src/libimcv/imc/imc_msg.h

   1 /*
   2  * Copyright (C) 2012 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 imc_msg imc_msg
  18  * @{ @ingroup libimcv_imc
  19  */
  20
  21 #ifndef IMC_MSG_H_
  22 #define IMC_MSG_H_
  23
  24 #include <imc/imc_agent.h>
  25
  26 typedef struct imc_msg_t imc_msg_t;
  27
  28 #include <library.h>
  29
  30 /**
  31  * Interface for a PA-TNC message handled by an IMC.
  32  *
  33  */
  34 struct imc_msg_t {
  35
  36         /**
  37          * Get source ID of PA-TNC message
  38          *
  39          * @return                                      src ID
  40          */
  41         TNC_UInt32 (*get_src_id)(imc_msg_t *this);
  42
  43         /**
  44          * Get destination ID of PA-TNC message
  45          *
  46          * @return                                      destination ID
  47          */
  48         TNC_UInt32 (*get_dst_id)(imc_msg_t *this);
  49
  50         /**
  51          * Get the PA-TNC message type.
  52          *
  53          * @return                                      message type
  54          */
  55         pen_type_t (*get_msg_type)(imc_msg_t *this);
  56
  57         /**
  58          * Sends one or multiple PA-TNC messages
  59          *
  60          * @param excl                          set the excl message flag if supported
  61          * @return                                      TNC result code
  62          */
  63         TNC_Result (*send)(imc_msg_t *this, bool excl);
  64
  65         /**
  66          * Processes a received PA-TNC message
  67          *
  68          * @param fatal_error           TRUE if IMV sent a fatal error message
  69          * @return                                      TNC result code
  70          */
  71         TNC_Result (*receive)(imc_msg_t *this, bool *fatal_error);
  72
  73         /**
  74          * Add a PA-TNC attribute to the send queue
  75          *
  76          * @param attr                          PA-TNC attribute to be added
  77          */
  78         void (*add_attribute)(imc_msg_t *this, pa_tnc_attr_t *attr);
  79
  80         /**
  81          * Enumerator over PA-TNC attributes contained in the PA-TNC message
  82          *
  83          * @return                                      PA-TNC attribute enumerator
  84          */
  85         enumerator_t* (*create_attribute_enumerator)(imc_msg_t *this);
  86
  87         /**
  88          * Get the encoding of the IMC message.
  89          *
  90          * @return                                      message encoding, internal data
  91          */
  92         chunk_t (*get_encoding)(imc_msg_t *this);
  93
  94         /**
  95          * Destroys a imc_msg_t object.
  96          */
  97         void (*destroy)(imc_msg_t *this);
  98 };
  99
 100 /**
 101  * Create a wrapper for an outbound message
 102  *
 103  * @param agent                                 IMC agent responsible for the message
 104  * @param state                                 IMC state for the given connection ID
 105  * @param connection_id                 connection ID
 106  * @param src_id                                source IMC ID
 107  * @param dst_id                                destination IMV ID
 108  * @param msg_type                              PA-TNC message type
 109  */
 110 imc_msg_t* imc_msg_create(imc_agent_t *agent, imc_state_t *state,
 111                                                   TNC_ConnectionID connection_id,
 112                                                   TNC_UInt32 src_id, TNC_UInt32 dst_id,
 113                                                   pen_type_t msg_type);
 114
 115 /**
 116  * Create a wrapper for an outbound message based on a received message
 117  *
 118  * @param msg                                   received message the reply is based on
 119  */
 120 imc_msg_t* imc_msg_create_as_reply(imc_msg_t *msg);
 121
 122 /**
 123  * Create a wrapper around message data received via the legacy IF-IMC interface
 124  *
 125  * @param agent                                 IMC agent responsible for the message
 126  * @param state                                 IMC state for the given connection ID
 127  * @param connection_id                 connection ID
 128  * @param msg_type                              PA-TNC message type
 129  * @param msg                                   received PA-TNC message blob
 130  */
 131 imc_msg_t* imc_msg_create_from_data(imc_agent_t *agent, imc_state_t *state,
 132                                                                         TNC_ConnectionID connection_id,
 133                                                                         TNC_MessageType msg_type,
 134                                                                         chunk_t msg);
 135
 136 /**
 137  * Create a wrapper around message data received via the long IF-IMC interface
 138  *
 139  * @param agent                                 IMC agent responsible for the message
 140  * @param state                                 IMC state for the given connection ID
 141  * @param connection_id                 connection ID
 142  * @param src_id                                source IMV ID
 143  * @param dst_id                                destination IMC ID
 144  * @param msg_vid                               PA-TNC message vendor ID
 145  * @param msg_subtype                   PA-TNC subtype
 146  * @param msg                                   received PA-TNC message blob
 147  */
 148 imc_msg_t* imc_msg_create_from_long_data(imc_agent_t *agent, imc_state_t *state,
 149                                                                                  TNC_ConnectionID connection_id,
 150                                                                                  TNC_UInt32 src_id, TNC_UInt32 dst_id,
 151                                                                                  TNC_VendorID msg_vid,
 152                                                                                  TNC_MessageSubtype msg_subtype,
 153                                                                                  chunk_t msg);
 154
 155 #endif /** IMC_MSG_H_ @}*/