src/libtnccs/tnc/tnccs/tnccs.h

   1 /*
   2  * Copyright (C) 2010-2011 Andreas Steffen
   3  * HSR Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  */
  15
  16 /**
  17  * @defgroup tnccs tnccs
  18  * @ingroup tnc
  19  *
  20  * @defgroup tnccst tnccs
  21  * @{ @ingroup tnccs
  22  */
  23
  24 #ifndef TNCCS_H_
  25 #define TNCCS_H_
  26
  27 typedef struct tnccs_t tnccs_t;
  28 typedef enum tnccs_type_t tnccs_type_t;
  29
  30 #include <tncif.h>
  31 #include <tncifimc.h>
  32 #include <tncifimv.h>
  33
  34 #include <library.h>
  35 #include <plugins/plugin.h>
  36
  37 /**
  38  * Type of TNC Client/Server protocol
  39  */
  40 enum tnccs_type_t {
  41         TNCCS_UNKNOWN,
  42         TNCCS_1_1,
  43         TNCCS_SOH,
  44         TNCCS_2_0,
  45         TNCCS_DYNAMIC
  46 };
  47
  48 /**
  49  * enum names for tnccs_type_t.
  50  */
  51 extern enum_name_t *tnccs_type_names;
  52
  53 /**
  54  * Constructor definition for a pluggable TNCCS protocol implementation.
  55  *
  56  * @param is_server             TRUE if TNC Server, FALSE if TNC Client
  57  * @return                              implementation of the tnccs_t interface
  58  */
  59 typedef tnccs_t *(*tnccs_constructor_t)(bool is_server);
  60
  61 /**
  62  * Callback function adding a message to a TNCCS batch
  63  *
  64  * @param imc_id                ID of IMC or TNC_IMCID_ANY
  65  * @param imc_id                ID of IMV or TNC_IMVID_ANY
  66  * @param msg                   message to be added
  67  * @param msg_len               message length
  68  * @param msg_type              message type
  69  * @return                      result code
  70  */
  71 typedef TNC_Result (*tnccs_send_message_t)(tnccs_t* tncss, TNC_IMCID imc_id,
  72                                                                                                          TNC_IMVID imv_id,
  73                                                                                                          TNC_BufferReference msg,
  74                                                                                                          TNC_UInt32 msg_len,
  75                                                                                                          TNC_MessageType msg_type);
  76
  77 #endif /** TNCCS_H_ @}*/