1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/* Copyright (c) 2014 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*
* Secure non-volatile storage routines
*/
#ifndef VBOOT_REFERENCE_2SECDATA_H_
#define VBOOT_REFERENCE_2SECDATA_H_
#include "2api.h"
/*****************************************************************************/
/* Firmware secure storage space */
/* Which param to get/set for vb2_secdata_firmware_get/set() */
enum vb2_secdata_firmware_param {
/* Flags; see vb2_secdata_firmware_flags */
VB2_SECDATA_FIRMWARE_FLAGS = 0,
/* Firmware versions */
VB2_SECDATA_FIRMWARE_VERSIONS,
};
/* Flags for firmware space */
enum vb2_secdata_firmware_flags {
/*
* Last boot was developer mode. TPM ownership is cleared when
* transitioning to/from developer mode. Set/cleared by
* vb2_check_dev_switch().
*/
VB2_SECDATA_FIRMWARE_FLAG_LAST_BOOT_DEVELOPER = (1 << 0),
/*
* Virtual developer mode switch is on. Set/cleared by the
* keyboard-controlled dev screens in recovery mode. Cleared by
* vb2_check_dev_switch().
*/
VB2_SECDATA_FIRMWARE_FLAG_DEV_MODE = (1 << 1),
};
/**
* Initialize firmware secure storage context and verify its CRC.
*
* This must be called before vb2_secdata_firmware_get/set().
*
* @param ctx Context pointer
* @return VB2_SUCCESS, or non-zero error code if error.
*/
vb2_error_t vb2_secdata_firmware_init(struct vb2_context *ctx);
/**
* Read a firmware secure storage value.
*
* @param ctx Context pointer
* @param param Parameter to read
* @return Requested parameter value
*/
uint32_t vb2_secdata_firmware_get(struct vb2_context *ctx,
enum vb2_secdata_firmware_param param);
/**
* Write a firmware secure storage value.
*
* @param ctx Context pointer
* @param param Parameter to write
* @param value New value
*/
void vb2_secdata_firmware_set(struct vb2_context *ctx,
enum vb2_secdata_firmware_param param,
uint32_t value);
/*****************************************************************************/
/* Kernel secure storage space
*
* These are separate functions so that they don't bloat the size of the early
* boot code which uses the firmware version space functions.
*/
/* Which param to get/set for vb2_secdata_kernel_get/set() */
enum vb2_secdata_kernel_param {
/* Kernel versions */
VB2_SECDATA_KERNEL_VERSIONS = 0,
/* Flags; see vb2_secdata_kernel_flags */
VB2_SECDATA_KERNEL_FLAGS,
};
/* Flags for kernel space */
enum vb2_secdata_kernel_flags {
/*
* Phone recovery is disabled.
*
* RW firmware currently sets this flag to disable phone recovery on
* first boot (see function vb2api_kernel_phase1()). A future RW update
* will flip this flag back to 0 when phone recovery is ready. In the
* case that there are TPM communication issues, phone recovery is
* enabled by the default value of 0. See b/147744345 for details.
*/
VB2_SECDATA_KERNEL_FLAG_PHONE_RECOVERY_DISABLED = (1 << 0),
};
/**
* Initialize kernel secure storage context and verify its CRC.
*
* This must be called before vb2_secdata_kernel_get/set().
*
* @param ctx Context pointer
* @return VB2_SUCCESS, or non-zero error code if error.
*/
vb2_error_t vb2_secdata_kernel_init(struct vb2_context *ctx);
/**
* Read a kernel secure storage value.
*
* @param ctx Context pointer
* @param param Parameter to read
* @return Requested parameter value
*/
uint32_t vb2_secdata_kernel_get(struct vb2_context *ctx,
enum vb2_secdata_kernel_param param);
/**
* Write a kernel secure storage value.
*
* @param ctx Context pointer
* @param param Parameter to write
* @param value New value
*/
void vb2_secdata_kernel_set(struct vb2_context *ctx,
enum vb2_secdata_kernel_param param,
uint32_t value);
/**
* Get ec_hash from kernel secure storage.
*
* @param ctx Context pointer
* @return Buffer where hash is stored or NULL on error.
*/
const uint8_t *vb2_secdata_kernel_get_ec_hash(struct vb2_context *ctx);
/**
* Set ec_hash in kernel secure storage.
*
* @param ctx Context pointer
* @param sha256 Hash to be set. 32 bytes.
*/
void vb2_secdata_kernel_set_ec_hash(struct vb2_context *ctx,
const uint8_t *sha256);
/*****************************************************************************/
/* Firmware management parameters (FWMP) space */
/* Flags for FWMP space */
enum vb2_secdata_fwmp_flags {
VB2_SECDATA_FWMP_DEV_DISABLE_BOOT = (1 << 0),
VB2_SECDATA_FWMP_DEV_DISABLE_RECOVERY = (1 << 1),
VB2_SECDATA_FWMP_DEV_ENABLE_EXTERNAL = (1 << 2),
VB2_SECDATA_FWMP_DEV_ENABLE_LEGACY = (1 << 3),
VB2_SECDATA_FWMP_DEV_ENABLE_OFFICIAL_ONLY = (1 << 4),
VB2_SECDATA_FWMP_DEV_USE_KEY_HASH = (1 << 5),
/* CCD = case-closed debugging on cr50; flag implemented on cr50 */
VB2_SECDATA_FWMP_DEV_DISABLE_CCD_UNLOCK = (1 << 6),
VB2_SECDATA_FWMP_DEV_FIPS_MODE = (1 << 7),
};
/**
* Initialize FWMP secure storage context and verify its CRC.
*
* This must be called before vb2_secdata_fwmp_get_flag/get_dev_key_hash().
*
* @param ctx Context pointer
* @return VB2_SUCCESS, or non-zero error code if error.
*/
vb2_error_t vb2_secdata_fwmp_init(struct vb2_context *ctx);
/**
* Read a FWMP secure storage flag value.
*
* It is unsupported to call before successfully running vb2_secdata_fwmp_init.
* In this case, vboot will fail and exit.
*
* @param ctx Context pointer
* @param flag Flag to read
* @return current flag value (0 or 1)
*/
int vb2_secdata_fwmp_get_flag(struct vb2_context *ctx,
enum vb2_secdata_fwmp_flags flag);
/**
* Return a pointer to FWMP dev key hash.
*
* @param ctx Context pointer
* @return uint8_t pointer to dev_key_hash field
*/
uint8_t *vb2_secdata_fwmp_get_dev_key_hash(struct vb2_context *ctx);
#endif /* VBOOT_REFERENCE_2SECDATA_H_ */
|
