]>
Commit | Line | Data |
---|---|---|
8a73348b | 1 | /* |
33388b44 | 2 | * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved. |
8a73348b MC |
3 | * |
4 | * Licensed under the Apache License 2.0 (the "License"). You may not use | |
5 | * this file except in compliance with the License. You can obtain a copy | |
6 | * in the file LICENSE in the source distribution or at | |
7 | * https://www.openssl.org/source/license.html | |
8 | */ | |
9 | ||
ae4186b0 DMSP |
10 | #ifndef OPENSSL_CORE_NAMES_H |
11 | # define OPENSSL_CORE_NAMES_H | |
8a73348b MC |
12 | |
13 | # ifdef __cplusplus | |
14 | extern "C" { | |
15 | # endif | |
16 | ||
b8086652 SL |
17 | /* Well known parameter names that core passes to providers */ |
18 | #define OSSL_PROV_PARAM_CORE_VERSION "openssl-version" /* utf8_ptr */ | |
19 | #define OSSL_PROV_PARAM_CORE_PROV_NAME "provider-name" /* utf8_ptr */ | |
20 | #define OSSL_PROV_PARAM_CORE_MODULE_FILENAME "module-filename" /* utf8_ptr */ | |
21 | ||
36fc5fc6 SL |
22 | /* Well known parameter names that Providers can define */ |
23 | #define OSSL_PROV_PARAM_NAME "name" /* utf8_string */ | |
24 | #define OSSL_PROV_PARAM_VERSION "version" /* utf8_string */ | |
25 | #define OSSL_PROV_PARAM_BUILDINFO "buildinfo" /* utf8_string */ | |
04cb5ec0 | 26 | #define OSSL_PROV_PARAM_STATUS "status" /* uint */ |
991a6bb5 | 27 | #define OSSL_PROV_PARAM_SECURITY_CHECKS "security-checks" /* uint */ |
8a73348b | 28 | |
36fc5fc6 SL |
29 | /* Self test callback parameters */ |
30 | #define OSSL_PROV_PARAM_SELF_TEST_PHASE "st-phase" /* utf8_string */ | |
31 | #define OSSL_PROV_PARAM_SELF_TEST_TYPE "st-type" /* utf8_string */ | |
32 | #define OSSL_PROV_PARAM_SELF_TEST_DESC "st-desc" /* utf8_string */ | |
df05f2ce | 33 | |
14c8a3d1 RL |
34 | /*- |
35 | * Provider-native object abstractions | |
36 | * | |
37 | * These are used when a provider wants to pass object data or an object | |
38 | * reference back to libcrypto. This is only useful for provider functions | |
39 | * that take a callback to which an OSSL_PARAM array with these parameters | |
40 | * can be passed. | |
41 | * | |
42 | * This set of parameter names is explained in detail in provider-object(7) | |
43 | * (doc/man7/provider-object.pod) | |
44 | */ | |
45 | #define OSSL_OBJECT_PARAM_TYPE "type" /* INTEGER */ | |
46 | #define OSSL_OBJECT_PARAM_DATA_TYPE "data-type" /* UTF8_STRING */ | |
47 | #define OSSL_OBJECT_PARAM_REFERENCE "reference" /* OCTET_STRING */ | |
48 | #define OSSL_OBJECT_PARAM_DATA "data" /* OCTET_STRING or UTF8_STRING */ | |
49 | #define OSSL_OBJECT_PARAM_DESC "desc" /* UTF8_STRING */ | |
50 | ||
cb74317b P |
51 | /* |
52 | * Algorithm parameters | |
53 | * If "engine" or "properties" are specified, they should always be paired | |
54 | * with the algorithm type. | |
b8086652 SL |
55 | * Note these are common names that are shared by many types (such as kdf, mac, |
56 | * and pkey) e.g: see OSSL_MAC_PARAM_DIGEST below. | |
cb74317b P |
57 | */ |
58 | #define OSSL_ALG_PARAM_DIGEST "digest" /* utf8_string */ | |
59 | #define OSSL_ALG_PARAM_CIPHER "cipher" /* utf8_string */ | |
a540ef90 | 60 | #define OSSL_ALG_PARAM_ENGINE "engine" /* utf8_string */ |
4e8b8e47 | 61 | #define OSSL_ALG_PARAM_MAC "mac" /* utf8_string */ |
cb74317b P |
62 | #define OSSL_ALG_PARAM_PROPERTIES "properties"/* utf8_string */ |
63 | ||
459b15d4 | 64 | /* cipher parameters */ |
e71fd827 MC |
65 | #define OSSL_CIPHER_PARAM_PADDING "padding" /* uint */ |
66 | #define OSSL_CIPHER_PARAM_TLS_VERSION "tls-version" /* uint */ | |
67 | #define OSSL_CIPHER_PARAM_TLS_MAC "tls-mac" /* octet_ptr */ | |
68 | #define OSSL_CIPHER_PARAM_TLS_MAC_SIZE "tls-mac-size" /* size_t */ | |
69 | #define OSSL_CIPHER_PARAM_MODE "mode" /* uint */ | |
70 | #define OSSL_CIPHER_PARAM_BLOCK_SIZE "blocksize" /* size_t */ | |
71 | #define OSSL_CIPHER_PARAM_FLAGS "flags" /* ulong */ | |
72 | #define OSSL_CIPHER_PARAM_KEYLEN "keylen" /* size_t */ | |
73 | #define OSSL_CIPHER_PARAM_IVLEN "ivlen" /* size_t */ | |
74 | #define OSSL_CIPHER_PARAM_IV "iv" /* octet_string OR octet_ptr */ | |
84890268 | 75 | #define OSSL_CIPHER_PARAM_IV_STATE "iv-state" /* octet_string OR octet_ptr */ |
e71fd827 MC |
76 | #define OSSL_CIPHER_PARAM_NUM "num" /* uint */ |
77 | #define OSSL_CIPHER_PARAM_ROUNDS "rounds" /* uint */ | |
78 | #define OSSL_CIPHER_PARAM_AEAD_TAG "tag" /* octet_string */ | |
79 | #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD "tlsaad" /* octet_string */ | |
80 | #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD "tlsaadpad" /* size_t */ | |
81 | #define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED "tlsivfixed" /* octet_string */ | |
82 | #define OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN "tlsivgen" /* octet_string */ | |
83 | #define OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV "tlsivinv" /* octet_string */ | |
11b44359 | 84 | #define OSSL_CIPHER_PARAM_AEAD_IVLEN OSSL_CIPHER_PARAM_IVLEN |
e71fd827 MC |
85 | #define OSSL_CIPHER_PARAM_AEAD_TAGLEN "taglen" /* size_t */ |
86 | #define OSSL_CIPHER_PARAM_AEAD_MAC_KEY "mackey" /* octet_string */ | |
87 | #define OSSL_CIPHER_PARAM_RANDOM_KEY "randkey" /* octet_string */ | |
88 | #define OSSL_CIPHER_PARAM_RC2_KEYBITS "keybits" /* size_t */ | |
89 | #define OSSL_CIPHER_PARAM_SPEED "speed" /* uint */ | |
7cc355c2 | 90 | #define OSSL_CIPHER_PARAM_CTS_MODE "cts_mode" /* utf8_string */ |
c96399e2 | 91 | /* For passing the AlgorithmIdentifier parameter in DER form */ |
11b44359 | 92 | #define OSSL_CIPHER_PARAM_ALG_ID "alg_id_param" /* octet_string */ |
df05f2ce | 93 | |
0d2bfe52 SL |
94 | #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT \ |
95 | "tls1multi_maxsndfrag" /* uint */ | |
96 | #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE \ | |
97 | "tls1multi_maxbufsz" /* size_t */ | |
98 | #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE \ | |
99 | "tls1multi_interleave" /* uint */ | |
100 | #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD \ | |
101 | "tls1multi_aad" /* octet_string */ | |
102 | #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN \ | |
103 | "tls1multi_aadpacklen" /* uint */ | |
104 | #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC \ | |
105 | "tls1multi_enc" /* octet_string */ | |
106 | #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN \ | |
107 | "tls1multi_encin" /* octet_string */ | |
108 | #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN \ | |
109 | "tls1multi_enclen" /* size_t */ | |
eb173822 | 110 | |
7cc355c2 SL |
111 | /* OSSL_CIPHER_PARAM_CTS_MODE Values */ |
112 | #define OSSL_CIPHER_CTS_MODE_CS1 "CS1" | |
113 | #define OSSL_CIPHER_CTS_MODE_CS2 "CS2" | |
114 | #define OSSL_CIPHER_CTS_MODE_CS3 "CS3" | |
115 | ||
d5e5e2ff | 116 | /* digest parameters */ |
1c3ace68 SL |
117 | #define OSSL_DIGEST_PARAM_XOFLEN "xoflen" /* size_t */ |
118 | #define OSSL_DIGEST_PARAM_SSL3_MS "ssl3-ms" /* octet string */ | |
119 | #define OSSL_DIGEST_PARAM_PAD_TYPE "pad_type" /* uint */ | |
120 | #define OSSL_DIGEST_PARAM_MICALG "micalg" /* utf8 string */ | |
121 | #define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */ | |
122 | #define OSSL_DIGEST_PARAM_SIZE "size" /* size_t */ | |
123 | #define OSSL_DIGEST_PARAM_FLAGS "flags" /* ulong */ | |
d5e5e2ff | 124 | |
81ff9eeb | 125 | /* Known DIGEST names (not a complete list) */ |
505b41fc | 126 | #define OSSL_DIGEST_NAME_MD5 "MD5" |
6f4b7663 | 127 | #define OSSL_DIGEST_NAME_MD5_SHA1 "MD5-SHA1" |
505b41fc RL |
128 | #define OSSL_DIGEST_NAME_SHA1 "SHA1" |
129 | #define OSSL_DIGEST_NAME_SHA2_224 "SHA2-224" | |
130 | #define OSSL_DIGEST_NAME_SHA2_256 "SHA2-256" | |
131 | #define OSSL_DIGEST_NAME_SHA2_384 "SHA2-384" | |
132 | #define OSSL_DIGEST_NAME_SHA2_512 "SHA2-512" | |
45c236ad SL |
133 | #define OSSL_DIGEST_NAME_SHA2_512_224 "SHA2-512/224" |
134 | #define OSSL_DIGEST_NAME_SHA2_512_256 "SHA2-512/256" | |
6f4b7663 RL |
135 | #define OSSL_DIGEST_NAME_MD2 "MD2" |
136 | #define OSSL_DIGEST_NAME_MD4 "MD4" | |
137 | #define OSSL_DIGEST_NAME_MDC2 "MDC2" | |
138 | #define OSSL_DIGEST_NAME_RIPEMD160 "RIPEMD160" | |
505b41fc RL |
139 | #define OSSL_DIGEST_NAME_SHA3_224 "SHA3-224" |
140 | #define OSSL_DIGEST_NAME_SHA3_256 "SHA3-256" | |
141 | #define OSSL_DIGEST_NAME_SHA3_384 "SHA3-384" | |
142 | #define OSSL_DIGEST_NAME_SHA3_512 "SHA3-512" | |
cc35c3ed MC |
143 | #define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128" |
144 | #define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256" | |
d0b79f86 | 145 | #define OSSL_DIGEST_NAME_SM3 "SM3" |
81ff9eeb | 146 | |
e74bd290 | 147 | /* MAC parameters */ |
1c3ace68 SL |
148 | #define OSSL_MAC_PARAM_KEY "key" /* octet string */ |
149 | #define OSSL_MAC_PARAM_IV "iv" /* octet string */ | |
150 | #define OSSL_MAC_PARAM_CUSTOM "custom" /* utf8 string */ | |
151 | #define OSSL_MAC_PARAM_SALT "salt" /* octet string */ | |
152 | #define OSSL_MAC_PARAM_XOF "xof" /* int, 0 or 1 */ | |
153 | #define OSSL_MAC_PARAM_FLAGS "flags" /* int */ | |
703170d4 RL |
154 | /* |
155 | * If "engine" or "properties" are specified, they should always be paired | |
156 | * with "cipher" or "digest". | |
157 | */ | |
3fddbb26 MC |
158 | #define OSSL_MAC_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */ |
159 | #define OSSL_MAC_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */ | |
160 | #define OSSL_MAC_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */ | |
161 | #define OSSL_MAC_PARAM_SIZE "size" /* size_t */ | |
162 | #define OSSL_MAC_PARAM_TLS_DATA_SIZE "tls-data-size" /* size_t */ | |
e74bd290 | 163 | |
b8086652 SL |
164 | /* Known MAC names */ |
165 | #define OSSL_MAC_NAME_BLAKE2BMAC "BLAKE2BMAC" | |
166 | #define OSSL_MAC_NAME_BLAKE2SMAC "BLAKE2SMAC" | |
81ff9eeb | 167 | #define OSSL_MAC_NAME_CMAC "CMAC" |
b8086652 | 168 | #define OSSL_MAC_NAME_GMAC "GMAC" |
81ff9eeb RL |
169 | #define OSSL_MAC_NAME_HMAC "HMAC" |
170 | #define OSSL_MAC_NAME_KMAC128 "KMAC128" | |
171 | #define OSSL_MAC_NAME_KMAC256 "KMAC256" | |
b8086652 SL |
172 | #define OSSL_MAC_NAME_POLY1305 "POLY1305" |
173 | #define OSSL_MAC_NAME_SIPHASH "SIPHASH" | |
81ff9eeb | 174 | |
2f755701 P |
175 | /* KDF / PRF parameters */ |
176 | #define OSSL_KDF_PARAM_SECRET "secret" /* octet string */ | |
177 | #define OSSL_KDF_PARAM_KEY "key" /* octet string */ | |
178 | #define OSSL_KDF_PARAM_SALT "salt" /* octet string */ | |
179 | #define OSSL_KDF_PARAM_PASSWORD "pass" /* octet string */ | |
4e8b8e47 | 180 | #define OSSL_KDF_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */ |
f6dead1b | 181 | #define OSSL_KDF_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */ |
4e8b8e47 | 182 | #define OSSL_KDF_PARAM_MAC OSSL_ALG_PARAM_MAC /* utf8 string */ |
2f755701 | 183 | #define OSSL_KDF_PARAM_MAC_SIZE "maclen" /* size_t */ |
cb74317b | 184 | #define OSSL_KDF_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */ |
2f755701 P |
185 | #define OSSL_KDF_PARAM_ITER "iter" /* unsigned int */ |
186 | #define OSSL_KDF_PARAM_MODE "mode" /* utf8 string or int */ | |
187 | #define OSSL_KDF_PARAM_PKCS5 "pkcs5" /* int */ | |
188 | #define OSSL_KDF_PARAM_UKM "ukm" /* octet string */ | |
189 | #define OSSL_KDF_PARAM_CEK_ALG "cekalg" /* utf8 string */ | |
190 | #define OSSL_KDF_PARAM_SCRYPT_N "n" /* uint64_t */ | |
191 | #define OSSL_KDF_PARAM_SCRYPT_R "r" /* uint32_t */ | |
192 | #define OSSL_KDF_PARAM_SCRYPT_P "p" /* uint32_t */ | |
193 | #define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */ | |
194 | #define OSSL_KDF_PARAM_INFO "info" /* octet string */ | |
195 | #define OSSL_KDF_PARAM_SEED "seed" /* octet string */ | |
196 | #define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */ | |
197 | #define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */ | |
198 | #define OSSL_KDF_PARAM_SSHKDF_TYPE "type" /* int */ | |
199 | #define OSSL_KDF_PARAM_SIZE "size" /* size_t */ | |
33f54da3 SS |
200 | #define OSSL_KDF_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */ |
201 | #define OSSL_KDF_PARAM_CONSTANT "constant" /* octet string */ | |
b7466c13 | 202 | #define OSSL_KDF_PARAM_PKCS12_ID "id" /* int */ |
2f755701 | 203 | |
d810cc19 P |
204 | /* Known KDF names */ |
205 | #define OSSL_KDF_NAME_HKDF "HKDF" | |
206 | #define OSSL_KDF_NAME_PBKDF2 "PBKDF2" | |
cc35c3ed | 207 | #define OSSL_KDF_NAME_SCRYPT "SCRYPT" |
d810cc19 P |
208 | #define OSSL_KDF_NAME_SSHKDF "SSHKDF" |
209 | #define OSSL_KDF_NAME_SSKDF "SSKDF" | |
210 | #define OSSL_KDF_NAME_TLS1_PRF "TLS1-PRF" | |
211 | #define OSSL_KDF_NAME_X942KDF "X942KDF" | |
212 | #define OSSL_KDF_NAME_X963KDF "X963KDF" | |
a39bc440 | 213 | #define OSSL_KDF_NAME_KBKDF "KBKDF" |
33f54da3 | 214 | #define OSSL_KDF_NAME_KRB5KDF "KRB5KDF" |
d810cc19 | 215 | |
f000e828 P |
216 | /* Known RAND names */ |
217 | #define OSSL_RAND_PARAM_STATE "state" | |
714a1bb3 | 218 | #define OSSL_RAND_PARAM_STRENGTH "strength" |
714a1bb3 P |
219 | #define OSSL_RAND_PARAM_TEST_ENTROPY "test_entropy" |
220 | #define OSSL_RAND_PARAM_TEST_NONCE "test_nonce" | |
221 | ||
f000e828 P |
222 | /* RAND/DRBG names */ |
223 | #define OSSL_DRBG_PARAM_RESEED_REQUESTS "reseed_requests" | |
224 | #define OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL "reseed_time_interval" | |
225 | #define OSSL_DRBG_PARAM_MAX_REQUEST "max_request" | |
226 | #define OSSL_DRBG_PARAM_MIN_ENTROPYLEN "min_entropylen" | |
227 | #define OSSL_DRBG_PARAM_MAX_ENTROPYLEN "max_entropylen" | |
228 | #define OSSL_DRBG_PARAM_MIN_NONCELEN "min_noncelen" | |
229 | #define OSSL_DRBG_PARAM_MAX_NONCELEN "max_noncelen" | |
230 | #define OSSL_DRBG_PARAM_MAX_PERSLEN "max_perslen" | |
231 | #define OSSL_DRBG_PARAM_MAX_ADINLEN "max_adinlen" | |
b0614f0a | 232 | #define OSSL_DRBG_PARAM_RESEED_COUNTER "reseed_counter" |
f000e828 P |
233 | #define OSSL_DRBG_PARAM_RESEED_TIME "reseed_time" |
234 | #define OSSL_DRBG_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES | |
235 | #define OSSL_DRBG_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST | |
236 | #define OSSL_DRBG_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER | |
237 | #define OSSL_DRBG_PARAM_MAC OSSL_ALG_PARAM_MAC | |
238 | #define OSSL_DRBG_PARAM_USE_DF "use_derivation_function" | |
239 | ||
240 | /* DRBG call back parameters */ | |
241 | #define OSSL_DRBG_PARAM_ENTROPY_REQUIRED "entropy_required" | |
242 | #define OSSL_DRBG_PARAM_PREDICTION_RESISTANCE "prediction_resistance" | |
243 | #define OSSL_DRBG_PARAM_MIN_LENGTH "minium_length" | |
244 | #define OSSL_DRBG_PARAM_MAX_LENGTH "maxium_length" | |
245 | #define OSSL_DRBG_PARAM_RANDOM_DATA "random_data" | |
246 | #define OSSL_DRBG_PARAM_SIZE "size" | |
247 | ||
ff64702b | 248 | /* PKEY parameters */ |
6508e858 RL |
249 | /* Common PKEY parameters */ |
250 | #define OSSL_PKEY_PARAM_BITS "bits" /* integer */ | |
251 | #define OSSL_PKEY_PARAM_MAX_SIZE "max-size" /* integer */ | |
252 | #define OSSL_PKEY_PARAM_SECURITY_BITS "security-bits" /* integer */ | |
d5aef594 | 253 | #define OSSL_PKEY_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST |
a540ef90 MC |
254 | #define OSSL_PKEY_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */ |
255 | #define OSSL_PKEY_PARAM_ENGINE OSSL_ALG_PARAM_ENGINE /* utf8 string */ | |
8bee6512 | 256 | #define OSSL_PKEY_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES |
ead0d234 RL |
257 | #define OSSL_PKEY_PARAM_DEFAULT_DIGEST "default-digest" /* utf8 string */ |
258 | #define OSSL_PKEY_PARAM_MANDATORY_DIGEST "mandatory-digest" /* utf8 string */ | |
6f4b7663 | 259 | #define OSSL_PKEY_PARAM_PAD_MODE "pad-mode" |
6f4b7663 | 260 | #define OSSL_PKEY_PARAM_DIGEST_SIZE "digest-size" |
15671090 | 261 | #define OSSL_PKEY_PARAM_MASKGENFUNC "mgf" |
6f4b7663 RL |
262 | #define OSSL_PKEY_PARAM_MGF1_DIGEST "mgf1-digest" |
263 | #define OSSL_PKEY_PARAM_MGF1_PROPERTIES "mgf1-properties" | |
6a9bd929 | 264 | #define OSSL_PKEY_PARAM_TLS_ENCODED_PT "tls-encoded-pt" |
023b188c | 265 | #define OSSL_PKEY_PARAM_GROUP_NAME "group" |
86df26b3 | 266 | #define OSSL_PKEY_PARAM_DIST_ID "distid" |
90d3cb57 MC |
267 | #define OSSL_PKEY_PARAM_PUB_KEY "pub" |
268 | #define OSSL_PKEY_PARAM_PRIV_KEY "priv" | |
6508e858 | 269 | |
4889dadc | 270 | /* Diffie-Hellman/DSA Parameters */ |
4f2271d5 SL |
271 | #define OSSL_PKEY_PARAM_FFC_P "p" |
272 | #define OSSL_PKEY_PARAM_FFC_G "g" | |
273 | #define OSSL_PKEY_PARAM_FFC_Q "q" | |
274 | #define OSSL_PKEY_PARAM_FFC_GINDEX "gindex" | |
275 | #define OSSL_PKEY_PARAM_FFC_PCOUNTER "pcounter" | |
276 | #define OSSL_PKEY_PARAM_FFC_SEED "seed" | |
277 | #define OSSL_PKEY_PARAM_FFC_COFACTOR "j" | |
278 | #define OSSL_PKEY_PARAM_FFC_H "hindex" | |
279 | #define OSSL_PKEY_PARAM_FFC_VALIDATE_TYPE "valid-type" | |
280 | ||
281 | /* Diffie-Hellman/DSA Parameters parameter validation types */ | |
282 | #define OSSL_FFC_PARAM_VALIDATE_PQ "validate-pq" | |
283 | #define OSSL_FFC_PARAM_VALIDATE_G "validate-g" | |
284 | #define OSSL_FFC_PARAM_VALIDATE_PQG "validate-pqg" | |
7165593c SL |
285 | |
286 | /* Diffie-Hellman params */ | |
4f2271d5 SL |
287 | #define OSSL_PKEY_PARAM_DH_GENERATOR "safeprime-generator" |
288 | #define OSSL_PKEY_PARAM_DH_PRIV_LEN "priv_len" | |
7165593c | 289 | |
4fe54d67 | 290 | /* Elliptic Curve Domain Parameters */ |
4f2271d5 SL |
291 | #define OSSL_PKEY_PARAM_EC_PUB_X "qx" |
292 | #define OSSL_PKEY_PARAM_EC_PUB_Y "qy" | |
4fe54d67 | 293 | |
c0f39ded SL |
294 | /* Elliptic Curve Explicit Domain Parameters */ |
295 | #define OSSL_PKEY_PARAM_EC_FIELD_TYPE "field-type" | |
296 | #define OSSL_PKEY_PARAM_EC_P "p" | |
297 | #define OSSL_PKEY_PARAM_EC_A "a" | |
298 | #define OSSL_PKEY_PARAM_EC_B "b" | |
299 | #define OSSL_PKEY_PARAM_EC_GENERATOR "generator" | |
300 | #define OSSL_PKEY_PARAM_EC_ORDER "order" | |
301 | #define OSSL_PKEY_PARAM_EC_COFACTOR "cofactor" | |
302 | #define OSSL_PKEY_PARAM_EC_SEED "seed" | |
303 | #define OSSL_PKEY_PARAM_EC_CHAR2_M "m" | |
304 | #define OSSL_PKEY_PARAM_EC_CHAR2_TYPE "basis-type" | |
305 | #define OSSL_PKEY_PARAM_EC_CHAR2_TP_BASIS "tp" | |
306 | #define OSSL_PKEY_PARAM_EC_CHAR2_PP_K1 "k1" | |
307 | #define OSSL_PKEY_PARAM_EC_CHAR2_PP_K2 "k2" | |
308 | #define OSSL_PKEY_PARAM_EC_CHAR2_PP_K3 "k3" | |
309 | ||
4fe54d67 NT |
310 | /* Elliptic Curve Key Parameters */ |
311 | #define OSSL_PKEY_PARAM_USE_COFACTOR_FLAG "use-cofactor-flag" | |
312 | #define OSSL_PKEY_PARAM_USE_COFACTOR_ECDH \ | |
313 | OSSL_PKEY_PARAM_USE_COFACTOR_FLAG | |
314 | ||
29be6023 RL |
315 | /* RSA Keys */ |
316 | /* | |
317 | * n, e, d are the usual public and private key components | |
318 | * | |
319 | * rsa-num is the number of factors, including p and q | |
320 | * rsa-factor is used for each factor: p, q, r_i (i = 3, ...) | |
321 | * rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...) | |
322 | * rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...) | |
323 | * | |
324 | * The number of rsa-factor items must be equal to the number of rsa-exponent | |
325 | * items, and the number of rsa-coefficients must be one less. | |
326 | * (the base i for the coefficients is 2, not 1, at least as implied by | |
327 | * RFC 8017) | |
328 | */ | |
329 | #define OSSL_PKEY_PARAM_RSA_N "n" | |
330 | #define OSSL_PKEY_PARAM_RSA_E "e" | |
331 | #define OSSL_PKEY_PARAM_RSA_D "d" | |
332 | #define OSSL_PKEY_PARAM_RSA_FACTOR "rsa-factor" | |
333 | #define OSSL_PKEY_PARAM_RSA_EXPONENT "rsa-exponent" | |
334 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient" | |
96ebe52e SL |
335 | #define OSSL_PKEY_PARAM_RSA_FACTOR1 OSSL_PKEY_PARAM_RSA_FACTOR"1" |
336 | #define OSSL_PKEY_PARAM_RSA_FACTOR2 OSSL_PKEY_PARAM_RSA_FACTOR"2" | |
337 | #define OSSL_PKEY_PARAM_RSA_FACTOR3 OSSL_PKEY_PARAM_RSA_FACTOR"3" | |
338 | #define OSSL_PKEY_PARAM_RSA_FACTOR4 OSSL_PKEY_PARAM_RSA_FACTOR"4" | |
339 | #define OSSL_PKEY_PARAM_RSA_FACTOR5 OSSL_PKEY_PARAM_RSA_FACTOR"5" | |
340 | #define OSSL_PKEY_PARAM_RSA_FACTOR6 OSSL_PKEY_PARAM_RSA_FACTOR"6" | |
341 | #define OSSL_PKEY_PARAM_RSA_FACTOR7 OSSL_PKEY_PARAM_RSA_FACTOR"7" | |
342 | #define OSSL_PKEY_PARAM_RSA_FACTOR8 OSSL_PKEY_PARAM_RSA_FACTOR"8" | |
343 | #define OSSL_PKEY_PARAM_RSA_FACTOR9 OSSL_PKEY_PARAM_RSA_FACTOR"9" | |
344 | #define OSSL_PKEY_PARAM_RSA_FACTOR10 OSSL_PKEY_PARAM_RSA_FACTOR"10" | |
345 | #define OSSL_PKEY_PARAM_RSA_EXPONENT1 OSSL_PKEY_PARAM_RSA_EXPONENT"1" | |
346 | #define OSSL_PKEY_PARAM_RSA_EXPONENT2 OSSL_PKEY_PARAM_RSA_EXPONENT"2" | |
347 | #define OSSL_PKEY_PARAM_RSA_EXPONENT3 OSSL_PKEY_PARAM_RSA_EXPONENT"3" | |
348 | #define OSSL_PKEY_PARAM_RSA_EXPONENT4 OSSL_PKEY_PARAM_RSA_EXPONENT"4" | |
349 | #define OSSL_PKEY_PARAM_RSA_EXPONENT5 OSSL_PKEY_PARAM_RSA_EXPONENT"5" | |
350 | #define OSSL_PKEY_PARAM_RSA_EXPONENT6 OSSL_PKEY_PARAM_RSA_EXPONENT"6" | |
351 | #define OSSL_PKEY_PARAM_RSA_EXPONENT7 OSSL_PKEY_PARAM_RSA_EXPONENT"7" | |
352 | #define OSSL_PKEY_PARAM_RSA_EXPONENT8 OSSL_PKEY_PARAM_RSA_EXPONENT"8" | |
353 | #define OSSL_PKEY_PARAM_RSA_EXPONENT9 OSSL_PKEY_PARAM_RSA_EXPONENT"9" | |
354 | #define OSSL_PKEY_PARAM_RSA_EXPONENT10 OSSL_PKEY_PARAM_RSA_EXPONENT"10" | |
355 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT1 OSSL_PKEY_PARAM_RSA_COEFFICIENT"1" | |
356 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT2 OSSL_PKEY_PARAM_RSA_COEFFICIENT"2" | |
357 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT3 OSSL_PKEY_PARAM_RSA_COEFFICIENT"3" | |
358 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT4 OSSL_PKEY_PARAM_RSA_COEFFICIENT"4" | |
359 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT5 OSSL_PKEY_PARAM_RSA_COEFFICIENT"5" | |
360 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT6 OSSL_PKEY_PARAM_RSA_COEFFICIENT"6" | |
361 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT7 OSSL_PKEY_PARAM_RSA_COEFFICIENT"7" | |
362 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT8 OSSL_PKEY_PARAM_RSA_COEFFICIENT"8" | |
363 | #define OSSL_PKEY_PARAM_RSA_COEFFICIENT9 OSSL_PKEY_PARAM_RSA_COEFFICIENT"9" | |
364 | ||
b8086652 SL |
365 | /* RSA padding modes */ |
366 | #define OSSL_PKEY_RSA_PAD_MODE_NONE "none" | |
367 | #define OSSL_PKEY_RSA_PAD_MODE_PKCSV15 "pkcs1" | |
368 | #define OSSL_PKEY_RSA_PAD_MODE_SSLV23 "sslv23" | |
369 | #define OSSL_PKEY_RSA_PAD_MODE_OAEP "oaep" | |
370 | #define OSSL_PKEY_RSA_PAD_MODE_X931 "x931" | |
371 | #define OSSL_PKEY_RSA_PAD_MODE_PSS "pss" | |
372 | ||
373 | /* RSA pss padding salt length */ | |
374 | #define OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST "digest" | |
375 | #define OSSL_PKEY_RSA_PSS_SALT_LEN_MAX "max" | |
376 | #define OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO "auto" | |
96ebe52e | 377 | |
62924755 | 378 | /* Key generation parameters */ |
15671090 RL |
379 | #define OSSL_PKEY_PARAM_RSA_BITS OSSL_PKEY_PARAM_BITS |
380 | #define OSSL_PKEY_PARAM_RSA_PRIMES "primes" | |
381 | #define OSSL_PKEY_PARAM_RSA_DIGEST OSSL_PKEY_PARAM_DIGEST | |
719523c7 | 382 | #define OSSL_PKEY_PARAM_RSA_DIGEST_PROPS OSSL_PKEY_PARAM_PROPERTIES |
15671090 RL |
383 | #define OSSL_PKEY_PARAM_RSA_MASKGENFUNC OSSL_PKEY_PARAM_MASKGENFUNC |
384 | #define OSSL_PKEY_PARAM_RSA_MGF1_DIGEST OSSL_PKEY_PARAM_MGF1_DIGEST | |
385 | #define OSSL_PKEY_PARAM_RSA_PSS_SALTLEN "saltlen" | |
29be6023 | 386 | |
b03ec3b5 SL |
387 | /* Key generation parameters */ |
388 | #define OSSL_PKEY_PARAM_FFC_TYPE "type" | |
389 | #define OSSL_PKEY_PARAM_FFC_PBITS "pbits" | |
390 | #define OSSL_PKEY_PARAM_FFC_QBITS "qbits" | |
391 | #define OSSL_PKEY_PARAM_FFC_DIGEST OSSL_PKEY_PARAM_DIGEST | |
392 | #define OSSL_PKEY_PARAM_FFC_DIGEST_PROPS OSSL_PKEY_PARAM_PROPERTIES | |
393 | ||
c0f39ded SL |
394 | #define OSSL_PKEY_PARAM_EC_ENCODING "encoding" /* utf8_string */ |
395 | ||
396 | /* OSSL_PKEY_PARAM_EC_ENCODING values */ | |
397 | #define OSSL_PKEY_EC_ENCODING_EXPLICIT "explicit" | |
398 | #define OSSL_PKEY_EC_ENCODING_GROUP "named_curve" | |
399 | ||
35aca9ec | 400 | /* Key Exchange parameters */ |
4fe54d67 NT |
401 | #define OSSL_EXCHANGE_PARAM_PAD "pad" /* uint */ |
402 | #define OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE "ecdh-cofactor-mode" /* int */ | |
403 | #define OSSL_EXCHANGE_PARAM_KDF_TYPE "kdf-type" /* utf8_string */ | |
404 | #define OSSL_EXCHANGE_PARAM_KDF_DIGEST "kdf-digest" /* utf8_string */ | |
405 | #define OSSL_EXCHANGE_PARAM_KDF_DIGEST_PROPS "kdf-digest-props" /* utf8_string */ | |
406 | #define OSSL_EXCHANGE_PARAM_KDF_OUTLEN "kdf-outlen" /* size_t */ | |
407 | ||
408 | /* | |
409 | * TODO(3.0): improve this pattern | |
410 | * | |
411 | * Currently the sole internal user of OSSL_EXCHANGE_PARAM_KDF_UKM is | |
412 | * EVP_PKEY_CTX_{set0,get0}_ecdh_kdf_ukm(): | |
413 | * OSSL_EXCHANGE_PARAM_KDF_UKM is handled as a octet_string on set0, | |
414 | * and as an octet_ptr on get0. | |
415 | * | |
416 | * This pattern is borrowed from the handling of | |
417 | * OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL in | |
418 | * EVP_PKEY_CTX_{set0,get0}_rsa_oaep_label(). | |
419 | */ | |
420 | #define OSSL_EXCHANGE_PARAM_KDF_UKM "kdf-ukm" /* see note above */ | |
421 | #define OSSL_EXCHANGE_PARAM_KDF_UKM_LEN "kdf-ukm-len" /* size_t */ | |
35aca9ec | 422 | |
4889dadc | 423 | /* Signature parameters */ |
d5aef594 | 424 | #define OSSL_SIGNATURE_PARAM_ALGORITHM_ID "algorithm-id" |
6f4b7663 | 425 | #define OSSL_SIGNATURE_PARAM_PAD_MODE OSSL_PKEY_PARAM_PAD_MODE |
d5aef594 | 426 | #define OSSL_SIGNATURE_PARAM_DIGEST OSSL_PKEY_PARAM_DIGEST |
8bee6512 | 427 | #define OSSL_SIGNATURE_PARAM_PROPERTIES OSSL_PKEY_PARAM_PROPERTIES |
15671090 | 428 | #define OSSL_SIGNATURE_PARAM_PSS_SALTLEN "saltlen" |
6f4b7663 RL |
429 | #define OSSL_SIGNATURE_PARAM_MGF1_DIGEST OSSL_PKEY_PARAM_MGF1_DIGEST |
430 | #define OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES \ | |
431 | OSSL_PKEY_PARAM_MGF1_PROPERTIES | |
edd3b7a3 | 432 | #define OSSL_SIGNATURE_PARAM_DIGEST_SIZE OSSL_PKEY_PARAM_DIGEST_SIZE |
4889dadc | 433 | |
89abd1b6 | 434 | /* Asym cipher parameters */ |
ce64d3ee MC |
435 | #define OSSL_ASYM_CIPHER_PARAM_DIGEST OSSL_PKEY_PARAM_DIGEST |
436 | #define OSSL_ASYM_CIPHER_PARAM_PROPERTIES OSSL_PKEY_PARAM_PROPERTIES | |
437 | #define OSSL_ASYM_CIPHER_PARAM_ENGINE OSSL_PKEY_PARAM_ENGINE | |
6f4b7663 RL |
438 | #define OSSL_ASYM_CIPHER_PARAM_PAD_MODE OSSL_PKEY_PARAM_PAD_MODE |
439 | #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST \ | |
440 | OSSL_PKEY_PARAM_MGF1_DIGEST | |
441 | #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS \ | |
442 | OSSL_PKEY_PARAM_MGF1_PROPERTIES | |
d9a75107 MC |
443 | #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST OSSL_ALG_PARAM_DIGEST |
444 | #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS "digest-props" | |
d9a75107 MC |
445 | #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL "oaep-label" |
446 | #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN "oaep-label-len" | |
447 | #define OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION "tls-client-version" | |
448 | #define OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION "tls-negotiated-version" | |
89abd1b6 | 449 | |
866234ac | 450 | /* |
ece9304c | 451 | * Encoder / decoder parameters |
866234ac | 452 | */ |
ece9304c RL |
453 | #define OSSL_ENCODER_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER |
454 | #define OSSL_ENCODER_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES | |
5a6d6fe6 RL |
455 | #define OSSL_ENCODER_PARAM_INPUT_TYPE "input-type" |
456 | #define OSSL_ENCODER_PARAM_OUTPUT_TYPE "output-type" | |
ece9304c | 457 | |
ece9304c | 458 | #define OSSL_DECODER_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES |
ece9304c | 459 | #define OSSL_DECODER_PARAM_INPUT_TYPE "input-type" |
c3e4c1f3 | 460 | |
866234ac | 461 | /* Passphrase callback parameters */ |
ece9304c | 462 | #define OSSL_PASSPHRASE_PARAM_INFO "info" |
866234ac | 463 | |
62924755 RL |
464 | /* Keygen callback parameters, from provider to libcrypto */ |
465 | #define OSSL_GEN_PARAM_POTENTIAL "potential" /* integer */ | |
466 | #define OSSL_GEN_PARAM_ITERATION "iteration" /* integer */ | |
467 | ||
4f2271d5 SL |
468 | /* ACVP Test parameters : These should not be used normally */ |
469 | #define OSSL_PKEY_PARAM_RSA_TEST_XP1 "xp1" | |
470 | #define OSSL_PKEY_PARAM_RSA_TEST_XP2 "xp2" | |
471 | #define OSSL_PKEY_PARAM_RSA_TEST_XP "xp" | |
472 | #define OSSL_PKEY_PARAM_RSA_TEST_XQ1 "xq1" | |
473 | #define OSSL_PKEY_PARAM_RSA_TEST_XQ2 "xq2" | |
474 | #define OSSL_PKEY_PARAM_RSA_TEST_XQ "xq" | |
475 | #define OSSL_PKEY_PARAM_RSA_TEST_P1 "p1" | |
476 | #define OSSL_PKEY_PARAM_RSA_TEST_P2 "p2" | |
477 | #define OSSL_PKEY_PARAM_RSA_TEST_Q1 "q1" | |
478 | #define OSSL_PKEY_PARAM_RSA_TEST_Q2 "q2" | |
479 | #define OSSL_SIGNATURE_PARAM_KAT "kat" | |
480 | ||
80f4fd18 SL |
481 | /* KEM parameters */ |
482 | #define OSSL_KEM_PARAM_OPERATION "operation" | |
483 | ||
484 | /* OSSL_KEM_PARAM_OPERATION values */ | |
485 | #define OSSL_KEM_PARAM_OPERATION_RSASVE "RSASVE" | |
486 | ||
72bfc958 MC |
487 | /* Capabilities */ |
488 | ||
80f4fd18 | 489 | /* TLS-GROUP Capability */ |
72bfc958 MC |
490 | #define OSSL_CAPABILITY_TLS_GROUP_NAME "tls-group-name" |
491 | #define OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL "tls-group-name-internal" | |
492 | #define OSSL_CAPABILITY_TLS_GROUP_ID "tls-group-id" | |
493 | #define OSSL_CAPABILITY_TLS_GROUP_ALG "tls-group-alg" | |
494 | #define OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS "tls-group-sec-bits" | |
c1a74f59 | 495 | #define OSSL_CAPABILITY_TLS_GROUP_IS_KEM "tls-group-is-kem" |
72bfc958 MC |
496 | #define OSSL_CAPABILITY_TLS_GROUP_MIN_TLS "tls-min-tls" |
497 | #define OSSL_CAPABILITY_TLS_GROUP_MAX_TLS "tls-max-tls" | |
498 | #define OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS "tls-min-dtls" | |
499 | #define OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS "tls-max-dtls" | |
500 | ||
8704b6bf RL |
501 | /*- |
502 | * storemgmt parameters | |
503 | */ | |
504 | ||
505 | /* | |
506 | * Used by storemgmt_ctx_set_params(): | |
507 | * | |
508 | * - OSSL_STORE_PARAM_EXPECT is an INTEGER, and the value is any of the | |
509 | * OSSL_STORE_INFO numbers. This is used to set the expected type of | |
510 | * object loaded. | |
511 | * | |
512 | * - OSSL_STORE_PARAM_SUBJECT, OSSL_STORE_PARAM_ISSUER, | |
513 | * OSSL_STORE_PARAM_SERIAL, OSSL_STORE_PARAM_FINGERPRINT, | |
514 | * OSSL_STORE_PARAM_DIGEST, OSSL_STORE_PARAM_ALIAS | |
515 | * are used as search criteria. | |
516 | * (OSSL_STORE_PARAM_DIGEST is used with OSSL_STORE_PARAM_FINGERPRINT) | |
517 | */ | |
518 | #define OSSL_STORE_PARAM_EXPECT "expect" /* INTEGER */ | |
519 | #define OSSL_STORE_PARAM_SUBJECT "subject" /* DER blob => OCTET_STRING */ | |
520 | #define OSSL_STORE_PARAM_ISSUER "name" /* DER blob => OCTET_STRING */ | |
521 | #define OSSL_STORE_PARAM_SERIAL "serial" /* INTEGER */ | |
522 | #define OSSL_STORE_PARAM_DIGEST "digest" /* UTF8_STRING */ | |
523 | #define OSSL_STORE_PARAM_FINGERPRINT "fingerprint" /* OCTET_STRING */ | |
524 | #define OSSL_STORE_PARAM_ALIAS "alias" /* UTF8_STRING */ | |
525 | ||
526 | /* You may want to pass properties for the provider implementation to use */ | |
527 | #define OSSL_STORE_PARAM_PROPERTIES "properties" /* utf8_string */ | |
528 | ||
8a73348b MC |
529 | # ifdef __cplusplus |
530 | } | |
531 | # endif | |
532 | ||
533 | #endif |