c3aea048cbab4a478e7087af90ca277cb6af514a
[strongswan.git] / src / libpts / plugins / imv_attestation / imv_attestation_state.h
1 /*
2 * Copyright (C) 2011-2012 Sansar Choinyambuu, 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 /**
17 * @defgroup imv_attestation imv_attestation
18 * @ingroup libpts_plugins
19 *
20 * @defgroup imv_attestation_state_t imv_attestation_state
21 * @{ @ingroup imv_attestation
22 */
23
24 #ifndef IMV_ATTESTATION_STATE_H_
25 #define IMV_ATTESTATION_STATE_H_
26
27 #include <imv/imv_state.h>
28 #include <imv/imv_reason_string.h>
29 #include <pts/pts.h>
30 #include <pts/pts_database.h>
31 #include <pts/components/pts_component.h>
32
33 #include <library.h>
34 #include <bio/bio_writer.h>
35
36 typedef struct imv_attestation_state_t imv_attestation_state_t;
37 typedef enum imv_attestation_flag_t imv_attestation_flag_t;
38 typedef enum imv_attestation_handshake_state_t imv_attestation_handshake_state_t;
39 typedef enum imv_meas_error_t imv_meas_error_t;
40
41 /**
42 * IMV Attestation Flags set for completed actions
43 */
44 enum imv_attestation_flag_t {
45 IMV_ATTESTATION_ATTR_PRODUCT_INFO = (1<<0),
46 IMV_ATTESTATION_ATTR_STRING_VERSION = (1<<1),
47 IMV_ATTESTATION_ATTR_DEVICE_ID = (1<<2),
48 IMV_ATTESTATION_ATTR_MUST = (1<<3)-1,
49 IMV_ATTESTATION_ATTR_REQ = (1<<3),
50 IMV_ATTESTATION_ALGO = (1<<4),
51 IMV_ATTESTATION_FILE_MEAS = (1<<5),
52 IMV_ATTESTATION_REC = (1<<6)
53 };
54
55 /**
56 * IMV Attestation Handshake States (state machine)
57 */
58 enum imv_attestation_handshake_state_t {
59 IMV_ATTESTATION_STATE_INIT,
60 IMV_ATTESTATION_STATE_DISCOVERY,
61 IMV_ATTESTATION_STATE_NONCE_REQ,
62 IMV_ATTESTATION_STATE_TPM_INIT,
63 IMV_ATTESTATION_STATE_COMP_EVID,
64 IMV_ATTESTATION_STATE_EVID_FINAL,
65 IMV_ATTESTATION_STATE_END,
66 };
67
68 /**
69 * IMV Measurement Error Types
70 */
71 enum imv_meas_error_t {
72 IMV_ATTESTATION_ERROR_FILE_MEAS_FAIL = 1,
73 IMV_ATTESTATION_ERROR_FILE_MEAS_PEND = 2,
74 IMV_ATTESTATION_ERROR_NO_TRUSTED_AIK = 4,
75 IMV_ATTESTATION_ERROR_COMP_EVID_FAIL = 8,
76 IMV_ATTESTATION_ERROR_COMP_EVID_PEND = 16,
77 IMV_ATTESTATION_ERROR_TPM_QUOTE_FAIL = 32
78 };
79
80 /**
81 * Internal state of an imv_attestation_t connection instance
82 */
83 struct imv_attestation_state_t {
84
85 /**
86 * imv_state_t interface
87 */
88 imv_state_t interface;
89
90 /**
91 * Get state of the handshake
92 *
93 * @return the handshake state of IMV
94 */
95 imv_attestation_handshake_state_t (*get_handshake_state)(
96 imv_attestation_state_t *this);
97
98 /**
99 * Set state of the handshake
100 *
101 * @param new_state the handshake state of IMV
102 */
103 void (*set_handshake_state)(imv_attestation_state_t *this,
104 imv_attestation_handshake_state_t new_state);
105
106 /**
107 * Get the PTS object
108 *
109 * @return PTS object
110 */
111 pts_t* (*get_pts)(imv_attestation_state_t *this);
112
113 /**
114 * Create and add an entry to the list of Functional Components
115 *
116 * @param name Component Functional Name
117 * @param depth Sub-component Depth
118 * @param pts_db PTS measurement database
119 * @return created functional component instance or NULL
120 */
121 pts_component_t* (*create_component)(imv_attestation_state_t *this,
122 pts_comp_func_name_t *name,
123 uint32_t depth,
124 pts_database_t *pts_db);
125
126 /**
127 * Enumerate over all Functional Components
128 *
129 * @return Functional Component enumerator
130 */
131 enumerator_t* (*create_component_enumerator)(imv_attestation_state_t *this);
132
133 /**
134 * Get a Functional Component with a given name
135 *
136 * @param name Name of the requested Functional Component
137 * @return Functional Component if found, NULL otherwise
138 */
139 pts_component_t* (*get_component)(imv_attestation_state_t *this,
140 pts_comp_func_name_t *name);
141
142 /**
143 * Tell the Functional Components to finalize any measurement registrations
144 * and to check if all expected measurements were received
145 *
146 * @param result Writer appending component measurement results
147 */
148 void (*finalize_components)(imv_attestation_state_t *this,
149 bio_writer_t *result);
150
151 /**
152 * Indicates the types of measurement errors that occurred
153 *
154 * @return Measurement error flags
155 */
156 uint32_t (*get_measurement_error)(imv_attestation_state_t *this);
157
158 /**
159 * Call if a measurement error is encountered
160 *
161 * @param error Measurement error type
162 */
163 void (*set_measurement_error)(imv_attestation_state_t *this,
164 uint32_t error);
165
166 /**
167 * Returns a concatenation of File Measurement reason strings
168 *
169 * @param reason_string Concatenated reason strings
170 */
171 void (*add_file_meas_reasons)(imv_attestation_state_t *this,
172 imv_reason_string_t *reason_string);
173
174 /**
175 * Returns a concatenation of Component Evidence reason strings
176 *
177 * @param reason_string Concatenated reason strings
178 */
179 void (*add_comp_evid_reasons)(imv_attestation_state_t *this,
180 imv_reason_string_t *reason_string);
181 };
182
183 /**
184 * Create an imv_attestation_state_t instance
185 *
186 * @param id connection ID
187 */
188 imv_state_t* imv_attestation_state_create(TNC_ConnectionID id);
189
190 #endif /** IMV_ATTESTATION_STATE_H_ @}*/