secure/lib/libcrypto/man/man3/BIO_push.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "BIO_PUSH 3"
 136 .TH BIO_PUSH 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 BIO_push, BIO_pop, BIO_set_next \- add and remove BIOs from a chain
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/bio.h>
 147 \&
 148 \& BIO *BIO_push(BIO *b, BIO *next);
 149 \& BIO *BIO_pop(BIO *b);
 150 \& void BIO_set_next(BIO *b, BIO *next);
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fBBIO_push()\fR pushes \fIb\fR on \fInext\fR.
 155 If \fIb\fR is \s-1NULL\s0 the function does nothing and returns \fInext\fR.
 156 Otherwise it prepends \fIb\fR, which may be a single \s-1BIO\s0 or a chain of BIOs,
 157 to \fInext\fR (unless \fInext\fR is \s-1NULL\s0).
 158 It then makes a control call on \fIb\fR and returns \fIb\fR.
 159 .PP
 160 \&\fBBIO_pop()\fR removes the \s-1BIO\s0 \fIb\fR from any chain is is part of.
 161 If \fIb\fR is \s-1NULL\s0 the function does nothing and returns \s-1NULL.\s0
 162 Otherwise it makes a control call on \fIb\fR and
 163 returns the next \s-1BIO\s0 in the chain, or \s-1NULL\s0 if there is no next \s-1BIO.\s0
 164 The removed \s-1BIO\s0 becomes a single \s-1BIO\s0 with no association with
 165 the original chain, it can thus be freed or be made part of a different chain.
 166 .PP
 167 \&\fBBIO_set_next()\fR replaces the existing next \s-1BIO\s0 in a chain with the \s-1BIO\s0 pointed to
 168 by \fInext\fR. The new chain may include some of the same BIOs from the old chain
 169 or it may be completely different.
 170 .SH "NOTES"
 171 .IX Header "NOTES"
 172 The names of these functions are perhaps a little misleading. \fBBIO_push()\fR
 173 joins two \s-1BIO\s0 chains whereas \fBBIO_pop()\fR deletes a single \s-1BIO\s0 from a chain,
 174 the deleted \s-1BIO\s0 does not need to be at the end of a chain.
 175 .PP
 176 The process of calling \fBBIO_push()\fR and \fBBIO_pop()\fR on a \s-1BIO\s0 may have additional
 177 consequences (a control call is made to the affected BIOs).
 178 Any effects will be noted in the descriptions of individual BIOs.
 179 .SH "RETURN VALUES"
 180 .IX Header "RETURN VALUES"
 181 \&\fBBIO_push()\fR returns the head of the chain,
 182 which usually is \fIb\fR, or \fInext\fR if \fIb\fR is \s-1NULL.\s0
 183 .PP
 184 \&\fBBIO_pop()\fR returns the next \s-1BIO\s0 in the chain,
 185 or \s-1NULL\s0 if there is no next \s-1BIO.\s0
 186 .SH "EXAMPLES"
 187 .IX Header "EXAMPLES"
 188 For these examples suppose \fImd1\fR and \fImd2\fR are digest BIOs,
 189 \&\fIb64\fR is a base64 \s-1BIO\s0 and \fIf\fR is a file \s-1BIO.\s0
 190 .PP
 191 If the call:
 192 .PP
 193 .Vb 1
 194 \& BIO_push(b64, f);
 195 .Ve
 196 .PP
 197 is made then the new chain will be \fIb64\-f\fR. After making the calls
 198 .PP
 199 .Vb 2
 200 \& BIO_push(md2, b64);
 201 \& BIO_push(md1, md2);
 202 .Ve
 203 .PP
 204 the new chain is \fImd1\-md2\-b64\-f\fR. Data written to \fImd1\fR will be digested
 205 by \fImd1\fR and \fImd2\fR, base64 encoded, and finally written to \fIf\fR.
 206 .PP
 207 It should be noted that reading causes data to pass in the reverse
 208 direction, that is data is read from \fIf\fR, base64 decoded,
 209 and digested by \fImd2\fR and then \fImd1\fR.
 210 .PP
 211 The call:
 212 .PP
 213 .Vb 1
 214 \& BIO_pop(md2);
 215 .Ve
 216 .PP
 217 will return \fIb64\fR and the new chain will be \fImd1\-b64\-f\fR.
 218 Data can be written to and read from \fImd1\fR as before,
 219 except that \fImd2\fR will no more be applied.
 220 .SH "SEE ALSO"
 221 .IX Header "SEE ALSO"
 222 bio
 223 .SH "HISTORY"
 224 .IX Header "HISTORY"
 225 The \fBBIO_set_next()\fR function was added in OpenSSL 1.1.0.
 226 .SH "COPYRIGHT"
 227 .IX Header "COPYRIGHT"
 228 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
 229 .PP
 230 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 231 this file except in compliance with the License.  You can obtain a copy
 232 in the file \s-1LICENSE\s0 in the source distribution or at
 233 <https://www.openssl.org/source/license.html>.