2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
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
10 #ifndef OPENSSL_CORE_NAMES_H
11 # define OPENSSL_CORE_NAMES_H
18 /* Well known parameter names that core passes to providers */
19 #define OSSL_PROV_PARAM_CORE_VERSION "openssl-version" /* utf8_ptr */
20 #define OSSL_PROV_PARAM_CORE_PROV_NAME "provider-name" /* utf8_ptr */
21 #define OSSL_PROV_PARAM_CORE_MODULE_FILENAME "module-filename" /* utf8_ptr */
23 /* Well known parameter names that Providers can define */
24 #define OSSL_PROV_PARAM_NAME "name" /* utf8_ptr */
25 #define OSSL_PROV_PARAM_VERSION "version" /* utf8_ptr */
26 #define OSSL_PROV_PARAM_BUILDINFO "buildinfo" /* utf8_ptr */
27 #define OSSL_PROV_PARAM_STATUS "status" /* uint */
28 #define OSSL_PROV_PARAM_SECURITY_CHECKS "security-checks" /* uint */
29 #define OSSL_PROV_PARAM_TLS1_PRF_EMS_CHECK "tls1-prf-ems-check" /* uint */
30 #define OSSL_PROV_PARAM_DRBG_TRUNC_DIGEST "drbg-no-trunc-md" /* uint */
32 /* Self test callback parameters */
33 #define OSSL_PROV_PARAM_SELF_TEST_PHASE "st-phase" /* utf8_string */
34 #define OSSL_PROV_PARAM_SELF_TEST_TYPE "st-type" /* utf8_string */
35 #define OSSL_PROV_PARAM_SELF_TEST_DESC "st-desc" /* utf8_string */
38 * Provider-native object abstractions
40 * These are used when a provider wants to pass object data or an object
41 * reference back to libcrypto. This is only useful for provider functions
42 * that take a callback to which an OSSL_PARAM array with these parameters
45 * This set of parameter names is explained in detail in provider-object(7)
46 * (doc/man7/provider-object.pod)
48 #define OSSL_OBJECT_PARAM_TYPE "type" /* INTEGER */
49 #define OSSL_OBJECT_PARAM_DATA_TYPE "data-type" /* UTF8_STRING */
50 #define OSSL_OBJECT_PARAM_DATA_STRUCTURE "data-structure" /* UTF8_STRING */
51 #define OSSL_OBJECT_PARAM_REFERENCE "reference" /* OCTET_STRING */
52 #define OSSL_OBJECT_PARAM_DATA "data" /* OCTET_STRING or UTF8_STRING */
53 #define OSSL_OBJECT_PARAM_DESC "desc" /* UTF8_STRING */
56 * Algorithm parameters
57 * If "engine" or "properties" are specified, they should always be paired
58 * with the algorithm type.
59 * Note these are common names that are shared by many types (such as kdf, mac,
60 * and pkey) e.g: see OSSL_MAC_PARAM_DIGEST below.
62 #define OSSL_ALG_PARAM_DIGEST "digest" /* utf8_string */
63 #define OSSL_ALG_PARAM_CIPHER "cipher" /* utf8_string */
64 #define OSSL_ALG_PARAM_ENGINE "engine" /* utf8_string */
65 #define OSSL_ALG_PARAM_MAC "mac" /* utf8_string */
66 #define OSSL_ALG_PARAM_PROPERTIES "properties"/* utf8_string */
68 /* cipher parameters */
69 #define OSSL_CIPHER_PARAM_PADDING "padding" /* uint */
70 #define OSSL_CIPHER_PARAM_USE_BITS "use-bits" /* uint */
71 #define OSSL_CIPHER_PARAM_TLS_VERSION "tls-version" /* uint */
72 #define OSSL_CIPHER_PARAM_TLS_MAC "tls-mac" /* octet_ptr */
73 #define OSSL_CIPHER_PARAM_TLS_MAC_SIZE "tls-mac-size" /* size_t */
74 #define OSSL_CIPHER_PARAM_MODE "mode" /* uint */
75 #define OSSL_CIPHER_PARAM_BLOCK_SIZE "blocksize" /* size_t */
76 #define OSSL_CIPHER_PARAM_AEAD "aead" /* int, 0 or 1 */
77 #define OSSL_CIPHER_PARAM_CUSTOM_IV "custom-iv" /* int, 0 or 1 */
78 #define OSSL_CIPHER_PARAM_CTS "cts" /* int, 0 or 1 */
79 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK "tls-multi" /* int, 0 or 1 */
80 #define OSSL_CIPHER_PARAM_HAS_RAND_KEY "has-randkey" /* int, 0 or 1 */
81 #define OSSL_CIPHER_PARAM_KEYLEN "keylen" /* size_t */
82 #define OSSL_CIPHER_PARAM_IVLEN "ivlen" /* size_t */
83 #define OSSL_CIPHER_PARAM_IV "iv" /* octet_string OR octet_ptr */
84 #define OSSL_CIPHER_PARAM_UPDATED_IV "updated-iv" /* octet_string OR octet_ptr */
85 #define OSSL_CIPHER_PARAM_NUM "num" /* uint */
86 #define OSSL_CIPHER_PARAM_ROUNDS "rounds" /* uint */
87 #define OSSL_CIPHER_PARAM_AEAD_TAG "tag" /* octet_string */
88 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD "tlsaad" /* octet_string */
89 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD "tlsaadpad" /* size_t */
90 #define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED "tlsivfixed" /* octet_string */
91 #define OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN "tlsivgen" /* octet_string */
92 #define OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV "tlsivinv" /* octet_string */
93 #define OSSL_CIPHER_PARAM_AEAD_IVLEN OSSL_CIPHER_PARAM_IVLEN
94 #define OSSL_CIPHER_PARAM_AEAD_TAGLEN "taglen" /* size_t */
95 #define OSSL_CIPHER_PARAM_AEAD_MAC_KEY "mackey" /* octet_string */
96 #define OSSL_CIPHER_PARAM_RANDOM_KEY "randkey" /* octet_string */
97 #define OSSL_CIPHER_PARAM_RC2_KEYBITS "keybits" /* size_t */
98 #define OSSL_CIPHER_PARAM_SPEED "speed" /* uint */
99 #define OSSL_CIPHER_PARAM_CTS_MODE "cts_mode" /* utf8_string */
100 /* For passing the AlgorithmIdentifier parameter in DER form */
101 #define OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS "alg_id_param" /* octet_string */
102 #define OSSL_CIPHER_PARAM_XTS_STANDARD "xts_standard" /* utf8_string */
104 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT \
105 "tls1multi_maxsndfrag" /* uint */
106 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE \
107 "tls1multi_maxbufsz" /* size_t */
108 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE \
109 "tls1multi_interleave" /* uint */
110 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD \
111 "tls1multi_aad" /* octet_string */
112 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN \
113 "tls1multi_aadpacklen" /* uint */
114 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC \
115 "tls1multi_enc" /* octet_string */
116 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN \
117 "tls1multi_encin" /* octet_string */
118 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN \
119 "tls1multi_enclen" /* size_t */
121 /* OSSL_CIPHER_PARAM_CTS_MODE Values */
122 #define OSSL_CIPHER_CTS_MODE_CS1 "CS1"
123 #define OSSL_CIPHER_CTS_MODE_CS2 "CS2"
124 #define OSSL_CIPHER_CTS_MODE_CS3 "CS3"
126 /* Known CIPHER names (not a complete list) */
127 #define OSSL_CIPHER_NAME_AES_128_GCM_SIV "AES-128-GCM-SIV"
128 #define OSSL_CIPHER_NAME_AES_192_GCM_SIV "AES-192-GCM-SIV"
129 #define OSSL_CIPHER_NAME_AES_256_GCM_SIV "AES-256-GCM-SIV"
131 /* digest parameters */
132 #define OSSL_DIGEST_PARAM_XOFLEN "xoflen" /* size_t */
133 #define OSSL_DIGEST_PARAM_SSL3_MS "ssl3-ms" /* octet string */
134 #define OSSL_DIGEST_PARAM_PAD_TYPE "pad-type" /* uint */
135 #define OSSL_DIGEST_PARAM_MICALG "micalg" /* utf8 string */
136 #define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */
137 #define OSSL_DIGEST_PARAM_SIZE "size" /* size_t */
138 #define OSSL_DIGEST_PARAM_XOF "xof" /* int, 0 or 1 */
139 #define OSSL_DIGEST_PARAM_ALGID_ABSENT "algid-absent" /* int, 0 or 1 */
141 /* Known DIGEST names (not a complete list) */
142 #define OSSL_DIGEST_NAME_MD5 "MD5"
143 #define OSSL_DIGEST_NAME_MD5_SHA1 "MD5-SHA1"
144 #define OSSL_DIGEST_NAME_SHA1 "SHA1"
145 #define OSSL_DIGEST_NAME_SHA2_224 "SHA2-224"
146 #define OSSL_DIGEST_NAME_SHA2_256 "SHA2-256"
147 #define OSSL_DIGEST_NAME_SHA2_384 "SHA2-384"
148 #define OSSL_DIGEST_NAME_SHA2_512 "SHA2-512"
149 #define OSSL_DIGEST_NAME_SHA2_512_224 "SHA2-512/224"
150 #define OSSL_DIGEST_NAME_SHA2_512_256 "SHA2-512/256"
151 #define OSSL_DIGEST_NAME_MD2 "MD2"
152 #define OSSL_DIGEST_NAME_MD4 "MD4"
153 #define OSSL_DIGEST_NAME_MDC2 "MDC2"
154 #define OSSL_DIGEST_NAME_RIPEMD160 "RIPEMD160"
155 #define OSSL_DIGEST_NAME_SHA3_224 "SHA3-224"
156 #define OSSL_DIGEST_NAME_SHA3_256 "SHA3-256"
157 #define OSSL_DIGEST_NAME_SHA3_384 "SHA3-384"
158 #define OSSL_DIGEST_NAME_SHA3_512 "SHA3-512"
159 #define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128"
160 #define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256"
161 #define OSSL_DIGEST_NAME_SM3 "SM3"
164 #define OSSL_MAC_PARAM_KEY "key" /* octet string */
165 #define OSSL_MAC_PARAM_IV "iv" /* octet string */
166 #define OSSL_MAC_PARAM_CUSTOM "custom" /* utf8 string */
167 #define OSSL_MAC_PARAM_SALT "salt" /* octet string */
168 #define OSSL_MAC_PARAM_XOF "xof" /* int, 0 or 1 */
169 #define OSSL_MAC_PARAM_DIGEST_NOINIT "digest-noinit" /* int, 0 or 1 */
170 #define OSSL_MAC_PARAM_DIGEST_ONESHOT "digest-oneshot" /* int, 0 or 1 */
171 #define OSSL_MAC_PARAM_C_ROUNDS "c-rounds" /* unsigned int */
172 #define OSSL_MAC_PARAM_D_ROUNDS "d-rounds" /* unsigned int */
175 * If "engine" or "properties" are specified, they should always be paired
176 * with "cipher" or "digest".
178 #define OSSL_MAC_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
179 #define OSSL_MAC_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */
180 #define OSSL_MAC_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
181 #define OSSL_MAC_PARAM_SIZE "size" /* size_t */
182 #define OSSL_MAC_PARAM_BLOCK_SIZE "block-size" /* size_t */
183 #define OSSL_MAC_PARAM_TLS_DATA_SIZE "tls-data-size" /* size_t */
185 /* Known MAC names */
186 #define OSSL_MAC_NAME_BLAKE2BMAC "BLAKE2BMAC"
187 #define OSSL_MAC_NAME_BLAKE2SMAC "BLAKE2SMAC"
188 #define OSSL_MAC_NAME_CMAC "CMAC"
189 #define OSSL_MAC_NAME_GMAC "GMAC"
190 #define OSSL_MAC_NAME_HMAC "HMAC"
191 #define OSSL_MAC_NAME_KMAC128 "KMAC128"
192 #define OSSL_MAC_NAME_KMAC256 "KMAC256"
193 #define OSSL_MAC_NAME_POLY1305 "POLY1305"
194 #define OSSL_MAC_NAME_SIPHASH "SIPHASH"
196 /* KDF / PRF parameters */
197 #define OSSL_KDF_PARAM_SECRET "secret" /* octet string */
198 #define OSSL_KDF_PARAM_KEY "key" /* octet string */
199 #define OSSL_KDF_PARAM_SALT "salt" /* octet string */
200 #define OSSL_KDF_PARAM_PASSWORD "pass" /* octet string */
201 #define OSSL_KDF_PARAM_PREFIX "prefix" /* octet string */
202 #define OSSL_KDF_PARAM_LABEL "label" /* octet string */
203 #define OSSL_KDF_PARAM_DATA "data" /* octet string */
204 #define OSSL_KDF_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */
205 #define OSSL_KDF_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
206 #define OSSL_KDF_PARAM_MAC OSSL_ALG_PARAM_MAC /* utf8 string */
207 #define OSSL_KDF_PARAM_MAC_SIZE "maclen" /* size_t */
208 #define OSSL_KDF_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
209 #define OSSL_KDF_PARAM_ITER "iter" /* unsigned int */
210 #define OSSL_KDF_PARAM_MODE "mode" /* utf8 string or int */
211 #define OSSL_KDF_PARAM_PKCS5 "pkcs5" /* int */
212 #define OSSL_KDF_PARAM_UKM "ukm" /* octet string */
213 #define OSSL_KDF_PARAM_CEK_ALG "cekalg" /* utf8 string */
214 #define OSSL_KDF_PARAM_SCRYPT_N "n" /* uint64_t */
215 #define OSSL_KDF_PARAM_SCRYPT_R "r" /* uint32_t */
216 #define OSSL_KDF_PARAM_SCRYPT_P "p" /* uint32_t */
217 #define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */
218 #define OSSL_KDF_PARAM_INFO "info" /* octet string */
219 #define OSSL_KDF_PARAM_SEED "seed" /* octet string */
220 #define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */
221 #define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */
222 #define OSSL_KDF_PARAM_SSHKDF_TYPE "type" /* int */
223 #define OSSL_KDF_PARAM_SIZE "size" /* size_t */
224 #define OSSL_KDF_PARAM_CONSTANT "constant" /* octet string */
225 #define OSSL_KDF_PARAM_PKCS12_ID "id" /* int */
226 #define OSSL_KDF_PARAM_KBKDF_USE_L "use-l" /* int */
227 #define OSSL_KDF_PARAM_KBKDF_USE_SEPARATOR "use-separator" /* int */
228 #define OSSL_KDF_PARAM_KBKDF_R "r" /* int */
229 #define OSSL_KDF_PARAM_X942_ACVPINFO "acvp-info"
230 #define OSSL_KDF_PARAM_X942_PARTYUINFO "partyu-info"
231 #define OSSL_KDF_PARAM_X942_PARTYVINFO "partyv-info"
232 #define OSSL_KDF_PARAM_X942_SUPP_PUBINFO "supp-pubinfo"
233 #define OSSL_KDF_PARAM_X942_SUPP_PRIVINFO "supp-privinfo"
234 #define OSSL_KDF_PARAM_X942_USE_KEYBITS "use-keybits"
235 #define OSSL_KDF_PARAM_HMACDRBG_ENTROPY "entropy"
236 #define OSSL_KDF_PARAM_HMACDRBG_NONCE "nonce"
237 #define OSSL_KDF_PARAM_THREADS "threads" /* uint32_t */
238 #define OSSL_KDF_PARAM_EARLY_CLEAN "early_clean" /* uint32_t */
239 #define OSSL_KDF_PARAM_ARGON2_AD "ad" /* octet string */
240 #define OSSL_KDF_PARAM_ARGON2_LANES "lanes" /* uint32_t */
241 #define OSSL_KDF_PARAM_ARGON2_MEMCOST "memcost" /* uint32_t */
242 #define OSSL_KDF_PARAM_ARGON2_VERSION "version" /* uint32_t */
244 /* Known KDF names */
245 #define OSSL_KDF_NAME_HKDF "HKDF"
246 #define OSSL_KDF_NAME_TLS1_3_KDF "TLS13-KDF"
247 #define OSSL_KDF_NAME_PBKDF1 "PBKDF1"
248 #define OSSL_KDF_NAME_PBKDF2 "PBKDF2"
249 #define OSSL_KDF_NAME_SCRYPT "SCRYPT"
250 #define OSSL_KDF_NAME_SSHKDF "SSHKDF"
251 #define OSSL_KDF_NAME_SSKDF "SSKDF"
252 #define OSSL_KDF_NAME_TLS1_PRF "TLS1-PRF"
253 #define OSSL_KDF_NAME_X942KDF_ASN1 "X942KDF-ASN1"
254 #define OSSL_KDF_NAME_X942KDF_CONCAT "X942KDF-CONCAT"
255 #define OSSL_KDF_NAME_X963KDF "X963KDF"
256 #define OSSL_KDF_NAME_KBKDF "KBKDF"
257 #define OSSL_KDF_NAME_KRB5KDF "KRB5KDF"
258 #define OSSL_KDF_NAME_HMACDRBGKDF "HMAC-DRBG-KDF"
260 /* Known RAND names */
261 #define OSSL_RAND_PARAM_STATE "state"
262 #define OSSL_RAND_PARAM_STRENGTH "strength"
263 #define OSSL_RAND_PARAM_MAX_REQUEST "max_request"
264 #define OSSL_RAND_PARAM_TEST_ENTROPY "test_entropy"
265 #define OSSL_RAND_PARAM_TEST_NONCE "test_nonce"
267 /* RAND/DRBG names */
268 #define OSSL_DRBG_PARAM_RESEED_REQUESTS "reseed_requests"
269 #define OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL "reseed_time_interval"
270 #define OSSL_DRBG_PARAM_MIN_ENTROPYLEN "min_entropylen"
271 #define OSSL_DRBG_PARAM_MAX_ENTROPYLEN "max_entropylen"
272 #define OSSL_DRBG_PARAM_MIN_NONCELEN "min_noncelen"
273 #define OSSL_DRBG_PARAM_MAX_NONCELEN "max_noncelen"
274 #define OSSL_DRBG_PARAM_MAX_PERSLEN "max_perslen"
275 #define OSSL_DRBG_PARAM_MAX_ADINLEN "max_adinlen"
276 #define OSSL_DRBG_PARAM_RESEED_COUNTER "reseed_counter"
277 #define OSSL_DRBG_PARAM_RESEED_TIME "reseed_time"
278 #define OSSL_DRBG_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
279 #define OSSL_DRBG_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST
280 #define OSSL_DRBG_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER
281 #define OSSL_DRBG_PARAM_MAC OSSL_ALG_PARAM_MAC
282 #define OSSL_DRBG_PARAM_USE_DF "use_derivation_function"
284 /* DRBG call back parameters */
285 #define OSSL_DRBG_PARAM_ENTROPY_REQUIRED "entropy_required"
286 #define OSSL_DRBG_PARAM_PREDICTION_RESISTANCE "prediction_resistance"
287 #define OSSL_DRBG_PARAM_MIN_LENGTH "minium_length"
288 #define OSSL_DRBG_PARAM_MAX_LENGTH "maxium_length"
289 #define OSSL_DRBG_PARAM_RANDOM_DATA "random_data"
290 #define OSSL_DRBG_PARAM_SIZE "size"
292 /* PKEY parameters */
293 /* Common PKEY parameters */
294 #define OSSL_PKEY_PARAM_BITS "bits" /* integer */
295 #define OSSL_PKEY_PARAM_MAX_SIZE "max-size" /* integer */
296 #define OSSL_PKEY_PARAM_SECURITY_BITS "security-bits" /* integer */
297 #define OSSL_PKEY_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST
298 #define OSSL_PKEY_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
299 #define OSSL_PKEY_PARAM_ENGINE OSSL_ALG_PARAM_ENGINE /* utf8 string */
300 #define OSSL_PKEY_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
301 #define OSSL_PKEY_PARAM_DEFAULT_DIGEST "default-digest" /* utf8 string */
302 #define OSSL_PKEY_PARAM_MANDATORY_DIGEST "mandatory-digest" /* utf8 string */
303 #define OSSL_PKEY_PARAM_PAD_MODE "pad-mode"
304 #define OSSL_PKEY_PARAM_DIGEST_SIZE "digest-size"
305 #define OSSL_PKEY_PARAM_MASKGENFUNC "mgf"
306 #define OSSL_PKEY_PARAM_MGF1_DIGEST "mgf1-digest"
307 #define OSSL_PKEY_PARAM_MGF1_PROPERTIES "mgf1-properties"
308 #define OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY "encoded-pub-key"
309 #define OSSL_PKEY_PARAM_GROUP_NAME "group"
310 #define OSSL_PKEY_PARAM_DIST_ID "distid"
311 #define OSSL_PKEY_PARAM_PUB_KEY "pub"
312 #define OSSL_PKEY_PARAM_PRIV_KEY "priv"
313 #define OSSL_PKEY_PARAM_IMPLICIT_REJECTION "implicit-rejection"
315 /* Diffie-Hellman/DSA Parameters */
316 #define OSSL_PKEY_PARAM_FFC_P "p"
317 #define OSSL_PKEY_PARAM_FFC_G "g"
318 #define OSSL_PKEY_PARAM_FFC_Q "q"
319 #define OSSL_PKEY_PARAM_FFC_GINDEX "gindex"
320 #define OSSL_PKEY_PARAM_FFC_PCOUNTER "pcounter"
321 #define OSSL_PKEY_PARAM_FFC_SEED "seed"
322 #define OSSL_PKEY_PARAM_FFC_COFACTOR "j"
323 #define OSSL_PKEY_PARAM_FFC_H "hindex"
324 #define OSSL_PKEY_PARAM_FFC_VALIDATE_PQ "validate-pq"
325 #define OSSL_PKEY_PARAM_FFC_VALIDATE_G "validate-g"
326 #define OSSL_PKEY_PARAM_FFC_VALIDATE_LEGACY "validate-legacy"
328 /* Diffie-Hellman params */
329 #define OSSL_PKEY_PARAM_DH_GENERATOR "safeprime-generator"
330 #define OSSL_PKEY_PARAM_DH_PRIV_LEN "priv_len"
332 /* Elliptic Curve Domain Parameters */
333 #define OSSL_PKEY_PARAM_EC_PUB_X "qx"
334 #define OSSL_PKEY_PARAM_EC_PUB_Y "qy"
336 /* Elliptic Curve Explicit Domain Parameters */
337 #define OSSL_PKEY_PARAM_EC_FIELD_TYPE "field-type"
338 #define OSSL_PKEY_PARAM_EC_P "p"
339 #define OSSL_PKEY_PARAM_EC_A "a"
340 #define OSSL_PKEY_PARAM_EC_B "b"
341 #define OSSL_PKEY_PARAM_EC_GENERATOR "generator"
342 #define OSSL_PKEY_PARAM_EC_ORDER "order"
343 #define OSSL_PKEY_PARAM_EC_COFACTOR "cofactor"
344 #define OSSL_PKEY_PARAM_EC_SEED "seed"
345 #define OSSL_PKEY_PARAM_EC_CHAR2_M "m"
346 #define OSSL_PKEY_PARAM_EC_CHAR2_TYPE "basis-type"
347 #define OSSL_PKEY_PARAM_EC_CHAR2_TP_BASIS "tp"
348 #define OSSL_PKEY_PARAM_EC_CHAR2_PP_K1 "k1"
349 #define OSSL_PKEY_PARAM_EC_CHAR2_PP_K2 "k2"
350 #define OSSL_PKEY_PARAM_EC_CHAR2_PP_K3 "k3"
351 #define OSSL_PKEY_PARAM_EC_DECODED_FROM_EXPLICIT_PARAMS "decoded-from-explicit"
353 /* Elliptic Curve Key Parameters */
354 #define OSSL_PKEY_PARAM_USE_COFACTOR_FLAG "use-cofactor-flag"
355 #define OSSL_PKEY_PARAM_USE_COFACTOR_ECDH \
356 OSSL_PKEY_PARAM_USE_COFACTOR_FLAG
360 * n, e, d are the usual public and private key components
362 * rsa-num is the number of factors, including p and q
363 * rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
364 * rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
365 * rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
367 * The number of rsa-factor items must be equal to the number of rsa-exponent
368 * items, and the number of rsa-coefficients must be one less.
369 * (the base i for the coefficients is 2, not 1, at least as implied by
372 #define OSSL_PKEY_PARAM_RSA_N "n"
373 #define OSSL_PKEY_PARAM_RSA_E "e"
374 #define OSSL_PKEY_PARAM_RSA_D "d"
375 #define OSSL_PKEY_PARAM_RSA_FACTOR "rsa-factor"
376 #define OSSL_PKEY_PARAM_RSA_EXPONENT "rsa-exponent"
377 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient"
378 #define OSSL_PKEY_PARAM_RSA_FACTOR1 OSSL_PKEY_PARAM_RSA_FACTOR"1"
379 #define OSSL_PKEY_PARAM_RSA_FACTOR2 OSSL_PKEY_PARAM_RSA_FACTOR"2"
380 #define OSSL_PKEY_PARAM_RSA_FACTOR3 OSSL_PKEY_PARAM_RSA_FACTOR"3"
381 #define OSSL_PKEY_PARAM_RSA_FACTOR4 OSSL_PKEY_PARAM_RSA_FACTOR"4"
382 #define OSSL_PKEY_PARAM_RSA_FACTOR5 OSSL_PKEY_PARAM_RSA_FACTOR"5"
383 #define OSSL_PKEY_PARAM_RSA_FACTOR6 OSSL_PKEY_PARAM_RSA_FACTOR"6"
384 #define OSSL_PKEY_PARAM_RSA_FACTOR7 OSSL_PKEY_PARAM_RSA_FACTOR"7"
385 #define OSSL_PKEY_PARAM_RSA_FACTOR8 OSSL_PKEY_PARAM_RSA_FACTOR"8"
386 #define OSSL_PKEY_PARAM_RSA_FACTOR9 OSSL_PKEY_PARAM_RSA_FACTOR"9"
387 #define OSSL_PKEY_PARAM_RSA_FACTOR10 OSSL_PKEY_PARAM_RSA_FACTOR"10"
388 #define OSSL_PKEY_PARAM_RSA_EXPONENT1 OSSL_PKEY_PARAM_RSA_EXPONENT"1"
389 #define OSSL_PKEY_PARAM_RSA_EXPONENT2 OSSL_PKEY_PARAM_RSA_EXPONENT"2"
390 #define OSSL_PKEY_PARAM_RSA_EXPONENT3 OSSL_PKEY_PARAM_RSA_EXPONENT"3"
391 #define OSSL_PKEY_PARAM_RSA_EXPONENT4 OSSL_PKEY_PARAM_RSA_EXPONENT"4"
392 #define OSSL_PKEY_PARAM_RSA_EXPONENT5 OSSL_PKEY_PARAM_RSA_EXPONENT"5"
393 #define OSSL_PKEY_PARAM_RSA_EXPONENT6 OSSL_PKEY_PARAM_RSA_EXPONENT"6"
394 #define OSSL_PKEY_PARAM_RSA_EXPONENT7 OSSL_PKEY_PARAM_RSA_EXPONENT"7"
395 #define OSSL_PKEY_PARAM_RSA_EXPONENT8 OSSL_PKEY_PARAM_RSA_EXPONENT"8"
396 #define OSSL_PKEY_PARAM_RSA_EXPONENT9 OSSL_PKEY_PARAM_RSA_EXPONENT"9"
397 #define OSSL_PKEY_PARAM_RSA_EXPONENT10 OSSL_PKEY_PARAM_RSA_EXPONENT"10"
398 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT1 OSSL_PKEY_PARAM_RSA_COEFFICIENT"1"
399 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT2 OSSL_PKEY_PARAM_RSA_COEFFICIENT"2"
400 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT3 OSSL_PKEY_PARAM_RSA_COEFFICIENT"3"
401 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT4 OSSL_PKEY_PARAM_RSA_COEFFICIENT"4"
402 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT5 OSSL_PKEY_PARAM_RSA_COEFFICIENT"5"
403 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT6 OSSL_PKEY_PARAM_RSA_COEFFICIENT"6"
404 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT7 OSSL_PKEY_PARAM_RSA_COEFFICIENT"7"
405 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT8 OSSL_PKEY_PARAM_RSA_COEFFICIENT"8"
406 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT9 OSSL_PKEY_PARAM_RSA_COEFFICIENT"9"
408 /* RSA padding modes */
409 #define OSSL_PKEY_RSA_PAD_MODE_NONE "none"
410 #define OSSL_PKEY_RSA_PAD_MODE_PKCSV15 "pkcs1"
411 #define OSSL_PKEY_RSA_PAD_MODE_OAEP "oaep"
412 #define OSSL_PKEY_RSA_PAD_MODE_X931 "x931"
413 #define OSSL_PKEY_RSA_PAD_MODE_PSS "pss"
415 /* RSA pss padding salt length */
416 #define OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST "digest"
417 #define OSSL_PKEY_RSA_PSS_SALT_LEN_MAX "max"
418 #define OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO "auto"
419 #define OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO_DIGEST_MAX "auto-digestmax"
421 /* Key generation parameters */
422 #define OSSL_PKEY_PARAM_RSA_BITS OSSL_PKEY_PARAM_BITS
423 #define OSSL_PKEY_PARAM_RSA_PRIMES "primes"
424 #define OSSL_PKEY_PARAM_RSA_DIGEST OSSL_PKEY_PARAM_DIGEST
425 #define OSSL_PKEY_PARAM_RSA_DIGEST_PROPS OSSL_PKEY_PARAM_PROPERTIES
426 #define OSSL_PKEY_PARAM_RSA_MASKGENFUNC OSSL_PKEY_PARAM_MASKGENFUNC
427 #define OSSL_PKEY_PARAM_RSA_MGF1_DIGEST OSSL_PKEY_PARAM_MGF1_DIGEST
428 #define OSSL_PKEY_PARAM_RSA_PSS_SALTLEN "saltlen"
430 /* EC, X25519 and X448 Key generation parameters */
431 #define OSSL_PKEY_PARAM_DHKEM_IKM "dhkem-ikm"
433 /* Key generation parameters */
434 #define OSSL_PKEY_PARAM_FFC_TYPE "type"
435 #define OSSL_PKEY_PARAM_FFC_PBITS "pbits"
436 #define OSSL_PKEY_PARAM_FFC_QBITS "qbits"
437 #define OSSL_PKEY_PARAM_FFC_DIGEST OSSL_PKEY_PARAM_DIGEST
438 #define OSSL_PKEY_PARAM_FFC_DIGEST_PROPS OSSL_PKEY_PARAM_PROPERTIES
440 #define OSSL_PKEY_PARAM_EC_ENCODING "encoding" /* utf8_string */
441 #define OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT "point-format"
442 #define OSSL_PKEY_PARAM_EC_GROUP_CHECK_TYPE "group-check"
443 #define OSSL_PKEY_PARAM_EC_INCLUDE_PUBLIC "include-public"
445 /* OSSL_PKEY_PARAM_EC_ENCODING values */
446 #define OSSL_PKEY_EC_ENCODING_EXPLICIT "explicit"
447 #define OSSL_PKEY_EC_ENCODING_GROUP "named_curve"
449 #define OSSL_PKEY_EC_POINT_CONVERSION_FORMAT_UNCOMPRESSED "uncompressed"
450 #define OSSL_PKEY_EC_POINT_CONVERSION_FORMAT_COMPRESSED "compressed"
451 #define OSSL_PKEY_EC_POINT_CONVERSION_FORMAT_HYBRID "hybrid"
453 #define OSSL_PKEY_EC_GROUP_CHECK_DEFAULT "default"
454 #define OSSL_PKEY_EC_GROUP_CHECK_NAMED "named"
455 #define OSSL_PKEY_EC_GROUP_CHECK_NAMED_NIST "named-nist"
457 /* Key Exchange parameters */
458 #define OSSL_EXCHANGE_PARAM_PAD "pad" /* uint */
459 #define OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE "ecdh-cofactor-mode" /* int */
460 #define OSSL_EXCHANGE_PARAM_KDF_TYPE "kdf-type" /* utf8_string */
461 #define OSSL_EXCHANGE_PARAM_KDF_DIGEST "kdf-digest" /* utf8_string */
462 #define OSSL_EXCHANGE_PARAM_KDF_DIGEST_PROPS "kdf-digest-props" /* utf8_string */
463 #define OSSL_EXCHANGE_PARAM_KDF_OUTLEN "kdf-outlen" /* size_t */
464 /* The following parameter is an octet_string on set and an octet_ptr on get */
465 #define OSSL_EXCHANGE_PARAM_KDF_UKM "kdf-ukm"
467 /* Signature parameters */
468 #define OSSL_SIGNATURE_PARAM_ALGORITHM_ID "algorithm-id"
469 #define OSSL_SIGNATURE_PARAM_PAD_MODE OSSL_PKEY_PARAM_PAD_MODE
470 #define OSSL_SIGNATURE_PARAM_DIGEST OSSL_PKEY_PARAM_DIGEST
471 #define OSSL_SIGNATURE_PARAM_PROPERTIES OSSL_PKEY_PARAM_PROPERTIES
472 #define OSSL_SIGNATURE_PARAM_PSS_SALTLEN "saltlen"
473 #define OSSL_SIGNATURE_PARAM_MGF1_DIGEST OSSL_PKEY_PARAM_MGF1_DIGEST
474 #define OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES \
475 OSSL_PKEY_PARAM_MGF1_PROPERTIES
476 #define OSSL_SIGNATURE_PARAM_DIGEST_SIZE OSSL_PKEY_PARAM_DIGEST_SIZE
477 #define OSSL_SIGNATURE_PARAM_NONCE_TYPE "nonce-type"
478 #define OSSL_SIGNATURE_PARAM_INSTANCE "instance"
479 #define OSSL_SIGNATURE_PARAM_CONTEXT_STRING "context-string"
481 /* Asym cipher parameters */
482 #define OSSL_ASYM_CIPHER_PARAM_DIGEST OSSL_PKEY_PARAM_DIGEST
483 #define OSSL_ASYM_CIPHER_PARAM_PROPERTIES OSSL_PKEY_PARAM_PROPERTIES
484 #define OSSL_ASYM_CIPHER_PARAM_ENGINE OSSL_PKEY_PARAM_ENGINE
485 #define OSSL_ASYM_CIPHER_PARAM_PAD_MODE OSSL_PKEY_PARAM_PAD_MODE
486 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST \
487 OSSL_PKEY_PARAM_MGF1_DIGEST
488 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS \
489 OSSL_PKEY_PARAM_MGF1_PROPERTIES
490 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST OSSL_ALG_PARAM_DIGEST
491 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS "digest-props"
492 /* The following parameter is an octet_string on set and an octet_ptr on get */
493 #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL "oaep-label"
494 #define OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION "tls-client-version"
495 #define OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION "tls-negotiated-version"
496 #define OSSL_ASYM_CIPHER_PARAM_IMPLICIT_REJECTION "implicit-rejection"
499 * Encoder / decoder parameters
501 #define OSSL_ENCODER_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER
502 #define OSSL_ENCODER_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
503 /* Currently PVK only, but reusable for others as needed */
504 #define OSSL_ENCODER_PARAM_ENCRYPT_LEVEL "encrypt-level"
505 #define OSSL_ENCODER_PARAM_SAVE_PARAMETERS "save-parameters" /* integer */
507 #define OSSL_DECODER_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
509 /* Passphrase callback parameters */
510 #define OSSL_PASSPHRASE_PARAM_INFO "info"
512 /* Keygen callback parameters, from provider to libcrypto */
513 #define OSSL_GEN_PARAM_POTENTIAL "potential" /* integer */
514 #define OSSL_GEN_PARAM_ITERATION "iteration" /* integer */
516 /* ACVP Test parameters : These should not be used normally */
517 #define OSSL_PKEY_PARAM_RSA_TEST_XP1 "xp1"
518 #define OSSL_PKEY_PARAM_RSA_TEST_XP2 "xp2"
519 #define OSSL_PKEY_PARAM_RSA_TEST_XP "xp"
520 #define OSSL_PKEY_PARAM_RSA_TEST_XQ1 "xq1"
521 #define OSSL_PKEY_PARAM_RSA_TEST_XQ2 "xq2"
522 #define OSSL_PKEY_PARAM_RSA_TEST_XQ "xq"
523 #define OSSL_PKEY_PARAM_RSA_TEST_P1 "p1"
524 #define OSSL_PKEY_PARAM_RSA_TEST_P2 "p2"
525 #define OSSL_PKEY_PARAM_RSA_TEST_Q1 "q1"
526 #define OSSL_PKEY_PARAM_RSA_TEST_Q2 "q2"
527 #define OSSL_SIGNATURE_PARAM_KAT "kat"
530 #define OSSL_KEM_PARAM_OPERATION "operation"
531 #define OSSL_KEM_PARAM_IKME "ikme"
533 /* OSSL_KEM_PARAM_OPERATION values */
534 #define OSSL_KEM_PARAM_OPERATION_RSASVE "RSASVE"
535 #define OSSL_KEM_PARAM_OPERATION_DHKEM "DHKEM"
539 /* TLS-GROUP Capability */
540 #define OSSL_CAPABILITY_TLS_GROUP_NAME "tls-group-name"
541 #define OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL "tls-group-name-internal"
542 #define OSSL_CAPABILITY_TLS_GROUP_ID "tls-group-id"
543 #define OSSL_CAPABILITY_TLS_GROUP_ALG "tls-group-alg"
544 #define OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS "tls-group-sec-bits"
545 #define OSSL_CAPABILITY_TLS_GROUP_IS_KEM "tls-group-is-kem"
546 #define OSSL_CAPABILITY_TLS_GROUP_MIN_TLS "tls-min-tls"
547 #define OSSL_CAPABILITY_TLS_GROUP_MAX_TLS "tls-max-tls"
548 #define OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS "tls-min-dtls"
549 #define OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS "tls-max-dtls"
551 /* TLS-SIGALG Capability */
552 #define OSSL_CAPABILITY_TLS_SIGALG_IANA_NAME "tls-sigalg-iana-name"
553 #define OSSL_CAPABILITY_TLS_SIGALG_CODE_POINT "tls-sigalg-code-point"
554 #define OSSL_CAPABILITY_TLS_SIGALG_NAME "tls-sigalg-name"
555 #define OSSL_CAPABILITY_TLS_SIGALG_OID "tls-sigalg-oid"
556 #define OSSL_CAPABILITY_TLS_SIGALG_SIG_NAME "tls-sigalg-sig-name"
557 #define OSSL_CAPABILITY_TLS_SIGALG_SIG_OID "tls-sigalg-sig-oid"
558 #define OSSL_CAPABILITY_TLS_SIGALG_HASH_NAME "tls-sigalg-hash-name"
559 #define OSSL_CAPABILITY_TLS_SIGALG_HASH_OID "tls-sigalg-hash-oid"
560 #define OSSL_CAPABILITY_TLS_SIGALG_KEYTYPE "tls-sigalg-keytype"
561 #define OSSL_CAPABILITY_TLS_SIGALG_KEYTYPE_OID "tls-sigalg-keytype-oid"
562 #define OSSL_CAPABILITY_TLS_SIGALG_SECURITY_BITS "tls-sigalg-sec-bits"
563 #define OSSL_CAPABILITY_TLS_SIGALG_MIN_TLS "tls-min-tls"
564 #define OSSL_CAPABILITY_TLS_SIGALG_MAX_TLS "tls-max-tls"
567 * storemgmt parameters
571 * Used by storemgmt_ctx_set_params():
573 * - OSSL_STORE_PARAM_EXPECT is an INTEGER, and the value is any of the
574 * OSSL_STORE_INFO numbers. This is used to set the expected type of
577 * - OSSL_STORE_PARAM_SUBJECT, OSSL_STORE_PARAM_ISSUER,
578 * OSSL_STORE_PARAM_SERIAL, OSSL_STORE_PARAM_FINGERPRINT,
579 * OSSL_STORE_PARAM_DIGEST, OSSL_STORE_PARAM_ALIAS
580 * are used as search criteria.
581 * (OSSL_STORE_PARAM_DIGEST is used with OSSL_STORE_PARAM_FINGERPRINT)
583 #define OSSL_STORE_PARAM_EXPECT "expect" /* INTEGER */
584 #define OSSL_STORE_PARAM_SUBJECT "subject" /* DER blob => OCTET_STRING */
585 #define OSSL_STORE_PARAM_ISSUER "name" /* DER blob => OCTET_STRING */
586 #define OSSL_STORE_PARAM_SERIAL "serial" /* INTEGER */
587 #define OSSL_STORE_PARAM_DIGEST "digest" /* UTF8_STRING */
588 #define OSSL_STORE_PARAM_FINGERPRINT "fingerprint" /* OCTET_STRING */
589 #define OSSL_STORE_PARAM_ALIAS "alias" /* UTF8_STRING */
591 /* You may want to pass properties for the provider implementation to use */
592 #define OSSL_STORE_PARAM_PROPERTIES "properties" /* utf8_string */
593 /* OSSL_DECODER input type if a decoder is used by the store */
594 #define OSSL_STORE_PARAM_INPUT_TYPE "input-type" /* UTF8_STRING */
597 /* Libssl record layer */
599 #define OSSL_LIBSSL_RECORD_LAYER_PARAM_OPTIONS "options"
600 #define OSSL_LIBSSL_RECORD_LAYER_PARAM_MODE "mode"
601 #define OSSL_LIBSSL_RECORD_LAYER_PARAM_READ_AHEAD "read_ahead"
602 #define OSSL_LIBSSL_RECORD_LAYER_READ_BUFFER_LEN "read_buffer_len"
603 #define OSSL_LIBSSL_RECORD_LAYER_PARAM_USE_ETM "use_etm"
604 #define OSSL_LIBSSL_RECORD_LAYER_PARAM_STREAM_MAC "stream_mac"
605 #define OSSL_LIBSSL_RECORD_LAYER_PARAM_TLSTREE "tlstree"
606 #define OSSL_LIBSSL_RECORD_LAYER_PARAM_MAX_FRAG_LEN "max_frag_len"
607 #define OSSL_LIBSSL_RECORD_LAYER_PARAM_MAX_EARLY_DATA "max_early_data"
608 #define OSSL_LIBSSL_RECORD_LAYER_PARAM_BLOCK_PADDING "block_padding"