X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=doc%2Fman7%2Fprovider-keymgmt.pod;h=aa2be41acc33d8d40e70599eacf9f9ce26b427cd;hb=363b1e5daea4a01889e6ff27148018be63d33b9b;hp=279256d5672fbd178418779feda1a08bcf815b12;hpb=ce82b892e8b86d68d02096554b4e07af7f095368;p=oweals%2Fopenssl.git

diff --git a/doc/man7/provider-keymgmt.pod b/doc/man7/provider-keymgmt.pod
index 279256d567..aa2be41acc 100644
--- a/doc/man7/provider-keymgmt.pod
+++ b/doc/man7/provider-keymgmt.pod
@@ -6,7 +6,7 @@ provider-keymgmt - The KEYMGMT library E<lt>-E<gt> provider functions
 
 =head1 SYNOPSIS
 
- #include <openssl/core_numbers.h>
+ #include <openssl/core_dispatch.h>
 
  /*
   * None of these are actual functions, but are displayed like this for
@@ -15,30 +15,42 @@ provider-keymgmt - The KEYMGMT library E<lt>-E<gt> provider functions
   */
 
  /* Key object (keydata) creation and destruction */
- void *OP_keymgmt_new(void *provctx);
- void OP_keymgmt_free(void *keydata);
+ void *OSSL_FUNC_keymgmt_new(void *provctx);
+ void OSSL_FUNC_keymgmt_free(void *keydata);
+
+ void *OSSL_FUNC_keymgmt_gen_init(void *provctx, int selection);
+ 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 *provctx);
+ void *OSSL_FUNC_keymgmt_gen(void *genctx, OSSL_CALLBACK *cb, void *cbarg);
+ void OSSL_FUNC_keymgmt_gen_cleanup(void *genctx);
 
  /* Key object information */
- int OP_keymgmt_get_params(void *keydata, OSSL_PARAM params[]);
- const OSSL_PARAM *OP_keymgmt_gettable_params(void);
- int OP_keymgmt_set_params(void *keydata, const OSSL_PARAM params[]);
- const OSSL_PARAM *OP_keymgmt_settable_params(void);
+ int OSSL_FUNC_keymgmt_get_params(void *keydata, OSSL_PARAM params[]);
+ const OSSL_PARAM *OSSL_FUNC_keymgmt_gettable_params(void);
+ int OSSL_FUNC_keymgmt_set_params(void *keydata, const OSSL_PARAM params[]);
+ const OSSL_PARAM *OSSL_FUNC_keymgmt_settable_params(void);
 
  /* Key object content checks */
- int OP_keymgmt_has(void *keydata, int selection);
+ int OSSL_FUNC_keymgmt_has(void *keydata, int selection);
+ int OSSL_FUNC_keymgmt_match(const void *keydata1, const void *keydata2,
+                             int selection);
 
  /* Discovery of supported operations */
- const char *OP_keymgmt_query_operation_name(int operation_id);
+ const char *OSSL_FUNC_keymgmt_query_operation_name(int operation_id);
 
  /* Key object import and export functions */
- int OP_keymgmt_import(int selection, void *keydata, const OSSL_PARAM params[]);
- const OSSL_PARAM *OP_keymgmt_import_types(int selection);
- int OP_keymgmt_export(int selection, void *keydata,
-                       OSSL_CALLBACK *param_cb, void *cbarg);
- const OSSL_PARAM *OP_keymgmt_export_types(int selection);
+ int OSSL_FUNC_keymgmt_import(int selection, void *keydata, const OSSL_PARAM params[]);
+ const OSSL_PARAM *OSSL_FUNC_keymgmt_import_types(int selection);
+ int OSSL_FUNC_keymgmt_export(int selection, void *keydata,
+                              OSSL_CALLBACK *param_cb, void *cbarg);
+ const OSSL_PARAM *OSSL_FUNC_keymgmt_export_types(int selection);
+
+ /* Key object copy */
+ int OSSL_FUNC_keymgmt_copy(void *keydata_to, const void *keydata_from, int selection);
 
  /* Key object validation */
- int OP_keymgmt_validate(void *keydata, int selection);
+ int OSSL_FUNC_keymgmt_validate(void *keydata, int selection);
 
 =head1 DESCRIPTION
 
@@ -62,34 +74,43 @@ provider_query_operation() function
 All these "functions" have a corresponding function type definition
 named B<OSSL_{name}_fn>, and a helper function to retrieve the
 function pointer from a B<OSSL_DISPATCH> element named
-B<OSSL_get_{name}>.
-For example, the "function" OP_keymgmt_new() has these:
+B<OSSL_FUNC_{name}>.
+For example, the "function" OSSL_FUNC_keymgmt_new() has these:
 
- typedef void *(OSSL_OP_keymgmt_new_fn)(void *provctx);
- static ossl_inline OSSL_OP_keymgmt_new_fn
-     OSSL_get_OP_keymgmt_new(const OSSL_DISPATCH *opf);
+ 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);
 
 B<OSSL_DISPATCH> arrays are indexed by numbers that are provided as
-macros in L<openssl-core_numbers.h(7)>, as follows:
+macros in L<openssl-core_dispatch.h(7)>, as follows:
 
- OP_keymgmt_new                  OSSL_FUNC_KEYMGMT_NEW
- OP_keymgmt_free                 OSSL_FUNC_KEYMGMT_FREE
+ OSSL_FUNC_keymgmt_new                  OSSL_FUNC_KEYMGMT_NEW
+ OSSL_FUNC_keymgmt_free                 OSSL_FUNC_KEYMGMT_FREE
 
- OP_keymgmt_get_params           OSSL_FUNC_KEYMGMT_GET_PARAMS
- OP_keymgmt_gettable_params      OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS
- OP_keymgmt_set_params           OSSL_FUNC_KEYMGMT_SET_PARAMS
- OP_keymgmt_settable_params      OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS
+ 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
 
- OP_keymgmt_query_operation_name OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME
+ 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
 
- OP_keymgmt_has                  OSSL_FUNC_KEYMGMT_HAS
- OP_keymgmt_validate             OSSL_FUNC_KEYMGMT_VALIDATE
+ OSSL_FUNC_keymgmt_query_operation_name OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME
 
- OP_keymgmt_import               OSSL_FUNC_KEYMGMT_IMPORT
- OP_keymgmt_import_types         OSSL_FUNC_KEYMGMT_IMPORT_TYPES
- OP_keymgmt_export               OSSL_FUNC_KEYMGMT_EXPORT
- OP_keymgmt_export_types         OSSL_FUNC_KEYMGMT_EXPORT_TYPES
+ 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_copy                 OSSL_FUNC_KEYMGMT_COPY
 
 =head2 Key Objects
 
@@ -180,44 +201,73 @@ the other half.
 
 =head2 Constructing and Destructing Functions
 
-OP_keymgmt_new() should create a provider side key object.  The
+OSSL_FUNC_keymgmt_new() should create a provider side key object.  The
 provider context I<provctx> is passed and may be incorporated in the
 key object, but that is not mandatory.
 
-OP_keymgmt_free() should free the passed I<keydata>.
+OSSL_FUNC_keymgmt_free() should free the passed I<keydata>.
+
+OSSL_FUNC_keymgmt_gen_init(), OSSL_FUNC_keymgmt_gen_set_template(),
+OSSL_FUNC_keymgmt_gen_set_params(), OSSL_FUNC_keymgmt_gen_settable_params(),
+OSSL_FUNC_keymgmt_gen() and OSSL_FUNC_keymgmt_gen_cleanup() work together as a more
+elaborate context based key object constructor.
+
+OSSL_FUNC_keymgmt_gen_init() should create the key object generation context
+and initialize it with I<selections>, which will determine what kind
+of contents the key object to be generated should get.
+
+OSSL_FUNC_keymgmt_gen_set_template() should add I<template> to the context
+I<genctx>.  The I<template> is assumed to be a key object constructed
+with the same KEYMGMT, 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 DSA or DH key would get the domain
+parameters from this I<template>.
+
+OSSL_FUNC_keymgmt_gen_set_params() should set additional parameters from
+I<params> in the key object generation context I<genctx>.
+
+OSSL_FUNC_keymgmt_gen_settable_params() should return a constant array of
+descriptor B<OSSL_PARAM>, for parameters that OSSL_FUNC_keymgmt_gen_set_params() 
+can handle.
+
+OSSL_FUNC_keymgmt_gen() should perform the key object generation itself, and
+return the result.  The callback I<cb> should be called at regular
+intervals with indications on how the key object generation
+progresses.
 
-The constructor and destructor are mandatory, a KEYMGMT implementation
-without them will not be accepted.
+OSSL_FUNC_keymgmt_gen_cleanup() should clean up and free the key object
+generation context I<genctx>
 
-=for comment when new constructors appear, it's sufficient if only one
-of them is present.  The remark above will have to change to reflect
-that.
+At least one of OSSL_FUNC_keymgmt_new() and OSSL_FUNC_keymgmt_gen() are mandatory,
+as well as OSSL_FUNC_keymgmt_free().  Additionally, if OSSL_FUNC_keymgmt_gen() is
+present, OSSL_FUNC_keymgmt_gen_init() and OSSL_FUNC_keymgmt_gen_cleanup() must be
+present as well.
 
 =head2 Key Object Information Functions
 
-OP_keymgmt_get_params() should extract information data associated
-with the given I<keydata>, see L</Information Parameters>.
+OSSL_FUNC_keymgmt_get_params() should extract information data associated
+with the given I<keydata>, see L</Common Information Parameters>.
 
-OP_keymgmt_gettable_params() should return a constant array of
-descriptor B<OSSL_PARAM>, for parameters that OP_keymgmt_get_params()
+OSSL_FUNC_keymgmt_gettable_params() should return a constant array of
+descriptor B<OSSL_PARAM>, for parameters that OSSL_FUNC_keymgmt_get_params()
 can handle.
 
-If OP_keymgmt_gettable_params() is present, OP_keymgmt_get_params()
+If OSSL_FUNC_keymgmt_gettable_params() is present, OSSL_FUNC_keymgmt_get_params()
 must also be present, and vice versa.
 
-OP_keymgmt_set_params() should update information data associated
-with the given I<keydata>, see L</Information Parameters>.
+OSSL_FUNC_keymgmt_set_params() should update information data associated
+with the given I<keydata>, see L</Common Information Parameters>.
 
-OP_keymgmt_settable_params() should return a constant array of
-descriptor B<OSSL_PARAM>, for parameters that OP_keymgmt_set_params()
+OSSL_FUNC_keymgmt_settable_params() should return a constant array of
+descriptor B<OSSL_PARAM>, for parameters that OSSL_FUNC_keymgmt_set_params()
 can handle.
 
-If OP_keymgmt_settable_params() is present, OP_keymgmt_set_params()
+If OSSL_FUNC_keymgmt_settable_params() is present, OSSL_FUNC_keymgmt_set_params()
 must also be present, and vice versa.
 
 =head2 Key Object Checking Functions
 
-OP_keymgmt_query_operation_name() should return the name of the
+OSSL_FUNC_keymgmt_query_operation_name() should return the name of the
 supported algorithm for the operation I<operation_id>.  This is
 similar to provider_query_operation() (see L<provider-base(7)>),
 but only works as an advisory.  If this function is not present, or
@@ -225,13 +275,13 @@ returns NULL, 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.
 
-OP_keymgmt_has() should check whether the given I<keydata> contains the subsets
+OSSL_FUNC_keymgmt_has() should check whether the given I<keydata> contains the subsets
 of data indicated by the I<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.
 
-OP_keymgmt_validate() should check if the I<keydata> contains valid
+OSSL_FUNC_keymgmt_validate() should check if the I<keydata> contains valid
 data subsets indicated by I<selection>.  Some combined selections of
 data subsets may cause validation of the combined data.
 For example, the combination of B<OSSL_KEYMGMT_SELECT_PRIVATE_KEY> and
@@ -239,31 +289,39 @@ B<OSSL_KEYMGMT_SELECT_PUBLIC_KEY> (or B<OSSL_KEYMGMT_SELECT_KEYPAIR>
 for short) is expected to check that the pairwise consistency of
 I<keydata> is valid.
 
-=head2 Key Object Import and Export Functions
+OSSL_FUNC_keymgmt_match() should check if the data subset indicated by
+I<selection> in I<keydata1> and I<keydata2> match.  It is assumed that
+the caller has ensured that I<keydata1> and I<keydata2> are both owned
+by the implementation of this function.
 
-OP_keymgmt_import() should import data indicated by I<selection> into
+=head2 Key Object Import, Export and Copy Functions
+
+OSSL_FUNC_keymgmt_import() should import data indicated by I<selection> into
 I<keydata> with values taken from the B<OSSL_PARAM> array I<params>.
 
-OP_keymgmt_export() should extract values indicated by I<selection>
+OSSL_FUNC_keymgmt_export() should extract values indicated by I<selection>
 from I<keydata>, create an B<OSSL_PARAM> array with them and call
 I<param_cb> with that array as well as the given I<cbarg>.
 
-OP_keymgmt_import_types() should return a constant array of descriptor
+OSSL_FUNC_keymgmt_import_types() should return a constant array of descriptor
 B<OSSL_PARAM> for data indicated by I<selection>, for parameters that
-OP_keymgmt_import() can handle.
+OSSL_FUNC_keymgmt_import() can handle.
 
-OP_keymgmt_export_types() should return a constant array of descriptor
+OSSL_FUNC_keymgmt_export_types() should return a constant array of descriptor
 B<OSSL_PARAM> for data indicated by I<selection>, that the
-OP_keymgmt_export() callback can expect to receive.
+OSSL_FUNC_keymgmt_export() callback can expect to receive.
+
+OSSL_FUNC_keymgmt_copy() should copy data subsets indicated by I<selection>
+from I<keydata_from> to I<keydata_to>.  It is assumed that the caller
+has ensured that I<keydata_to> and I<keydata_from> are both owned by
+the implementation of this function.
 
-=head2 Information Parameters
+=head2 Common Information Parameters
 
 See L<OSSL_PARAM(3)> for further details on the parameters structure.
 
-Parameters currently recognised by built-in keymgmt algorithms
-are as follows.
-Not all parameters are relevant to, or are understood by all keymgmt
-algorithms:
+Common information parameters currently recognised by all built-in
+keymgmt algorithms are as follows:
 
 =over 4
 
@@ -291,49 +349,37 @@ dimensions handled in the rest of the same provider.
 The value should be the number of security bits of the given key.
 Bits of security is defined in SP800-57.
 
-=item "use-cofactor-flag" (B<OSSL_PKEY_PARAM_USE_COFACTOR_FLAG>,
-B<OSSL_PKEY_PARAM_USE_COFACTOR_ECDH>) <integer>
-
-The value should be either 1 or 0, to respectively enable or disable
-use of the cofactor in operations using this key.
-
-In the context of a key that can be used to perform an Elliptic Curve
-Diffie-Hellman key exchange, this parameter can be used to mark a requirement
-for using the Cofactor Diffie-Hellman (CDH) variant of the key exchange
-algorithm.
-
-See also L<provider-keyexch(7)> for the related
-B<OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE> parameter that can be set on a
-per-operation basis.
-
 =back
 
 =head1 RETURN VALUES
 
-OP_keymgmt_new() should return a valid reference to the newly created provider
+OSSL_FUNC_keymgmt_new() should return a valid reference to the newly created provider
 side key object, or NULL on failure.
 
-OP_keymgmt_import(), OP_keymgmt_export(), OP_keymgmt_get_params() and
-OP_keymgmt_set_params() should return 1 for success or 0 on error.
+OSSL_FUNC_keymgmt_import(), OSSL_FUNC_keymgmt_export(), OSSL_FUNC_keymgmt_get_params() and
+OSSL_FUNC_keymgmt_set_params() should return 1 for success or 0 on error.
 
-OP_keymgmt_validate() should return 1 on successful validation, or 0 on
+OSSL_FUNC_keymgmt_validate() should return 1 on successful validation, or 0 on
 failure.
 
-OP_keymgmt_has() should return 1 if all the selected data subsets are contained
+OSSL_FUNC_keymgmt_has() should return 1 if all the selected data subsets are contained
 in the given I<keydata> or 0 otherwise.
 
-OP_keymgmt_query_operation_name() should return a pointer to a string matching
+OSSL_FUNC_keymgmt_query_operation_name() should return a pointer to a string matching
 the requested operation, or NULL if the same name used to fetch the keymgmt
 applies.
 
-OP_keymgmt_gettable_params() and OP_keymgmt_settable_params()
-OP_keymgmt_import_types(), OP_keymgmt_export_types()
+OSSL_FUNC_keymgmt_gettable_params() and OSSL_FUNC_keymgmt_settable_params()
+OSSL_FUNC_keymgmt_import_types(), OSSL_FUNC_keymgmt_export_types()
 should
 always return a constant B<OSSL_PARAM> array.
 
 =head1 SEE ALSO
 
-L<provider(7)>
+L<provider(7)>,
+L<EVP_PKEY-X25519(7)>, L<EVP_PKEY-X448(7)>, L<EVP_PKEY-ED25519(7)>,
+L<EVP_PKEY-ED448(7)>, L<EVP_PKEY-EC(7)>, L<EVP_PKEY-RSA(7)>,
+L<EVP_PKEY-DSA(7)>, L<EVP_PKEY-DH(7)>
 
 =head1 HISTORY