projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| 8a73348b MC |
1 | /* |
| 2 | * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. | |
| 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 | ||
| 10 | #ifndef OSSL_CORE_NAMES_H | |
| 11 | # define OSSL_CORE_NAMES_H | |
| 12 | ||
| 13 | # ifdef __cplusplus | |
| 14 | extern "C" { | |
| 15 | # endif | |
| 16 | ||
| 17 | /* | |
| 18 | * Well known parameter names that Providers can define | |
| 19 | */ | |
| 20 | ||
| 21 | /* | |
| 22 | * A printable name for this provider | |
| 23 | * Type: OSSL_PARAM_UTF8_STRING | |
| 24 | */ | |
| 25 | #define OSSL_PROV_PARAM_NAME "name" | |
| 26 | /* | |
| 27 | * A version string for this provider | |
| 28 | * Type: OSSL_PARAM_UTF8_STRING | |
| 29 | */ | |
| 30 | #define OSSL_PROV_PARAM_VERSION "version" | |
| 31 | /* | |
| 32 | * A string providing provider specific build information | |
| 33 | * Type: OSSL_PARAM_UTF8_STRING | |
| 34 | */ | |
| 35 | #define OSSL_PROV_PARAM_BUILDINFO "buildinfo" | |
| 36 | ||
| 25e60144 SL |
37 | /* |
| 38 | * The module filename | |
| 39 | * Type: OSSL_PARAM_OCTET_STRING | |
| 40 | */ | |
| 41 | #define OSSL_PROV_PARAM_MODULE_FILENAME "module-filename" | |
| df05f2ce | 42 | |
| cb74317b P |
43 | /* |
| 44 | * Algorithm parameters | |
| 45 | * If "engine" or "properties" are specified, they should always be paired | |
| 46 | * with the algorithm type. | |
| 47 | */ | |
| 48 | #define OSSL_ALG_PARAM_DIGEST "digest" /* utf8_string */ | |
| 49 | #define OSSL_ALG_PARAM_CIPHER "cipher" /* utf8_string */ | |
| 50 | #define OSSL_ALG_PARAM_ENGINE "engine" /* utf8_string */ | |
| 51 | #define OSSL_ALG_PARAM_PROPERTIES "properties"/* utf8_string */ | |
| 52 | ||
| 459b15d4 | 53 | /* cipher parameters */ |
| 1c3ace68 SL |
54 | #define OSSL_CIPHER_PARAM_PADDING "padding" /* uint */ |
| 55 | #define OSSL_CIPHER_PARAM_MODE "mode" /* uint */ | |
| 56 | #define OSSL_CIPHER_PARAM_BLOCK_SIZE "blocksize" /* size_t */ | |
| 459b15d4 | 57 | #define OSSL_CIPHER_PARAM_FLAGS "flags" /* ulong */ |
| 1c3ace68 SL |
58 | #define OSSL_CIPHER_PARAM_KEYLEN "keylen" /* size_t */ |
| 59 | #define OSSL_CIPHER_PARAM_IVLEN "ivlen" /* size_t */ | |
| 459b15d4 | 60 | #define OSSL_CIPHER_PARAM_IV "iv" /* octet_string OR octet_ptr */ |
| 1c3ace68 | 61 | #define OSSL_CIPHER_PARAM_NUM "num" /* uint */ |
| 459b15d4 SL |
62 | #define OSSL_CIPHER_PARAM_AEAD_TAG "tag" /* octet_string */ |
| 63 | #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD "tlsaad" /* octet_string */ | |
| 64 | #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD "tlsaadpad" /* size_t */ | |
| 65 | #define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED "tlsivfixed" /* octet_string */ | |
| 1c3ace68 | 66 | #define OSSL_CIPHER_PARAM_AEAD_IVLEN OSSL_CIPHER_PARAM_IVLEN |
| 4a42e264 | 67 | #define OSSL_CIPHER_PARAM_RANDOM_KEY "randkey" /* octet_string */ |
| df05f2ce | 68 | |
| d5e5e2ff | 69 | /* digest parameters */ |
| 1c3ace68 SL |
70 | #define OSSL_DIGEST_PARAM_XOFLEN "xoflen" /* size_t */ |
| 71 | #define OSSL_DIGEST_PARAM_SSL3_MS "ssl3-ms" /* octet string */ | |
| 72 | #define OSSL_DIGEST_PARAM_PAD_TYPE "pad_type" /* uint */ | |
| 73 | #define OSSL_DIGEST_PARAM_MICALG "micalg" /* utf8 string */ | |
| 74 | #define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */ | |
| 75 | #define OSSL_DIGEST_PARAM_SIZE "size" /* size_t */ | |
| 76 | #define OSSL_DIGEST_PARAM_FLAGS "flags" /* ulong */ | |
| d5e5e2ff | 77 | |
| 81ff9eeb RL |
78 | /* Known DIGEST names (not a complete list) */ |
| 79 | #define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK_KMAC128" | |
| 80 | #define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK_KMAC256" | |
| 81 | ||
| e74bd290 | 82 | /* MAC parameters */ |
| 1c3ace68 SL |
83 | #define OSSL_MAC_PARAM_KEY "key" /* octet string */ |
| 84 | #define OSSL_MAC_PARAM_IV "iv" /* octet string */ | |
| 85 | #define OSSL_MAC_PARAM_CUSTOM "custom" /* utf8 string */ | |
| 86 | #define OSSL_MAC_PARAM_SALT "salt" /* octet string */ | |
| 87 | #define OSSL_MAC_PARAM_XOF "xof" /* int, 0 or 1 */ | |
| 88 | #define OSSL_MAC_PARAM_FLAGS "flags" /* int */ | |
| 703170d4 RL |
89 | /* |
| 90 | * If "engine" or "properties" are specified, they should always be paired | |
| 91 | * with "cipher" or "digest". | |
| 92 | */ | |
| cb74317b P |
93 | #define OSSL_MAC_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */ |
| 94 | #define OSSL_MAC_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */ | |
| 95 | #define OSSL_MAC_PARAM_ENGINE OSSL_ALG_PARAM_ENGINE /* utf8 string */ | |
| 96 | #define OSSL_MAC_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */ | |
| 1c3ace68 | 97 | #define OSSL_MAC_PARAM_SIZE "size" /* size_t */ |
| e74bd290 | 98 | |
| 81ff9eeb RL |
99 | /* Known MAC names (not a complete list) */ |
| 100 | #define OSSL_MAC_NAME_CMAC "CMAC" | |
| 101 | #define OSSL_MAC_NAME_HMAC "HMAC" | |
| 102 | #define OSSL_MAC_NAME_KMAC128 "KMAC128" | |
| 103 | #define OSSL_MAC_NAME_KMAC256 "KMAC256" | |
| 104 | ||
| 2f755701 P |
105 | /* KDF / PRF parameters */ |
| 106 | #define OSSL_KDF_PARAM_SECRET "secret" /* octet string */ | |
| 107 | #define OSSL_KDF_PARAM_KEY "key" /* octet string */ | |
| 108 | #define OSSL_KDF_PARAM_SALT "salt" /* octet string */ | |
| 109 | #define OSSL_KDF_PARAM_PASSWORD "pass" /* octet string */ | |
| cb74317b | 110 | #define OSSL_KDF_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */ |
| 2f755701 P |
111 | #define OSSL_KDF_PARAM_MAC "mac" /* utf8 string */ |
| 112 | #define OSSL_KDF_PARAM_MAC_SIZE "maclen" /* size_t */ | |
| cb74317b P |
113 | #define OSSL_KDF_PARAM_ENGINE OSSL_ALG_PARAM_ENGINE /* utf8 string */ |
| 114 | #define OSSL_KDF_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */ | |
| 2f755701 P |
115 | #define OSSL_KDF_PARAM_ITER "iter" /* unsigned int */ |
| 116 | #define OSSL_KDF_PARAM_MODE "mode" /* utf8 string or int */ | |
| 117 | #define OSSL_KDF_PARAM_PKCS5 "pkcs5" /* int */ | |
| 118 | #define OSSL_KDF_PARAM_UKM "ukm" /* octet string */ | |
| 119 | #define OSSL_KDF_PARAM_CEK_ALG "cekalg" /* utf8 string */ | |
| 120 | #define OSSL_KDF_PARAM_SCRYPT_N "n" /* uint64_t */ | |
| 121 | #define OSSL_KDF_PARAM_SCRYPT_R "r" /* uint32_t */ | |
| 122 | #define OSSL_KDF_PARAM_SCRYPT_P "p" /* uint32_t */ | |
| 123 | #define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */ | |
| 124 | #define OSSL_KDF_PARAM_INFO "info" /* octet string */ | |
| 125 | #define OSSL_KDF_PARAM_SEED "seed" /* octet string */ | |
| 126 | #define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */ | |
| 127 | #define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */ | |
| 128 | #define OSSL_KDF_PARAM_SSHKDF_TYPE "type" /* int */ | |
| 129 | #define OSSL_KDF_PARAM_SIZE "size" /* size_t */ | |
| 130 | ||
| ff64702b | 131 | /* PKEY parameters */ |
| 4889dadc MC |
132 | /* Diffie-Hellman/DSA Parameters */ |
| 133 | #define OSSL_PKEY_PARAM_FFC_P "ffc-p" | |
| 134 | #define OSSL_PKEY_PARAM_FFC_G "ffc-g" | |
| 135 | #define OSSL_PKEY_PARAM_FFC_Q "ffc-q" | |
| 136 | ||
| ff64702b MC |
137 | /* Diffie-Hellman Keys */ |
| 138 | #define OSSL_PKEY_PARAM_DH_PUB_KEY "dh-pub" | |
| 139 | #define OSSL_PKEY_PARAM_DH_PRIV_KEY "dh-priv" | |
| 140 | ||
| 4889dadc MC |
141 | /* DSA Keys */ |
| 142 | #define OSSL_PKEY_PARAM_DSA_PUB_KEY "dsa-pub" | |
| 143 | #define OSSL_PKEY_PARAM_DSA_PRIV_KEY "dsa-priv" | |
| 144 | ||
| 35aca9ec MC |
145 | /* Key Exchange parameters */ |
| 146 | ||
| 1c3ace68 | 147 | #define OSSL_EXCHANGE_PARAM_PAD "exchange-pad" /* uint */ |
| 35aca9ec | 148 | |
| 4889dadc MC |
149 | /* Signature parameters */ |
| 150 | #define OSSL_SIGNATURE_PARAM_DIGEST "digest" | |
| 151 | #define OSSL_SIGNATURE_PARAM_DIGEST_SIZE "digest-size" | |
| 152 | ||
| 8a73348b MC |
153 | # ifdef __cplusplus |
| 154 | } | |
| 155 | # endif | |
| 156 | ||
| 157 | #endif |