crypto/external/bsd/openssl/lib/libcrypto/man/BIO_f_cipher.3

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