]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/core_names.h
Move the record padding callback fully into the record layer
[thirdparty/openssl.git] / include / openssl / core_names.h
CommitLineData
8a73348b 1/*
4333b89f 2 * Copyright 2019-2021 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
d59068bd 12# pragma once
8a73348b
MC
13
14# ifdef __cplusplus
15extern "C" {
16# endif
17
b8086652
SL
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 */
22
36fc5fc6 23/* Well known parameter names that Providers can define */
809526a0
MB
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 */
04cb5ec0 27#define OSSL_PROV_PARAM_STATUS "status" /* uint */
991a6bb5 28#define OSSL_PROV_PARAM_SECURITY_CHECKS "security-checks" /* uint */
8a73348b 29
36fc5fc6
SL
30/* Self test callback parameters */
31#define OSSL_PROV_PARAM_SELF_TEST_PHASE "st-phase" /* utf8_string */
32#define OSSL_PROV_PARAM_SELF_TEST_TYPE "st-type" /* utf8_string */
33#define OSSL_PROV_PARAM_SELF_TEST_DESC "st-desc" /* utf8_string */
df05f2ce 34
14c8a3d1
RL
35/*-
36 * Provider-native object abstractions
37 *
38 * These are used when a provider wants to pass object data or an object
39 * reference back to libcrypto. This is only useful for provider functions
40 * that take a callback to which an OSSL_PARAM array with these parameters
41 * can be passed.
42 *
43 * This set of parameter names is explained in detail in provider-object(7)
44 * (doc/man7/provider-object.pod)
45 */
45da4a0f
RL
46#define OSSL_OBJECT_PARAM_TYPE "type" /* INTEGER */
47#define OSSL_OBJECT_PARAM_DATA_TYPE "data-type" /* UTF8_STRING */
48#define OSSL_OBJECT_PARAM_DATA_STRUCTURE "data-structure" /* UTF8_STRING */
49#define OSSL_OBJECT_PARAM_REFERENCE "reference" /* OCTET_STRING */
50#define OSSL_OBJECT_PARAM_DATA "data" /* OCTET_STRING or UTF8_STRING */
51#define OSSL_OBJECT_PARAM_DESC "desc" /* UTF8_STRING */
14c8a3d1 52
cb74317b
P
53/*
54 * Algorithm parameters
55 * If "engine" or "properties" are specified, they should always be paired
56 * with the algorithm type.
b8086652
SL
57 * Note these are common names that are shared by many types (such as kdf, mac,
58 * and pkey) e.g: see OSSL_MAC_PARAM_DIGEST below.
cb74317b
P
59 */
60#define OSSL_ALG_PARAM_DIGEST "digest" /* utf8_string */
61#define OSSL_ALG_PARAM_CIPHER "cipher" /* utf8_string */
a540ef90 62#define OSSL_ALG_PARAM_ENGINE "engine" /* utf8_string */
4e8b8e47 63#define OSSL_ALG_PARAM_MAC "mac" /* utf8_string */
cb74317b
P
64#define OSSL_ALG_PARAM_PROPERTIES "properties"/* utf8_string */
65
459b15d4 66/* cipher parameters */
e71fd827 67#define OSSL_CIPHER_PARAM_PADDING "padding" /* uint */
e2311445 68#define OSSL_CIPHER_PARAM_USE_BITS "use-bits" /* uint */
e71fd827
MC
69#define OSSL_CIPHER_PARAM_TLS_VERSION "tls-version" /* uint */
70#define OSSL_CIPHER_PARAM_TLS_MAC "tls-mac" /* octet_ptr */
71#define OSSL_CIPHER_PARAM_TLS_MAC_SIZE "tls-mac-size" /* size_t */
72#define OSSL_CIPHER_PARAM_MODE "mode" /* uint */
73#define OSSL_CIPHER_PARAM_BLOCK_SIZE "blocksize" /* size_t */
a054d15c
SL
74#define OSSL_CIPHER_PARAM_AEAD "aead" /* int, 0 or 1 */
75#define OSSL_CIPHER_PARAM_CUSTOM_IV "custom-iv" /* int, 0 or 1 */
76#define OSSL_CIPHER_PARAM_CTS "cts" /* int, 0 or 1 */
77#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK "tls-multi" /* int, 0 or 1 */
f41fd10d 78#define OSSL_CIPHER_PARAM_HAS_RAND_KEY "has-randkey" /* int, 0 or 1 */
e71fd827
MC
79#define OSSL_CIPHER_PARAM_KEYLEN "keylen" /* size_t */
80#define OSSL_CIPHER_PARAM_IVLEN "ivlen" /* size_t */
81#define OSSL_CIPHER_PARAM_IV "iv" /* octet_string OR octet_ptr */
0d83b7b9 82#define OSSL_CIPHER_PARAM_UPDATED_IV "updated-iv" /* octet_string OR octet_ptr */
e71fd827
MC
83#define OSSL_CIPHER_PARAM_NUM "num" /* uint */
84#define OSSL_CIPHER_PARAM_ROUNDS "rounds" /* uint */
85#define OSSL_CIPHER_PARAM_AEAD_TAG "tag" /* octet_string */
86#define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD "tlsaad" /* octet_string */
87#define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD "tlsaadpad" /* size_t */
88#define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED "tlsivfixed" /* octet_string */
89#define OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN "tlsivgen" /* octet_string */
90#define OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV "tlsivinv" /* octet_string */
11b44359 91#define OSSL_CIPHER_PARAM_AEAD_IVLEN OSSL_CIPHER_PARAM_IVLEN
e71fd827
MC
92#define OSSL_CIPHER_PARAM_AEAD_TAGLEN "taglen" /* size_t */
93#define OSSL_CIPHER_PARAM_AEAD_MAC_KEY "mackey" /* octet_string */
94#define OSSL_CIPHER_PARAM_RANDOM_KEY "randkey" /* octet_string */
95#define OSSL_CIPHER_PARAM_RC2_KEYBITS "keybits" /* size_t */
96#define OSSL_CIPHER_PARAM_SPEED "speed" /* uint */
7cc355c2 97#define OSSL_CIPHER_PARAM_CTS_MODE "cts_mode" /* utf8_string */
c96399e2 98/* For passing the AlgorithmIdentifier parameter in DER form */
592ea4ba 99#define OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS "alg_id_param" /* octet_string */
df05f2ce 100
0d2bfe52
SL
101#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT \
102 "tls1multi_maxsndfrag" /* uint */
103#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE \
104 "tls1multi_maxbufsz" /* size_t */
105#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE \
106 "tls1multi_interleave" /* uint */
107#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD \
108 "tls1multi_aad" /* octet_string */
109#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN \
110 "tls1multi_aadpacklen" /* uint */
111#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC \
112 "tls1multi_enc" /* octet_string */
113#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN \
114 "tls1multi_encin" /* octet_string */
115#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN \
116 "tls1multi_enclen" /* size_t */
eb173822 117
7cc355c2
SL
118/* OSSL_CIPHER_PARAM_CTS_MODE Values */
119#define OSSL_CIPHER_CTS_MODE_CS1 "CS1"
120#define OSSL_CIPHER_CTS_MODE_CS2 "CS2"
121#define OSSL_CIPHER_CTS_MODE_CS3 "CS3"
122
0113ec84
TS
123/* Known CIPHER names (not a complete list) */
124#define OSSL_CIPHER_NAME_AES_128_GCM_SIV "AES-128-GCM-SIV"
125#define OSSL_CIPHER_NAME_AES_192_GCM_SIV "AES-192-GCM-SIV"
126#define OSSL_CIPHER_NAME_AES_256_GCM_SIV "AES-256-GCM-SIV"
127
d5e5e2ff 128/* digest parameters */
a054d15c
SL
129#define OSSL_DIGEST_PARAM_XOFLEN "xoflen" /* size_t */
130#define OSSL_DIGEST_PARAM_SSL3_MS "ssl3-ms" /* octet string */
131#define OSSL_DIGEST_PARAM_PAD_TYPE "pad-type" /* uint */
132#define OSSL_DIGEST_PARAM_MICALG "micalg" /* utf8 string */
133#define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */
134#define OSSL_DIGEST_PARAM_SIZE "size" /* size_t */
135#define OSSL_DIGEST_PARAM_XOF "xof" /* int, 0 or 1 */
136#define OSSL_DIGEST_PARAM_ALGID_ABSENT "algid-absent" /* int, 0 or 1 */
d5e5e2ff 137
81ff9eeb 138/* Known DIGEST names (not a complete list) */
505b41fc 139#define OSSL_DIGEST_NAME_MD5 "MD5"
6f4b7663 140#define OSSL_DIGEST_NAME_MD5_SHA1 "MD5-SHA1"
505b41fc
RL
141#define OSSL_DIGEST_NAME_SHA1 "SHA1"
142#define OSSL_DIGEST_NAME_SHA2_224 "SHA2-224"
143#define OSSL_DIGEST_NAME_SHA2_256 "SHA2-256"
144#define OSSL_DIGEST_NAME_SHA2_384 "SHA2-384"
145#define OSSL_DIGEST_NAME_SHA2_512 "SHA2-512"
45c236ad
SL
146#define OSSL_DIGEST_NAME_SHA2_512_224 "SHA2-512/224"
147#define OSSL_DIGEST_NAME_SHA2_512_256 "SHA2-512/256"
6f4b7663
RL
148#define OSSL_DIGEST_NAME_MD2 "MD2"
149#define OSSL_DIGEST_NAME_MD4 "MD4"
150#define OSSL_DIGEST_NAME_MDC2 "MDC2"
151#define OSSL_DIGEST_NAME_RIPEMD160 "RIPEMD160"
505b41fc
RL
152#define OSSL_DIGEST_NAME_SHA3_224 "SHA3-224"
153#define OSSL_DIGEST_NAME_SHA3_256 "SHA3-256"
154#define OSSL_DIGEST_NAME_SHA3_384 "SHA3-384"
155#define OSSL_DIGEST_NAME_SHA3_512 "SHA3-512"
cc35c3ed
MC
156#define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128"
157#define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256"
d0b79f86 158#define OSSL_DIGEST_NAME_SM3 "SM3"
81ff9eeb 159
e74bd290 160/* MAC parameters */
36978c19
SL
161#define OSSL_MAC_PARAM_KEY "key" /* octet string */
162#define OSSL_MAC_PARAM_IV "iv" /* octet string */
163#define OSSL_MAC_PARAM_CUSTOM "custom" /* utf8 string */
164#define OSSL_MAC_PARAM_SALT "salt" /* octet string */
165#define OSSL_MAC_PARAM_XOF "xof" /* int, 0 or 1 */
166#define OSSL_MAC_PARAM_DIGEST_NOINIT "digest-noinit" /* int, 0 or 1 */
167#define OSSL_MAC_PARAM_DIGEST_ONESHOT "digest-oneshot" /* int, 0 or 1 */
ae7d90a1
P
168#define OSSL_MAC_PARAM_C_ROUNDS "c-rounds" /* unsigned int */
169#define OSSL_MAC_PARAM_D_ROUNDS "d-rounds" /* unsigned int */
36978c19 170
703170d4
RL
171/*
172 * If "engine" or "properties" are specified, they should always be paired
173 * with "cipher" or "digest".
174 */
3fddbb26
MC
175#define OSSL_MAC_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
176#define OSSL_MAC_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */
177#define OSSL_MAC_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
178#define OSSL_MAC_PARAM_SIZE "size" /* size_t */
eb1b66f0 179#define OSSL_MAC_PARAM_BLOCK_SIZE "block-size" /* size_t */
3fddbb26 180#define OSSL_MAC_PARAM_TLS_DATA_SIZE "tls-data-size" /* size_t */
e74bd290 181
b8086652
SL
182/* Known MAC names */
183#define OSSL_MAC_NAME_BLAKE2BMAC "BLAKE2BMAC"
184#define OSSL_MAC_NAME_BLAKE2SMAC "BLAKE2SMAC"
81ff9eeb 185#define OSSL_MAC_NAME_CMAC "CMAC"
b8086652 186#define OSSL_MAC_NAME_GMAC "GMAC"
81ff9eeb
RL
187#define OSSL_MAC_NAME_HMAC "HMAC"
188#define OSSL_MAC_NAME_KMAC128 "KMAC128"
189#define OSSL_MAC_NAME_KMAC256 "KMAC256"
b8086652
SL
190#define OSSL_MAC_NAME_POLY1305 "POLY1305"
191#define OSSL_MAC_NAME_SIPHASH "SIPHASH"
81ff9eeb 192
2f755701
P
193/* KDF / PRF parameters */
194#define OSSL_KDF_PARAM_SECRET "secret" /* octet string */
195#define OSSL_KDF_PARAM_KEY "key" /* octet string */
196#define OSSL_KDF_PARAM_SALT "salt" /* octet string */
197#define OSSL_KDF_PARAM_PASSWORD "pass" /* octet string */
f7d998a2
P
198#define OSSL_KDF_PARAM_PREFIX "prefix" /* octet string */
199#define OSSL_KDF_PARAM_LABEL "label" /* octet string */
200#define OSSL_KDF_PARAM_DATA "data" /* octet string */
4e8b8e47 201#define OSSL_KDF_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */
f6dead1b 202#define OSSL_KDF_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
4e8b8e47 203#define OSSL_KDF_PARAM_MAC OSSL_ALG_PARAM_MAC /* utf8 string */
2f755701 204#define OSSL_KDF_PARAM_MAC_SIZE "maclen" /* size_t */
cb74317b 205#define OSSL_KDF_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
2f755701
P
206#define OSSL_KDF_PARAM_ITER "iter" /* unsigned int */
207#define OSSL_KDF_PARAM_MODE "mode" /* utf8 string or int */
208#define OSSL_KDF_PARAM_PKCS5 "pkcs5" /* int */
209#define OSSL_KDF_PARAM_UKM "ukm" /* octet string */
210#define OSSL_KDF_PARAM_CEK_ALG "cekalg" /* utf8 string */
211#define OSSL_KDF_PARAM_SCRYPT_N "n" /* uint64_t */
212#define OSSL_KDF_PARAM_SCRYPT_R "r" /* uint32_t */
213#define OSSL_KDF_PARAM_SCRYPT_P "p" /* uint32_t */
214#define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */
215#define OSSL_KDF_PARAM_INFO "info" /* octet string */
216#define OSSL_KDF_PARAM_SEED "seed" /* octet string */
217#define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */
218#define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */
219#define OSSL_KDF_PARAM_SSHKDF_TYPE "type" /* int */
220#define OSSL_KDF_PARAM_SIZE "size" /* size_t */
33f54da3 221#define OSSL_KDF_PARAM_CONSTANT "constant" /* octet string */
b7466c13 222#define OSSL_KDF_PARAM_PKCS12_ID "id" /* int */
4757a347
SL
223#define OSSL_KDF_PARAM_KBKDF_USE_L "use-l" /* int */
224#define OSSL_KDF_PARAM_KBKDF_USE_SEPARATOR "use-separator" /* int */
0e9a265e 225#define OSSL_KDF_PARAM_KBKDF_R "r" /* int */
8a686bdb 226#define OSSL_KDF_PARAM_X942_ACVPINFO "acvp-info"
89cccbea
SL
227#define OSSL_KDF_PARAM_X942_PARTYUINFO "partyu-info"
228#define OSSL_KDF_PARAM_X942_PARTYVINFO "partyv-info"
229#define OSSL_KDF_PARAM_X942_SUPP_PUBINFO "supp-pubinfo"
230#define OSSL_KDF_PARAM_X942_SUPP_PRIVINFO "supp-privinfo"
231#define OSSL_KDF_PARAM_X942_USE_KEYBITS "use-keybits"
2f755701 232
d810cc19 233/* Known KDF names */
89cccbea 234#define OSSL_KDF_NAME_HKDF "HKDF"
f7d998a2 235#define OSSL_KDF_NAME_TLS1_3_KDF "TLS13-KDF"
0f183675 236#define OSSL_KDF_NAME_PBKDF1 "PBKDF1"
89cccbea
SL
237#define OSSL_KDF_NAME_PBKDF2 "PBKDF2"
238#define OSSL_KDF_NAME_SCRYPT "SCRYPT"
239#define OSSL_KDF_NAME_SSHKDF "SSHKDF"
240#define OSSL_KDF_NAME_SSKDF "SSKDF"
241#define OSSL_KDF_NAME_TLS1_PRF "TLS1-PRF"
242#define OSSL_KDF_NAME_X942KDF_ASN1 "X942KDF-ASN1"
243#define OSSL_KDF_NAME_X942KDF_CONCAT "X942KDF-CONCAT"
244#define OSSL_KDF_NAME_X963KDF "X963KDF"
245#define OSSL_KDF_NAME_KBKDF "KBKDF"
246#define OSSL_KDF_NAME_KRB5KDF "KRB5KDF"
d810cc19 247
f000e828
P
248/* Known RAND names */
249#define OSSL_RAND_PARAM_STATE "state"
714a1bb3 250#define OSSL_RAND_PARAM_STRENGTH "strength"
03bede0c 251#define OSSL_RAND_PARAM_MAX_REQUEST "max_request"
714a1bb3
P
252#define OSSL_RAND_PARAM_TEST_ENTROPY "test_entropy"
253#define OSSL_RAND_PARAM_TEST_NONCE "test_nonce"
254
f000e828
P
255/* RAND/DRBG names */
256#define OSSL_DRBG_PARAM_RESEED_REQUESTS "reseed_requests"
257#define OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL "reseed_time_interval"
f000e828
P
258#define OSSL_DRBG_PARAM_MIN_ENTROPYLEN "min_entropylen"
259#define OSSL_DRBG_PARAM_MAX_ENTROPYLEN "max_entropylen"
260#define OSSL_DRBG_PARAM_MIN_NONCELEN "min_noncelen"
261#define OSSL_DRBG_PARAM_MAX_NONCELEN "max_noncelen"
262#define OSSL_DRBG_PARAM_MAX_PERSLEN "max_perslen"
263#define OSSL_DRBG_PARAM_MAX_ADINLEN "max_adinlen"
b0614f0a 264#define OSSL_DRBG_PARAM_RESEED_COUNTER "reseed_counter"
f000e828
P
265#define OSSL_DRBG_PARAM_RESEED_TIME "reseed_time"
266#define OSSL_DRBG_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
267#define OSSL_DRBG_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST
268#define OSSL_DRBG_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER
269#define OSSL_DRBG_PARAM_MAC OSSL_ALG_PARAM_MAC
270#define OSSL_DRBG_PARAM_USE_DF "use_derivation_function"
271
272/* DRBG call back parameters */
273#define OSSL_DRBG_PARAM_ENTROPY_REQUIRED "entropy_required"
274#define OSSL_DRBG_PARAM_PREDICTION_RESISTANCE "prediction_resistance"
275#define OSSL_DRBG_PARAM_MIN_LENGTH "minium_length"
276#define OSSL_DRBG_PARAM_MAX_LENGTH "maxium_length"
277#define OSSL_DRBG_PARAM_RANDOM_DATA "random_data"
278#define OSSL_DRBG_PARAM_SIZE "size"
279
ff64702b 280/* PKEY parameters */
6508e858
RL
281/* Common PKEY parameters */
282#define OSSL_PKEY_PARAM_BITS "bits" /* integer */
283#define OSSL_PKEY_PARAM_MAX_SIZE "max-size" /* integer */
284#define OSSL_PKEY_PARAM_SECURITY_BITS "security-bits" /* integer */
d5aef594 285#define OSSL_PKEY_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST
a540ef90
MC
286#define OSSL_PKEY_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
287#define OSSL_PKEY_PARAM_ENGINE OSSL_ALG_PARAM_ENGINE /* utf8 string */
8bee6512 288#define OSSL_PKEY_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
ead0d234
RL
289#define OSSL_PKEY_PARAM_DEFAULT_DIGEST "default-digest" /* utf8 string */
290#define OSSL_PKEY_PARAM_MANDATORY_DIGEST "mandatory-digest" /* utf8 string */
6f4b7663 291#define OSSL_PKEY_PARAM_PAD_MODE "pad-mode"
6f4b7663 292#define OSSL_PKEY_PARAM_DIGEST_SIZE "digest-size"
15671090 293#define OSSL_PKEY_PARAM_MASKGENFUNC "mgf"
6f4b7663
RL
294#define OSSL_PKEY_PARAM_MGF1_DIGEST "mgf1-digest"
295#define OSSL_PKEY_PARAM_MGF1_PROPERTIES "mgf1-properties"
5ac8fb58 296#define OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY "encoded-pub-key"
023b188c 297#define OSSL_PKEY_PARAM_GROUP_NAME "group"
86df26b3 298#define OSSL_PKEY_PARAM_DIST_ID "distid"
90d3cb57
MC
299#define OSSL_PKEY_PARAM_PUB_KEY "pub"
300#define OSSL_PKEY_PARAM_PRIV_KEY "priv"
6508e858 301
4889dadc 302/* Diffie-Hellman/DSA Parameters */
4f2271d5
SL
303#define OSSL_PKEY_PARAM_FFC_P "p"
304#define OSSL_PKEY_PARAM_FFC_G "g"
305#define OSSL_PKEY_PARAM_FFC_Q "q"
306#define OSSL_PKEY_PARAM_FFC_GINDEX "gindex"
307#define OSSL_PKEY_PARAM_FFC_PCOUNTER "pcounter"
308#define OSSL_PKEY_PARAM_FFC_SEED "seed"
309#define OSSL_PKEY_PARAM_FFC_COFACTOR "j"
310#define OSSL_PKEY_PARAM_FFC_H "hindex"
b98f752e
SL
311#define OSSL_PKEY_PARAM_FFC_VALIDATE_PQ "validate-pq"
312#define OSSL_PKEY_PARAM_FFC_VALIDATE_G "validate-g"
313#define OSSL_PKEY_PARAM_FFC_VALIDATE_LEGACY "validate-legacy"
7165593c
SL
314
315/* Diffie-Hellman params */
4f2271d5
SL
316#define OSSL_PKEY_PARAM_DH_GENERATOR "safeprime-generator"
317#define OSSL_PKEY_PARAM_DH_PRIV_LEN "priv_len"
7165593c 318
4fe54d67 319/* Elliptic Curve Domain Parameters */
4f2271d5
SL
320#define OSSL_PKEY_PARAM_EC_PUB_X "qx"
321#define OSSL_PKEY_PARAM_EC_PUB_Y "qy"
4fe54d67 322
c0f39ded 323/* Elliptic Curve Explicit Domain Parameters */
3bcc933e
MC
324#define OSSL_PKEY_PARAM_EC_FIELD_TYPE "field-type"
325#define OSSL_PKEY_PARAM_EC_P "p"
326#define OSSL_PKEY_PARAM_EC_A "a"
327#define OSSL_PKEY_PARAM_EC_B "b"
328#define OSSL_PKEY_PARAM_EC_GENERATOR "generator"
329#define OSSL_PKEY_PARAM_EC_ORDER "order"
330#define OSSL_PKEY_PARAM_EC_COFACTOR "cofactor"
331#define OSSL_PKEY_PARAM_EC_SEED "seed"
332#define OSSL_PKEY_PARAM_EC_CHAR2_M "m"
333#define OSSL_PKEY_PARAM_EC_CHAR2_TYPE "basis-type"
334#define OSSL_PKEY_PARAM_EC_CHAR2_TP_BASIS "tp"
335#define OSSL_PKEY_PARAM_EC_CHAR2_PP_K1 "k1"
336#define OSSL_PKEY_PARAM_EC_CHAR2_PP_K2 "k2"
337#define OSSL_PKEY_PARAM_EC_CHAR2_PP_K3 "k3"
338#define OSSL_PKEY_PARAM_EC_DECODED_FROM_EXPLICIT_PARAMS "decoded-from-explicit"
c0f39ded 339
4fe54d67
NT
340/* Elliptic Curve Key Parameters */
341#define OSSL_PKEY_PARAM_USE_COFACTOR_FLAG "use-cofactor-flag"
342#define OSSL_PKEY_PARAM_USE_COFACTOR_ECDH \
343 OSSL_PKEY_PARAM_USE_COFACTOR_FLAG
344
29be6023
RL
345/* RSA Keys */
346/*
347 * n, e, d are the usual public and private key components
348 *
349 * rsa-num is the number of factors, including p and q
350 * rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
351 * rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
352 * rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
353 *
354 * The number of rsa-factor items must be equal to the number of rsa-exponent
355 * items, and the number of rsa-coefficients must be one less.
356 * (the base i for the coefficients is 2, not 1, at least as implied by
357 * RFC 8017)
358 */
359#define OSSL_PKEY_PARAM_RSA_N "n"
360#define OSSL_PKEY_PARAM_RSA_E "e"
361#define OSSL_PKEY_PARAM_RSA_D "d"
362#define OSSL_PKEY_PARAM_RSA_FACTOR "rsa-factor"
363#define OSSL_PKEY_PARAM_RSA_EXPONENT "rsa-exponent"
364#define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient"
96ebe52e
SL
365#define OSSL_PKEY_PARAM_RSA_FACTOR1 OSSL_PKEY_PARAM_RSA_FACTOR"1"
366#define OSSL_PKEY_PARAM_RSA_FACTOR2 OSSL_PKEY_PARAM_RSA_FACTOR"2"
367#define OSSL_PKEY_PARAM_RSA_FACTOR3 OSSL_PKEY_PARAM_RSA_FACTOR"3"
368#define OSSL_PKEY_PARAM_RSA_FACTOR4 OSSL_PKEY_PARAM_RSA_FACTOR"4"
369#define OSSL_PKEY_PARAM_RSA_FACTOR5 OSSL_PKEY_PARAM_RSA_FACTOR"5"
370#define OSSL_PKEY_PARAM_RSA_FACTOR6 OSSL_PKEY_PARAM_RSA_FACTOR"6"
371#define OSSL_PKEY_PARAM_RSA_FACTOR7 OSSL_PKEY_PARAM_RSA_FACTOR"7"
372#define OSSL_PKEY_PARAM_RSA_FACTOR8 OSSL_PKEY_PARAM_RSA_FACTOR"8"
373#define OSSL_PKEY_PARAM_RSA_FACTOR9 OSSL_PKEY_PARAM_RSA_FACTOR"9"
374#define OSSL_PKEY_PARAM_RSA_FACTOR10 OSSL_PKEY_PARAM_RSA_FACTOR"10"
375#define OSSL_PKEY_PARAM_RSA_EXPONENT1 OSSL_PKEY_PARAM_RSA_EXPONENT"1"
376#define OSSL_PKEY_PARAM_RSA_EXPONENT2 OSSL_PKEY_PARAM_RSA_EXPONENT"2"
377#define OSSL_PKEY_PARAM_RSA_EXPONENT3 OSSL_PKEY_PARAM_RSA_EXPONENT"3"
378#define OSSL_PKEY_PARAM_RSA_EXPONENT4 OSSL_PKEY_PARAM_RSA_EXPONENT"4"
379#define OSSL_PKEY_PARAM_RSA_EXPONENT5 OSSL_PKEY_PARAM_RSA_EXPONENT"5"
380#define OSSL_PKEY_PARAM_RSA_EXPONENT6 OSSL_PKEY_PARAM_RSA_EXPONENT"6"
381#define OSSL_PKEY_PARAM_RSA_EXPONENT7 OSSL_PKEY_PARAM_RSA_EXPONENT"7"
382#define OSSL_PKEY_PARAM_RSA_EXPONENT8 OSSL_PKEY_PARAM_RSA_EXPONENT"8"
383#define OSSL_PKEY_PARAM_RSA_EXPONENT9 OSSL_PKEY_PARAM_RSA_EXPONENT"9"
384#define OSSL_PKEY_PARAM_RSA_EXPONENT10 OSSL_PKEY_PARAM_RSA_EXPONENT"10"
385#define OSSL_PKEY_PARAM_RSA_COEFFICIENT1 OSSL_PKEY_PARAM_RSA_COEFFICIENT"1"
386#define OSSL_PKEY_PARAM_RSA_COEFFICIENT2 OSSL_PKEY_PARAM_RSA_COEFFICIENT"2"
387#define OSSL_PKEY_PARAM_RSA_COEFFICIENT3 OSSL_PKEY_PARAM_RSA_COEFFICIENT"3"
388#define OSSL_PKEY_PARAM_RSA_COEFFICIENT4 OSSL_PKEY_PARAM_RSA_COEFFICIENT"4"
389#define OSSL_PKEY_PARAM_RSA_COEFFICIENT5 OSSL_PKEY_PARAM_RSA_COEFFICIENT"5"
390#define OSSL_PKEY_PARAM_RSA_COEFFICIENT6 OSSL_PKEY_PARAM_RSA_COEFFICIENT"6"
391#define OSSL_PKEY_PARAM_RSA_COEFFICIENT7 OSSL_PKEY_PARAM_RSA_COEFFICIENT"7"
392#define OSSL_PKEY_PARAM_RSA_COEFFICIENT8 OSSL_PKEY_PARAM_RSA_COEFFICIENT"8"
393#define OSSL_PKEY_PARAM_RSA_COEFFICIENT9 OSSL_PKEY_PARAM_RSA_COEFFICIENT"9"
394
b8086652
SL
395/* RSA padding modes */
396#define OSSL_PKEY_RSA_PAD_MODE_NONE "none"
397#define OSSL_PKEY_RSA_PAD_MODE_PKCSV15 "pkcs1"
b8086652
SL
398#define OSSL_PKEY_RSA_PAD_MODE_OAEP "oaep"
399#define OSSL_PKEY_RSA_PAD_MODE_X931 "x931"
400#define OSSL_PKEY_RSA_PAD_MODE_PSS "pss"
401
402/* RSA pss padding salt length */
403#define OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST "digest"
404#define OSSL_PKEY_RSA_PSS_SALT_LEN_MAX "max"
405#define OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO "auto"
96ebe52e 406
62924755 407/* Key generation parameters */
e947a064
DB
408#define OSSL_PKEY_PARAM_RSA_BITS OSSL_PKEY_PARAM_BITS
409#define OSSL_PKEY_PARAM_RSA_PRIMES "primes"
410#define OSSL_PKEY_PARAM_RSA_DIGEST OSSL_PKEY_PARAM_DIGEST
411#define OSSL_PKEY_PARAM_RSA_DIGEST_PROPS OSSL_PKEY_PARAM_PROPERTIES
412#define OSSL_PKEY_PARAM_RSA_MASKGENFUNC OSSL_PKEY_PARAM_MASKGENFUNC
413#define OSSL_PKEY_PARAM_RSA_MGF1_DIGEST OSSL_PKEY_PARAM_MGF1_DIGEST
414#define OSSL_PKEY_PARAM_RSA_PSS_SALTLEN "saltlen"
29be6023 415
78c44b05 416/* EC, X25519 and X448 Key generation parameters */
417#define OSSL_PKEY_PARAM_DHKEM_IKM "dhkem-ikm"
418
b03ec3b5
SL
419/* Key generation parameters */
420#define OSSL_PKEY_PARAM_FFC_TYPE "type"
421#define OSSL_PKEY_PARAM_FFC_PBITS "pbits"
422#define OSSL_PKEY_PARAM_FFC_QBITS "qbits"
423#define OSSL_PKEY_PARAM_FFC_DIGEST OSSL_PKEY_PARAM_DIGEST
424#define OSSL_PKEY_PARAM_FFC_DIGEST_PROPS OSSL_PKEY_PARAM_PROPERTIES
425
5b5eea4b
SL
426#define OSSL_PKEY_PARAM_EC_ENCODING "encoding" /* utf8_string */
427#define OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT "point-format"
428#define OSSL_PKEY_PARAM_EC_GROUP_CHECK_TYPE "group-check"
429#define OSSL_PKEY_PARAM_EC_INCLUDE_PUBLIC "include-public"
c0f39ded
SL
430
431/* OSSL_PKEY_PARAM_EC_ENCODING values */
432#define OSSL_PKEY_EC_ENCODING_EXPLICIT "explicit"
433#define OSSL_PKEY_EC_ENCODING_GROUP "named_curve"
434
5b5eea4b
SL
435#define OSSL_PKEY_EC_POINT_CONVERSION_FORMAT_UNCOMPRESSED "uncompressed"
436#define OSSL_PKEY_EC_POINT_CONVERSION_FORMAT_COMPRESSED "compressed"
437#define OSSL_PKEY_EC_POINT_CONVERSION_FORMAT_HYBRID "hybrid"
438
439#define OSSL_PKEY_EC_GROUP_CHECK_DEFAULT "default"
440#define OSSL_PKEY_EC_GROUP_CHECK_NAMED "named"
441#define OSSL_PKEY_EC_GROUP_CHECK_NAMED_NIST "named-nist"
442
35aca9ec 443/* Key Exchange parameters */
4fe54d67
NT
444#define OSSL_EXCHANGE_PARAM_PAD "pad" /* uint */
445#define OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE "ecdh-cofactor-mode" /* int */
446#define OSSL_EXCHANGE_PARAM_KDF_TYPE "kdf-type" /* utf8_string */
447#define OSSL_EXCHANGE_PARAM_KDF_DIGEST "kdf-digest" /* utf8_string */
448#define OSSL_EXCHANGE_PARAM_KDF_DIGEST_PROPS "kdf-digest-props" /* utf8_string */
449#define OSSL_EXCHANGE_PARAM_KDF_OUTLEN "kdf-outlen" /* size_t */
76e48c9d
TM
450/* The following parameter is an octet_string on set and an octet_ptr on get */
451#define OSSL_EXCHANGE_PARAM_KDF_UKM "kdf-ukm"
35aca9ec 452
4889dadc 453/* Signature parameters */
d5aef594 454#define OSSL_SIGNATURE_PARAM_ALGORITHM_ID "algorithm-id"
6f4b7663 455#define OSSL_SIGNATURE_PARAM_PAD_MODE OSSL_PKEY_PARAM_PAD_MODE
d5aef594 456#define OSSL_SIGNATURE_PARAM_DIGEST OSSL_PKEY_PARAM_DIGEST
8bee6512 457#define OSSL_SIGNATURE_PARAM_PROPERTIES OSSL_PKEY_PARAM_PROPERTIES
15671090 458#define OSSL_SIGNATURE_PARAM_PSS_SALTLEN "saltlen"
6f4b7663
RL
459#define OSSL_SIGNATURE_PARAM_MGF1_DIGEST OSSL_PKEY_PARAM_MGF1_DIGEST
460#define OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES \
461 OSSL_PKEY_PARAM_MGF1_PROPERTIES
edd3b7a3 462#define OSSL_SIGNATURE_PARAM_DIGEST_SIZE OSSL_PKEY_PARAM_DIGEST_SIZE
4889dadc 463
89abd1b6 464/* Asym cipher parameters */
ce64d3ee
MC
465#define OSSL_ASYM_CIPHER_PARAM_DIGEST OSSL_PKEY_PARAM_DIGEST
466#define OSSL_ASYM_CIPHER_PARAM_PROPERTIES OSSL_PKEY_PARAM_PROPERTIES
467#define OSSL_ASYM_CIPHER_PARAM_ENGINE OSSL_PKEY_PARAM_ENGINE
6f4b7663
RL
468#define OSSL_ASYM_CIPHER_PARAM_PAD_MODE OSSL_PKEY_PARAM_PAD_MODE
469#define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST \
470 OSSL_PKEY_PARAM_MGF1_DIGEST
471#define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS \
472 OSSL_PKEY_PARAM_MGF1_PROPERTIES
d9a75107
MC
473#define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST OSSL_ALG_PARAM_DIGEST
474#define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS "digest-props"
76e48c9d 475/* The following parameter is an octet_string on set and an octet_ptr on get */
d9a75107 476#define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL "oaep-label"
d9a75107
MC
477#define OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION "tls-client-version"
478#define OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION "tls-negotiated-version"
89abd1b6 479
866234ac 480/*
ece9304c 481 * Encoder / decoder parameters
866234ac 482 */
8a98a507
RL
483#define OSSL_ENCODER_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER
484#define OSSL_ENCODER_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
0cc0164d
RL
485/* Currently PVK only, but reusable for others as needed */
486#define OSSL_ENCODER_PARAM_ENCRYPT_LEVEL "encrypt-level"
78043fe8 487#define OSSL_ENCODER_PARAM_SAVE_PARAMETERS "save-parameters" /* integer */
ece9304c 488
ebfdb63d 489#define OSSL_DECODER_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
c3e4c1f3 490
866234ac 491/* Passphrase callback parameters */
ece9304c 492#define OSSL_PASSPHRASE_PARAM_INFO "info"
866234ac 493
62924755
RL
494/* Keygen callback parameters, from provider to libcrypto */
495#define OSSL_GEN_PARAM_POTENTIAL "potential" /* integer */
496#define OSSL_GEN_PARAM_ITERATION "iteration" /* integer */
497
4f2271d5
SL
498/* ACVP Test parameters : These should not be used normally */
499#define OSSL_PKEY_PARAM_RSA_TEST_XP1 "xp1"
500#define OSSL_PKEY_PARAM_RSA_TEST_XP2 "xp2"
501#define OSSL_PKEY_PARAM_RSA_TEST_XP "xp"
502#define OSSL_PKEY_PARAM_RSA_TEST_XQ1 "xq1"
503#define OSSL_PKEY_PARAM_RSA_TEST_XQ2 "xq2"
504#define OSSL_PKEY_PARAM_RSA_TEST_XQ "xq"
505#define OSSL_PKEY_PARAM_RSA_TEST_P1 "p1"
506#define OSSL_PKEY_PARAM_RSA_TEST_P2 "p2"
507#define OSSL_PKEY_PARAM_RSA_TEST_Q1 "q1"
508#define OSSL_PKEY_PARAM_RSA_TEST_Q2 "q2"
509#define OSSL_SIGNATURE_PARAM_KAT "kat"
510
80f4fd18
SL
511/* KEM parameters */
512#define OSSL_KEM_PARAM_OPERATION "operation"
78c44b05 513#define OSSL_KEM_PARAM_IKME "ikme"
80f4fd18
SL
514
515/* OSSL_KEM_PARAM_OPERATION values */
516#define OSSL_KEM_PARAM_OPERATION_RSASVE "RSASVE"
78c44b05 517#define OSSL_KEM_PARAM_OPERATION_DHKEM "DHKEM"
80f4fd18 518
72bfc958
MC
519/* Capabilities */
520
80f4fd18 521/* TLS-GROUP Capability */
72bfc958
MC
522#define OSSL_CAPABILITY_TLS_GROUP_NAME "tls-group-name"
523#define OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL "tls-group-name-internal"
524#define OSSL_CAPABILITY_TLS_GROUP_ID "tls-group-id"
525#define OSSL_CAPABILITY_TLS_GROUP_ALG "tls-group-alg"
526#define OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS "tls-group-sec-bits"
c1a74f59 527#define OSSL_CAPABILITY_TLS_GROUP_IS_KEM "tls-group-is-kem"
72bfc958
MC
528#define OSSL_CAPABILITY_TLS_GROUP_MIN_TLS "tls-min-tls"
529#define OSSL_CAPABILITY_TLS_GROUP_MAX_TLS "tls-max-tls"
530#define OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS "tls-min-dtls"
531#define OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS "tls-max-dtls"
532
8704b6bf
RL
533/*-
534 * storemgmt parameters
535 */
536
537/*
538 * Used by storemgmt_ctx_set_params():
539 *
540 * - OSSL_STORE_PARAM_EXPECT is an INTEGER, and the value is any of the
541 * OSSL_STORE_INFO numbers. This is used to set the expected type of
542 * object loaded.
543 *
544 * - OSSL_STORE_PARAM_SUBJECT, OSSL_STORE_PARAM_ISSUER,
545 * OSSL_STORE_PARAM_SERIAL, OSSL_STORE_PARAM_FINGERPRINT,
546 * OSSL_STORE_PARAM_DIGEST, OSSL_STORE_PARAM_ALIAS
547 * are used as search criteria.
548 * (OSSL_STORE_PARAM_DIGEST is used with OSSL_STORE_PARAM_FINGERPRINT)
549 */
550#define OSSL_STORE_PARAM_EXPECT "expect" /* INTEGER */
551#define OSSL_STORE_PARAM_SUBJECT "subject" /* DER blob => OCTET_STRING */
552#define OSSL_STORE_PARAM_ISSUER "name" /* DER blob => OCTET_STRING */
553#define OSSL_STORE_PARAM_SERIAL "serial" /* INTEGER */
554#define OSSL_STORE_PARAM_DIGEST "digest" /* UTF8_STRING */
555#define OSSL_STORE_PARAM_FINGERPRINT "fingerprint" /* OCTET_STRING */
556#define OSSL_STORE_PARAM_ALIAS "alias" /* UTF8_STRING */
557
558/* You may want to pass properties for the provider implementation to use */
559#define OSSL_STORE_PARAM_PROPERTIES "properties" /* utf8_string */
d382e796
TM
560/* OSSL_DECODER input type if a decoder is used by the store */
561#define OSSL_STORE_PARAM_INPUT_TYPE "input-type" /* UTF8_STRING */
8704b6bf 562
e2d5742b
MC
563
564/* Libssl record layer */
565
9dd90232
MC
566#define OSSL_LIBSSL_RECORD_LAYER_PARAM_OPTIONS "options"
567#define OSSL_LIBSSL_RECORD_LAYER_PARAM_MODE "mode"
568#define OSSL_LIBSSL_RECORD_LAYER_PARAM_READ_AHEAD "read_ahead"
81c9ebd9 569#define OSSL_LIBSSL_RECORD_LAYER_READ_BUFFER_LEN "read_buffer_len"
9dd90232 570#define OSSL_LIBSSL_RECORD_LAYER_PARAM_USE_ETM "use_etm"
8124ab56
MC
571#define OSSL_LIBSSL_RECORD_LAYER_PARAM_STREAM_MAC "stream_mac"
572#define OSSL_LIBSSL_RECORD_LAYER_PARAM_TLSTREE "tlstree"
9dd90232
MC
573#define OSSL_LIBSSL_RECORD_LAYER_PARAM_MAX_FRAG_LEN "max_frag_len"
574#define OSSL_LIBSSL_RECORD_LAYER_PARAM_MAX_EARLY_DATA "max_early_data"
e2d5742b 575
8a73348b
MC
576# ifdef __cplusplus
577}
578# endif
579
580#endif