Added add_segment() method to IETF attributes
[strongswan.git] / src / libimcv / plugins / imv_scanner / imv_scanner_state.c
1 /*
2 * Copyright (C) 2011-2014 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 #include "imv_scanner_state.h"
17 #include "imv/imv_lang_string.h"
18 #include "imv/imv_reason_string.h"
19 #include "imv/imv_remediation_string.h"
20
21 #include <tncif_policy.h>
22
23 #include <utils/lexparser.h>
24 #include <utils/debug.h>
25
26 typedef struct private_imv_scanner_state_t private_imv_scanner_state_t;
27
28 /**
29 * Private data of an imv_scanner_state_t object.
30 */
31 struct private_imv_scanner_state_t {
32
33 /**
34 * Public members of imv_scanner_state_t
35 */
36 imv_scanner_state_t public;
37
38 /**
39 * TNCCS connection ID
40 */
41 TNC_ConnectionID connection_id;
42
43 /**
44 * TNCCS connection state
45 */
46 TNC_ConnectionState state;
47
48 /**
49 * Does the TNCCS connection support long message types?
50 */
51 bool has_long;
52
53 /**
54 * Does the TNCCS connection support exclusive delivery?
55 */
56 bool has_excl;
57
58 /**
59 * Maximum PA-TNC message size for this TNCCS connection
60 */
61 uint32_t max_msg_len;
62
63 /**
64 * Flags set for completed actions
65 */
66 uint32_t action_flags;
67
68 /**
69 * IMV database session associatied with TNCCS connection
70 */
71 imv_session_t *session;
72
73 /**
74 * PA-TNC attribute segmentation contracts associated with TNCCS connection
75 */
76 seg_contract_manager_t *contracts;
77
78 /**
79 * IMV action recommendation
80 */
81 TNC_IMV_Action_Recommendation rec;
82
83 /**
84 * IMV evaluation result
85 */
86 TNC_IMV_Evaluation_Result eval;
87
88 /**
89 * IMV Scanner handshake state
90 */
91 imv_scanner_handshake_state_t handshake_state;
92
93 /**
94 * Copy of the received IEEE Port Filter attribute
95 */
96 ietf_attr_port_filter_t *port_filter_attr;
97
98 /**
99 * List with ports that should be closed
100 */
101 linked_list_t *violating_ports;
102
103 /**
104 * TNC Reason String
105 */
106 imv_reason_string_t *reason_string;
107
108 /**
109 * IETF Remediation Instructions String
110 */
111 imv_remediation_string_t *remediation_string;
112
113 };
114
115 /**
116 * Supported languages
117 */
118 static char* languages[] = { "en", "de", "fr", "pl" };
119
120 /**
121 * Reason strings for "Port Filter"
122 */
123 static imv_lang_string_t reasons[] = {
124 { "en", "Open server ports were detected" },
125 { "de", "Offene Serverports wurden festgestellt" },
126 { "fr", "Il y a des ports du serveur ouverts" },
127 { "pl", "Są otwarte porty serwera" },
128 { NULL, NULL }
129 };
130
131 /**
132 * Instruction strings for "Port Filters"
133 */
134 static imv_lang_string_t instr_ports_title[] = {
135 { "en", "Open Server Ports" },
136 { "de", "Offene Server Ports" },
137 { "fr", "Ports ouverts du serveur" },
138 { "pl", "Otwarte Porty Serwera" },
139 { NULL, NULL }
140 };
141
142 static imv_lang_string_t instr_ports_descr[] = {
143 { "en", "Open Internet ports have been detected" },
144 { "de", "Offenen Internet-Ports wurden festgestellt" },
145 { "fr", "Il y'a des ports Internet ouverts" },
146 { "pl", "Porty internetowe są otwarte" },
147 { NULL, NULL }
148 };
149
150 static imv_lang_string_t instr_ports_header[] = {
151 { "en", "Please close the following server ports:" },
152 { "de", "Bitte schliessen Sie die folgenden Serverports:" },
153 { "fr", "Fermez les ports du serveur suivants s'il vous plait:" },
154 { "pl", "Proszę zamknąć następujące porty serwera:" },
155 { NULL, NULL }
156 };
157
158 METHOD(imv_state_t, get_connection_id, TNC_ConnectionID,
159 private_imv_scanner_state_t *this)
160 {
161 return this->connection_id;
162 }
163
164 METHOD(imv_state_t, has_long, bool,
165 private_imv_scanner_state_t *this)
166 {
167 return this->has_long;
168 }
169
170 METHOD(imv_state_t, has_excl, bool,
171 private_imv_scanner_state_t *this)
172 {
173 return this->has_excl;
174 }
175
176 METHOD(imv_state_t, set_flags, void,
177 private_imv_scanner_state_t *this, bool has_long, bool has_excl)
178 {
179 this->has_long = has_long;
180 this->has_excl = has_excl;
181 }
182
183 METHOD(imv_state_t, set_max_msg_len, void,
184 private_imv_scanner_state_t *this, uint32_t max_msg_len)
185 {
186 this->max_msg_len = max_msg_len;
187 }
188
189 METHOD(imv_state_t, get_max_msg_len, uint32_t,
190 private_imv_scanner_state_t *this)
191 {
192 return this->max_msg_len;
193 }
194
195 METHOD(imv_state_t, set_action_flags, void,
196 private_imv_scanner_state_t *this, uint32_t flags)
197 {
198 this->action_flags |= flags;
199 }
200
201 METHOD(imv_state_t, get_action_flags, uint32_t,
202 private_imv_scanner_state_t *this)
203 {
204 return this->action_flags;
205 }
206
207 METHOD(imv_state_t, set_session, void,
208 private_imv_scanner_state_t *this, imv_session_t *session)
209 {
210 this->session = session;
211 }
212
213 METHOD(imv_state_t, get_session, imv_session_t*,
214 private_imv_scanner_state_t *this)
215 {
216 return this->session;
217 }
218
219 METHOD(imv_state_t, get_contracts, seg_contract_manager_t*,
220 private_imv_scanner_state_t *this)
221 {
222 return this->contracts;
223 }
224
225 METHOD(imv_state_t, change_state, void,
226 private_imv_scanner_state_t *this, TNC_ConnectionState new_state)
227 {
228 this->state = new_state;
229 }
230
231 METHOD(imv_state_t, get_recommendation, void,
232 private_imv_scanner_state_t *this, TNC_IMV_Action_Recommendation *rec,
233 TNC_IMV_Evaluation_Result *eval)
234 {
235 *rec = this->rec;
236 *eval = this->eval;
237 }
238
239 METHOD(imv_state_t, set_recommendation, void,
240 private_imv_scanner_state_t *this, TNC_IMV_Action_Recommendation rec,
241 TNC_IMV_Evaluation_Result eval)
242 {
243 this->rec = rec;
244 this->eval = eval;
245 }
246
247 METHOD(imv_state_t, update_recommendation, void,
248 private_imv_scanner_state_t *this, TNC_IMV_Action_Recommendation rec,
249 TNC_IMV_Evaluation_Result eval)
250 {
251 this->rec = tncif_policy_update_recommendation(this->rec, rec);
252 this->eval = tncif_policy_update_evaluation(this->eval, eval);
253 }
254
255 METHOD(imv_state_t, get_reason_string, bool,
256 private_imv_scanner_state_t *this, enumerator_t *language_enumerator,
257 chunk_t *reason_string, char **reason_language)
258 {
259 if (this->violating_ports->get_count(this->violating_ports) == 0)
260 {
261 return FALSE;
262 }
263 *reason_language = imv_lang_string_select_lang(language_enumerator,
264 languages, countof(languages));
265
266 /* Instantiate a TNC Reason String object */
267 DESTROY_IF(this->reason_string);
268 this->reason_string = imv_reason_string_create(*reason_language, "\n");
269 if (this->rec != TNC_IMV_ACTION_RECOMMENDATION_NO_RECOMMENDATION)
270 {
271 this->reason_string->add_reason(this->reason_string, reasons);
272 }
273 *reason_string = this->reason_string->get_encoding(this->reason_string);
274
275 return TRUE;
276 }
277
278 METHOD(imv_state_t, get_remediation_instructions, bool,
279 private_imv_scanner_state_t *this, enumerator_t *language_enumerator,
280 chunk_t *string, char **lang_code, char **uri)
281 {
282 if (this->violating_ports->get_count(this->violating_ports) == 0)
283 {
284 return FALSE;
285 }
286 *lang_code = imv_lang_string_select_lang(language_enumerator,
287 languages, countof(languages));
288
289 /* Instantiate an IETF Remediation Instructions String object */
290 DESTROY_IF(this->remediation_string);
291 this->remediation_string = imv_remediation_string_create(
292 TRUE, *lang_code); /* TODO get os_type */
293
294 this->remediation_string->add_instruction(this->remediation_string,
295 instr_ports_title,
296 instr_ports_descr,
297 instr_ports_header,
298 this->violating_ports);
299 *string = this->remediation_string->get_encoding(this->remediation_string);
300 *uri = lib->settings->get_str(lib->settings,
301 "%s.plugins.imv-scanner.remediation_uri", NULL, lib->ns);
302
303 return TRUE;
304 }
305
306 METHOD(imv_state_t, destroy, void,
307 private_imv_scanner_state_t *this)
308 {
309 DESTROY_IF(this->session);
310 DESTROY_IF(this->reason_string);
311 DESTROY_IF(this->remediation_string);
312 DESTROY_IF(&this->port_filter_attr->pa_tnc_attribute);
313 this->contracts->destroy(this->contracts);
314 this->violating_ports->destroy_function(this->violating_ports, free);
315 free(this);
316 }
317
318 METHOD(imv_scanner_state_t, set_handshake_state, void,
319 private_imv_scanner_state_t *this, imv_scanner_handshake_state_t new_state)
320 {
321 this->handshake_state = new_state;
322 }
323
324 METHOD(imv_scanner_state_t, get_handshake_state, imv_scanner_handshake_state_t,
325 private_imv_scanner_state_t *this)
326 {
327 return this->handshake_state;
328 }
329
330 METHOD(imv_scanner_state_t, set_port_filter_attr, void,
331 private_imv_scanner_state_t *this, ietf_attr_port_filter_t *attr)
332 {
333 DESTROY_IF(&this->port_filter_attr->pa_tnc_attribute);
334 this->port_filter_attr = attr;
335 }
336
337 METHOD(imv_scanner_state_t, get_port_filter_attr, ietf_attr_port_filter_t*,
338 private_imv_scanner_state_t *this)
339 {
340 return this->port_filter_attr;
341 }
342
343 METHOD(imv_scanner_state_t, add_violating_port, void,
344 private_imv_scanner_state_t *this, char *port)
345 {
346 this->violating_ports->insert_last(this->violating_ports, port);
347 }
348
349 /**
350 * Described in header.
351 */
352 imv_state_t *imv_scanner_state_create(TNC_ConnectionID connection_id)
353 {
354 private_imv_scanner_state_t *this;
355
356 INIT(this,
357 .public = {
358 .interface = {
359 .get_connection_id = _get_connection_id,
360 .has_long = _has_long,
361 .has_excl = _has_excl,
362 .set_flags = _set_flags,
363 .set_max_msg_len = _set_max_msg_len,
364 .get_max_msg_len = _get_max_msg_len,
365 .set_action_flags = _set_action_flags,
366 .get_action_flags = _get_action_flags,
367 .set_session = _set_session,
368 .get_session= _get_session,
369 .get_contracts = _get_contracts,
370 .change_state = _change_state,
371 .get_recommendation = _get_recommendation,
372 .set_recommendation = _set_recommendation,
373 .update_recommendation = _update_recommendation,
374 .get_reason_string = _get_reason_string,
375 .get_remediation_instructions = _get_remediation_instructions,
376 .destroy = _destroy,
377 },
378 .set_handshake_state = _set_handshake_state,
379 .get_handshake_state = _get_handshake_state,
380 .set_port_filter_attr = _set_port_filter_attr,
381 .get_port_filter_attr = _get_port_filter_attr,
382 .add_violating_port = _add_violating_port,
383 },
384 .state = TNC_CONNECTION_STATE_CREATE,
385 .rec = TNC_IMV_ACTION_RECOMMENDATION_NO_RECOMMENDATION,
386 .eval = TNC_IMV_EVALUATION_RESULT_DONT_KNOW,
387 .connection_id = connection_id,
388 .contracts = seg_contract_manager_create(),
389 .violating_ports = linked_list_create(),
390 );
391
392 return &this->public.interface;
393 }
394
395