diff options
Diffstat (limited to 'src/lib/libcrypto/man/BIO_new.3')
| -rw-r--r-- | src/lib/libcrypto/man/BIO_new.3 | 276 |
1 files changed, 0 insertions, 276 deletions
diff --git a/src/lib/libcrypto/man/BIO_new.3 b/src/lib/libcrypto/man/BIO_new.3 deleted file mode 100644 index e7c08c99f1..0000000000 --- a/src/lib/libcrypto/man/BIO_new.3 +++ /dev/null | |||
| @@ -1,276 +0,0 @@ | |||
| 1 | .\" $OpenBSD: BIO_new.3,v 1.21 2021/07/10 15:56:18 schwarze Exp $ | ||
| 2 | .\" full merge up to: | ||
| 3 | .\" OpenSSL man3/BIO_new.pod fb46be03 Feb 26 11:51:31 2016 +0000 | ||
| 4 | .\" OpenSSL man7/bio.pod 631c37be Dec 12 16:56:50 2017 +0100 | ||
| 5 | .\" partial merge up to: | ||
| 6 | .\" OpenSSL man3/BIO_new.pod e9b77246 Jan 20 19:58:49 2017 +0100 | ||
| 7 | .\" | ||
| 8 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. | ||
| 9 | .\" Copyright (c) 2000, 2015, 2016 The OpenSSL Project. All rights reserved. | ||
| 10 | .\" | ||
| 11 | .\" Redistribution and use in source and binary forms, with or without | ||
| 12 | .\" modification, are permitted provided that the following conditions | ||
| 13 | .\" are met: | ||
| 14 | .\" | ||
| 15 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 16 | .\" notice, this list of conditions and the following disclaimer. | ||
| 17 | .\" | ||
| 18 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 19 | .\" notice, this list of conditions and the following disclaimer in | ||
| 20 | .\" the documentation and/or other materials provided with the | ||
| 21 | .\" distribution. | ||
| 22 | .\" | ||
| 23 | .\" 3. All advertising materials mentioning features or use of this | ||
| 24 | .\" software must display the following acknowledgment: | ||
| 25 | .\" "This product includes software developed by the OpenSSL Project | ||
| 26 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
| 27 | .\" | ||
| 28 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
| 29 | .\" endorse or promote products derived from this software without | ||
| 30 | .\" prior written permission. For written permission, please contact | ||
| 31 | .\" openssl-core@openssl.org. | ||
| 32 | .\" | ||
| 33 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
| 34 | .\" nor may "OpenSSL" appear in their names without prior written | ||
| 35 | .\" permission of the OpenSSL Project. | ||
| 36 | .\" | ||
| 37 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
| 38 | .\" acknowledgment: | ||
| 39 | .\" "This product includes software developed by the OpenSSL Project | ||
| 40 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
| 41 | .\" | ||
| 42 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
| 43 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 44 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| 45 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
| 46 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| 47 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
| 48 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| 49 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 50 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
| 51 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| 52 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
| 53 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| 54 | .\" | ||
| 55 | .Dd $Mdocdate: July 10 2021 $ | ||
| 56 | .Dt BIO_NEW 3 | ||
| 57 | .Os | ||
| 58 | .Sh NAME | ||
| 59 | .Nm BIO_new , | ||
| 60 | .Nm BIO_up_ref , | ||
| 61 | .Nm BIO_set , | ||
| 62 | .Nm BIO_free , | ||
| 63 | .Nm BIO_vfree , | ||
| 64 | .Nm BIO_free_all | ||
| 65 | .Nd construct and destruct I/O abstraction objects | ||
| 66 | .Sh SYNOPSIS | ||
| 67 | .In openssl/bio.h | ||
| 68 | .Ft BIO * | ||
| 69 | .Fo BIO_new | ||
| 70 | .Fa "const BIO_METHOD *type" | ||
| 71 | .Fc | ||
| 72 | .Ft int | ||
| 73 | .Fo BIO_up_ref | ||
| 74 | .Fa "BIO *a" | ||
| 75 | .Fc | ||
| 76 | .Ft int | ||
| 77 | .Fo BIO_set | ||
| 78 | .Fa "BIO *a" | ||
| 79 | .Fa "const BIO_METHOD *type" | ||
| 80 | .Fc | ||
| 81 | .Ft int | ||
| 82 | .Fo BIO_free | ||
| 83 | .Fa "BIO *a" | ||
| 84 | .Fc | ||
| 85 | .Ft void | ||
| 86 | .Fo BIO_vfree | ||
| 87 | .Fa "BIO *a" | ||
| 88 | .Fc | ||
| 89 | .Ft void | ||
| 90 | .Fo BIO_free_all | ||
| 91 | .Fa "BIO *a" | ||
| 92 | .Fc | ||
| 93 | .Sh DESCRIPTION | ||
| 94 | A | ||
| 95 | .Vt BIO | ||
| 96 | is an I/O abstraction object, hiding many of the underlying I/O | ||
| 97 | details from an application. | ||
| 98 | If an application uses BIOs for its I/O, it can transparently handle | ||
| 99 | SSL connections, unencrypted network connections, and file I/O. | ||
| 100 | .Pp | ||
| 101 | The | ||
| 102 | .Fn BIO_new | ||
| 103 | function constructs a new | ||
| 104 | .Vt BIO | ||
| 105 | using the method | ||
| 106 | .Fa type | ||
| 107 | and sets its reference count to 1. | ||
| 108 | There are two groups of BIO types, source/sink BIOs and filter BIOs. | ||
| 109 | .Pp | ||
| 110 | Source/sink BIOs provide input or consume output. | ||
| 111 | Examples include socket BIOs and file BIOs. | ||
| 112 | .Pp | ||
| 113 | Filter BIOs take data from one BIO and pass it through to another, | ||
| 114 | or to the application, forming a chain of BIOs. | ||
| 115 | The data may be left unmodified (for example by a message digest BIO) | ||
| 116 | or translated (for example by an encryption BIO). | ||
| 117 | The effect of a filter BIO may change according to the I/O operation | ||
| 118 | it is performing: for example an encryption BIO encrypts data | ||
| 119 | if it is written to and decrypts data if it is read from. | ||
| 120 | .Pp | ||
| 121 | Some BIOs (such as memory BIOs) can be used immediately after calling | ||
| 122 | .Fn BIO_new . | ||
| 123 | Others (such as file BIOs) need some additional initialization, and | ||
| 124 | utility functions exists to construct and initialize such BIOs. | ||
| 125 | .Pp | ||
| 126 | Normally the | ||
| 127 | .Fa type | ||
| 128 | argument is supplied by a function which returns a pointer to a | ||
| 129 | .Vt BIO_METHOD . | ||
| 130 | There is a naming convention for such functions: | ||
| 131 | the methods for source/sink BIOs are called | ||
| 132 | .Fn BIO_s_* | ||
| 133 | and those for filter BIOs | ||
| 134 | .Fn BIO_f_* . | ||
| 135 | .Pp | ||
| 136 | .Fn BIO_up_ref | ||
| 137 | increments the reference count of | ||
| 138 | .Fa a | ||
| 139 | by 1. | ||
| 140 | .Pp | ||
| 141 | .Fn BIO_set | ||
| 142 | is a deprecated function to initialize an unused | ||
| 143 | .Vt BIO | ||
| 144 | structure located in static memory or on the stack, | ||
| 145 | to set its method to | ||
| 146 | .Fa type , | ||
| 147 | and to set its reference count to 1. | ||
| 148 | It must not be called on | ||
| 149 | .Vt BIO | ||
| 150 | objects created with | ||
| 151 | .Fn BIO_new , | ||
| 152 | nor on objects that were already used. | ||
| 153 | .Pp | ||
| 154 | .Fn BIO_free | ||
| 155 | and | ||
| 156 | .Fn BIO_vfree | ||
| 157 | decrement the reference count of | ||
| 158 | .Fa a | ||
| 159 | by 1, and if the reference count reaches 0, they destruct the single | ||
| 160 | .Vt BIO | ||
| 161 | .Fa a , | ||
| 162 | which may also have some effect on the | ||
| 163 | underlying I/O structure, for example it may close the file being | ||
| 164 | referred to under certain circumstances. | ||
| 165 | If | ||
| 166 | .Fa a | ||
| 167 | is a | ||
| 168 | .Dv NULL | ||
| 169 | pointer, no action occurs. | ||
| 170 | If | ||
| 171 | .Fn BIO_free | ||
| 172 | is called on a BIO chain, it destructs at most one BIO, | ||
| 173 | resulting in a memory leak. | ||
| 174 | .Pp | ||
| 175 | .Fn BIO_free_all | ||
| 176 | calls | ||
| 177 | .Fn BIO_free | ||
| 178 | on | ||
| 179 | .Fa a | ||
| 180 | and on all following | ||
| 181 | .Vt BIO | ||
| 182 | objects in the chain. | ||
| 183 | As soon as the reference count of a | ||
| 184 | .Vt BIO | ||
| 185 | is still non-zero after calling | ||
| 186 | .Fn BIO_free | ||
| 187 | on it, the function | ||
| 188 | .Fn BIO_free_all | ||
| 189 | returns right away and refrains from freeing the remaining | ||
| 190 | .Vt BIO | ||
| 191 | objects in the chain. | ||
| 192 | It does not halt if an error occurs | ||
| 193 | destructing an individual BIO in the chain. | ||
| 194 | If | ||
| 195 | .Fa a | ||
| 196 | is a | ||
| 197 | .Dv NULL | ||
| 198 | pointer, no action occurs. | ||
| 199 | Calling | ||
| 200 | .Fn BIO_free_all | ||
| 201 | on a single BIO has the same effect as | ||
| 202 | .Fn BIO_vfree . | ||
| 203 | .Pp | ||
| 204 | Common I/O functions are documented in | ||
| 205 | .Xr BIO_read 3 . | ||
| 206 | Forming chains is explained in | ||
| 207 | .Xr BIO_push 3 ; | ||
| 208 | inspecting them is explained in | ||
| 209 | .Xr BIO_find_type 3 . | ||
| 210 | For more details about the different kinds of BIOs, see the individual | ||
| 211 | .Vt BIO_METHOD | ||
| 212 | manual pages. | ||
| 213 | .Sh RETURN VALUES | ||
| 214 | .Fn BIO_new | ||
| 215 | returns a newly constructed | ||
| 216 | .Vt BIO | ||
| 217 | object or | ||
| 218 | .Dv NULL | ||
| 219 | on failure. | ||
| 220 | .Pp | ||
| 221 | .Fn BIO_up_ref , | ||
| 222 | .Fn BIO_set , | ||
| 223 | and | ||
| 224 | .Fn BIO_free | ||
| 225 | return 1 for success or 0 for failure. | ||
| 226 | .Sh EXAMPLES | ||
| 227 | Create a memory BIO: | ||
| 228 | .Pp | ||
| 229 | .Dl BIO *mem = BIO_new(BIO_s_mem()); | ||
| 230 | .Sh SEE ALSO | ||
| 231 | .Xr BIO_ctrl 3 , | ||
| 232 | .Xr BIO_dump 3 , | ||
| 233 | .Xr BIO_f_base64 3 , | ||
| 234 | .Xr BIO_f_buffer 3 , | ||
| 235 | .Xr BIO_f_cipher 3 , | ||
| 236 | .Xr BIO_f_md 3 , | ||
| 237 | .Xr BIO_f_null 3 , | ||
| 238 | .Xr BIO_f_ssl 3 , | ||
| 239 | .Xr BIO_find_type 3 , | ||
| 240 | .Xr BIO_get_ex_new_index 3 , | ||
| 241 | .Xr BIO_meth_new 3 , | ||
| 242 | .Xr BIO_new_CMS 3 , | ||
| 243 | .Xr BIO_printf 3 , | ||
| 244 | .Xr BIO_push 3 , | ||
| 245 | .Xr BIO_read 3 , | ||
| 246 | .Xr BIO_s_accept 3 , | ||
| 247 | .Xr BIO_s_bio 3 , | ||
| 248 | .Xr BIO_s_connect 3 , | ||
| 249 | .Xr BIO_s_fd 3 , | ||
| 250 | .Xr BIO_s_file 3 , | ||
| 251 | .Xr BIO_s_mem 3 , | ||
| 252 | .Xr BIO_s_null 3 , | ||
| 253 | .Xr BIO_s_socket 3 , | ||
| 254 | .Xr BIO_set_callback 3 , | ||
| 255 | .Xr BIO_set_data 3 , | ||
| 256 | .Xr BIO_should_retry 3 , | ||
| 257 | .Xr BUF_MEM_new 3 , | ||
| 258 | .Xr crypto 3 | ||
| 259 | .Sh HISTORY | ||
| 260 | .Fn BIO_new , | ||
| 261 | .Fn BIO_set , | ||
| 262 | and | ||
| 263 | .Fn BIO_free | ||
| 264 | first appeared in SSLeay 0.6.0. | ||
| 265 | .Fn BIO_free_all | ||
| 266 | first appeared in SSLeay 0.6.6. | ||
| 267 | All these functions have been available since | ||
| 268 | .Ox 2.4 . | ||
| 269 | .Pp | ||
| 270 | .Fn BIO_vfree | ||
| 271 | first appeared in OpenSSL 0.9.6 and has been available since | ||
| 272 | .Ox 2.9 . | ||
| 273 | .Pp | ||
| 274 | .Fn BIO_up_ref | ||
| 275 | first appeared in OpenSSL 1.1.0 and has been available since | ||
| 276 | .Ox 6.3 . | ||
