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

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