1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
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.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
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
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
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'
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 \
133 .\" ========================================================================
135 .IX Title "BIO_F_CIPHER 3"
136 .TH BIO_F_CIPHER 3 "2021-03-25" "1.1.1k" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx \- cipher BIO filter
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/bio.h>
147 \& #include <openssl/evp.h>
149 \& const BIO_METHOD *BIO_f_cipher(void);
150 \& void BIO_set_cipher(BIO *b, const EVP_CIPHER *cipher,
151 \& unsigned char *key, unsigned char *iv, int enc);
152 \& int BIO_get_cipher_status(BIO *b)
153 \& int BIO_get_cipher_ctx(BIO *b, EVP_CIPHER_CTX **pctx)
156 .IX Header "DESCRIPTION"
157 \&\fBBIO_f_cipher()\fR returns the cipher \s-1BIO\s0 method. This is a filter
158 \&\s-1BIO\s0 that encrypts any data written through it, and decrypts any data
159 read from it. It is a \s-1BIO\s0 wrapper for the cipher routines
160 \&\fBEVP_CipherInit()\fR, \fBEVP_CipherUpdate()\fR and \fBEVP_CipherFinal()\fR.
162 Cipher BIOs do not support \fBBIO_gets()\fR or \fBBIO_puts()\fR.
164 \&\fBBIO_flush()\fR on an encryption \s-1BIO\s0 that is being written through is
165 used to signal that no more data is to be encrypted: this is used
166 to flush and possibly pad the final block through the \s-1BIO.\s0
168 \&\fBBIO_set_cipher()\fR sets the cipher of \s-1BIO\s0 \fBb\fR to \fBcipher\fR using key \fBkey\fR
169 and \s-1IV\s0 \fBiv\fR. \fBenc\fR should be set to 1 for encryption and zero for
172 When reading from an encryption \s-1BIO\s0 the final block is automatically
173 decrypted and checked when \s-1EOF\s0 is detected. \fBBIO_get_cipher_status()\fR
174 is a \fBBIO_ctrl()\fR macro which can be called to determine whether the
175 decryption operation was successful.
177 \&\fBBIO_get_cipher_ctx()\fR is a \fBBIO_ctrl()\fR macro which retrieves the internal
178 \&\s-1BIO\s0 cipher context. The retrieved context can be used in conjunction
179 with the standard cipher routines to set it up. This is useful when
180 \&\fBBIO_set_cipher()\fR is not flexible enough for the applications needs.
183 When encrypting \fBBIO_flush()\fR \fBmust\fR be called to flush the final block
184 through the \s-1BIO.\s0 If it is not then the final block will fail a subsequent
187 When decrypting an error on the final block is signaled by a zero
188 return value from the read operation. A successful decrypt followed
189 by \s-1EOF\s0 will also return zero for the final read. \fBBIO_get_cipher_status()\fR
190 should be called to determine if the decrypt was successful.
192 As always, if \fBBIO_gets()\fR or \fBBIO_puts()\fR support is needed then it can
193 be achieved by preceding the cipher \s-1BIO\s0 with a buffering \s-1BIO.\s0
195 .IX Header "RETURN VALUES"
196 \&\fBBIO_f_cipher()\fR returns the cipher \s-1BIO\s0 method.
198 \&\fBBIO_set_cipher()\fR does not return a value.
200 \&\fBBIO_get_cipher_status()\fR returns 1 for a successful decrypt and 0
203 \&\fBBIO_get_cipher_ctx()\fR currently always returns 1.
205 .IX Header "COPYRIGHT"
206 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
208 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
209 this file except in compliance with the License. You can obtain a copy
210 in the file \s-1LICENSE\s0 in the source distribution or at
211 <https://www.openssl.org/source/license.html>.