1e8b764fb42bc7bcf4c7d350c251966d93949a1a
[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_IVLEN         OSSL_CIPHER_PARAM_IVLEN
68 #define OSSL_CIPHER_PARAM_AEAD_TAGLEN        "taglen"     /* size_t */
69 #define OSSL_CIPHER_PARAM_AEAD_MAC_KEY       "mackey"     /* octet_string */
70 #define OSSL_CIPHER_PARAM_RANDOM_KEY         "randkey"    /* octet_string */
71 #define OSSL_CIPHER_PARAM_RC2_KEYBITS        "keybits"    /* size_t */
72 #define OSSL_CIPHER_PARAM_SPEED              "speed"      /* uint */
73 /* For passing the AlgorithmIdentifier parameter in DER form */
74 #define OSSL_CIPHER_PARAM_ALG_ID             "alg_id_param" /* octet_string */
75
76
77 /* digest parameters */
78 #define OSSL_DIGEST_PARAM_XOFLEN     "xoflen"    /* size_t */
79 #define OSSL_DIGEST_PARAM_SSL3_MS    "ssl3-ms"   /* octet string */
80 #define OSSL_DIGEST_PARAM_PAD_TYPE   "pad_type"  /* uint */
81 #define OSSL_DIGEST_PARAM_MICALG     "micalg"    /* utf8 string */
82 #define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */
83 #define OSSL_DIGEST_PARAM_SIZE       "size"      /* size_t */
84 #define OSSL_DIGEST_PARAM_FLAGS      "flags"     /* ulong */
85
86 /* Known DIGEST names (not a complete list) */
87 #define OSSL_DIGEST_NAME_MD5 "MD5"
88 #define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128"
89 #define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256"
90
91 /* MAC parameters */
92 #define OSSL_MAC_PARAM_KEY          "key"        /* octet string */
93 #define OSSL_MAC_PARAM_IV           "iv"         /* octet string */
94 #define OSSL_MAC_PARAM_CUSTOM       "custom"     /* utf8 string */
95 #define OSSL_MAC_PARAM_SALT         "salt"       /* octet string */
96 #define OSSL_MAC_PARAM_XOF          "xof"        /* int, 0 or 1 */
97 #define OSSL_MAC_PARAM_FLAGS        "flags"      /* int */
98 /*
99  * If "engine" or "properties" are specified, they should always be paired
100  * with "cipher" or "digest".
101  */
102 #define OSSL_MAC_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
103 #define OSSL_MAC_PARAM_DIGEST       OSSL_ALG_PARAM_DIGEST     /* utf8 string */
104 #define OSSL_MAC_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
105 #define OSSL_MAC_PARAM_SIZE         "size"       /* size_t */
106
107 /* Known MAC names (not a complete list) */
108 #define OSSL_MAC_NAME_CMAC          "CMAC"
109 #define OSSL_MAC_NAME_HMAC          "HMAC"
110 #define OSSL_MAC_NAME_KMAC128       "KMAC128"
111 #define OSSL_MAC_NAME_KMAC256       "KMAC256"
112
113 /* KDF / PRF parameters */
114 #define OSSL_KDF_PARAM_SECRET       "secret"    /* octet string */
115 #define OSSL_KDF_PARAM_KEY          "key"       /* octet string */
116 #define OSSL_KDF_PARAM_SALT         "salt"      /* octet string */
117 #define OSSL_KDF_PARAM_PASSWORD     "pass"      /* octet string */
118 #define OSSL_KDF_PARAM_DIGEST       OSSL_ALG_PARAM_DIGEST     /* utf8 string */
119 #define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
120 #define OSSL_KDF_PARAM_MAC          OSSL_ALG_PARAM_MAC        /* utf8 string */
121 #define OSSL_KDF_PARAM_MAC_SIZE     "maclen"    /* size_t */
122 #define OSSL_KDF_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
123 #define OSSL_KDF_PARAM_ITER         "iter"      /* unsigned int */
124 #define OSSL_KDF_PARAM_MODE         "mode"      /* utf8 string or int */
125 #define OSSL_KDF_PARAM_PKCS5        "pkcs5"     /* int */
126 #define OSSL_KDF_PARAM_UKM          "ukm"       /* octet string */
127 #define OSSL_KDF_PARAM_CEK_ALG      "cekalg"    /* utf8 string */
128 #define OSSL_KDF_PARAM_SCRYPT_N     "n"         /* uint64_t */
129 #define OSSL_KDF_PARAM_SCRYPT_R     "r"         /* uint32_t */
130 #define OSSL_KDF_PARAM_SCRYPT_P     "p"         /* uint32_t */
131 #define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */
132 #define OSSL_KDF_PARAM_INFO         "info"      /* octet string */
133 #define OSSL_KDF_PARAM_SEED         "seed"      /* octet string */
134 #define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */
135 #define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */
136 #define OSSL_KDF_PARAM_SSHKDF_TYPE  "type"      /* int */
137 #define OSSL_KDF_PARAM_SIZE         "size"      /* size_t */
138 #define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
139 #define OSSL_KDF_PARAM_CONSTANT     "constant"  /* octet string */
140
141 /* Known KDF names */
142 #define OSSL_KDF_NAME_HKDF          "HKDF"
143 #define OSSL_KDF_NAME_PBKDF2        "PBKDF2"
144 #define OSSL_KDF_NAME_SCRYPT        "SCRYPT"
145 #define OSSL_KDF_NAME_SSHKDF        "SSHKDF"
146 #define OSSL_KDF_NAME_SSKDF         "SSKDF"
147 #define OSSL_KDF_NAME_TLS1_PRF      "TLS1-PRF"
148 #define OSSL_KDF_NAME_X942KDF       "X942KDF"
149 #define OSSL_KDF_NAME_X963KDF       "X963KDF"
150 #define OSSL_KDF_NAME_KBKDF         "KBKDF"
151 #define OSSL_KDF_NAME_KRB5KDF       "KRB5KDF"
152
153 /* PKEY parameters */
154 /* Diffie-Hellman/DSA Parameters */
155 #define OSSL_PKEY_PARAM_FFC_P        "p"
156 #define OSSL_PKEY_PARAM_FFC_G        "g"
157 #define OSSL_PKEY_PARAM_FFC_Q        "q"
158
159 /* Diffie-Hellman Keys */
160 #define OSSL_PKEY_PARAM_DH_PUB_KEY   "pub"
161 #define OSSL_PKEY_PARAM_DH_PRIV_KEY  "priv"
162
163 /* DSA Keys */
164 #define OSSL_PKEY_PARAM_DSA_PUB_KEY  "pub"
165 #define OSSL_PKEY_PARAM_DSA_PRIV_KEY "priv"
166
167 /* RSA Keys */
168 /*
169  * n, e, d are the usual public and private key components
170  *
171  * rsa-num is the number of factors, including p and q
172  * rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
173  * rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
174  * rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
175  *
176  * The number of rsa-factor items must be equal to the number of rsa-exponent
177  * items, and the number of rsa-coefficients must be one less.
178  * (the base i for the coefficients is 2, not 1, at least as implied by
179  * RFC 8017)
180  */
181 #define OSSL_PKEY_PARAM_RSA_N           "n"
182 #define OSSL_PKEY_PARAM_RSA_E           "e"
183 #define OSSL_PKEY_PARAM_RSA_D           "d"
184 #define OSSL_PKEY_PARAM_RSA_FACTOR      "rsa-factor"
185 #define OSSL_PKEY_PARAM_RSA_EXPONENT    "rsa-exponent"
186 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient"
187
188 /* Key Exchange parameters */
189
190 #define OSSL_EXCHANGE_PARAM_PAD      "pad" /* uint */
191
192 /* Signature parameters */
193 #define OSSL_SIGNATURE_PARAM_DIGEST         OSSL_ALG_PARAM_DIGEST
194 #define OSSL_SIGNATURE_PARAM_DIGEST_SIZE    "digest-size"
195
196 /* Asym cipher parameters */
197 #define OSSL_ASYM_CIPHER_PARAM_PAD_MODE             "pad-mode"
198 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST          OSSL_ALG_PARAM_DIGEST
199 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS    "digest-props"
200 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST          "mgf1-digest"
201 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS    "mgf1-digest-props"
202 #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL           "oaep-label"
203 #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN       "oaep-label-len"
204
205 # ifdef __cplusplus
206 }
207 # endif
208
209 #endif