1 // SPDX-License-Identifier: BSD-2-Clause 2 /* 3 * Copyright (c) 2017-2020, Linaro Limited 4 */ 5 6 #include <assert.h> 7 #include <pkcs11_ta.h> 8 #include <string.h> 9 #include <util.h> 10 #include <tee_api.h> 11 #include <tee_internal_api_extensions.h> 12 13 #include "pkcs11_helpers.h" 14 #include "token_capabilities.h" 15 16 #define ALLOWED_PKCS11_CKFM \ 17 (PKCS11_CKFM_ENCRYPT | PKCS11_CKFM_DECRYPT | \ 18 PKCS11_CKFM_DERIVE | PKCS11_CKFM_DIGEST | \ 19 PKCS11_CKFM_SIGN | PKCS11_CKFM_SIGN_RECOVER | \ 20 PKCS11_CKFM_VERIFY | PKCS11_CKFM_VERIFY_RECOVER | \ 21 PKCS11_CKFM_GENERATE | PKCS11_CKFM_GENERATE_KEY_PAIR | \ 22 PKCS11_CKFM_WRAP | PKCS11_CKFM_UNWRAP) 23 24 /* 25 * Definition of supported processings for a PKCS#11 mechanisms 26 * @id: Mechanism ID 27 * @flags: Valid PKCS11_CKFM_* for a mechanism as per PKCS#11 28 * @one_shot: true of mechanism can be used for a one-short processing 29 * @string: Helper string of the mechanism ID for debug purpose 30 */ 31 struct pkcs11_mechachism_modes { 32 uint32_t id; 33 uint32_t flags; 34 bool one_shot; 35 #if CFG_TEE_TA_LOG_LEVEL > 0 36 const char *string; 37 #endif 38 }; 39 40 #if CFG_TEE_TA_LOG_LEVEL > 0 41 #define MECHANISM(_label, _flags, _single_part) \ 42 { \ 43 .id = _label, \ 44 .one_shot = (_single_part), \ 45 .flags = (_flags), \ 46 .string = #_label, \ 47 } 48 #else 49 #define MECHANISM(_label, _flags, _single_part) \ 50 { \ 51 .id = _label, \ 52 .one_shot = (_single_part), \ 53 .flags = (_flags), \ 54 } 55 #endif 56 57 #define SINGLE_PART_ONLY true 58 #define ANY_PART false 59 60 #define CKFM_CIPHER (PKCS11_CKFM_ENCRYPT | PKCS11_CKFM_DECRYPT) 61 #define CKFM_WRAP_UNWRAP (PKCS11_CKFM_WRAP | PKCS11_CKFM_UNWRAP) 62 #define CKFM_CIPHER_WRAP (CKFM_CIPHER | CKFM_WRAP_UNWRAP) 63 #define CKFM_CIPHER_WRAP_DERIVE (CKFM_CIPHER_WRAP | PKCS11_CKFM_DERIVE) 64 #define CKFM_AUTH_NO_RECOVER (PKCS11_CKFM_SIGN | PKCS11_CKFM_VERIFY) 65 #define CKFM_AUTH_WITH_RECOVER (PKCS11_CKFM_SIGN_RECOVER | \ 66 PKCS11_CKFM_VERIFY_RECOVER) 67 68 /* PKCS#11 specificies permitted operation for each mechanism */ 69 static const struct pkcs11_mechachism_modes pkcs11_modes[] = { 70 /* AES */ 71 MECHANISM(PKCS11_CKM_AES_ECB, CKFM_CIPHER_WRAP, ANY_PART), 72 MECHANISM(PKCS11_CKM_AES_CBC, CKFM_CIPHER_WRAP, ANY_PART), 73 MECHANISM(PKCS11_CKM_AES_CBC_PAD, CKFM_CIPHER_WRAP, ANY_PART), 74 MECHANISM(PKCS11_CKM_AES_CTS, CKFM_CIPHER_WRAP, ANY_PART), 75 MECHANISM(PKCS11_CKM_AES_CTR, CKFM_CIPHER_WRAP, ANY_PART), 76 MECHANISM(PKCS11_CKM_AES_ECB_ENCRYPT_DATA, PKCS11_CKFM_DERIVE, 77 ANY_PART), 78 MECHANISM(PKCS11_CKM_AES_CBC_ENCRYPT_DATA, PKCS11_CKFM_DERIVE, 79 ANY_PART), 80 MECHANISM(PKCS11_CKM_AES_KEY_GEN, PKCS11_CKFM_GENERATE, ANY_PART), 81 MECHANISM(PKCS11_CKM_GENERIC_SECRET_KEY_GEN, PKCS11_CKFM_GENERATE, 82 ANY_PART), 83 /* Digest */ 84 MECHANISM(PKCS11_CKM_MD5, PKCS11_CKFM_DIGEST, ANY_PART), 85 MECHANISM(PKCS11_CKM_SHA_1, PKCS11_CKFM_DIGEST, ANY_PART), 86 MECHANISM(PKCS11_CKM_SHA224, PKCS11_CKFM_DIGEST, ANY_PART), 87 MECHANISM(PKCS11_CKM_SHA256, PKCS11_CKFM_DIGEST, ANY_PART), 88 MECHANISM(PKCS11_CKM_SHA384, PKCS11_CKFM_DIGEST, ANY_PART), 89 MECHANISM(PKCS11_CKM_SHA512, PKCS11_CKFM_DIGEST, ANY_PART), 90 /* HMAC */ 91 MECHANISM(PKCS11_CKM_MD5_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 92 MECHANISM(PKCS11_CKM_SHA_1_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 93 MECHANISM(PKCS11_CKM_SHA224_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 94 MECHANISM(PKCS11_CKM_SHA256_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 95 MECHANISM(PKCS11_CKM_SHA384_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 96 MECHANISM(PKCS11_CKM_SHA512_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 97 /* EC */ 98 MECHANISM(PKCS11_CKM_EC_KEY_PAIR_GEN, PKCS11_CKFM_GENERATE_KEY_PAIR, 99 ANY_PART), 100 }; 101 102 #if CFG_TEE_TA_LOG_LEVEL > 0 103 const char *mechanism_string_id(enum pkcs11_mechanism_id id) 104 { 105 const size_t offset = sizeof("PKCS11_CKM_") - 1; 106 size_t n = 0; 107 108 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 109 if (pkcs11_modes[n].id == id) 110 return pkcs11_modes[n].string + offset; 111 112 return "Unknown ID"; 113 } 114 #endif /*CFG_TEE_TA_LOG_LEVEL*/ 115 116 /* 117 * Return true if @id is a valid mechanism ID 118 */ 119 bool mechanism_is_valid(enum pkcs11_mechanism_id id) 120 { 121 size_t n = 0; 122 123 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 124 if (id == pkcs11_modes[n].id) 125 return true; 126 127 return false; 128 } 129 130 /* 131 * Return true if mechanism ID is valid and flags matches PKCS#11 compliancy 132 */ 133 bool __maybe_unused mechanism_flags_complies_pkcs11(uint32_t mechanism_type, 134 uint32_t flags) 135 { 136 size_t n = 0; 137 138 assert((flags & ~ALLOWED_PKCS11_CKFM) == 0); 139 140 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) { 141 if (pkcs11_modes[n].id == mechanism_type) { 142 if (flags & ~pkcs11_modes[n].flags) 143 EMSG("%s flags: 0x%"PRIx32" vs 0x%"PRIx32, 144 id2str_mechanism(mechanism_type), 145 flags, pkcs11_modes[n].flags); 146 147 return (flags & ~pkcs11_modes[n].flags) == 0; 148 } 149 } 150 151 /* Mechanism ID unexpectedly not found */ 152 return false; 153 } 154 155 bool mechanism_is_one_shot_only(uint32_t mechanism_type) 156 { 157 size_t n = 0; 158 159 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 160 if (pkcs11_modes[n].id == mechanism_type) 161 return pkcs11_modes[n].one_shot; 162 163 /* Mechanism ID unexpectedly not found */ 164 TEE_Panic(PKCS11_RV_NOT_FOUND); 165 /* Dummy return to keep compiler happy */ 166 return false; 167 } 168 169 /* 170 * Field single_part_only is unused from array token_mechanism[], hence 171 * simply use ANY_PART for all mechanism there. 172 */ 173 #define TA_MECHANISM(_label, _flags) MECHANISM((_label), (_flags), ANY_PART) 174 175 /* 176 * Arrays that centralizes the IDs and processing flags for mechanisms 177 * supported by each embedded token. 178 */ 179 const struct pkcs11_mechachism_modes token_mechanism[] = { 180 TA_MECHANISM(PKCS11_CKM_AES_ECB, CKFM_CIPHER), 181 TA_MECHANISM(PKCS11_CKM_AES_CBC, CKFM_CIPHER), 182 TA_MECHANISM(PKCS11_CKM_AES_CBC_PAD, CKFM_CIPHER), 183 TA_MECHANISM(PKCS11_CKM_AES_CTR, CKFM_CIPHER), 184 TA_MECHANISM(PKCS11_CKM_AES_CTS, CKFM_CIPHER), 185 TA_MECHANISM(PKCS11_CKM_AES_ECB_ENCRYPT_DATA, PKCS11_CKFM_DERIVE), 186 TA_MECHANISM(PKCS11_CKM_AES_CBC_ENCRYPT_DATA, PKCS11_CKFM_DERIVE), 187 TA_MECHANISM(PKCS11_CKM_AES_KEY_GEN, PKCS11_CKFM_GENERATE), 188 TA_MECHANISM(PKCS11_CKM_GENERIC_SECRET_KEY_GEN, PKCS11_CKFM_GENERATE), 189 TA_MECHANISM(PKCS11_CKM_MD5, PKCS11_CKFM_DIGEST), 190 TA_MECHANISM(PKCS11_CKM_SHA_1, PKCS11_CKFM_DIGEST), 191 TA_MECHANISM(PKCS11_CKM_SHA224, PKCS11_CKFM_DIGEST), 192 TA_MECHANISM(PKCS11_CKM_SHA256, PKCS11_CKFM_DIGEST), 193 TA_MECHANISM(PKCS11_CKM_SHA384, PKCS11_CKFM_DIGEST), 194 TA_MECHANISM(PKCS11_CKM_SHA512, PKCS11_CKFM_DIGEST), 195 TA_MECHANISM(PKCS11_CKM_MD5_HMAC, CKFM_AUTH_NO_RECOVER), 196 TA_MECHANISM(PKCS11_CKM_SHA_1_HMAC, CKFM_AUTH_NO_RECOVER), 197 TA_MECHANISM(PKCS11_CKM_SHA224_HMAC, CKFM_AUTH_NO_RECOVER), 198 TA_MECHANISM(PKCS11_CKM_SHA256_HMAC, CKFM_AUTH_NO_RECOVER), 199 TA_MECHANISM(PKCS11_CKM_SHA384_HMAC, CKFM_AUTH_NO_RECOVER), 200 TA_MECHANISM(PKCS11_CKM_SHA512_HMAC, CKFM_AUTH_NO_RECOVER), 201 TA_MECHANISM(PKCS11_CKM_EC_KEY_PAIR_GEN, 202 PKCS11_CKFM_GENERATE_KEY_PAIR), 203 }; 204 205 /* 206 * tee_malloc_mechanism_array - Allocate and fill array of supported mechanisms 207 * @count: [in] [out] Pointer to number of mechanism IDs in client resource 208 * Return allocated array of the supported mechanism IDs 209 * 210 * Allocates array with 32bit cells mechanism IDs for the supported ones only 211 * if *@count covers number mechanism IDs exposed. 212 */ 213 uint32_t *tee_malloc_mechanism_list(size_t *out_count) 214 { 215 size_t n = 0; 216 size_t count = 0; 217 uint32_t *array = NULL; 218 219 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) 220 if (token_mechanism[n].flags) 221 count++; 222 223 if (*out_count >= count) 224 array = TEE_Malloc(count * sizeof(*array), 225 TEE_USER_MEM_HINT_NO_FILL_ZERO); 226 227 *out_count = count; 228 229 if (!array) 230 return NULL; 231 232 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) { 233 if (token_mechanism[n].flags) { 234 count--; 235 array[count] = token_mechanism[n].id; 236 } 237 } 238 assert(!count); 239 240 return array; 241 } 242 243 uint32_t mechanism_supported_flags(enum pkcs11_mechanism_id id) 244 { 245 size_t n = 0; 246 247 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) { 248 if (id == token_mechanism[n].id) { 249 uint32_t flags = token_mechanism[n].flags; 250 251 assert(mechanism_flags_complies_pkcs11(id, flags)); 252 return flags; 253 } 254 } 255 256 return 0; 257 } 258 259 void pkcs11_mechanism_supported_key_sizes(uint32_t proc_id, 260 uint32_t *min_key_size, 261 uint32_t *max_key_size) 262 { 263 switch (proc_id) { 264 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 265 /* This mechanism expects the keysize to be returned in bits */ 266 *min_key_size = 1; /* in bits */ 267 *max_key_size = 4096; /* in bits */ 268 break; 269 case PKCS11_CKM_MD5_HMAC: 270 *min_key_size = 8; 271 *max_key_size = 64; 272 break; 273 case PKCS11_CKM_SHA_1_HMAC: 274 *min_key_size = 10; 275 *max_key_size = 64; 276 break; 277 case PKCS11_CKM_SHA224_HMAC: 278 *min_key_size = 14; 279 *max_key_size = 64; 280 break; 281 case PKCS11_CKM_SHA256_HMAC: 282 *min_key_size = 24; 283 *max_key_size = 128; 284 break; 285 case PKCS11_CKM_SHA384_HMAC: 286 *min_key_size = 32; 287 *max_key_size = 128; 288 break; 289 case PKCS11_CKM_SHA512_HMAC: 290 *min_key_size = 32; 291 *max_key_size = 128; 292 break; 293 case PKCS11_CKM_AES_KEY_GEN: 294 case PKCS11_CKM_AES_ECB: 295 case PKCS11_CKM_AES_CBC: 296 case PKCS11_CKM_AES_CBC_PAD: 297 case PKCS11_CKM_AES_CTR: 298 case PKCS11_CKM_AES_CTS: 299 *min_key_size = 16; 300 *max_key_size = 32; 301 break; 302 case PKCS11_CKM_EC_KEY_PAIR_GEN: 303 *min_key_size = 160; /* in bits */ 304 *max_key_size = 521; /* in bits */ 305 break; 306 default: 307 *min_key_size = 0; 308 *max_key_size = 0; 309 break; 310 } 311 } 312 313 void mechanism_supported_key_sizes_bytes(uint32_t proc_id, 314 uint32_t *min_key_size, 315 uint32_t *max_key_size) 316 { 317 pkcs11_mechanism_supported_key_sizes(proc_id, min_key_size, 318 max_key_size); 319 320 if (proc_id == PKCS11_CKM_GENERIC_SECRET_KEY_GEN) { 321 *min_key_size = (*min_key_size + 7) / 8; 322 *max_key_size = (*max_key_size + 7) / 8; 323 } 324 } 325