secure/lib/libcrypto/man/blowfish.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   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 "blowfish 3"
 132 .TH blowfish 3 "2006-11-19" "0.9.8d" "OpenSSL"
 133 .SH "NAME"
 134 blowfish, BF_set_key, BF_encrypt, BF_decrypt, BF_ecb_encrypt, BF_cbc_encrypt,
 135 BF_cfb64_encrypt, BF_ofb64_encrypt, BF_options \- Blowfish encryption
 136 .SH "SYNOPSIS"
 137 .IX Header "SYNOPSIS"
 138 .Vb 1
 139 \& #include <openssl/blowfish.h>
 140 .Ve
 141 .PP
 142 .Vb 1
 143 \& void BF_set_key(BF_KEY *key, int len, const unsigned char *data);
 144 .Ve
 145 .PP
 146 .Vb 10
 147 \& void BF_ecb_encrypt(const unsigned char *in, unsigned char *out,
 148 \&         BF_KEY *key, int enc);
 149 \& void BF_cbc_encrypt(const unsigned char *in, unsigned char *out,
 150 \&         long length, BF_KEY *schedule, unsigned char *ivec, int enc);
 151 \& void BF_cfb64_encrypt(const unsigned char *in, unsigned char *out,
 152 \&         long length, BF_KEY *schedule, unsigned char *ivec, int *num,
 153 \&         int enc);
 154 \& void BF_ofb64_encrypt(const unsigned char *in, unsigned char *out,
 155 \&         long length, BF_KEY *schedule, unsigned char *ivec, int *num);
 156 \& const char *BF_options(void);
 157 .Ve
 158 .PP
 159 .Vb 2
 160 \& void BF_encrypt(BF_LONG *data,const BF_KEY *key);
 161 \& void BF_decrypt(BF_LONG *data,const BF_KEY *key);
 162 .Ve
 163 .SH "DESCRIPTION"
 164 .IX Header "DESCRIPTION"
 165 This library implements the Blowfish cipher, which was invented and described
 166 by Counterpane (see http://www.counterpane.com/blowfish.html ).
 167 .PP
 168 Blowfish is a block cipher that operates on 64 bit (8 byte) blocks of data.
 169 It uses a variable size key, but typically, 128 bit (16 byte) keys are
 170 considered good for strong encryption.  Blowfish can be used in the same
 171 modes as \s-1DES\s0 (see \fIdes_modes\fR\|(7)).  Blowfish is currently one
 172 of the faster block ciphers.  It is quite a bit faster than \s-1DES\s0, and much
 173 faster than \s-1IDEA\s0 or \s-1RC2\s0.
 174 .PP
 175 Blowfish consists of a key setup phase and the actual encryption or decryption
 176 phase.
 177 .PP
 178 \&\fIBF_set_key()\fR sets up the \fB\s-1BF_KEY\s0\fR \fBkey\fR using the \fBlen\fR bytes long key
 179 at \fBdata\fR.
 180 .PP
 181 \&\fIBF_ecb_encrypt()\fR is the basic Blowfish encryption and decryption function.
 182 It encrypts or decrypts the first 64 bits of \fBin\fR using the key \fBkey\fR,
 183 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\fB\s-1BF_ENCRYPT\s0\fR)
 184 or decryption (\fB\s-1BF_DECRYPT\s0\fR) shall be performed.  The vector pointed at by
 185 \&\fBin\fR and \fBout\fR must be 64 bits in length, no less.  If they are larger,
 186 everything after the first 64 bits is ignored.
 187 .PP
 188 The mode functions \fIBF_cbc_encrypt()\fR, \fIBF_cfb64_encrypt()\fR and \fIBF_ofb64_encrypt()\fR
 189 all operate on variable length data.  They all take an initialization vector
 190 \&\fBivec\fR which needs to be passed along into the next call of the same function
 191 for the same message.  \fBivec\fR may be initialized with anything, but the
 192 recipient needs to know what it was initialized with, or it won't be able
 193 to decrypt.  Some programs and protocols simplify this, like \s-1SSH\s0, where
 194 \&\fBivec\fR is simply initialized to zero.
 195 \&\fIBF_cbc_encrypt()\fR operates on data that is a multiple of 8 bytes long, while
 196 \&\fIBF_cfb64_encrypt()\fR and \fIBF_ofb64_encrypt()\fR are used to encrypt an variable
 197 number of bytes (the amount does not have to be an exact multiple of 8).  The
 198 purpose of the latter two is to simulate stream ciphers, and therefore, they
 199 need the parameter \fBnum\fR, which is a pointer to an integer where the current
 200 offset in \fBivec\fR is stored between calls.  This integer must be initialized
 201 to zero when \fBivec\fR is initialized.
 202 .PP
 203 \&\fIBF_cbc_encrypt()\fR is the Cipher Block Chaining function for Blowfish.  It
 204 encrypts or decrypts the 64 bits chunks of \fBin\fR using the key \fBschedule\fR,
 205 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\s-1BF_ENCRYPT\s0) or
 206 decryption (\s-1BF_DECRYPT\s0) shall be performed.  \fBivec\fR must point at an 8 byte
 207 long initialization vector.
 208 .PP
 209 \&\fIBF_cfb64_encrypt()\fR is the \s-1CFB\s0 mode for Blowfish with 64 bit feedback.
 210 It encrypts or decrypts the bytes in \fBin\fR using the key \fBschedule\fR,
 211 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\fB\s-1BF_ENCRYPT\s0\fR)
 212 or decryption (\fB\s-1BF_DECRYPT\s0\fR) shall be performed.  \fBivec\fR must point at an
 213 8 byte long initialization vector. \fBnum\fR must point at an integer which must
 214 be initially zero.
 215 .PP
 216 \&\fIBF_ofb64_encrypt()\fR is the \s-1OFB\s0 mode for Blowfish with 64 bit feedback.
 217 It uses the same parameters as \fIBF_cfb64_encrypt()\fR, which must be initialized
 218 the same way.
 219 .PP
 220 \&\fIBF_encrypt()\fR and \fIBF_decrypt()\fR are the lowest level functions for Blowfish
 221 encryption.  They encrypt/decrypt the first 64 bits of the vector pointed by
 222 \&\fBdata\fR, using the key \fBkey\fR.  These functions should not be used unless you
 223 implement 'modes' of Blowfish.  The alternative is to use \fIBF_ecb_encrypt()\fR.
 224 If you still want to use these functions, you should be aware that they take
 225 each 32\-bit chunk in host-byte order, which is little-endian on little-endian
 226 platforms and big-endian on big-endian ones.
 227 .SH "RETURN VALUES"
 228 .IX Header "RETURN VALUES"
 229 None of the functions presented here return any value.
 230 .SH "NOTE"
 231 .IX Header "NOTE"
 232 Applications should use the higher level functions
 233 \&\fIEVP_EncryptInit\fR\|(3) etc. instead of calling the
 234 blowfish functions directly.
 235 .SH "SEE ALSO"
 236 .IX Header "SEE ALSO"
 237 \&\fIdes_modes\fR\|(7)
 238 .SH "HISTORY"
 239 .IX Header "HISTORY"
 240 The Blowfish functions are available in all versions of SSLeay and OpenSSL.