minor fixes in imc_attestation.c
[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 *
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/pts_database.h>
28 #include <pts/components/pts_component.h>
29 #include <library.h>
30
31 typedef struct imv_attestation_state_t imv_attestation_state_t;
32 typedef enum imv_attestation_handshake_state_t imv_attestation_handshake_state_t;
33
34 /**
35 * IMV Attestation Handshake States (state machine)
36 */
37 enum imv_attestation_handshake_state_t {
38 IMV_ATTESTATION_STATE_INIT,
39 IMV_ATTESTATION_STATE_NONCE_REQ,
40 IMV_ATTESTATION_STATE_TPM_INIT,
41 IMV_ATTESTATION_STATE_MEAS,
42 IMV_ATTESTATION_STATE_COMP_EVID,
43 IMV_ATTESTATION_STATE_EVID_FINAL,
44 IMV_ATTESTATION_STATE_END,
45 };
46
47 /**
48 * Internal state of an imv_attestation_t connection instance
49 */
50 struct imv_attestation_state_t {
51
52 /**
53 * imv_state_t interface
54 */
55 imv_state_t interface;
56
57 /**
58 * Get state of the handshake
59 *
60 * @return the handshake state of IMV
61 */
62 imv_attestation_handshake_state_t (*get_handshake_state)(
63 imv_attestation_state_t *this);
64
65 /**
66 * Set state of the handshake
67 *
68 * @param new_state the handshake state of IMV
69 */
70 void (*set_handshake_state)(imv_attestation_state_t *this,
71 imv_attestation_handshake_state_t new_state);
72
73 /**
74 * Get the PTS object
75 *
76 * @return PTS object
77 */
78 pts_t* (*get_pts)(imv_attestation_state_t *this);
79
80 /**
81 * Add an entry to the list of pending file/directory measurement requests
82 *
83 * @param file_id primary key into file table
84 * @param is_dir TRUE if directory
85 * @return unique request ID
86 */
87 u_int16_t (*add_file_meas_request)(imv_attestation_state_t *this,
88 int file_id, bool is_dir);
89
90 /**
91 * Returns the number of pending file/directory measurement requests
92 *
93 * @return number of pending requests
94 */
95 int (*get_file_meas_request_count)(imv_attestation_state_t *this);
96
97 /**
98 * Check for presence of request_id and if found remove it from the list
99 *
100 * @param id unique request ID
101 * @param file_id primary key into file table
102 * @param is_dir return TRUE if request was for a directory
103 * @return TRUE if request ID found, FALSE otherwise
104 */
105 bool (*check_off_file_meas_request)(imv_attestation_state_t *this,
106 u_int16_t id, int *file_id, bool *is_dir);
107
108 /**
109 * Create and add an entry to the list of Functional Components
110 *
111 * @param name Component Functional Name
112 * @param depth Sub-component Depth
113 * @param pts_db PTS measurement database
114 * @return created functional component instance or NULL
115 */
116 pts_component_t* (*create_component)(imv_attestation_state_t *this,
117 pts_comp_func_name_t *name,
118 u_int32_t depth,
119 pts_database_t *pts_db);
120
121 /**
122 * Get a Functional Component with a given name
123 *
124 * @param name Name of the requested Functional Component
125 * @return Functional Component if found, NULL otherwise
126 */
127 pts_component_t* (*get_component)(imv_attestation_state_t *this,
128 pts_comp_func_name_t *name);
129
130 /**
131 * Tell the Functional Components to finalize any measurement registrations
132 * and to check if all expected measurements were received
133 */
134 void (*finalize_components)(imv_attestation_state_t *this);
135
136 /**
137 * Have the Functional Component measurements been finalized?
138 */
139 bool (*components_finalized)(imv_attestation_state_t *this);
140
141 /**
142 * Indicates if a file measurement error occurred
143 *
144 * @return TRUE in case of measurement error
145 */
146 bool (*get_measurement_error)(imv_attestation_state_t *this);
147
148 /**
149 * Call if a file measurement error is encountered
150 */
151 void (*set_measurement_error)(imv_attestation_state_t *this);
152
153 };
154
155 /**
156 * Create an imv_attestation_state_t instance
157 *
158 * @param id connection ID
159 */
160 imv_state_t* imv_attestation_state_create(TNC_ConnectionID id);
161
162 #endif /** IMV_ATTESTATION_STATE_H_ @}*/