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