Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "PROVIDER-KEYMGMT 7ossl" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
provider-keymgmt - The KEYMGMT library <-> provider functions Header "SYNOPSIS" .Vb 1 #include <openssl/core_dispatch.h> \& /* * None of these are actual functions, but are displayed like this for * the function signatures for functions that are offered as function * pointers in OSSL_DISPATCH arrays. */ \& /* Key object (keydata) creation and destruction */ void *OSSL_FUNC_keymgmt_new(void *provctx); void OSSL_FUNC_keymgmt_free(void *keydata); \& /* Generation, a more complex constructor */ void *OSSL_FUNC_keymgmt_gen_init(void *provctx, int selection, const OSSL_PARAM params[]); int OSSL_FUNC_keymgmt_gen_set_template(void *genctx, void *template); int OSSL_FUNC_keymgmt_gen_set_params(void *genctx, const OSSL_PARAM params[]); const OSSL_PARAM *OSSL_FUNC_keymgmt_gen_settable_params(void *genctx, void *provctx); void *OSSL_FUNC_keymgmt_gen(void *genctx, OSSL_CALLBACK *cb, void *cbarg); void OSSL_FUNC_keymgmt_gen_cleanup(void *genctx); \& /* Key loading by object reference, also a constructor */ void *OSSL_FUNC_keymgmt_load(const void *reference, size_t *reference_sz); \& /* Key object information */ int OSSL_FUNC_keymgmt_get_params(void *keydata, OSSL_PARAM params[]); const OSSL_PARAM *OSSL_FUNC_keymgmt_gettable_params(void *provctx); int OSSL_FUNC_keymgmt_set_params(void *keydata, const OSSL_PARAM params[]); const OSSL_PARAM *OSSL_FUNC_keymgmt_settable_params(void *provctx); \& /* Key object content checks */ int OSSL_FUNC_keymgmt_has(const void *keydata, int selection); int OSSL_FUNC_keymgmt_match(const void *keydata1, const void *keydata2, int selection); \& /* Discovery of supported operations */ const char *OSSL_FUNC_keymgmt_query_operation_name(int operation_id); \& /* Key object import and export functions */ int OSSL_FUNC_keymgmt_import(void *keydata, int selection, const OSSL_PARAM params[]); const OSSL_PARAM *OSSL_FUNC_keymgmt_import_types(int selection); int OSSL_FUNC_keymgmt_export(void *keydata, int selection, OSSL_CALLBACK *param_cb, void *cbarg); const OSSL_PARAM *OSSL_FUNC_keymgmt_export_types(int selection); \& /* Key object duplication, a constructor */ void *OSSL_FUNC_keymgmt_dup(const void *keydata_from, int selection); \& /* Key object validation */ int OSSL_FUNC_keymgmt_validate(const void *keydata, int selection, int checktype); .Ve Header "DESCRIPTION" The \s-1KEYMGMT\s0 operation doesn't have much public visibility in OpenSSL libraries, it's rather an internal operation that's designed to work in tandem with operations that use private/public key pairs.

Because the \s-1KEYMGMT\s0 operation shares knowledge with the operations it works with in tandem, they must belong to the same provider. The OpenSSL libraries will ensure that they do.

The primary responsibility of the \s-1KEYMGMT\s0 operation is to hold the provider side key data for the OpenSSL library \s-1EVP_PKEY\s0 structure.

All \*(L"functions\*(R" mentioned here are passed as function pointers between \fIlibcrypto and the provider in \s-1OSSL_DISPATCH\s0\|(3) arrays via \s-1OSSL_ALGORITHM\s0\|(3) arrays that are returned by the provider's \fBprovider_query_operation() function (see \*(L"Provider Functions\*(R" in provider-base\|(7)).

All these \*(L"functions\*(R" have a corresponding function type definition named OSSL_FUNC_{name}_fn, and a helper function to retrieve the function pointer from a \s-1OSSL_DISPATCH\s0\|(3) element named \fBOSSL_FUNC_{name}. For example, the \*(L"function\*(R" OSSL_FUNC_keymgmt_new() has these:

.Vb 3 typedef void *(OSSL_FUNC_keymgmt_new_fn)(void *provctx); static ossl_inline OSSL_FUNC_keymgmt_new_fn OSSL_FUNC_keymgmt_new(const OSSL_DISPATCH *opf); .Ve

\s-1OSSL_DISPATCH\s0\|(3) arrays are indexed by numbers that are provided as macros in openssl-core_dispatch.h\|(7), as follows:

.Vb 2 OSSL_FUNC_keymgmt_new OSSL_FUNC_KEYMGMT_NEW OSSL_FUNC_keymgmt_free OSSL_FUNC_KEYMGMT_FREE \& OSSL_FUNC_keymgmt_gen_init OSSL_FUNC_KEYMGMT_GEN_INIT OSSL_FUNC_keymgmt_gen_set_template OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE OSSL_FUNC_keymgmt_gen_set_params OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS OSSL_FUNC_keymgmt_gen_settable_params OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS OSSL_FUNC_keymgmt_gen OSSL_FUNC_KEYMGMT_GEN OSSL_FUNC_keymgmt_gen_cleanup OSSL_FUNC_KEYMGMT_GEN_CLEANUP \& OSSL_FUNC_keymgmt_load OSSL_FUNC_KEYMGMT_LOAD \& OSSL_FUNC_keymgmt_get_params OSSL_FUNC_KEYMGMT_GET_PARAMS OSSL_FUNC_keymgmt_gettable_params OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS OSSL_FUNC_keymgmt_set_params OSSL_FUNC_KEYMGMT_SET_PARAMS OSSL_FUNC_keymgmt_settable_params OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS \& OSSL_FUNC_keymgmt_query_operation_name OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME \& OSSL_FUNC_keymgmt_has OSSL_FUNC_KEYMGMT_HAS OSSL_FUNC_keymgmt_validate OSSL_FUNC_KEYMGMT_VALIDATE OSSL_FUNC_keymgmt_match OSSL_FUNC_KEYMGMT_MATCH \& OSSL_FUNC_keymgmt_import OSSL_FUNC_KEYMGMT_IMPORT OSSL_FUNC_keymgmt_import_types OSSL_FUNC_KEYMGMT_IMPORT_TYPES OSSL_FUNC_keymgmt_export OSSL_FUNC_KEYMGMT_EXPORT OSSL_FUNC_keymgmt_export_types OSSL_FUNC_KEYMGMT_EXPORT_TYPES \& OSSL_FUNC_keymgmt_dup OSSL_FUNC_KEYMGMT_DUP .Ve

Subsection "Key Objects" A key object is a collection of data for an asymmetric key, and is represented as keydata in this manual.

The exact contents of a key object are defined by the provider, and it is assumed that different operations in one and the same provider use the exact same structure to represent this collection of data, so that for example, a key object that has been created using the \s-1KEYMGMT\s0 interface that we document here can be passed as is to other provider operations, such as OP_signature_sign_init() (see \fBprovider-signature\|(7)).

With some of the \s-1KEYMGMT\s0 functions, it's possible to select a specific subset of data to handle, governed by the bits in a selection indicator. The bits are:

Item "OSSL_KEYMGMT_SELECT_PRIVATE_KEY" Indicating that the private key data in a key object should be considered. Item "OSSL_KEYMGMT_SELECT_PUBLIC_KEY" Indicating that the public key data in a key object should be considered. Item "OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS" Indicating that the domain parameters in a key object should be considered. Item "OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS" Indicating that other parameters in a key object should be considered. .Sp Other parameters are key parameters that don't fit any other classification. In other words, this particular selector bit works as a last resort bit bucket selector.

Some selector bits have also been combined for easier use:

Item "OSSL_KEYMGMT_SELECT_ALL_PARAMETERS" Indicating that all key object parameters should be considered, regardless of their more granular classification. .Sp This is a combination of \s-1OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS\s0 and \fB\s-1OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS\s0. Item "OSSL_KEYMGMT_SELECT_KEYPAIR" Indicating that both the whole key pair in a key object should be considered, i.e. the combination of public and private key. .Sp This is a combination of \s-1OSSL_KEYMGMT_SELECT_PRIVATE_KEY\s0 and \fB\s-1OSSL_KEYMGMT_SELECT_PUBLIC_KEY\s0. Item "OSSL_KEYMGMT_SELECT_ALL" Indicating that everything in a key object should be considered.

The exact interpretation of those bits or how they combine is left to each function where you can specify a selector.

It's left to the provider implementation to decide what is reasonable to do with regards to received selector bits and how to do it. Among others, an implementation of OSSL_FUNC_keymgmt_match() might opt to not compare the private half if it has compared the public half, since a match of one half implies a match of the other half.

Subsection "Constructing and Destructing Functions" \fBOSSL_FUNC_keymgmt_new() should create a provider side key object. The provider context provctx is passed and may be incorporated in the key object, but that is not mandatory.

\fBOSSL_FUNC_keymgmt_free() should free the passed keydata.

\fBOSSL_FUNC_keymgmt_gen_init(), OSSL_FUNC_keymgmt_gen_set_template(), \fBOSSL_FUNC_keymgmt_gen_set_params(), OSSL_FUNC_keymgmt_gen_settable_params(), \fBOSSL_FUNC_keymgmt_gen() and OSSL_FUNC_keymgmt_gen_cleanup() work together as a more elaborate context based key object constructor.

\fBOSSL_FUNC_keymgmt_gen_init() should create the key object generation context and initialize it with selections, which will determine what kind of contents the key object to be generated should get. The params, if not \s-1NULL,\s0 should be set on the context in a manner similar to using OSSL_FUNC_keymgmt_set_params().

\fBOSSL_FUNC_keymgmt_gen_set_template() should add template to the context \fIgenctx. The template is assumed to be a key object constructed with the same \s-1KEYMGMT,\s0 and from which content that the implementation chooses can be used as a template for the key object to be generated. Typically, the generation of a \s-1DSA\s0 or \s-1DH\s0 key would get the domain parameters from this template.

\fBOSSL_FUNC_keymgmt_gen_set_params() should set additional parameters from \fIparams in the key object generation context genctx.

\fBOSSL_FUNC_keymgmt_gen_settable_params() should return a constant array of descriptor \s-1OSSL_PARAM\s0\|(3), for parameters that OSSL_FUNC_keymgmt_gen_set_params() can handle.

\fBOSSL_FUNC_keymgmt_gen() should perform the key object generation itself, and return the result. The callback cb should be called at regular intervals with indications on how the key object generation progresses.

\fBOSSL_FUNC_keymgmt_gen_cleanup() should clean up and free the key object generation context genctx

\fBOSSL_FUNC_keymgmt_load() creates a provider side key object based on a \fIreference object with a size of reference_sz bytes, that only the provider knows how to interpret, but that may come from other operations. Outside the provider, this reference is simply an array of bytes.

At least one of OSSL_FUNC_keymgmt_new(), OSSL_FUNC_keymgmt_gen() and \fBOSSL_FUNC_keymgmt_load() are mandatory, as well as OSSL_FUNC_keymgmt_free() and \fBOSSL_FUNC_keymgmt_has(). Additionally, if OSSL_FUNC_keymgmt_gen() is present, \fBOSSL_FUNC_keymgmt_gen_init() and OSSL_FUNC_keymgmt_gen_cleanup() must be present as well.

Subsection "Key Object Information Functions" \fBOSSL_FUNC_keymgmt_get_params() should extract information data associated with the given keydata, see \*(L"Common Information Parameters\*(R".

\fBOSSL_FUNC_keymgmt_gettable_params() should return a constant array of descriptor \s-1OSSL_PARAM\s0\|(3), for parameters that OSSL_FUNC_keymgmt_get_params() can handle.

If OSSL_FUNC_keymgmt_gettable_params() is present, OSSL_FUNC_keymgmt_get_params() must also be present, and vice versa.

\fBOSSL_FUNC_keymgmt_set_params() should update information data associated with the given keydata, see \*(L"Common Information Parameters\*(R".

\fBOSSL_FUNC_keymgmt_settable_params() should return a constant array of descriptor \s-1OSSL_PARAM\s0\|(3), for parameters that OSSL_FUNC_keymgmt_set_params() can handle.

If OSSL_FUNC_keymgmt_settable_params() is present, OSSL_FUNC_keymgmt_set_params() must also be present, and vice versa.

Subsection "Key Object Checking Functions" \fBOSSL_FUNC_keymgmt_query_operation_name() should return the name of the supported algorithm for the operation operation_id. This is similar to provider_query_operation() (see provider-base\|(7)), but only works as an advisory. If this function is not present, or returns \s-1NULL,\s0 the caller is free to assume that there's an algorithm from the same provider, of the same name as the one used to fetch the keymgmt and try to use that.

\fBOSSL_FUNC_keymgmt_has() should check whether the given keydata contains the subsets of data indicated by the selector. A combination of several selector bits must consider all those subsets, not just one. An implementation is, however, free to consider an empty subset of data to still be a valid subset. For algorithms where some selection is not meaningful such as \s-1OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS\s0 for \s-1RSA\s0 keys the function should just return 1 as the selected subset is not really missing in the key.

\fBOSSL_FUNC_keymgmt_validate() should check if the keydata contains valid data subsets indicated by selection. Some combined selections of data subsets may cause validation of the combined data. For example, the combination of \s-1OSSL_KEYMGMT_SELECT_PRIVATE_KEY\s0 and \fB\s-1OSSL_KEYMGMT_SELECT_PUBLIC_KEY\s0 (or \s-1OSSL_KEYMGMT_SELECT_KEYPAIR\s0 for short) is expected to check that the pairwise consistency of \fIkeydata is valid. The checktype parameter controls what type of check is performed on the subset of data. Two types of check are defined: \fB\s-1OSSL_KEYMGMT_VALIDATE_FULL_CHECK\s0 and \s-1OSSL_KEYMGMT_VALIDATE_QUICK_CHECK\s0. The interpretation of how much checking is performed in a full check versus a quick check is key type specific. Some providers may have no distinction between a full check and a quick check. For algorithms where some selection is not meaningful such as \s-1OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS\s0 for \s-1RSA\s0 keys the function should just return 1 as there is nothing to validate for that selection.

\fBOSSL_FUNC_keymgmt_match() should check if the data subset indicated by \fIselection in keydata1 and keydata2 match. It is assumed that the caller has ensured that keydata1 and keydata2 are both owned by the implementation of this function.

Subsection "Key Object Import, Export and Duplication Functions" \fBOSSL_FUNC_keymgmt_import() should import data indicated by selection into \fIkeydata with values taken from the \s-1OSSL_PARAM\s0\|(3) array params.

\fBOSSL_FUNC_keymgmt_export() should extract values indicated by selection from keydata, create an \s-1OSSL_PARAM\s0\|(3) array with them and call \fIparam_cb with that array as well as the given cbarg.

\fBOSSL_FUNC_keymgmt_import_types() should return a constant array of descriptor \s-1OSSL_PARAM\s0\|(3) for data indicated by selection, for parameters that \fBOSSL_FUNC_keymgmt_import() can handle.

\fBOSSL_FUNC_keymgmt_export_types() should return a constant array of descriptor \s-1OSSL_PARAM\s0\|(3) for data indicated by selection, that the \fBOSSL_FUNC_keymgmt_export() callback can expect to receive.

\fBOSSL_FUNC_keymgmt_dup() should duplicate data subsets indicated by \fIselection or the whole key data keydata_from and create a new provider side key object with the data.

Subsection "Common Information Parameters" See \s-1OSSL_PARAM\s0\|(3) for further details on the parameters structure.

Common information parameters currently recognised by all built-in keymgmt algorithms are as follows: Item "bits (OSSL_PKEY_PARAM_BITS) <integer>" The value should be the cryptographic length of the cryptosystem to which the key belongs, in bits. The definition of cryptographic length is specific to the key cryptosystem. Item "max-size (OSSL_PKEY_PARAM_MAX_SIZE) <integer>" The value should be the maximum size that a caller should allocate to safely store a signature (called sig in provider-signature\|(7)), the result of asymmmetric encryption / decryption (out in \fBprovider-asym_cipher\|(7), a derived secret (secret in \fBprovider-keyexch\|(7), and similar data). .Sp Because an \s-1EVP_KEYMGMT\s0 method is always tightly bound to another method (signature, asymmetric cipher, key exchange, ...) and must be of the same provider, this number only needs to be synchronised with the dimensions handled in the rest of the same provider. Item "security-bits (OSSL_PKEY_PARAM_SECURITY_BITS) <integer>" The value should be the number of security bits of the given key. Bits of security is defined in \s-1SP800-57.\s0 Item "mandatory-digest (OSSL_PKEY_PARAM_MANDATORY_DIGEST) <UTF8 string>" If there is a mandatory digest for performing a signature operation with keys from this keymgmt, this parameter should get its name as value. .Sp When EVP_PKEY_get_default_digest_name() queries this parameter and it's filled in by the implementation, its return value will be 2. .Sp If the keymgmt implementation fills in the value "" or "UNDEF", \fBEVP_PKEY_get_default_digest_name\|(3) will place the string "UNDEF" into its argument mdname. This signifies that no digest should be specified with the corresponding signature operation. Item "default-digest (OSSL_PKEY_PARAM_DEFAULT_DIGEST) <UTF8 string>" If there is a default digest for performing a signature operation with keys from this keymgmt, this parameter should get its name as value. .Sp When EVP_PKEY_get_default_digest_name\|(3) queries this parameter and it's filled in by the implementation, its return value will be 1. Note that if \fB\s-1OSSL_PKEY_PARAM_MANDATORY_DIGEST\s0 is responded to as well, \fBEVP_PKEY_get_default_digest_name\|(3) ignores the response to this parameter. .Sp If the keymgmt implementation fills in the value "" or "UNDEF", \fBEVP_PKEY_get_default_digest_name\|(3) will place the string "UNDEF" into its argument mdname. This signifies that no digest has to be specified with the corresponding signature operation, but may be specified as an option.

Header "RETURN VALUES" \fBOSSL_FUNC_keymgmt_new() and OSSL_FUNC_keymgmt_dup() should return a valid reference to the newly created provider side key object, or \s-1NULL\s0 on failure.

\fBOSSL_FUNC_keymgmt_import(), OSSL_FUNC_keymgmt_export(), OSSL_FUNC_keymgmt_get_params() and \fBOSSL_FUNC_keymgmt_set_params() should return 1 for success or 0 on error.

\fBOSSL_FUNC_keymgmt_validate() should return 1 on successful validation, or 0 on failure.

\fBOSSL_FUNC_keymgmt_has() should return 1 if all the selected data subsets are contained in the given keydata or 0 otherwise.

\fBOSSL_FUNC_keymgmt_query_operation_name() should return a pointer to a string matching the requested operation, or \s-1NULL\s0 if the same name used to fetch the keymgmt applies.

\fBOSSL_FUNC_keymgmt_gettable_params() and OSSL_FUNC_keymgmt_settable_params() \fBOSSL_FUNC_keymgmt_import_types(), OSSL_FUNC_keymgmt_export_types() should always return a constant \s-1OSSL_PARAM\s0\|(3) array.

Header "SEE ALSO" \fBprovider\|(7), \s-1EVP_PKEY-X25519\s0\|(7), \s-1EVP_PKEY-X448\s0\|(7), \s-1EVP_PKEY-ED25519\s0\|(7), \s-1EVP_PKEY-ED448\s0\|(7), \s-1EVP_PKEY-EC\s0\|(7), \s-1EVP_PKEY-RSA\s0\|(7), \s-1EVP_PKEY-DSA\s0\|(7), \s-1EVP_PKEY-DH\s0\|(7) Header "HISTORY" The \s-1KEYMGMT\s0 interface was introduced in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.