added IETF standard error handling method
[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 pa_tnc_msg_t *msg;
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 msg = pa_tnc_msg_create();
182
183 if (imv_attestation_build(msg, attestation_state, supported_algorithms,
184 supported_dh_groups, pts_db))
185 {
186 msg->build(msg);
187 result = imv_attestation->send_message(imv_attestation, connection_id,
188 FALSE, 0, TNC_IMCID_ANY,
189 msg->get_encoding(msg));
190 }
191 else
192 {
193 result = TNC_RESULT_FATAL;
194 }
195 msg->destroy(msg);
196
197 return result;
198 }
199
200 static TNC_Result receive_message(TNC_IMVID imv_id,
201 TNC_ConnectionID connection_id,
202 TNC_UInt32 msg_flags,
203 chunk_t msg,
204 TNC_VendorID msg_vid,
205 TNC_MessageSubtype msg_subtype,
206 TNC_UInt32 src_imc_id,
207 TNC_UInt32 dst_imv_id)
208 {
209 pa_tnc_msg_t *pa_tnc_msg;
210 pa_tnc_attr_t *attr;
211 linked_list_t *attr_list;
212 imv_state_t *state;
213 imv_attestation_state_t *attestation_state;
214 pts_t *pts;
215 enumerator_t *enumerator;
216 TNC_Result result;
217
218 if (!imv_attestation)
219 {
220 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
221 return TNC_RESULT_NOT_INITIALIZED;
222 }
223
224 /* get current IMV state */
225 if (!imv_attestation->get_state(imv_attestation, connection_id, &state))
226 {
227 return TNC_RESULT_FATAL;
228 }
229 attestation_state = (imv_attestation_state_t*)state;
230 pts = attestation_state->get_pts(attestation_state);
231
232 /* parse received PA-TNC message and automatically handle any errors */
233 result = imv_attestation->receive_message(imv_attestation, state, msg,
234 msg_vid, msg_subtype, src_imc_id, dst_imv_id, &pa_tnc_msg);
235
236 /* no parsed PA-TNC attributes available if an error occurred */
237 if (!pa_tnc_msg)
238 {
239 return result;
240 }
241
242 /* preprocess any IETF standard error attributes */
243 result = pa_tnc_msg->process_ietf_std_errors(pa_tnc_msg) ?
244 TNC_RESULT_FATAL : TNC_RESULT_SUCCESS;
245
246 attr_list = linked_list_create();
247
248 /* analyze PA-TNC attributes */
249 enumerator = pa_tnc_msg->create_attribute_enumerator(pa_tnc_msg);
250 while (enumerator->enumerate(enumerator, &attr))
251 {
252 if (attr->get_vendor_id(attr) == PEN_IETF)
253 {
254 if (attr->get_type(attr) == IETF_ATTR_PA_TNC_ERROR)
255 {
256 ietf_attr_pa_tnc_error_t *error_attr;
257 pen_t error_vendor_id;
258 pa_tnc_error_code_t error_code;
259 chunk_t msg_info;
260
261 error_attr = (ietf_attr_pa_tnc_error_t*)attr;
262 error_vendor_id = error_attr->get_vendor_id(error_attr);
263
264 if (error_vendor_id == PEN_TCG)
265 {
266 error_code = error_attr->get_error_code(error_attr);
267 msg_info = error_attr->get_msg_info(error_attr);
268
269 DBG1(DBG_IMV, "received TCG-PTS error '%N'",
270 pts_error_code_names, error_code);
271 DBG1(DBG_IMV, "error information: %B", &msg_info);
272
273 result = TNC_RESULT_FATAL;
274 }
275 }
276 else if (attr->get_type(attr) == IETF_ATTR_PRODUCT_INFORMATION)
277 {
278 ietf_attr_product_info_t *attr_cast;
279 char *platform_info;
280
281 attr_cast = (ietf_attr_product_info_t*)attr;
282 platform_info = attr_cast->get_info(attr_cast, NULL, NULL);
283 pts->set_platform_info(pts, platform_info);
284 }
285 }
286 else if (attr->get_vendor_id(attr) == PEN_TCG)
287 {
288 if (!imv_attestation_process(attr, attr_list, attestation_state,
289 supported_algorithms,supported_dh_groups, pts_db, pts_credmgr))
290 {
291 result = TNC_RESULT_FATAL;
292 break;
293 }
294 }
295 }
296 enumerator->destroy(enumerator);
297 pa_tnc_msg->destroy(pa_tnc_msg);
298
299 if (result != TNC_RESULT_SUCCESS)
300 {
301 attr_list->destroy(attr_list);
302 state->set_recommendation(state,
303 TNC_IMV_ACTION_RECOMMENDATION_NO_RECOMMENDATION,
304 TNC_IMV_EVALUATION_RESULT_ERROR);
305 return imv_attestation->provide_recommendation(imv_attestation,
306 connection_id);
307 }
308
309 if (attr_list->get_count(attr_list))
310 {
311 pa_tnc_msg = pa_tnc_msg_create();
312
313 enumerator = attr_list->create_enumerator(attr_list);
314 while (enumerator->enumerate(enumerator, &attr))
315 {
316 pa_tnc_msg->add_attribute(pa_tnc_msg, attr);
317 }
318 enumerator->destroy(enumerator);
319
320 pa_tnc_msg->build(pa_tnc_msg);
321 result = imv_attestation->send_message(imv_attestation, connection_id,
322 FALSE, 0, TNC_IMCID_ANY,
323 pa_tnc_msg->get_encoding(pa_tnc_msg));
324
325 pa_tnc_msg->destroy(pa_tnc_msg);
326 attr_list->destroy(attr_list);
327
328 return result;
329 }
330 attr_list->destroy(attr_list);
331
332 if (attestation_state->get_handshake_state(attestation_state) ==
333 IMV_ATTESTATION_STATE_END)
334 {
335 if (attestation_state->get_file_meas_request_count(attestation_state))
336 {
337 DBG1(DBG_IMV, "failure due to %d pending file measurements",
338 attestation_state->get_file_meas_request_count(attestation_state));
339 attestation_state->set_measurement_error(attestation_state);
340 }
341 if (attestation_state->get_component_count(attestation_state))
342 {
343 DBG1(DBG_IMV, "failure due to %d components waiting for evidence",
344 attestation_state->get_component_count(attestation_state));
345 attestation_state->set_measurement_error(attestation_state);
346 }
347 if (attestation_state->get_measurement_error(attestation_state))
348 {
349 state->set_recommendation(state,
350 TNC_IMV_ACTION_RECOMMENDATION_ISOLATE,
351 TNC_IMV_EVALUATION_RESULT_NONCOMPLIANT_MAJOR);
352 }
353 else
354 {
355 state->set_recommendation(state,
356 TNC_IMV_ACTION_RECOMMENDATION_ALLOW,
357 TNC_IMV_EVALUATION_RESULT_COMPLIANT);
358 }
359 return imv_attestation->provide_recommendation(imv_attestation,
360 connection_id);
361 }
362
363 return send_message(connection_id);
364 }
365
366 /**
367 * see section 3.8.4 of TCG TNC IF-IMV Specification 1.3
368 */
369 TNC_Result TNC_IMV_ReceiveMessage(TNC_IMVID imv_id,
370 TNC_ConnectionID connection_id,
371 TNC_BufferReference msg,
372 TNC_UInt32 msg_len,
373 TNC_MessageType msg_type)
374 {
375 TNC_VendorID msg_vid;
376 TNC_MessageSubtype msg_subtype;
377
378 msg_vid = msg_type >> 8;
379 msg_subtype = msg_type & TNC_SUBTYPE_ANY;
380
381 return receive_message(imv_id, connection_id, 0, chunk_create(msg, msg_len),
382 msg_vid, msg_subtype, 0, TNC_IMVID_ANY);
383 }
384
385 /**
386 * see section 3.8.6 of TCG TNC IF-IMV Specification 1.3
387 */
388 TNC_Result TNC_IMV_ReceiveMessageLong(TNC_IMVID imv_id,
389 TNC_ConnectionID connection_id,
390 TNC_UInt32 msg_flags,
391 TNC_BufferReference msg,
392 TNC_UInt32 msg_len,
393 TNC_VendorID msg_vid,
394 TNC_MessageSubtype msg_subtype,
395 TNC_UInt32 src_imc_id,
396 TNC_UInt32 dst_imv_id)
397 {
398 return receive_message(imv_id, connection_id, msg_flags,
399 chunk_create(msg, msg_len), msg_vid, msg_subtype,
400 src_imc_id, dst_imv_id);
401 }
402
403 /**
404 * see section 3.8.7 of TCG TNC IF-IMV Specification 1.3
405 */
406 TNC_Result TNC_IMV_SolicitRecommendation(TNC_IMVID imv_id,
407 TNC_ConnectionID connection_id)
408 {
409 if (!imv_attestation)
410 {
411 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
412 return TNC_RESULT_NOT_INITIALIZED;
413 }
414 return imv_attestation->provide_recommendation(imv_attestation,
415 connection_id);
416 }
417
418 /**
419 * see section 3.8.8 of TCG TNC IF-IMV Specification 1.3
420 */
421 TNC_Result TNC_IMV_BatchEnding(TNC_IMVID imv_id,
422 TNC_ConnectionID connection_id)
423 {
424 imv_state_t *state;
425 imv_attestation_state_t *attestation_state;
426
427 if (!imv_attestation)
428 {
429 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
430 return TNC_RESULT_NOT_INITIALIZED;
431 }
432 /* get current IMV state */
433 if (!imv_attestation->get_state(imv_attestation, connection_id, &state))
434 {
435 return TNC_RESULT_FATAL;
436 }
437 attestation_state = (imv_attestation_state_t*)state;
438
439 /* Check if IMV has to initiate the PA-TNC exchange */
440 if (attestation_state->get_handshake_state(attestation_state) ==
441 IMV_ATTESTATION_STATE_INIT)
442 {
443 return send_message(connection_id);
444 }
445 return TNC_RESULT_SUCCESS;
446 }
447
448 /**
449 * see section 3.8.9 of TCG TNC IF-IMV Specification 1.3
450 */
451 TNC_Result TNC_IMV_Terminate(TNC_IMVID imv_id)
452 {
453 if (!imv_attestation)
454 {
455 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
456 return TNC_RESULT_NOT_INITIALIZED;
457 }
458 if (pts_creds)
459 {
460 pts_credmgr->remove_set(pts_credmgr, pts_creds->get_set(pts_creds));
461 pts_creds->destroy(pts_creds);
462 }
463 DESTROY_IF(pts_db);
464 DESTROY_IF(pts_credmgr);
465
466 libpts_deinit();
467
468 imv_attestation->destroy(imv_attestation);
469 imv_attestation = NULL;
470
471 return TNC_RESULT_SUCCESS;
472 }
473
474 /**
475 * see section 4.2.8.1 of TCG TNC IF-IMV Specification 1.3
476 */
477 TNC_Result TNC_IMV_ProvideBindFunction(TNC_IMVID imv_id,
478 TNC_TNCS_BindFunctionPointer bind_function)
479 {
480 if (!imv_attestation)
481 {
482 DBG1(DBG_IMV, "IMV \"%s\" has not been initialized", imv_name);
483 return TNC_RESULT_NOT_INITIALIZED;
484 }
485 return imv_attestation->bind_functions(imv_attestation, bind_function);
486 }