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