26b0fa17c6353cfbe42722fbccdffc2e48e2182e
[strongswan.git] / src / libtnccs / tnc / tnccs / tnccs_manager.h
1 /*
2 * Copyright (C) 2010 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_manager tnccs_manager
18 * @{ @ingroup tnccs
19 */
20
21 #ifndef TNCCS_MANAGER_H_
22 #define TNCCS_MANAGER_H_
23
24 typedef struct tnccs_manager_t tnccs_manager_t;
25
26 #include "tnccs.h"
27 #include "tnc/imv/imv_recommendations.h"
28
29 /**
30 * The TNCCS manager manages all TNCCS implementations and creates instances.
31 *
32 * A plugin registers its implemented TNCCS protocol with the manager by
33 * providing type and a constructor function. The manager then creates
34 * TNCCS protocol instances via the provided constructor.
35 */
36 struct tnccs_manager_t {
37
38 /**
39 * Register a TNCCS protocol implementation.
40 *
41 * @param type TNCCS protocol type
42 * @param constructor constructor, returns a TNCCS protocol implementation
43 */
44 void (*add_method)(tnccs_manager_t *this, tnccs_type_t type,
45 tnccs_constructor_t constructor);
46
47 /**
48 * Unregister a TNCCS protocol implementation using it's constructor.
49 *
50 * @param constructor constructor function to remove, as added in add_method
51 */
52 void (*remove_method)(tnccs_manager_t *this, tnccs_constructor_t constructor);
53
54 /**
55 * Create a new TNCCS protocol instance.
56 *
57 * @param type type of the TNCCS protocol
58 * @param is_server TRUE if TNC Server, FALSE if TNC Client
59 * @return TNCCS protocol instance, NULL if no constructor found
60 */
61 tnccs_t* (*create_instance)(tnccs_manager_t *this, tnccs_type_t type,
62 bool is_server);
63
64 /**
65 * Create a TNCCS connection and assign a unique connection ID as well a
66 * callback function for adding a message to a TNCCS batch and create
67 * an empty set for collecting IMV recommendations
68 *
69 * @param tnccs TNCCS connection instance
70 * @param send_message TNCCS callback function
71 * @param request_handshake_retry pointer to boolean variable
72 * @param recs pointer to IMV recommendation set
73 * @return assigned connection ID
74 */
75 TNC_ConnectionID (*create_connection)(tnccs_manager_t *this, tnccs_t *tnccs,
76 tnccs_send_message_t send_message,
77 bool *request_handshake_retry,
78 recommendations_t **recs);
79
80 /**
81 * Remove a TNCCS connection using its connection ID.
82 *
83 * @param id ID of the connection to be removed
84 * @param is_server TNC Server if TRUE, TNC Client if FALSE
85 */
86 void (*remove_connection)(tnccs_manager_t *this, TNC_ConnectionID id,
87 bool is_server);
88
89 /**
90 * Request a handshake retry
91 *
92 * @param is_imc TRUE if IMC, FALSE if IMV
93 * @param imcv_id ID of IMC or IMV requesting the retry
94 * @param id ID of a specific connection or any connection
95 * @param reason reason for the handshake retry
96 * @return return code
97 */
98 TNC_Result (*request_handshake_retry)(tnccs_manager_t *this, bool is_imc,
99 TNC_UInt32 imcv_id,
100 TNC_ConnectionID id,
101 TNC_RetryReason reason);
102
103 /**
104 * Add an IMC/IMV message to the batch of a given connection ID.
105 *
106 * @param imc_id ID of IMC or TNC_IMCID_ANY
107 * @param imv_id ID of IMV or TNC_IMVID_ANY
108 * @param id ID of target connection
109 * @param msg message to be added
110 * @param msg_len message length
111 * @param msg_type message type
112 * @return return code
113 */
114 TNC_Result (*send_message)(tnccs_manager_t *this, TNC_IMCID imc_id,
115 TNC_IMVID imv_id,
116 TNC_ConnectionID id,
117 TNC_BufferReference msg,
118 TNC_UInt32 msg_len,
119 TNC_MessageType msg_type);
120
121 /**
122 * Deliver an IMV Action Recommendation and IMV Evaluation Result to the TNCS
123 *
124 * @param imv_id ID of the IMV providing the recommendation
125 * @param id ID of target connection
126 * @param rec action recommendation
127 * @param eval evaluation result
128 * @return return code
129 */
130 TNC_Result (*provide_recommendation)(tnccs_manager_t *this,
131 TNC_IMVID imv_id,
132 TNC_ConnectionID id,
133 TNC_IMV_Action_Recommendation rec,
134 TNC_IMV_Evaluation_Result eval);
135
136 /**
137 * Get the value of an attribute associated with a connection or with the
138 * TNCS as a whole.
139 *
140 * @param imv_id ID of the IMV requesting the attribute
141 * @param id ID of target connection
142 * @param attribute_id ID of the requested attribute
143 * @param buffer_len length of the buffer in bytes
144 * @param buffer pointer to the buffer
145 * @param out_value_len actual length of the returned attribute
146 * @return return code
147 */
148 TNC_Result (*get_attribute)(tnccs_manager_t *this,
149 TNC_IMVID imv_id,
150 TNC_ConnectionID id,
151 TNC_AttributeID attribute_id,
152 TNC_UInt32 buffer_len,
153 TNC_BufferReference buffer,
154 TNC_UInt32 *out_value_len);
155
156 /**
157 * Set the value of an attribute associated with a connection or with the
158 * TNCS as a whole.
159 *
160 * @param imv_id ID of the IMV setting the attribute
161 * @param id ID of target connection
162 * @param attribute_id ID of the attribute to be set
163 * @param buffer_len length of the buffer in bytes
164 * @param buffer pointer to the buffer
165 * @return return code
166 */
167 TNC_Result (*set_attribute)(tnccs_manager_t *this,
168 TNC_IMVID imv_id,
169 TNC_ConnectionID id,
170 TNC_AttributeID attribute_id,
171 TNC_UInt32 buffer_len,
172 TNC_BufferReference buffer);
173
174 /**
175 * Destroy a tnccs_manager instance.
176 */
177 void (*destroy)(tnccs_manager_t *this);
178 };
179
180 /**
181 * Helper function to (un-)register TNCCS methods from plugin features.
182 *
183 * This function is a plugin_feature_callback_t and can be used with the
184 * PLUGIN_CALLBACK macro to register a TNCCS method constructor.
185 *
186 * @param plugin plugin registering the TNCCS method constructor
187 * @param feature associated plugin feature
188 * @param reg TRUE to register, FALSE to unregister.
189 * @param data data passed to callback, a tnccs_constructor_t
190 */
191 bool tnccs_method_register(plugin_t *plugin, plugin_feature_t *feature,
192 bool reg, void *data);
193
194 #endif /** TNCCS_MANAGER_H_ @}*/