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 }; 98 99 #if CFG_TEE_TA_LOG_LEVEL > 0 100 const char *mechanism_string_id(enum pkcs11_mechanism_id id) 101 { 102 const size_t offset = sizeof("PKCS11_CKM_") - 1; 103 size_t n = 0; 104 105 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 106 if (pkcs11_modes[n].id == id) 107 return pkcs11_modes[n].string + offset; 108 109 return "Unknown ID"; 110 } 111 #endif /*CFG_TEE_TA_LOG_LEVEL*/ 112 113 /* 114 * Return true if @id is a valid mechanism ID 115 */ 116 bool mechanism_is_valid(enum pkcs11_mechanism_id id) 117 { 118 size_t n = 0; 119 120 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 121 if (id == pkcs11_modes[n].id) 122 return true; 123 124 return false; 125 } 126 127 /* 128 * Return true if mechanism ID is valid and flags matches PKCS#11 compliancy 129 */ 130 bool __maybe_unused mechanism_flags_complies_pkcs11(uint32_t mechanism_type, 131 uint32_t flags) 132 { 133 size_t n = 0; 134 135 assert((flags & ~ALLOWED_PKCS11_CKFM) == 0); 136 137 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) { 138 if (pkcs11_modes[n].id == mechanism_type) { 139 if (flags & ~pkcs11_modes[n].flags) 140 EMSG("%s flags: 0x%"PRIx32" vs 0x%"PRIx32, 141 id2str_mechanism(mechanism_type), 142 flags, pkcs11_modes[n].flags); 143 144 return (flags & ~pkcs11_modes[n].flags) == 0; 145 } 146 } 147 148 /* Mechanism ID unexpectedly not found */ 149 return false; 150 } 151 152 bool mechanism_is_one_shot_only(uint32_t mechanism_type) 153 { 154 size_t n = 0; 155 156 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 157 if (pkcs11_modes[n].id == mechanism_type) 158 return pkcs11_modes[n].one_shot; 159 160 /* Mechanism ID unexpectedly not found */ 161 TEE_Panic(PKCS11_RV_NOT_FOUND); 162 /* Dummy return to keep compiler happy */ 163 return false; 164 } 165 166 /* 167 * Field single_part_only is unused from array token_mechanism[], hence 168 * simply use ANY_PART for all mechanism there. 169 */ 170 #define TA_MECHANISM(_label, _flags) MECHANISM((_label), (_flags), ANY_PART) 171 172 /* 173 * Arrays that centralizes the IDs and processing flags for mechanisms 174 * supported by each embedded token. 175 */ 176 const struct pkcs11_mechachism_modes token_mechanism[] = { 177 TA_MECHANISM(PKCS11_CKM_AES_ECB, CKFM_CIPHER), 178 TA_MECHANISM(PKCS11_CKM_AES_CBC, CKFM_CIPHER), 179 TA_MECHANISM(PKCS11_CKM_AES_CBC_PAD, CKFM_CIPHER), 180 TA_MECHANISM(PKCS11_CKM_AES_CTR, CKFM_CIPHER), 181 TA_MECHANISM(PKCS11_CKM_AES_CTS, CKFM_CIPHER), 182 TA_MECHANISM(PKCS11_CKM_AES_ECB_ENCRYPT_DATA, PKCS11_CKFM_DERIVE), 183 TA_MECHANISM(PKCS11_CKM_AES_CBC_ENCRYPT_DATA, PKCS11_CKFM_DERIVE), 184 TA_MECHANISM(PKCS11_CKM_AES_KEY_GEN, PKCS11_CKFM_GENERATE), 185 TA_MECHANISM(PKCS11_CKM_GENERIC_SECRET_KEY_GEN, PKCS11_CKFM_GENERATE), 186 TA_MECHANISM(PKCS11_CKM_MD5, PKCS11_CKFM_DIGEST), 187 TA_MECHANISM(PKCS11_CKM_SHA_1, PKCS11_CKFM_DIGEST), 188 TA_MECHANISM(PKCS11_CKM_SHA224, PKCS11_CKFM_DIGEST), 189 TA_MECHANISM(PKCS11_CKM_SHA256, PKCS11_CKFM_DIGEST), 190 TA_MECHANISM(PKCS11_CKM_SHA384, PKCS11_CKFM_DIGEST), 191 TA_MECHANISM(PKCS11_CKM_SHA512, PKCS11_CKFM_DIGEST), 192 TA_MECHANISM(PKCS11_CKM_MD5_HMAC, CKFM_AUTH_NO_RECOVER), 193 TA_MECHANISM(PKCS11_CKM_SHA_1_HMAC, CKFM_AUTH_NO_RECOVER), 194 TA_MECHANISM(PKCS11_CKM_SHA224_HMAC, CKFM_AUTH_NO_RECOVER), 195 TA_MECHANISM(PKCS11_CKM_SHA256_HMAC, CKFM_AUTH_NO_RECOVER), 196 TA_MECHANISM(PKCS11_CKM_SHA384_HMAC, CKFM_AUTH_NO_RECOVER), 197 TA_MECHANISM(PKCS11_CKM_SHA512_HMAC, CKFM_AUTH_NO_RECOVER), 198 }; 199 200 /* 201 * tee_malloc_mechanism_array - Allocate and fill array of supported mechanisms 202 * @count: [in] [out] Pointer to number of mechanism IDs in client resource 203 * Return allocated array of the supported mechanism IDs 204 * 205 * Allocates array with 32bit cells mechanism IDs for the supported ones only 206 * if *@count covers number mechanism IDs exposed. 207 */ 208 uint32_t *tee_malloc_mechanism_list(size_t *out_count) 209 { 210 size_t n = 0; 211 size_t count = 0; 212 uint32_t *array = NULL; 213 214 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) 215 if (token_mechanism[n].flags) 216 count++; 217 218 if (*out_count >= count) 219 array = TEE_Malloc(count * sizeof(*array), 220 TEE_USER_MEM_HINT_NO_FILL_ZERO); 221 222 *out_count = count; 223 224 if (!array) 225 return NULL; 226 227 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) { 228 if (token_mechanism[n].flags) { 229 count--; 230 array[count] = token_mechanism[n].id; 231 } 232 } 233 assert(!count); 234 235 return array; 236 } 237 238 uint32_t mechanism_supported_flags(enum pkcs11_mechanism_id id) 239 { 240 size_t n = 0; 241 242 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) { 243 if (id == token_mechanism[n].id) { 244 uint32_t flags = token_mechanism[n].flags; 245 246 assert(mechanism_flags_complies_pkcs11(id, flags)); 247 return flags; 248 } 249 } 250 251 return 0; 252 } 253 254 void pkcs11_mechanism_supported_key_sizes(uint32_t proc_id, 255 uint32_t *min_key_size, 256 uint32_t *max_key_size) 257 { 258 switch (proc_id) { 259 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 260 /* This mechanism expects the keysize to be returned in bits */ 261 *min_key_size = 1; /* in bits */ 262 *max_key_size = 4096; /* in bits */ 263 break; 264 case PKCS11_CKM_MD5_HMAC: 265 *min_key_size = 8; 266 *max_key_size = 64; 267 break; 268 case PKCS11_CKM_SHA_1_HMAC: 269 *min_key_size = 10; 270 *max_key_size = 64; 271 break; 272 case PKCS11_CKM_SHA224_HMAC: 273 *min_key_size = 14; 274 *max_key_size = 64; 275 break; 276 case PKCS11_CKM_SHA256_HMAC: 277 *min_key_size = 24; 278 *max_key_size = 128; 279 break; 280 case PKCS11_CKM_SHA384_HMAC: 281 *min_key_size = 32; 282 *max_key_size = 128; 283 break; 284 case PKCS11_CKM_SHA512_HMAC: 285 *min_key_size = 32; 286 *max_key_size = 128; 287 break; 288 case PKCS11_CKM_AES_KEY_GEN: 289 case PKCS11_CKM_AES_ECB: 290 case PKCS11_CKM_AES_CBC: 291 case PKCS11_CKM_AES_CBC_PAD: 292 case PKCS11_CKM_AES_CTR: 293 case PKCS11_CKM_AES_CTS: 294 *min_key_size = 16; 295 *max_key_size = 32; 296 break; 297 default: 298 *min_key_size = 0; 299 *max_key_size = 0; 300 break; 301 } 302 } 303 304 void mechanism_supported_key_sizes_bytes(uint32_t proc_id, 305 uint32_t *min_key_size, 306 uint32_t *max_key_size) 307 { 308 pkcs11_mechanism_supported_key_sizes(proc_id, min_key_size, 309 max_key_size); 310 311 if (proc_id == PKCS11_CKM_GENERIC_SECRET_KEY_GEN) { 312 *min_key_size = (*min_key_size + 7) / 8; 313 *max_key_size = (*max_key_size + 7) / 8; 314 } 315 } 316