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 /* Well known parameter names that Providers can define */
  18 #define OSSL_PROV_PARAM_NAME            "name"                /* utf8_string */
  19 #define OSSL_PROV_PARAM_VERSION         "version"             /* utf8_string */
  20 #define OSSL_PROV_PARAM_BUILDINFO       "buildinfo"           /* utf8_string */
  21 #define OSSL_PROV_PARAM_MODULE_FILENAME "module-filename"     /* octet_string */
  22
  23 /* Self test callback parameters */
  24 #define OSSL_PROV_PARAM_SELF_TEST_PHASE  "st-phase" /* utf8_string */
  25 #define OSSL_PROV_PARAM_SELF_TEST_TYPE   "st-type"  /* utf8_string */
  26 #define OSSL_PROV_PARAM_SELF_TEST_DESC   "st-desc"  /* utf8_string */
  27
  28 /*
  29  * Algorithm parameters
  30  * If "engine" or "properties" are specified, they should always be paired
  31  * with the algorithm type.
  32  */
  33 #define OSSL_ALG_PARAM_DIGEST       "digest"    /* utf8_string */
  34 #define OSSL_ALG_PARAM_CIPHER       "cipher"    /* utf8_string */
  35 #define OSSL_ALG_PARAM_MAC          "mac"       /* utf8_string */
  36 #define OSSL_ALG_PARAM_PROPERTIES   "properties"/* utf8_string */
  37
  38 /* cipher parameters */
  39 #define OSSL_CIPHER_PARAM_PADDING              "padding"    /* uint */
  40 #define OSSL_CIPHER_PARAM_MODE                 "mode"       /* uint */
  41 #define OSSL_CIPHER_PARAM_BLOCK_SIZE           "blocksize" /* size_t */
  42 #define OSSL_CIPHER_PARAM_FLAGS                "flags"      /* ulong */
  43 #define OSSL_CIPHER_PARAM_KEYLEN               "keylen"     /* size_t */
  44 #define OSSL_CIPHER_PARAM_IVLEN                "ivlen"      /* size_t */
  45 #define OSSL_CIPHER_PARAM_IV                   "iv"         /* octet_string OR octet_ptr */
  46 #define OSSL_CIPHER_PARAM_NUM                  "num"        /* uint */
  47 #define OSSL_CIPHER_PARAM_ROUNDS               "rounds"     /* uint */
  48 #define OSSL_CIPHER_PARAM_AEAD_TAG             "tag"        /* octet_string */
  49 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD        "tlsaad"     /* octet_string */
  50 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD    "tlsaadpad"  /* size_t */
  51 #define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED   "tlsivfixed" /* octet_string */
  52 #define OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN "tlsivgen" /* octet_string */
  53 #define OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV "tlsivinv" /* octet_string */
  54 #define OSSL_CIPHER_PARAM_AEAD_IVLEN           OSSL_CIPHER_PARAM_IVLEN
  55 #define OSSL_CIPHER_PARAM_AEAD_TAGLEN          "taglen"     /* size_t */
  56 #define OSSL_CIPHER_PARAM_AEAD_MAC_KEY         "mackey"     /* octet_string */
  57 #define OSSL_CIPHER_PARAM_RANDOM_KEY           "randkey"    /* octet_string */
  58 #define OSSL_CIPHER_PARAM_RC2_KEYBITS          "keybits"    /* size_t */
  59 #define OSSL_CIPHER_PARAM_SPEED                "speed"      /* uint */
  60 /* For passing the AlgorithmIdentifier parameter in DER form */
  61 #define OSSL_CIPHER_PARAM_ALG_ID               "alg_id_param" /* octet_string */
  62
  63 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT                    \
  64     "tls1multi_maxsndfrag" /* uint */
  65 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE                          \
  66     "tls1multi_maxbufsz"   /* size_t */
  67 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE                           \
  68     "tls1multi_interleave" /* uint */
  69 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD                                  \
  70     "tls1multi_aad"        /* octet_string */
  71 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN                          \
  72     "tls1multi_aadpacklen" /* uint */
  73 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC                                  \
  74     "tls1multi_enc"        /* octet_string */
  75 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN                               \
  76     "tls1multi_encin"      /* octet_string */
  77 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN                              \
  78     "tls1multi_enclen"     /* size_t */
  79
  80 /* digest parameters */
  81 #define OSSL_DIGEST_PARAM_XOFLEN     "xoflen"    /* size_t */
  82 #define OSSL_DIGEST_PARAM_SSL3_MS    "ssl3-ms"   /* octet string */
  83 #define OSSL_DIGEST_PARAM_PAD_TYPE   "pad_type"  /* uint */
  84 #define OSSL_DIGEST_PARAM_MICALG     "micalg"    /* utf8 string */
  85 #define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */
  86 #define OSSL_DIGEST_PARAM_SIZE       "size"      /* size_t */
  87 #define OSSL_DIGEST_PARAM_FLAGS      "flags"     /* ulong */
  88
  89 /* Known DIGEST names (not a complete list) */
  90 #define OSSL_DIGEST_NAME_MD5            "MD5"
  91 #define OSSL_DIGEST_NAME_MD5_SHA1       "MD5-SHA1"
  92 #define OSSL_DIGEST_NAME_SHA1           "SHA1"
  93 #define OSSL_DIGEST_NAME_SHA2_224       "SHA2-224"
  94 #define OSSL_DIGEST_NAME_SHA2_256       "SHA2-256"
  95 #define OSSL_DIGEST_NAME_SHA2_384       "SHA2-384"
  96 #define OSSL_DIGEST_NAME_SHA2_512       "SHA2-512"
  97 #define OSSL_DIGEST_NAME_MD2            "MD2"
  98 #define OSSL_DIGEST_NAME_MD4            "MD4"
  99 #define OSSL_DIGEST_NAME_MDC2           "MDC2"
 100 #define OSSL_DIGEST_NAME_RIPEMD160      "RIPEMD160"
 101 #define OSSL_DIGEST_NAME_SHA3_224       "SHA3-224"
 102 #define OSSL_DIGEST_NAME_SHA3_256       "SHA3-256"
 103 #define OSSL_DIGEST_NAME_SHA3_384       "SHA3-384"
 104 #define OSSL_DIGEST_NAME_SHA3_512       "SHA3-512"
 105 #define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128"
 106 #define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256"
 107
 108 /* MAC parameters */
 109 #define OSSL_MAC_PARAM_KEY          "key"        /* octet string */
 110 #define OSSL_MAC_PARAM_IV           "iv"         /* octet string */
 111 #define OSSL_MAC_PARAM_CUSTOM       "custom"     /* utf8 string */
 112 #define OSSL_MAC_PARAM_SALT         "salt"       /* octet string */
 113 #define OSSL_MAC_PARAM_XOF          "xof"        /* int, 0 or 1 */
 114 #define OSSL_MAC_PARAM_FLAGS        "flags"      /* int */
 115 /*
 116  * If "engine" or "properties" are specified, they should always be paired
 117  * with "cipher" or "digest".
 118  */
 119 #define OSSL_MAC_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
 120 #define OSSL_MAC_PARAM_DIGEST       OSSL_ALG_PARAM_DIGEST     /* utf8 string */
 121 #define OSSL_MAC_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
 122 #define OSSL_MAC_PARAM_SIZE         "size"       /* size_t */
 123
 124 /* Known MAC names (not a complete list) */
 125 #define OSSL_MAC_NAME_CMAC          "CMAC"
 126 #define OSSL_MAC_NAME_HMAC          "HMAC"
 127 #define OSSL_MAC_NAME_KMAC128       "KMAC128"
 128 #define OSSL_MAC_NAME_KMAC256       "KMAC256"
 129
 130 /* KDF / PRF parameters */
 131 #define OSSL_KDF_PARAM_SECRET       "secret"    /* octet string */
 132 #define OSSL_KDF_PARAM_KEY          "key"       /* octet string */
 133 #define OSSL_KDF_PARAM_SALT         "salt"      /* octet string */
 134 #define OSSL_KDF_PARAM_PASSWORD     "pass"      /* octet string */
 135 #define OSSL_KDF_PARAM_DIGEST       OSSL_ALG_PARAM_DIGEST     /* utf8 string */
 136 #define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
 137 #define OSSL_KDF_PARAM_MAC          OSSL_ALG_PARAM_MAC        /* utf8 string */
 138 #define OSSL_KDF_PARAM_MAC_SIZE     "maclen"    /* size_t */
 139 #define OSSL_KDF_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
 140 #define OSSL_KDF_PARAM_ITER         "iter"      /* unsigned int */
 141 #define OSSL_KDF_PARAM_MODE         "mode"      /* utf8 string or int */
 142 #define OSSL_KDF_PARAM_PKCS5        "pkcs5"     /* int */
 143 #define OSSL_KDF_PARAM_UKM          "ukm"       /* octet string */
 144 #define OSSL_KDF_PARAM_CEK_ALG      "cekalg"    /* utf8 string */
 145 #define OSSL_KDF_PARAM_SCRYPT_N     "n"         /* uint64_t */
 146 #define OSSL_KDF_PARAM_SCRYPT_R     "r"         /* uint32_t */
 147 #define OSSL_KDF_PARAM_SCRYPT_P     "p"         /* uint32_t */
 148 #define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */
 149 #define OSSL_KDF_PARAM_INFO         "info"      /* octet string */
 150 #define OSSL_KDF_PARAM_SEED         "seed"      /* octet string */
 151 #define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */
 152 #define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */
 153 #define OSSL_KDF_PARAM_SSHKDF_TYPE  "type"      /* int */
 154 #define OSSL_KDF_PARAM_SIZE         "size"      /* size_t */
 155 #define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
 156 #define OSSL_KDF_PARAM_CONSTANT     "constant"  /* octet string */
 157
 158 /* Known KDF names */
 159 #define OSSL_KDF_NAME_HKDF          "HKDF"
 160 #define OSSL_KDF_NAME_PBKDF2        "PBKDF2"
 161 #define OSSL_KDF_NAME_SCRYPT        "SCRYPT"
 162 #define OSSL_KDF_NAME_SSHKDF        "SSHKDF"
 163 #define OSSL_KDF_NAME_SSKDF         "SSKDF"
 164 #define OSSL_KDF_NAME_TLS1_PRF      "TLS1-PRF"
 165 #define OSSL_KDF_NAME_X942KDF       "X942KDF"
 166 #define OSSL_KDF_NAME_X963KDF       "X963KDF"
 167 #define OSSL_KDF_NAME_KBKDF         "KBKDF"
 168 #define OSSL_KDF_NAME_KRB5KDF       "KRB5KDF"
 169
 170 /* PKEY parameters */
 171 /* Common PKEY parameters */
 172 #define OSSL_PKEY_PARAM_BITS                "bits" /* integer */
 173 #define OSSL_PKEY_PARAM_MAX_SIZE            "max-size" /* integer */
 174 #define OSSL_PKEY_PARAM_SECURITY_BITS       "security-bits" /* integer */
 175 #define OSSL_PKEY_PARAM_DIGEST              OSSL_ALG_PARAM_DIGEST
 176 #define OSSL_PKEY_PARAM_PROPERTIES          OSSL_ALG_PARAM_PROPERTIES
 177 #define OSSL_PKEY_PARAM_DEFAULT_DIGEST      "default-digest" /* utf8 string */
 178 #define OSSL_PKEY_PARAM_MANDATORY_DIGEST    "mandatory-digest" /* utf8 string */
 179 #define OSSL_PKEY_PARAM_PAD_MODE            "pad-mode"
 180 #define OSSL_PKEY_PARAM_DIGEST              OSSL_ALG_PARAM_DIGEST
 181 #define OSSL_PKEY_PARAM_PROPERTIES          OSSL_ALG_PARAM_PROPERTIES
 182 #define OSSL_PKEY_PARAM_DIGEST_SIZE         "digest-size"
 183 #define OSSL_PKEY_PARAM_MGF1_DIGEST         "mgf1-digest"
 184 #define OSSL_PKEY_PARAM_MGF1_PROPERTIES     "mgf1-properties"
 185
 186 /* Diffie-Hellman/DSA public/private key */
 187 #define OSSL_PKEY_PARAM_PUB_KEY             "pub"
 188 #define OSSL_PKEY_PARAM_PRIV_KEY            "priv"
 189
 190 /* Diffie-Hellman/DSA Parameters */
 191 #define OSSL_PKEY_PARAM_FFC_P        "p"
 192 #define OSSL_PKEY_PARAM_FFC_G        "g"
 193 #define OSSL_PKEY_PARAM_FFC_Q        "q"
 194
 195 /* Elliptic Curve Domain Parameters */
 196 #define OSSL_PKEY_PARAM_EC_NAME      "curve-name"
 197
 198 /* Elliptic Curve Key Parameters */
 199 #define OSSL_PKEY_PARAM_USE_COFACTOR_FLAG "use-cofactor-flag"
 200 #define OSSL_PKEY_PARAM_USE_COFACTOR_ECDH \
 201     OSSL_PKEY_PARAM_USE_COFACTOR_FLAG
 202
 203 /* RSA Keys */
 204 /*
 205  * n, e, d are the usual public and private key components
 206  *
 207  * rsa-num is the number of factors, including p and q
 208  * rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
 209  * rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
 210  * rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
 211  *
 212  * The number of rsa-factor items must be equal to the number of rsa-exponent
 213  * items, and the number of rsa-coefficients must be one less.
 214  * (the base i for the coefficients is 2, not 1, at least as implied by
 215  * RFC 8017)
 216  */
 217 #define OSSL_PKEY_PARAM_RSA_N           "n"
 218 #define OSSL_PKEY_PARAM_RSA_E           "e"
 219 #define OSSL_PKEY_PARAM_RSA_D           "d"
 220 #define OSSL_PKEY_PARAM_RSA_FACTOR      "rsa-factor"
 221 #define OSSL_PKEY_PARAM_RSA_EXPONENT    "rsa-exponent"
 222 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient"
 223
 224 /* Key Exchange parameters */
 225
 226 #define OSSL_EXCHANGE_PARAM_PAD                   "pad" /* uint */
 227 #define OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE "ecdh-cofactor-mode" /* int */
 228 #define OSSL_EXCHANGE_PARAM_KDF_TYPE              "kdf-type" /* utf8_string */
 229 #define OSSL_EXCHANGE_PARAM_KDF_DIGEST            "kdf-digest" /* utf8_string */
 230 #define OSSL_EXCHANGE_PARAM_KDF_DIGEST_PROPS      "kdf-digest-props" /* utf8_string */
 231 #define OSSL_EXCHANGE_PARAM_KDF_OUTLEN            "kdf-outlen" /* size_t */
 232
 233 /*
 234  * TODO(3.0): improve this pattern
 235  *
 236  * Currently the sole internal user of OSSL_EXCHANGE_PARAM_KDF_UKM is
 237  * EVP_PKEY_CTX_{set0,get0}_ecdh_kdf_ukm():
 238  *      OSSL_EXCHANGE_PARAM_KDF_UKM is handled as a octet_string on set0,
 239  *      and as an octet_ptr on get0.
 240  *
 241  * This pattern is borrowed from the handling of
 242  * OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL in
 243  * EVP_PKEY_CTX_{set0,get0}_rsa_oaep_label().
 244  */
 245 #define OSSL_EXCHANGE_PARAM_KDF_UKM               "kdf-ukm" /* see note above */
 246 #define OSSL_EXCHANGE_PARAM_KDF_UKM_LEN           "kdf-ukm-len" /* size_t */
 247
 248 /* Signature parameters */
 249 #define OSSL_SIGNATURE_PARAM_ALGORITHM_ID       "algorithm-id"
 250 #define OSSL_SIGNATURE_PARAM_PAD_MODE           OSSL_PKEY_PARAM_PAD_MODE
 251 #define OSSL_SIGNATURE_PARAM_DIGEST             OSSL_PKEY_PARAM_DIGEST
 252 #define OSSL_SIGNATURE_PARAM_PROPERTIES         OSSL_PKEY_PARAM_PROPERTIES
 253 #define OSSL_SIGNATURE_PARAM_PSS_SALTLEN        "pss-saltlen"
 254 #define OSSL_SIGNATURE_PARAM_MGF1_DIGEST        OSSL_PKEY_PARAM_MGF1_DIGEST
 255 #define OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES    \
 256     OSSL_PKEY_PARAM_MGF1_PROPERTIES
 257
 258 /* Asym cipher parameters */
 259 #define OSSL_ASYM_CIPHER_PARAM_PAD_MODE                 OSSL_PKEY_PARAM_PAD_MODE
 260 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST              \
 261     OSSL_PKEY_PARAM_MGF1_DIGEST
 262 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS        \
 263     OSSL_PKEY_PARAM_MGF1_PROPERTIES
 264 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST              OSSL_ALG_PARAM_DIGEST
 265 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS        "digest-props"
 266 #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL               "oaep-label"
 267 #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN           "oaep-label-len"
 268 #define OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION       "tls-client-version"
 269 #define OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION   "tls-negotiated-version"
 270
 271 /*
 272  * Serializer parameters
 273  */
 274 /* The passphrase may be passed as a utf8 string or an octet string */
 275 #define OSSL_SERIALIZER_PARAM_CIPHER            OSSL_ALG_PARAM_CIPHER
 276 #define OSSL_SERIALIZER_PARAM_PROPERTIES        OSSL_ALG_PARAM_PROPERTIES
 277 #define OSSL_SERIALIZER_PARAM_PASS              "passphrase"
 278
 279 /* Passphrase callback parameters */
 280 #define OSSL_PASSPHRASE_PARAM_INFO              "info"
 281
 282 # ifdef __cplusplus
 283 }
 284 # endif
 285
 286 #endif