1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2014-2021, Linaro Limited
4  * Copyright (c) 2021, SumUp Services GmbH
5  */
6 
7 #ifndef TEE_API_DEFINES_EXTENSIONS_H
8 #define TEE_API_DEFINES_EXTENSIONS_H
9 
10 /*
11  * API extended result codes as per TEE_Result IDs defined in GPD TEE
12  * Internal Core API specification v1.1:
13  *
14  * 0x70000000 - 0x7FFFFFFF: Reserved for implementation-specific return
15  *			    code providing non-error information
16  * 0x80000000 - 0x8FFFFFFF: Reserved for implementation-specific errors
17  *
18  * TEE_ERROR_DEFER_DRIVER_INIT - Device driver failed to initialize because
19  * the driver depends on a device not yet initialized.
20  */
21 #define TEE_ERROR_DEFER_DRIVER_INIT	0x80000000
22 
23 /*
24  * TEE_ERROR_NODE_DISABLED - Device driver failed to initialize because it is
25  * not allocated for TEE environment.
26  */
27 #define TEE_ERROR_NODE_DISABLED		0x80000001
28 
29 /*
30  * HMAC-based Extract-and-Expand Key Derivation Function (HKDF)
31  */
32 
33 #define TEE_ALG_HKDF_MD5_DERIVE_KEY     0x800010C0
34 #define TEE_ALG_HKDF_SHA1_DERIVE_KEY    0x800020C0
35 #define TEE_ALG_HKDF_SHA224_DERIVE_KEY  0x800030C0
36 #define TEE_ALG_HKDF_SHA256_DERIVE_KEY  0x800040C0
37 #define TEE_ALG_HKDF_SHA384_DERIVE_KEY  0x800050C0
38 #define TEE_ALG_HKDF_SHA512_DERIVE_KEY  0x800060C0
39 
40 #define TEE_TYPE_HKDF_IKM               0xA10000C0
41 
42 #define TEE_ATTR_HKDF_IKM               0xC00001C0
43 #define TEE_ATTR_HKDF_SALT              0xD00002C0
44 #define TEE_ATTR_HKDF_INFO              0xD00003C0
45 #define TEE_ATTR_HKDF_OKM_LENGTH        0xF00004C0
46 
47 /*
48  * Concatenation Key Derivation Function (Concat KDF)
49  * NIST SP 800-56A section 5.8.1
50  */
51 
52 #define TEE_ALG_CONCAT_KDF_SHA1_DERIVE_KEY    0x800020C1
53 #define TEE_ALG_CONCAT_KDF_SHA224_DERIVE_KEY  0x800030C1
54 #define TEE_ALG_CONCAT_KDF_SHA256_DERIVE_KEY  0x800040C1
55 #define TEE_ALG_CONCAT_KDF_SHA384_DERIVE_KEY  0x800050C1
56 #define TEE_ALG_CONCAT_KDF_SHA512_DERIVE_KEY  0x800060C1
57 
58 #define TEE_TYPE_CONCAT_KDF_Z                 0xA10000C1
59 
60 #define TEE_ATTR_CONCAT_KDF_Z                 0xC00001C1
61 #define TEE_ATTR_CONCAT_KDF_OTHER_INFO        0xD00002C1
62 #define TEE_ATTR_CONCAT_KDF_DKM_LENGTH        0xF00003C1
63 
64 /*
65  * PKCS #5 v2.0 Key Derivation Function 2 (PBKDF2)
66  * RFC 2898 section 5.2
67  * https://www.ietf.org/rfc/rfc2898.txt
68  */
69 
70 #define TEE_ALG_PBKDF2_HMAC_SHA1_DERIVE_KEY 0x800020C2
71 
72 #define TEE_TYPE_PBKDF2_PASSWORD            0xA10000C2
73 
74 #define TEE_ATTR_PBKDF2_PASSWORD            0xC00001C2
75 #define TEE_ATTR_PBKDF2_SALT                0xD00002C2
76 #define TEE_ATTR_PBKDF2_ITERATION_COUNT     0xF00003C2
77 #define TEE_ATTR_PBKDF2_DKM_LENGTH          0xF00004C2
78 
79 /*
80  * PKCS#1 v1.5 RSASSA pre-hashed sign/verify
81  */
82 
83 #define TEE_ALG_RSASSA_PKCS1_V1_5	0xF0000830
84 
85 /*
86  *  TDEA CMAC (NIST SP800-38B)
87  */
88 #define TEE_ALG_DES3_CMAC	0xF0000613
89 
90 /*
91  *  SM4-XTS
92  */
93 #define TEE_ALG_SM4_XTS 0xF0000414
94 
95 /*
96  * Implementation-specific object storage constants
97  */
98 
99 /* Storage is provided by the Rich Execution Environment (REE) */
100 #define TEE_STORAGE_PRIVATE_REE	 0x80000000
101 /* Storage is the Replay Protected Memory Block partition of an eMMC device */
102 #define TEE_STORAGE_PRIVATE_RPMB 0x80000100
103 /* Was TEE_STORAGE_PRIVATE_SQL, which isn't supported any longer */
104 #define TEE_STORAGE_PRIVATE_SQL_RESERVED  0x80000200
105 
106 /*
107  * Extension of "Memory Access Rights Constants"
108  * #define TEE_MEMORY_ACCESS_READ             0x00000001
109  * #define TEE_MEMORY_ACCESS_WRITE            0x00000002
110  * #define TEE_MEMORY_ACCESS_ANY_OWNER        0x00000004
111  *
112  * TEE_MEMORY_ACCESS_NONSECURE : if set TEE_CheckMemoryAccessRights()
113  * successfully returns only if target vmem range is mapped non-secure.
114  *
115  * TEE_MEMORY_ACCESS_SECURE : if set TEE_CheckMemoryAccessRights()
116  * successfully returns only if target vmem range is mapped secure.
117 
118  */
119 #define TEE_MEMORY_ACCESS_NONSECURE          0x10000000
120 #define TEE_MEMORY_ACCESS_SECURE             0x20000000
121 
122 /*
123  * Implementation-specific login types
124  */
125 
126 /* Private login method for REE kernel clients */
127 #define TEE_LOGIN_REE_KERNEL		0x80000000
128 
129 #endif /* TEE_API_DEFINES_EXTENSIONS_H */
130