include/openssl/core_names.h

   1 /*
   2  * Copyright 2019-2020 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 core passes to providers */
  18 #define OSSL_PROV_PARAM_CORE_VERSION         "openssl-version" /* utf8_ptr */
  19 #define OSSL_PROV_PARAM_CORE_PROV_NAME       "provider-name"   /* utf8_ptr */
  20 #define OSSL_PROV_PARAM_CORE_MODULE_FILENAME "module-filename" /* utf8_ptr */
  21
  22 /* Well known parameter names that Providers can define */
  23 #define OSSL_PROV_PARAM_NAME            "name"                /* utf8_string */
  24 #define OSSL_PROV_PARAM_VERSION         "version"             /* utf8_string */
  25 #define OSSL_PROV_PARAM_BUILDINFO       "buildinfo"           /* utf8_string */
  26 #define OSSL_PROV_PARAM_STATUS          "status"              /* uint */
  27 #define OSSL_PROV_PARAM_SECURITY_CHECKS "security-checks"     /* uint */
  28
  29 /* Self test callback parameters */
  30 #define OSSL_PROV_PARAM_SELF_TEST_PHASE  "st-phase" /* utf8_string */
  31 #define OSSL_PROV_PARAM_SELF_TEST_TYPE   "st-type"  /* utf8_string */
  32 #define OSSL_PROV_PARAM_SELF_TEST_DESC   "st-desc"  /* utf8_string */
  33
  34 /*-
  35  * Provider-native object abstractions
  36  *
  37  * These are used when a provider wants to pass object data or an object
  38  * reference back to libcrypto.  This is only useful for provider functions
  39  * that take a callback to which an OSSL_PARAM array with these parameters
  40  * can be passed.
  41  *
  42  * This set of parameter names is explained in detail in provider-object(7)
  43  * (doc/man7/provider-object.pod)
  44  */
  45 #define OSSL_OBJECT_PARAM_TYPE       "type"      /* INTEGER */
  46 #define OSSL_OBJECT_PARAM_DATA_TYPE  "data-type" /* UTF8_STRING */
  47 #define OSSL_OBJECT_PARAM_REFERENCE  "reference" /* OCTET_STRING */
  48 #define OSSL_OBJECT_PARAM_DATA       "data" /* OCTET_STRING or UTF8_STRING */
  49 #define OSSL_OBJECT_PARAM_DESC       "desc"      /* UTF8_STRING */
  50
  51 /*
  52  * Algorithm parameters
  53  * If "engine" or "properties" are specified, they should always be paired
  54  * with the algorithm type.
  55  * Note these are common names that are shared by many types (such as kdf, mac,
  56  * and pkey) e.g: see OSSL_MAC_PARAM_DIGEST below.
  57  */
  58 #define OSSL_ALG_PARAM_DIGEST       "digest"    /* utf8_string */
  59 #define OSSL_ALG_PARAM_CIPHER       "cipher"    /* utf8_string */
  60 #define OSSL_ALG_PARAM_ENGINE       "engine"    /* utf8_string */
  61 #define OSSL_ALG_PARAM_MAC          "mac"       /* utf8_string */
  62 #define OSSL_ALG_PARAM_PROPERTIES   "properties"/* utf8_string */
  63
  64 /* cipher parameters */
  65 #define OSSL_CIPHER_PARAM_PADDING              "padding"      /* uint */
  66 #define OSSL_CIPHER_PARAM_TLS_VERSION          "tls-version"  /* uint */
  67 #define OSSL_CIPHER_PARAM_TLS_MAC              "tls-mac"      /* octet_ptr */
  68 #define OSSL_CIPHER_PARAM_TLS_MAC_SIZE         "tls-mac-size" /* size_t */
  69 #define OSSL_CIPHER_PARAM_MODE                 "mode"         /* uint */
  70 #define OSSL_CIPHER_PARAM_BLOCK_SIZE           "blocksize"    /* size_t */
  71 #define OSSL_CIPHER_PARAM_FLAGS                "flags"        /* ulong */
  72 #define OSSL_CIPHER_PARAM_KEYLEN               "keylen"       /* size_t */
  73 #define OSSL_CIPHER_PARAM_IVLEN                "ivlen"        /* size_t */
  74 #define OSSL_CIPHER_PARAM_IV                   "iv"           /* octet_string OR octet_ptr */
  75 #define OSSL_CIPHER_PARAM_IV_STATE             "iv-state"     /* octet_string OR octet_ptr */
  76 #define OSSL_CIPHER_PARAM_NUM                  "num"          /* uint */
  77 #define OSSL_CIPHER_PARAM_ROUNDS               "rounds"       /* uint */
  78 #define OSSL_CIPHER_PARAM_AEAD_TAG             "tag"          /* octet_string */
  79 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD        "tlsaad"       /* octet_string */
  80 #define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD    "tlsaadpad"    /* size_t */
  81 #define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED   "tlsivfixed"   /* octet_string */
  82 #define OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN "tlsivgen"     /* octet_string */
  83 #define OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV "tlsivinv"     /* octet_string */
  84 #define OSSL_CIPHER_PARAM_AEAD_IVLEN           OSSL_CIPHER_PARAM_IVLEN
  85 #define OSSL_CIPHER_PARAM_AEAD_TAGLEN          "taglen"       /* size_t */
  86 #define OSSL_CIPHER_PARAM_AEAD_MAC_KEY         "mackey"       /* octet_string */
  87 #define OSSL_CIPHER_PARAM_RANDOM_KEY           "randkey"      /* octet_string */
  88 #define OSSL_CIPHER_PARAM_RC2_KEYBITS          "keybits"      /* size_t */
  89 #define OSSL_CIPHER_PARAM_SPEED                "speed"        /* uint */
  90 #define OSSL_CIPHER_PARAM_CTS_MODE             "cts_mode"     /* utf8_string */
  91 /* For passing the AlgorithmIdentifier parameter in DER form */
  92 #define OSSL_CIPHER_PARAM_ALG_ID               "alg_id_param" /* octet_string */
  93
  94 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT                    \
  95     "tls1multi_maxsndfrag" /* uint */
  96 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE                          \
  97     "tls1multi_maxbufsz"   /* size_t */
  98 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE                           \
  99     "tls1multi_interleave" /* uint */
 100 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD                                  \
 101     "tls1multi_aad"        /* octet_string */
 102 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN                          \
 103     "tls1multi_aadpacklen" /* uint */
 104 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC                                  \
 105     "tls1multi_enc"        /* octet_string */
 106 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN                               \
 107     "tls1multi_encin"      /* octet_string */
 108 #define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN                              \
 109     "tls1multi_enclen"     /* size_t */
 110
 111 /* OSSL_CIPHER_PARAM_CTS_MODE Values */
 112 #define OSSL_CIPHER_CTS_MODE_CS1 "CS1"
 113 #define OSSL_CIPHER_CTS_MODE_CS2 "CS2"
 114 #define OSSL_CIPHER_CTS_MODE_CS3 "CS3"
 115
 116 /* digest parameters */
 117 #define OSSL_DIGEST_PARAM_XOFLEN     "xoflen"    /* size_t */
 118 #define OSSL_DIGEST_PARAM_SSL3_MS    "ssl3-ms"   /* octet string */
 119 #define OSSL_DIGEST_PARAM_PAD_TYPE   "pad_type"  /* uint */
 120 #define OSSL_DIGEST_PARAM_MICALG     "micalg"    /* utf8 string */
 121 #define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */
 122 #define OSSL_DIGEST_PARAM_SIZE       "size"      /* size_t */
 123 #define OSSL_DIGEST_PARAM_FLAGS      "flags"     /* ulong */
 124
 125 /* Known DIGEST names (not a complete list) */
 126 #define OSSL_DIGEST_NAME_MD5            "MD5"
 127 #define OSSL_DIGEST_NAME_MD5_SHA1       "MD5-SHA1"
 128 #define OSSL_DIGEST_NAME_SHA1           "SHA1"
 129 #define OSSL_DIGEST_NAME_SHA2_224       "SHA2-224"
 130 #define OSSL_DIGEST_NAME_SHA2_256       "SHA2-256"
 131 #define OSSL_DIGEST_NAME_SHA2_384       "SHA2-384"
 132 #define OSSL_DIGEST_NAME_SHA2_512       "SHA2-512"
 133 #define OSSL_DIGEST_NAME_SHA2_512_224   "SHA2-512/224"
 134 #define OSSL_DIGEST_NAME_SHA2_512_256   "SHA2-512/256"
 135 #define OSSL_DIGEST_NAME_MD2            "MD2"
 136 #define OSSL_DIGEST_NAME_MD4            "MD4"
 137 #define OSSL_DIGEST_NAME_MDC2           "MDC2"
 138 #define OSSL_DIGEST_NAME_RIPEMD160      "RIPEMD160"
 139 #define OSSL_DIGEST_NAME_SHA3_224       "SHA3-224"
 140 #define OSSL_DIGEST_NAME_SHA3_256       "SHA3-256"
 141 #define OSSL_DIGEST_NAME_SHA3_384       "SHA3-384"
 142 #define OSSL_DIGEST_NAME_SHA3_512       "SHA3-512"
 143 #define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128"
 144 #define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256"
 145 #define OSSL_DIGEST_NAME_SM3            "SM3"
 146
 147 /* MAC parameters */
 148 #define OSSL_MAC_PARAM_KEY          "key"        /* octet string */
 149 #define OSSL_MAC_PARAM_IV           "iv"         /* octet string */
 150 #define OSSL_MAC_PARAM_CUSTOM       "custom"     /* utf8 string */
 151 #define OSSL_MAC_PARAM_SALT         "salt"       /* octet string */
 152 #define OSSL_MAC_PARAM_XOF          "xof"        /* int, 0 or 1 */
 153 #define OSSL_MAC_PARAM_FLAGS        "flags"      /* int */
 154 /*
 155  * If "engine" or "properties" are specified, they should always be paired
 156  * with "cipher" or "digest".
 157  */
 158 #define OSSL_MAC_PARAM_CIPHER           OSSL_ALG_PARAM_CIPHER     /* utf8 string */
 159 #define OSSL_MAC_PARAM_DIGEST           OSSL_ALG_PARAM_DIGEST     /* utf8 string */
 160 #define OSSL_MAC_PARAM_PROPERTIES       OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
 161 #define OSSL_MAC_PARAM_SIZE             "size"                    /* size_t */
 162 #define OSSL_MAC_PARAM_TLS_DATA_SIZE    "tls-data-size"           /* size_t */
 163
 164 /* Known MAC names */
 165 #define OSSL_MAC_NAME_BLAKE2BMAC    "BLAKE2BMAC"
 166 #define OSSL_MAC_NAME_BLAKE2SMAC    "BLAKE2SMAC"
 167 #define OSSL_MAC_NAME_CMAC          "CMAC"
 168 #define OSSL_MAC_NAME_GMAC          "GMAC"
 169 #define OSSL_MAC_NAME_HMAC          "HMAC"
 170 #define OSSL_MAC_NAME_KMAC128       "KMAC128"
 171 #define OSSL_MAC_NAME_KMAC256       "KMAC256"
 172 #define OSSL_MAC_NAME_POLY1305      "POLY1305"
 173 #define OSSL_MAC_NAME_SIPHASH       "SIPHASH"
 174
 175 /* KDF / PRF parameters */
 176 #define OSSL_KDF_PARAM_SECRET       "secret"    /* octet string */
 177 #define OSSL_KDF_PARAM_KEY          "key"       /* octet string */
 178 #define OSSL_KDF_PARAM_SALT         "salt"      /* octet string */
 179 #define OSSL_KDF_PARAM_PASSWORD     "pass"      /* octet string */
 180 #define OSSL_KDF_PARAM_DIGEST       OSSL_ALG_PARAM_DIGEST     /* utf8 string */
 181 #define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
 182 #define OSSL_KDF_PARAM_MAC          OSSL_ALG_PARAM_MAC        /* utf8 string */
 183 #define OSSL_KDF_PARAM_MAC_SIZE     "maclen"    /* size_t */
 184 #define OSSL_KDF_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
 185 #define OSSL_KDF_PARAM_ITER         "iter"      /* unsigned int */
 186 #define OSSL_KDF_PARAM_MODE         "mode"      /* utf8 string or int */
 187 #define OSSL_KDF_PARAM_PKCS5        "pkcs5"     /* int */
 188 #define OSSL_KDF_PARAM_UKM          "ukm"       /* octet string */
 189 #define OSSL_KDF_PARAM_CEK_ALG      "cekalg"    /* utf8 string */
 190 #define OSSL_KDF_PARAM_SCRYPT_N     "n"         /* uint64_t */
 191 #define OSSL_KDF_PARAM_SCRYPT_R     "r"         /* uint32_t */
 192 #define OSSL_KDF_PARAM_SCRYPT_P     "p"         /* uint32_t */
 193 #define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */
 194 #define OSSL_KDF_PARAM_INFO         "info"      /* octet string */
 195 #define OSSL_KDF_PARAM_SEED         "seed"      /* octet string */
 196 #define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */
 197 #define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */
 198 #define OSSL_KDF_PARAM_SSHKDF_TYPE  "type"      /* int */
 199 #define OSSL_KDF_PARAM_SIZE         "size"      /* size_t */
 200 #define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
 201 #define OSSL_KDF_PARAM_CONSTANT     "constant"  /* octet string */
 202 #define OSSL_KDF_PARAM_PKCS12_ID    "id"        /* int */
 203 #define OSSL_KDF_PARAM_KBKDF_USE_L  "use-l"             /* int */
 204 #define OSSL_KDF_PARAM_KBKDF_USE_SEPARATOR  "use-separator"     /* int */
 205
 206 /* Known KDF names */
 207 #define OSSL_KDF_NAME_HKDF          "HKDF"
 208 #define OSSL_KDF_NAME_PBKDF2        "PBKDF2"
 209 #define OSSL_KDF_NAME_SCRYPT        "SCRYPT"
 210 #define OSSL_KDF_NAME_SSHKDF        "SSHKDF"
 211 #define OSSL_KDF_NAME_SSKDF         "SSKDF"
 212 #define OSSL_KDF_NAME_TLS1_PRF      "TLS1-PRF"
 213 #define OSSL_KDF_NAME_X942KDF       "X942KDF"
 214 #define OSSL_KDF_NAME_X963KDF       "X963KDF"
 215 #define OSSL_KDF_NAME_KBKDF         "KBKDF"
 216 #define OSSL_KDF_NAME_KRB5KDF       "KRB5KDF"
 217
 218 /* Known RAND names */
 219 #define OSSL_RAND_PARAM_STATE                   "state"
 220 #define OSSL_RAND_PARAM_STRENGTH                "strength"
 221 #define OSSL_RAND_PARAM_TEST_ENTROPY            "test_entropy"
 222 #define OSSL_RAND_PARAM_TEST_NONCE              "test_nonce"
 223
 224 /* RAND/DRBG names */
 225 #define OSSL_DRBG_PARAM_RESEED_REQUESTS         "reseed_requests"
 226 #define OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL    "reseed_time_interval"
 227 #define OSSL_DRBG_PARAM_MAX_REQUEST             "max_request"
 228 #define OSSL_DRBG_PARAM_MIN_ENTROPYLEN          "min_entropylen"
 229 #define OSSL_DRBG_PARAM_MAX_ENTROPYLEN          "max_entropylen"
 230 #define OSSL_DRBG_PARAM_MIN_NONCELEN            "min_noncelen"
 231 #define OSSL_DRBG_PARAM_MAX_NONCELEN            "max_noncelen"
 232 #define OSSL_DRBG_PARAM_MAX_PERSLEN             "max_perslen"
 233 #define OSSL_DRBG_PARAM_MAX_ADINLEN             "max_adinlen"
 234 #define OSSL_DRBG_PARAM_RESEED_COUNTER          "reseed_counter"
 235 #define OSSL_DRBG_PARAM_RESEED_TIME             "reseed_time"
 236 #define OSSL_DRBG_PARAM_PROPERTIES              OSSL_ALG_PARAM_PROPERTIES
 237 #define OSSL_DRBG_PARAM_DIGEST                  OSSL_ALG_PARAM_DIGEST
 238 #define OSSL_DRBG_PARAM_CIPHER                  OSSL_ALG_PARAM_CIPHER
 239 #define OSSL_DRBG_PARAM_MAC                     OSSL_ALG_PARAM_MAC
 240 #define OSSL_DRBG_PARAM_USE_DF                  "use_derivation_function"
 241
 242 /* DRBG call back parameters */
 243 #define OSSL_DRBG_PARAM_ENTROPY_REQUIRED        "entropy_required"
 244 #define OSSL_DRBG_PARAM_PREDICTION_RESISTANCE   "prediction_resistance"
 245 #define OSSL_DRBG_PARAM_MIN_LENGTH              "minium_length"
 246 #define OSSL_DRBG_PARAM_MAX_LENGTH              "maxium_length"
 247 #define OSSL_DRBG_PARAM_RANDOM_DATA             "random_data"
 248 #define OSSL_DRBG_PARAM_SIZE                    "size"
 249
 250 /* PKEY parameters */
 251 /* Common PKEY parameters */
 252 #define OSSL_PKEY_PARAM_BITS                "bits" /* integer */
 253 #define OSSL_PKEY_PARAM_MAX_SIZE            "max-size" /* integer */
 254 #define OSSL_PKEY_PARAM_SECURITY_BITS       "security-bits" /* integer */
 255 #define OSSL_PKEY_PARAM_DIGEST              OSSL_ALG_PARAM_DIGEST
 256 #define OSSL_PKEY_PARAM_CIPHER              OSSL_ALG_PARAM_CIPHER /* utf8 string */
 257 #define OSSL_PKEY_PARAM_ENGINE              OSSL_ALG_PARAM_ENGINE /* utf8 string */
 258 #define OSSL_PKEY_PARAM_PROPERTIES          OSSL_ALG_PARAM_PROPERTIES
 259 #define OSSL_PKEY_PARAM_DEFAULT_DIGEST      "default-digest" /* utf8 string */
 260 #define OSSL_PKEY_PARAM_MANDATORY_DIGEST    "mandatory-digest" /* utf8 string */
 261 #define OSSL_PKEY_PARAM_PAD_MODE            "pad-mode"
 262 #define OSSL_PKEY_PARAM_DIGEST_SIZE         "digest-size"
 263 #define OSSL_PKEY_PARAM_MASKGENFUNC         "mgf"
 264 #define OSSL_PKEY_PARAM_MGF1_DIGEST         "mgf1-digest"
 265 #define OSSL_PKEY_PARAM_MGF1_PROPERTIES     "mgf1-properties"
 266 #define OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY  "encoded-pub-key"
 267 #define OSSL_PKEY_PARAM_GROUP_NAME          "group"
 268 #define OSSL_PKEY_PARAM_DIST_ID             "distid"
 269 #define OSSL_PKEY_PARAM_PUB_KEY             "pub"
 270 #define OSSL_PKEY_PARAM_PRIV_KEY            "priv"
 271
 272 /* Diffie-Hellman/DSA Parameters */
 273 #define OSSL_PKEY_PARAM_FFC_P               "p"
 274 #define OSSL_PKEY_PARAM_FFC_G               "g"
 275 #define OSSL_PKEY_PARAM_FFC_Q               "q"
 276 #define OSSL_PKEY_PARAM_FFC_GINDEX          "gindex"
 277 #define OSSL_PKEY_PARAM_FFC_PCOUNTER        "pcounter"
 278 #define OSSL_PKEY_PARAM_FFC_SEED            "seed"
 279 #define OSSL_PKEY_PARAM_FFC_COFACTOR        "j"
 280 #define OSSL_PKEY_PARAM_FFC_H               "hindex"
 281 #define OSSL_PKEY_PARAM_FFC_VALIDATE_TYPE   "valid-type"
 282
 283 /* Diffie-Hellman/DSA Parameters parameter validation types */
 284 #define OSSL_FFC_PARAM_VALIDATE_PQ          "validate-pq"
 285 #define OSSL_FFC_PARAM_VALIDATE_G           "validate-g"
 286 #define OSSL_FFC_PARAM_VALIDATE_PQG         "validate-pqg"
 287
 288 /* Diffie-Hellman params */
 289 #define OSSL_PKEY_PARAM_DH_GENERATOR        "safeprime-generator"
 290 #define OSSL_PKEY_PARAM_DH_PRIV_LEN         "priv_len"
 291
 292 /* Elliptic Curve Domain Parameters */
 293 #define OSSL_PKEY_PARAM_EC_PUB_X     "qx"
 294 #define OSSL_PKEY_PARAM_EC_PUB_Y     "qy"
 295
 296 /* Elliptic Curve Explicit Domain Parameters */
 297 #define OSSL_PKEY_PARAM_EC_FIELD_TYPE     "field-type"
 298 #define OSSL_PKEY_PARAM_EC_P              "p"
 299 #define OSSL_PKEY_PARAM_EC_A              "a"
 300 #define OSSL_PKEY_PARAM_EC_B              "b"
 301 #define OSSL_PKEY_PARAM_EC_GENERATOR      "generator"
 302 #define OSSL_PKEY_PARAM_EC_ORDER          "order"
 303 #define OSSL_PKEY_PARAM_EC_COFACTOR       "cofactor"
 304 #define OSSL_PKEY_PARAM_EC_SEED           "seed"
 305 #define OSSL_PKEY_PARAM_EC_CHAR2_M        "m"
 306 #define OSSL_PKEY_PARAM_EC_CHAR2_TYPE     "basis-type"
 307 #define OSSL_PKEY_PARAM_EC_CHAR2_TP_BASIS "tp"
 308 #define OSSL_PKEY_PARAM_EC_CHAR2_PP_K1    "k1"
 309 #define OSSL_PKEY_PARAM_EC_CHAR2_PP_K2    "k2"
 310 #define OSSL_PKEY_PARAM_EC_CHAR2_PP_K3    "k3"
 311
 312 /* Elliptic Curve Key Parameters */
 313 #define OSSL_PKEY_PARAM_USE_COFACTOR_FLAG "use-cofactor-flag"
 314 #define OSSL_PKEY_PARAM_USE_COFACTOR_ECDH \
 315     OSSL_PKEY_PARAM_USE_COFACTOR_FLAG
 316
 317 /* RSA Keys */
 318 /*
 319  * n, e, d are the usual public and private key components
 320  *
 321  * rsa-num is the number of factors, including p and q
 322  * rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
 323  * rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
 324  * rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
 325  *
 326  * The number of rsa-factor items must be equal to the number of rsa-exponent
 327  * items, and the number of rsa-coefficients must be one less.
 328  * (the base i for the coefficients is 2, not 1, at least as implied by
 329  * RFC 8017)
 330  */
 331 #define OSSL_PKEY_PARAM_RSA_N           "n"
 332 #define OSSL_PKEY_PARAM_RSA_E           "e"
 333 #define OSSL_PKEY_PARAM_RSA_D           "d"
 334 #define OSSL_PKEY_PARAM_RSA_FACTOR      "rsa-factor"
 335 #define OSSL_PKEY_PARAM_RSA_EXPONENT    "rsa-exponent"
 336 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient"
 337 #define OSSL_PKEY_PARAM_RSA_FACTOR1      OSSL_PKEY_PARAM_RSA_FACTOR"1"
 338 #define OSSL_PKEY_PARAM_RSA_FACTOR2      OSSL_PKEY_PARAM_RSA_FACTOR"2"
 339 #define OSSL_PKEY_PARAM_RSA_FACTOR3      OSSL_PKEY_PARAM_RSA_FACTOR"3"
 340 #define OSSL_PKEY_PARAM_RSA_FACTOR4      OSSL_PKEY_PARAM_RSA_FACTOR"4"
 341 #define OSSL_PKEY_PARAM_RSA_FACTOR5      OSSL_PKEY_PARAM_RSA_FACTOR"5"
 342 #define OSSL_PKEY_PARAM_RSA_FACTOR6      OSSL_PKEY_PARAM_RSA_FACTOR"6"
 343 #define OSSL_PKEY_PARAM_RSA_FACTOR7      OSSL_PKEY_PARAM_RSA_FACTOR"7"
 344 #define OSSL_PKEY_PARAM_RSA_FACTOR8      OSSL_PKEY_PARAM_RSA_FACTOR"8"
 345 #define OSSL_PKEY_PARAM_RSA_FACTOR9      OSSL_PKEY_PARAM_RSA_FACTOR"9"
 346 #define OSSL_PKEY_PARAM_RSA_FACTOR10     OSSL_PKEY_PARAM_RSA_FACTOR"10"
 347 #define OSSL_PKEY_PARAM_RSA_EXPONENT1    OSSL_PKEY_PARAM_RSA_EXPONENT"1"
 348 #define OSSL_PKEY_PARAM_RSA_EXPONENT2    OSSL_PKEY_PARAM_RSA_EXPONENT"2"
 349 #define OSSL_PKEY_PARAM_RSA_EXPONENT3    OSSL_PKEY_PARAM_RSA_EXPONENT"3"
 350 #define OSSL_PKEY_PARAM_RSA_EXPONENT4    OSSL_PKEY_PARAM_RSA_EXPONENT"4"
 351 #define OSSL_PKEY_PARAM_RSA_EXPONENT5    OSSL_PKEY_PARAM_RSA_EXPONENT"5"
 352 #define OSSL_PKEY_PARAM_RSA_EXPONENT6    OSSL_PKEY_PARAM_RSA_EXPONENT"6"
 353 #define OSSL_PKEY_PARAM_RSA_EXPONENT7    OSSL_PKEY_PARAM_RSA_EXPONENT"7"
 354 #define OSSL_PKEY_PARAM_RSA_EXPONENT8    OSSL_PKEY_PARAM_RSA_EXPONENT"8"
 355 #define OSSL_PKEY_PARAM_RSA_EXPONENT9    OSSL_PKEY_PARAM_RSA_EXPONENT"9"
 356 #define OSSL_PKEY_PARAM_RSA_EXPONENT10   OSSL_PKEY_PARAM_RSA_EXPONENT"10"
 357 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT1 OSSL_PKEY_PARAM_RSA_COEFFICIENT"1"
 358 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT2 OSSL_PKEY_PARAM_RSA_COEFFICIENT"2"
 359 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT3 OSSL_PKEY_PARAM_RSA_COEFFICIENT"3"
 360 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT4 OSSL_PKEY_PARAM_RSA_COEFFICIENT"4"
 361 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT5 OSSL_PKEY_PARAM_RSA_COEFFICIENT"5"
 362 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT6 OSSL_PKEY_PARAM_RSA_COEFFICIENT"6"
 363 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT7 OSSL_PKEY_PARAM_RSA_COEFFICIENT"7"
 364 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT8 OSSL_PKEY_PARAM_RSA_COEFFICIENT"8"
 365 #define OSSL_PKEY_PARAM_RSA_COEFFICIENT9 OSSL_PKEY_PARAM_RSA_COEFFICIENT"9"
 366
 367 /* RSA padding modes */
 368 #define OSSL_PKEY_RSA_PAD_MODE_NONE    "none"
 369 #define OSSL_PKEY_RSA_PAD_MODE_PKCSV15 "pkcs1"
 370 #define OSSL_PKEY_RSA_PAD_MODE_SSLV23  "sslv23"
 371 #define OSSL_PKEY_RSA_PAD_MODE_OAEP    "oaep"
 372 #define OSSL_PKEY_RSA_PAD_MODE_X931    "x931"
 373 #define OSSL_PKEY_RSA_PAD_MODE_PSS     "pss"
 374
 375 /* RSA pss padding salt length */
 376 #define OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST "digest"
 377 #define OSSL_PKEY_RSA_PSS_SALT_LEN_MAX    "max"
 378 #define OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO   "auto"
 379
 380 /* Key generation parameters */
 381 #define OSSL_PKEY_PARAM_RSA_BITS            OSSL_PKEY_PARAM_BITS
 382 #define OSSL_PKEY_PARAM_RSA_PRIMES          "primes"
 383 #define OSSL_PKEY_PARAM_RSA_DIGEST          OSSL_PKEY_PARAM_DIGEST
 384 #define OSSL_PKEY_PARAM_RSA_DIGEST_PROPS    OSSL_PKEY_PARAM_PROPERTIES
 385 #define OSSL_PKEY_PARAM_RSA_MASKGENFUNC     OSSL_PKEY_PARAM_MASKGENFUNC
 386 #define OSSL_PKEY_PARAM_RSA_MGF1_DIGEST     OSSL_PKEY_PARAM_MGF1_DIGEST
 387 #define OSSL_PKEY_PARAM_RSA_PSS_SALTLEN     "saltlen"
 388
 389 /* Key generation parameters */
 390 #define OSSL_PKEY_PARAM_FFC_TYPE         "type"
 391 #define OSSL_PKEY_PARAM_FFC_PBITS        "pbits"
 392 #define OSSL_PKEY_PARAM_FFC_QBITS        "qbits"
 393 #define OSSL_PKEY_PARAM_FFC_DIGEST       OSSL_PKEY_PARAM_DIGEST
 394 #define OSSL_PKEY_PARAM_FFC_DIGEST_PROPS OSSL_PKEY_PARAM_PROPERTIES
 395
 396 #define OSSL_PKEY_PARAM_EC_ENCODING      "encoding" /* utf8_string */
 397
 398 /* OSSL_PKEY_PARAM_EC_ENCODING values */
 399 #define OSSL_PKEY_EC_ENCODING_EXPLICIT  "explicit"
 400 #define OSSL_PKEY_EC_ENCODING_GROUP     "named_curve"
 401
 402 /* Key Exchange parameters */
 403 #define OSSL_EXCHANGE_PARAM_PAD                   "pad" /* uint */
 404 #define OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE "ecdh-cofactor-mode" /* int */
 405 #define OSSL_EXCHANGE_PARAM_KDF_TYPE              "kdf-type" /* utf8_string */
 406 #define OSSL_EXCHANGE_PARAM_KDF_DIGEST            "kdf-digest" /* utf8_string */
 407 #define OSSL_EXCHANGE_PARAM_KDF_DIGEST_PROPS      "kdf-digest-props" /* utf8_string */
 408 #define OSSL_EXCHANGE_PARAM_KDF_OUTLEN            "kdf-outlen" /* size_t */
 409
 410 /*
 411  * TODO(3.0): improve this pattern
 412  *
 413  * Currently the sole internal user of OSSL_EXCHANGE_PARAM_KDF_UKM is
 414  * EVP_PKEY_CTX_{set0,get0}_ecdh_kdf_ukm():
 415  *      OSSL_EXCHANGE_PARAM_KDF_UKM is handled as a octet_string on set0,
 416  *      and as an octet_ptr on get0.
 417  *
 418  * This pattern is borrowed from the handling of
 419  * OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL in
 420  * EVP_PKEY_CTX_{set0,get0}_rsa_oaep_label().
 421  */
 422 #define OSSL_EXCHANGE_PARAM_KDF_UKM               "kdf-ukm" /* see note above */
 423 #define OSSL_EXCHANGE_PARAM_KDF_UKM_LEN           "kdf-ukm-len" /* size_t */
 424
 425 /* Signature parameters */
 426 #define OSSL_SIGNATURE_PARAM_ALGORITHM_ID       "algorithm-id"
 427 #define OSSL_SIGNATURE_PARAM_PAD_MODE           OSSL_PKEY_PARAM_PAD_MODE
 428 #define OSSL_SIGNATURE_PARAM_DIGEST             OSSL_PKEY_PARAM_DIGEST
 429 #define OSSL_SIGNATURE_PARAM_PROPERTIES         OSSL_PKEY_PARAM_PROPERTIES
 430 #define OSSL_SIGNATURE_PARAM_PSS_SALTLEN        "saltlen"
 431 #define OSSL_SIGNATURE_PARAM_MGF1_DIGEST        OSSL_PKEY_PARAM_MGF1_DIGEST
 432 #define OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES    \
 433     OSSL_PKEY_PARAM_MGF1_PROPERTIES
 434 #define OSSL_SIGNATURE_PARAM_DIGEST_SIZE        OSSL_PKEY_PARAM_DIGEST_SIZE
 435
 436 /* Asym cipher parameters */
 437 #define OSSL_ASYM_CIPHER_PARAM_DIGEST                   OSSL_PKEY_PARAM_DIGEST
 438 #define OSSL_ASYM_CIPHER_PARAM_PROPERTIES               OSSL_PKEY_PARAM_PROPERTIES
 439 #define OSSL_ASYM_CIPHER_PARAM_ENGINE                   OSSL_PKEY_PARAM_ENGINE
 440 #define OSSL_ASYM_CIPHER_PARAM_PAD_MODE                 OSSL_PKEY_PARAM_PAD_MODE
 441 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST              \
 442     OSSL_PKEY_PARAM_MGF1_DIGEST
 443 #define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS        \
 444     OSSL_PKEY_PARAM_MGF1_PROPERTIES
 445 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST              OSSL_ALG_PARAM_DIGEST
 446 #define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS        "digest-props"
 447 #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL               "oaep-label"
 448 #define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN           "oaep-label-len"
 449 #define OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION       "tls-client-version"
 450 #define OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION   "tls-negotiated-version"
 451
 452 /*
 453  * Encoder / decoder parameters
 454  */
 455 #define OSSL_ENCODER_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER
 456 #define OSSL_ENCODER_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES
 457 #define OSSL_ENCODER_PARAM_INPUT_TYPE   "input-type"
 458 #define OSSL_ENCODER_PARAM_OUTPUT_TYPE  "output-type"
 459
 460 #define OSSL_DECODER_PARAM_PROPERTIES       OSSL_ALG_PARAM_PROPERTIES
 461 #define OSSL_DECODER_PARAM_INPUT_TYPE       "input-type"
 462 #define OSSL_DECODER_PARAM_INPUT_STRUCTURE  "input-structure"
 463
 464 /* Passphrase callback parameters */
 465 #define OSSL_PASSPHRASE_PARAM_INFO      "info"
 466
 467 /* Keygen callback parameters, from provider to libcrypto */
 468 #define OSSL_GEN_PARAM_POTENTIAL            "potential" /* integer */
 469 #define OSSL_GEN_PARAM_ITERATION            "iteration" /* integer */
 470
 471 /* ACVP Test parameters : These should not be used normally */
 472 #define OSSL_PKEY_PARAM_RSA_TEST_XP1 "xp1"
 473 #define OSSL_PKEY_PARAM_RSA_TEST_XP2 "xp2"
 474 #define OSSL_PKEY_PARAM_RSA_TEST_XP  "xp"
 475 #define OSSL_PKEY_PARAM_RSA_TEST_XQ1 "xq1"
 476 #define OSSL_PKEY_PARAM_RSA_TEST_XQ2 "xq2"
 477 #define OSSL_PKEY_PARAM_RSA_TEST_XQ  "xq"
 478 #define OSSL_PKEY_PARAM_RSA_TEST_P1  "p1"
 479 #define OSSL_PKEY_PARAM_RSA_TEST_P2  "p2"
 480 #define OSSL_PKEY_PARAM_RSA_TEST_Q1  "q1"
 481 #define OSSL_PKEY_PARAM_RSA_TEST_Q2  "q2"
 482 #define OSSL_SIGNATURE_PARAM_KAT "kat"
 483
 484 /* KEM parameters */
 485 #define OSSL_KEM_PARAM_OPERATION            "operation"
 486
 487 /* OSSL_KEM_PARAM_OPERATION values */
 488 #define OSSL_KEM_PARAM_OPERATION_RSASVE     "RSASVE"
 489
 490 /* Capabilities */
 491
 492 /* TLS-GROUP Capability */
 493 #define OSSL_CAPABILITY_TLS_GROUP_NAME              "tls-group-name"
 494 #define OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL     "tls-group-name-internal"
 495 #define OSSL_CAPABILITY_TLS_GROUP_ID                "tls-group-id"
 496 #define OSSL_CAPABILITY_TLS_GROUP_ALG               "tls-group-alg"
 497 #define OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS     "tls-group-sec-bits"
 498 #define OSSL_CAPABILITY_TLS_GROUP_IS_KEM            "tls-group-is-kem"
 499 #define OSSL_CAPABILITY_TLS_GROUP_MIN_TLS           "tls-min-tls"
 500 #define OSSL_CAPABILITY_TLS_GROUP_MAX_TLS           "tls-max-tls"
 501 #define OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS          "tls-min-dtls"
 502 #define OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS          "tls-max-dtls"
 503
 504 /*-
 505  * storemgmt parameters
 506  */
 507
 508 /*
 509  * Used by storemgmt_ctx_set_params():
 510  *
 511  * - OSSL_STORE_PARAM_EXPECT is an INTEGER, and the value is any of the
 512  *   OSSL_STORE_INFO numbers.  This is used to set the expected type of
 513  *   object loaded.
 514  *
 515  * - OSSL_STORE_PARAM_SUBJECT, OSSL_STORE_PARAM_ISSUER,
 516  *   OSSL_STORE_PARAM_SERIAL, OSSL_STORE_PARAM_FINGERPRINT,
 517  *   OSSL_STORE_PARAM_DIGEST, OSSL_STORE_PARAM_ALIAS
 518  *   are used as search criteria.
 519  *   (OSSL_STORE_PARAM_DIGEST is used with OSSL_STORE_PARAM_FINGERPRINT)
 520  */
 521 #define OSSL_STORE_PARAM_EXPECT     "expect"       /* INTEGER */
 522 #define OSSL_STORE_PARAM_SUBJECT    "subject" /* DER blob => OCTET_STRING */
 523 #define OSSL_STORE_PARAM_ISSUER     "name" /* DER blob => OCTET_STRING */
 524 #define OSSL_STORE_PARAM_SERIAL     "serial"       /* INTEGER */
 525 #define OSSL_STORE_PARAM_DIGEST     "digest"       /* UTF8_STRING */
 526 #define OSSL_STORE_PARAM_FINGERPRINT "fingerprint" /* OCTET_STRING */
 527 #define OSSL_STORE_PARAM_ALIAS      "alias"        /* UTF8_STRING */
 528
 529 /* You may want to pass properties for the provider implementation to use */
 530 #define OSSL_STORE_PARAM_PROPERTIES "properties"   /* utf8_string */
 531
 532 # ifdef __cplusplus
 533 }
 534 # endif
 535
 536 #endif