imc/imv->send_message() uses attr_list
[strongswan.git] / src / libpts / plugins / imv_attestation / imv_attestation.c
1 /*
2 * Copyright (C) 2011 Sansar Choinyambuu
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_attestation_state.h"
17 #include "imv_attestation_process.h"
18 #include "imv_attestation_build.h"
19
20 #include <imv/imv_agent.h>
21 #include <pa_tnc/pa_tnc_msg.h>
22 #include <ietf/ietf_attr.h>
23 #include <ietf/ietf_attr_pa_tnc_error.h>
24 #include <ietf/ietf_attr_product_info.h>
25
26 #include <libpts.h>
27
28 #include <pts/pts.h>
29 #include <pts/pts_database.h>
30 #include <pts/pts_creds.h>
31
32 #include <tcg/tcg_attr.h>
33
34 #include <tncif_pa_subtypes.h>
35
36 #include <pen/pen.h>
37 #include <debug.h>
38 #include <credentials/credential_manager.h>
39 #include <utils/linked_list.h>
40
41 /* IMV definitions */
42
43 static const char imv_name[] = "Attestation";
44
45 #define IMV_VENDOR_ID PEN_TCG
46 #define IMV_SUBTYPE PA_SUBTYPE_TCG_PTS
47
48 static imv_agent_t *imv_attestation;
49
50 /**
51 * Supported PTS measurement algorithms
52 */
53 static pts_meas_algorithms_t supported_algorithms = PTS_MEAS_ALGO_NONE;
54
55 /**
56 * Supported PTS Diffie Hellman Groups
57 */
58 static pts_dh_group_t supported_dh_groups = PTS_DH_GROUP_NONE;
59
60 /**
61 * PTS file measurement database
62 */
63 static pts_database_t *pts_db;
64
65 /**
66 * PTS credentials
67 */
68 static pts_creds_t *pts_creds;
69
70 /**
71 * PTS credential manager
72 */
73 static credential_manager_t *pts_credmgr;
74
75 /**
76 * see section 3.8.1 of TCG TNC IF-IMV Specification 1.3
77 */
78 TNC_Result TNC_IMV_Initialize(TNC_IMVID imv_id,
79 TNC_Version min_version,
80 TNC_Version max_version,
81 TNC_Version *actual_version)
82 {
83 char *hash_alg, *dh_group, *uri, *cadir;
84
85 if (imv_attestation)
86 {
87 DBG1(DBG_IMV, "IMV \"%s\" has already been initialized", imv_name);
88 return TNC_RESULT_ALREADY_INITIALIZED;
89 }
90 if (!pts_meas_algo_probe(&supported_algorithms) ||
91 !pts_dh_group_probe(&supported_dh_groups))
92 {
93 return TNC_RESULT_FATAL;
94 }
95 imv_attestation = imv_agent_create(imv_name, IMV_VENDOR_ID, IMV_SUBTYPE,
96 imv_id, actual_version);
97 if (!imv_attestation)
98 {
99 return TNC_RESULT_FATAL;
100 }
101
102 libpts_init();
103
104 if (min_version > TNC_IFIMV_VERSION_1 || max_version < TNC_IFIMV_VERSION_1)
105 {
106 DBG1(DBG_IMV, "no common IF-IMV version");
107 return TNC_RESULT_NO_COMMON_VERSION;
108 }
109
110 hash_alg = lib->settings->get_str(lib->settings,
111 "libimcv.plugins.imv-attestation.hash_algorithm", "sha256");
112 dh_group = lib->settings->get_str(lib->settings,
113 "libimcv.plugins.imv-attestation.dh_group", "ecp256");
114
115 if (!pts_meas_algo_update(hash_alg, &supported_algorithms) ||
116 !pts_dh_group_update(dh_group, &supported_dh_groups))
117 {
118 return TNC_RESULT_FATAL;
119 }
120
121 /* create a PTS credential manager */
122 pts_credmgr = credential_manager_create();
123
124 /* create PTS credential set */
125 cadir = lib->settings->get_str(lib->settings,
126 "libimcv.plugins.imv-attestation.cadir", NULL);
127 pts_creds = pts_creds_create(cadir);
128 if (pts_creds)
129 {
130 pts_credmgr->add_set(pts_credmgr, pts_creds->get_set(pts_creds));
131 }
132
133 /* attach file measurement database */
134 uri = lib->settings->get_str(lib->settings,
135 "libimcv.plugins.imv-attestation.database", NULL);
136 pts_db = pts_database_create(uri);
137
138 return TNC_RESULT_SUCCESS;
139 }
140
141 /**
142 * see section 3.8.2 of TCG TNC IF-IMV Specification 1.3
143 */
144 TNC_Result TNC_IMV_NotifyConnectionChange(TNC_IMVID imv_id,
145 TNC_ConnectionID connection_id,
146 TNC_ConnectionState new_state)
147 {
148 imv_state_t *state;
149
150 if (!imv_attestation)
151 {
152 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
153 return TNC_RESULT_NOT_INITIALIZED;
154 }
155 switch (new_state)
156 {
157 case TNC_CONNECTION_STATE_CREATE:
158 state = imv_attestation_state_create(connection_id);
159 return imv_attestation->create_state(imv_attestation, state);
160 case TNC_CONNECTION_STATE_DELETE:
161 return imv_attestation->delete_state(imv_attestation, connection_id);
162 case TNC_CONNECTION_STATE_HANDSHAKE:
163 default:
164 return imv_attestation->change_state(imv_attestation, connection_id,
165 new_state, NULL);
166 }
167 }
168
169 static TNC_Result send_message(TNC_ConnectionID connection_id)
170 {
171 linked_list_t *attr_list;
172 imv_state_t *state;
173 imv_attestation_state_t *attestation_state;
174 TNC_Result result;
175
176 if (!imv_attestation->get_state(imv_attestation, connection_id, &state))
177 {
178 return TNC_RESULT_FATAL;
179 }
180 attestation_state = (imv_attestation_state_t*)state;
181 attr_list = linked_list_create();
182
183 if (imv_attestation_build(attr_list, attestation_state, supported_algorithms,
184 supported_dh_groups, pts_db))
185 {
186 if (attr_list->get_count(attr_list))
187 {
188 result = imv_attestation->send_message(imv_attestation,
189 connection_id, FALSE, 0, TNC_IMCID_ANY, attr_list);
190 }
191 else
192 {
193 result = TNC_RESULT_SUCCESS;
194 }
195 attr_list->destroy(attr_list);
196 }
197 else
198 {
199 attr_list->destroy_offset(attr_list, offsetof(pa_tnc_attr_t, destroy));
200 result = TNC_RESULT_FATAL;
201 }
202
203 return result;
204 }
205
206 static TNC_Result receive_message(TNC_IMVID imv_id,
207 TNC_ConnectionID connection_id,
208 TNC_UInt32 msg_flags,
209 chunk_t msg,
210 TNC_VendorID msg_vid,
211 TNC_MessageSubtype msg_subtype,
212 TNC_UInt32 src_imc_id,
213 TNC_UInt32 dst_imv_id)
214 {
215 pa_tnc_msg_t *pa_tnc_msg;
216 pa_tnc_attr_t *attr;
217 linked_list_t *attr_list;
218 imv_state_t *state;
219 imv_attestation_state_t *attestation_state;
220 pts_t *pts;
221 enumerator_t *enumerator;
222 TNC_Result result;
223
224 if (!imv_attestation)
225 {
226 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
227 return TNC_RESULT_NOT_INITIALIZED;
228 }
229
230 /* get current IMV state */
231 if (!imv_attestation->get_state(imv_attestation, connection_id, &state))
232 {
233 return TNC_RESULT_FATAL;
234 }
235 attestation_state = (imv_attestation_state_t*)state;
236 pts = attestation_state->get_pts(attestation_state);
237
238 /* parse received PA-TNC message and automatically handle any errors */
239 result = imv_attestation->receive_message(imv_attestation, state, msg,
240 msg_vid, msg_subtype, src_imc_id, dst_imv_id, &pa_tnc_msg);
241
242 /* no parsed PA-TNC attributes available if an error occurred */
243 if (!pa_tnc_msg)
244 {
245 return result;
246 }
247
248 /* preprocess any IETF standard error attributes */
249 result = pa_tnc_msg->process_ietf_std_errors(pa_tnc_msg) ?
250 TNC_RESULT_FATAL : TNC_RESULT_SUCCESS;
251
252 attr_list = linked_list_create();
253
254 /* analyze PA-TNC attributes */
255 enumerator = pa_tnc_msg->create_attribute_enumerator(pa_tnc_msg);
256 while (enumerator->enumerate(enumerator, &attr))
257 {
258 if (attr->get_vendor_id(attr) == PEN_IETF)
259 {
260 if (attr->get_type(attr) == IETF_ATTR_PA_TNC_ERROR)
261 {
262 ietf_attr_pa_tnc_error_t *error_attr;
263 pen_t error_vendor_id;
264 pa_tnc_error_code_t error_code;
265 chunk_t msg_info;
266
267 error_attr = (ietf_attr_pa_tnc_error_t*)attr;
268 error_vendor_id = error_attr->get_vendor_id(error_attr);
269
270 if (error_vendor_id == PEN_TCG)
271 {
272 error_code = error_attr->get_error_code(error_attr);
273 msg_info = error_attr->get_msg_info(error_attr);
274
275 DBG1(DBG_IMV, "received TCG-PTS error '%N'",
276 pts_error_code_names, error_code);
277 DBG1(DBG_IMV, "error information: %B", &msg_info);
278
279 result = TNC_RESULT_FATAL;
280 }
281 }
282 else if (attr->get_type(attr) == IETF_ATTR_PRODUCT_INFORMATION)
283 {
284 ietf_attr_product_info_t *attr_cast;
285 char *platform_info;
286
287 attr_cast = (ietf_attr_product_info_t*)attr;
288 platform_info = attr_cast->get_info(attr_cast, NULL, NULL);
289 pts->set_platform_info(pts, platform_info);
290 }
291 }
292 else if (attr->get_vendor_id(attr) == PEN_TCG)
293 {
294 if (!imv_attestation_process(attr, attr_list, attestation_state,
295 supported_algorithms,supported_dh_groups, pts_db, pts_credmgr))
296 {
297 result = TNC_RESULT_FATAL;
298 break;
299 }
300 }
301 }
302 enumerator->destroy(enumerator);
303 pa_tnc_msg->destroy(pa_tnc_msg);
304
305 if (result != TNC_RESULT_SUCCESS)
306 {
307 attr_list->destroy_offset(attr_list, offsetof(pa_tnc_attr_t, destroy));
308 state->set_recommendation(state,
309 TNC_IMV_ACTION_RECOMMENDATION_ISOLATE,
310 TNC_IMV_EVALUATION_RESULT_ERROR);
311 return imv_attestation->provide_recommendation(imv_attestation,
312 connection_id);
313 }
314
315 if (attr_list->get_count(attr_list))
316 {
317 result = imv_attestation->send_message(imv_attestation, connection_id,
318 FALSE, 0, TNC_IMCID_ANY, attr_list);
319 attr_list->destroy(attr_list);
320 return result;
321 }
322 attr_list->destroy(attr_list);
323
324 /* check the IMV state for the next PA-TNC attributes to send */
325 result = send_message(connection_id);
326 if (result != TNC_RESULT_SUCCESS)
327 {
328 state->set_recommendation(state,
329 TNC_IMV_ACTION_RECOMMENDATION_NO_RECOMMENDATION,
330 TNC_IMV_EVALUATION_RESULT_ERROR);
331 return imv_attestation->provide_recommendation(imv_attestation,
332 connection_id);
333 }
334
335 if (attestation_state->get_handshake_state(attestation_state) ==
336 IMV_ATTESTATION_STATE_END)
337 {
338 if (attestation_state->get_file_meas_request_count(attestation_state))
339 {
340 DBG1(DBG_IMV, "failure due to %d pending file measurements",
341 attestation_state->get_file_meas_request_count(attestation_state));
342 attestation_state->set_measurement_error(attestation_state);
343 }
344 if (attestation_state->get_measurement_error(attestation_state))
345 {
346 state->set_recommendation(state,
347 TNC_IMV_ACTION_RECOMMENDATION_ISOLATE,
348 TNC_IMV_EVALUATION_RESULT_NONCOMPLIANT_MAJOR);
349 }
350 else
351 {
352 state->set_recommendation(state,
353 TNC_IMV_ACTION_RECOMMENDATION_ALLOW,
354 TNC_IMV_EVALUATION_RESULT_COMPLIANT);
355 }
356 return imv_attestation->provide_recommendation(imv_attestation,
357 connection_id);
358 }
359
360 return result;
361 }
362
363 /**
364 * see section 3.8.4 of TCG TNC IF-IMV Specification 1.3
365 */
366 TNC_Result TNC_IMV_ReceiveMessage(TNC_IMVID imv_id,
367 TNC_ConnectionID connection_id,
368 TNC_BufferReference msg,
369 TNC_UInt32 msg_len,
370 TNC_MessageType msg_type)
371 {
372 TNC_VendorID msg_vid;
373 TNC_MessageSubtype msg_subtype;
374
375 msg_vid = msg_type >> 8;
376 msg_subtype = msg_type & TNC_SUBTYPE_ANY;
377
378 return receive_message(imv_id, connection_id, 0, chunk_create(msg, msg_len),
379 msg_vid, msg_subtype, 0, TNC_IMVID_ANY);
380 }
381
382 /**
383 * see section 3.8.6 of TCG TNC IF-IMV Specification 1.3
384 */
385 TNC_Result TNC_IMV_ReceiveMessageLong(TNC_IMVID imv_id,
386 TNC_ConnectionID connection_id,
387 TNC_UInt32 msg_flags,
388 TNC_BufferReference msg,
389 TNC_UInt32 msg_len,
390 TNC_VendorID msg_vid,
391 TNC_MessageSubtype msg_subtype,
392 TNC_UInt32 src_imc_id,
393 TNC_UInt32 dst_imv_id)
394 {
395 return receive_message(imv_id, connection_id, msg_flags,
396 chunk_create(msg, msg_len), msg_vid, msg_subtype,
397 src_imc_id, dst_imv_id);
398 }
399
400 /**
401 * see section 3.8.7 of TCG TNC IF-IMV Specification 1.3
402 */
403 TNC_Result TNC_IMV_SolicitRecommendation(TNC_IMVID imv_id,
404 TNC_ConnectionID connection_id)
405 {
406 if (!imv_attestation)
407 {
408 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
409 return TNC_RESULT_NOT_INITIALIZED;
410 }
411 return imv_attestation->provide_recommendation(imv_attestation,
412 connection_id);
413 }
414
415 /**
416 * see section 3.8.8 of TCG TNC IF-IMV Specification 1.3
417 */
418 TNC_Result TNC_IMV_BatchEnding(TNC_IMVID imv_id,
419 TNC_ConnectionID connection_id)
420 {
421 imv_state_t *state;
422 imv_attestation_state_t *attestation_state;
423
424 if (!imv_attestation)
425 {
426 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
427 return TNC_RESULT_NOT_INITIALIZED;
428 }
429 /* get current IMV state */
430 if (!imv_attestation->get_state(imv_attestation, connection_id, &state))
431 {
432 return TNC_RESULT_FATAL;
433 }
434 attestation_state = (imv_attestation_state_t*)state;
435
436 /* Check if IMV has to initiate the PA-TNC exchange */
437 if (attestation_state->get_handshake_state(attestation_state) ==
438 IMV_ATTESTATION_STATE_INIT)
439 {
440 return send_message(connection_id);
441 }
442 return TNC_RESULT_SUCCESS;
443 }
444
445 /**
446 * see section 3.8.9 of TCG TNC IF-IMV Specification 1.3
447 */
448 TNC_Result TNC_IMV_Terminate(TNC_IMVID imv_id)
449 {
450 if (!imv_attestation)
451 {
452 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
453 return TNC_RESULT_NOT_INITIALIZED;
454 }
455 if (pts_creds)
456 {
457 pts_credmgr->remove_set(pts_credmgr, pts_creds->get_set(pts_creds));
458 pts_creds->destroy(pts_creds);
459 }
460 DESTROY_IF(pts_db);
461 DESTROY_IF(pts_credmgr);
462
463 libpts_deinit();
464
465 imv_attestation->destroy(imv_attestation);
466 imv_attestation = NULL;
467
468 return TNC_RESULT_SUCCESS;
469 }
470
471 /**
472 * see section 4.2.8.1 of TCG TNC IF-IMV Specification 1.3
473 */
474 TNC_Result TNC_IMV_ProvideBindFunction(TNC_IMVID imv_id,
475 TNC_TNCS_BindFunctionPointer bind_function)
476 {
477 if (!imv_attestation)
478 {
479 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
480 return TNC_RESULT_NOT_INITIALIZED;
481 }
482 return imv_attestation->bind_functions(imv_attestation, bind_function);
483 }