xref: /aosp_15_r20/external/vboot_reference/firmware/2lib/2common.c (revision 8617a60d3594060b7ecbd21bc622a7c14f3cf2bc)
1*8617a60dSAndroid Build Coastguard Worker /* Copyright 2014 The ChromiumOS Authors
2*8617a60dSAndroid Build Coastguard Worker  * Use of this source code is governed by a BSD-style license that can be
3*8617a60dSAndroid Build Coastguard Worker  * found in the LICENSE file.
4*8617a60dSAndroid Build Coastguard Worker  *
5*8617a60dSAndroid Build Coastguard Worker  * Common functions between firmware and kernel verified boot.
6*8617a60dSAndroid Build Coastguard Worker  * (Firmware portion)
7*8617a60dSAndroid Build Coastguard Worker  */
8*8617a60dSAndroid Build Coastguard Worker 
9*8617a60dSAndroid Build Coastguard Worker #include "2common.h"
10*8617a60dSAndroid Build Coastguard Worker #include "2rsa.h"
11*8617a60dSAndroid Build Coastguard Worker 
12*8617a60dSAndroid Build Coastguard Worker test_mockable
vb2_safe_memcmp(const void * s1,const void * s2,size_t size)13*8617a60dSAndroid Build Coastguard Worker vb2_error_t vb2_safe_memcmp(const void *s1, const void *s2, size_t size)
14*8617a60dSAndroid Build Coastguard Worker {
15*8617a60dSAndroid Build Coastguard Worker 	const unsigned char *us1 = s1;
16*8617a60dSAndroid Build Coastguard Worker 	const unsigned char *us2 = s2;
17*8617a60dSAndroid Build Coastguard Worker 	int result = 0;
18*8617a60dSAndroid Build Coastguard Worker 
19*8617a60dSAndroid Build Coastguard Worker 	if (0 == size)
20*8617a60dSAndroid Build Coastguard Worker 		return 0;
21*8617a60dSAndroid Build Coastguard Worker 
22*8617a60dSAndroid Build Coastguard Worker 	/*
23*8617a60dSAndroid Build Coastguard Worker 	 * Code snippet without data-dependent branch due to Nate Lawson
24*8617a60dSAndroid Build Coastguard Worker 	 * ([email protected]) of Root Labs.
25*8617a60dSAndroid Build Coastguard Worker 	 */
26*8617a60dSAndroid Build Coastguard Worker 	while (size--)
27*8617a60dSAndroid Build Coastguard Worker 		result |= *us1++ ^ *us2++;
28*8617a60dSAndroid Build Coastguard Worker 
29*8617a60dSAndroid Build Coastguard Worker 	return result != 0;
30*8617a60dSAndroid Build Coastguard Worker }
31*8617a60dSAndroid Build Coastguard Worker 
vb2_align(uint8_t ** ptr,uint32_t * size,uint32_t align,uint32_t want_size)32*8617a60dSAndroid Build Coastguard Worker vb2_error_t vb2_align(uint8_t **ptr, uint32_t *size, uint32_t align,
33*8617a60dSAndroid Build Coastguard Worker 		      uint32_t want_size)
34*8617a60dSAndroid Build Coastguard Worker {
35*8617a60dSAndroid Build Coastguard Worker 	uintptr_t p = (uintptr_t)*ptr;
36*8617a60dSAndroid Build Coastguard Worker 	uintptr_t offs = p & (align - 1);
37*8617a60dSAndroid Build Coastguard Worker 
38*8617a60dSAndroid Build Coastguard Worker 	if (offs) {
39*8617a60dSAndroid Build Coastguard Worker 		offs = align - offs;
40*8617a60dSAndroid Build Coastguard Worker 
41*8617a60dSAndroid Build Coastguard Worker 		if (*size < offs)
42*8617a60dSAndroid Build Coastguard Worker 			return VB2_ERROR_ALIGN_BIGGER_THAN_SIZE;
43*8617a60dSAndroid Build Coastguard Worker 
44*8617a60dSAndroid Build Coastguard Worker 		*ptr += offs;
45*8617a60dSAndroid Build Coastguard Worker 		*size -= offs;
46*8617a60dSAndroid Build Coastguard Worker 	}
47*8617a60dSAndroid Build Coastguard Worker 
48*8617a60dSAndroid Build Coastguard Worker 	if (*size < want_size)
49*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_ALIGN_SIZE;
50*8617a60dSAndroid Build Coastguard Worker 
51*8617a60dSAndroid Build Coastguard Worker 	return VB2_SUCCESS;
52*8617a60dSAndroid Build Coastguard Worker }
53*8617a60dSAndroid Build Coastguard Worker 
vb2_workbuf_init(struct vb2_workbuf * wb,uint8_t * buf,uint32_t size)54*8617a60dSAndroid Build Coastguard Worker void vb2_workbuf_init(struct vb2_workbuf *wb, uint8_t *buf, uint32_t size)
55*8617a60dSAndroid Build Coastguard Worker {
56*8617a60dSAndroid Build Coastguard Worker 	wb->buf = buf;
57*8617a60dSAndroid Build Coastguard Worker 	wb->size = size;
58*8617a60dSAndroid Build Coastguard Worker 
59*8617a60dSAndroid Build Coastguard Worker 	/* Align the buffer so allocations will be aligned */
60*8617a60dSAndroid Build Coastguard Worker 	if (vb2_align(&wb->buf, &wb->size, VB2_WORKBUF_ALIGN, 0))
61*8617a60dSAndroid Build Coastguard Worker 		wb->size = 0;
62*8617a60dSAndroid Build Coastguard Worker }
63*8617a60dSAndroid Build Coastguard Worker 
vb2_workbuf_alloc(struct vb2_workbuf * wb,uint32_t size)64*8617a60dSAndroid Build Coastguard Worker void *vb2_workbuf_alloc(struct vb2_workbuf *wb, uint32_t size)
65*8617a60dSAndroid Build Coastguard Worker {
66*8617a60dSAndroid Build Coastguard Worker 	uint8_t *ptr = wb->buf;
67*8617a60dSAndroid Build Coastguard Worker 
68*8617a60dSAndroid Build Coastguard Worker 	/* Round up size to work buffer alignment */
69*8617a60dSAndroid Build Coastguard Worker 	size = vb2_wb_round_up(size);
70*8617a60dSAndroid Build Coastguard Worker 
71*8617a60dSAndroid Build Coastguard Worker 	if (size > wb->size)
72*8617a60dSAndroid Build Coastguard Worker 		return NULL;
73*8617a60dSAndroid Build Coastguard Worker 
74*8617a60dSAndroid Build Coastguard Worker 	wb->buf += size;
75*8617a60dSAndroid Build Coastguard Worker 	wb->size -= size;
76*8617a60dSAndroid Build Coastguard Worker 
77*8617a60dSAndroid Build Coastguard Worker 	return ptr;
78*8617a60dSAndroid Build Coastguard Worker }
79*8617a60dSAndroid Build Coastguard Worker 
vb2_workbuf_realloc(struct vb2_workbuf * wb,uint32_t oldsize,uint32_t newsize)80*8617a60dSAndroid Build Coastguard Worker void *vb2_workbuf_realloc(struct vb2_workbuf *wb, uint32_t oldsize,
81*8617a60dSAndroid Build Coastguard Worker 			  uint32_t newsize)
82*8617a60dSAndroid Build Coastguard Worker {
83*8617a60dSAndroid Build Coastguard Worker 	/*
84*8617a60dSAndroid Build Coastguard Worker 	 * Just free and allocate to update the size.  No need to move/copy
85*8617a60dSAndroid Build Coastguard Worker 	 * memory, since the new pointer is guaranteed to be the same as the
86*8617a60dSAndroid Build Coastguard Worker 	 * old one.  The new allocation can fail, if the new size is too big.
87*8617a60dSAndroid Build Coastguard Worker 	 */
88*8617a60dSAndroid Build Coastguard Worker 	vb2_workbuf_free(wb, oldsize);
89*8617a60dSAndroid Build Coastguard Worker 	return vb2_workbuf_alloc(wb, newsize);
90*8617a60dSAndroid Build Coastguard Worker }
91*8617a60dSAndroid Build Coastguard Worker 
vb2_workbuf_free(struct vb2_workbuf * wb,uint32_t size)92*8617a60dSAndroid Build Coastguard Worker void vb2_workbuf_free(struct vb2_workbuf *wb, uint32_t size)
93*8617a60dSAndroid Build Coastguard Worker {
94*8617a60dSAndroid Build Coastguard Worker 	/* Round up size to work buffer alignment */
95*8617a60dSAndroid Build Coastguard Worker 	size = vb2_wb_round_up(size);
96*8617a60dSAndroid Build Coastguard Worker 
97*8617a60dSAndroid Build Coastguard Worker 	wb->buf -= size;
98*8617a60dSAndroid Build Coastguard Worker 	wb->size += size;
99*8617a60dSAndroid Build Coastguard Worker }
100*8617a60dSAndroid Build Coastguard Worker 
vb2_offset_of(const void * base,const void * ptr)101*8617a60dSAndroid Build Coastguard Worker ptrdiff_t vb2_offset_of(const void *base, const void *ptr)
102*8617a60dSAndroid Build Coastguard Worker {
103*8617a60dSAndroid Build Coastguard Worker 	return (uintptr_t)ptr - (uintptr_t)base;
104*8617a60dSAndroid Build Coastguard Worker }
105*8617a60dSAndroid Build Coastguard Worker 
vb2_member_of(void * parent,ptrdiff_t offset)106*8617a60dSAndroid Build Coastguard Worker void *vb2_member_of(void *parent, ptrdiff_t offset)
107*8617a60dSAndroid Build Coastguard Worker {
108*8617a60dSAndroid Build Coastguard Worker 	/* TODO(kitching): vb2_assert(parent && offset) */
109*8617a60dSAndroid Build Coastguard Worker 	return parent + offset;
110*8617a60dSAndroid Build Coastguard Worker }
111*8617a60dSAndroid Build Coastguard Worker 
vb2_verify_member_inside(const void * parent,size_t parent_size,const void * member,size_t member_size,ptrdiff_t member_data_offset,size_t member_data_size)112*8617a60dSAndroid Build Coastguard Worker vb2_error_t vb2_verify_member_inside(const void *parent, size_t parent_size,
113*8617a60dSAndroid Build Coastguard Worker 				     const void *member, size_t member_size,
114*8617a60dSAndroid Build Coastguard Worker 				     ptrdiff_t member_data_offset,
115*8617a60dSAndroid Build Coastguard Worker 				     size_t member_data_size)
116*8617a60dSAndroid Build Coastguard Worker {
117*8617a60dSAndroid Build Coastguard Worker 	const uintptr_t parent_end = (uintptr_t)parent + parent_size;
118*8617a60dSAndroid Build Coastguard Worker 	const ptrdiff_t member_offs = vb2_offset_of(parent, member);
119*8617a60dSAndroid Build Coastguard Worker 	const ptrdiff_t member_end_offs = member_offs + member_size;
120*8617a60dSAndroid Build Coastguard Worker 	const ptrdiff_t data_offs = member_offs + member_data_offset;
121*8617a60dSAndroid Build Coastguard Worker 	const ptrdiff_t data_end_offs = data_offs + member_data_size;
122*8617a60dSAndroid Build Coastguard Worker 
123*8617a60dSAndroid Build Coastguard Worker 	/* Make sure parent doesn't wrap */
124*8617a60dSAndroid Build Coastguard Worker 	if (parent_end < (uintptr_t)parent)
125*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_INSIDE_PARENT_WRAPS;
126*8617a60dSAndroid Build Coastguard Worker 
127*8617a60dSAndroid Build Coastguard Worker 	/*
128*8617a60dSAndroid Build Coastguard Worker 	 * Make sure the member is fully contained in the parent and doesn't
129*8617a60dSAndroid Build Coastguard Worker 	 * wrap.  Use >, not >=, since member_size = 0 is possible.
130*8617a60dSAndroid Build Coastguard Worker 	 */
131*8617a60dSAndroid Build Coastguard Worker 	if (member_end_offs < member_offs)
132*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_INSIDE_MEMBER_WRAPS;
133*8617a60dSAndroid Build Coastguard Worker 	if (member_offs < 0 || member_offs > parent_size ||
134*8617a60dSAndroid Build Coastguard Worker 	    member_end_offs > parent_size)
135*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_INSIDE_MEMBER_OUTSIDE;
136*8617a60dSAndroid Build Coastguard Worker 
137*8617a60dSAndroid Build Coastguard Worker 	/* Make sure the member data is after the member */
138*8617a60dSAndroid Build Coastguard Worker 	if (member_data_size > 0 && data_offs < member_end_offs)
139*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_INSIDE_DATA_OVERLAP;
140*8617a60dSAndroid Build Coastguard Worker 
141*8617a60dSAndroid Build Coastguard Worker 	/* Make sure parent fully contains member data, if any */
142*8617a60dSAndroid Build Coastguard Worker 	if (data_end_offs < data_offs)
143*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_INSIDE_DATA_WRAPS;
144*8617a60dSAndroid Build Coastguard Worker 	if (data_offs < 0 || data_offs > parent_size ||
145*8617a60dSAndroid Build Coastguard Worker 	    data_end_offs > parent_size)
146*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_INSIDE_DATA_OUTSIDE;
147*8617a60dSAndroid Build Coastguard Worker 
148*8617a60dSAndroid Build Coastguard Worker 	return VB2_SUCCESS;
149*8617a60dSAndroid Build Coastguard Worker }
150*8617a60dSAndroid Build Coastguard Worker 
151*8617a60dSAndroid Build Coastguard Worker test_mockable
vb2_verify_digest(const struct vb2_public_key * key,struct vb2_signature * sig,const uint8_t * digest,const struct vb2_workbuf * wb)152*8617a60dSAndroid Build Coastguard Worker vb2_error_t vb2_verify_digest(const struct vb2_public_key *key,
153*8617a60dSAndroid Build Coastguard Worker 			      struct vb2_signature *sig, const uint8_t *digest,
154*8617a60dSAndroid Build Coastguard Worker 			      const struct vb2_workbuf *wb)
155*8617a60dSAndroid Build Coastguard Worker {
156*8617a60dSAndroid Build Coastguard Worker 	/* A signature is destroyed in the process of being verified. */
157*8617a60dSAndroid Build Coastguard Worker 	uint8_t *sig_data = vb2_signature_data_mutable(sig);
158*8617a60dSAndroid Build Coastguard Worker 
159*8617a60dSAndroid Build Coastguard Worker 	if (!sig->data_size)
160*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_VDATA_NOT_ENOUGH_DATA;
161*8617a60dSAndroid Build Coastguard Worker 
162*8617a60dSAndroid Build Coastguard Worker 	if (sig->sig_size != vb2_rsa_sig_size(key->sig_alg)) {
163*8617a60dSAndroid Build Coastguard Worker 		VB2_DEBUG("Wrong data signature size for algorithm, "
164*8617a60dSAndroid Build Coastguard Worker 			  "sig_size=%d, expected %d for algorithm %d.\n",
165*8617a60dSAndroid Build Coastguard Worker 			  sig->sig_size, vb2_rsa_sig_size(key->sig_alg),
166*8617a60dSAndroid Build Coastguard Worker 			  key->sig_alg);
167*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_VDATA_SIG_SIZE;
168*8617a60dSAndroid Build Coastguard Worker 	}
169*8617a60dSAndroid Build Coastguard Worker 
170*8617a60dSAndroid Build Coastguard Worker 	if (key->allow_hwcrypto) {
171*8617a60dSAndroid Build Coastguard Worker 		vb2_error_t rv =
172*8617a60dSAndroid Build Coastguard Worker 			vb2ex_hwcrypto_rsa_verify_digest(key, sig_data, digest);
173*8617a60dSAndroid Build Coastguard Worker 
174*8617a60dSAndroid Build Coastguard Worker 		if (rv != VB2_ERROR_EX_HWCRYPTO_UNSUPPORTED) {
175*8617a60dSAndroid Build Coastguard Worker 			VB2_DEBUG("Using HW RSA engine for sig_alg %d %s\n",
176*8617a60dSAndroid Build Coastguard Worker 					key->sig_alg,
177*8617a60dSAndroid Build Coastguard Worker 					rv ? "failed" : "succeeded");
178*8617a60dSAndroid Build Coastguard Worker 			return rv;
179*8617a60dSAndroid Build Coastguard Worker 		}
180*8617a60dSAndroid Build Coastguard Worker 
181*8617a60dSAndroid Build Coastguard Worker 		VB2_DEBUG("HW RSA for sig_alg %d not supported, using SW\n",
182*8617a60dSAndroid Build Coastguard Worker 			  key->sig_alg);
183*8617a60dSAndroid Build Coastguard Worker 	} else {
184*8617a60dSAndroid Build Coastguard Worker 		VB2_DEBUG("HW RSA forbidden, using SW\n");
185*8617a60dSAndroid Build Coastguard Worker 	}
186*8617a60dSAndroid Build Coastguard Worker 
187*8617a60dSAndroid Build Coastguard Worker 	return vb2_rsa_verify_digest(key, sig_data, digest, wb);
188*8617a60dSAndroid Build Coastguard Worker }
189*8617a60dSAndroid Build Coastguard Worker 
190*8617a60dSAndroid Build Coastguard Worker test_mockable
vb2_verify_data(const uint8_t * data,uint32_t size,struct vb2_signature * sig,const struct vb2_public_key * key,const struct vb2_workbuf * wb)191*8617a60dSAndroid Build Coastguard Worker vb2_error_t vb2_verify_data(const uint8_t *data, uint32_t size,
192*8617a60dSAndroid Build Coastguard Worker 			    struct vb2_signature *sig,
193*8617a60dSAndroid Build Coastguard Worker 			    const struct vb2_public_key *key,
194*8617a60dSAndroid Build Coastguard Worker 			    const struct vb2_workbuf *wb)
195*8617a60dSAndroid Build Coastguard Worker {
196*8617a60dSAndroid Build Coastguard Worker 	struct vb2_hash hash;
197*8617a60dSAndroid Build Coastguard Worker 
198*8617a60dSAndroid Build Coastguard Worker 	if (sig->data_size > size) {
199*8617a60dSAndroid Build Coastguard Worker 		VB2_DEBUG("Data buffer smaller than length of signed data.\n");
200*8617a60dSAndroid Build Coastguard Worker 		return VB2_ERROR_VDATA_NOT_ENOUGH_DATA;
201*8617a60dSAndroid Build Coastguard Worker 	}
202*8617a60dSAndroid Build Coastguard Worker 
203*8617a60dSAndroid Build Coastguard Worker 	VB2_TRY(vb2_hash_calculate(key->allow_hwcrypto, data, sig->data_size,
204*8617a60dSAndroid Build Coastguard Worker 				   key->hash_alg, &hash));
205*8617a60dSAndroid Build Coastguard Worker 
206*8617a60dSAndroid Build Coastguard Worker 	return vb2_verify_digest(key, sig, hash.raw, wb);
207*8617a60dSAndroid Build Coastguard Worker }
208