src/libimcv/imv/imv_agent.h

   1 /*
   2  * Copyright (C) 2011 Andreas Steffen, HSR Hochschule fuer Technik Rapperswil
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License as published by the
   6  * Free Software Foundation; either version 2 of the License, or (at your
   7  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * for more details.
  13  */
  14
  15 /**
  16  *
  17  * @defgroup imv_agent_t imv_agent
  18  * @{ @ingroup imv_agent
  19  */
  20
  21 #ifndef IMV_AGENT_H_
  22 #define IMV_AGENT_H_
  23
  24 #include "imv_state.h"
  25 #include "pa_tnc/pa_tnc_msg.h"
  26
  27 #include <tncifimv.h>
  28 #include <pen/pen.h>
  29
  30 #include <library.h>
  31
  32 typedef struct imv_agent_t imv_agent_t;
  33
  34 /**
  35  * Core functions of an Integrity Measurement Verifier (IMV)
  36  */
  37 struct imv_agent_t {
  38
  39         /**
  40          * Ask a TNCS to retry an Integrity Check Handshake
  41          *
  42          * @param imv_id                        IMV ID assigned by TNCS
  43          * @param connection_id         network connection ID assigned by TNCS
  44          * @param reason                        IMV retry reason
  45          * @return                                      TNC result code
  46          */
  47         TNC_Result (*request_handshake_retry)(TNC_IMVID imv_id,
  48                                                                                   TNC_ConnectionID connection_id,
  49                                                                                   TNC_RetryReason reason);
  50
  51         /**
  52          * Bind TNCS functions
  53          *
  54          * @param bind_function         function offered by the TNCS
  55          * @return                                      TNC result code
  56          */
  57         TNC_Result (*bind_functions)(imv_agent_t *this,
  58                                                                  TNC_TNCS_BindFunctionPointer bind_function);
  59
  60         /**
  61          * Create the IMV state for a TNCCS connection instance
  62          *
  63          * @param state                         internal IMV state instance
  64          * @return                                      TNC result code
  65          */
  66         TNC_Result (*create_state)(imv_agent_t *this, imv_state_t *state);
  67
  68         /**
  69          * Delete the IMV state for a TNCCS connection instance
  70          *
  71          * @param connection_id         network connection ID assigned by TNCS
  72          * @return                                      TNC result code
  73          */
  74         TNC_Result (*delete_state)(imv_agent_t *this,
  75                                                            TNC_ConnectionID connection_id);
  76
  77         /**
  78          * Change the current state of a TNCCS connection
  79          *
  80          * @param connection_id         network connection ID assigned by TNCS
  81          * @param new_state                     new state of TNCCS connection
  82          * @param state_p                       internal IMV state instance [optional argument]
  83          * @return                                      TNC result code
  84          */
  85         TNC_Result (*change_state)(imv_agent_t *this,
  86                                                            TNC_ConnectionID connection_id,
  87                                                            TNC_ConnectionState new_state,
  88                                                            imv_state_t **state_p);
  89
  90         /**
  91          * Get the IMV state for a TNCCS connection instance
  92          *
  93          * @param connection_id         network connection ID assigned by TNCS
  94          * @param state                         internal IMV state instance
  95          * @return                                      TRUE if the state was found
  96          */
  97         bool (*get_state)(imv_agent_t *this,
  98                                           TNC_ConnectionID connection_id, imv_state_t **state);
  99
 100         /**
 101          * Call when a PA-TNC message is to be sent
 102          *
 103          * @param connection_id         network connection ID assigned by TNCS
 104          * @param excl                          exclusive flag
 105          * @param src_imv_id            IMV ID to be set as source
 106          * @param dst_imc_id            IMD ID to be set as destination
 107          * @param msg                           message to send
 108          * @return                                      TNC result code
 109          */
 110         TNC_Result (*send_message)(imv_agent_t *this,
 111                                                            TNC_ConnectionID connection_id, bool excl,
 112                                                            TNC_UInt32 src_imv_id, TNC_UInt32 dst_imc_id,
 113                                                            chunk_t msg);
 114
 115         /**
 116          * Call when a PA-TNC message was received
 117          *
 118          * @param state                         state for current connection
 119          * @param msg                           received unparsed message
 120          * @param msg_vid                       message vendorID of the received message
 121          * @param msg_subtype           message subtype of the received message
 122          * @param src_imc_id            source IMC ID
 123          * @param dst_imv_id            destination IMV ID
 124          * @param pa_tnc_message        parsed PA-TNC message or NULL if an error occurred
 125          * @return                                      TNC result code
 126          */
 127         TNC_Result (*receive_message)(imv_agent_t *this,
 128                                                                   imv_state_t *state, chunk_t msg,
 129                                                                   TNC_VendorID msg_vid,
 130                                                                   TNC_MessageSubtype msg_subtype,
 131                                                                   TNC_UInt32 src_imc_id,
 132                                                                   TNC_UInt32 dst_imv_id,
 133                                                                   pa_tnc_msg_t **pa_tnc_msg);
 134
 135         /**
 136          * Set Action Recommendation and Evaluation Result in the IMV state
 137          *
 138          * @param connection_id         network connection ID assigned by TNCS
 139          * @param rec                           IMV action recommendation
 140          * @param eval                          IMV evaluation result
 141          * @return                                      TNC result code
 142          */
 143         TNC_Result (*set_recommendation)(imv_agent_t *this,
 144                                                                          TNC_ConnectionID connection_id,
 145                                                                          TNC_IMV_Action_Recommendation rec,
 146                                                                          TNC_IMV_Evaluation_Result eval);
 147
 148         /**
 149          * Deliver IMV Action Recommendation and IMV Evaluation Result to the TNCS
 150          *
 151          * @param connection_id         network connection ID assigned by TNCS
 152          * @return                                      TNC result code
 153          */
 154         TNC_Result (*provide_recommendation)(imv_agent_t *this,
 155                                                                                  TNC_ConnectionID connection_id);
 156
 157         /**
 158          * Reserve additional IMV IDs from TNCS
 159          *
 160          * @param count                         number of additional IMV IDs to be assigned
 161          * @return                                      TNC result code
 162          */
 163         TNC_Result (*reserve_additional_ids)(imv_agent_t *this, int count);
 164
 165         /**
 166          * Return the number of additional IMV IDs assigned by the TNCS
 167          *
 168          * @return                                      number of additional IMV IDs
 169          */
 170         int (*count_additional_ids)(imv_agent_t *this);
 171
 172         /**
 173          * Create an enumerator for the additional IMV IDs
 174          */
 175         enumerator_t* (*create_id_enumerator)(imv_agent_t *this);
 176
 177         /**
 178          * Destroys an imv_agent_t object
 179          */
 180         void (*destroy)(imv_agent_t *this);
 181 };
 182
 183 /**
 184  * Create an imv_agent_t object
 185  *
 186  * @param name                          name of the IMV
 187  * @param vendor_id                     vendor ID of the IMV
 188  * @param subtype                       message subtype of the IMV
 189  * @param id                            ID of the IMV as assigned by the TNCS
 190  * @param actual_version        actual version of the IF-IMV API
 191  *
 192  */
 193 imv_agent_t *imv_agent_create(const char *name,
 194                                                           pen_t vendor_id, u_int32_t subtype,
 195                                                           TNC_IMVID id, TNC_Version *actual_version);
 196
 197 #endif /** IMV_AGENT_H_ @}*/