refactored file measurement request list
[strongswan.git] / src / libimcv / 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 <tcg/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_MEAS,
38 IMV_ATTESTATION_STATE_COMP_EVID,
39 IMV_ATTESTATION_STATE_IML,
40 IMV_ATTESTATION_STATE_END,
41 };
42
43 /**
44 * Internal state of an imv_attestation_t connection instance
45 */
46 struct imv_attestation_state_t {
47
48 /**
49 * imv_state_t interface
50 */
51 imv_state_t interface;
52
53 /**
54 * Get state of the handshake
55 *
56 * @return the handshake state of IMV
57 */
58 imv_attestation_handshake_state_t (*get_handshake_state)(imv_attestation_state_t *this);
59
60 /**
61 * Set state of the handshake
62 *
63 * @param new_state the handshake state of IMV
64 */
65 void (*set_handshake_state)(imv_attestation_state_t *this,
66 imv_attestation_handshake_state_t new_state);
67
68 /**
69 * Get the PTS object
70 *
71 * @return PTS object
72 */
73 pts_t* (*get_pts)(imv_attestation_state_t *this);
74
75 /**
76 * Add an entry to the list of pending file/directory measurement requests
77 *
78 * @param id unique request ID
79 * @param is_dir TRUE if directory
80 */
81 void (*add_request)(imv_attestation_state_t *this, int id, bool is_dir);
82
83 /**
84 * Returns the number of pending file/directory measurement requests
85 *
86 * @return number of pending requests
87 */
88 int (*get_request_count)(imv_attestation_state_t *this);
89
90 /**
91 * Check for presence of request_id and if found remove it from the list
92 *
93 * @param id unique request ID
94 * @param is_dir return TRUE if request was for a directory
95 * @return TRUE if request ID found, FALSE otherwise
96 */
97 bool (*check_off_request)(imv_attestation_state_t *this, int id,
98 bool *is_dir);
99
100 };
101
102 /**
103 * Create an imv_attestation_state_t instance
104 *
105 * @param id connection ID
106 */
107 imv_state_t* imv_attestation_state_create(TNC_ConnectionID id);
108
109 #endif /** IMV_ATTESTATION_STATE_H_ @}*/