db9cb9ab2d4491e805bac9122822cd34ed01df39
[openssl.git] / include / openssl / core_names.h
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 OPENSSL_CORE_NAMES_H
11 # define OPENSSL_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
37 /*
38  * The module filename
39  * Type: OSSL_PARAM_OCTET_STRING
40  */
41 #define OSSL_PROV_PARAM_MODULE_FILENAME "module-filename"
42
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_MAC          "mac"       /* utf8_string */
51 #define OSSL_ALG_PARAM_PROPERTIES   "properties"/* utf8_string */
52
53 /* cipher parameters */
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 */
57 #define OSSL_CIPHER_PARAM_FLAGS                "flags"      /* ulong */
58 #define OSSL_CIPHER_PARAM_KEYLEN               "keylen"     /* size_t */
59 #define OSSL_CIPHER_PARAM_IVLEN                "ivlen"      /* size_t */
60 #define OSSL_CIPHER_PARAM_IV                   "iv"         /* octet_string OR octet_ptr */
61 #define OSSL_CIPHER_PARAM_NUM                  "num"        /* uint */
62 #define OSSL_CIPHER_PARAM_ROUNDS               "rounds"     /* uint */
63 #define OSSL_CIPHER_PARAM_AEAD_TAG             "tag"        /* octet_string */
64 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD        "tlsaad"     /* octet_string */
65 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD    "tlsaadpad"  /* size_t */
66 #define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED   "tlsivfixed" /* octet_string */
67 #define OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN "tlsivgen" /* octet_string */
68 #define OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV "tlsivinv" /* octet_string */
69 #define OSSL_CIPHER_PARAM_AEAD_IVLEN           OSSL_CIPHER_PARAM_IVLEN
70 #define OSSL_CIPHER_PARAM_AEAD_TAGLEN          "taglen"     /* size_t */
71 #define OSSL_CIPHER_PARAM_AEAD_MAC_KEY         "mackey"     /* octet_string */
72 #define OSSL_CIPHER_PARAM_RANDOM_KEY           "randkey"    /* octet_string */
73 #define OSSL_CIPHER_PARAM_RC2_KEYBITS          "keybits"    /* size_t */
74 #define OSSL_CIPHER_PARAM_SPEED                "speed"      /* uint */
75 /* For passing the AlgorithmIdentifier parameter in DER form */
76 #define OSSL_CIPHER_PARAM_ALG_ID               "alg_id_param" /* octet_string */
77
78 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT                    \
79     "tls1multi_maxsndfrag" /* uint */
80 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE                          \
81     "tls1multi_maxbufsz"   /* size_t */
82 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE                           \
83     "tls1multi_interleave" /* uint */
84 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD                                  \
85     "tls1multi_aad"        /* octet_string */
86 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN                          \
87     "tls1multi_aadpacklen" /* uint */
88 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC                                  \
89     "tls1multi_enc"        /* octet_string */
90 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN                               \
91     "tls1multi_encin"      /* octet_string */
92 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN                              \
93     "tls1multi_enclen"     /* size_t */
94
95 /* digest parameters */
96 #define OSSL_DIGEST_PARAM_XOFLEN     "xoflen"    /* size_t */
97 #define OSSL_DIGEST_PARAM_SSL3_MS    "ssl3-ms"   /* octet string */
98 #define OSSL_DIGEST_PARAM_PAD_TYPE   "pad_type"  /* uint */
99 #define OSSL_DIGEST_PARAM_MICALG     "micalg"    /* utf8 string */
100 #define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */
101 #define OSSL_DIGEST_PARAM_SIZE       "size"      /* size_t */
102 #define OSSL_DIGEST_PARAM_FLAGS      "flags"     /* ulong */
103
104 /* Known DIGEST names (not a complete list) */
105 #define OSSL_DIGEST_NAME_MD5 "MD5"
106 #define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128"
107 #define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256"
108
109 /* MAC parameters */
110 #define OSSL_MAC_PARAM_KEY          "key"        /* octet string */
111 #define OSSL_MAC_PARAM_IV           "iv"         /* octet string */
112 #define OSSL_MAC_PARAM_CUSTOM       "custom"     /* utf8 string */
113 #define OSSL_MAC_PARAM_SALT         "salt"       /* octet string */
114 #define OSSL_MAC_PARAM_XOF          "xof"        /* int, 0 or 1 */
115 #define OSSL_MAC_PARAM_FLAGS        "flags"      /* int */
116 /*
117  * If "engine" or "properties" are specified, they should always be paired
118  * with "cipher" or "digest".
119  */
120 #define OSSL_MAC_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
121 #define OSSL_MAC_PARAM_DIGEST       OSSL_ALG_PARAM_DIGEST     /* utf8 string */
122 #define OSSL_MAC_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
123 #define OSSL_MAC_PARAM_SIZE         "size"       /* size_t */
124
125 /* Known MAC names (not a complete list) */
126 #define OSSL_MAC_NAME_CMAC          "CMAC"
127 #define OSSL_MAC_NAME_HMAC          "HMAC"
128 #define OSSL_MAC_NAME_KMAC128       "KMAC128"
129 #define OSSL_MAC_NAME_KMAC256       "KMAC256"
130
131 /* KDF / PRF parameters */
132 #define OSSL_KDF_PARAM_SECRET       "secret"    /* octet string */
133 #define OSSL_KDF_PARAM_KEY          "key"       /* octet string */
134 #define OSSL_KDF_PARAM_SALT         "salt"      /* octet string */
135 #define OSSL_KDF_PARAM_PASSWORD     "pass"      /* octet string */
136 #define OSSL_KDF_PARAM_DIGEST       OSSL_ALG_PARAM_DIGEST     /* utf8 string */
137 #define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
138 #define OSSL_KDF_PARAM_MAC          OSSL_ALG_PARAM_MAC        /* utf8 string */
139 #define OSSL_KDF_PARAM_MAC_SIZE     "maclen"    /* size_t */
140 #define OSSL_KDF_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
141 #define OSSL_KDF_PARAM_ITER         "iter"      /* unsigned int */
142 #define OSSL_KDF_PARAM_MODE         "mode"      /* utf8 string or int */
143 #define OSSL_KDF_PARAM_PKCS5        "pkcs5"     /* int */
144 #define OSSL_KDF_PARAM_UKM          "ukm"       /* octet string */
145 #define OSSL_KDF_PARAM_CEK_ALG      "cekalg"    /* utf8 string */
146 #define OSSL_KDF_PARAM_SCRYPT_N     "n"         /* uint64_t */
147 #define OSSL_KDF_PARAM_SCRYPT_R     "r"         /* uint32_t */
148 #define OSSL_KDF_PARAM_SCRYPT_P     "p"         /* uint32_t */
149 #define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */
150 #define OSSL_KDF_PARAM_INFO         "info"      /* octet string */
151 #define OSSL_KDF_PARAM_SEED         "seed"      /* octet string */
152 #define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */
153 #define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */
154 #define OSSL_KDF_PARAM_SSHKDF_TYPE  "type"      /* int */
155 #define OSSL_KDF_PARAM_SIZE         "size"      /* size_t */
156 #define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
157 #define OSSL_KDF_PARAM_CONSTANT     "constant"  /* octet string */
158
159 /* Known KDF names */
160 #define OSSL_KDF_NAME_HKDF          "HKDF"
161 #define OSSL_KDF_NAME_PBKDF2        "PBKDF2"
162 #define OSSL_KDF_NAME_SCRYPT        "SCRYPT"
163 #define OSSL_KDF_NAME_SSHKDF        "SSHKDF"
164 #define OSSL_KDF_NAME_SSKDF         "SSKDF"
165 #define OSSL_KDF_NAME_TLS1_PRF      "TLS1-PRF"
166 #define OSSL_KDF_NAME_X942KDF       "X942KDF"
167 #define OSSL_KDF_NAME_X963KDF       "X963KDF"
168 #define OSSL_KDF_NAME_KBKDF         "KBKDF"
169 #define OSSL_KDF_NAME_KRB5KDF       "KRB5KDF"
170
171 /* PKEY parameters */
172 /* Diffie-Hellman/DSA Parameters */
173 #define OSSL_PKEY_PARAM_FFC_P        "p"
174 #define OSSL_PKEY_PARAM_FFC_G        "g"
175 #define OSSL_PKEY_PARAM_FFC_Q        "q"
176
177 /* Diffie-Hellman Keys */
178 #define OSSL_PKEY_PARAM_DH_PUB_KEY   "pub"
179 #define OSSL_PKEY_PARAM_DH_PRIV_KEY  "priv"
180
181 /* DSA Keys */
182 #define OSSL_PKEY_PARAM_DSA_PUB_KEY  "pub"
183 #define OSSL_PKEY_PARAM_DSA_PRIV_KEY "priv"
184
185 /* RSA Keys */
186 /*
187  * n, e, d are the usual public and private key components
188  *
189  * rsa-num is the number of factors, including p and q
190  * rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
191  * rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
192  * rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
193  *
194  * The number of rsa-factor items must be equal to the number of rsa-exponent
195  * items, and the number of rsa-coefficients must be one less.
196  * (the base i for the coefficients is 2, not 1, at least as implied by
197  * RFC 8017)
198  */
199 #define OSSL_PKEY_PARAM_RSA_N           "n"
200 #define OSSL_PKEY_PARAM_RSA_E           "e"
201 #define OSSL_PKEY_PARAM_RSA_D           "d"
202 #define OSSL_PKEY_PARAM_RSA_FACTOR      "rsa-factor"
203 #define OSSL_PKEY_PARAM_RSA_EXPONENT    "rsa-exponent"
204 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient"
205
206 /* Key Exchange parameters */
207
208 #define OSSL_EXCHANGE_PARAM_PAD      "pad" /* uint */
209
210 /* Signature parameters */
211 #define OSSL_SIGNATURE_PARAM_DIGEST         OSSL_ALG_PARAM_DIGEST
212 #define OSSL_SIGNATURE_PARAM_DIGEST_SIZE    "digest-size"
213
214 /* Asym cipher parameters */
215 #define OSSL_ASYM_CIPHER_PARAM_PAD_MODE                 "pad-mode"
216 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST              OSSL_ALG_PARAM_DIGEST
217 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS        "digest-props"
218 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST              "mgf1-digest"
219 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS        "mgf1-digest-props"
220 #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL               "oaep-label"
221 #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN           "oaep-label-len"
222 #define OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION       "tls-client-version"
223 #define OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION   "tls-negotiated-version"
224
225 /*
226  * Serializer parameters
227  */
228 /* The passphrase may be passed as a utf8 string or an octet string */
229 #define OSSL_SERIALIZER_PARAM_CIPHER            OSSL_ALG_PARAM_CIPHER
230 #define OSSL_SERIALIZER_PARAM_PROPERTIES        OSSL_ALG_PARAM_PROPERTIES
231 #define OSSL_SERIALIZER_PARAM_PASS              "passphrase"
232
233 /* Passphrase callback parameters */
234 #define OSSL_PASSPHRASE_PARAM_INFO              "info"
235
236 # ifdef __cplusplus
237 }
238 # endif
239
240 #endif