Skip to content

Commit

Permalink
Add provider documentation for the new open_ex
Browse files Browse the repository at this point in the history
Signed-off-by: Simo Sorce <simo@redhat.com>

Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from openssl#20131)
  • Loading branch information
simo5 authored and beldmit committed Sep 19, 2023
1 parent 6412900 commit e40d538
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions doc/man7/provider-storemgmt.pod
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ provider-storemgmt - The OSSL_STORE library E<lt>-E<gt> provider functions
int OSSL_FUNC_store_export_object
(void *loaderctx, const void *objref, size_t objref_sz,
OSSL_CALLBACK *export_cb, void *export_cbarg);
void *OSSL_FUNC_store_open_ex(void *provctx, const char *uri,
const OSSL_PARAM params[],
OSSL_PASSPHRASE_CALLBACK *pw_cb,
void *pw_cbarg);

int OSSL_FUNC_store_delete(void *provctx, const char *uri,
const OSSL_PARAM params[],
Expand Down Expand Up @@ -75,6 +79,7 @@ in L<openssl-core_dispatch.h(7)>, as follows:
OSSL_FUNC_store_close OSSL_FUNC_STORE_CLOSE
OSSL_FUNC_store_export_object OSSL_FUNC_STORE_EXPORT_OBJECT
OSSL_FUNC_store_delete OSSL_FUNC_STORE_DELETE
OSSL_FUNC_store_open_ex OSSL_FUNC_STORE_OPEN_EX

=head2 Functions

Expand Down Expand Up @@ -124,6 +129,13 @@ implementation is entirely responsible for the interpretation of the URI. In
case a passphrase needs to be prompted to remove an object, I<pw_cb> should be
called.

OSSL_FUNC_store_open_ex() is an extended variant of OSSL_FUNC_store_open(). If
the provider does not implement this function the code internally falls back to
use the original OSSL_FUNC_store_open().
This variant additionally accepts an L<OSSL_PARAM(3)> object and a I<pw_cb>
callback that can be used to request a passphrase in cases where the whole
store needs to be unlocked before performing any load operation.

=head2 Load Parameters

=over 4
Expand Down

0 comments on commit e40d538

Please sign in to comment.