libimcv: Move settings to <ns>.imcv and <ns>.plugins with fallback
[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_string_version.h>
29 #include <ita/ita_attr.h>
30 #include <ita/ita_attr_get_settings.h>
31 #include <ita/ita_attr_settings.h>
32 #include <ita/ita_attr_angel.h>
33 #include <ita/ita_attr_device_id.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 is %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 is disabled");
231 attr = ietf_attr_default_pwd_enabled_create(FALSE);
232 msg->add_attribute(msg, attr);
233 }
234
235 /**
236 * Add ITA Device ID attribute to the send queue
237 */
238 static void add_device_id(imc_msg_t *msg)
239 {
240 pa_tnc_attr_t *attr;
241 chunk_t value;
242 char *name;
243
244 name = os->get_type(os) == OS_TYPE_ANDROID ?
245 "android_id" : "/var/lib/dbus/machine-id";
246 value = os->get_setting(os, name);
247
248 if (value.len == 0)
249 {
250 DBG1(DBG_IMC, "no device ID available");
251 return;
252 }
253
254 /* trim trailing newline character */
255 if (value.ptr[value.len - 1] == '\n')
256 {
257 value.len--;
258 }
259
260 DBG1(DBG_IMC, "device ID is %.*s", value.len, value.ptr);
261 attr = ita_attr_device_id_create(value);
262 msg->add_attribute(msg, attr);
263 free(value.ptr);
264 }
265
266 /**
267 * Add an IETF Installed Packages attribute to the send queue
268 */
269 static void add_installed_packages(imc_state_t *state, imc_msg_t *msg)
270 {
271 pa_tnc_attr_t *attr = NULL, *attr_angel;
272 ietf_attr_installed_packages_t *attr_cast;
273 enumerator_t *enumerator;
274 chunk_t name, version;
275 size_t max_attr_size, attr_size, entry_size;
276 bool first = TRUE;
277
278 /**
279 * Compute the maximum IETF Installed Packages attribute size
280 * leaving space for an additional ITA Angel attribute
281 */
282 max_attr_size = state->get_max_msg_len(state) - 8 - 12;
283
284 /* At least one IETF Installed Packages attribute is sent */
285 attr = ietf_attr_installed_packages_create();
286 attr_size = 12 + 4;
287
288 enumerator = os->create_package_enumerator(os);
289 if (enumerator)
290 {
291 while (enumerator->enumerate(enumerator, &name, &version))
292 {
293 DBG2(DBG_IMC, "package '%.*s' (%.*s)",
294 name.len, name.ptr, version.len, version.ptr);
295
296 entry_size = 2 + name.len + version.len;
297 if (attr_size + entry_size > max_attr_size)
298 {
299 if (first)
300 {
301 /**
302 * Send an ITA Start Angel attribute to the IMV signalling
303 * that multiple ITA Installed Package attributes follow.
304 */
305 attr_angel = ita_attr_angel_create(TRUE);
306 msg->add_attribute(msg, attr_angel);
307 first = FALSE;
308 }
309 msg->add_attribute(msg, attr);
310
311 /* create the next IETF Installed Packages attribute */
312 attr = ietf_attr_installed_packages_create();
313 attr_size = 12 + 4;
314 }
315 attr_cast = (ietf_attr_installed_packages_t*)attr;
316 attr_cast->add(attr_cast, name, version);
317 attr_size += entry_size;
318 }
319 enumerator->destroy(enumerator);
320 }
321 msg->add_attribute(msg, attr);
322
323 if (!first)
324 {
325 /**
326 * If we sent an ITA Start Angel attribute in the first place,
327 * terminate by appending a matching ITA Stop Angel attribute.
328 */
329 attr_angel = ita_attr_angel_create(FALSE);
330 msg->add_attribute(msg, attr_angel);
331 }
332 }
333
334 /**
335 * Add ITA Settings attribute to the send queue
336 */
337 static void add_settings(enumerator_t *enumerator, imc_msg_t *msg)
338 {
339 pa_tnc_attr_t *attr = NULL;
340 ita_attr_settings_t *attr_cast;
341 chunk_t value;
342 char *name;
343 bool first = TRUE;
344
345 while (enumerator->enumerate(enumerator, &name))
346 {
347 DBG1(DBG_IMC, "setting '%s'", name);
348
349 value = os->get_setting(os, name);
350 if (!value.ptr)
351 {
352 continue;
353 }
354 if (first)
355 {
356 attr = ita_attr_settings_create();
357 first = FALSE;
358 }
359 attr_cast = (ita_attr_settings_t*)attr;
360 attr_cast->add(attr_cast, name, value);
361 chunk_free(&value);
362 }
363
364 if (attr)
365 {
366 msg->add_attribute(msg, attr);
367 }
368 }
369
370 /**
371 * see section 3.8.3 of TCG TNC IF-IMC Specification 1.3
372 */
373 TNC_Result TNC_IMC_BeginHandshake(TNC_IMCID imc_id,
374 TNC_ConnectionID connection_id)
375 {
376 imc_state_t *state;
377 imc_msg_t *out_msg;
378 TNC_Result result = TNC_RESULT_SUCCESS;
379
380 if (!imc_os)
381 {
382 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
383 return TNC_RESULT_NOT_INITIALIZED;
384 }
385 if (!imc_os->get_state(imc_os, connection_id, &state))
386 {
387 return TNC_RESULT_FATAL;
388 }
389 if (lib->settings->get_bool(lib->settings,
390 "%s.plugins.imc-os.push_info", TRUE, lib->ns))
391 {
392 out_msg = imc_msg_create(imc_os, state, connection_id, imc_id,
393 TNC_IMVID_ANY, msg_types[0]);
394 add_product_info(out_msg);
395 add_string_version(out_msg);
396 add_numeric_version(out_msg);
397 add_op_status(out_msg);
398 add_fwd_enabled(out_msg);
399 add_default_pwd_enabled(out_msg);
400 add_device_id(out_msg);
401
402 /* send PA-TNC message with the excl flag not set */
403 result = out_msg->send(out_msg, FALSE);
404 out_msg->destroy(out_msg);
405 }
406
407 return result;
408 }
409
410 static TNC_Result receive_message(imc_state_t *state, imc_msg_t *in_msg)
411 {
412 imc_msg_t *out_msg;
413 enumerator_t *enumerator;
414 pa_tnc_attr_t *attr;
415 pen_type_t type;
416 TNC_Result result;
417 bool fatal_error = FALSE;
418
419 /* parse received PA-TNC message and handle local and remote errors */
420 result = in_msg->receive(in_msg, &fatal_error);
421 if (result != TNC_RESULT_SUCCESS)
422 {
423 return result;
424 }
425 out_msg = imc_msg_create_as_reply(in_msg);
426
427 /* analyze PA-TNC attributes */
428 enumerator = in_msg->create_attribute_enumerator(in_msg);
429 while (enumerator->enumerate(enumerator, &attr))
430 {
431 type = attr->get_type(attr);
432
433 if (type.vendor_id == PEN_IETF)
434 {
435 if (type.type == IETF_ATTR_ATTRIBUTE_REQUEST)
436 {
437 ietf_attr_attr_request_t *attr_cast;
438 pen_type_t *entry;
439 enumerator_t *e;
440
441 attr_cast = (ietf_attr_attr_request_t*)attr;
442
443 e = attr_cast->create_enumerator(attr_cast);
444 while (e->enumerate(e, &entry))
445 {
446 if (entry->vendor_id == PEN_IETF)
447 {
448 switch (entry->type)
449 {
450 case IETF_ATTR_PRODUCT_INFORMATION:
451 add_product_info(out_msg);
452 break;
453 case IETF_ATTR_STRING_VERSION:
454 add_string_version(out_msg);
455 break;
456 case IETF_ATTR_NUMERIC_VERSION:
457 add_numeric_version(out_msg);
458 break;
459 case IETF_ATTR_OPERATIONAL_STATUS:
460 add_op_status(out_msg);
461 break;
462 case IETF_ATTR_FORWARDING_ENABLED:
463 add_fwd_enabled(out_msg);
464 break;
465 case IETF_ATTR_FACTORY_DEFAULT_PWD_ENABLED:
466 add_default_pwd_enabled(out_msg);
467 break;
468 case IETF_ATTR_INSTALLED_PACKAGES:
469 add_installed_packages(state, out_msg);
470 break;
471 default:
472 break;
473 }
474 }
475 else if (entry->vendor_id == PEN_ITA)
476 {
477 switch (entry->type)
478 {
479 case ITA_ATTR_DEVICE_ID:
480 add_device_id(out_msg);
481 break;
482 default:
483 break;
484 }
485 }
486 }
487 e->destroy(e);
488 }
489 }
490 else if (type.vendor_id == PEN_ITA && type.type == ITA_ATTR_GET_SETTINGS)
491 {
492 ita_attr_get_settings_t *attr_cast;
493 enumerator_t *e;
494
495 attr_cast = (ita_attr_get_settings_t*)attr;
496
497 e = attr_cast->create_enumerator(attr_cast);
498 add_settings(e, out_msg);
499 e->destroy(e);
500 }
501 }
502 enumerator->destroy(enumerator);
503
504 if (fatal_error)
505 {
506 result = TNC_RESULT_FATAL;
507 }
508 else
509 {
510 result = out_msg->send(out_msg, TRUE);
511 }
512 out_msg->destroy(out_msg);
513
514 return result;
515 }
516
517 /**
518 * see section 3.8.4 of TCG TNC IF-IMC Specification 1.3
519
520 */
521 TNC_Result TNC_IMC_ReceiveMessage(TNC_IMCID imc_id,
522 TNC_ConnectionID connection_id,
523 TNC_BufferReference msg,
524 TNC_UInt32 msg_len,
525 TNC_MessageType msg_type)
526 {
527 imc_state_t *state;
528 imc_msg_t *in_msg;
529 TNC_Result result;
530
531 if (!imc_os)
532 {
533 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
534 return TNC_RESULT_NOT_INITIALIZED;
535 }
536 if (!imc_os->get_state(imc_os, connection_id, &state))
537 {
538 return TNC_RESULT_FATAL;
539 }
540 in_msg = imc_msg_create_from_data(imc_os, state, connection_id, msg_type,
541 chunk_create(msg, msg_len));
542 result = receive_message(state, in_msg);
543 in_msg->destroy(in_msg);
544
545 return result;
546 }
547
548 /**
549 * see section 3.8.6 of TCG TNC IF-IMV Specification 1.3
550 */
551 TNC_Result TNC_IMC_ReceiveMessageLong(TNC_IMCID imc_id,
552 TNC_ConnectionID connection_id,
553 TNC_UInt32 msg_flags,
554 TNC_BufferReference msg,
555 TNC_UInt32 msg_len,
556 TNC_VendorID msg_vid,
557 TNC_MessageSubtype msg_subtype,
558 TNC_UInt32 src_imv_id,
559 TNC_UInt32 dst_imc_id)
560 {
561 imc_state_t *state;
562 imc_msg_t *in_msg;
563 TNC_Result result;
564
565 if (!imc_os)
566 {
567 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
568 return TNC_RESULT_NOT_INITIALIZED;
569 }
570 if (!imc_os->get_state(imc_os, connection_id, &state))
571 {
572 return TNC_RESULT_FATAL;
573 }
574 in_msg = imc_msg_create_from_long_data(imc_os, state, connection_id,
575 src_imv_id, dst_imc_id,msg_vid, msg_subtype,
576 chunk_create(msg, msg_len));
577 result =receive_message(state, in_msg);
578 in_msg->destroy(in_msg);
579
580 return result;
581 }
582
583 /**
584 * see section 3.8.7 of TCG TNC IF-IMC Specification 1.3
585 */
586 TNC_Result TNC_IMC_BatchEnding(TNC_IMCID imc_id,
587 TNC_ConnectionID connection_id)
588 {
589 if (!imc_os)
590 {
591 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
592 return TNC_RESULT_NOT_INITIALIZED;
593 }
594 return TNC_RESULT_SUCCESS;
595 }
596
597 /**
598 * see section 3.8.8 of TCG TNC IF-IMC Specification 1.3
599 */
600 TNC_Result TNC_IMC_Terminate(TNC_IMCID imc_id)
601 {
602 if (!imc_os)
603 {
604 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
605 return TNC_RESULT_NOT_INITIALIZED;
606 }
607 imc_os->destroy(imc_os);
608 imc_os = NULL;
609
610 os->destroy(os);
611 os = NULL;
612
613 return TNC_RESULT_SUCCESS;
614 }
615
616 /**
617 * see section 4.2.8.1 of TCG TNC IF-IMC Specification 1.3
618 */
619 TNC_Result TNC_IMC_ProvideBindFunction(TNC_IMCID imc_id,
620 TNC_TNCC_BindFunctionPointer bind_function)
621 {
622 if (!imc_os)
623 {
624 DBG1(DBG_IMC, "IMC \"%s\" has not been initialized", imc_name);
625 return TNC_RESULT_NOT_INITIALIZED;
626 }
627 return imc_os->bind_functions(imc_os, bind_function);
628 }