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