xref: /optee_os/ta/pkcs11/src/pkcs11_attributes.c (revision 70c78a55b8a5a4ffe5310e322bbdadfd11d7e641)
1 // SPDX-License-Identifier: BSD-2-Clause
2 /*
3  * Copyright (c) 2017-2020, Linaro Limited
4  */
5 
6 #include <assert.h>
7 #include <inttypes.h>
8 #include <pkcs11_ta.h>
9 #include <stdlib.h>
10 #include <string_ext.h>
11 #include <tee_internal_api_extensions.h>
12 #include <tee_internal_api.h>
13 #include <trace.h>
14 #include <util.h>
15 
16 #include "attributes.h"
17 #include "handle.h"
18 #include "pkcs11_attributes.h"
19 #include "pkcs11_helpers.h"
20 #include "pkcs11_token.h"
21 #include "sanitize_object.h"
22 #include "serializer.h"
23 #include "token_capabilities.h"
24 
25 /* Byte size of CKA_ID attribute when generated locally */
26 #define PKCS11_CKA_DEFAULT_SIZE		16
27 
28 static uint32_t pkcs11_func2ckfm(enum processing_func function)
29 {
30 	switch (function) {
31 	case PKCS11_FUNCTION_DIGEST:
32 		return PKCS11_CKFM_DIGEST;
33 	case PKCS11_FUNCTION_GENERATE:
34 		return PKCS11_CKFM_GENERATE;
35 	case PKCS11_FUNCTION_GENERATE_PAIR:
36 		return PKCS11_CKFM_GENERATE_KEY_PAIR;
37 	case PKCS11_FUNCTION_DERIVE:
38 		return PKCS11_CKFM_DERIVE;
39 	case PKCS11_FUNCTION_WRAP:
40 		return PKCS11_CKFM_WRAP;
41 	case PKCS11_FUNCTION_UNWRAP:
42 		return PKCS11_CKFM_UNWRAP;
43 	case PKCS11_FUNCTION_ENCRYPT:
44 		return PKCS11_CKFM_ENCRYPT;
45 	case PKCS11_FUNCTION_DECRYPT:
46 		return PKCS11_CKFM_DECRYPT;
47 	case PKCS11_FUNCTION_SIGN:
48 		return PKCS11_CKFM_SIGN;
49 	case PKCS11_FUNCTION_VERIFY:
50 		return PKCS11_CKFM_VERIFY;
51 	case PKCS11_FUNCTION_SIGN_RECOVER:
52 		return PKCS11_CKFM_SIGN_RECOVER;
53 	case PKCS11_FUNCTION_VERIFY_RECOVER:
54 		return PKCS11_CKFM_VERIFY_RECOVER;
55 	default:
56 		return 0;
57 	}
58 }
59 
60 enum pkcs11_rc
61 check_mechanism_against_processing(struct pkcs11_session *session,
62 				   enum pkcs11_mechanism_id mechanism_type,
63 				   enum processing_func function,
64 				   enum processing_step step)
65 {
66 	bool allowed = false;
67 
68 	switch (step) {
69 	case PKCS11_FUNC_STEP_INIT:
70 		switch (function) {
71 		case PKCS11_FUNCTION_IMPORT:
72 		case PKCS11_FUNCTION_COPY:
73 		case PKCS11_FUNCTION_MODIFY:
74 		case PKCS11_FUNCTION_DESTROY:
75 			return PKCS11_CKR_OK;
76 		default:
77 			break;
78 		}
79 		/*
80 		 * Check that the returned PKCS11_CKFM_* flag from
81 		 * pkcs11_func2ckfm() is among the ones from
82 		 * mechanism_supported_flags().
83 		 */
84 		allowed = mechanism_supported_flags(mechanism_type) &
85 			  pkcs11_func2ckfm(function);
86 		break;
87 
88 	case PKCS11_FUNC_STEP_ONESHOT:
89 		if (session->processing->always_authen &&
90 		    !session->processing->relogged)
91 			return PKCS11_CKR_USER_NOT_LOGGED_IN;
92 
93 		if (session->processing->updated) {
94 			EMSG("Cannot perform one-shot on updated processing");
95 			return PKCS11_CKR_OPERATION_ACTIVE;
96 		}
97 
98 		allowed = true;
99 		break;
100 
101 	case PKCS11_FUNC_STEP_UPDATE:
102 		if (session->processing->always_authen &&
103 		    !session->processing->relogged)
104 			return PKCS11_CKR_USER_NOT_LOGGED_IN;
105 
106 		allowed = !mechanism_is_one_shot_only(mechanism_type);
107 		break;
108 
109 	case PKCS11_FUNC_STEP_FINAL:
110 		if (session->processing->always_authen &&
111 		    !session->processing->relogged)
112 			return PKCS11_CKR_USER_NOT_LOGGED_IN;
113 
114 		return PKCS11_CKR_OK;
115 
116 	default:
117 		TEE_Panic(step);
118 		break;
119 	}
120 
121 	if (!allowed) {
122 		EMSG("Processing %#x/%s not permitted (%u/%u)",
123 		     (unsigned int)mechanism_type, id2str_proc(mechanism_type),
124 		     function, step);
125 		return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
126 	}
127 
128 	return PKCS11_CKR_OK;
129 }
130 
131 /*
132  * Object default boolean attributes as per PKCS#11
133  */
134 static uint8_t *pkcs11_object_default_boolprop(uint32_t attribute)
135 {
136 	static const uint8_t bool_true = 1;
137 	static const uint8_t bool_false;
138 
139 	switch (attribute) {
140 	/* As per PKCS#11 default value */
141 	case PKCS11_CKA_MODIFIABLE:
142 	case PKCS11_CKA_COPYABLE:
143 	case PKCS11_CKA_DESTROYABLE:
144 		return (uint8_t *)&bool_true;
145 	case PKCS11_CKA_TOKEN:
146 	case PKCS11_CKA_PRIVATE:
147 	case PKCS11_CKA_WRAP_WITH_TRUSTED:
148 	case PKCS11_CKA_ALWAYS_AUTHENTICATE:
149 	case PKCS11_CKA_SENSITIVE:
150 		return (uint8_t *)&bool_false;
151 	/* Token specific default value */
152 	case PKCS11_CKA_SIGN:
153 	case PKCS11_CKA_VERIFY:
154 	case PKCS11_CKA_DERIVE:
155 	case PKCS11_CKA_ENCRYPT:
156 	case PKCS11_CKA_DECRYPT:
157 	case PKCS11_CKA_SIGN_RECOVER:
158 	case PKCS11_CKA_VERIFY_RECOVER:
159 	case PKCS11_CKA_WRAP:
160 	case PKCS11_CKA_UNWRAP:
161 	case PKCS11_CKA_EXTRACTABLE:
162 	case PKCS11_CKA_TRUSTED:
163 		return (uint8_t *)&bool_false;
164 	default:
165 		DMSG("No default for boolprop attribute %#"PRIx32, attribute);
166 		return NULL;
167 	}
168 }
169 
170 /*
171  * Object expects several boolean attributes to be set to a default value
172  * or to a validate client configuration value. This function append the input
173  * attribute (id/size/value) in the serialized object.
174  */
175 static enum pkcs11_rc pkcs11_import_object_boolprop(struct obj_attrs **out,
176 						    struct obj_attrs *templ,
177 						    uint32_t attribute)
178 {
179 	enum pkcs11_rc rc = PKCS11_CKR_OK;
180 	uint8_t bbool = 0;
181 	uint32_t size = sizeof(uint8_t);
182 	void *attr = NULL;
183 
184 	rc = get_attribute(templ, attribute, &bbool, &size);
185 	if (rc) {
186 		if (rc != PKCS11_RV_NOT_FOUND)
187 			return rc;
188 		attr = pkcs11_object_default_boolprop(attribute);
189 		if (!attr)
190 			return PKCS11_CKR_TEMPLATE_INCOMPLETE;
191 	} else {
192 		attr = &bbool;
193 	}
194 
195 	/* Boolean attributes are 1byte in the ABI, no alignment issue */
196 	return add_attribute(out, attribute, attr, sizeof(uint8_t));
197 }
198 
199 static enum pkcs11_rc set_mandatory_boolprops(struct obj_attrs **out,
200 					      struct obj_attrs *temp,
201 					      uint32_t const *bp,
202 					      size_t bp_count)
203 {
204 	enum pkcs11_rc rc = PKCS11_CKR_OK;
205 	size_t n = 0;
206 
207 	for (n = 0; n < bp_count; n++) {
208 		rc = pkcs11_import_object_boolprop(out, temp, bp[n]);
209 		if (rc)
210 			return rc;
211 	}
212 
213 	return rc;
214 }
215 
216 static enum pkcs11_rc set_mandatory_attributes(struct obj_attrs **out,
217 					       struct obj_attrs *temp,
218 					       uint32_t const *attrs,
219 					       size_t attrs_count)
220 {
221 	enum pkcs11_rc rc = PKCS11_CKR_OK;
222 	size_t n = 0;
223 
224 	for (n = 0; n < attrs_count; n++) {
225 		uint32_t size = 0;
226 		void *value = NULL;
227 
228 		if (get_attribute_ptr(temp, attrs[n], &value, &size))
229 			return PKCS11_CKR_TEMPLATE_INCOMPLETE;
230 
231 		rc = add_attribute(out, attrs[n], value, size);
232 		if (rc)
233 			return rc;
234 	}
235 
236 	return rc;
237 }
238 
239 static enum pkcs11_rc get_default_value(enum pkcs11_attr_id id, void **value,
240 					uint32_t *size)
241 {
242 	/* should have been taken care of already */
243 	assert(!pkcs11_attr_is_boolean(id));
244 
245 	if (id == PKCS11_CKA_PUBLIC_KEY_INFO) {
246 		EMSG("Cannot provide default PUBLIC_KEY_INFO");
247 		return PKCS11_CKR_TEMPLATE_INCONSISTENT;
248 	}
249 
250 	/* All other attributes have an empty default value */
251 	*value = NULL;
252 	*size = 0;
253 	return PKCS11_CKR_OK;
254 }
255 
256 static enum pkcs11_rc set_optional_attributes_with_def(struct obj_attrs **out,
257 						       struct obj_attrs *temp,
258 						       uint32_t const *attrs,
259 						       size_t attrs_count,
260 						       bool default_to_null)
261 {
262 	enum pkcs11_rc rc = PKCS11_CKR_OK;
263 	size_t n = 0;
264 
265 	for (n = 0; n < attrs_count; n++) {
266 		uint32_t size = 0;
267 		void *value = NULL;
268 
269 		rc = get_attribute_ptr(temp, attrs[n], &value, &size);
270 		if (rc == PKCS11_RV_NOT_FOUND) {
271 			if (default_to_null) {
272 				rc = get_default_value(attrs[n], &value, &size);
273 			} else {
274 				rc = PKCS11_CKR_OK;
275 				continue;
276 			}
277 		}
278 		if (rc)
279 			return rc;
280 
281 		rc = add_attribute(out, attrs[n], value, size);
282 		if (rc)
283 			return rc;
284 	}
285 
286 	return rc;
287 }
288 
289 static enum pkcs11_rc set_attributes_opt_or_null(struct obj_attrs **out,
290 						 struct obj_attrs *temp,
291 						 uint32_t const *attrs,
292 						 size_t attrs_count)
293 {
294 	return set_optional_attributes_with_def(out, temp, attrs, attrs_count,
295 						true /* defaults to empty */);
296 }
297 
298 static enum pkcs11_rc set_optional_attributes(struct obj_attrs **out,
299 					      struct obj_attrs *temp,
300 					      uint32_t const *attrs,
301 					      size_t attrs_count)
302 {
303 	return set_optional_attributes_with_def(out, temp, attrs, attrs_count,
304 						false /* no default value */);
305 }
306 
307 /*
308  * Below are listed the mandated or optional expected attributes for
309  * PKCS#11 storage objects.
310  *
311  * Note: boolprops (mandated boolean attributes) PKCS11_CKA_ALWAYS_SENSITIVE,
312  * and PKCS11_CKA_NEVER_EXTRACTABLE are set by the token, not provided
313  * in the client template.
314  */
315 
316 /* PKCS#11 specification for any object (session/token) of the storage */
317 static const uint32_t any_object_boolprops[] = {
318 	PKCS11_CKA_TOKEN, PKCS11_CKA_PRIVATE,
319 	PKCS11_CKA_MODIFIABLE, PKCS11_CKA_COPYABLE, PKCS11_CKA_DESTROYABLE,
320 };
321 
322 static const uint32_t any_object_opt_or_null[] = {
323 	PKCS11_CKA_LABEL,
324 };
325 
326 /* PKCS#11 specification for raw data object (+any_object_xxx) */
327 const uint32_t raw_data_opt_or_null[] = {
328 	PKCS11_CKA_OBJECT_ID, PKCS11_CKA_APPLICATION, PKCS11_CKA_VALUE,
329 };
330 
331 /* PKCS#11 specification for any key object (+any_object_xxx) */
332 static const uint32_t any_key_boolprops[] = {
333 	PKCS11_CKA_DERIVE,
334 };
335 
336 static const uint32_t any_key_opt_or_null[] = {
337 	PKCS11_CKA_ID,
338 	PKCS11_CKA_START_DATE, PKCS11_CKA_END_DATE,
339 };
340 
341 static const uint32_t any_key_optional[] = {
342 	PKCS11_CKA_ALLOWED_MECHANISMS,
343 };
344 
345 /* PKCS#11 specification for any symmetric key (+any_key_xxx) */
346 static const uint32_t symm_key_boolprops[] = {
347 	PKCS11_CKA_ENCRYPT, PKCS11_CKA_DECRYPT,
348 	PKCS11_CKA_SIGN, PKCS11_CKA_VERIFY,
349 	PKCS11_CKA_WRAP, PKCS11_CKA_UNWRAP,
350 	PKCS11_CKA_SENSITIVE, PKCS11_CKA_EXTRACTABLE,
351 	PKCS11_CKA_WRAP_WITH_TRUSTED, PKCS11_CKA_TRUSTED,
352 };
353 
354 static const uint32_t symm_key_opt_or_null[] = {
355 	PKCS11_CKA_WRAP_TEMPLATE, PKCS11_CKA_UNWRAP_TEMPLATE,
356 	PKCS11_CKA_DERIVE_TEMPLATE,
357 	PKCS11_CKA_VALUE, PKCS11_CKA_VALUE_LEN,
358 };
359 
360 /* PKCS#11 specification for any asymmetric public key (+any_key_xxx) */
361 static const uint32_t public_key_boolprops[] = {
362 	PKCS11_CKA_ENCRYPT, PKCS11_CKA_VERIFY, PKCS11_CKA_VERIFY_RECOVER,
363 	PKCS11_CKA_WRAP,
364 	PKCS11_CKA_TRUSTED,
365 };
366 
367 static const uint32_t public_key_mandated[] = {
368 	PKCS11_CKA_SUBJECT
369 };
370 
371 static const uint32_t public_key_opt_or_null[] = {
372 	PKCS11_CKA_WRAP_TEMPLATE, PKCS11_CKA_PUBLIC_KEY_INFO,
373 };
374 
375 /* PKCS#11 specification for any asymmetric private key (+any_key_xxx) */
376 static const uint32_t private_key_boolprops[] = {
377 	PKCS11_CKA_DECRYPT, PKCS11_CKA_SIGN, PKCS11_CKA_SIGN_RECOVER,
378 	PKCS11_CKA_UNWRAP,
379 	PKCS11_CKA_SENSITIVE, PKCS11_CKA_EXTRACTABLE,
380 	PKCS11_CKA_WRAP_WITH_TRUSTED, PKCS11_CKA_ALWAYS_AUTHENTICATE,
381 };
382 
383 static const uint32_t private_key_mandated[] = {
384 	PKCS11_CKA_SUBJECT
385 };
386 
387 static const uint32_t private_key_opt_or_null[] = {
388 	PKCS11_CKA_UNWRAP_TEMPLATE, PKCS11_CKA_PUBLIC_KEY_INFO,
389 };
390 
391 /* PKCS#11 specification for any RSA key (+public/private_key_xxx) */
392 static const uint32_t rsa_public_key_mandated[] = {
393 	PKCS11_CKA_MODULUS_BITS,
394 };
395 
396 static const uint32_t rsa_public_key_opt_or_null[] = {
397 	PKCS11_CKA_MODULUS, PKCS11_CKA_PUBLIC_EXPONENT,
398 };
399 
400 static const uint32_t rsa_private_key_opt_or_null[] = {
401 	PKCS11_CKA_MODULUS, PKCS11_CKA_PUBLIC_EXPONENT,
402 	PKCS11_CKA_PRIVATE_EXPONENT,
403 	PKCS11_CKA_PRIME_1, PKCS11_CKA_PRIME_2,
404 	PKCS11_CKA_EXPONENT_1, PKCS11_CKA_EXPONENT_2, PKCS11_CKA_COEFFICIENT,
405 };
406 
407 /* PKCS#11 specification for any EC key (+public/private_key_xxx) */
408 static const uint32_t ec_public_key_mandated[] = {
409 	PKCS11_CKA_EC_PARAMS,
410 };
411 
412 static const uint32_t ec_public_key_opt_or_null[] = {
413 	PKCS11_CKA_EC_POINT,
414 };
415 
416 static const uint32_t ec_private_key_mandated[] = {
417 	PKCS11_CKA_EC_PARAMS,
418 };
419 
420 static const uint32_t ec_private_key_opt_or_null[] = {
421 	PKCS11_CKA_VALUE,
422 };
423 
424 static enum pkcs11_rc create_storage_attributes(struct obj_attrs **out,
425 						struct obj_attrs *temp)
426 {
427 	enum pkcs11_class_id class = PKCS11_CKO_UNDEFINED_ID;
428 	enum pkcs11_rc rc = PKCS11_CKR_OK;
429 
430 	rc = init_attributes_head(out);
431 	if (rc)
432 		return rc;
433 
434 	/* Object class is mandatory */
435 	class = get_class(temp);
436 	if (class == PKCS11_CKO_UNDEFINED_ID) {
437 		EMSG("Class attribute not found");
438 
439 		return PKCS11_CKR_TEMPLATE_INCONSISTENT;
440 	}
441 	rc = add_attribute(out, PKCS11_CKA_CLASS, &class, sizeof(uint32_t));
442 	if (rc)
443 		return rc;
444 
445 	rc = set_mandatory_boolprops(out, temp, any_object_boolprops,
446 				     ARRAY_SIZE(any_object_boolprops));
447 	if (rc)
448 		return rc;
449 
450 	return set_attributes_opt_or_null(out, temp, any_object_opt_or_null,
451 					  ARRAY_SIZE(any_object_opt_or_null));
452 }
453 
454 static enum pkcs11_rc create_genkey_attributes(struct obj_attrs **out,
455 					       struct obj_attrs *temp)
456 {
457 	uint32_t type = PKCS11_CKO_UNDEFINED_ID;
458 	enum pkcs11_rc rc = PKCS11_CKR_OK;
459 
460 	rc = create_storage_attributes(out, temp);
461 	if (rc)
462 		return rc;
463 
464 	type = get_key_type(temp);
465 	if (type == PKCS11_CKK_UNDEFINED_ID) {
466 		EMSG("Key type attribute not found");
467 
468 		return PKCS11_CKR_TEMPLATE_INCONSISTENT;
469 	}
470 	rc = add_attribute(out, PKCS11_CKA_KEY_TYPE, &type, sizeof(uint32_t));
471 	if (rc)
472 		return rc;
473 
474 	rc = set_mandatory_boolprops(out, temp, any_key_boolprops,
475 				     ARRAY_SIZE(any_key_boolprops));
476 	if (rc)
477 		return rc;
478 
479 	rc = set_attributes_opt_or_null(out, temp, any_key_opt_or_null,
480 					ARRAY_SIZE(any_key_opt_or_null));
481 	if (rc)
482 		return rc;
483 
484 	return set_optional_attributes(out, temp, any_key_optional,
485 				       ARRAY_SIZE(any_key_optional));
486 
487 }
488 
489 static enum pkcs11_rc create_symm_key_attributes(struct obj_attrs **out,
490 						 struct obj_attrs *temp)
491 {
492 	enum pkcs11_rc rc = PKCS11_CKR_OK;
493 
494 	assert(get_class(temp) == PKCS11_CKO_SECRET_KEY);
495 
496 	rc = create_genkey_attributes(out, temp);
497 	if (rc)
498 		return rc;
499 
500 	assert(get_class(*out) == PKCS11_CKO_SECRET_KEY);
501 
502 	switch (get_key_type(*out)) {
503 	case PKCS11_CKK_GENERIC_SECRET:
504 	case PKCS11_CKK_AES:
505 	case PKCS11_CKK_MD5_HMAC:
506 	case PKCS11_CKK_SHA_1_HMAC:
507 	case PKCS11_CKK_SHA256_HMAC:
508 	case PKCS11_CKK_SHA384_HMAC:
509 	case PKCS11_CKK_SHA512_HMAC:
510 	case PKCS11_CKK_SHA224_HMAC:
511 		break;
512 	default:
513 		EMSG("Invalid key type %#"PRIx32"/%s",
514 		     get_key_type(*out), id2str_key_type(get_key_type(*out)));
515 
516 		return PKCS11_CKR_TEMPLATE_INCONSISTENT;
517 	}
518 
519 	rc = set_mandatory_boolprops(out, temp, symm_key_boolprops,
520 				     ARRAY_SIZE(symm_key_boolprops));
521 	if (rc)
522 		return rc;
523 
524 	return set_attributes_opt_or_null(out, temp, symm_key_opt_or_null,
525 					  ARRAY_SIZE(symm_key_opt_or_null));
526 }
527 
528 static enum pkcs11_rc create_data_attributes(struct obj_attrs **out,
529 					     struct obj_attrs *temp)
530 {
531 	enum pkcs11_rc rc = PKCS11_CKR_OK;
532 
533 	assert(get_class(temp) == PKCS11_CKO_DATA);
534 
535 	rc = create_storage_attributes(out, temp);
536 	if (rc)
537 		return rc;
538 
539 	assert(get_class(*out) == PKCS11_CKO_DATA);
540 
541 	return set_attributes_opt_or_null(out, temp, raw_data_opt_or_null,
542 					  ARRAY_SIZE(raw_data_opt_or_null));
543 }
544 
545 static enum pkcs11_rc create_pub_key_attributes(struct obj_attrs **out,
546 						struct obj_attrs *temp)
547 {
548 	uint32_t const *mandated = NULL;
549 	uint32_t const *opt_or_null = NULL;
550 	size_t mandated_count = 0;
551 	size_t opt_or_null_count = 0;
552 	enum pkcs11_rc rc = PKCS11_CKR_OK;
553 
554 	assert(get_class(temp) == PKCS11_CKO_PUBLIC_KEY);
555 
556 	rc = create_genkey_attributes(out, temp);
557 	if (rc)
558 		return rc;
559 
560 	assert(get_class(*out) == PKCS11_CKO_PUBLIC_KEY);
561 
562 	rc = set_mandatory_boolprops(out, temp, public_key_boolprops,
563 				     ARRAY_SIZE(public_key_boolprops));
564 	if (rc)
565 		return rc;
566 
567 	rc = set_mandatory_attributes(out, temp, public_key_mandated,
568 				      ARRAY_SIZE(public_key_mandated));
569 	if (rc)
570 		return rc;
571 
572 	rc = set_attributes_opt_or_null(out, temp,
573 					public_key_opt_or_null,
574 					ARRAY_SIZE(public_key_opt_or_null));
575 	if (rc)
576 		return rc;
577 
578 	switch (get_key_type(*out)) {
579 	case PKCS11_CKK_RSA:
580 		mandated = rsa_public_key_mandated;
581 		opt_or_null = rsa_public_key_opt_or_null;
582 		mandated_count = ARRAY_SIZE(rsa_public_key_mandated);
583 		opt_or_null_count = ARRAY_SIZE(rsa_public_key_opt_or_null);
584 		break;
585 	case PKCS11_CKK_EC:
586 		mandated = ec_public_key_mandated;
587 		opt_or_null = ec_public_key_opt_or_null;
588 		mandated_count = ARRAY_SIZE(ec_public_key_mandated);
589 		opt_or_null_count = ARRAY_SIZE(ec_public_key_opt_or_null);
590 		break;
591 	default:
592 		EMSG("Invalid key type %#"PRIx32"/%s",
593 		     get_key_type(*out), id2str_key_type(get_key_type(*out)));
594 
595 		return PKCS11_CKR_TEMPLATE_INCONSISTENT;
596 	}
597 
598 	rc = set_mandatory_attributes(out, temp, mandated, mandated_count);
599 	if (rc)
600 		return rc;
601 
602 	return set_attributes_opt_or_null(out, temp, opt_or_null,
603 					  opt_or_null_count);
604 }
605 
606 static enum pkcs11_rc create_priv_key_attributes(struct obj_attrs **out,
607 						 struct obj_attrs *temp)
608 {
609 	uint32_t const *mandated = NULL;
610 	uint32_t const *opt_or_null = NULL;
611 	size_t mandated_count = 0;
612 	size_t opt_or_null_count = 0;
613 	enum pkcs11_rc rc = PKCS11_CKR_OK;
614 
615 	assert(get_class(temp) == PKCS11_CKO_PRIVATE_KEY);
616 
617 	rc = create_genkey_attributes(out, temp);
618 	if (rc)
619 		return rc;
620 
621 	assert(get_class(*out) == PKCS11_CKO_PRIVATE_KEY);
622 
623 	rc = set_mandatory_boolprops(out, temp, private_key_boolprops,
624 				     ARRAY_SIZE(private_key_boolprops));
625 	if (rc)
626 		return rc;
627 
628 	rc = set_mandatory_attributes(out, temp, private_key_mandated,
629 				      ARRAY_SIZE(private_key_mandated));
630 	if (rc)
631 		return rc;
632 
633 	rc = set_attributes_opt_or_null(out, temp, private_key_opt_or_null,
634 					ARRAY_SIZE(private_key_opt_or_null));
635 	if (rc)
636 		return rc;
637 
638 	switch (get_key_type(*out)) {
639 	case PKCS11_CKK_RSA:
640 		opt_or_null = rsa_private_key_opt_or_null;
641 		opt_or_null_count = ARRAY_SIZE(rsa_private_key_opt_or_null);
642 		break;
643 	case PKCS11_CKK_EC:
644 		mandated = ec_private_key_mandated;
645 		opt_or_null = ec_private_key_opt_or_null;
646 		mandated_count = ARRAY_SIZE(ec_private_key_mandated);
647 		opt_or_null_count = ARRAY_SIZE(ec_private_key_opt_or_null);
648 		break;
649 	default:
650 		EMSG("Invalid key type %#"PRIx32"/%s",
651 		     get_key_type(*out), id2str_key_type(get_key_type(*out)));
652 
653 		return PKCS11_CKR_TEMPLATE_INCONSISTENT;
654 	}
655 
656 	rc = set_mandatory_attributes(out, temp, mandated, mandated_count);
657 	if (rc)
658 		return rc;
659 
660 	return set_attributes_opt_or_null(out, temp, opt_or_null,
661 					  opt_or_null_count);
662 }
663 
664 /*
665  * Create an attribute list for a new object from a template and a parent
666  * object (optional) for an object generation function (generate, copy,
667  * derive...).
668  *
669  * PKCS#11 directives on the supplied template and expected return value:
670  * - template has an invalid attribute ID: ATTRIBUTE_TYPE_INVALID
671  * - template has an invalid value for an attribute: ATTRIBUTE_VALID_INVALID
672  * - template has value for a read-only attribute: ATTRIBUTE_READ_ONLY
673  * - template+default+parent => still miss an attribute: TEMPLATE_INCONSISTENT
674  *
675  * INFO on PKCS11_CMD_COPY_OBJECT:
676  * - parent PKCS11_CKA_COPYIABLE=false => return ACTION_PROHIBITED.
677  * - template can specify PKCS11_CKA_TOKEN, PKCS11_CKA_PRIVATE,
678  *   PKCS11_CKA_MODIFIABLE, PKCS11_CKA_DESTROYABLE.
679  * - SENSITIVE can change from false to true, not from true to false.
680  * - LOCAL is the parent LOCAL
681  */
682 enum pkcs11_rc
683 create_attributes_from_template(struct obj_attrs **out, void *template,
684 				size_t template_size,
685 				struct obj_attrs *parent __unused,
686 				enum processing_func function,
687 				enum pkcs11_mechanism_id mecha)
688 {
689 	struct obj_attrs *temp = NULL;
690 	struct obj_attrs *attrs = NULL;
691 	enum pkcs11_rc rc = PKCS11_CKR_OK;
692 	uint8_t local = 0;
693 	uint8_t always_sensitive = 0;
694 	uint8_t never_extract = 0;
695 	uint32_t class = PKCS11_UNDEFINED_ID;
696 	uint32_t type = PKCS11_UNDEFINED_ID;
697 	uint32_t mechanism_id = PKCS11_CKM_UNDEFINED_ID;
698 
699 #ifdef DEBUG	/* Sanity: check function argument */
700 	trace_attributes_from_api_head("template", template, template_size);
701 	switch (function) {
702 	case PKCS11_FUNCTION_GENERATE:
703 	case PKCS11_FUNCTION_IMPORT:
704 		break;
705 	default:
706 		TEE_Panic(TEE_ERROR_NOT_SUPPORTED);
707 	}
708 #endif
709 
710 	rc = sanitize_client_object(&temp, template, template_size);
711 	if (rc)
712 		goto out;
713 
714 	/* If class/type not defined, match from mechanism */
715 	if (get_class(temp) == PKCS11_UNDEFINED_ID &&
716 	    get_key_type(temp) == PKCS11_UNDEFINED_ID) {
717 		switch (mecha) {
718 		case PKCS11_CKM_GENERIC_SECRET_KEY_GEN:
719 			class = PKCS11_CKO_SECRET_KEY;
720 			type = PKCS11_CKK_GENERIC_SECRET;
721 			break;
722 		case PKCS11_CKM_AES_KEY_GEN:
723 			class = PKCS11_CKO_SECRET_KEY;
724 			type = PKCS11_CKK_AES;
725 			break;
726 		default:
727 			EMSG("Unable to define class/type from mechanism");
728 			rc = PKCS11_CKR_TEMPLATE_INCOMPLETE;
729 			goto out;
730 		}
731 		if (class != PKCS11_UNDEFINED_ID) {
732 			rc = add_attribute(&temp, PKCS11_CKA_CLASS,
733 					   &class, sizeof(uint32_t));
734 			if (rc)
735 				goto out;
736 		}
737 		if (type != PKCS11_UNDEFINED_ID) {
738 			rc = add_attribute(&temp, PKCS11_CKA_KEY_TYPE,
739 					   &type, sizeof(uint32_t));
740 			if (rc)
741 				goto out;
742 		}
743 	}
744 
745 	switch (mecha) {
746 	case PKCS11_CKM_GENERIC_SECRET_KEY_GEN:
747 		if (get_class(temp) != PKCS11_CKO_SECRET_KEY ||
748 		    get_key_type(temp) != PKCS11_CKK_GENERIC_SECRET) {
749 			rc = PKCS11_CKR_TEMPLATE_INCONSISTENT;
750 			goto out;
751 		}
752 		break;
753 	case PKCS11_CKM_AES_KEY_GEN:
754 		if (get_class(temp) != PKCS11_CKO_SECRET_KEY ||
755 		    get_key_type(temp) != PKCS11_CKK_AES) {
756 			rc = PKCS11_CKR_TEMPLATE_INCONSISTENT;
757 			goto out;
758 		}
759 		break;
760 	default:
761 		break;
762 	}
763 
764 	if (!sanitize_consistent_class_and_type(temp)) {
765 		EMSG("Inconsistent class/type");
766 		rc = PKCS11_CKR_TEMPLATE_INCONSISTENT;
767 		goto out;
768 	}
769 
770 	switch (get_class(temp)) {
771 	case PKCS11_CKO_DATA:
772 		rc = create_data_attributes(&attrs, temp);
773 		break;
774 	case PKCS11_CKO_SECRET_KEY:
775 		rc = create_symm_key_attributes(&attrs, temp);
776 		break;
777 	case PKCS11_CKO_PUBLIC_KEY:
778 		rc = create_pub_key_attributes(&attrs, temp);
779 		break;
780 	case PKCS11_CKO_PRIVATE_KEY:
781 		rc = create_priv_key_attributes(&attrs, temp);
782 		break;
783 	default:
784 		DMSG("Invalid object class %#"PRIx32"/%s",
785 		     get_class(temp), id2str_class(get_class(temp)));
786 
787 		rc = PKCS11_CKR_TEMPLATE_INCONSISTENT;
788 		break;
789 	}
790 	if (rc)
791 		goto out;
792 
793 	if (get_attribute(temp, PKCS11_CKA_LOCAL, NULL, NULL) !=
794 	    PKCS11_RV_NOT_FOUND) {
795 		rc = PKCS11_CKR_TEMPLATE_INCONSISTENT;
796 		goto out;
797 	}
798 
799 	if (get_attribute(temp, PKCS11_CKA_KEY_GEN_MECHANISM, NULL, NULL) !=
800 	    PKCS11_RV_NOT_FOUND) {
801 		rc = PKCS11_CKR_TEMPLATE_INCONSISTENT;
802 		goto out;
803 	}
804 
805 	switch (function) {
806 	case PKCS11_FUNCTION_GENERATE:
807 		local = PKCS11_TRUE;
808 		break;
809 	case PKCS11_FUNCTION_IMPORT:
810 	default:
811 		local = PKCS11_FALSE;
812 		break;
813 	}
814 	rc = add_attribute(&attrs, PKCS11_CKA_LOCAL, &local, sizeof(local));
815 	if (rc)
816 		goto out;
817 
818 	switch (get_class(attrs)) {
819 	case PKCS11_CKO_SECRET_KEY:
820 	case PKCS11_CKO_PRIVATE_KEY:
821 	case PKCS11_CKO_PUBLIC_KEY:
822 		always_sensitive = PKCS11_FALSE;
823 		never_extract = PKCS11_FALSE;
824 
825 		switch (function) {
826 		case PKCS11_FUNCTION_GENERATE:
827 			always_sensitive = get_bool(attrs,
828 						    PKCS11_CKA_SENSITIVE);
829 			never_extract = !get_bool(attrs,
830 						  PKCS11_CKA_EXTRACTABLE);
831 			break;
832 		default:
833 			break;
834 		}
835 
836 		rc = add_attribute(&attrs, PKCS11_CKA_ALWAYS_SENSITIVE,
837 				   &always_sensitive, sizeof(always_sensitive));
838 		if (rc)
839 			goto out;
840 
841 		rc = add_attribute(&attrs, PKCS11_CKA_NEVER_EXTRACTABLE,
842 				   &never_extract, sizeof(never_extract));
843 		if (rc)
844 			goto out;
845 
846 		/* Keys mandate attribute PKCS11_CKA_KEY_GEN_MECHANISM */
847 		if (local)
848 			mechanism_id = mecha;
849 		else
850 			mechanism_id = PKCS11_CK_UNAVAILABLE_INFORMATION;
851 
852 		rc = add_attribute(&attrs, PKCS11_CKA_KEY_GEN_MECHANISM,
853 				   &mechanism_id, sizeof(mechanism_id));
854 		if (rc)
855 			goto out;
856 		break;
857 
858 	default:
859 		break;
860 	}
861 
862 	*out = attrs;
863 
864 #ifdef DEBUG
865 	trace_attributes("object", attrs);
866 #endif
867 
868 out:
869 	TEE_Free(temp);
870 	if (rc)
871 		TEE_Free(attrs);
872 
873 	return rc;
874 }
875 
876 static enum pkcs11_rc check_attrs_misc_integrity(struct obj_attrs *head)
877 {
878 	if (get_bool(head, PKCS11_CKA_NEVER_EXTRACTABLE) &&
879 	    get_bool(head, PKCS11_CKA_EXTRACTABLE)) {
880 		DMSG("Never/Extractable attributes mismatch %d/%d",
881 		     get_bool(head, PKCS11_CKA_NEVER_EXTRACTABLE),
882 		     get_bool(head, PKCS11_CKA_EXTRACTABLE));
883 
884 		return PKCS11_CKR_TEMPLATE_INCONSISTENT;
885 	}
886 
887 	if (get_bool(head, PKCS11_CKA_ALWAYS_SENSITIVE) &&
888 	    !get_bool(head, PKCS11_CKA_SENSITIVE)) {
889 		DMSG("Sensitive/always attributes mismatch %d/%d",
890 		     get_bool(head, PKCS11_CKA_SENSITIVE),
891 		     get_bool(head, PKCS11_CKA_ALWAYS_SENSITIVE));
892 
893 		return PKCS11_CKR_TEMPLATE_INCONSISTENT;
894 	}
895 
896 	return PKCS11_CKR_OK;
897 }
898 
899 /*
900  * Check access to object against authentication to token
901  */
902 enum pkcs11_rc check_access_attrs_against_token(struct pkcs11_session *session,
903 						struct obj_attrs *head)
904 {
905 	bool private = true;
906 
907 	switch (get_class(head)) {
908 	case PKCS11_CKO_SECRET_KEY:
909 	case PKCS11_CKO_PUBLIC_KEY:
910 	case PKCS11_CKO_DATA:
911 		private = get_bool(head, PKCS11_CKA_PRIVATE);
912 		break;
913 	case PKCS11_CKO_PRIVATE_KEY:
914 		break;
915 	default:
916 		return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
917 	}
918 
919 	if (private && pkcs11_session_is_public(session)) {
920 		DMSG("Private object access from a public session");
921 
922 		return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
923 	}
924 
925 	return PKCS11_CKR_OK;
926 }
927 
928 /*
929  * Check the attributes of a to-be-created object matches the token state
930  */
931 enum pkcs11_rc check_created_attrs_against_token(struct pkcs11_session *session,
932 						 struct obj_attrs *head)
933 {
934 	enum pkcs11_rc rc = PKCS11_CKR_OK;
935 
936 	rc = check_attrs_misc_integrity(head);
937 	if (rc)
938 		return rc;
939 
940 	if (get_bool(head, PKCS11_CKA_TRUSTED) &&
941 	    !pkcs11_session_is_so(session)) {
942 		DMSG("Can't create trusted object");
943 
944 		return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
945 	}
946 
947 	if (get_bool(head, PKCS11_CKA_TOKEN) &&
948 	    !pkcs11_session_is_read_write(session)) {
949 		DMSG("Can't create persistent object");
950 
951 		return PKCS11_CKR_SESSION_READ_ONLY;
952 	}
953 
954 	/*
955 	 * TODO: START_DATE and END_DATE: complies with current time?
956 	 */
957 	return PKCS11_CKR_OK;
958 }
959 
960 #define DMSG_BAD_BBOOL(attr, proc, head)				\
961 	do {								\
962 		uint32_t __maybe_unused _attr = (attr);			\
963 		uint8_t __maybe_unused _bvalue = 0;			\
964 		enum pkcs11_rc __maybe_unused _rc = PKCS11_CKR_OK;	\
965 									\
966 		_rc = get_attribute((head), _attr, &_bvalue, NULL);	\
967 		DMSG("%s issue for %s: %sfound, value %"PRIu8,		\
968 		     id2str_attr(_attr), id2str_proc((proc)),		\
969 		     _rc ? "not " : "", _bvalue);			\
970 	} while (0)
971 
972 static bool __maybe_unused check_attr_bval(uint32_t proc_id __maybe_unused,
973 					   struct obj_attrs *head,
974 					   uint32_t attribute, bool val)
975 {
976 	uint8_t bbool = 0;
977 	uint32_t sz = sizeof(bbool);
978 
979 	if (!get_attribute(head, attribute, &bbool, &sz) && !!bbool == val)
980 		return true;
981 
982 	DMSG_BAD_BBOOL(attribute, proc_id, head);
983 	return false;
984 }
985 
986 /*
987  * Check the attributes of a new secret match the processing/mechanism
988  * used to create it.
989  *
990  * @proc_id - PKCS11_CKM_xxx
991  * @head - head of the attributes of the to-be-created object.
992  */
993 enum pkcs11_rc check_created_attrs_against_processing(uint32_t proc_id,
994 						      struct obj_attrs *head)
995 {
996 	/*
997 	 * Processings that do not create secrets are not expected to call
998 	 * this function which would panic.
999 	 */
1000 	switch (proc_id) {
1001 	case PKCS11_PROCESSING_IMPORT:
1002 		assert(check_attr_bval(proc_id, head, PKCS11_CKA_LOCAL, false));
1003 		break;
1004 	case PKCS11_CKM_GENERIC_SECRET_KEY_GEN:
1005 	case PKCS11_CKM_AES_KEY_GEN:
1006 		assert(check_attr_bval(proc_id, head, PKCS11_CKA_LOCAL, true));
1007 		break;
1008 	default:
1009 		TEE_Panic(proc_id);
1010 		break;
1011 	}
1012 
1013 	switch (proc_id) {
1014 	case PKCS11_CKM_GENERIC_SECRET_KEY_GEN:
1015 		assert(get_key_type(head) == PKCS11_CKK_GENERIC_SECRET);
1016 		break;
1017 	case PKCS11_CKM_AES_KEY_GEN:
1018 		assert(get_key_type(head) == PKCS11_CKK_AES);
1019 		break;
1020 	case PKCS11_PROCESSING_IMPORT:
1021 	default:
1022 		break;
1023 	}
1024 
1025 	return PKCS11_CKR_OK;
1026 }
1027 
1028 static void get_key_min_max_sizes(enum pkcs11_key_type key_type,
1029 				  uint32_t *min_key_size,
1030 				  uint32_t *max_key_size)
1031 {
1032 	enum pkcs11_mechanism_id mechanism = PKCS11_CKM_UNDEFINED_ID;
1033 
1034 	switch (key_type) {
1035 	case PKCS11_CKK_GENERIC_SECRET:
1036 		mechanism = PKCS11_CKM_GENERIC_SECRET_KEY_GEN;
1037 		break;
1038 	case PKCS11_CKK_AES:
1039 		mechanism = PKCS11_CKM_AES_KEY_GEN;
1040 		break;
1041 	case PKCS11_CKK_MD5_HMAC:
1042 		mechanism = PKCS11_CKM_MD5_HMAC;
1043 		break;
1044 	case PKCS11_CKK_SHA_1_HMAC:
1045 		mechanism = PKCS11_CKM_SHA_1_HMAC;
1046 		break;
1047 	case PKCS11_CKK_SHA224_HMAC:
1048 		mechanism = PKCS11_CKM_SHA224_HMAC;
1049 		break;
1050 	case PKCS11_CKK_SHA256_HMAC:
1051 		mechanism = PKCS11_CKM_SHA256_HMAC;
1052 		break;
1053 	case PKCS11_CKK_SHA384_HMAC:
1054 		mechanism = PKCS11_CKM_SHA384_HMAC;
1055 		break;
1056 	case PKCS11_CKK_SHA512_HMAC:
1057 		mechanism = PKCS11_CKM_SHA512_HMAC;
1058 		break;
1059 	default:
1060 		TEE_Panic(key_type);
1061 		break;
1062 	}
1063 
1064 	mechanism_supported_key_sizes(mechanism, min_key_size,
1065 				      max_key_size);
1066 }
1067 
1068 enum pkcs11_rc check_created_attrs(struct obj_attrs *key1,
1069 				   struct obj_attrs *key2)
1070 {
1071 	enum pkcs11_rc rc = PKCS11_CKR_OK;
1072 	struct obj_attrs *secret = NULL;
1073 	uint32_t max_key_size = 0;
1074 	uint32_t min_key_size = 0;
1075 	uint32_t key_length = 0;
1076 
1077 	switch (get_class(key1)) {
1078 	case PKCS11_CKO_SECRET_KEY:
1079 		secret = key1;
1080 		break;
1081 	default:
1082 		return PKCS11_CKR_ATTRIBUTE_VALUE_INVALID;
1083 	}
1084 
1085 	if (key2)
1086 		return PKCS11_CKR_ATTRIBUTE_VALUE_INVALID;
1087 
1088 	if (secret) {
1089 		switch (get_key_type(secret)) {
1090 		case PKCS11_CKK_AES:
1091 		case PKCS11_CKK_GENERIC_SECRET:
1092 		case PKCS11_CKK_MD5_HMAC:
1093 		case PKCS11_CKK_SHA_1_HMAC:
1094 		case PKCS11_CKK_SHA224_HMAC:
1095 		case PKCS11_CKK_SHA256_HMAC:
1096 		case PKCS11_CKK_SHA384_HMAC:
1097 		case PKCS11_CKK_SHA512_HMAC:
1098 			break;
1099 		default:
1100 			return PKCS11_CKR_TEMPLATE_INCONSISTENT;
1101 		}
1102 
1103 		/* Get key size */
1104 		rc = get_u32_attribute(secret, PKCS11_CKA_VALUE_LEN,
1105 				       &key_length);
1106 		if (rc)
1107 			return PKCS11_CKR_TEMPLATE_INCOMPLETE;
1108 	}
1109 
1110 	get_key_min_max_sizes(get_key_type(key1), &min_key_size, &max_key_size);
1111 	if (key_length < min_key_size || key_length > max_key_size) {
1112 		EMSG("Length %"PRIu32" vs range [%"PRIu32" %"PRIu32"]",
1113 		     key_length, min_key_size, max_key_size);
1114 
1115 		return PKCS11_CKR_KEY_SIZE_RANGE;
1116 	}
1117 
1118 	return PKCS11_CKR_OK;
1119 }
1120 
1121 /* Check processing ID against attribute ALLOWED_MECHANISMS if any */
1122 static bool parent_key_complies_allowed_processings(uint32_t proc_id,
1123 						    struct obj_attrs *head)
1124 {
1125 	char *attr = NULL;
1126 	uint32_t size = 0;
1127 	uint32_t proc = 0;
1128 	size_t count = 0;
1129 	enum pkcs11_rc rc = PKCS11_CKR_GENERAL_ERROR;
1130 
1131 	rc = get_attribute_ptr(head, PKCS11_CKA_ALLOWED_MECHANISMS,
1132 			       (void *)&attr, &size);
1133 	if (rc == PKCS11_RV_NOT_FOUND)
1134 		return true;
1135 	if (rc) {
1136 		EMSG("unexpected attributes state");
1137 		TEE_Panic(TEE_ERROR_BAD_STATE);
1138 	}
1139 
1140 	for (count = size / sizeof(uint32_t); count; count--) {
1141 		TEE_MemMove(&proc, attr, sizeof(uint32_t));
1142 		attr += sizeof(uint32_t);
1143 
1144 		if (proc == proc_id)
1145 			return true;
1146 	}
1147 
1148 	DMSG("can't find %s in allowed list", id2str_proc(proc_id));
1149 	return false;
1150 }
1151 
1152 static enum pkcs11_attr_id func_to_attr(enum processing_func func)
1153 {
1154 	switch (func) {
1155 	case PKCS11_FUNCTION_ENCRYPT:
1156 		return PKCS11_CKA_ENCRYPT;
1157 	case PKCS11_FUNCTION_DECRYPT:
1158 		return PKCS11_CKA_DECRYPT;
1159 	case PKCS11_FUNCTION_SIGN:
1160 		return PKCS11_CKA_SIGN;
1161 	case PKCS11_FUNCTION_VERIFY:
1162 		return PKCS11_CKA_VERIFY;
1163 	case PKCS11_FUNCTION_WRAP:
1164 		return PKCS11_CKA_WRAP;
1165 	case PKCS11_FUNCTION_UNWRAP:
1166 		return PKCS11_CKA_UNWRAP;
1167 	case PKCS11_FUNCTION_DERIVE:
1168 		return PKCS11_CKA_DERIVE;
1169 	default:
1170 		return PKCS11_CKA_UNDEFINED_ID;
1171 	}
1172 }
1173 
1174 enum pkcs11_rc
1175 check_parent_attrs_against_processing(enum pkcs11_mechanism_id proc_id,
1176 				      enum processing_func function,
1177 				      struct obj_attrs *head)
1178 {
1179 	enum pkcs11_class_id key_class = get_class(head);
1180 	enum pkcs11_key_type key_type = get_key_type(head);
1181 	enum pkcs11_attr_id attr = func_to_attr(function);
1182 
1183 	if (!get_bool(head, attr)) {
1184 		DMSG("%s not permitted", id2str_attr(attr));
1185 		return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1186 	}
1187 
1188 	/* Check processing complies with parent key family */
1189 	switch (proc_id) {
1190 	case PKCS11_CKM_AES_ECB:
1191 	case PKCS11_CKM_AES_CBC:
1192 	case PKCS11_CKM_AES_CBC_PAD:
1193 	case PKCS11_CKM_AES_CTS:
1194 	case PKCS11_CKM_AES_CTR:
1195 		if (key_class == PKCS11_CKO_SECRET_KEY &&
1196 		    key_type == PKCS11_CKK_AES)
1197 			break;
1198 
1199 		DMSG("%s invalid key %s/%s", id2str_proc(proc_id),
1200 		     id2str_class(key_class), id2str_key_type(key_type));
1201 
1202 		return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1203 
1204 	case PKCS11_CKM_MD5_HMAC:
1205 	case PKCS11_CKM_SHA_1_HMAC:
1206 	case PKCS11_CKM_SHA224_HMAC:
1207 	case PKCS11_CKM_SHA256_HMAC:
1208 	case PKCS11_CKM_SHA384_HMAC:
1209 	case PKCS11_CKM_SHA512_HMAC:
1210 		if (key_class != PKCS11_CKO_SECRET_KEY)
1211 			return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1212 
1213 		if (key_type == PKCS11_CKK_GENERIC_SECRET)
1214 			break;
1215 
1216 		switch (proc_id) {
1217 		case PKCS11_CKM_MD5_HMAC:
1218 			if (key_type == PKCS11_CKK_MD5_HMAC)
1219 				break;
1220 			return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1221 		case PKCS11_CKM_SHA_1_HMAC:
1222 			if (key_type == PKCS11_CKK_SHA_1_HMAC)
1223 				break;
1224 			return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1225 		case PKCS11_CKM_SHA224_HMAC:
1226 			if (key_type == PKCS11_CKK_SHA224_HMAC)
1227 				break;
1228 			return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1229 		case PKCS11_CKM_SHA256_HMAC:
1230 			if (key_type == PKCS11_CKK_SHA256_HMAC)
1231 				break;
1232 			return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1233 		case PKCS11_CKM_SHA384_HMAC:
1234 			if (key_type == PKCS11_CKK_SHA384_HMAC)
1235 				break;
1236 			return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1237 		case PKCS11_CKM_SHA512_HMAC:
1238 			if (key_type == PKCS11_CKK_SHA512_HMAC)
1239 				break;
1240 			return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1241 		default:
1242 			return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1243 		}
1244 		break;
1245 
1246 	default:
1247 		DMSG("Invalid processing %#"PRIx32"/%s", proc_id,
1248 		     id2str_proc(proc_id));
1249 
1250 		return PKCS11_CKR_MECHANISM_INVALID;
1251 	}
1252 
1253 	if (!parent_key_complies_allowed_processings(proc_id, head)) {
1254 		DMSG("Allowed mechanism failed");
1255 		return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED;
1256 	}
1257 
1258 	return PKCS11_CKR_OK;
1259 }
1260