5f2af9baf2e5b73062f2aa10f94fe9e35a56bcf8
[strongswan.git] / src / libimcv / plugins / imc_os / imc_os.c
1 /*
2 * Copyright (C) 2011-2012 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 "imc_os_state.h"
17
18 #include <imc/imc_agent.h>
19 #include <imc/imc_msg.h>
20 #include <ietf/ietf_attr.h>
21 #include <ietf/ietf_attr_attr_request.h>
22 #include <ietf/ietf_attr_default_pwd_enabled.h>
23 #include <ietf/ietf_attr_fwd_enabled.h>
24 #include <ietf/ietf_attr_installed_packages.h>
25 #include <ietf/ietf_attr_numeric_version.h>
26 #include <ietf/ietf_attr_op_status.h>
27 #include <ietf/ietf_attr_product_info.h>
28 #include <ietf/ietf_attr_remediation_instr.h>
29 #include <ietf/ietf_attr_string_version.h>
30 #include <ita/ita_attr.h>
31 #include <ita/ita_attr_get_settings.h>
32 #include <ita/ita_attr_settings.h>
33 #include <ita/ita_attr_angel.h>
34 #include <os_info/os_info.h>
35
36 #include <tncif_pa_subtypes.h>
37
38 #include <pen/pen.h>
39 #include <utils/debug.h>
40
41 /* IMC definitions */
42
43 static const char imc_name[] = "OS";
44
45 static pen_type_t msg_types[] = {
46 { PEN_IETF, PA_SUBTYPE_IETF_OPERATING_SYSTEM }
47 };
48
49 static imc_agent_t *imc_os;
50 static os_info_t *os;
51
52 /**
53 * see section 3.8.1 of TCG TNC IF-IMC Specification 1.3
54 */
55 TNC_Result TNC_IMC_Initialize(TNC_IMCID imc_id,
56 TNC_Version min_version,
57 TNC_Version max_version,
58 TNC_Version *actual_version)
59 {
60 if (imc_os)
61 {
62 DBG1(DBG_IMC, "IMC \"%s\" has already been initialized", imc_name);
63 return TNC_RESULT_ALREADY_INITIALIZED;
64 }
65 imc_os = imc_agent_create(imc_name, msg_types, countof(msg_types),
66 imc_id, actual_version);
67 if (!imc_os)
68 {
69 return TNC_RESULT_FATAL;
70 }
71
72 os = os_info_create();
73 if (!os)
74 {
75 imc_os->destroy(imc_os);
76 imc_os = NULL;
77
78 return TNC_RESULT_FATAL;
79 }
80
81 if (min_version > TNC_IFIMC_VERSION_1 || max_version < TNC_IFIMC_VERSION_1)
82 {
83 DBG1(DBG_IMC, "no common IF-IMC version");
84 return TNC_RESULT_NO_COMMON_VERSION;
85 }
86 return TNC_RESULT_SUCCESS;
87 }
88
89 /**
90 * see section 3.8.2 of TCG TNC IF-IMC Specification 1.3
91 */
92 TNC_Result TNC_IMC_NotifyConnectionChange(TNC_IMCID imc_id,
93 TNC_ConnectionID connection_id,
94 TNC_ConnectionState new_state)
95 {
96 imc_state_t *state;
97
98 if (!imc_os)
99 {
100 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
101 return TNC_RESULT_NOT_INITIALIZED;
102 }
103 switch (new_state)
104 {
105 case TNC_CONNECTION_STATE_CREATE:
106 state = imc_os_state_create(connection_id);
107 return imc_os->create_state(imc_os, state);
108 case TNC_CONNECTION_STATE_HANDSHAKE:
109 if (imc_os->change_state(imc_os, connection_id, new_state,
110 &state) != TNC_RESULT_SUCCESS)
111 {
112 return TNC_RESULT_FATAL;
113 }
114 state->set_result(state, imc_id,
115 TNC_IMV_EVALUATION_RESULT_DONT_KNOW);
116 return TNC_RESULT_SUCCESS;
117 case TNC_CONNECTION_STATE_DELETE:
118 return imc_os->delete_state(imc_os, connection_id);
119 default:
120 return imc_os->change_state(imc_os, connection_id,
121 new_state, NULL);
122 }
123 }
124
125 /**
126 * Add IETF Product Information attribute to the send queue
127 */
128 static void add_product_info(imc_msg_t *msg)
129 {
130 pa_tnc_attr_t *attr;
131 os_type_t os_type;
132 pen_t vendor_id = PEN_IETF;
133 int i;
134
135 typedef struct vendor_pen_t {
136 os_type_t os_type;
137 pen_t pen;
138 } vendor_pen_t;
139
140 vendor_pen_t vendor_pens[] = {
141 { OS_TYPE_DEBIAN, PEN_DEBIAN },
142 { OS_TYPE_UBUNTU, PEN_CANONICAL },
143 { OS_TYPE_FEDORA, PEN_FEDORA },
144 { OS_TYPE_REDHAT, PEN_REDHAT },
145 { OS_TYPE_ANDROID, PEN_GOOGLE }
146 };
147
148 os_type = os->get_type(os);
149 for (i = 0; i < countof(vendor_pens); i++)
150 {
151 if (os_type == vendor_pens[i].os_type)
152 {
153 vendor_id = vendor_pens[i].pen;
154 break;
155 }
156 }
157 attr = ietf_attr_product_info_create(vendor_id, 0, os->get_name(os));
158 msg->add_attribute(msg, attr);
159 }
160
161 /**
162 * Add IETF Numeric Version attribute to the send queue
163 */
164 static void add_numeric_version(imc_msg_t *msg)
165 {
166 pa_tnc_attr_t *attr;
167 u_int32_t major, minor;
168
169 os->get_numeric_version(os, &major, &minor);
170 DBG1(DBG_IMC, "operating system numeric version is %d.%d",
171 major, minor);
172
173 attr = ietf_attr_numeric_version_create(major, minor, 0, 0, 0);
174 msg->add_attribute(msg, attr);
175 }
176
177 /**
178 * Add IETF String Version attribute to the send queue
179 */
180 static void add_string_version(imc_msg_t *msg)
181 {
182 pa_tnc_attr_t *attr;
183
184 attr = ietf_attr_string_version_create(os->get_version(os),
185 chunk_empty, chunk_empty);
186 msg->add_attribute(msg, attr);
187 }
188
189 /**
190 * Add IETF Operational Status attribute to the send queue
191 */
192 static void add_op_status(imc_msg_t *msg)
193 {
194 pa_tnc_attr_t *attr;
195 time_t uptime, last_boot;
196
197 uptime = os->get_uptime(os);
198 last_boot = uptime ? time(NULL) - uptime : UNDEFINED_TIME;
199 if (last_boot != UNDEFINED_TIME)
200 {
201 DBG1(DBG_IMC, "last boot: %T, %u s ago", &last_boot, TRUE, uptime);
202 }
203 attr = ietf_attr_op_status_create(OP_STATUS_OPERATIONAL,
204 OP_RESULT_SUCCESSFUL, last_boot);
205 msg->add_attribute(msg, attr);
206 }
207
208 /**
209 * Add IETF Forwarding Enabled attribute to the send queue
210 */
211 static void add_fwd_enabled(imc_msg_t *msg)
212 {
213 pa_tnc_attr_t *attr;
214 os_fwd_status_t fwd_status;
215
216 fwd_status = os->get_fwd_status(os);
217 DBG1(DBG_IMC, "IPv4 forwarding status: %N",
218 os_fwd_status_names, fwd_status);
219 attr = ietf_attr_fwd_enabled_create(fwd_status);
220 msg->add_attribute(msg, attr);
221 }
222
223 /**
224 * Add IETF Factory Default Password Enabled attribute to the send queue
225 */
226 static void add_default_pwd_enabled(imc_msg_t *msg)
227 {
228 pa_tnc_attr_t *attr;
229
230 DBG1(DBG_IMC, "factory default password: disabled");
231 attr = ietf_attr_default_pwd_enabled_create(FALSE);
232 msg->add_attribute(msg, attr);
233 }
234
235 /**
236 * Add an IETF Installed Packages attribute to the send queue
237 */
238 static void add_installed_packages(imc_state_t *state, imc_msg_t *msg)
239 {
240 pa_tnc_attr_t *attr = NULL, *attr_angel;
241 ietf_attr_installed_packages_t *attr_cast;
242 enumerator_t *enumerator;
243 chunk_t name, version;
244 size_t max_attr_size, attr_size, entry_size;
245 bool first = TRUE;
246
247 /**
248 * Compute the maximum IETF Installed Packages attribute size
249 * leaving space for an additional ITA Angel attribute
250 */
251 max_attr_size = state->get_max_msg_len(state) - 8 - 12;
252
253 /* At least one IETF Installed Packages attribute is sent */
254 attr = ietf_attr_installed_packages_create();
255 attr_size = 12 + 4;
256
257 enumerator = os->create_package_enumerator(os);
258 if (enumerator)
259 {
260 while (enumerator->enumerate(enumerator, &name, &version))
261 {
262 DBG2(DBG_IMC, "package '%.*s' (%.*s)",
263 name.len, name.ptr, version.len, version.ptr);
264
265 entry_size = 2 + name.len + version.len;
266 if (attr_size + entry_size > max_attr_size)
267 {
268 if (first)
269 {
270 /**
271 * Send an ITA Start Angel attribute to the IMV signalling
272 * that multiple ITA Installed Package attributes follow.
273 */
274 attr_angel = ita_attr_angel_create(TRUE);
275 msg->add_attribute(msg, attr_angel);
276 first = FALSE;
277 }
278 msg->add_attribute(msg, attr);
279
280 /* create the next IETF Installed Packages attribute */
281 attr = ietf_attr_installed_packages_create();
282 attr_size = 12 + 4;
283 }
284 attr_cast = (ietf_attr_installed_packages_t*)attr;
285 attr_cast->add(attr_cast, name, version);
286 attr_size += entry_size;
287 }
288 enumerator->destroy(enumerator);
289 }
290 msg->add_attribute(msg, attr);
291
292 if (!first)
293 {
294 /**
295 * If we sent an ITA Start Angel attribute in the first place,
296 * terminate by appending a matching ITA Stop Angel attribute.
297 */
298 attr_angel = ita_attr_angel_create(FALSE);
299 msg->add_attribute(msg, attr_angel);
300 }
301 }
302
303 /**
304 * Add ITA Settings attribute to the send queue
305 */
306 static void add_settings(enumerator_t *enumerator, imc_msg_t *msg)
307 {
308 pa_tnc_attr_t *attr = NULL;
309 ita_attr_settings_t *attr_cast;
310 chunk_t value;
311 char *name;
312 bool first = TRUE;
313
314 while (enumerator->enumerate(enumerator, &name))
315 {
316 DBG1(DBG_IMC, "setting '%s'", name);
317
318 value = os->get_setting(os, name);
319 if (!value.ptr)
320 {
321 continue;
322 }
323 if (first)
324 {
325 attr = ita_attr_settings_create();
326 first = FALSE;
327 }
328 attr_cast = (ita_attr_settings_t*)attr;
329 attr_cast->add(attr_cast, name, value);
330 chunk_free(&value);
331 }
332
333 if (attr)
334 {
335 msg->add_attribute(msg, attr);
336 }
337 }
338
339 /**
340 * see section 3.8.3 of TCG TNC IF-IMC Specification 1.3
341 */
342 TNC_Result TNC_IMC_BeginHandshake(TNC_IMCID imc_id,
343 TNC_ConnectionID connection_id)
344 {
345 imc_state_t *state;
346 imc_msg_t *out_msg;
347 TNC_Result result = TNC_RESULT_SUCCESS;
348
349 if (!imc_os)
350 {
351 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
352 return TNC_RESULT_NOT_INITIALIZED;
353 }
354 if (!imc_os->get_state(imc_os, connection_id, &state))
355 {
356 return TNC_RESULT_FATAL;
357 }
358 if (lib->settings->get_bool(lib->settings,
359 "libimcv.plugins.imc-os.send_info", TRUE))
360 {
361 out_msg = imc_msg_create(imc_os, state, connection_id, imc_id,
362 TNC_IMVID_ANY, msg_types[0]);
363 add_product_info(out_msg);
364 add_string_version(out_msg);
365 add_numeric_version(out_msg);
366 add_op_status(out_msg);
367 add_fwd_enabled(out_msg);
368 add_default_pwd_enabled(out_msg);
369
370 /* send PA-TNC message with the excl flag not set */
371 result = out_msg->send(out_msg, FALSE);
372 out_msg->destroy(out_msg);
373 }
374
375 return result;
376 }
377
378 static TNC_Result receive_message(imc_state_t *state, imc_msg_t *in_msg)
379 {
380 imc_msg_t *out_msg;
381 enumerator_t *enumerator;
382 pa_tnc_attr_t *attr;
383 pen_type_t type;
384 TNC_Result result;
385 bool fatal_error = FALSE;
386
387 /* parse received PA-TNC message and handle local and remote errors */
388 result = in_msg->receive(in_msg, &fatal_error);
389 if (result != TNC_RESULT_SUCCESS)
390 {
391 return result;
392 }
393 out_msg = imc_msg_create_as_reply(in_msg);
394
395 /* analyze PA-TNC attributes */
396 enumerator = in_msg->create_attribute_enumerator(in_msg);
397 while (enumerator->enumerate(enumerator, &attr))
398 {
399 type = attr->get_type(attr);
400
401 if (type.vendor_id == PEN_IETF)
402 {
403 if (type.type == IETF_ATTR_ATTRIBUTE_REQUEST)
404 {
405 ietf_attr_attr_request_t *attr_cast;
406 pen_type_t *entry;
407 enumerator_t *e;
408
409 attr_cast = (ietf_attr_attr_request_t*)attr;
410
411 e = attr_cast->create_enumerator(attr_cast);
412 while (e->enumerate(e, &entry))
413 {
414 if (entry->vendor_id != PEN_IETF)
415 {
416 continue;
417 }
418 switch (entry->type)
419 {
420 case IETF_ATTR_PRODUCT_INFORMATION:
421 add_product_info(out_msg);
422 break;
423 case IETF_ATTR_STRING_VERSION:
424 add_string_version(out_msg);
425 break;
426 case IETF_ATTR_NUMERIC_VERSION:
427 add_numeric_version(out_msg);
428 break;
429 case IETF_ATTR_OPERATIONAL_STATUS:
430 add_op_status(out_msg);
431 break;
432 case IETF_ATTR_FORWARDING_ENABLED:
433 add_fwd_enabled(out_msg);
434 break;
435 case IETF_ATTR_FACTORY_DEFAULT_PWD_ENABLED:
436 add_default_pwd_enabled(out_msg);
437 break;
438 case IETF_ATTR_INSTALLED_PACKAGES:
439 add_installed_packages(state, out_msg);
440 break;
441 default:
442 break;
443 }
444 }
445 e->destroy(e);
446 }
447 else if (type.type == IETF_ATTR_REMEDIATION_INSTRUCTIONS)
448 {
449 ietf_attr_remediation_instr_t *attr_cast;
450 pen_type_t parameters_type;
451 chunk_t parameters, string, lang_code;
452
453 attr_cast = (ietf_attr_remediation_instr_t*)attr;
454 parameters_type = attr_cast->get_parameters_type(attr_cast);
455 parameters = attr_cast->get_parameters(attr_cast);
456
457 if (parameters_type.vendor_id == PEN_IETF)
458 {
459 switch (parameters_type.type)
460 {
461 case IETF_REMEDIATION_PARAMETERS_URI:
462 DBG1(DBG_IMC, "remediation uri: '%.*s'",
463 parameters.len, parameters.ptr);
464 break;
465 case IETF_REMEDIATION_PARAMETERS_STRING:
466 string = attr_cast->get_string(attr_cast, &lang_code);
467 DBG1(DBG_IMC, "remediation string: '%.*s' [%.*s]",
468 string.len, string.ptr,
469 lang_code.len, lang_code.ptr);
470 break;
471 default:
472 DBG1(DBG_IMC, "remediation parameters %B", &parameters);
473 }
474 }
475 else
476 {
477 DBG1(DBG_IMC, "remediation parameters %B", &parameters);
478 }
479 }
480 }
481 else if (type.vendor_id == PEN_ITA && type.type == ITA_ATTR_GET_SETTINGS)
482 {
483 ita_attr_get_settings_t *attr_cast;
484 enumerator_t *e;
485
486 attr_cast = (ita_attr_get_settings_t*)attr;
487
488 e = attr_cast->create_enumerator(attr_cast);
489 add_settings(e, out_msg);
490 e->destroy(e);
491 }
492 }
493 enumerator->destroy(enumerator);
494
495 if (fatal_error)
496 {
497 result = TNC_RESULT_FATAL;
498 }
499 else
500 {
501 result = out_msg->send(out_msg, TRUE);
502 }
503 out_msg->destroy(out_msg);
504
505 return result;
506 }
507
508 /**
509 * see section 3.8.4 of TCG TNC IF-IMC Specification 1.3
510
511 */
512 TNC_Result TNC_IMC_ReceiveMessage(TNC_IMCID imc_id,
513 TNC_ConnectionID connection_id,
514 TNC_BufferReference msg,
515 TNC_UInt32 msg_len,
516 TNC_MessageType msg_type)
517 {
518 imc_state_t *state;
519 imc_msg_t *in_msg;
520 TNC_Result result;
521
522 if (!imc_os)
523 {
524 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
525 return TNC_RESULT_NOT_INITIALIZED;
526 }
527 if (!imc_os->get_state(imc_os, connection_id, &state))
528 {
529 return TNC_RESULT_FATAL;
530 }
531 in_msg = imc_msg_create_from_data(imc_os, state, connection_id, msg_type,
532 chunk_create(msg, msg_len));
533 result = receive_message(state, in_msg);
534 in_msg->destroy(in_msg);
535
536 return result;
537 }
538
539 /**
540 * see section 3.8.6 of TCG TNC IF-IMV Specification 1.3
541 */
542 TNC_Result TNC_IMC_ReceiveMessageLong(TNC_IMCID imc_id,
543 TNC_ConnectionID connection_id,
544 TNC_UInt32 msg_flags,
545 TNC_BufferReference msg,
546 TNC_UInt32 msg_len,
547 TNC_VendorID msg_vid,
548 TNC_MessageSubtype msg_subtype,
549 TNC_UInt32 src_imv_id,
550 TNC_UInt32 dst_imc_id)
551 {
552 imc_state_t *state;
553 imc_msg_t *in_msg;
554 TNC_Result result;
555
556 if (!imc_os)
557 {
558 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
559 return TNC_RESULT_NOT_INITIALIZED;
560 }
561 if (!imc_os->get_state(imc_os, connection_id, &state))
562 {
563 return TNC_RESULT_FATAL;
564 }
565 in_msg = imc_msg_create_from_long_data(imc_os, state, connection_id,
566 src_imv_id, dst_imc_id,msg_vid, msg_subtype,
567 chunk_create(msg, msg_len));
568 result =receive_message(state, in_msg);
569 in_msg->destroy(in_msg);
570
571 return result;
572 }
573
574 /**
575 * see section 3.8.7 of TCG TNC IF-IMC Specification 1.3
576 */
577 TNC_Result TNC_IMC_BatchEnding(TNC_IMCID imc_id,
578 TNC_ConnectionID connection_id)
579 {
580 if (!imc_os)
581 {
582 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
583 return TNC_RESULT_NOT_INITIALIZED;
584 }
585 return TNC_RESULT_SUCCESS;
586 }
587
588 /**
589 * see section 3.8.8 of TCG TNC IF-IMC Specification 1.3
590 */
591 TNC_Result TNC_IMC_Terminate(TNC_IMCID imc_id)
592 {
593 if (!imc_os)
594 {
595 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
596 return TNC_RESULT_NOT_INITIALIZED;
597 }
598 imc_os->destroy(imc_os);
599 imc_os = NULL;
600
601 os->destroy(os);
602 os = NULL;
603
604 return TNC_RESULT_SUCCESS;
605 }
606
607 /**
608 * see section 4.2.8.1 of TCG TNC IF-IMC Specification 1.3
609 */
610 TNC_Result TNC_IMC_ProvideBindFunction(TNC_IMCID imc_id,
611 TNC_TNCC_BindFunctionPointer bind_function)
612 {
613 if (!imc_os)
614 {
615 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
616 return TNC_RESULT_NOT_INITIALIZED;
617 }
618 return imc_os->bind_functions(imc_os, bind_function);
619 }