Corrected. It said before that ivec had to be initialised to zero,
[openssl.git] / doc / crypto / blowfish.pod
1 =pod
2
3 =head1 NAME
4
5 blowfish, BF_set_key, BF_encrypt, BF_decrypt, BF_ecb_encrypt, BF_cbc_encrypt,
6 BF_cfb64_encrypt, BF_ofb64_encrypt, BF_options - Blowfish encryption
7
8 =head1 SYNOPSIS
9
10  #include <openssl/blowfish.h>
11
12  void BF_set_key(BF_KEY *key, int len, const unsigned char *data);
13
14  void BF_encrypt(BF_LONG *data,const BF_KEY *key);
15  void BF_decrypt(BF_LONG *data,const BF_KEY *key);
16  
17  void BF_ecb_encrypt(const unsigned char *in, unsigned char *out,
18          BF_KEY *key, int enc);
19  void BF_cbc_encrypt(const unsigned char *in, unsigned char *out,
20          long length, BF_KEY *schedule, unsigned char *ivec, int enc);
21  void BF_cfb64_encrypt(const unsigned char *in, unsigned char *out,
22          long length, BF_KEY *schedule, unsigned char *ivec, int *num,
23          int enc);
24  void BF_ofb64_encrypt(const unsigned char *in, unsigned char *out,
25          long length, BF_KEY *schedule, unsigned char *ivec, int *num);
26  const char *BF_options(void);
27
28 =head1 DESCRIPTION
29
30 This library implements the Blowfish cipher, which is invented and described
31 by Counterpane (see http://www.counterpane.com/blowfish/ ).
32
33 Blowfish is a block cipher that operates on 64 bit (8 byte) blocks of data.
34 It uses a variable size key, but typically, 128 bit (16 byte) keys are
35 a considered good for strong encryption.  Blowfish can be used in the same
36 modes as DES (see L<des_modes(7)|des_modes(7)>).  Blowfish is currently one
37 of the faster block ciphers.  It is quite a bit faster than DES, and much
38 faster than IDEA or RC2.
39
40 Blowfish consists of a key setup phase and the actual encryption or decryption
41 phase.
42
43 BF_set_key() sets up the B<BF_KEY> B<key> using the B<len> bytes long key
44 at B<data>.
45
46 BF_encrypt() and BF_decrypt() are the lowest level functions for Blowfish
47 encryption.  They encrypt/decrypt the first 64 bits of the vector pointed by
48 B<data>, using the key B<key>.  These functions should not be used unless you
49 implement 'modes' of Blowfish.
50
51 BF_ecb_encrypt() is the basic Blowfish encryption and decryption function.
52 It encrypts or decrypts the first 64 bits of B<in> using the key B<key>,
53 putting the result in B<out>.  B<enc> decides if encryption (B<BF_ENCRYPT>)
54 or decryption (B<BF_DECRYPT>) shall be performed.  The vector pointed at by
55 B<in> and B<out> must be 64 bits in length, no less.  If they are larger,
56 everything after the first 64 bits is ignored.
57
58 The mode functions BF_cbc_encrypt(), BF_cfb64_encrypt() and BF_ofb64_encrypt()
59 all operate on variable length data.  They all take an initialisation vector
60 B<ivec> which needs to be passed along into the next call of the same function 
61 for the same message.  B<ivec> may be initialised with anything, but the
62 recipient needs to know what it was initialised with, or it won't be able
63 to decrypt.  Some programs and protocols simplify this, like SSH, where
64 B<ivec> is simply initialised to zero.
65 BF_cbc_encrypt() operates of data that is a multiple of 8 bytes long, while
66 BF_cfb64_encrypt() and BF_ofb64_encrypt() are used to encrypt an variable
67 number of bytes (the amount does not have to be an exact multiple of 8).  The
68 purpose of the latter two is to simulate stream ciphers, and therefore, they
69 need the parameter B<num>, which is a pointer to an integer where the current
70 offset in B<ivec> is stored between calls.  This integer must be initialised
71 to zero when B<ivec> is initialised.
72
73 BF_cbc_encrypt() is the Cipher Block Chaining function for Blowfish.  It
74 encrypts or decrypts the 64 bits chunks of B<in> using the key B<schedule>,
75 putting the result in B<out>.  B<enc> decides if encryption (BF_ENCRYPT) or
76 decryption (BF_DECRYPT) shall be performed.  B<ivec> must point at an 8 byte
77 long initialisation vector.
78
79 BF_cfb64_encrypt() is the CFB mode for Blowfish with 64 bit feedback.
80 It encrypts or decrypts the bytes in B<in> using the key B<schedule>,
81 putting the result in B<out>.  B<enc> decides if encryption (B<BF_ENCRYPT>)
82 or decryption (B<BF_DECRYPT>) shall be performed.  B<ivec> must point at an
83 8 byte long initialisation vector. B<num> must point at an integer which must
84 be initially zero.
85
86 BF_ofb64_encrypt() is the OFB mode for Blowfish with 64 bit feedback.
87 It uses the same parameters as BF_cfb64_encrypt(), which must be initialised
88 the same way.
89
90 =head1 RETURN VALUES
91
92 None of the functions presented here return any value.
93
94 =head1 NOTE
95
96 Applications should use the higher level functions
97 L<EVP_EncryptInit(3)|EVP_EncryptInit(3)> etc. instead of calling the
98 blowfish functions directly.
99
100 =head1 SEE ALSO
101
102 L<des_modes(7)|des_modes(7)>
103
104 =head1 HISTORY
105
106 The Blowfish functions are available in all versions of SSLeay and OpenSSL.
107
108 =cut
109