From: Tomas Mraz <tomas@openssl.org>
Date: Thu, 7 Apr 2022 14:48:06 +0000 (+0200)
Subject: Add missing documentation of OSSL_FUNC_store_export_object()
X-Git-Tag: openssl-3.2.0-alpha1~2462
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=13941d438458068d4150c5899f6bbc0add393cc4;p=thirdparty%2Fopenssl.git

Add missing documentation of OSSL_FUNC_store_export_object()

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/17554)
---

diff --git a/doc/man7/provider-storemgmt.pod b/doc/man7/provider-storemgmt.pod
index d38e8e53d70..611f24930c0 100644
--- a/doc/man7/provider-storemgmt.pod
+++ b/doc/man7/provider-storemgmt.pod
@@ -105,6 +105,15 @@ further loading.
 
 OSSL_FUNC_store_close() frees the provider side context I<ctx>.
 
+When a provider-native object is created by a store manager it would be unsuitable
+for direct use with a foreign provider. The export function allows for
+exporting the object to that foreign provider if the foreign provider
+supports the type of the object and provides an import function.
+
+OSSL_FUNC_store_export_object() should export the object of size I<objref_sz>
+referenced by I<objref> as an B<OSSL_PARAM> array and pass that to the
+I<export_cb> as well as the given I<export_cbarg>.
+
 =head2 Load Parameters
 
 =over 4