summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/lib/libcrypto/man/BIO_get_data.3115
-rw-r--r--src/lib/libcrypto/man/Makefile3
2 files changed, 117 insertions, 1 deletions
diff --git a/src/lib/libcrypto/man/BIO_get_data.3 b/src/lib/libcrypto/man/BIO_get_data.3
new file mode 100644
index 0000000000..2a7543960c
--- /dev/null
+++ b/src/lib/libcrypto/man/BIO_get_data.3
@@ -0,0 +1,115 @@
1.\" $OpenBSD: BIO_get_data.3,v 1.1 2018/02/19 14:08:52 schwarze Exp $
2.\" selective merge up to: OpenSSL e90fc053 Jul 15 09:39:45 2017 -0400
3.\"
4.\" This file was written by Matt Caswell <matt@openssl.org>
5.\" Copyright (c) 2016 The OpenSSL Project. All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in
16.\" the documentation and/or other materials provided with the
17.\" distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\" software must display the following acknowledgment:
21.\" "This product includes software developed by the OpenSSL Project
22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\" endorse or promote products derived from this software without
26.\" prior written permission. For written permission, please contact
27.\" openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\" nor may "OpenSSL" appear in their names without prior written
31.\" permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\" acknowledgment:
35.\" "This product includes software developed by the OpenSSL Project
36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: February 19 2018 $
52.Dt BIO_GET_DATA 3
53.Os
54.Sh NAME
55.Nm BIO_set_data ,
56.Nm BIO_get_data ,
57.Nm BIO_set_init
58.Nd manage BIO state information
59.Sh SYNOPSIS
60.In openssl/bio.h
61.Ft void
62.Fo BIO_set_data
63.Fa "BIO *a"
64.Fa "void *ptr"
65.Fc
66.Ft void *
67.Fo BIO_get_data
68.Fa "BIO *a"
69.Fc
70.Ft void
71.Fo BIO_set_init
72.Fa "BIO *a"
73.Fa "int init"
74.Fc
75.Sh DESCRIPTION
76These functions are mainly useful when implementing a custom BIO.
77.Pp
78The
79.Fn BIO_set_data
80function associates the custom data pointed to by
81.Fa ptr
82with the
83.Fa "BIO a" .
84This data can subsequently be retrieved via a call to
85.Fn BIO_get_data .
86This can be used by custom BIOs for storing implementation specific
87information.
88.Pp
89The
90.Fn BIO_set_init
91function sets the
92.Fa init
93flag in
94.Fa a
95to the specified value.
96A non-zero value indicates that initialisation is complete,
97whilst zero indicates that it is not.
98Often initialisation will complete
99during initial construction of the BIO.
100For some BIOs however, initialisation may not be complete until
101additional steps have been taken, for example through calling custom
102ctrls.
103.Sh RETURN VALUES
104.Fn BIO_get_data
105returns a pointer to the implementation specific custom data associated
106with
107.Fa a ,
108or
109.Dv NULL
110if none is set.
111.Sh SEE ALSO
112.Xr BIO_meth_new 3 ,
113.Xr BIO_new 3
114.Sh HISTORY
115These functions first appeared in OpenSSL 1.1.0.
diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile
index 8d15d6121c..d880928ea5 100644
--- a/src/lib/libcrypto/man/Makefile
+++ b/src/lib/libcrypto/man/Makefile
@@ -1,4 +1,4 @@
1# $OpenBSD: Makefile,v 1.132 2018/02/19 08:20:26 schwarze Exp $ 1# $OpenBSD: Makefile,v 1.133 2018/02/19 14:08:52 schwarze Exp $
2 2
3.include <bsd.own.mk> 3.include <bsd.own.mk>
4 4
@@ -25,6 +25,7 @@ MAN= \
25 BIO_f_md.3 \ 25 BIO_f_md.3 \
26 BIO_f_null.3 \ 26 BIO_f_null.3 \
27 BIO_find_type.3 \ 27 BIO_find_type.3 \
28 BIO_get_data.3 \
28 BIO_get_ex_new_index.3 \ 29 BIO_get_ex_new_index.3 \
29 BIO_meth_new.3 \ 30 BIO_meth_new.3 \
30 BIO_new.3 \ 31 BIO_new.3 \