4ab9d7e18867df0557f06154ea0793582b65b3fe
[strongswan.git] / src / libtnccs / tnc / tnccs / tnccs_manager.h
1 /*
2 * Copyright (C) 2010-2013 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 * @param server Server identity
60 * @param peer Client identity
61 * @param transport Underlying TNC IF-T transport protocol used
62 * @return TNCCS protocol instance, NULL if no constructor found
63 */
64 tnccs_t* (*create_instance)(tnccs_manager_t *this, tnccs_type_t type,
65 bool is_server, identification_t *server,
66 identification_t *peer,
67 tnc_ift_type_t transport);
68
69 /**
70 * Create a TNCCS connection and assign a unique connection ID as well a
71 * callback function for adding a message to a TNCCS batch and create
72 * an empty set for collecting IMV recommendations
73 *
74 * @param type TNCCS protocol type
75 * @param tnccs TNCCS connection instance
76 * @param send_message TNCCS callback function
77 * @param request_handshake_retry pointer to boolean variable
78 * @param max_msg_len maximum PA-TNC message size
79 * @param recs pointer to IMV recommendation set
80 * @return assigned connection ID
81 */
82 TNC_ConnectionID (*create_connection)(tnccs_manager_t *this,
83 tnccs_type_t type, tnccs_t *tnccs,
84 tnccs_send_message_t send_message,
85 bool *request_handshake_retry,
86 u_int32_t max_msg_len,
87 recommendations_t **recs);
88
89 /**
90 * Remove a TNCCS connection using its connection ID.
91 *
92 * @param id ID of the connection to be removed
93 * @param is_server TNC Server if TRUE, TNC Client if FALSE
94 */
95 void (*remove_connection)(tnccs_manager_t *this, TNC_ConnectionID id,
96 bool is_server);
97
98 /**
99 * Request a handshake retry
100 *
101 * @param is_imc TRUE if IMC, FALSE if IMV
102 * @param imcv_id ID of IMC or IMV requesting the retry
103 * @param id ID of a specific connection or any connection
104 * @param reason reason for the handshake retry
105 * @return return code
106 */
107 TNC_Result (*request_handshake_retry)(tnccs_manager_t *this, bool is_imc,
108 TNC_UInt32 imcv_id,
109 TNC_ConnectionID id,
110 TNC_RetryReason reason);
111
112 /**
113 * Add an IMC/IMV message to the batch of a given connection ID.
114 *
115 * @param imc_id ID of IMC or TNC_IMCID_ANY
116 * @param imv_id ID of IMV or TNC_IMVID_ANY
117 * @param id ID of target connection
118 * @param msg_flags message flags
119 * @param msg message to be added
120 * @param msg_len message length
121 * @param msg_vid message vendor ID
122 * @param msg_subtype message subtype
123 * @return return code
124 */
125 TNC_Result (*send_message)(tnccs_manager_t *this,
126 TNC_IMCID imc_id,
127 TNC_IMVID imv_id,
128 TNC_ConnectionID id,
129 TNC_UInt32 msg_flags,
130 TNC_BufferReference msg,
131 TNC_UInt32 msg_len,
132 TNC_VendorID msg_vid,
133 TNC_MessageSubtype msg_subtype);
134
135 /**
136 * Deliver an IMV Action Recommendation and IMV Evaluation Result to the TNCS
137 *
138 * @param imv_id ID of the IMV providing the recommendation
139 * @param id ID of target connection
140 * @param rec action recommendation
141 * @param eval evaluation result
142 * @return return code
143 */
144 TNC_Result (*provide_recommendation)(tnccs_manager_t *this,
145 TNC_IMVID imv_id,
146 TNC_ConnectionID id,
147 TNC_IMV_Action_Recommendation rec,
148 TNC_IMV_Evaluation_Result eval);
149
150 /**
151 * Get the value of an attribute associated with a connection or with the
152 * TNCS as a whole.
153 *
154 * @param is_imc TRUE if IMC, FALSE if IMV
155 * @param imcv_id ID of the IMC/IMV requesting the attribute
156 * @param id ID of target connection
157 * @param attribute_id ID of the requested attribute
158 * @param buffer_len length of the buffer in bytes
159 * @param buffer pointer to the buffer
160 * @param value_len actual length of the returned attribute
161 * @return return code
162 */
163 TNC_Result (*get_attribute)(tnccs_manager_t *this, bool is_imc,
164 TNC_UInt32 imcv_id,
165 TNC_ConnectionID id,
166 TNC_AttributeID attribute_id,
167 TNC_UInt32 buffer_len,
168 TNC_BufferReference buffer,
169 TNC_UInt32 *value_len);
170
171 /**
172 * Set the value of an attribute associated with a connection or with the
173 * TNCS as a whole.
174 *
175 * @param is_imc TRUE if IMC, FALSE if IMV
176 * @param imcv_id ID of the IMC/IMV setting the attribute
177 * @param id ID of target connection
178 * @param attribute_id ID of the attribute to be set
179 * @param buffer_len length of the buffer in bytes
180 * @param buffer pointer to the buffer
181 * @return return code
182 */
183 TNC_Result (*set_attribute)(tnccs_manager_t *this, bool is_imc,
184 TNC_UInt32 imcv_id,
185 TNC_ConnectionID id,
186 TNC_AttributeID attribute_id,
187 TNC_UInt32 buffer_len,
188 TNC_BufferReference buffer);
189
190 /**
191 * Destroy a tnccs_manager instance.
192 */
193 void (*destroy)(tnccs_manager_t *this);
194 };
195
196 /**
197 * Helper function to (un-)register TNCCS methods from plugin features.
198 *
199 * This function is a plugin_feature_callback_t and can be used with the
200 * PLUGIN_CALLBACK macro to register a TNCCS method constructor.
201 *
202 * @param plugin plugin registering the TNCCS method constructor
203 * @param feature associated plugin feature
204 * @param reg TRUE to register, FALSE to unregister.
205 * @param data data passed to callback, a tnccs_constructor_t
206 */
207 bool tnccs_method_register(plugin_t *plugin, plugin_feature_t *feature,
208 bool reg, void *data);
209
210 #endif /** TNCCS_MANAGER_H_ @}*/