summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/BIO_push.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/BIO_push.3')
-rw-r--r--src/lib/libcrypto/man/BIO_push.342
1 files changed, 20 insertions, 22 deletions
diff --git a/src/lib/libcrypto/man/BIO_push.3 b/src/lib/libcrypto/man/BIO_push.3
index 0357a8446c..eff3619fb3 100644
--- a/src/lib/libcrypto/man/BIO_push.3
+++ b/src/lib/libcrypto/man/BIO_push.3
@@ -1,6 +1,6 @@
1.\" $OpenBSD: BIO_push.3,v 1.2 2016/11/06 15:52:50 jmc Exp $ 1.\" $OpenBSD: BIO_push.3,v 1.3 2016/11/07 15:52:47 jmc Exp $
2.\" 2.\"
3.Dd $Mdocdate: November 6 2016 $ 3.Dd $Mdocdate: November 7 2016 $
4.Dt BIO_PUSH 3 4.Dt BIO_PUSH 3
5.Os 5.Os
6.Sh NAME 6.Sh NAME
@@ -35,22 +35,14 @@ from a chain and returns the next BIO in the chain, or
35.Dv NULL 35.Dv NULL
36if there is no next BIO. 36if there is no next BIO.
37The removed BIO then becomes a single BIO with no association with the 37The removed BIO then becomes a single BIO with no association with the
38original chain, it can thus be freed or attached to a different chain. 38original chain.
39.Sh RETURN VALUES 39it can thus be freed or attached to a different chain.
40.Fn BIO_push
41returns the beginning of the chain,
42.Fa b .
43.Pp 40.Pp
44.Fn BIO_pop
45returns the next BIO in the chain, or
46.Dv NULL
47if there is no next BIO.
48.Sh NOTES
49The names of these functions are perhaps a little misleading. 41The names of these functions are perhaps a little misleading.
50.Fn BIO_push 42.Fn BIO_push
51joins two BIO chains whereas 43joins two BIO chains whereas
52.Fn BIO_pop 44.Fn BIO_pop
53deletes a single BIO from a chain, 45deletes a single BIO from a chain;
54the deleted BIO does not need to be at the end of a chain. 46the deleted BIO does not need to be at the end of a chain.
55.Pp 47.Pp
56The process of calling 48The process of calling
@@ -60,6 +52,15 @@ and
60on a BIO may have additional consequences: 52on a BIO may have additional consequences:
61a control call is made to the affected BIOs. 53a control call is made to the affected BIOs.
62Any effects will be noted in the descriptions of individual BIOs. 54Any effects will be noted in the descriptions of individual BIOs.
55.Sh RETURN VALUES
56.Fn BIO_push
57returns the beginning of the chain,
58.Fa b .
59.Pp
60.Fn BIO_pop
61returns the next BIO in the chain, or
62.Dv NULL
63if there is no next BIO.
63.Sh EXAMPLES 64.Sh EXAMPLES
64For these examples suppose 65For these examples suppose
65.Sy md1 66.Sy md1
@@ -67,7 +68,7 @@ and
67.Sy md2 68.Sy md2
68are digest BIOs, 69are digest BIOs,
69.Sy b64 70.Sy b64
70is a base64 BIO and 71is a Base64 BIO and
71.Sy f 72.Sy f
72is a file BIO. 73is a file BIO.
73.Pp 74.Pp
@@ -92,17 +93,14 @@ by
92.Sy md1 93.Sy md1
93and 94and
94.Sy md2 , 95.Sy md2 ,
95.Sy base64 96Base64-encoded and written to
96encoded and written to
97.Sy f . 97.Sy f .
98.Pp 98.Pp
99It should be noted that reading causes data to pass 99It should be noted that reading causes data to pass
100in the reverse direction, that is data is read from 100in the reverse direction.
101That is, data is read from
101.Sy f , 102.Sy f ,
102base64 103Base64-decoded and digested by
103.Sy decoded
104and digested
105by
106.Sy md1 104.Sy md1
107and 105and
108.Sy md2 . 106.Sy md2 .
@@ -113,7 +111,7 @@ If this call is made:
113The call will return 111The call will return
114.Sy b64 112.Sy b64
115and the new chain will be 113and the new chain will be
116.Sy md1-b64-f Ns ; 114.Sy md1-b64-f ;
117data can be written to 115data can be written to
118.Sy md1 116.Sy md1
119as before. 117as before.