summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/BIO.3
diff options
context:
space:
mode:
authorschwarze <>2015-02-14 14:09:01 +0000
committerschwarze <>2015-02-14 14:09:01 +0000
commit88853a20be023939d14cfde9e86a81bfcc75ef7b (patch)
tree14e96de4625e6c5d8612c27a513ebf5ed519b352 /src/lib/libcrypto/man/BIO.3
parent948b14a55ded39aea589e34e23c19085fd99cac5 (diff)
downloadopenbsd-88853a20be023939d14cfde9e86a81bfcc75ef7b.tar.gz
openbsd-88853a20be023939d14cfde9e86a81bfcc75ef7b.tar.bz2
openbsd-88853a20be023939d14cfde9e86a81bfcc75ef7b.zip
second batch of perlpod(1) to mdoc(7) conversion
Diffstat (limited to 'src/lib/libcrypto/man/BIO.3')
-rw-r--r--src/lib/libcrypto/man/BIO.356
1 files changed, 56 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/BIO.3 b/src/lib/libcrypto/man/BIO.3
new file mode 100644
index 0000000000..f352379003
--- /dev/null
+++ b/src/lib/libcrypto/man/BIO.3
@@ -0,0 +1,56 @@
1.Dd July 17, 2014
2.Dt BIO 3
3.Os
4.Sh NAME
5.Nm BIO
6.Nd I/O abstraction
7.Sh SYNOPSIS
8.In openssl/bio.h
9.Sh DESCRIPTION
10A BIO is an I/O abstraction,
11it hides many of the underlying I/O details from an application.
12If an application uses a BIO for its I/O, it can transparently handle
13SSL connections, unencrypted network connections and file I/O.
14.Pp
15There are two types of BIO, a source/sink BIO and a filter BIO.
16.Pp
17As its name implies, a source/sink BIO is a source and/or sink of data,
18examples include a socket BIO and a file BIO.
19.Pp
20A filter BIO takes data from one BIO and passes it through
21to another, or to the application.
22The data may be left unmodified (for example a message digest BIO)
23or translated (for example an encryption BIO).
24The effect of a filter BIO may change according to the I/O operation
25it is performing: for example an encryption BIO will encrypt data
26if it is being written to and decrypt data if it is being read from.
27.Pp
28BIOs can be joined together to form a chain
29(a single BIO is a chain with one component).
30A chain normally consist of one source/sink BIO
31and one or more filter BIOs.
32Data read from or written to the first BIO then traverses the chain
33to the end (normally a source/sink BIO).
34.Sh SEE ALSO
35.Xr BIO_ctrl 3 ,
36.Xr BIO_f_base64 3 ,
37.Xr BIO_f_buffer 3 ,
38.Xr BIO_f_cipher 3 ,
39.Xr BIO_f_md 3 ,
40.Xr BIO_f_null 3 ,
41.Xr BIO_f_ssl 3 ,
42.Xr BIO_find_type 3 ,
43.Xr BIO_new 3 ,
44.Xr BIO_new_bio_pair 3 ,
45.Xr BIO_push 3 ,
46.Xr BIO_read 3 ,
47.Xr BIO_s_accept 3 ,
48.Xr BIO_s_bio 3 ,
49.Xr BIO_s_connect 3 ,
50.Xr BIO_s_fd 3 ,
51.Xr BIO_s_file 3 ,
52.Xr BIO_s_mem 3 ,
53.Xr BIO_s_null 3 ,
54.Xr BIO_s_socket 3 ,
55.Xr BIO_set_callback 3 ,
56.Xr BIO_should_retry 3