diff options
Diffstat (limited to 'src/libimcv/imc/imc_agent.h')
| -rw-r--r-- | src/libimcv/imc/imc_agent.h | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/src/libimcv/imc/imc_agent.h b/src/libimcv/imc/imc_agent.h new file mode 100644 index 000000000..d1fef4d8d --- /dev/null +++ b/src/libimcv/imc/imc_agent.h @@ -0,0 +1,175 @@ +/* + * Copyright (C) 2011 Andreas Steffen, HSR Hochschule fuer Technik Rapperswil + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation; either version 2 of the License, or (at your + * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * for more details. + */ + +/** + * + * @defgroup imc_agent_t imc_agent + * @{ @ingroup imc_agent + */ + +#ifndef IMC_AGENT_H_ +#define IMC_AGENT_H_ + +#include "imc_state.h" +#include "pa_tnc/pa_tnc_msg.h" + +#include <tncifimc.h> +#include <pen/pen.h> + +#include <library.h> + +typedef struct imc_agent_t imc_agent_t; + +/** + * Core functions of an Integrity Measurement Verifier (IMC) + */ +struct imc_agent_t { + + /** + * Ask a TNCC to retry an Integrity Check Handshake + * + * @param imc_id IMC ID assigned by TNCC + * @param connection_id network connection ID assigned by TNCC + * @param reason IMC retry reason + * @return TNC result code + */ + TNC_Result (*request_handshake_retry)(TNC_IMCID imc_id, + TNC_ConnectionID connection_id, + TNC_RetryReason reason); + + /** + * Bind TNCC functions + * + * @param bind_function function offered by the TNCC + * @return TNC result code + */ + TNC_Result (*bind_functions)(imc_agent_t *this, + TNC_TNCC_BindFunctionPointer bind_function); + + /** + * Create the IMC state for a TNCCS connection instance + * + * @param state internal IMC state instance + * @return TNC result code + */ + TNC_Result (*create_state)(imc_agent_t *this, imc_state_t *state); + + /** + * Delete the IMC state for a TNCCS connection instance + * + * @param connection_id network connection ID assigned by TNCS + * @return TNC result code + */ + TNC_Result (*delete_state)(imc_agent_t *this, + TNC_ConnectionID connection_id); + + /** + * Change the current state of a TNCCS connection + * + * @param connection_id network connection ID assigned by TNCS + * @param new_state new state of TNCCS connection + * @param state_p internal IMC state instance [optional argument] + * @return TNC result code + */ + TNC_Result (*change_state)(imc_agent_t *this, + TNC_ConnectionID connection_id, + TNC_ConnectionState new_state, + imc_state_t **state_p); + + /** + * Get the IMC state for a TNCCS connection instance + * + * @param connection_id network connection ID assigned by TNCS + * @param state internal IMC state instance + * @return TRUE if the state was found + */ + bool (*get_state)(imc_agent_t *this, + TNC_ConnectionID connection_id, imc_state_t **state); + + /** + * Call when an PA-TNC message is to be sent + * + * @param connection_id network connection ID assigned by TNCC + * @param excl exclusive flag + * @param src_imc_id IMC ID to be set as source + * @param dst_imv_id IMV ID to be set as destination + * @param msg message to send + * @return TNC result code + */ + TNC_Result (*send_message)(imc_agent_t *this, + TNC_ConnectionID connection_id, bool excl, + TNC_UInt32 src_imc_id, TNC_UInt32 dst_imv_id, + chunk_t msg); + + /** + * Call when a PA-TNC message was received + * + * @param state state for current connection + * @param msg received unparsed message + * @param msg_vid message vendorID of the received message + * @param msg_subtype message subtype of the received message + * @param src_imv_id source IMV ID + * @param dst_imc_id destination IMC ID + * @param pa_tnc_message parsed PA-TNC message or NULL if an error occurred + * @return TNC result code + */ + TNC_Result (*receive_message)(imc_agent_t *this, + imc_state_t *state, chunk_t msg, + TNC_VendorID msg_vid, + TNC_MessageSubtype msg_subtype, + TNC_UInt32 src_imv_id, + TNC_UInt32 dst_imc_id, + pa_tnc_msg_t **pa_tnc_msg); + + /** + * Reserve additional IMC IDs from TNCC + * + * @param count number of additional IMC IDs to be assigned + * @return TNC result code + */ + TNC_Result (*reserve_additional_ids)(imc_agent_t *this, int count); + + /** + * Return the number of additional IMC IDs assigned by the TNCC + * + * @return number of additional IMC IDs + */ + int (*count_additional_ids)(imc_agent_t *this); + + /** + * Create an enumerator for the additional IMC IDs + */ + enumerator_t* (*create_id_enumerator)(imc_agent_t *this); + + /** + * Destroys an imc_agent_t object + */ + void (*destroy)(imc_agent_t *this); +}; + +/** + * Create an imc_agent_t object + * + * @param name name of the IMC + * @param vendor_id vendor ID of the IMC + * @param subtype message subtype of the IMC + * @param id ID of the IMC as assigned by the TNCS + * @param actual_version actual version of the IF-IMC API + * + */ +imc_agent_t *imc_agent_create(const char *name, + pen_t vendor_id, u_int32_t subtype, + TNC_IMCID id, TNC_Version *actual_version); + +#endif /** IMC_AGENT_H_ @}*/ |