1 // SPDX-License-Identifier: BSD-2-Clause 2 /* 3 * Copyright (c) 2017-2020, Linaro Limited 4 */ 5 6 #include <assert.h> 7 #include <bitstring.h> 8 #include <pkcs11_ta.h> 9 #include <stdlib.h> 10 #include <string.h> 11 #include <util.h> 12 #include <tee_internal_api.h> 13 #include <tee_internal_api_extensions.h> 14 #include <trace.h> 15 16 #include "attributes.h" 17 #include "pkcs11_helpers.h" 18 #include "sanitize_object.h" 19 #include "serializer.h" 20 #include "token_capabilities.h" 21 22 /* 23 * Functions to generate a serialized object. 24 * References are pointers to struct serializer. 25 */ 26 27 bool sanitize_consistent_class_and_type(struct obj_attrs *attrs) 28 { 29 switch (get_class(attrs)) { 30 case PKCS11_CKO_DATA: 31 return true; 32 case PKCS11_CKO_SECRET_KEY: 33 return key_type_is_symm_key(get_key_type(attrs)); 34 case PKCS11_CKO_MECHANISM: 35 return mechanism_is_valid(get_mechanism_type(attrs)); 36 case PKCS11_CKO_PUBLIC_KEY: 37 case PKCS11_CKO_PRIVATE_KEY: 38 return key_type_is_asymm_key(get_key_type(attrs)); 39 case PKCS11_CKO_OTP_KEY: 40 case PKCS11_CKO_CERTIFICATE: 41 case PKCS11_CKO_DOMAIN_PARAMETERS: 42 case PKCS11_CKO_HW_FEATURE: 43 default: 44 return false; 45 } 46 47 return false; 48 } 49 50 static enum pkcs11_rc read_attr_advance(void *buf, size_t blen, size_t *pos, 51 struct pkcs11_attribute_head *attr, 52 void **data) 53 { 54 uint8_t *b = buf; 55 size_t data_pos = 0; 56 size_t next_pos = 0; 57 58 if (ADD_OVERFLOW(*pos, sizeof(*attr), &data_pos) || data_pos > blen) 59 return PKCS11_CKR_FUNCTION_FAILED; 60 TEE_MemMove(attr, b + *pos, sizeof(*attr)); 61 62 if (ADD_OVERFLOW(data_pos, attr->size, &next_pos) || next_pos > blen) 63 return PKCS11_CKR_FUNCTION_FAILED; 64 65 *data = b + data_pos; 66 *pos = next_pos; 67 68 return PKCS11_CKR_OK; 69 } 70 71 /* Sanitize class/type in a client attribute list */ 72 static enum pkcs11_rc sanitize_class_and_type(struct obj_attrs **dst, void *src, 73 size_t src_size, 74 uint32_t class_hint, 75 uint32_t type_hint) 76 { 77 uint32_t class_found = PKCS11_CKO_UNDEFINED_ID; 78 size_t pos = sizeof(struct pkcs11_object_head); 79 struct pkcs11_attribute_head cli_ref = { }; 80 uint32_t type_found = PKCS11_UNDEFINED_ID; 81 enum pkcs11_rc rc = PKCS11_CKR_OK; 82 void *data = NULL; 83 84 while (pos != src_size) { 85 rc = read_attr_advance(src, src_size, &pos, &cli_ref, &data); 86 if (rc) 87 goto err; 88 89 if (cli_ref.id == PKCS11_CKA_CLASS) { 90 uint32_t class = 0; 91 92 if (cli_ref.size != sizeof(class)) { 93 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 94 goto err; 95 } 96 97 TEE_MemMove(&class, data, sizeof(class)); 98 99 if (class_found != PKCS11_CKO_UNDEFINED_ID && 100 class_found != class) { 101 EMSG("Conflicting class value"); 102 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 103 goto err; 104 } 105 106 class_found = class; 107 continue; 108 } 109 110 /* The attribute is a type-in-class */ 111 if (pkcs11_attr_is_type(cli_ref.id)) { 112 uint32_t type = 0; 113 114 if (cli_ref.size != sizeof(type)) { 115 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 116 goto err; 117 } 118 119 TEE_MemMove(&type, data, sizeof(type)); 120 121 if (type_found != PKCS11_CKK_UNDEFINED_ID && 122 type_found != type) { 123 EMSG("Conflicting type-in-class value"); 124 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 125 goto err; 126 } 127 128 type_found = type; 129 } 130 } 131 132 if (class_found != PKCS11_CKO_UNDEFINED_ID) { 133 rc = add_attribute(dst, PKCS11_CKA_CLASS, 134 &class_found, sizeof(class_found)); 135 if (rc) 136 return rc; 137 } else { 138 if (class_hint != PKCS11_CKO_UNDEFINED_ID) { 139 rc = add_attribute(dst, PKCS11_CKA_CLASS, 140 &class_hint, sizeof(class_hint)); 141 if (rc) 142 return rc; 143 } 144 } 145 146 if (type_found != PKCS11_UNDEFINED_ID) { 147 rc = add_attribute(dst, PKCS11_CKA_KEY_TYPE, 148 &type_found, sizeof(type_found)); 149 if (rc) 150 return rc; 151 } else { 152 if (type_hint != PKCS11_UNDEFINED_ID) { 153 rc = add_attribute(dst, PKCS11_CKA_KEY_TYPE, 154 &type_hint, sizeof(type_hint)); 155 if (rc) 156 return rc; 157 } 158 } 159 160 return PKCS11_CKR_OK; 161 162 err: 163 trace_attributes_from_api_head("bad-template", src, src_size); 164 165 return rc; 166 } 167 168 static enum pkcs11_rc sanitize_boolprops(struct obj_attrs **dst, void *src, 169 size_t src_size) 170 { 171 bitstr_t bit_decl(seen_attrs, PKCS11_BOOLPROPS_MAX_COUNT) = { 0 }; 172 bitstr_t bit_decl(boolprops, PKCS11_BOOLPROPS_MAX_COUNT) = { 0 }; 173 size_t pos = sizeof(struct pkcs11_object_head); 174 struct pkcs11_attribute_head cli_ref = { }; 175 enum pkcs11_rc rc = PKCS11_CKR_OK; 176 bool value = false; 177 void *data = NULL; 178 int idx = 0; 179 180 /* 181 * We're keeping track of seen boolean attributes in the bitstring 182 * seen_attrs. The bitstring boolprops holds the recorded value 183 * once seen_attrs has been updated. 184 */ 185 186 while (pos != src_size) { 187 rc = read_attr_advance(src, src_size, &pos, &cli_ref, &data); 188 if (rc) 189 return rc; 190 191 idx = pkcs11_attr2boolprop_shift(cli_ref.id); 192 if (idx < 0) 193 continue; /* skipping non-boolean attributes */ 194 195 if (idx >= PKCS11_BOOLPROPS_MAX_COUNT || 196 cli_ref.size != sizeof(uint8_t)) 197 return PKCS11_CKR_FUNCTION_FAILED; 198 199 value = *(uint8_t *)data; 200 201 /* 202 * If this attribute has already been seen, check that it 203 * still holds the same value as last time. 204 */ 205 if (bit_test(seen_attrs, idx) && 206 value != (bool)bit_test(boolprops, idx)) 207 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 208 209 if (value) 210 bit_set(boolprops, idx); 211 212 if (!bit_test(seen_attrs, idx)) { 213 uint8_t pkcs11_bool = value; 214 215 rc = add_attribute(dst, cli_ref.id, &pkcs11_bool, 216 sizeof(pkcs11_bool)); 217 if (rc) 218 return rc; 219 } 220 bit_set(seen_attrs, idx); 221 } 222 223 return PKCS11_CKR_OK; 224 } 225 226 static uint32_t sanitize_indirect_attr(struct obj_attrs **dst, 227 struct pkcs11_attribute_head *cli_ref, 228 char *data) 229 { 230 struct obj_attrs *obj2 = NULL; 231 enum pkcs11_rc rc = PKCS11_CKR_OK; 232 233 assert(pkcs11_attr_has_indirect_attributes(cli_ref->id)); 234 235 rc = init_attributes_head(&obj2); 236 if (rc) 237 return rc; 238 239 /* Build a new serial object while sanitizing the attributes list */ 240 rc = sanitize_client_object(&obj2, data, cli_ref->size, 241 PKCS11_CKO_UNDEFINED_ID, 242 PKCS11_UNDEFINED_ID); 243 if (rc) 244 goto out; 245 246 rc = add_attribute(dst, cli_ref->id, obj2, 247 sizeof(*obj2) + obj2->attrs_size); 248 out: 249 TEE_Free(obj2); 250 return rc; 251 } 252 253 enum pkcs11_rc sanitize_client_object(struct obj_attrs **dst, void *src, 254 size_t size, uint32_t class_hint, 255 uint32_t type_hint) 256 { 257 struct pkcs11_attribute_head cli_ref = { }; 258 struct pkcs11_object_head head = { }; 259 enum pkcs11_rc rc = PKCS11_CKR_OK; 260 size_t pos = sizeof(head); 261 size_t sz_from_hdr = 0; 262 void *data = NULL; 263 264 if (size < sizeof(head)) 265 return PKCS11_CKR_ARGUMENTS_BAD; 266 267 TEE_MemMove(&head, src, sizeof(head)); 268 269 if (ADD_OVERFLOW(sizeof(head), head.attrs_size, &sz_from_hdr) || 270 size < sz_from_hdr) 271 return PKCS11_CKR_ARGUMENTS_BAD; 272 273 rc = init_attributes_head(dst); 274 if (rc) 275 return rc; 276 277 rc = sanitize_class_and_type(dst, src, sz_from_hdr, class_hint, 278 type_hint); 279 if (rc) 280 return rc; 281 282 rc = sanitize_boolprops(dst, src, sz_from_hdr); 283 if (rc) 284 return rc; 285 286 while (pos != sz_from_hdr) { 287 rc = read_attr_advance(src, sz_from_hdr, &pos, &cli_ref, &data); 288 if (rc) 289 return rc; 290 291 if (cli_ref.id == PKCS11_CKA_CLASS || 292 pkcs11_attr_is_type(cli_ref.id) || 293 pkcs11_attr_is_boolean(cli_ref.id)) 294 continue; 295 296 if (pkcs11_attr_has_indirect_attributes(cli_ref.id)) { 297 rc = sanitize_indirect_attr(dst, &cli_ref, data); 298 if (rc) 299 return rc; 300 301 continue; 302 } 303 304 if (!valid_pkcs11_attribute_id(cli_ref.id, cli_ref.size)) { 305 EMSG("Invalid attribute id %#"PRIx32, cli_ref.id); 306 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 307 } 308 309 rc = add_attribute(dst, cli_ref.id, data, cli_ref.size); 310 if (rc) 311 return rc; 312 } 313 314 return rc; 315 } 316 317 /* 318 * Debug: dump object attribute array to output trace 319 */ 320 321 static void __trace_attributes(char *prefix, void *src, void *end) 322 { 323 size_t next = 0; 324 char *prefix2 = NULL; 325 size_t prefix_len = strlen(prefix); 326 char *cur = src; 327 328 /* append 4 spaces to the prefix plus terminal '\0' */ 329 prefix2 = TEE_Malloc(prefix_len + 1 + 4, TEE_MALLOC_FILL_ZERO); 330 if (!prefix2) 331 return; 332 333 TEE_MemMove(prefix2, prefix, prefix_len + 1); 334 TEE_MemFill(prefix2 + prefix_len, ' ', 4); 335 *(prefix2 + prefix_len + 4) = '\0'; 336 337 for (; cur < (char *)end; cur += next) { 338 struct pkcs11_attribute_head pkcs11_ref; 339 uint8_t data[4] = { 0 }; 340 uint32_t data_u32 = 0; 341 char *start = NULL; 342 343 TEE_MemMove(&pkcs11_ref, cur, sizeof(pkcs11_ref)); 344 TEE_MemMove(&data[0], cur + sizeof(pkcs11_ref), 345 MIN(pkcs11_ref.size, sizeof(data))); 346 TEE_MemMove(&data_u32, cur + sizeof(pkcs11_ref), 347 sizeof(data_u32)); 348 349 next = sizeof(pkcs11_ref) + pkcs11_ref.size; 350 351 DMSG_RAW("%s Attr %s / %s (%#04"PRIx32" %"PRIu32"-byte)", 352 prefix, id2str_attr(pkcs11_ref.id), 353 id2str_attr_value(pkcs11_ref.id, pkcs11_ref.size, 354 cur + sizeof(pkcs11_ref)), 355 pkcs11_ref.id, pkcs11_ref.size); 356 357 switch (pkcs11_ref.size) { 358 case 0: 359 break; 360 case 1: 361 DMSG_RAW("%s Attr byte value: %02x", prefix, data[0]); 362 break; 363 case 2: 364 DMSG_RAW("%s Attr byte value: %02x %02x", 365 prefix, data[0], data[1]); 366 break; 367 case 3: 368 DMSG_RAW("%s Attr byte value: %02x %02x %02x", 369 prefix, data[0], data[1], data[2]); 370 break; 371 case 4: 372 DMSG_RAW("%s Attr byte value: %02x %02x %02x %02x", 373 prefix, data[0], data[1], data[2], data[3]); 374 break; 375 default: 376 DMSG_RAW("%s Attr byte value: %02x %02x %02x %02x ...", 377 prefix, data[0], data[1], data[2], data[3]); 378 break; 379 } 380 381 switch (pkcs11_ref.id) { 382 case PKCS11_CKA_WRAP_TEMPLATE: 383 case PKCS11_CKA_UNWRAP_TEMPLATE: 384 case PKCS11_CKA_DERIVE_TEMPLATE: 385 start = cur + sizeof(pkcs11_ref); 386 trace_attributes_from_api_head(prefix2, start, 387 (char *)end - start); 388 break; 389 default: 390 break; 391 } 392 } 393 394 /* Sanity */ 395 if (cur != (char *)end) 396 EMSG("Warning: unexpected alignment issue"); 397 398 TEE_Free(prefix2); 399 } 400 401 void trace_attributes_from_api_head(const char *prefix, void *ref, size_t size) 402 { 403 struct pkcs11_object_head head = { }; 404 char *pre = NULL; 405 size_t offset = 0; 406 407 TEE_MemMove(&head, ref, sizeof(head)); 408 409 if (size > sizeof(head) + head.attrs_size) { 410 EMSG("template overflows client buffer (%zu/%zu)", 411 size, sizeof(head) + head.attrs_size); 412 return; 413 } 414 415 pre = TEE_Malloc(prefix ? strlen(prefix) + 2 : 2, TEE_MALLOC_FILL_ZERO); 416 if (!pre) { 417 EMSG("%s: out of memory", prefix); 418 return; 419 } 420 if (prefix) 421 TEE_MemMove(pre, prefix, strlen(prefix)); 422 423 DMSG_RAW("%s,--- (serial object) Attributes list --------", pre); 424 DMSG_RAW("%s| %"PRIu32" item(s) - %"PRIu32" bytes", 425 pre, head.attrs_count, head.attrs_size); 426 427 offset = sizeof(head); 428 pre[prefix ? strlen(prefix) : 0] = '|'; 429 __trace_attributes(pre, (char *)ref + offset, 430 (char *)ref + offset + head.attrs_size); 431 432 DMSG_RAW("%s`-----------------------", prefix ? prefix : ""); 433 434 TEE_Free(pre); 435 } 436