c1bc3a7d7bf96c51aa85be029a5a1e92c62b507c
[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 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
37 /*
38  * The module filename
39  * Type: OSSL_PARAM_OCTET_STRING
40  */
41 #define OSSL_PROV_PARAM_MODULE_FILENAME "module-filename"
42
43 /* cipher parameters */
44 #define OSSL_CIPHER_PARAM_PADDING   "padding"    /* int */
45 #define OSSL_CIPHER_PARAM_MODE      "mode"       /* int */
46 #define OSSL_CIPHER_PARAM_BLOCK_SIZE "blocksize" /* int */
47 #define OSSL_CIPHER_PARAM_FLAGS     "flags"      /* ulong */
48 #define OSSL_CIPHER_PARAM_KEYLEN    "keylen"     /* int */
49 #define OSSL_CIPHER_PARAM_IVLEN     "ivlen"      /* int */
50 #define OSSL_CIPHER_PARAM_IV        "iv"         /* octet_string OR octet_ptr */
51 #define OSSL_CIPHER_PARAM_NUM       "num"        /* int */
52 #define OSSL_CIPHER_PARAM_AEAD_TAG           "tag"        /* octet_string */
53 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD      "tlsaad"     /* octet_string */
54 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD  "tlsaadpad"  /* size_t */
55 #define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED "tlsivfixed" /* octet_string */
56 #define OSSL_CIPHER_PARAM_AEAD_IVLEN         "aeadivlen"  /* size_t */
57
58 /* digest parameters */
59 #define OSSL_DIGEST_PARAM_XOFLEN    "xoflen"
60 #define OSSL_DIGEST_PARAM_SSL3_MS   "ssl3-ms"
61 #define OSSL_DIGEST_PARAM_PAD_TYPE  "pad_type"
62 #define OSSL_DIGEST_PARAM_MICALG    "micalg"
63 #define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* OSSL_PARAM_INTEGER */
64 #define OSSL_DIGEST_PARAM_SIZE      "size" /* OSSL_PARAM_INTEGER */
65 #define OSSL_DIGEST_PARAM_FLAGS     "flags" /* OSSL_PARAM_UNSIGNED_INTEGER */
66
67 /* MAC parameters */
68 #define OSSL_MAC_PARAM_KEY          "key"       /* octet string */
69 #define OSSL_MAC_PARAM_IV           "iv"        /* octet string */
70 #define OSSL_MAC_PARAM_CUSTOM       "custom"    /* utf8 string */
71 #define OSSL_MAC_PARAM_SALT         "salt"      /* octet string */
72 #define OSSL_MAC_PARAM_XOF          "xof"       /* int, 0 or 1 */
73 #define OSSL_MAC_PARAM_FLAGS        "flags"     /* int */
74 /* Note that "md" and "digest" are equivalent */
75 #define OSSL_MAC_PARAM_MD           "md"        /* utf8 string */
76 #define OSSL_MAC_PARAM_DIGEST       "digest"    /* utf8 string */
77 #define OSSL_MAC_PARAM_CIPHER       "cipher"    /* utf8 string */
78 /* Note that "algorithm" can be used instead of "md", "digest" or "cipher" */
79 #define OSSL_MAC_PARAM_ALGORITHM    "algorithm" /* utf8 string */
80 #define OSSL_MAC_PARAM_ENGINE       "engine"    /* utf8 string */
81 #define OSSL_MAC_PARAM_PROPERTIES   "properties" /* utf8 string */
82 /* Note that "size", "digestsize" and "outlen" are equivalent */
83 #define OSSL_MAC_PARAM_SIZE         "size"      /* size_t */
84 #define OSSL_MAC_PARAM_DIGESTSIZE   "digestsize" /* size_t */
85 #define OSSL_MAC_PARAM_OUTLEN       "outlen"    /* size_t */
86
87 /* PKEY parameters */
88 /* Diffie-Hellman Parameters */
89 #define OSSL_PKEY_PARAM_DH_P         "dh-p"
90 #define OSSL_PKEY_PARAM_DH_G         "dh-g"
91 #define OSSL_PKEY_PARAM_DH_Q         "dh-q"
92 /* Diffie-Hellman Keys */
93 #define OSSL_PKEY_PARAM_DH_PUB_KEY   "dh-pub"
94 #define OSSL_PKEY_PARAM_DH_PRIV_KEY  "dh-priv"
95
96 /* Key Exchange parameters */
97
98 #define OSSL_EXCHANGE_PARAM_PAD           "exchange-pad"
99
100 # ifdef __cplusplus
101 }
102 # endif
103
104 #endif