automatically registering component measurements
[strongswan.git] / src / libpts / plugins / imv_attestation / imv_attestation_state.h
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 /**
17 *
18 * @defgroup imv_attestation_state_t imv_attestation_state
19 * @{ @ingroup imv_attestation_state
20 */
21
22 #ifndef IMV_ATTESTATION_STATE_H_
23 #define IMV_ATTESTATION_STATE_H_
24
25 #include <imv/imv_state.h>
26 #include <pts/pts.h>
27 #include <pts/components/pts_component.h>
28 #include <library.h>
29
30 typedef struct imv_attestation_state_t imv_attestation_state_t;
31 typedef enum imv_attestation_handshake_state_t imv_attestation_handshake_state_t;
32
33 /**
34 * IMV Attestation Handshake States (state machine)
35 */
36 enum imv_attestation_handshake_state_t {
37 IMV_ATTESTATION_STATE_INIT,
38 IMV_ATTESTATION_STATE_NONCE_REQ,
39 IMV_ATTESTATION_STATE_TPM_INIT,
40 IMV_ATTESTATION_STATE_MEAS,
41 IMV_ATTESTATION_STATE_COMP_EVID,
42 IMV_ATTESTATION_STATE_END,
43 };
44
45 /**
46 * Internal state of an imv_attestation_t connection instance
47 */
48 struct imv_attestation_state_t {
49
50 /**
51 * imv_state_t interface
52 */
53 imv_state_t interface;
54
55 /**
56 * Get state of the handshake
57 *
58 * @return the handshake state of IMV
59 */
60 imv_attestation_handshake_state_t (*get_handshake_state)(
61 imv_attestation_state_t *this);
62
63 /**
64 * Set state of the handshake
65 *
66 * @param new_state the handshake state of IMV
67 */
68 void (*set_handshake_state)(imv_attestation_state_t *this,
69 imv_attestation_handshake_state_t new_state);
70
71 /**
72 * Get the PTS object
73 *
74 * @return PTS object
75 */
76 pts_t* (*get_pts)(imv_attestation_state_t *this);
77
78 /**
79 * Add an entry to the list of pending file/directory measurement requests
80 *
81 * @param file_id primary key into file table
82 * @param is_dir TRUE if directory
83 * @return unique request ID
84 */
85 u_int16_t (*add_file_meas_request)(imv_attestation_state_t *this,
86 int file_id, bool is_dir);
87
88 /**
89 * Returns the number of pending file/directory measurement requests
90 *
91 * @return number of pending requests
92 */
93 int (*get_file_meas_request_count)(imv_attestation_state_t *this);
94
95 /**
96 * Check for presence of request_id and if found remove it from the list
97 *
98 * @param id unique request ID
99 * @param file_id primary key into file table
100 * @param is_dir return TRUE if request was for a directory
101 * @return TRUE if request ID found, FALSE otherwise
102 */
103 bool (*check_off_file_meas_request)(imv_attestation_state_t *this,
104 u_int16_t id, int *file_id, bool *is_dir);
105
106 /**
107 * Add an entry to the list of Functional Components waiting for evidence
108 *
109 * @param entry Functional Component
110 */
111 void (*add_component)(imv_attestation_state_t *this, pts_component_t *entry);
112
113 /**
114 * Returns the number of Functional Component waiting for evidence
115 *
116 * @return Number of waiting Functional Components
117 */
118 int (*get_component_count)(imv_attestation_state_t *this);
119
120 /**
121 * Check for presence of Functional Component and remove and return it
122 *
123 * @param name Name of the requested Functional Component
124 * @return Functional Component if found, NULL otherwise
125 */
126 pts_component_t* (*check_off_component)(imv_attestation_state_t *this,
127 pts_comp_func_name_t *name);
128
129 /**
130 * Tell the Functional Components to finalize any measurement registrations
131 */
132 void (*check_off_registrations)(imv_attestation_state_t *this);
133
134 /**
135 * Indicates if a file measurement error occurred
136 *
137 * @return TRUE in case of measurement error
138 */
139 bool (*get_measurement_error)(imv_attestation_state_t *this);
140
141 /**
142 * Call if a file measurement error is encountered
143 */
144 void (*set_measurement_error)(imv_attestation_state_t *this);
145
146 };
147
148 /**
149 * Create an imv_attestation_state_t instance
150 *
151 * @param id connection ID
152 */
153 imv_state_t* imv_attestation_state_create(TNC_ConnectionID id);
154
155 #endif /** IMV_ATTESTATION_STATE_H_ @}*/