]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
DOCS: Fix KEM init function documentation
authorolszomal <Malgorzata.Olszowka@stunnel.org>
Wed, 22 Jul 2026 10:34:07 +0000 (12:34 +0200)
committerNorbert Pocs <norbertp@openssl.org>
Mon, 27 Jul 2026 07:56:55 +0000 (09:56 +0200)
Document the missing params argument for OSSL_FUNC_kem_decapsulate_init(),
remove stale name references, and fix the malformed provider-keymgmt(7) link.

Complements: 78c44b05945b Add HPKE DHKEM provider support for EC, X25519 and X448.
Signed-off-by: olszomal <Malgorzata.Olszowka@stunnel.org>
Reviewed-by: Jakub Zelenka <jakub.zelenka@openssl.foundation>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
MergeDate: Mon Jul 27 07:57:01 2026
(Merged from https://github.com/openssl/openssl/pull/32045)

doc/man7/provider-kem.pod

index 85b8f1a6b80aa222f1d6f23d6bcfc560336752aa..943f2b69dc319283e17737507fb676e3edcd9fbb 100644 (file)
@@ -32,7 +32,8 @@ provider-kem - The kem library E<lt>-E<gt> provider functions
                                unsigned char *secret, size_t *secretlen);
 
  /* Decapsulation */
- int OSSL_FUNC_kem_decapsulate_init(void *ctx, void *provkey);
+ int OSSL_FUNC_kem_decapsulate_init(void *ctx, void *provkey,
+                                    const OSSL_PARAM params[]);
  int OSSL_FUNC_kem_auth_decapsulate_init(void *ctx, void *provkey,
                                          void *provauthkey,
                                          const OSSL_PARAM params[]);
@@ -129,13 +130,13 @@ context in the I<ctx> parameter and return the duplicate copy.
 
 OSSL_FUNC_kem_encapsulate_init() initialises a context for an asymmetric
 encapsulation given a provider side asymmetric kem context in the I<ctx>
-parameter, a pointer to a provider key object in the I<provkey> parameter and
-the I<name> of the algorithm.
+parameter, a pointer to a provider key object in the I<provkey> parameter.
+
 The I<params>, if not NULL, should be set on the context in a manner similar to
 using OSSL_FUNC_kem_set_ctx_params().
 The key object should have been previously generated, loaded or imported into
 the provider using the key management (OSSL_OP_KEYMGMT) operation (see
-provider-keymgmt(7)>.
+L<provider-keymgmt(7)>.
 
 OSSL_FUNC_kem_auth_encapsulate_init() is similar to
 OSSL_FUNC_kem_encapsulate_init(), but also passes an additional authentication
@@ -159,11 +160,13 @@ written to I<*secretlen>.
 
 OSSL_FUNC_kem_decapsulate_init() initialises a context for an asymmetric
 decapsulation given a provider side asymmetric kem context in the I<ctx>
-parameter, a pointer to a provider key object in the I<provkey> parameter, and
-a I<name> of the algorithm.
+parameter, a pointer to a provider key object in the I<provkey> parameter.
+
+The I<params>, if not NULL, should be set on the context in a manner similar to
+using OSSL_FUNC_kem_set_ctx_params().
 The key object should have been previously generated, loaded or imported into
 the provider using the key management (OSSL_OP_KEYMGMT) operation (see
-provider-keymgmt(7)>.
+L<provider-keymgmt(7)>.
 
 OSSL_FUNC_kem_auth_decapsulate_init() is similar to
 OSSL_FUNC_kem_decapsulate_init(), but also passes an additional authentication