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