aboutsummaryrefslogtreecommitdiffstats
path: root/secure/lib/libcrypto/man/man3/OSSL_STORE_open.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/man3/OSSL_STORE_open.3')
-rw-r--r--secure/lib/libcrypto/man/man3/OSSL_STORE_open.337
1 files changed, 21 insertions, 16 deletions
diff --git a/secure/lib/libcrypto/man/man3/OSSL_STORE_open.3 b/secure/lib/libcrypto/man/man3/OSSL_STORE_open.3
index 3f5e885601ad..1e5768981fd7 100644
--- a/secure/lib/libcrypto/man/man3/OSSL_STORE_open.3
+++ b/secure/lib/libcrypto/man/man3/OSSL_STORE_open.3
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -133,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "OSSL_STORE_OPEN 3"
-.TH OSSL_STORE_OPEN 3 "2020-04-21" "1.1.1g" "OpenSSL"
+.TH OSSL_STORE_OPEN 3 "2020-09-22" "1.1.1h" "OpenSSL"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -179,21 +179,22 @@ information for \fBOSSL_STORE_open()\fR, \fBOSSL_STORE_load()\fR, \fBOSSL_STORE_
\&\fBOSSL_STORE_close()\fR to work together.
.SS "Functions"
.IX Subsection "Functions"
-\&\fBOSSL_STORE_open()\fR takes a uri or path \fBuri\fR, password \s-1UI\s0 method
-\&\fBui_method\fR with associated data \fBui_data\fR, and post processing
-callback \fBpost_process\fR with associated data \fBpost_process_data\fR,
+\&\fBOSSL_STORE_open()\fR takes a uri or path \fIuri\fR, password \s-1UI\s0 method
+\&\fIui_method\fR with associated data \fIui_data\fR, and post processing
+callback \fIpost_process\fR with associated data \fIpost_process_data\fR,
opens a channel to the data located at that \s-1URI\s0 and returns a
\&\fB\s-1OSSL_STORE_CTX\s0\fR with all necessary internal information.
-The given \fBui_method\fR and \fBui_data_data\fR will be reused by all
-functions that use \fB\s-1OSSL_STORE_CTX\s0\fR when interaction is needed.
-The given \fBpost_process\fR and \fBpost_process_data\fR will be reused by
+The given \fIui_method\fR and \fIui_data\fR will be reused by all
+functions that use \fB\s-1OSSL_STORE_CTX\s0\fR when interaction is needed,
+for instance to provide a password.
+The given \fIpost_process\fR and \fIpost_process_data\fR will be reused by
\&\fBOSSL_STORE_load()\fR to manipulate or drop the value to be returned.
-The \fBpost_process\fR function drops values by returning \fB\s-1NULL\s0\fR, which
+The \fIpost_process\fR function drops values by returning \s-1NULL,\s0 which
will cause \fBOSSL_STORE_load()\fR to start its process over with loading
-the next object, until \fBpost_process\fR returns something other than
-\&\fB\s-1NULL\s0\fR, or the end of data is reached as indicated by \fBOSSL_STORE_eof()\fR.
+the next object, until \fIpost_process\fR returns something other than
+\&\s-1NULL,\s0 or the end of data is reached as indicated by \fBOSSL_STORE_eof()\fR.
.PP
-\&\fBOSSL_STORE_ctrl()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR, and command number \fBcmd\fR and
+\&\fBOSSL_STORE_ctrl()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR, and command number \fIcmd\fR and
more arguments not specified here.
The available loader specific command numbers and arguments they each
take depends on the loader that's used and is documented together with
@@ -222,6 +223,7 @@ Note that it may still be meaningful to try and load more objects, unless
\&\fBOSSL_STORE_close()\fR takes a \fB\s-1OSSL_STORE_CTX\s0\fR, closes the channel that was opened
by \fBOSSL_STORE_open()\fR and frees all other information that was stored in the
\&\fB\s-1OSSL_STORE_CTX\s0\fR, as well as the \fB\s-1OSSL_STORE_CTX\s0\fR itself.
+If \fIctx\fR is \s-1NULL\s0 it does nothing.
.SH "SUPPORTED SCHEMES"
.IX Header "SUPPORTED SCHEMES"
The basic supported scheme is \fBfile:\fR.
@@ -248,12 +250,12 @@ See \fBpassphrase\-encoding\fR\|(7) for further information.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fBOSSL_STORE_open()\fR returns a pointer to a \fB\s-1OSSL_STORE_CTX\s0\fR on success, or
-\&\fB\s-1NULL\s0\fR on failure.
+\&\s-1NULL\s0 on failure.
.PP
\&\fBOSSL_STORE_load()\fR returns a pointer to a \fB\s-1OSSL_STORE_INFO\s0\fR on success, or
-\&\fB\s-1NULL\s0\fR on error or when end of data is reached.
+\&\s-1NULL\s0 on error or when end of data is reached.
Use \fBOSSL_STORE_error()\fR and \fBOSSL_STORE_eof()\fR to determine the meaning of a
-returned \fB\s-1NULL\s0\fR.
+returned \s-1NULL.\s0
.PP
\&\fBOSSL_STORE_eof()\fR returns 1 if the end of data has been reached, otherwise
0.
@@ -271,9 +273,12 @@ otherwise 0.
\&\s-1\fBOSSL_STORE_CTX\s0()\fR, \fBOSSL_STORE_post_process_info_fn()\fR, \fBOSSL_STORE_open()\fR,
\&\fBOSSL_STORE_ctrl()\fR, \fBOSSL_STORE_load()\fR, \fBOSSL_STORE_eof()\fR and \fBOSSL_STORE_close()\fR
were added in OpenSSL 1.1.1.
+.PP
+Handling of \s-1NULL\s0 \fIctx\fR argument for \fBOSSL_STORE_close()\fR
+was introduced in OpenSSL 1.1.1h.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
-Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2016\-2020 The OpenSSL Project Authors. All Rights Reserved.
.PP
Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy