Imported Upstream version 4.6.4

1 files changed, 230 insertions, 0 deletions

diff --git a/src/libtnccs/tnc/imc/imc.h b/src/libtnccs/tnc/imc/imc.h
new file mode 100644
index 000000000..3ff7d5194
--- /dev/null
+++ b/src/libtnccs/tnc/imc/imc.h
@@ -0,0 +1,230 @@
+/*
+ * Copyright (C) 2010-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 imc
+ * @ingroup tnc
+ *
+ * @defgroup imct imc
+ * @{ @ingroup imc
+ */
+
+#ifndef IMC_H_
+#define IMC_H_
+
+#include <tncifimc.h>
+
+#include <library.h>
+
+typedef struct imc_t imc_t;
+
+/**
+ * Controls a single Integrity Measurement Collector (IMC)
+ */
+struct imc_t {
+
+	/**
+	 * The TNC Client calls this function to initialize the IMC and agree on
+	 * the API version number to be used. It also supplies the IMC ID, an IMC
+	 * identifier that the IMC must use when calling TNC Client callback functions.
+	 *
+	 * @param imcID					IMC ID assigned by TNCC
+	 * @param minVersion			minimum API version supported by TNCC
+	 * @param maxVersion			maximum API version supported by TNCC
+	 * @param OutActualVersion		mutually supported API version number
+	 * @return						TNC result code
+	 */
+	TNC_Result (*initialize)(TNC_IMCID imcID,
+							 TNC_Version minVersion,
+							 TNC_Version maxVersion,
+							 TNC_Version *OutActualVersion);
+
+	/**
+	 * The TNC Client calls this function to inform the IMC that the state of
+	 * the network connection identified by connectionID has changed to newState.
+	 *
+	 * @param imcID					IMC ID assigned by TNCC
+	 * @param connectionID			network connection ID assigned by TNCC
+	 * @param newState				new network connection state
+	 * @return						TNC result code
+	 */
+	TNC_Result (*notify_connection_change)(TNC_IMCID imcID,
+										   TNC_ConnectionID connectionID,
+										   TNC_ConnectionState newState);
+
+	/**
+	 * The TNC Client calls this function to indicate that an Integrity Check
+	 * Handshake is beginning and solicit messages from IMCs for the first batch.
+	 *
+	 * @param imcID					IMC ID assigned by TNCC
+	 * @param connectionID			network connection ID assigned by TNCC
+	 * @return						TNC result code
+	 */
+	TNC_Result (*begin_handshake)(TNC_IMCID imcID,
+								  TNC_ConnectionID connectionID);
+
+	/**
+	 * The TNC Client calls this function to deliver a message to the IMC.
+	 * The message is contained in the buffer referenced by message and contains
+	 * the number of octets indicated by messageLength. The type of the message
+	 * is indicated by messageType.
+	 *
+	 * @param imcID					IMC ID assigned by TNCS
+	 * @param connectionID			network connection ID assigned by TNCC
+	 * @param message				reference to buffer containing message
+	 * @param messageLength			number of octets in message
+	 * @param messageType			message type of message
+	 * @return						TNC result code
+	 */
+	TNC_Result (*receive_message)(TNC_IMCID imcID,
+								  TNC_ConnectionID connectionID,
+								  TNC_BufferReference message,
+								  TNC_UInt32 messageLength,
+								  TNC_MessageType messageType);
+
+	/**
+	 * The TNC Client calls this function to deliver a message to the IMC.
+	 * The message is contained in the buffer referenced by message and contains
+	 * the number of octets indicated by messageLength. The type of the message
+	 * is indicated by the message Vendor ID and message subtype.
+	 *
+	 * @param imcID					IMC ID assigned by TNCS
+	 * @param connectionID			network connection ID assigned by TNCC
+	 * @param messageFlags			message flags
+	 * @param message				reference to buffer containing message
+	 * @param messageLength			number of octets in message
+	 * @param messageVendorID		message Vendor ID
+	 * @param messageSubtype		message subtype
+	 * @param sourceIMVID			source IMV ID
+	 * @param destinationIMCID		destination IMC ID
+	 * @return						TNC result code
+	 */
+	TNC_Result (*receive_message_long)(TNC_IMCID imcID,
+									   TNC_ConnectionID connectionID,
+									   TNC_UInt32 messageFlags,
+									   TNC_BufferReference message,
+									   TNC_UInt32 messageLength,
+									   TNC_VendorID messageVendorID,
+									   TNC_MessageSubtype messageSubtype,
+									   TNC_UInt32 sourceIMVID,
+									   TNC_UInt32 destinationIMCID);
+
+	/**
+	 * The TNC Client calls this function to notify IMCs that all IMV messages
+	 * received in a batch have been delivered and this is the IMC’s last chance
+	 * to send a message in the batch of IMC messages currently being collected.
+	 *
+	 * @param imcID					IMC ID assigned by TNCC
+	 * @param connectionID			network connection ID assigned by TNCC
+	 * @return						TNC result code
+	 */
+	TNC_Result (*batch_ending)(TNC_IMCID imcID,
+							   TNC_ConnectionID connectionID);
+
+	/**
+	 * The TNC Client calls this function to close down the IMC when all work is
+	 * complete or the IMC reports TNC_RESULT_FATAL.
+	 *
+	 * @param imcID					IMC ID assigned by TNCC
+	 * @return						TNC result code
+	 */
+	TNC_Result (*terminate)(TNC_IMCID imcID);
+
+	/**
+	 * IMVs implementing the UNIX/Linux Dynamic Linkage platform binding MUST
+	 * define this additional function. The TNC Server MUST call the function
+	 * immediately after calling TNC_IMV_Initialize to provide a pointer to the
+	 * TNCS bind function. The IMV can then use the TNCS bind function to obtain
+	 * pointers to any other TNCS functions.
+	 *
+	 * @param imcID					IMC ID assigned by TNCC
+	 * @param bindFunction			pointer to TNC_TNCC_BindFunction
+	 * @return						TNC result code
+	 */
+	TNC_Result (*provide_bind_function)(TNC_IMCID imcID,
+										TNC_TNCC_BindFunctionPointer bindFunction);
+
+	/**
+	 * Sets the ID of an imc_t object.
+	 *
+	 * @param id					IMC ID to be assigned
+	 */
+	void (*set_id)(imc_t *this, TNC_IMCID id);
+
+	/**
+	 * Returns the ID of an imc_t object.
+	 *
+	 * @return						assigned IMC ID
+	 */
+	TNC_IMCID (*get_id)(imc_t *this);
+
+	/**
+	 * Assign an additional ID to an imc_t object.
+	 *
+	 * @param id					additional IMC ID to be assigned
+	 */
+	void (*add_id)(imc_t *this, TNC_IMCID id);
+
+	/**
+	 * Checks if the ID is assigned to the imc_t object.
+	 *
+	 * @return						TRUE if IMC ID is assigned to imc_t object
+	 */
+	bool (*has_id)(imc_t *this, TNC_IMCID id);
+
+	/**
+	 * Returns the name of an imc_t object.
+	 *
+	 * @return						name of IMC
+	 */
+	char* (*get_name)(imc_t *this);
+
+	/**
+	 * Sets the supported message types of an imc_t object.
+	 *
+	 * @param supported_types		list of messages type supported by IMC
+	 * @param type_count			number of supported message types
+	 */
+	void (*set_message_types)(imc_t *this, TNC_MessageTypeList supported_types,
+										   TNC_UInt32 type_count);
+
+	/**
+	 * Sets the supported long message types of an imc_t object.
+	 *
+	 * @param supported_vids		list of vendor IDs supported by IMC
+	 * @param supported_subtypes	list of messages type supported by IMC
+	 * @param type_count			number of supported message types
+	 */
+	void (*set_message_types_long)(imc_t *this, TNC_VendorIDList supported_vids,
+								   TNC_MessageSubtypeList supported_subtypes,
+								   TNC_UInt32 type_count);
+
+	/**
+	 * Check if the IMC supports a given message type.
+	 *
+	 * @param msg_vid				message vendor ID
+	 * @param msg_subtype			message subtype
+	 * @return						TRUE if supported
+	 */
+	bool (*type_supported)(imc_t *this, TNC_VendorID msg_vid,
+										TNC_MessageSubtype msg_subtype);
+
+	/**
+	 * Destroys an imc_t object.
+	 */
+	void (*destroy)(imc_t *this);
+};
+
+#endif /** IMC_H_ @}*/