secure/lib/libcrypto/man/BF_encrypt.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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 "BF_ENCRYPT 3"
 132 .TH BF_ENCRYPT 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 BF_set_key, BF_encrypt, BF_decrypt, BF_ecb_encrypt, BF_cbc_encrypt, BF_cfb64_encrypt, BF_ofb64_encrypt, BF_options \- Blowfish encryption
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/blowfish.h>
 143 \&
 144 \& void BF_set_key(BF_KEY *key, int len, const unsigned char *data);
 145 \&
 146 \& void BF_ecb_encrypt(const unsigned char *in, unsigned char *out,
 147 \&                     BF_KEY *key, int enc);
 148 \& void BF_cbc_encrypt(const unsigned char *in, unsigned char *out,
 149 \&                     long length, BF_KEY *schedule,
 150 \&                     unsigned char *ivec, int enc);
 151 \& void BF_cfb64_encrypt(const unsigned char *in, unsigned char *out,
 152 \&                       long length, BF_KEY *schedule,
 153 \&                       unsigned char *ivec, int *num, int enc);
 154 \& void BF_ofb64_encrypt(const unsigned char *in, unsigned char *out,
 155 \&                       long length, BF_KEY *schedule,
 156 \&                       unsigned char *ivec, int *num);
 157 \& const char *BF_options(void);
 158 \&
 159 \& void BF_encrypt(BF_LONG *data, const BF_KEY *key);
 160 \& void BF_decrypt(BF_LONG *data, const BF_KEY *key);
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 This library implements the Blowfish cipher, which was invented and described
 165 by Counterpane (see http://www.counterpane.com/blowfish.html ).
 166 .PP
 167 Blowfish is a block cipher that operates on 64 bit (8 byte) blocks of data.
 168 It uses a variable size key, but typically, 128 bit (16 byte) keys are
 169 considered good for strong encryption.  Blowfish can be used in the same
 170 modes as \s-1DES\s0 (see \fIdes_modes\fR\|(7)).  Blowfish is currently one
 171 of the faster block ciphers.  It is quite a bit faster than \s-1DES,\s0 and much
 172 faster than \s-1IDEA\s0 or \s-1RC2.\s0
 173 .PP
 174 Blowfish consists of a key setup phase and the actual encryption or decryption
 175 phase.
 176 .PP
 177 \&\fIBF_set_key()\fR sets up the \fB\s-1BF_KEY\s0\fR \fBkey\fR using the \fBlen\fR bytes long key
 178 at \fBdata\fR.
 179 .PP
 180 \&\fIBF_ecb_encrypt()\fR is the basic Blowfish encryption and decryption function.
 181 It encrypts or decrypts the first 64 bits of \fBin\fR using the key \fBkey\fR,
 182 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\fB\s-1BF_ENCRYPT\s0\fR)
 183 or decryption (\fB\s-1BF_DECRYPT\s0\fR) shall be performed.  The vector pointed at by
 184 \&\fBin\fR and \fBout\fR must be 64 bits in length, no less.  If they are larger,
 185 everything after the first 64 bits is ignored.
 186 .PP
 187 The mode functions \fIBF_cbc_encrypt()\fR, \fIBF_cfb64_encrypt()\fR and \fIBF_ofb64_encrypt()\fR
 188 all operate on variable length data.  They all take an initialization vector
 189 \&\fBivec\fR which needs to be passed along into the next call of the same function
 190 for the same message.  \fBivec\fR may be initialized with anything, but the
 191 recipient needs to know what it was initialized with, or it won't be able
 192 to decrypt.  Some programs and protocols simplify this, like \s-1SSH,\s0 where
 193 \&\fBivec\fR is simply initialized to zero.
 194 \&\fIBF_cbc_encrypt()\fR operates on data that is a multiple of 8 bytes long, while
 195 \&\fIBF_cfb64_encrypt()\fR and \fIBF_ofb64_encrypt()\fR are used to encrypt an variable
 196 number of bytes (the amount does not have to be an exact multiple of 8).  The
 197 purpose of the latter two is to simulate stream ciphers, and therefore, they
 198 need the parameter \fBnum\fR, which is a pointer to an integer where the current
 199 offset in \fBivec\fR is stored between calls.  This integer must be initialized
 200 to zero when \fBivec\fR is initialized.
 201 .PP
 202 \&\fIBF_cbc_encrypt()\fR is the Cipher Block Chaining function for Blowfish.  It
 203 encrypts or decrypts the 64 bits chunks of \fBin\fR using the key \fBschedule\fR,
 204 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\s-1BF_ENCRYPT\s0) or
 205 decryption (\s-1BF_DECRYPT\s0) shall be performed.  \fBivec\fR must point at an 8 byte
 206 long initialization vector.
 207 .PP
 208 \&\fIBF_cfb64_encrypt()\fR is the \s-1CFB\s0 mode for Blowfish with 64 bit feedback.
 209 It encrypts or decrypts the bytes in \fBin\fR using the key \fBschedule\fR,
 210 putting the result in \fBout\fR.  \fBenc\fR decides if encryption (\fB\s-1BF_ENCRYPT\s0\fR)
 211 or decryption (\fB\s-1BF_DECRYPT\s0\fR) shall be performed.  \fBivec\fR must point at an
 212 8 byte long initialization vector. \fBnum\fR must point at an integer which must
 213 be initially zero.
 214 .PP
 215 \&\fIBF_ofb64_encrypt()\fR is the \s-1OFB\s0 mode for Blowfish with 64 bit feedback.
 216 It uses the same parameters as \fIBF_cfb64_encrypt()\fR, which must be initialized
 217 the same way.
 218 .PP
 219 \&\fIBF_encrypt()\fR and \fIBF_decrypt()\fR are the lowest level functions for Blowfish
 220 encryption.  They encrypt/decrypt the first 64 bits of the vector pointed by
 221 \&\fBdata\fR, using the key \fBkey\fR.  These functions should not be used unless you
 222 implement 'modes' of Blowfish.  The alternative is to use \fIBF_ecb_encrypt()\fR.
 223 If you still want to use these functions, you should be aware that they take
 224 each 32\-bit chunk in host-byte order, which is little-endian on little-endian
 225 platforms and big-endian on big-endian ones.
 226 .SH "RETURN VALUES"
 227 .IX Header "RETURN VALUES"
 228 None of the functions presented here return any value.
 229 .SH "NOTE"
 230 .IX Header "NOTE"
 231 Applications should use the higher level functions
 232 \&\fIEVP_EncryptInit\fR\|(3) etc. instead of calling these
 233 functions directly.
 234 .SH "SEE ALSO"
 235 .IX Header "SEE ALSO"
 236 \&\fIEVP_EncryptInit\fR\|(3),
 237 \&\fIdes_modes\fR\|(7)
 238 .SH "COPYRIGHT"
 239 .IX Header "COPYRIGHT"
 240 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
 241 .PP
 242 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 243 this file except in compliance with the License.  You can obtain a copy
 244 in the file \s-1LICENSE\s0 in the source distribution or at
 245 <https://www.openssl.org/source/license.html>.