blob: 956119faee3df116a65c9379e39b80ddffcd9e7b [file] [log] [blame]
Maulik Patel2358bbb2023-07-21 10:56:56 +01001/*
Tamas Ban5179a4d2024-01-25 17:05:30 +01002 * Copyright (c) 2023-2024, Arm Limited. All rights reserved.
Maulik Patel2358bbb2023-07-21 10:56:56 +01003 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 *
6 */
7
8#include <assert.h>
9#include "dpe_certificate.h"
10#include "dpe_context_mngr.h"
11#include "dpe_crypto_config.h"
12#include "dpe_crypto_interface.h"
Maulik Patele6adc112023-08-18 14:21:51 +010013#include "dpe_plat.h"
Maulik Patel2358bbb2023-07-21 10:56:56 +010014#include "qcbor/qcbor_encode.h"
15#include "t_cose_common.h"
16#include "t_cose_sign1_sign.h"
17
18#define ID_HEX_SIZE (2 * DICE_ID_SIZE) /* Size of CDI encoded to ascii hex */
Maulik Patele6adc112023-08-18 14:21:51 +010019#define LABEL_HEX_SIZE (2 * DPE_EXTERNAL_LABEL_MAX_SIZE)
Maulik Patel2358bbb2023-07-21 10:56:56 +010020
Maulik Patel2358bbb2023-07-21 10:56:56 +010021static void convert_to_ascii_hex(const uint8_t *in,
22 size_t in_size,
23 char *out,
24 size_t out_size)
25{
26 const char hex_table[] = "0123456789abcdef";
27 size_t in_pos = 0;
28 size_t out_pos = 0;
29
30 for (in_pos = 0; in_pos < in_size && out_pos < out_size; in_pos++) {
31 out[out_pos++] = hex_table[(in[in_pos] & 0xF0 >> 4)];
32 out[out_pos++] = hex_table[in[in_pos] & 0x0F];
33 }
34}
35
36static dpe_error_t t_cose_err_to_dpe_err(enum t_cose_err_t err)
37{
38 switch(err) {
39
40 case T_COSE_SUCCESS:
41 return DPE_NO_ERROR;
42
43 case T_COSE_ERR_TOO_SMALL:
44 return DPE_INSUFFICIENT_MEMORY;
45
46 default:
47 /* A lot of the errors are not mapped because they are
48 * primarily internal errors that should never happen. They
49 * end up here.
50 */
51 return DPE_INTERNAL_ERROR;
52 }
53}
54
Tamas Ban257471b2024-03-25 13:49:53 +010055static dpe_error_t certificate_encode_start(QCBOREncodeContext *cbor_enc_ctx,
56 struct t_cose_sign1_sign_ctx *signer_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +010057 psa_key_handle_t private_key)
58{
59 enum t_cose_err_t t_cose_err;
60 struct t_cose_key attest_key;
61 UsefulBufC attest_key_id = {NULL, 0};
62
63 /* DPE Certificate is untagged COSE_Sign1 message */
Tamas Ban257471b2024-03-25 13:49:53 +010064 t_cose_sign1_sign_init(signer_ctx, T_COSE_OPT_OMIT_CBOR_TAG, DPE_T_COSE_ALG);
Maulik Patel2358bbb2023-07-21 10:56:56 +010065
66 attest_key.crypto_lib = T_COSE_CRYPTO_LIB_PSA;
67 attest_key.k.key_handle = private_key;
68
Tamas Ban257471b2024-03-25 13:49:53 +010069 t_cose_sign1_set_signing_key(signer_ctx, attest_key, attest_key_id);
Maulik Patel2358bbb2023-07-21 10:56:56 +010070
Tamas Ban257471b2024-03-25 13:49:53 +010071 /* It is expected that the CBOR encoder is already initialized */
Maulik Patel2358bbb2023-07-21 10:56:56 +010072
Tamas Ban257471b2024-03-25 13:49:53 +010073 /* This encodes and writes the cose headers to be into the CBOR context. */
74 t_cose_err = t_cose_sign1_encode_parameters(signer_ctx,
75 cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +010076 if (t_cose_err) {
77 return t_cose_err_to_dpe_err(t_cose_err);
78 }
79
Tamas Ban257471b2024-03-25 13:49:53 +010080 QCBOREncode_OpenMap(cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +010081
82 return DPE_NO_ERROR;
83}
84
Tamas Ban257471b2024-03-25 13:49:53 +010085static void add_key_usage_claim(QCBOREncodeContext *cbor_enc_ctx)
Maulik Patel2358bbb2023-07-21 10:56:56 +010086{
87 uint8_t key_usage = DPE_CERT_KEY_USAGE_CERT_SIGN;
88
89 /* Encode key usage as byte string */
Tamas Ban257471b2024-03-25 13:49:53 +010090 QCBOREncode_AddBytesToMapN(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +010091 DPE_CERT_LABEL_KEY_USAGE,
92 (UsefulBufC){ &key_usage,
93 sizeof(key_usage) });
94}
95
Tamas Ban257471b2024-03-25 13:49:53 +010096static void add_label_claim(QCBOREncodeContext *cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +010097 const uint8_t *label,
98 size_t label_size)
99{
100 char label_hex[LABEL_HEX_SIZE];
101
102 /* If label is supplied, add label claim, else skip */
103 if ((label != NULL) && (label_size != 0)) {
104 convert_to_ascii_hex(&label[0],
105 label_size,
106 &label_hex[0],
107 sizeof(label_hex));
108
109 /* Encode label as text string */
Tamas Ban257471b2024-03-25 13:49:53 +0100110 QCBOREncode_AddTextToMapN(cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100111 DPE_CERT_LABEL_EXTERNAL_LABEL,
112 (UsefulBufC){ &label_hex[0],
113 label_size });
114 }
115}
116
Tamas Ban257471b2024-03-25 13:49:53 +0100117static void add_cdi_export_claim(QCBOREncodeContext *cbor_enc_ctx,
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100118 const struct layer_context_t *layer_ctx)
Maulik Patel9fd8bd22023-10-30 10:58:30 +0000119{
Tamas Ban257471b2024-03-25 13:49:53 +0100120 QCBOREncode_AddBoolToMapN(cbor_enc_ctx,
Maulik Patel9fd8bd22023-10-30 10:58:30 +0000121 DPE_CERT_LABEL_CDI_EXPORT,
122 layer_ctx->is_cdi_to_be_exported);
123}
124
Tamas Ban257471b2024-03-25 13:49:53 +0100125static void add_subject_claim(QCBOREncodeContext *cbor_enc_ctx,
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100126 const struct layer_context_t *layer_ctx)
Maulik Patel2358bbb2023-07-21 10:56:56 +0100127{
128 char cdi_id_hex[ID_HEX_SIZE];
129
130 convert_to_ascii_hex(&layer_ctx->data.cdi_id[0],
131 sizeof(layer_ctx->data.cdi_id),
132 &cdi_id_hex[0],
133 sizeof(cdi_id_hex));
134 /* Encode subject as text string */
Tamas Ban257471b2024-03-25 13:49:53 +0100135 QCBOREncode_AddTextToMapN(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100136 DPE_CERT_LABEL_SUBJECT,
137 (UsefulBufC){ &cdi_id_hex[0],
138 sizeof(cdi_id_hex) });
139}
140
Tamas Ban257471b2024-03-25 13:49:53 +0100141static void encode_issuer_claim(QCBOREncodeContext *cbor_enc_ctx,
Jamie Fox93225232023-09-22 14:09:30 +0100142 const uint8_t *issuer,
143 size_t issuer_size)
Maulik Patel2358bbb2023-07-21 10:56:56 +0100144{
Maulik Patel2358bbb2023-07-21 10:56:56 +0100145 char cdi_id_hex[ID_HEX_SIZE];
146
Jamie Fox93225232023-09-22 14:09:30 +0100147 convert_to_ascii_hex(issuer,
148 issuer_size,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100149 &cdi_id_hex[0],
150 sizeof(cdi_id_hex));
151
152 /* Encode issuer as text string */
Tamas Ban257471b2024-03-25 13:49:53 +0100153 QCBOREncode_AddTextToMapN(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100154 DPE_CERT_LABEL_ISSUER,
155 (UsefulBufC){ &cdi_id_hex[0],
156 sizeof(cdi_id_hex) });
157}
158
Tamas Ban257471b2024-03-25 13:49:53 +0100159static void encode_public_key(QCBOREncodeContext *cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100160 const uint8_t *pub_key,
161 size_t pub_key_size)
Maulik Patel2358bbb2023-07-21 10:56:56 +0100162{
163 /* As per RFC8152 */
164 const int64_t cose_key_type_value = DPE_T_COSE_KEY_TYPE_VAL;
165 const int64_t cose_key_ops_value = DPE_T_COSE_KEY_OPS_VAL;
166 const int64_t cose_key_ec2_curve_value = DPE_T_COSE_KEY_EC2_CURVE_VAL;
167 const int64_t cose_key_alg_value = DPE_T_COSE_KEY_ALG_VAL;
Maulik Patel2358bbb2023-07-21 10:56:56 +0100168
Tamas Ban257471b2024-03-25 13:49:53 +0100169 QCBOREncode_OpenMap(cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100170
171 /* Add the key type as int */
Tamas Ban257471b2024-03-25 13:49:53 +0100172 QCBOREncode_AddInt64ToMapN(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100173 DPE_CERT_LABEL_COSE_KEY_TYPE,
174 cose_key_type_value);
175
176 /* Add the algorithm as int */
Tamas Ban257471b2024-03-25 13:49:53 +0100177 QCBOREncode_AddInt64ToMapN(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100178 DPE_CERT_LABEL_COSE_KEY_ALG,
179 cose_key_alg_value);
180
181 /* Add the key operation as [+ (tstr/int)] */
Tamas Ban257471b2024-03-25 13:49:53 +0100182 QCBOREncode_OpenArrayInMapN(cbor_enc_ctx, DPE_CERT_LABEL_COSE_KEY_OPS);
183 QCBOREncode_AddInt64(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100184 cose_key_ops_value);
Tamas Ban257471b2024-03-25 13:49:53 +0100185 QCBOREncode_CloseArray(cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100186
187 /* Add the curve */
Tamas Ban257471b2024-03-25 13:49:53 +0100188 QCBOREncode_AddInt64ToMapN(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100189 DPE_CERT_LABEL_COSE_KEY_EC2_CURVE,
190 cose_key_ec2_curve_value);
191
Tamas Ban8ed52802024-03-14 09:36:05 +0100192 /*
193 * From psa/crypto.h:
194 *
195 * For other elliptic curve public keys (key types for which
196 * #PSA_KEY_TYPE_IS_ECC_PUBLIC_KEY is true), the format is the uncompressed
197 * representation defined by SEC1 &sect;2.3.3 as the content of an ECPoint.
198 * Let `m` be the bit size associated with the curve, i.e. the bit size of
199 * `q` for a curve over `F_q`. The representation consists of:
200 * - The byte 0x04;
201 * - `x_P` as a `ceiling(m/8)`-byte string, big-endian;
202 * - `y_P` as a `ceiling(m/8)`-byte string, big-endian.
203
204 * Furthermore, as per rfc5480 section-2.2:
205 *
206 * The first octet of the OCTET STRING indicates whether the key is
207 * compressed or uncompressed. The uncompressed form is indicated by 0x04
208 * and the compressed form is indicated by either 0x02 or 0x03.
209 */
Tamas Ban257471b2024-03-25 13:49:53 +0100210 QCBOREncode_AddBytesToMapN(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100211 DPE_CERT_LABEL_COSE_KEY_EC2_X,
Tamas Ban8ed52802024-03-14 09:36:05 +0100212 (UsefulBufC){ &pub_key[1],
Maulik Patele6adc112023-08-18 14:21:51 +0100213 pub_key_size / 2 });
Maulik Patel2358bbb2023-07-21 10:56:56 +0100214
Tamas Ban257471b2024-03-25 13:49:53 +0100215 QCBOREncode_AddBytesToMapN(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100216 DPE_CERT_LABEL_COSE_KEY_EC2_Y,
Tamas Ban8ed52802024-03-14 09:36:05 +0100217 (UsefulBufC){ &pub_key[1 + (pub_key_size / 2)],
Maulik Patele6adc112023-08-18 14:21:51 +0100218 pub_key_size / 2 });
Maulik Patel2358bbb2023-07-21 10:56:56 +0100219
Tamas Ban257471b2024-03-25 13:49:53 +0100220 QCBOREncode_CloseMap(cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100221
Maulik Patele6adc112023-08-18 14:21:51 +0100222}
223
Tamas Ban257471b2024-03-25 13:49:53 +0100224static void add_public_key_claim(QCBOREncodeContext *cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100225 const uint8_t *pub_key,
226 size_t pub_key_size)
227{
228 UsefulBufC wrapped;
229
230 /* Cose key is encoded as a map. This map is wrapped into the a
231 * byte string and it is further encoded as a map */
Tamas Ban257471b2024-03-25 13:49:53 +0100232 QCBOREncode_BstrWrapInMapN(cbor_enc_ctx, DPE_CERT_LABEL_SUBJECT_PUBLIC_KEY);
233 encode_public_key(cbor_enc_ctx, pub_key, pub_key_size);
234 QCBOREncode_CloseBstrWrap2(cbor_enc_ctx, true, &wrapped);
Maulik Patele6adc112023-08-18 14:21:51 +0100235 assert(wrapped.len <= DICE_MAX_ENCODED_PUBLIC_KEY_SIZE);
236}
237
Tamas Ban257471b2024-03-25 13:49:53 +0100238static void add_public_key_to_certificate_chain(QCBOREncodeContext *cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100239 const uint8_t *pub_key,
240 size_t pub_key_size)
241{
242 UsefulBufC wrapped;
243
244 /* Cose key is encoded as a map wrapped into a byte string */
Tamas Ban257471b2024-03-25 13:49:53 +0100245 QCBOREncode_BstrWrap(cbor_enc_ctx);
246 encode_public_key(cbor_enc_ctx, pub_key, pub_key_size);
247 QCBOREncode_CloseBstrWrap2(cbor_enc_ctx, true, &wrapped);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100248 assert(wrapped.len <= DICE_MAX_ENCODED_PUBLIC_KEY_SIZE);
249}
250
Tamas Ban257471b2024-03-25 13:49:53 +0100251static dpe_error_t certificate_encode_finish(QCBOREncodeContext *cbor_enc_ctx,
252 struct t_cose_sign1_sign_ctx *signer_ctx,
253 bool finish_cbor_encoding,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100254 UsefulBufC *completed_cert)
255{
256 QCBORError qcbor_result;
257 enum t_cose_err_t cose_return_value;
258
Tamas Ban257471b2024-03-25 13:49:53 +0100259 QCBOREncode_CloseMap(cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100260
261 /* -- Finish up the COSE_Sign1. This is where the signing happens -- */
Tamas Ban257471b2024-03-25 13:49:53 +0100262 cose_return_value = t_cose_sign1_encode_signature(signer_ctx,
263 cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100264 if (cose_return_value) {
265 /* Main errors are invoking the hash or signature */
266 return t_cose_err_to_dpe_err(cose_return_value);
267 }
268
Tamas Ban257471b2024-03-25 13:49:53 +0100269 /* If only a single certificate is created then encoding can be finished.
270 * Otherwise, when multiple certifcate is encoded in a raw
271 * (GetCertificateChain) then encoding will be finished
272 * by close_certificate_chain().
Maulik Patel2358bbb2023-07-21 10:56:56 +0100273 */
Tamas Ban257471b2024-03-25 13:49:53 +0100274 if (finish_cbor_encoding) {
275 /* Finally close off the CBOR formatting and get the pointer and length
276 * of the resulting COSE_Sign1.
277 */
278 qcbor_result = QCBOREncode_Finish(cbor_enc_ctx, completed_cert);
279 if (qcbor_result == QCBOR_ERR_BUFFER_TOO_SMALL) {
280 return DPE_INSUFFICIENT_MEMORY;
281 } else if (qcbor_result != QCBOR_SUCCESS) {
282 /* likely from array not closed, too many closes, ... */
283 return DPE_INTERNAL_ERROR;
284 } else {
285 return DPE_NO_ERROR;
286 }
Maulik Patel2358bbb2023-07-21 10:56:56 +0100287 }
288}
289
290static void encode_sw_component_measurements(QCBOREncodeContext *encode_ctx,
291 struct component_context_t *component_ctx)
292{
293 QCBOREncode_OpenMap(encode_ctx);
294
295 /* Encode measurement value as byte string */
296 QCBOREncode_AddBytesToMapN(encode_ctx,
297 DPE_CERT_LABEL_CODE_HASH,
298 (UsefulBufC){ &component_ctx->data.measurement_value,
299 DICE_HASH_SIZE });
300
301 /* Encode measurement descriptor version as byte string */
302 QCBOREncode_AddBytesToMapN(encode_ctx,
303 DPE_CERT_LABEL_CODE_DESCRIPTOR,
304 (UsefulBufC){ &component_ctx->data.measurement_descriptor,
305 component_ctx->data.measurement_descriptor_size });
306
307 /* Encode signer ID Hash as byte string */
308 QCBOREncode_AddBytesToMapN(encode_ctx,
309 DPE_CERT_LABEL_AUTHORITY_HASH,
310 (UsefulBufC){ &component_ctx->data.signer_id,
311 DICE_HASH_SIZE });
312
313 /* Encode signer ID descriptor as byte string */
314 QCBOREncode_AddBytesToMapN(encode_ctx,
315 DPE_CERT_LABEL_AUTHORITY_DESCRIPTOR,
316 (UsefulBufC){ &component_ctx->data.signer_id_descriptor,
317 component_ctx->data.signer_id_descriptor_size });
318
319 if (component_ctx->data.config_descriptor_size > 0) {
320 /* Encode config descriptor as byte string */
321 QCBOREncode_AddBytesToMapN(encode_ctx,
322 DPE_CERT_LABEL_CONFIGURATION_DESCRIPTOR,
323 (UsefulBufC){ &component_ctx->data.config_descriptor,
324 component_ctx->data.config_descriptor_size });
325 /* Encode config value as byte string */
326 QCBOREncode_AddBytesToMapN(encode_ctx,
327 DPE_CERT_LABEL_CONFIGURATION_HASH,
328 (UsefulBufC){ &component_ctx->data.config_value,
329 DICE_INLINE_CONFIG_SIZE });
330 } else {
331 /* Encode config value as byte string */
332 QCBOREncode_AddBytesToMapN(encode_ctx,
333 DPE_CERT_LABEL_CONFIGURATION_DESCRIPTOR,
334 (UsefulBufC){ &component_ctx->data.config_value,
335 DICE_INLINE_CONFIG_SIZE });
336 }
337
338 /* Encode mode value as byte string */
339 QCBOREncode_AddBytesToMapN(encode_ctx,
340 DPE_CERT_LABEL_MODE,
341 (UsefulBufC){ &component_ctx->data.mode,
342 sizeof(DiceMode) });
343
344 QCBOREncode_CloseMap(encode_ctx);
345}
346
347static void encode_layer_sw_components_array(uint16_t layer_idx,
Tamas Ban257471b2024-03-25 13:49:53 +0100348 QCBOREncodeContext *cbor_enc_ctx)
Maulik Patel2358bbb2023-07-21 10:56:56 +0100349{
350 int i, cnt;
351 struct component_context_t *component_ctx;
352
353 for (i = 0, cnt = 0; i < MAX_NUM_OF_COMPONENTS; i++) {
354 component_ctx = get_component_if_linked_to_layer(layer_idx, i);
355 if (component_ctx != NULL) {
356 /* This component belongs to current layer */
357 cnt++;
358
359 if (cnt == 1) {
360 /* Open array which stores SW components claims. */
Tamas Ban257471b2024-03-25 13:49:53 +0100361 QCBOREncode_OpenArrayInMapN(cbor_enc_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100362 DPE_CERT_LABEL_SW_COMPONENTS);
363 }
Tamas Ban257471b2024-03-25 13:49:53 +0100364 encode_sw_component_measurements(cbor_enc_ctx, component_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100365 }
366 }
367
368 if (cnt != 0) {
369 /* Close array which stores SW components claims. */
Tamas Ban257471b2024-03-25 13:49:53 +0100370 QCBOREncode_CloseArray(cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100371 }
372}
373
Tamas Ban257471b2024-03-25 13:49:53 +0100374static dpe_error_t add_issuer_claim(QCBOREncodeContext *cbor_enc_ctx,
Maulik Patel87c47ce2024-04-22 13:30:56 +0100375 const struct layer_context_t *layer_ctx,
Jamie Fox93225232023-09-22 14:09:30 +0100376 psa_key_id_t root_attest_key_id,
377 const struct layer_context_t *parent_layer_ctx)
378{
379 uint8_t rot_cdi_id[DICE_ID_SIZE];
380
Maulik Patel87c47ce2024-04-22 13:30:56 +0100381 if (layer_ctx->is_rot_layer) {
Jamie Fox93225232023-09-22 14:09:30 +0100382 /* For the RoT layer, issuer id is derived from the root attestation key */
383 if (derive_cdi_id(root_attest_key_id, rot_cdi_id,
384 sizeof(rot_cdi_id)) != PSA_SUCCESS) {
385 return DPE_INTERNAL_ERROR;
386 }
387
Tamas Ban257471b2024-03-25 13:49:53 +0100388 encode_issuer_claim(cbor_enc_ctx,
Jamie Fox93225232023-09-22 14:09:30 +0100389 rot_cdi_id,
390 sizeof(rot_cdi_id));
391 } else {
Tamas Ban257471b2024-03-25 13:49:53 +0100392 encode_issuer_claim(cbor_enc_ctx,
Jamie Fox93225232023-09-22 14:09:30 +0100393 parent_layer_ctx->data.cdi_id,
394 sizeof(parent_layer_ctx->data.cdi_id));
395 }
396
397 return DPE_NO_ERROR;
398}
Maulik Patel2358bbb2023-07-21 10:56:56 +0100399
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100400static dpe_error_t encode_layer_certificate_internal(const struct layer_context_t *layer_ctx,
Tamas Ban257471b2024-03-25 13:49:53 +0100401 QCBOREncodeContext *cbor_enc_ctx,
402 bool finish_cbor_encoding,
403 size_t *cert_actual_size)
Maulik Patel2358bbb2023-07-21 10:56:56 +0100404{
Tamas Ban257471b2024-03-25 13:49:53 +0100405 struct t_cose_sign1_sign_ctx signer_ctx;
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100406 struct layer_context_t *parent_layer_ctx;
407 uint16_t parent_layer_idx, layer_idx;
Maulik Patel2358bbb2023-07-21 10:56:56 +0100408 dpe_error_t err;
Maulik Patel2358bbb2023-07-21 10:56:56 +0100409 UsefulBufC completed_cert;
Jamie Fox93225232023-09-22 14:09:30 +0100410 psa_key_id_t attest_key_id;
Maulik Patel2358bbb2023-07-21 10:56:56 +0100411
Tamas Ban257471b2024-03-25 13:49:53 +0100412 /* Valid options: true & !NULL OR false & NULL */
413 assert(finish_cbor_encoding ^ (cert_actual_size == NULL));
414
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100415 layer_idx = layer_ctx->idx;
Tamas Ban257471b2024-03-25 13:49:53 +0100416 assert(layer_idx < MAX_NUM_OF_LAYERS);
Tamas Ban257471b2024-03-25 13:49:53 +0100417 parent_layer_idx = layer_ctx->parent_layer_idx;
418 assert(parent_layer_idx < MAX_NUM_OF_LAYERS);
419 parent_layer_ctx = get_layer_ctx_ptr(parent_layer_idx);
420
Jamie Fox93225232023-09-22 14:09:30 +0100421 /* The RoT layer certificate is signed by the provisioned attestation key,
Tamas Ban257471b2024-03-25 13:49:53 +0100422 * all other layers are signed by the parent layer's attestation key.
Jamie Fox93225232023-09-22 14:09:30 +0100423 */
Maulik Patel87c47ce2024-04-22 13:30:56 +0100424 if (layer_ctx->is_rot_layer) {
Jamie Fox93225232023-09-22 14:09:30 +0100425 attest_key_id = dpe_plat_get_root_attest_key_id();
426 } else {
427 attest_key_id = parent_layer_ctx->data.attest_key_id;
428 }
Maulik Patel2358bbb2023-07-21 10:56:56 +0100429
Tamas Ban257471b2024-03-25 13:49:53 +0100430 /* Get started creating the certificate. This sets up the CBOR and
Maulik Patel2358bbb2023-07-21 10:56:56 +0100431 * COSE contexts which causes the COSE headers to be constructed.
432 */
Tamas Ban257471b2024-03-25 13:49:53 +0100433 err = certificate_encode_start(cbor_enc_ctx,
434 &signer_ctx,
Maulik Patel2358bbb2023-07-21 10:56:56 +0100435 attest_key_id);
436 if (err != DPE_NO_ERROR) {
437 return err;
438 }
439
440 /* Add all the required claims */
441 /* Add issuer/authority claim */
Maulik Patel87c47ce2024-04-22 13:30:56 +0100442 err = add_issuer_claim(cbor_enc_ctx, layer_ctx, attest_key_id, parent_layer_ctx);
Jamie Fox93225232023-09-22 14:09:30 +0100443 if (err != DPE_NO_ERROR) {
444 return err;
445 }
Maulik Patel2358bbb2023-07-21 10:56:56 +0100446
447 /* Add subject claim */
Tamas Ban257471b2024-03-25 13:49:53 +0100448 add_subject_claim(cbor_enc_ctx, layer_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100449
450 /* Encode all firmware measurements for the components linked to this layer */
451 //TODO:
452 /* It is not yet defined in the open-dice profile how to represent
453 * multiple SW components in a single certificate; In current implementation,
454 * an array is created for all the components' measurements and within the
455 * array, there are multiple maps, one for each SW component
456 */
Tamas Ban257471b2024-03-25 13:49:53 +0100457 encode_layer_sw_components_array(layer_idx, cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100458
Maulik Patele6adc112023-08-18 14:21:51 +0100459 /* Add label claim */
Tamas Ban257471b2024-03-25 13:49:53 +0100460 add_label_claim(cbor_enc_ctx,
Maulik Patel4fed7812023-12-08 09:55:22 +0000461 &layer_ctx->data.external_key_deriv_label[0],
462 layer_ctx->data.external_key_deriv_label_len);
Maulik Patele6adc112023-08-18 14:21:51 +0100463
Maulik Patel2358bbb2023-07-21 10:56:56 +0100464 /* Add public key claim */
Tamas Ban257471b2024-03-25 13:49:53 +0100465 add_public_key_claim(cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100466 &layer_ctx->data.attest_pub_key[0],
467 layer_ctx->data.attest_pub_key_len);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100468
469 /* Add key usage claim */
Tamas Ban257471b2024-03-25 13:49:53 +0100470 add_key_usage_claim(cbor_enc_ctx);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100471
Maulik Patel9fd8bd22023-10-30 10:58:30 +0000472 /* Add CDI exported claim */
473 if (layer_ctx->is_cdi_to_be_exported) {
Tamas Ban257471b2024-03-25 13:49:53 +0100474 add_cdi_export_claim(cbor_enc_ctx, layer_ctx);
Maulik Patel9fd8bd22023-10-30 10:58:30 +0000475 }
476
Tamas Ban257471b2024-03-25 13:49:53 +0100477 /* Finish up creating the certificate. This is where the actual signature
478 * is generated.
Maulik Patel2358bbb2023-07-21 10:56:56 +0100479 */
Tamas Ban257471b2024-03-25 13:49:53 +0100480 err = certificate_encode_finish(cbor_enc_ctx, &signer_ctx,
481 finish_cbor_encoding, &completed_cert);
Maulik Patel2358bbb2023-07-21 10:56:56 +0100482 if (err != DPE_NO_ERROR) {
483 return err;
484 }
485
Tamas Ban257471b2024-03-25 13:49:53 +0100486 /* Update the final size of the certificate if requested */
487 if (cert_actual_size != NULL) {
488 *cert_actual_size = completed_cert.len;
489 }
Maulik Patel2358bbb2023-07-21 10:56:56 +0100490
491 return err;
492}
493
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100494dpe_error_t encode_layer_certificate(const struct layer_context_t *layer_ctx,
Tamas Ban257471b2024-03-25 13:49:53 +0100495 uint8_t *cert_buf,
496 size_t cert_buf_size,
497 size_t *cert_actual_size)
498{
499 QCBOREncodeContext cbor_enc_ctx;
500
501 QCBOREncode_Init(&cbor_enc_ctx,
502 (UsefulBuf){ cert_buf,
503 cert_buf_size });
504
505 /* Only a single certificate is encoded */
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100506 return encode_layer_certificate_internal(layer_ctx, &cbor_enc_ctx,
Tamas Ban257471b2024-03-25 13:49:53 +0100507 true, cert_actual_size);
508}
509
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100510dpe_error_t store_layer_certificate(const struct layer_context_t *layer_ctx)
Maulik Patel2358bbb2023-07-21 10:56:56 +0100511{
512 //TODO:
513 (void)layer_ctx;
514 return DPE_NO_ERROR;
515}
Maulik Patele6adc112023-08-18 14:21:51 +0100516
Tamas Ban257471b2024-03-25 13:49:53 +0100517static void open_certificate_chain(QCBOREncodeContext *cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100518 uint8_t *cert_chain_buf,
519 size_t cert_chain_buf_size)
520{
521 /* Set up encoding context with output buffer. */
Tamas Ban257471b2024-03-25 13:49:53 +0100522 QCBOREncode_Init(cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100523 (UsefulBuf){ &cert_chain_buf[0],
524 cert_chain_buf_size });
Tamas Ban257471b2024-03-25 13:49:53 +0100525 QCBOREncode_OpenArray(cbor_enc_ctx);
Maulik Patele6adc112023-08-18 14:21:51 +0100526}
527
Tamas Ban257471b2024-03-25 13:49:53 +0100528static dpe_error_t close_certificate_chain(QCBOREncodeContext *cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100529 size_t *cert_chain_actual_size)
530{
531 QCBORError encode_error;
532 UsefulBufC completed_cert_chain;
533
Tamas Ban257471b2024-03-25 13:49:53 +0100534 QCBOREncode_CloseArray(cbor_enc_ctx);
Maulik Patele6adc112023-08-18 14:21:51 +0100535
Tamas Ban257471b2024-03-25 13:49:53 +0100536 encode_error = QCBOREncode_Finish(cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100537 &completed_cert_chain);
538
539 /* Check for any encoding errors. */
540 if (encode_error == QCBOR_ERR_BUFFER_TOO_SMALL) {
541 return DPE_INSUFFICIENT_MEMORY;
542 } else if (encode_error != QCBOR_SUCCESS) {
543 return DPE_INTERNAL_ERROR;
544 }
545
546 *cert_chain_actual_size = completed_cert_chain.len;
547
548 return DPE_NO_ERROR;
549}
550
Tamas Ban257471b2024-03-25 13:49:53 +0100551static dpe_error_t add_root_attestation_public_key(QCBOREncodeContext *cbor_enc_ctx)
Maulik Patele6adc112023-08-18 14:21:51 +0100552{
553 psa_status_t status;
554 psa_key_id_t attest_key_id;
555 uint8_t attest_pub_key[DPE_ATTEST_PUB_KEY_SIZE];
556 size_t attest_pub_key_len;
557
558 attest_key_id = dpe_plat_get_root_attest_key_id();
559
560 status = psa_export_public_key(attest_key_id, attest_pub_key,
561 sizeof(attest_pub_key), &attest_pub_key_len);
562 if (status != PSA_SUCCESS) {
563 return DPE_INTERNAL_ERROR;
564 }
565
Tamas Ban257471b2024-03-25 13:49:53 +0100566 add_public_key_to_certificate_chain(cbor_enc_ctx, &attest_pub_key[0], attest_pub_key_len);
Maulik Patele6adc112023-08-18 14:21:51 +0100567
568 return DPE_NO_ERROR;
569}
570
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100571dpe_error_t get_certificate_chain(const struct layer_context_t *layer_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100572 uint8_t *cert_chain_buf,
573 size_t cert_chain_buf_size,
574 size_t *cert_chain_actual_size)
575{
Tamas Ban257471b2024-03-25 13:49:53 +0100576 QCBOREncodeContext cbor_enc_ctx;
Maulik Patele6adc112023-08-18 14:21:51 +0100577 dpe_error_t err;
578 int i;
579 uint16_t layer_chain[MAX_NUM_OF_LAYERS];
580 uint16_t layer_cnt = 0;
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100581 uint16_t layer_idx = layer_ctx->idx;
Maulik Patele6adc112023-08-18 14:21:51 +0100582
Tamas Ban257471b2024-03-25 13:49:53 +0100583 open_certificate_chain(&cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100584 cert_chain_buf,
585 cert_chain_buf_size);
586
587 /* Add DICE/Root public key (IAK public key) as the first entry of array */
Tamas Ban257471b2024-03-25 13:49:53 +0100588 err = add_root_attestation_public_key(&cbor_enc_ctx);
Maulik Patele6adc112023-08-18 14:21:51 +0100589 if (err != DPE_NO_ERROR) {
590 return err;
591 }
592
593 /* Loop from leaf to the RoT layer & save all the linked layers in this chain */
594 while ((layer_idx >= DPE_ROT_LAYER_IDX) && (layer_cnt < MAX_NUM_OF_LAYERS)) {
595
596 /* Save layer idx */
597 layer_chain[layer_cnt++] = layer_idx;
598
599 if (layer_idx == DPE_ROT_LAYER_IDX) {
600 /* This is the end of chain */
601 break;
602 }
603
604 layer_ctx = get_layer_ctx_ptr(layer_idx);
605 assert(layer_ctx->parent_layer_idx < layer_idx);
606 /* Move to the parent layer */
607 layer_idx = layer_ctx->parent_layer_idx;
608 }
609
610 i = (layer_cnt > 0) ? layer_cnt - 1 : 0;
611
612 /* Add certificate from RoT to leaf layer order */
613 while (i >= DPE_ROT_LAYER_IDX) {
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100614 layer_ctx = get_layer_ctx_ptr(layer_chain[i]);
Tamas Ban257471b2024-03-25 13:49:53 +0100615 /* Might multiple certificate is encoded */
Maulik Patelaa6b24f2024-04-05 15:13:08 +0100616 err = encode_layer_certificate_internal(layer_ctx, &cbor_enc_ctx,
Tamas Ban257471b2024-03-25 13:49:53 +0100617 false, NULL);
618 if (err != DPE_NO_ERROR) {
619 return err;
620 }
Maulik Patele6adc112023-08-18 14:21:51 +0100621 i--;
622 }
623
Tamas Ban257471b2024-03-25 13:49:53 +0100624 return close_certificate_chain(&cbor_enc_ctx,
Maulik Patele6adc112023-08-18 14:21:51 +0100625 cert_chain_actual_size);
626}
Maulik Patel9fd8bd22023-10-30 10:58:30 +0000627
Tamas Ban5179a4d2024-01-25 17:05:30 +0100628dpe_error_t encode_cdi(const uint8_t cdi_attest_buf[DICE_CDI_SIZE],
629 const uint8_t cdi_seal_buf[DICE_CDI_SIZE],
Maulik Patel9fd8bd22023-10-30 10:58:30 +0000630 uint8_t *encoded_cdi_buf,
631 size_t encoded_cdi_buf_size,
632 size_t *encoded_cdi_actual_size)
633{
634 QCBOREncodeContext encode_ctx;
635 QCBORError encode_err;
636 UsefulBufC out;
637
638 QCBOREncode_Init(&encode_ctx, (UsefulBuf){ encoded_cdi_buf, encoded_cdi_buf_size });
639 QCBOREncode_OpenMap(&encode_ctx);
640
641 /* Encode CDI value as byte string */
642 QCBOREncode_AddBytesToMapN(&encode_ctx,
643 DPE_LABEL_CDI_ATTEST,
Tamas Ban5179a4d2024-01-25 17:05:30 +0100644 (UsefulBufC){ cdi_attest_buf, DICE_CDI_SIZE });
645
646 QCBOREncode_AddBytesToMapN(&encode_ctx,
647 DPE_LABEL_CDI_SEAL,
648 (UsefulBufC){ cdi_seal_buf, DICE_CDI_SIZE });
Maulik Patel9fd8bd22023-10-30 10:58:30 +0000649
650 QCBOREncode_CloseMap(&encode_ctx);
651 encode_err = QCBOREncode_Finish(&encode_ctx, &out);
652
653 /* Check for any encoding errors. */
654 if (encode_err == QCBOR_ERR_BUFFER_TOO_SMALL) {
655 return DPE_INSUFFICIENT_MEMORY;
656 } else if (encode_err != QCBOR_SUCCESS) {
657 return DPE_INTERNAL_ERROR;
658 }
659
660 *encoded_cdi_actual_size = out.len;
661
662 return DPE_NO_ERROR;
663}