Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_f_cipher.3
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "BIO_f_cipher 3"
132 .TH BIO_f_cipher 3 "2008-09-06" "0.9.8h" "OpenSSL"
133 .SH "NAME"
134 BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx \- cipher BIO filter
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 2
138 \& #include <openssl/bio.h>
139 \& #include <openssl/evp.h>
140 .Ve
141 .PP
142 .Vb 5
143 \& BIO_METHOD *   BIO_f_cipher(void);
144 \& void BIO_set_cipher(BIO *b,const EVP_CIPHER *cipher,
145 \&                unsigned char *key, unsigned char *iv, int enc);
146 \& int BIO_get_cipher_status(BIO *b)
147 \& int BIO_get_cipher_ctx(BIO *b, EVP_CIPHER_CTX **pctx)
148 .Ve
149 .SH "DESCRIPTION"
150 .IX Header "DESCRIPTION"
151 \&\fIBIO_f_cipher()\fR returns the cipher \s-1BIO\s0 method. This is a filter
152 \&\s-1BIO\s0 that encrypts any data written through it, and decrypts any data
153 read from it. It is a \s-1BIO\s0 wrapper for the cipher routines
154 \&\fIEVP_CipherInit()\fR, \fIEVP_CipherUpdate()\fR and \fIEVP_CipherFinal()\fR.
155 .PP
156 Cipher BIOs do not support \fIBIO_gets()\fR or \fIBIO_puts()\fR. 
157 .PP
158 \&\fIBIO_flush()\fR on an encryption \s-1BIO\s0 that is being written through is
159 used to signal that no more data is to be encrypted: this is used
160 to flush and possibly pad the final block through the \s-1BIO\s0.
161 .PP
162 \&\fIBIO_set_cipher()\fR sets the cipher of \s-1BIO\s0 \fBb\fR to \fBcipher\fR using key \fBkey\fR
163 and \s-1IV\s0 \fBiv\fR. \fBenc\fR should be set to 1 for encryption and zero for
164 decryption.
165 .PP
166 When reading from an encryption \s-1BIO\s0 the final block is automatically
167 decrypted and checked when \s-1EOF\s0 is detected. \fIBIO_get_cipher_status()\fR
168 is a \fIBIO_ctrl()\fR macro which can be called to determine whether the
169 decryption operation was successful.
170 .PP
171 \&\fIBIO_get_cipher_ctx()\fR is a \fIBIO_ctrl()\fR macro which retrieves the internal
172 \&\s-1BIO\s0 cipher context. The retrieved context can be used in conjunction
173 with the standard cipher routines to set it up. This is useful when
174 \&\fIBIO_set_cipher()\fR is not flexible enough for the applications needs.
175 .SH "NOTES"
176 .IX Header "NOTES"
177 When encrypting \fIBIO_flush()\fR \fBmust\fR be called to flush the final block
178 through the \s-1BIO\s0. If it is not then the final block will fail a subsequent
179 decrypt.
180 .PP
181 When decrypting an error on the final block is signalled by a zero
182 return value from the read operation. A successful decrypt followed
183 by \s-1EOF\s0 will also return zero for the final read. \fIBIO_get_cipher_status()\fR
184 should be called to determine if the decrypt was successful.
185 .PP
186 As always, if \fIBIO_gets()\fR or \fIBIO_puts()\fR support is needed then it can
187 be achieved by preceding the cipher \s-1BIO\s0 with a buffering \s-1BIO\s0.
188 .SH "RETURN VALUES"
189 .IX Header "RETURN VALUES"
190 \&\fIBIO_f_cipher()\fR returns the cipher \s-1BIO\s0 method.
191 .PP
192 \&\fIBIO_set_cipher()\fR does not return a value.
193 .PP
194 \&\fIBIO_get_cipher_status()\fR returns 1 for a successful decrypt and 0
195 for failure.
196 .PP
197 \&\fIBIO_get_cipher_ctx()\fR currently always returns 1.
198 .SH "EXAMPLES"
199 .IX Header "EXAMPLES"
200 \&\s-1TBA\s0
201 .SH "SEE ALSO"
202 .IX Header "SEE ALSO"
203 \&\s-1TBA\s0