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

/*
 * Copyright 2019 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 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 */
#define OSSL_PROV_PARAM_MODULE_FILENAME "module-filename"     /* octet_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.
 */
#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_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 (not a complete list) */
#define OSSL_MAC_NAME_CMAC          "CMAC"
#define OSSL_MAC_NAME_HMAC          "HMAC"
#define OSSL_MAC_NAME_KMAC128       "KMAC128"
#define OSSL_MAC_NAME_KMAC256       "KMAC256"

/* 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_DEFAULT_DIGEST      "default-digest" /* utf8 string */
#define OSSL_PKEY_PARAM_MANDATORY_DIGEST    "mandatory-digest" /* utf8 string */

/* 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"

/* Diffie-Hellman Keys */
#define OSSL_PKEY_PARAM_DH_PUB_KEY   "pub"
#define OSSL_PKEY_PARAM_DH_PRIV_KEY  "priv"

/* DSA Keys */
#define OSSL_PKEY_PARAM_DSA_PUB_KEY  "pub"
#define OSSL_PKEY_PARAM_DSA_PRIV_KEY "priv"

/* 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"

/* Key Exchange parameters */

#define OSSL_EXCHANGE_PARAM_PAD      "pad" /* uint */

/* Signature parameters */
#define OSSL_SIGNATURE_PARAM_DIGEST         OSSL_ALG_PARAM_DIGEST
#define OSSL_SIGNATURE_PARAM_DIGEST_SIZE    "digest-size"

/* Asym cipher parameters */
#define OSSL_ASYM_CIPHER_PARAM_PAD_MODE                 "pad-mode"
#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_MGF1_DIGEST              "mgf1-digest"
#define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS        "mgf1-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"

# ifdef __cplusplus
}
# endif

#endif
Commit	Line	Data
8a73348b MC	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
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
36fc5fc6 SL	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 */
8a73348b	22
36fc5fc6 SL	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 */
df05f2ce	27
cb74317b P	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 */
4e8b8e47	35	#define OSSL_ALG_PARAM_MAC "mac" /* utf8_string */
cb74317b P	36	#define OSSL_ALG_PARAM_PROPERTIES "properties"/* utf8_string */
cb74317b P	37
459b15d4	38	/* cipher parameters */
11b44359 SL	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 */
c96399e2	60	/* For passing the AlgorithmIdentifier parameter in DER form */
11b44359	61	#define OSSL_CIPHER_PARAM_ALG_ID "alg_id_param" /* octet_string */
df05f2ce	62
0d2bfe52 SL	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 */
eb173822	79
d5e5e2ff	80	/* digest parameters */
1c3ace68 SL	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 */
d5e5e2ff	88
81ff9eeb	89	/* Known DIGEST names (not a complete list) */
47b4ccea	90	#define OSSL_DIGEST_NAME_MD5 "MD5"
cc35c3ed MC	91	#define OSSL_DIGEST_NAME_KECCAK_KMAC128 "KECCAK-KMAC-128"
cc35c3ed MC	92	#define OSSL_DIGEST_NAME_KECCAK_KMAC256 "KECCAK-KMAC-256"
81ff9eeb	93
e74bd290	94	/* MAC parameters */
1c3ace68 SL	95	#define OSSL_MAC_PARAM_KEY "key" /* octet string */
	96	#define OSSL_MAC_PARAM_IV "iv" /* octet string */
	97	#define OSSL_MAC_PARAM_CUSTOM "custom" /* utf8 string */
	98	#define OSSL_MAC_PARAM_SALT "salt" /* octet string */
	99	#define OSSL_MAC_PARAM_XOF "xof" /* int, 0 or 1 */
	100	#define OSSL_MAC_PARAM_FLAGS "flags" /* int */
703170d4 RL	101	/*
	102	* If "engine" or "properties" are specified, they should always be paired
	103	* with "cipher" or "digest".
	104	*/
cb74317b P	105	#define OSSL_MAC_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
cb74317b P	106	#define OSSL_MAC_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */
cb74317b	107	#define OSSL_MAC_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
1c3ace68	108	#define OSSL_MAC_PARAM_SIZE "size" /* size_t */
e74bd290	109
81ff9eeb RL	110	/* Known MAC names (not a complete list) */
	111	#define OSSL_MAC_NAME_CMAC "CMAC"
	112	#define OSSL_MAC_NAME_HMAC "HMAC"
	113	#define OSSL_MAC_NAME_KMAC128 "KMAC128"
	114	#define OSSL_MAC_NAME_KMAC256 "KMAC256"
	115
2f755701 P	116	/* KDF / PRF parameters */
	117	#define OSSL_KDF_PARAM_SECRET "secret" /* octet string */
	118	#define OSSL_KDF_PARAM_KEY "key" /* octet string */
	119	#define OSSL_KDF_PARAM_SALT "salt" /* octet string */
	120	#define OSSL_KDF_PARAM_PASSWORD "pass" /* octet string */
4e8b8e47	121	#define OSSL_KDF_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST /* utf8 string */
f6dead1b	122	#define OSSL_KDF_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
4e8b8e47	123	#define OSSL_KDF_PARAM_MAC OSSL_ALG_PARAM_MAC /* utf8 string */
2f755701	124	#define OSSL_KDF_PARAM_MAC_SIZE "maclen" /* size_t */
cb74317b	125	#define OSSL_KDF_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES /* utf8 string */
2f755701 P	126	#define OSSL_KDF_PARAM_ITER "iter" /* unsigned int */
	127	#define OSSL_KDF_PARAM_MODE "mode" /* utf8 string or int */
	128	#define OSSL_KDF_PARAM_PKCS5 "pkcs5" /* int */
	129	#define OSSL_KDF_PARAM_UKM "ukm" /* octet string */
	130	#define OSSL_KDF_PARAM_CEK_ALG "cekalg" /* utf8 string */
	131	#define OSSL_KDF_PARAM_SCRYPT_N "n" /* uint64_t */
	132	#define OSSL_KDF_PARAM_SCRYPT_R "r" /* uint32_t */
	133	#define OSSL_KDF_PARAM_SCRYPT_P "p" /* uint32_t */
	134	#define OSSL_KDF_PARAM_SCRYPT_MAXMEM "maxmem_bytes" /* uint64_t */
	135	#define OSSL_KDF_PARAM_INFO "info" /* octet string */
	136	#define OSSL_KDF_PARAM_SEED "seed" /* octet string */
	137	#define OSSL_KDF_PARAM_SSHKDF_XCGHASH "xcghash" /* octet string */
	138	#define OSSL_KDF_PARAM_SSHKDF_SESSION_ID "session_id" /* octet string */
	139	#define OSSL_KDF_PARAM_SSHKDF_TYPE "type" /* int */
	140	#define OSSL_KDF_PARAM_SIZE "size" /* size_t */
33f54da3 SS	141	#define OSSL_KDF_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER /* utf8 string */
33f54da3 SS	142	#define OSSL_KDF_PARAM_CONSTANT "constant" /* octet string */
2f755701	143
d810cc19 P	144	/* Known KDF names */
	145	#define OSSL_KDF_NAME_HKDF "HKDF"
	146	#define OSSL_KDF_NAME_PBKDF2 "PBKDF2"
cc35c3ed	147	#define OSSL_KDF_NAME_SCRYPT "SCRYPT"
d810cc19 P	148	#define OSSL_KDF_NAME_SSHKDF "SSHKDF"
	149	#define OSSL_KDF_NAME_SSKDF "SSKDF"
	150	#define OSSL_KDF_NAME_TLS1_PRF "TLS1-PRF"
	151	#define OSSL_KDF_NAME_X942KDF "X942KDF"
	152	#define OSSL_KDF_NAME_X963KDF "X963KDF"
a39bc440	153	#define OSSL_KDF_NAME_KBKDF "KBKDF"
33f54da3	154	#define OSSL_KDF_NAME_KRB5KDF "KRB5KDF"
d810cc19	155
ff64702b	156	/* PKEY parameters */
6508e858 RL	157	/* Common PKEY parameters */
	158	#define OSSL_PKEY_PARAM_BITS "bits" /* integer */
	159	#define OSSL_PKEY_PARAM_MAX_SIZE "max-size" /* integer */
	160	#define OSSL_PKEY_PARAM_SECURITY_BITS "security-bits" /* integer */
ead0d234 RL	161	#define OSSL_PKEY_PARAM_DEFAULT_DIGEST "default-digest" /* utf8 string */
ead0d234 RL	162	#define OSSL_PKEY_PARAM_MANDATORY_DIGEST "mandatory-digest" /* utf8 string */
6508e858	163
4889dadc	164	/* Diffie-Hellman/DSA Parameters */
20bf3d8b MC	165	#define OSSL_PKEY_PARAM_FFC_P "p"
	166	#define OSSL_PKEY_PARAM_FFC_G "g"
	167	#define OSSL_PKEY_PARAM_FFC_Q "q"
4889dadc	168
ff64702b	169	/* Diffie-Hellman Keys */
20bf3d8b MC	170	#define OSSL_PKEY_PARAM_DH_PUB_KEY "pub"
20bf3d8b MC	171	#define OSSL_PKEY_PARAM_DH_PRIV_KEY "priv"
ff64702b	172
4889dadc	173	/* DSA Keys */
20bf3d8b MC	174	#define OSSL_PKEY_PARAM_DSA_PUB_KEY "pub"
20bf3d8b MC	175	#define OSSL_PKEY_PARAM_DSA_PRIV_KEY "priv"
4889dadc	176
29be6023 RL	177	/* RSA Keys */
	178	/*
	179	* n, e, d are the usual public and private key components
	180	*
	181	* rsa-num is the number of factors, including p and q
	182	* rsa-factor is used for each factor: p, q, r_i (i = 3, ...)
	183	* rsa-exponent is used for each exponent: dP, dQ, d_i (i = 3, ...)
	184	* rsa-coefficient is used for each coefficient: qInv, t_i (i = 3, ...)
	185	*
	186	* The number of rsa-factor items must be equal to the number of rsa-exponent
	187	* items, and the number of rsa-coefficients must be one less.
	188	* (the base i for the coefficients is 2, not 1, at least as implied by
	189	* RFC 8017)
	190	*/
	191	#define OSSL_PKEY_PARAM_RSA_N "n"
	192	#define OSSL_PKEY_PARAM_RSA_E "e"
	193	#define OSSL_PKEY_PARAM_RSA_D "d"
	194	#define OSSL_PKEY_PARAM_RSA_FACTOR "rsa-factor"
	195	#define OSSL_PKEY_PARAM_RSA_EXPONENT "rsa-exponent"
	196	#define OSSL_PKEY_PARAM_RSA_COEFFICIENT "rsa-coefficient"
	197
35aca9ec MC	198	/* Key Exchange parameters */
35aca9ec MC	199
20bf3d8b	200	#define OSSL_EXCHANGE_PARAM_PAD "pad" /* uint */
35aca9ec	201
4889dadc	202	/* Signature parameters */
89abd1b6	203	#define OSSL_SIGNATURE_PARAM_DIGEST OSSL_ALG_PARAM_DIGEST
4889dadc MC	204	#define OSSL_SIGNATURE_PARAM_DIGEST_SIZE "digest-size"
4889dadc MC	205
89abd1b6	206	/* Asym cipher parameters */
d9a75107 MC	207	#define OSSL_ASYM_CIPHER_PARAM_PAD_MODE "pad-mode"
	208	#define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST OSSL_ALG_PARAM_DIGEST
	209	#define OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS "digest-props"
	210	#define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST "mgf1-digest"
	211	#define OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS "mgf1-digest-props"
	212	#define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL "oaep-label"
	213	#define OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN "oaep-label-len"
	214	#define OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION "tls-client-version"
	215	#define OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION "tls-negotiated-version"
89abd1b6	216
866234ac RL	217	/*
	218	* Serializer parameters
	219	*/
	220	/* The passphrase may be passed as a utf8 string or an octet string */
	221	#define OSSL_SERIALIZER_PARAM_CIPHER OSSL_ALG_PARAM_CIPHER
	222	#define OSSL_SERIALIZER_PARAM_PROPERTIES OSSL_ALG_PARAM_PROPERTIES
	223	#define OSSL_SERIALIZER_PARAM_PASS "passphrase"
	224
	225	/* Passphrase callback parameters */
	226	#define OSSL_PASSPHRASE_PARAM_INFO "info"
	227
8a73348b MC	228	# ifdef __cplusplus
	229	}
	230	# endif
	231
	232	#endif