1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2018-2020, Linaro Limited 4 */ 5 6 #ifndef PKCS11_HELPERS_H 7 #define PKCS11_HELPERS_H 8 9 #include <stdint.h> 10 #include <stddef.h> 11 12 #include <pkcs11_attributes.h> 13 #include <token_capabilities.h> 14 15 struct pkcs11_object; 16 17 /* 18 * TEE invocation parameter#0 is an in/out buffer of at least 32bit 19 * to store the TA PKCS#11 compliant return value. 20 */ 21 #define TEE_PARAM0_SIZE_MIN sizeof(uint32_t) 22 23 /* GPD TEE to PKCS11 status conversion */ 24 enum pkcs11_rc tee2pkcs_error(TEE_Result res); 25 26 /* 27 * Return true if and only if attribute ID with companion attribute value 28 * size do match a valid attribute identifier. 29 * 30 * @attribute_id - Target PKCS11 attribute ID 31 * @size - Byte size of the attribute value, 0 if non-constant size 32 */ 33 bool valid_pkcs11_attribute_id(uint32_t attribute_id, uint32_t size); 34 35 /* 36 * Return type attribute byte size if @attribute_id is the ID of a type 37 * attribute or 0 if not. 38 */ 39 size_t pkcs11_attr_is_type(uint32_t attribute_id); 40 41 /* Return true if the object class is related to a type-in-class */ 42 bool pkcs11_class_has_type(uint32_t class_id); 43 44 /* Return true if the object class relates to a key */ 45 bool pkcs11_attr_class_is_key(uint32_t class_id); 46 47 /* Return true if the key type @key_type_id relates to a symmetric key */ 48 bool key_type_is_symm_key(uint32_t key_type_id); 49 50 /* Return true if the key type @key_type_id relates to an asymmetric key */ 51 bool key_type_is_asymm_key(uint32_t key_type_id); 52 53 /* Boolprop flag shift position if @attribute_id is boolean, else -1 */ 54 int pkcs11_attr2boolprop_shift(uint32_t attribute_id); 55 56 /* Convert PKCS11 TA function ID into a TEE crypto operation mode */ 57 void pkcs2tee_mode(uint32_t *tee_id, enum processing_func function); 58 59 /* Load TEE operation attributes from a PKCS11 object, return false on error */ 60 bool pkcs2tee_load_attr(TEE_Attribute *tee_ref, uint32_t tee_id, 61 struct pkcs11_object *obj, 62 enum pkcs11_attr_id pkcs11_id); 63 64 /* Return true if attribute is a boolean, false otherwise */ 65 static inline bool pkcs11_attr_is_boolean(enum pkcs11_attr_id id) 66 { 67 return pkcs11_attr2boolprop_shift(id) >= 0; 68 } 69 70 #if CFG_TEE_TA_LOG_LEVEL > 0 71 /* Id-to-string conversions only for trace support */ 72 const char *id2str_ta_cmd(uint32_t id); 73 const char *id2str_rc(uint32_t id); 74 const char *id2str_slot_flag(uint32_t id); 75 const char *id2str_token_flag(uint32_t id); 76 const char *id2str_session_flag(uint32_t id); 77 const char *id2str_session_state(uint32_t id); 78 const char *id2str_attr(uint32_t id); 79 const char *id2str_class(uint32_t id); 80 const char *id2str_type(uint32_t id, uint32_t class); 81 const char *id2str_key_type(uint32_t id); 82 const char *id2str_attr_value(uint32_t id, size_t size, void *value); 83 const char *id2str_proc(uint32_t id); 84 const char *id2str_function(uint32_t id); 85 86 static inline const char *id2str_mechanism(enum pkcs11_mechanism_id id) 87 { 88 return mechanism_string_id(id); 89 } 90 #endif /* CFG_TEE_TA_LOG_LEVEL > 0 */ 91 #endif /*PKCS11_HELPERS_H*/ 92