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