[thirdparty/openssl.git] / include / openssl / core_names.h

/*
 * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#ifndef OPENSSL_CORE_NAMES_H
# define OPENSSL_CORE_NAMES_H

# ifdef __cplusplus
extern "C" {
# endif

/* Well known parameter names that core passes to providers */
#define OSSL_PROV_PARAM_CORE_VERSION         "openssl-version" /* utf8_ptr */
#define OSSL_PROV_PARAM_CORE_PROV_NAME       "provider-name"   /* utf8_ptr */
#define OSSL_PROV_PARAM_CORE_MODULE_FILENAME "module-filename" /* utf8_ptr */

/* Well known parameter names that Providers can define */
#define OSSL_PROV_PARAM_NAME            "name"                /* utf8_string */
#define OSSL_PROV_PARAM_VERSION         "version"             /* utf8_string */
#define OSSL_PROV_PARAM_BUILDINFO       "buildinfo"           /* utf8_string */

/* Self test callback parameters */
#define OSSL_PROV_PARAM_SELF_TEST_PHASE  "st-phase" /* utf8_string */
#define OSSL_PROV_PARAM_SELF_TEST_TYPE   "st-type"  /* utf8_string */
#define OSSL_PROV_PARAM_SELF_TEST_DESC   "st-desc"  /* utf8_string */

/*
 * Algorithm parameters
 * If "engine" or "properties" are specified, they should always be paired
 * with the algorithm type.
 * Note these are common names that are shared by many types (such as kdf, mac,
 * and pkey) e.g: see OSSL_MAC_PARAM_DIGEST below.
 */
#define OSSL_ALG_PARAM_DIGEST       "digest"    /* utf8_string */
#define OSSL_ALG_PARAM_CIPHER       "cipher"    /* utf8_string */
#define OSSL_ALG_PARAM_MAC          "mac"       /* utf8_string */
#define OSSL_ALG_PARAM_PROPERTIES   "properties"/* utf8_string */

/* cipher parameters */
#define OSSL_CIPHER_PARAM_PADDING              "padding"    /* uint */
#define OSSL_CIPHER_PARAM_MODE                 "mode"       /* uint */
#define OSSL_CIPHER_PARAM_BLOCK_SIZE           "blocksize" /* size_t */
#define OSSL_CIPHER_PARAM_FLAGS                "flags"      /* ulong */
#define OSSL_CIPHER_PARAM_KEYLEN               "keylen"     /* size_t */
#define OSSL_CIPHER_PARAM_IVLEN                "ivlen"      /* size_t */
#define OSSL_CIPHER_PARAM_IV                   "iv"         /* octet_string OR octet_ptr */
#define OSSL_CIPHER_PARAM_NUM                  "num"        /* uint */
#define OSSL_CIPHER_PARAM_ROUNDS               "rounds"     /* uint */
#define OSSL_CIPHER_PARAM_AEAD_TAG             "tag"        /* octet_string */
#define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD        "tlsaad"     /* octet_string */
#define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD    "tlsaadpad"  /* size_t */
#define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED   "tlsivfixed" /* octet_string */
#define OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN "tlsivgen" /* octet_string */
#define OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV "tlsivinv" /* octet_string */
#define OSSL_CIPHER_PARAM_AEAD_IVLEN           OSSL_CIPHER_PARAM_IVLEN
#define OSSL_CIPHER_PARAM_AEAD_TAGLEN          "taglen"     /* size_t */
#define OSSL_CIPHER_PARAM_AEAD_MAC_KEY         "mackey"     /* octet_string */
#define OSSL_CIPHER_PARAM_RANDOM_KEY           "randkey"    /* octet_string */
#define OSSL_CIPHER_PARAM_RC2_KEYBITS          "keybits"    /* size_t */
#define OSSL_CIPHER_PARAM_SPEED                "speed"      /* uint */
/* For passing the AlgorithmIdentifier parameter in DER form */
#define OSSL_CIPHER_PARAM_ALG_ID               "alg_id_param" /* octet_string */

#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT                    \
    "tls1multi_maxsndfrag" /* uint */
#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE                          \
    "tls1multi_maxbufsz"   /* size_t */
#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE                           \
    "tls1multi_interleave" /* uint */
#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD                                  \
    "tls1multi_aad"        /* octet_string */
#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN                          \
    "tls1multi_aadpacklen" /* uint */
#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC                                  \
    "tls1multi_enc"        /* octet_string */
#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN                               \
    "tls1multi_encin"      /* octet_string */
#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN                              \
    "tls1multi_enclen"     /* size_t */

/* digest parameters */
#define OSSL_DIGEST_PARAM_XOFLEN     "xoflen"    /* size_t */
#define OSSL_DIGEST_PARAM_SSL3_MS    "ssl3-ms"   /* octet string */
#define OSSL_DIGEST_PARAM_PAD_TYPE   "pad_type"  /* uint */
#define OSSL_DIGEST_PARAM_MICALG     "micalg"    /* utf8 string */
#define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */
#define OSSL_DIGEST_PARAM_SIZE       "size"      /* size_t */
#define OSSL_DIGEST_PARAM_FLAGS      "flags"     /* ulong */

/* Known DIGEST names (not a complete list) */
#define OSSL_DIGEST_NAME_MD5            "MD5"
#define OSSL_DIGEST_NAME_MD5_SHA1       "MD5-SHA1"
#define OSSL_DIGEST_NAME_SHA1           "SHA1"
#define OSSL_DIGEST_NAME_SHA2_224       "SHA2-224"
#define OSSL_DIGEST_NAME_SHA2_256       "SHA2-256"
#define OSSL_DIGEST_NAME_SHA2_384       "SHA2-384"
#define OSSL_DIGEST_NAME_SHA2_512       "SHA2-512"
#define OSSL_DIGEST_NAME_SHA2_512_224   "SHA2-512/224"
#define OSSL_DIGEST_NAME_SHA2_512_256   "SHA2-512/256"
#define OSSL_DIGEST_NAME_MD2            "MD2"
#define OSSL_DIGEST_NAME_MD4            "MD4"
#define OSSL_DIGEST_NAME_MDC2           "MDC2"
#define OSSL_DIGEST_NAME_RIPEMD160      "RIPEMD160"
#define OSSL_DIGEST_NAME_SHA3_224       "SHA3-224"
#define OSSL_DIGEST_NAME_SHA3_256       "SHA3-256"
#define OSSL_DIGEST_NAME_SHA3_384       "SHA3-384"
#define OSSL_DIGEST_NAME_SHA3_512       "SHA3-512"
#define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128"
#define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256"

/* MAC parameters */
#define OSSL_MAC_PARAM_KEY          "key"        /* octet string */
#define OSSL_MAC_PARAM_IV           "iv"         /* octet string */
#define OSSL_MAC_PARAM_CUSTOM       "custom"     /* utf8 string */
#define OSSL_MAC_PARAM_SALT         "salt"       /* octet string */
#define OSSL_MAC_PARAM_XOF          "xof"        /* int, 0 or 1 */
#define OSSL_MAC_PARAM_FLAGS        "flags"      /* int */
/*
 * If "engine" or "properties" are specified, they should always be paired
 * with "cipher" or "digest".
 */
#define OSSL_MAC_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
#define OSSL_MAC_PARAM_DIGEST       OSSL_ALG_PARAM_DIGEST     /* utf8 string */
#define OSSL_MAC_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
#define OSSL_MAC_PARAM_SIZE         "size"       /* size_t */

/* Known MAC names */
#define OSSL_MAC_NAME_BLAKE2BMAC    "BLAKE2BMAC"
#define OSSL_MAC_NAME_BLAKE2SMAC    "BLAKE2SMAC"
#define OSSL_MAC_NAME_CMAC          "CMAC"
#define OSSL_MAC_NAME_GMAC          "GMAC"
#define OSSL_MAC_NAME_HMAC          "HMAC"
#define OSSL_MAC_NAME_KMAC128       "KMAC128"
#define OSSL_MAC_NAME_KMAC256       "KMAC256"
#define OSSL_MAC_NAME_POLY1305      "POLY1305"
#define OSSL_MAC_NAME_SIPHASH       "SIPHASH"

/* KDF / PRF parameters */
#define OSSL_KDF_PARAM_SECRET       "secret"    /* octet string */
#define OSSL_KDF_PARAM_KEY          "key"       /* octet string */
#define OSSL_KDF_PARAM_SALT         "salt"      /* octet string */
#define OSSL_KDF_PARAM_PASSWORD     "pass"      /* octet string */
#define OSSL_KDF_PARAM_DIGEST       OSSL_ALG_PARAM_DIGEST     /* utf8 string */
#define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
#define OSSL_KDF_PARAM_MAC          OSSL_ALG_PARAM_MAC        /* utf8 string */
#define OSSL_KDF_PARAM_MAC_SIZE     "maclen"    /* size_t */
#define OSSL_KDF_PARAM_PROPERTIES   OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
#define OSSL_KDF_PARAM_ITER         "iter"      /* unsigned int */
#define OSSL_KDF_PARAM_MODE         "mode"      /* utf8 string or int */
#define OSSL_KDF_PARAM_PKCS5        "pkcs5"     /* int */
#define OSSL_KDF_PARAM_UKM          "ukm"       /* octet string */
#define OSSL_KDF_PARAM_CEK_ALG      "cekalg"    /* utf8 string */
#define OSSL_KDF_PARAM_SCRYPT_N     "n"         /* uint64_t */
#define OSSL_KDF_PARAM_SCRYPT_R     "r"         /* uint32_t */
#define OSSL_KDF_PARAM_SCRYPT_P     "p"         /* uint32_t */
#define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */
#define OSSL_KDF_PARAM_INFO         "info"      /* octet string */
#define OSSL_KDF_PARAM_SEED         "seed"      /* octet string */
#define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */
#define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */
#define OSSL_KDF_PARAM_SSHKDF_TYPE  "type"      /* int */
#define OSSL_KDF_PARAM_SIZE         "size"      /* size_t */
#define OSSL_KDF_PARAM_CIPHER       OSSL_ALG_PARAM_CIPHER     /* utf8 string */
#define OSSL_KDF_PARAM_CONSTANT     "constant"  /* octet string */

/* Known KDF names */
#define OSSL_KDF_NAME_HKDF          "HKDF"
#define OSSL_KDF_NAME_PBKDF2        "PBKDF2"
#define OSSL_KDF_NAME_SCRYPT        "SCRYPT"
#define OSSL_KDF_NAME_SSHKDF        "SSHKDF"
#define OSSL_KDF_NAME_SSKDF         "SSKDF"
#define OSSL_KDF_NAME_TLS1_PRF      "TLS1-PRF"
#define OSSL_KDF_NAME_X942KDF       "X942KDF"
#define OSSL_KDF_NAME_X963KDF       "X963KDF"
#define OSSL_KDF_NAME_KBKDF         "KBKDF"
#define OSSL_KDF_NAME_KRB5KDF       "KRB5KDF"

/* PKEY parameters */
/* Common PKEY parameters */
#define OSSL_PKEY_PARAM_BITS                "bits" /* integer */
#define OSSL_PKEY_PARAM_MAX_SIZE            "max-size" /* integer */
#define OSSL_PKEY_PARAM_SECURITY_BITS       "security-bits" /* integer */
#define OSSL_PKEY_PARAM_DIGEST              OSSL_ALG_PARAM_DIGEST
#define OSSL_PKEY_PARAM_PROPERTIES          OSSL_ALG_PARAM_PROPERTIES
#define OSSL_PKEY_PARAM_DEFAULT_DIGEST      "default-digest" /* utf8 string */
#define OSSL_PKEY_PARAM_MANDATORY_DIGEST    "mandatory-digest" /* utf8 string */
#define OSSL_PKEY_PARAM_PAD_MODE            "pad-mode"
#define OSSL_PKEY_PARAM_DIGEST_SIZE         "digest-size"
#define OSSL_PKEY_PARAM_MASKGENFUNC         "mgf"
#define OSSL_PKEY_PARAM_MGF1_DIGEST         "mgf1-digest"
#define OSSL_PKEY_PARAM_MGF1_PROPERTIES     "mgf1-properties"
#define OSSL_PKEY_PARAM_TLS_ENCODED_PT      "tls-encoded-pt"

/* Diffie-Hellman/DSA public/private key */
#define OSSL_PKEY_PARAM_PUB_KEY             "pub"
#define OSSL_PKEY_PARAM_PRIV_KEY            "priv"

/* Diffie-Hellman/DSA Parameters */
#define OSSL_PKEY_PARAM_FFC_P               "p"
#define OSSL_PKEY_PARAM_FFC_G               "g"
#define OSSL_PKEY_PARAM_FFC_Q               "q"
#define OSSL_PKEY_PARAM_FFC_GINDEX          "gindex"
#define OSSL_PKEY_PARAM_FFC_PCOUNTER        "pcounter"
#define OSSL_PKEY_PARAM_FFC_SEED            "seed"
#define OSSL_PKEY_PARAM_FFC_COFACTOR        "j"
#define OSSL_PKEY_PARAM_FFC_H               "hindex"
#define OSSL_PKEY_PARAM_FFC_VALIDATE_TYPE   "valid-type"

/* Diffie-Hellman/DSA Parameters parameter validation types */
#define OSSL_FFC_PARAM_VALIDATE_PQ          "validate-pq"
#define OSSL_FFC_PARAM_VALIDATE_G           "validate-g"
#define OSSL_FFC_PARAM_VALIDATE_PQG         "validate-pqg"

/* Diffie-Hellman params */
#define OSSL_PKEY_PARAM_DH_GROUP            "group"
#define OSSL_PKEY_PARAM_DH_GENERATOR        "safeprime-generator"
#define OSSL_PKEY_PARAM_DH_PRIV_LEN         "priv_len"

/* Elliptic Curve Domain Parameters */
#define OSSL_PKEY_PARAM_EC_NAME      "curve-name"
#define OSSL_PKEY_PARAM_EC_PUB_X     "qx"
#define OSSL_PKEY_PARAM_EC_PUB_Y     "qy"

/* Elliptic Curve Key Parameters */
#define OSSL_PKEY_PARAM_USE_COFACTOR_FLAG "use-cofactor-flag"
#define OSSL_PKEY_PARAM_USE_COFACTOR_ECDH \
    OSSL_PKEY_PARAM_USE_COFACTOR_FLAG

/* RSA Keys */
/*
 * n, e, d are the usual public and private key components
 *
 * rsa-num is the number of factors, including p and q
 * rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
 * rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
 * rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
 *
 * The number of rsa-factor items must be equal to the number of rsa-exponent
 * items, and the number of rsa-coefficients must be one less.
 * (the base i for the coefficients is 2, not 1, at least as implied by
 * RFC 8017)
 */
#define OSSL_PKEY_PARAM_RSA_N           "n"
#define OSSL_PKEY_PARAM_RSA_E           "e"
#define OSSL_PKEY_PARAM_RSA_D           "d"
#define OSSL_PKEY_PARAM_RSA_FACTOR      "rsa-factor"
#define OSSL_PKEY_PARAM_RSA_EXPONENT    "rsa-exponent"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient"
#define OSSL_PKEY_PARAM_RSA_FACTOR1      OSSL_PKEY_PARAM_RSA_FACTOR"1"
#define OSSL_PKEY_PARAM_RSA_FACTOR2      OSSL_PKEY_PARAM_RSA_FACTOR"2"
#define OSSL_PKEY_PARAM_RSA_FACTOR3      OSSL_PKEY_PARAM_RSA_FACTOR"3"
#define OSSL_PKEY_PARAM_RSA_FACTOR4      OSSL_PKEY_PARAM_RSA_FACTOR"4"
#define OSSL_PKEY_PARAM_RSA_FACTOR5      OSSL_PKEY_PARAM_RSA_FACTOR"5"
#define OSSL_PKEY_PARAM_RSA_FACTOR6      OSSL_PKEY_PARAM_RSA_FACTOR"6"
#define OSSL_PKEY_PARAM_RSA_FACTOR7      OSSL_PKEY_PARAM_RSA_FACTOR"7"
#define OSSL_PKEY_PARAM_RSA_FACTOR8      OSSL_PKEY_PARAM_RSA_FACTOR"8"
#define OSSL_PKEY_PARAM_RSA_FACTOR9      OSSL_PKEY_PARAM_RSA_FACTOR"9"
#define OSSL_PKEY_PARAM_RSA_FACTOR10     OSSL_PKEY_PARAM_RSA_FACTOR"10"
#define OSSL_PKEY_PARAM_RSA_EXPONENT1    OSSL_PKEY_PARAM_RSA_EXPONENT"1"
#define OSSL_PKEY_PARAM_RSA_EXPONENT2    OSSL_PKEY_PARAM_RSA_EXPONENT"2"
#define OSSL_PKEY_PARAM_RSA_EXPONENT3    OSSL_PKEY_PARAM_RSA_EXPONENT"3"
#define OSSL_PKEY_PARAM_RSA_EXPONENT4    OSSL_PKEY_PARAM_RSA_EXPONENT"4"
#define OSSL_PKEY_PARAM_RSA_EXPONENT5    OSSL_PKEY_PARAM_RSA_EXPONENT"5"
#define OSSL_PKEY_PARAM_RSA_EXPONENT6    OSSL_PKEY_PARAM_RSA_EXPONENT"6"
#define OSSL_PKEY_PARAM_RSA_EXPONENT7    OSSL_PKEY_PARAM_RSA_EXPONENT"7"
#define OSSL_PKEY_PARAM_RSA_EXPONENT8    OSSL_PKEY_PARAM_RSA_EXPONENT"8"
#define OSSL_PKEY_PARAM_RSA_EXPONENT9    OSSL_PKEY_PARAM_RSA_EXPONENT"9"
#define OSSL_PKEY_PARAM_RSA_EXPONENT10   OSSL_PKEY_PARAM_RSA_EXPONENT"10"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT1 OSSL_PKEY_PARAM_RSA_COEFFICIENT"1"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT2 OSSL_PKEY_PARAM_RSA_COEFFICIENT"2"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT3 OSSL_PKEY_PARAM_RSA_COEFFICIENT"3"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT4 OSSL_PKEY_PARAM_RSA_COEFFICIENT"4"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT5 OSSL_PKEY_PARAM_RSA_COEFFICIENT"5"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT6 OSSL_PKEY_PARAM_RSA_COEFFICIENT"6"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT7 OSSL_PKEY_PARAM_RSA_COEFFICIENT"7"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT8 OSSL_PKEY_PARAM_RSA_COEFFICIENT"8"
#define OSSL_PKEY_PARAM_RSA_COEFFICIENT9 OSSL_PKEY_PARAM_RSA_COEFFICIENT"9"

/* RSA padding modes */
#define OSSL_PKEY_RSA_PAD_MODE_NONE    "none"
#define OSSL_PKEY_RSA_PAD_MODE_PKCSV15 "pkcs1"
#define OSSL_PKEY_RSA_PAD_MODE_SSLV23  "sslv23"
#define OSSL_PKEY_RSA_PAD_MODE_OAEP    "oaep"
#define OSSL_PKEY_RSA_PAD_MODE_X931    "x931"
#define OSSL_PKEY_RSA_PAD_MODE_PSS     "pss"

/* RSA pss padding salt length */
#define OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST "digest"
#define OSSL_PKEY_RSA_PSS_SALT_LEN_MAX    "max"
#define OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO   "auto"

/* Key generation parameters */
#define OSSL_PKEY_PARAM_RSA_BITS            OSSL_PKEY_PARAM_BITS
#define OSSL_PKEY_PARAM_RSA_PRIMES          "primes"
#define OSSL_PKEY_PARAM_RSA_DIGEST          OSSL_PKEY_PARAM_DIGEST
#define OSSL_PKEY_PARAM_RSA_MASKGENFUNC     OSSL_PKEY_PARAM_MASKGENFUNC
#define OSSL_PKEY_PARAM_RSA_MGF1_DIGEST     OSSL_PKEY_PARAM_MGF1_DIGEST
#define OSSL_PKEY_PARAM_RSA_PSS_SALTLEN     "saltlen"

/* Key generation parameters */
#define OSSL_PKEY_PARAM_FFC_TYPE         "type"
#define OSSL_PKEY_PARAM_FFC_PBITS        "pbits"
#define OSSL_PKEY_PARAM_FFC_QBITS        "qbits"
#define OSSL_PKEY_PARAM_FFC_DIGEST       OSSL_PKEY_PARAM_DIGEST
#define OSSL_PKEY_PARAM_FFC_DIGEST_PROPS OSSL_PKEY_PARAM_PROPERTIES

/* Key Exchange parameters */
#define OSSL_EXCHANGE_PARAM_PAD                   "pad" /* uint */
#define OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE "ecdh-cofactor-mode" /* int */
#define OSSL_EXCHANGE_PARAM_KDF_TYPE              "kdf-type" /* utf8_string */
#define OSSL_EXCHANGE_PARAM_KDF_DIGEST            "kdf-digest" /* utf8_string */
#define OSSL_EXCHANGE_PARAM_KDF_DIGEST_PROPS      "kdf-digest-props" /* utf8_string */
#define OSSL_EXCHANGE_PARAM_KDF_OUTLEN            "kdf-outlen" /* size_t */

/*
 * TODO(3.0): improve this pattern
 *
 * Currently the sole internal user of OSSL_EXCHANGE_PARAM_KDF_UKM is
 * EVP_PKEY_CTX_{set0,get0}_ecdh_kdf_ukm():
 *      OSSL_EXCHANGE_PARAM_KDF_UKM is handled as a octet_string on set0,
 *      and as an octet_ptr on get0.
 *
 * This pattern is borrowed from the handling of
 * OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL in
 * EVP_PKEY_CTX_{set0,get0}_rsa_oaep_label().
 */
#define OSSL_EXCHANGE_PARAM_KDF_UKM               "kdf-ukm" /* see note above */
#define OSSL_EXCHANGE_PARAM_KDF_UKM_LEN           "kdf-ukm-len" /* size_t */

/* Signature parameters */
#define OSSL_SIGNATURE_PARAM_ALGORITHM_ID       "algorithm-id"
#define OSSL_SIGNATURE_PARAM_PAD_MODE           OSSL_PKEY_PARAM_PAD_MODE
#define OSSL_SIGNATURE_PARAM_DIGEST             OSSL_PKEY_PARAM_DIGEST
#define OSSL_SIGNATURE_PARAM_PROPERTIES         OSSL_PKEY_PARAM_PROPERTIES
#define OSSL_SIGNATURE_PARAM_PSS_SALTLEN        "saltlen"
#define OSSL_SIGNATURE_PARAM_MGF1_DIGEST        OSSL_PKEY_PARAM_MGF1_DIGEST
#define OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES    \
    OSSL_PKEY_PARAM_MGF1_PROPERTIES
#define OSSL_SIGNATURE_PARAM_DIGEST_SIZE        OSSL_PKEY_PARAM_DIGEST_SIZE

/* Asym cipher parameters */
#define OSSL_ASYM_CIPHER_PARAM_PAD_MODE                 OSSL_PKEY_PARAM_PAD_MODE
#define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST              \
    OSSL_PKEY_PARAM_MGF1_DIGEST
#define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS        \
    OSSL_PKEY_PARAM_MGF1_PROPERTIES
#define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST              OSSL_ALG_PARAM_DIGEST
#define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS        "digest-props"
#define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL               "oaep-label"
#define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN           "oaep-label-len"
#define OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION       "tls-client-version"
#define OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION   "tls-negotiated-version"

/*
 * Serializer parameters
 */
/* The passphrase may be passed as a utf8 string or an octet string */
#define OSSL_SERIALIZER_PARAM_CIPHER            OSSL_ALG_PARAM_CIPHER
#define OSSL_SERIALIZER_PARAM_PROPERTIES        OSSL_ALG_PARAM_PROPERTIES
#define OSSL_SERIALIZER_PARAM_PASS              "passphrase"

/* Passphrase callback parameters */
#define OSSL_PASSPHRASE_PARAM_INFO              "info"

/* Keygen callback parameters, from provider to libcrypto */
#define OSSL_GEN_PARAM_POTENTIAL            "potential" /* integer */
#define OSSL_GEN_PARAM_ITERATION            "iteration" /* integer */

/* ACVP Test parameters : These should not be used normally */
#define OSSL_PKEY_PARAM_RSA_TEST_XP1 "xp1"
#define OSSL_PKEY_PARAM_RSA_TEST_XP2 "xp2"
#define OSSL_PKEY_PARAM_RSA_TEST_XP  "xp"
#define OSSL_PKEY_PARAM_RSA_TEST_XQ1 "xq1"
#define OSSL_PKEY_PARAM_RSA_TEST_XQ2 "xq2"
#define OSSL_PKEY_PARAM_RSA_TEST_XQ  "xq"
#define OSSL_PKEY_PARAM_RSA_TEST_P1  "p1"
#define OSSL_PKEY_PARAM_RSA_TEST_P2  "p2"
#define OSSL_PKEY_PARAM_RSA_TEST_Q1  "q1"
#define OSSL_PKEY_PARAM_RSA_TEST_Q2  "q2"
#define OSSL_SIGNATURE_PARAM_KAT "kat"

# ifdef __cplusplus
}
# endif

#endif
Commit	Line	Data
8a73348b	1	/*
33388b44	2	* Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
8a73348b MC	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
ae4186b0 DMSP	10	#ifndef OPENSSL_CORE_NAMES_H
ae4186b0 DMSP	11	# define OPENSSL_CORE_NAMES_H
8a73348b MC	12
	13	# ifdef __cplusplus
	14	extern "C" {
	15	# endif
	16
b8086652 SL	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
36fc5fc6 SL	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 */
8a73348b	26
36fc5fc6 SL	27	/* Self test callback parameters */
	28	#define OSSL_PROV_PARAM_SELF_TEST_PHASE "st-phase" /* utf8_string */
	29	#define OSSL_PROV_PARAM_SELF_TEST_TYPE "st-type" /* utf8_string */
	30	#define OSSL_PROV_PARAM_SELF_TEST_DESC "st-desc" /* utf8_string */
df05f2ce	31
cb74317b P	32	/*
	33	* Algorithm parameters
	34	* If "engine" or "properties" are specified, they should always be paired
	35	* with the algorithm type.
b8086652 SL	36	* Note these are common names that are shared by many types (such as kdf, mac,
b8086652 SL	37	* and pkey) e.g: see OSSL_MAC_PARAM_DIGEST below.
cb74317b P	38	*/
	39	#define OSSL_ALG_PARAM_DIGEST "digest" /* utf8_string */
	40	#define OSSL_ALG_PARAM_CIPHER "cipher" /* utf8_string */
4e8b8e47	41	#define OSSL_ALG_PARAM_MAC "mac" /* utf8_string */
cb74317b P	42	#define OSSL_ALG_PARAM_PROPERTIES "properties"/* utf8_string */
cb74317b P	43
459b15d4	44	/* cipher parameters */
11b44359 SL	45	#define OSSL_CIPHER_PARAM_PADDING "padding" /* uint */
	46	#define OSSL_CIPHER_PARAM_MODE "mode" /* uint */
	47	#define OSSL_CIPHER_PARAM_BLOCK_SIZE "blocksize" /* size_t */
	48	#define OSSL_CIPHER_PARAM_FLAGS "flags" /* ulong */
	49	#define OSSL_CIPHER_PARAM_KEYLEN "keylen" /* size_t */
	50	#define OSSL_CIPHER_PARAM_IVLEN "ivlen" /* size_t */
	51	#define OSSL_CIPHER_PARAM_IV "iv" /* octet_string OR octet_ptr */
	52	#define OSSL_CIPHER_PARAM_NUM "num" /* uint */
	53	#define OSSL_CIPHER_PARAM_ROUNDS "rounds" /* uint */
	54	#define OSSL_CIPHER_PARAM_AEAD_TAG "tag" /* octet_string */
	55	#define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD "tlsaad" /* octet_string */
	56	#define OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD "tlsaadpad" /* size_t */
	57	#define OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED "tlsivfixed" /* octet_string */
	58	#define OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN "tlsivgen" /* octet_string */
	59	#define OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV "tlsivinv" /* octet_string */
	60	#define OSSL_CIPHER_PARAM_AEAD_IVLEN OSSL_CIPHER_PARAM_IVLEN
	61	#define OSSL_CIPHER_PARAM_AEAD_TAGLEN "taglen" /* size_t */
	62	#define OSSL_CIPHER_PARAM_AEAD_MAC_KEY "mackey" /* octet_string */
	63	#define OSSL_CIPHER_PARAM_RANDOM_KEY "randkey" /* octet_string */
	64	#define OSSL_CIPHER_PARAM_RC2_KEYBITS "keybits" /* size_t */
	65	#define OSSL_CIPHER_PARAM_SPEED "speed" /* uint */
c96399e2	66	/* For passing the AlgorithmIdentifier parameter in DER form */
11b44359	67	#define OSSL_CIPHER_PARAM_ALG_ID "alg_id_param" /* octet_string */
df05f2ce	68
0d2bfe52 SL	69	#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT \
	70	"tls1multi_maxsndfrag" /* uint */
	71	#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE \
	72	"tls1multi_maxbufsz" /* size_t */
	73	#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE \
	74	"tls1multi_interleave" /* uint */
	75	#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD \
	76	"tls1multi_aad" /* octet_string */
	77	#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN \
	78	"tls1multi_aadpacklen" /* uint */
	79	#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC \
	80	"tls1multi_enc" /* octet_string */
	81	#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN \
	82	"tls1multi_encin" /* octet_string */
	83	#define OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN \
	84	"tls1multi_enclen" /* size_t */
eb173822	85
d5e5e2ff	86	/* digest parameters */
1c3ace68 SL	87	#define OSSL_DIGEST_PARAM_XOFLEN "xoflen" /* size_t */
	88	#define OSSL_DIGEST_PARAM_SSL3_MS "ssl3-ms" /* octet string */
	89	#define OSSL_DIGEST_PARAM_PAD_TYPE "pad_type" /* uint */
	90	#define OSSL_DIGEST_PARAM_MICALG "micalg" /* utf8 string */
	91	#define OSSL_DIGEST_PARAM_BLOCK_SIZE "blocksize" /* size_t */
	92	#define OSSL_DIGEST_PARAM_SIZE "size" /* size_t */
	93	#define OSSL_DIGEST_PARAM_FLAGS "flags" /* ulong */
d5e5e2ff	94
81ff9eeb	95	/* Known DIGEST names (not a complete list) */
505b41fc	96	#define OSSL_DIGEST_NAME_MD5 "MD5"
6f4b7663	97	#define OSSL_DIGEST_NAME_MD5_SHA1 "MD5-SHA1"
505b41fc RL	98	#define OSSL_DIGEST_NAME_SHA1 "SHA1"
	99	#define OSSL_DIGEST_NAME_SHA2_224 "SHA2-224"
	100	#define OSSL_DIGEST_NAME_SHA2_256 "SHA2-256"
	101	#define OSSL_DIGEST_NAME_SHA2_384 "SHA2-384"
	102	#define OSSL_DIGEST_NAME_SHA2_512 "SHA2-512"
45c236ad SL	103	#define OSSL_DIGEST_NAME_SHA2_512_224 "SHA2-512/224"
45c236ad SL	104	#define OSSL_DIGEST_NAME_SHA2_512_256 "SHA2-512/256"
6f4b7663 RL	105	#define OSSL_DIGEST_NAME_MD2 "MD2"
	106	#define OSSL_DIGEST_NAME_MD4 "MD4"
	107	#define OSSL_DIGEST_NAME_MDC2 "MDC2"
	108	#define OSSL_DIGEST_NAME_RIPEMD160 "RIPEMD160"
505b41fc RL	109	#define OSSL_DIGEST_NAME_SHA3_224 "SHA3-224"
	110	#define OSSL_DIGEST_NAME_SHA3_256 "SHA3-256"
	111	#define OSSL_DIGEST_NAME_SHA3_384 "SHA3-384"
	112	#define OSSL_DIGEST_NAME_SHA3_512 "SHA3-512"
cc35c3ed MC	113	#define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128"
cc35c3ed MC	114	#define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256"
81ff9eeb	115
e74bd290	116	/* MAC parameters */
1c3ace68 SL	117	#define OSSL_MAC_PARAM_KEY "key" /* octet string */
	118	#define OSSL_MAC_PARAM_IV "iv" /* octet string */
	119	#define OSSL_MAC_PARAM_CUSTOM "custom" /* utf8 string */
	120	#define OSSL_MAC_PARAM_SALT "salt" /* octet string */
	121	#define OSSL_MAC_PARAM_XOF "xof" /* int, 0 or 1 */
	122	#define OSSL_MAC_PARAM_FLAGS "flags" /* int */
703170d4 RL	123	/*
	124	* If "engine" or "properties" are specified, they should always be paired
	125	* with "cipher" or "digest".
	126	*/
cb74317b P	127	#define OSSL_MAC_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
cb74317b P	128	#define OSSL_MAC_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */
cb74317b	129	#define OSSL_MAC_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
1c3ace68	130	#define OSSL_MAC_PARAM_SIZE "size" /* size_t */
e74bd290	131
b8086652 SL	132	/* Known MAC names */
	133	#define OSSL_MAC_NAME_BLAKE2BMAC "BLAKE2BMAC"
	134	#define OSSL_MAC_NAME_BLAKE2SMAC "BLAKE2SMAC"
81ff9eeb	135	#define OSSL_MAC_NAME_CMAC "CMAC"
b8086652	136	#define OSSL_MAC_NAME_GMAC "GMAC"
81ff9eeb RL	137	#define OSSL_MAC_NAME_HMAC "HMAC"
	138	#define OSSL_MAC_NAME_KMAC128 "KMAC128"
	139	#define OSSL_MAC_NAME_KMAC256 "KMAC256"
b8086652 SL	140	#define OSSL_MAC_NAME_POLY1305 "POLY1305"
b8086652 SL	141	#define OSSL_MAC_NAME_SIPHASH "SIPHASH"
81ff9eeb	142
2f755701 P	143	/* KDF / PRF parameters */
	144	#define OSSL_KDF_PARAM_SECRET "secret" /* octet string */
	145	#define OSSL_KDF_PARAM_KEY "key" /* octet string */
	146	#define OSSL_KDF_PARAM_SALT "salt" /* octet string */
	147	#define OSSL_KDF_PARAM_PASSWORD "pass" /* octet string */
4e8b8e47	148	#define OSSL_KDF_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */
f6dead1b	149	#define OSSL_KDF_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
4e8b8e47	150	#define OSSL_KDF_PARAM_MAC OSSL_ALG_PARAM_MAC /* utf8 string */
2f755701	151	#define OSSL_KDF_PARAM_MAC_SIZE "maclen" /* size_t */
cb74317b	152	#define OSSL_KDF_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
2f755701 P	153	#define OSSL_KDF_PARAM_ITER "iter" /* unsigned int */
	154	#define OSSL_KDF_PARAM_MODE "mode" /* utf8 string or int */
	155	#define OSSL_KDF_PARAM_PKCS5 "pkcs5" /* int */
	156	#define OSSL_KDF_PARAM_UKM "ukm" /* octet string */
	157	#define OSSL_KDF_PARAM_CEK_ALG "cekalg" /* utf8 string */
	158	#define OSSL_KDF_PARAM_SCRYPT_N "n" /* uint64_t */
	159	#define OSSL_KDF_PARAM_SCRYPT_R "r" /* uint32_t */
	160	#define OSSL_KDF_PARAM_SCRYPT_P "p" /* uint32_t */
	161	#define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */
	162	#define OSSL_KDF_PARAM_INFO "info" /* octet string */
	163	#define OSSL_KDF_PARAM_SEED "seed" /* octet string */
	164	#define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */
	165	#define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */
	166	#define OSSL_KDF_PARAM_SSHKDF_TYPE "type" /* int */
	167	#define OSSL_KDF_PARAM_SIZE "size" /* size_t */
33f54da3 SS	168	#define OSSL_KDF_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
33f54da3 SS	169	#define OSSL_KDF_PARAM_CONSTANT "constant" /* octet string */
2f755701	170
d810cc19 P	171	/* Known KDF names */
	172	#define OSSL_KDF_NAME_HKDF "HKDF"
	173	#define OSSL_KDF_NAME_PBKDF2 "PBKDF2"
cc35c3ed	174	#define OSSL_KDF_NAME_SCRYPT "SCRYPT"
d810cc19 P	175	#define OSSL_KDF_NAME_SSHKDF "SSHKDF"
	176	#define OSSL_KDF_NAME_SSKDF "SSKDF"
	177	#define OSSL_KDF_NAME_TLS1_PRF "TLS1-PRF"
	178	#define OSSL_KDF_NAME_X942KDF "X942KDF"
	179	#define OSSL_KDF_NAME_X963KDF "X963KDF"
a39bc440	180	#define OSSL_KDF_NAME_KBKDF "KBKDF"
33f54da3	181	#define OSSL_KDF_NAME_KRB5KDF "KRB5KDF"
d810cc19	182
ff64702b	183	/* PKEY parameters */
6508e858 RL	184	/* Common PKEY parameters */
	185	#define OSSL_PKEY_PARAM_BITS "bits" /* integer */
	186	#define OSSL_PKEY_PARAM_MAX_SIZE "max-size" /* integer */
	187	#define OSSL_PKEY_PARAM_SECURITY_BITS "security-bits" /* integer */
d5aef594	188	#define OSSL_PKEY_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST
8bee6512	189	#define OSSL_PKEY_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
ead0d234 RL	190	#define OSSL_PKEY_PARAM_DEFAULT_DIGEST "default-digest" /* utf8 string */
ead0d234 RL	191	#define OSSL_PKEY_PARAM_MANDATORY_DIGEST "mandatory-digest" /* utf8 string */
6f4b7663	192	#define OSSL_PKEY_PARAM_PAD_MODE "pad-mode"
6f4b7663	193	#define OSSL_PKEY_PARAM_DIGEST_SIZE "digest-size"
15671090	194	#define OSSL_PKEY_PARAM_MASKGENFUNC "mgf"
6f4b7663 RL	195	#define OSSL_PKEY_PARAM_MGF1_DIGEST "mgf1-digest"
6f4b7663 RL	196	#define OSSL_PKEY_PARAM_MGF1_PROPERTIES "mgf1-properties"
6a9bd929	197	#define OSSL_PKEY_PARAM_TLS_ENCODED_PT "tls-encoded-pt"
6f4b7663 RL	198
6f4b7663 RL	199	/* Diffie-Hellman/DSA public/private key */
90d3cb57 MC	200	#define OSSL_PKEY_PARAM_PUB_KEY "pub"
90d3cb57 MC	201	#define OSSL_PKEY_PARAM_PRIV_KEY "priv"
6508e858	202
4889dadc	203	/* Diffie-Hellman/DSA Parameters */
4f2271d5 SL	204	#define OSSL_PKEY_PARAM_FFC_P "p"
	205	#define OSSL_PKEY_PARAM_FFC_G "g"
	206	#define OSSL_PKEY_PARAM_FFC_Q "q"
	207	#define OSSL_PKEY_PARAM_FFC_GINDEX "gindex"
	208	#define OSSL_PKEY_PARAM_FFC_PCOUNTER "pcounter"
	209	#define OSSL_PKEY_PARAM_FFC_SEED "seed"
	210	#define OSSL_PKEY_PARAM_FFC_COFACTOR "j"
	211	#define OSSL_PKEY_PARAM_FFC_H "hindex"
	212	#define OSSL_PKEY_PARAM_FFC_VALIDATE_TYPE "valid-type"
	213
	214	/* Diffie-Hellman/DSA Parameters parameter validation types */
	215	#define OSSL_FFC_PARAM_VALIDATE_PQ "validate-pq"
	216	#define OSSL_FFC_PARAM_VALIDATE_G "validate-g"
	217	#define OSSL_FFC_PARAM_VALIDATE_PQG "validate-pqg"
7165593c SL	218
7165593c SL	219	/* Diffie-Hellman params */
4f2271d5 SL	220	#define OSSL_PKEY_PARAM_DH_GROUP "group"
	221	#define OSSL_PKEY_PARAM_DH_GENERATOR "safeprime-generator"
	222	#define OSSL_PKEY_PARAM_DH_PRIV_LEN "priv_len"
7165593c	223
4fe54d67 NT	224	/* Elliptic Curve Domain Parameters */
4fe54d67 NT	225	#define OSSL_PKEY_PARAM_EC_NAME "curve-name"
4f2271d5 SL	226	#define OSSL_PKEY_PARAM_EC_PUB_X "qx"
4f2271d5 SL	227	#define OSSL_PKEY_PARAM_EC_PUB_Y "qy"
4fe54d67 NT	228
	229	/* Elliptic Curve Key Parameters */
	230	#define OSSL_PKEY_PARAM_USE_COFACTOR_FLAG "use-cofactor-flag"
	231	#define OSSL_PKEY_PARAM_USE_COFACTOR_ECDH \
	232	OSSL_PKEY_PARAM_USE_COFACTOR_FLAG
	233
29be6023 RL	234	/* RSA Keys */
	235	/*
	236	* n, e, d are the usual public and private key components
	237	*
	238	* rsa-num is the number of factors, including p and q
	239	* rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
	240	* rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
	241	* rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
	242	*
	243	* The number of rsa-factor items must be equal to the number of rsa-exponent
	244	* items, and the number of rsa-coefficients must be one less.
	245	* (the base i for the coefficients is 2, not 1, at least as implied by
	246	* RFC 8017)
	247	*/
	248	#define OSSL_PKEY_PARAM_RSA_N "n"
	249	#define OSSL_PKEY_PARAM_RSA_E "e"
	250	#define OSSL_PKEY_PARAM_RSA_D "d"
	251	#define OSSL_PKEY_PARAM_RSA_FACTOR "rsa-factor"
	252	#define OSSL_PKEY_PARAM_RSA_EXPONENT "rsa-exponent"
	253	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient"
96ebe52e SL	254	#define OSSL_PKEY_PARAM_RSA_FACTOR1 OSSL_PKEY_PARAM_RSA_FACTOR"1"
	255	#define OSSL_PKEY_PARAM_RSA_FACTOR2 OSSL_PKEY_PARAM_RSA_FACTOR"2"
	256	#define OSSL_PKEY_PARAM_RSA_FACTOR3 OSSL_PKEY_PARAM_RSA_FACTOR"3"
	257	#define OSSL_PKEY_PARAM_RSA_FACTOR4 OSSL_PKEY_PARAM_RSA_FACTOR"4"
	258	#define OSSL_PKEY_PARAM_RSA_FACTOR5 OSSL_PKEY_PARAM_RSA_FACTOR"5"
	259	#define OSSL_PKEY_PARAM_RSA_FACTOR6 OSSL_PKEY_PARAM_RSA_FACTOR"6"
	260	#define OSSL_PKEY_PARAM_RSA_FACTOR7 OSSL_PKEY_PARAM_RSA_FACTOR"7"
	261	#define OSSL_PKEY_PARAM_RSA_FACTOR8 OSSL_PKEY_PARAM_RSA_FACTOR"8"
	262	#define OSSL_PKEY_PARAM_RSA_FACTOR9 OSSL_PKEY_PARAM_RSA_FACTOR"9"
	263	#define OSSL_PKEY_PARAM_RSA_FACTOR10 OSSL_PKEY_PARAM_RSA_FACTOR"10"
	264	#define OSSL_PKEY_PARAM_RSA_EXPONENT1 OSSL_PKEY_PARAM_RSA_EXPONENT"1"
	265	#define OSSL_PKEY_PARAM_RSA_EXPONENT2 OSSL_PKEY_PARAM_RSA_EXPONENT"2"
	266	#define OSSL_PKEY_PARAM_RSA_EXPONENT3 OSSL_PKEY_PARAM_RSA_EXPONENT"3"
	267	#define OSSL_PKEY_PARAM_RSA_EXPONENT4 OSSL_PKEY_PARAM_RSA_EXPONENT"4"
	268	#define OSSL_PKEY_PARAM_RSA_EXPONENT5 OSSL_PKEY_PARAM_RSA_EXPONENT"5"
	269	#define OSSL_PKEY_PARAM_RSA_EXPONENT6 OSSL_PKEY_PARAM_RSA_EXPONENT"6"
	270	#define OSSL_PKEY_PARAM_RSA_EXPONENT7 OSSL_PKEY_PARAM_RSA_EXPONENT"7"
	271	#define OSSL_PKEY_PARAM_RSA_EXPONENT8 OSSL_PKEY_PARAM_RSA_EXPONENT"8"
	272	#define OSSL_PKEY_PARAM_RSA_EXPONENT9 OSSL_PKEY_PARAM_RSA_EXPONENT"9"
	273	#define OSSL_PKEY_PARAM_RSA_EXPONENT10 OSSL_PKEY_PARAM_RSA_EXPONENT"10"
	274	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT1 OSSL_PKEY_PARAM_RSA_COEFFICIENT"1"
	275	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT2 OSSL_PKEY_PARAM_RSA_COEFFICIENT"2"
	276	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT3 OSSL_PKEY_PARAM_RSA_COEFFICIENT"3"
	277	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT4 OSSL_PKEY_PARAM_RSA_COEFFICIENT"4"
	278	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT5 OSSL_PKEY_PARAM_RSA_COEFFICIENT"5"
	279	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT6 OSSL_PKEY_PARAM_RSA_COEFFICIENT"6"
	280	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT7 OSSL_PKEY_PARAM_RSA_COEFFICIENT"7"
	281	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT8 OSSL_PKEY_PARAM_RSA_COEFFICIENT"8"
	282	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT9 OSSL_PKEY_PARAM_RSA_COEFFICIENT"9"
	283
b8086652 SL	284	/* RSA padding modes */
	285	#define OSSL_PKEY_RSA_PAD_MODE_NONE "none"
	286	#define OSSL_PKEY_RSA_PAD_MODE_PKCSV15 "pkcs1"
	287	#define OSSL_PKEY_RSA_PAD_MODE_SSLV23 "sslv23"
	288	#define OSSL_PKEY_RSA_PAD_MODE_OAEP "oaep"
	289	#define OSSL_PKEY_RSA_PAD_MODE_X931 "x931"
	290	#define OSSL_PKEY_RSA_PAD_MODE_PSS "pss"
	291
	292	/* RSA pss padding salt length */
	293	#define OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST "digest"
	294	#define OSSL_PKEY_RSA_PSS_SALT_LEN_MAX "max"
	295	#define OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO "auto"
96ebe52e	296
62924755	297	/* Key generation parameters */
15671090 RL	298	#define OSSL_PKEY_PARAM_RSA_BITS OSSL_PKEY_PARAM_BITS
	299	#define OSSL_PKEY_PARAM_RSA_PRIMES "primes"
	300	#define OSSL_PKEY_PARAM_RSA_DIGEST OSSL_PKEY_PARAM_DIGEST
	301	#define OSSL_PKEY_PARAM_RSA_MASKGENFUNC OSSL_PKEY_PARAM_MASKGENFUNC
	302	#define OSSL_PKEY_PARAM_RSA_MGF1_DIGEST OSSL_PKEY_PARAM_MGF1_DIGEST
	303	#define OSSL_PKEY_PARAM_RSA_PSS_SALTLEN "saltlen"
29be6023	304
b03ec3b5 SL	305	/* Key generation parameters */
	306	#define OSSL_PKEY_PARAM_FFC_TYPE "type"
	307	#define OSSL_PKEY_PARAM_FFC_PBITS "pbits"
	308	#define OSSL_PKEY_PARAM_FFC_QBITS "qbits"
	309	#define OSSL_PKEY_PARAM_FFC_DIGEST OSSL_PKEY_PARAM_DIGEST
	310	#define OSSL_PKEY_PARAM_FFC_DIGEST_PROPS OSSL_PKEY_PARAM_PROPERTIES
	311
35aca9ec	312	/* Key Exchange parameters */
4fe54d67 NT	313	#define OSSL_EXCHANGE_PARAM_PAD "pad" /* uint */
	314	#define OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE "ecdh-cofactor-mode" /* int */
	315	#define OSSL_EXCHANGE_PARAM_KDF_TYPE "kdf-type" /* utf8_string */
	316	#define OSSL_EXCHANGE_PARAM_KDF_DIGEST "kdf-digest" /* utf8_string */
	317	#define OSSL_EXCHANGE_PARAM_KDF_DIGEST_PROPS "kdf-digest-props" /* utf8_string */
	318	#define OSSL_EXCHANGE_PARAM_KDF_OUTLEN "kdf-outlen" /* size_t */
	319
	320	/*
	321	* TODO(3.0): improve this pattern
	322	*
	323	* Currently the sole internal user of OSSL_EXCHANGE_PARAM_KDF_UKM is
	324	* EVP_PKEY_CTX_{set0,get0}_ecdh_kdf_ukm():
	325	* OSSL_EXCHANGE_PARAM_KDF_UKM is handled as a octet_string on set0,
	326	* and as an octet_ptr on get0.
	327	*
	328	* This pattern is borrowed from the handling of
	329	* OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL in
	330	* EVP_PKEY_CTX_{set0,get0}_rsa_oaep_label().
	331	*/
	332	#define OSSL_EXCHANGE_PARAM_KDF_UKM "kdf-ukm" /* see note above */
	333	#define OSSL_EXCHANGE_PARAM_KDF_UKM_LEN "kdf-ukm-len" /* size_t */
35aca9ec	334
4889dadc	335	/* Signature parameters */
d5aef594	336	#define OSSL_SIGNATURE_PARAM_ALGORITHM_ID "algorithm-id"
6f4b7663	337	#define OSSL_SIGNATURE_PARAM_PAD_MODE OSSL_PKEY_PARAM_PAD_MODE
d5aef594	338	#define OSSL_SIGNATURE_PARAM_DIGEST OSSL_PKEY_PARAM_DIGEST
8bee6512	339	#define OSSL_SIGNATURE_PARAM_PROPERTIES OSSL_PKEY_PARAM_PROPERTIES
15671090	340	#define OSSL_SIGNATURE_PARAM_PSS_SALTLEN "saltlen"
6f4b7663 RL	341	#define OSSL_SIGNATURE_PARAM_MGF1_DIGEST OSSL_PKEY_PARAM_MGF1_DIGEST
	342	#define OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES \
	343	OSSL_PKEY_PARAM_MGF1_PROPERTIES
edd3b7a3	344	#define OSSL_SIGNATURE_PARAM_DIGEST_SIZE OSSL_PKEY_PARAM_DIGEST_SIZE
4889dadc	345
89abd1b6	346	/* Asym cipher parameters */
6f4b7663 RL	347	#define OSSL_ASYM_CIPHER_PARAM_PAD_MODE OSSL_PKEY_PARAM_PAD_MODE
	348	#define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST \
	349	OSSL_PKEY_PARAM_MGF1_DIGEST
	350	#define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS \
	351	OSSL_PKEY_PARAM_MGF1_PROPERTIES
d9a75107 MC	352	#define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST OSSL_ALG_PARAM_DIGEST
d9a75107 MC	353	#define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS "digest-props"
d9a75107 MC	354	#define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL "oaep-label"
	355	#define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN "oaep-label-len"
	356	#define OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION "tls-client-version"
	357	#define OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION "tls-negotiated-version"
89abd1b6	358
866234ac RL	359	/*
	360	* Serializer parameters
	361	*/
	362	/* The passphrase may be passed as a utf8 string or an octet string */
	363	#define OSSL_SERIALIZER_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER
	364	#define OSSL_SERIALIZER_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
	365	#define OSSL_SERIALIZER_PARAM_PASS "passphrase"
	366
	367	/* Passphrase callback parameters */
	368	#define OSSL_PASSPHRASE_PARAM_INFO "info"
	369
62924755 RL	370	/* Keygen callback parameters, from provider to libcrypto */
	371	#define OSSL_GEN_PARAM_POTENTIAL "potential" /* integer */
	372	#define OSSL_GEN_PARAM_ITERATION "iteration" /* integer */
	373
4f2271d5 SL	374	/* ACVP Test parameters : These should not be used normally */
	375	#define OSSL_PKEY_PARAM_RSA_TEST_XP1 "xp1"
	376	#define OSSL_PKEY_PARAM_RSA_TEST_XP2 "xp2"
	377	#define OSSL_PKEY_PARAM_RSA_TEST_XP "xp"
	378	#define OSSL_PKEY_PARAM_RSA_TEST_XQ1 "xq1"
	379	#define OSSL_PKEY_PARAM_RSA_TEST_XQ2 "xq2"
	380	#define OSSL_PKEY_PARAM_RSA_TEST_XQ "xq"
	381	#define OSSL_PKEY_PARAM_RSA_TEST_P1 "p1"
	382	#define OSSL_PKEY_PARAM_RSA_TEST_P2 "p2"
	383	#define OSSL_PKEY_PARAM_RSA_TEST_Q1 "q1"
	384	#define OSSL_PKEY_PARAM_RSA_TEST_Q2 "q2"
	385	#define OSSL_SIGNATURE_PARAM_KAT "kat"
	386
8a73348b MC	387	# ifdef __cplusplus
	388	}
	389	# endif
	390
	391	#endif