Remove -WX option from debug-VC-WIN32
[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_ecb_encrypt(const unsigned char *in, unsigned char *out,
15          BF_KEY *key, int enc);
16  void BF_cbc_encrypt(const unsigned char *in, unsigned char *out,
17          long length, BF_KEY *schedule, unsigned char *ivec, int enc);
18  void BF_cfb64_encrypt(const unsigned char *in, unsigned char *out,
19          long length, BF_KEY *schedule, unsigned char *ivec, int *num,
20          int enc);
21  void BF_ofb64_encrypt(const unsigned char *in, unsigned char *out,
22          long length, BF_KEY *schedule, unsigned char *ivec, int *num);
23  const char *BF_options(void);
24
25  void BF_encrypt(BF_LONG *data,const BF_KEY *key);
26  void BF_decrypt(BF_LONG *data,const BF_KEY *key);
27
28 =head1 DESCRIPTION
29
30 This library implements the Blowfish cipher, which was invented and described
31 by Counterpane (see http://www.counterpane.com/blowfish.html ).
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 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_ecb_encrypt() is the basic Blowfish encryption and decryption function.
47 It encrypts or decrypts the first 64 bits of B<in> using the key B<key>,
48 putting the result in B<out>.  B<enc> decides if encryption (B<BF_ENCRYPT>)
49 or decryption (B<BF_DECRYPT>) shall be performed.  The vector pointed at by
50 B<in> and B<out> must be 64 bits in length, no less.  If they are larger,
51 everything after the first 64 bits is ignored.
52
53 The mode functions BF_cbc_encrypt(), BF_cfb64_encrypt() and BF_ofb64_encrypt()
54 all operate on variable length data.  They all take an initialization vector
55 B<ivec> which needs to be passed along into the next call of the same function 
56 for the same message.  B<ivec> may be initialized with anything, but the
57 recipient needs to know what it was initialized with, or it won't be able
58 to decrypt.  Some programs and protocols simplify this, like SSH, where
59 B<ivec> is simply initialized to zero.
60 BF_cbc_encrypt() operates on data that is a multiple of 8 bytes long, while
61 BF_cfb64_encrypt() and BF_ofb64_encrypt() are used to encrypt an variable
62 number of bytes (the amount does not have to be an exact multiple of 8).  The
63 purpose of the latter two is to simulate stream ciphers, and therefore, they
64 need the parameter B<num>, which is a pointer to an integer where the current
65 offset in B<ivec> is stored between calls.  This integer must be initialized
66 to zero when B<ivec> is initialized.
67
68 BF_cbc_encrypt() is the Cipher Block Chaining function for Blowfish.  It
69 encrypts or decrypts the 64 bits chunks of B<in> using the key B<schedule>,
70 putting the result in B<out>.  B<enc> decides if encryption (BF_ENCRYPT) or
71 decryption (BF_DECRYPT) shall be performed.  B<ivec> must point at an 8 byte
72 long initialization vector.
73
74 BF_cfb64_encrypt() is the CFB mode for Blowfish with 64 bit feedback.
75 It encrypts or decrypts the bytes in B<in> using the key B<schedule>,
76 putting the result in B<out>.  B<enc> decides if encryption (B<BF_ENCRYPT>)
77 or decryption (B<BF_DECRYPT>) shall be performed.  B<ivec> must point at an
78 8 byte long initialization vector. B<num> must point at an integer which must
79 be initially zero.
80
81 BF_ofb64_encrypt() is the OFB mode for Blowfish with 64 bit feedback.
82 It uses the same parameters as BF_cfb64_encrypt(), which must be initialized
83 the same way.
84
85 BF_encrypt() and BF_decrypt() are the lowest level functions for Blowfish
86 encryption.  They encrypt/decrypt the first 64 bits of the vector pointed by
87 B<data>, using the key B<key>.  These functions should not be used unless you
88 implement 'modes' of Blowfish.  The alternative is to use BF_ecb_encrypt().
89 If you still want to use these functions, you should be aware that they take
90 each 32-bit chunk in host-byte order, which is little-endian on little-endian
91 platforms and big-endian on big-endian ones.
92
93 =head1 RETURN VALUES
94
95 None of the functions presented here return any value.
96
97 =head1 NOTE
98
99 Applications should use the higher level functions
100 L<EVP_EncryptInit(3)|EVP_EncryptInit(3)> etc. instead of calling the
101 blowfish functions directly.
102
103 =head1 SEE ALSO
104
105 L<des_modes(7)|des_modes(7)>
106
107 =head1 HISTORY
108
109 The Blowfish functions are available in all versions of SSLeay and OpenSSL.
110
111 =cut
112