d27432e8f762e51de888e9364441408e736f73a1
[akaros.git] / kern / lib / crypto / include / 2secdata.h
1 /* Copyright (c) 2014 The Chromium OS Authors. All rights reserved.
2  * Use of this source code is governed by a BSD-style license that can be
3  * found in the LICENSE file.
4  *
5  * Secure non-volatile storage routines
6  */
7
8 #ifndef VBOOT_REFERENCE_VBOOT_SECDATA_H_
9 #define VBOOT_REFERENCE_VBOOT_SECDATA_H_
10
11 /*****************************************************************************/
12 /* Firmware version space */
13
14 /* Expected value of vb2_secdata.version */
15 #define VB2_SECDATA_VERSION 2
16
17 /* Flags for firmware space */
18 enum vb2_secdata_flags {
19         /*
20          * Last boot was developer mode.  TPM ownership is cleared when
21          * transitioning to/from developer mode.  Set/cleared by
22          * vb2_check_dev_switch().
23          */
24         VB2_SECDATA_FLAG_LAST_BOOT_DEVELOPER = (1 << 0),
25
26         /*
27          * Virtual developer mode switch is on.  Set/cleared by the
28          * keyboard-controlled dev screens in recovery mode.  Cleared by
29          * vb2_check_dev_switch().
30          */
31         VB2_SECDATA_FLAG_DEV_MODE = (1 << 1),
32 };
33
34 /* Secure data area (firmware space) */
35 struct vb2_secdata {
36         /* Struct version, for backwards compatibility */
37         uint8_t struct_version;
38
39         /* Flags; see vb2_secdata_flags */
40         uint8_t flags;
41
42         /* Firmware versions */
43         uint32_t fw_versions;
44
45         /* Reserved for future expansion */
46         uint8_t reserved[3];
47
48         /* CRC; must be last field in struct */
49         uint8_t crc8;
50 } __attribute__((packed));
51
52 /* Which param to get/set for vb2_secdata_get() / vb2_secdata_set() */
53 enum vb2_secdata_param {
54         /* Flags; see vb2_secdata_flags */
55         VB2_SECDATA_FLAGS = 0,
56
57         /* Firmware versions */
58         VB2_SECDATA_VERSIONS,
59 };
60
61 /*****************************************************************************/
62 /* Kernel version space */
63
64 /* Kernel space - KERNEL_NV_INDEX, locked with physical presence. */
65 #define VB2_SECDATAK_VERSION 2
66 #define VB2_SECDATAK_UID 0x4752574c  /* 'GRWL' */
67
68 struct vb2_secdatak {
69         /* Struct version, for backwards compatibility */
70         uint8_t struct_version;
71
72         /* Unique ID to detect space redefinition */
73         uint32_t uid;
74
75         /* Kernel versions */
76         uint32_t kernel_versions;
77
78         /* Reserved for future expansion */
79         uint8_t reserved[3];
80
81         /* CRC; must be last field in struct */
82         uint8_t crc8;
83 } __attribute__((packed));
84
85 /* Which param to get/set for vb2_secdatak_get() / vb2_secdatak_set() */
86 enum vb2_secdatak_param {
87         /* Kernel versions */
88         VB2_SECDATAK_VERSIONS = 0,
89 };
90
91 /*****************************************************************************/
92 /* Firmware version space functions */
93
94 /**
95  * Check the CRC of the secure storage context.
96  *
97  * Use this if reading from secure storage may be flaky, and you want to retry
98  * reading it several times.
99  *
100  * This may be called before vb2_context_init().
101  *
102  * @param ctx           Context pointer
103  * @return VB2_SUCCESS, or non-zero error code if error.
104  */
105 int vb2_secdata_check_crc(const struct vb2_context *ctx);
106
107 /**
108  * Create fresh data in the secure storage context.
109  *
110  * Use this only when initializing the secure storage context on a new machine
111  * the first time it boots.  Do NOT simply use this if vb2_secdata_check_crc()
112  * (or any other API in this library) fails; that could allow the secure data
113  * to be rolled back to an insecure state.
114  *
115  * This may be called before vb2_context_init().
116  */
117 int vb2_secdata_create(struct vb2_context *ctx);
118
119 /**
120  * Initialize the secure storage context and verify its CRC.
121  *
122  * This must be called before vb2_secdata_get() or vb2_secdata_set().
123  *
124  * @param ctx           Context pointer
125  * @return VB2_SUCCESS, or non-zero error code if error.
126  */
127 int vb2_secdata_init(struct vb2_context *ctx);
128
129 /**
130  * Read a secure storage value.
131  *
132  * @param ctx           Context pointer
133  * @param param         Parameter to read
134  * @param dest          Destination for value
135  * @return VB2_SUCCESS, or non-zero error code if error.
136  */
137 int vb2_secdata_get(struct vb2_context *ctx,
138                     enum vb2_secdata_param param,
139                     uint32_t *dest);
140
141 /**
142  * Write a secure storage value.
143  *
144  * @param ctx           Context pointer
145  * @param param         Parameter to write
146  * @param value         New value
147  * @return VB2_SUCCESS, or non-zero error code if error.
148  */
149 int vb2_secdata_set(struct vb2_context *ctx,
150                     enum vb2_secdata_param param,
151                     uint32_t value);
152
153 /*****************************************************************************/
154 /* Kernel version space functions.
155  *
156  * These are separate functions so that they don't bloat the size of the early
157  * boot code which uses the firmware version space functions.
158  */
159
160 /**
161  * Check the CRC of the kernel version secure storage context.
162  *
163  * Use this if reading from secure storage may be flaky, and you want to retry
164  * reading it several times.
165  *
166  * This may be called before vb2_context_init().
167  *
168  * @param ctx           Context pointer
169  * @return VB2_SUCCESS, or non-zero error code if error.
170  */
171 int vb2_secdatak_check_crc(const struct vb2_context *ctx);
172
173 /**
174  * Create fresh data in the secure storage context.
175  *
176  * Use this only when initializing the secure storage context on a new machine
177  * the first time it boots.  Do NOT simply use this if vb2_secdatak_check_crc()
178  * (or any other API in this library) fails; that could allow the secure data
179  * to be rolled back to an insecure state.
180  *
181  * This may be called before vb2_context_init().
182  */
183 int vb2_secdatak_create(struct vb2_context *ctx);
184
185 /**
186  * Initialize the secure storage context and verify its CRC.
187  *
188  * This must be called before vb2_secdatak_get() or vb2_secdatak_set().
189  *
190  * @param ctx           Context pointer
191  * @return VB2_SUCCESS, or non-zero error code if error.
192  */
193 int vb2_secdatak_init(struct vb2_context *ctx);
194
195 /**
196  * Read a secure storage value.
197  *
198  * @param ctx           Context pointer
199  * @param param         Parameter to read
200  * @param dest          Destination for value
201  * @return VB2_SUCCESS, or non-zero error code if error.
202  */
203 int vb2_secdatak_get(struct vb2_context *ctx,
204                      enum vb2_secdatak_param param,
205                      uint32_t *dest);
206
207 /**
208  * Write a secure storage value.
209  *
210  * @param ctx           Context pointer
211  * @param param         Parameter to write
212  * @param value         New value
213  * @return VB2_SUCCESS, or non-zero error code if error.
214  */
215 int vb2_secdatak_set(struct vb2_context *ctx,
216                      enum vb2_secdatak_param param,
217                      uint32_t value);
218
219 #endif  /* VBOOT_REFERENCE_VBOOT_2SECDATA_H_ */