Fix the indentation, and avoid a compiler warning.
[openssl.git] / FAQ
1 OpenSSL  -  Frequently Asked Questions
2 --------------------------------------
3
4 * Which is the current version of OpenSSL?
5 * Where is the documentation?
6 * How can I contact the OpenSSL developers?
7 * Do I need patent licenses to use OpenSSL?
8 * Is OpenSSL thread-safe?
9 * Why do I get a "PRNG not seeded" error message?
10 * Why does the linker complain about undefined symbols?
11 * Where can I get a compiled version of OpenSSL?
12
13
14 * Which is the current version of OpenSSL?
15
16 The current version is available from <URL: http://www.openssl.org>.
17 OpenSSL 0.9.5 was released on February 28th, 2000.
18
19 In addition to the current stable release, you can also access daily
20 snapshots of the OpenSSL development version at <URL:
21 ftp://ftp.openssl.org/snapshot/>, or get it by anonymous CVS access.
22
23
24 * Where is the documentation?
25
26 OpenSSL is a library that provides cryptographic functionality to
27 applications such as secure web servers.  Be sure to read the
28 documentation of the application you want to use.  The INSTALL file
29 explains how to install this library.
30
31 OpenSSL includes a command line utility that can be used to perform a
32 variety of cryptographic functions.  It is described in the openssl(1)
33 manpage.  Documentation for developers is currently being written.  A
34 few manual pages already are available; overviews over libcrypto and
35 libssl are given in the crypto(3) and ssl(3) manpages.
36
37 The OpenSSL manpages are installed in /usr/local/ssl/man/ (or a
38 different directory if you specified one as described in INSTALL).
39 In addition, you can read the most current versions at
40 <URL: http://www.openssl.org/docs/>.
41
42 For information on parts of libcrypto that are not yet documented, you
43 might want to read Ariel Glenn's documentation on SSLeay 0.9, OpenSSL's
44 predecessor, at <URL: http://www.columbia.edu/~ariel/ssleay/>.  Much
45 of this still applies to OpenSSL.
46
47 There is some documentation about certificate extensions and PKCS#12
48 in doc/openssl.txt
49
50 The original SSLeay documentation is included in OpenSSL as
51 doc/ssleay.txt.  It may be useful when none of the other resources
52 help, but please note that it reflects the obsolete version SSLeay
53 0.6.6.
54
55
56 * How can I contact the OpenSSL developers?
57
58 The README file describes how to submit bug reports and patches to
59 OpenSSL.  Information on the OpenSSL mailing lists is available from
60 <URL: http://www.openssl.org>.
61
62
63 * Do I need patent licenses to use OpenSSL?
64
65 The patents section of the README file lists patents that may apply to
66 you if you want to use OpenSSL.  For information on intellectual
67 property rights, please consult a lawyer.  The OpenSSL team does not
68 offer legal advice.
69
70 You can configure OpenSSL so as not to use RC5 and IDEA by using
71  ./config no-rc5 no-idea
72
73 Until the RSA patent expires, U.S. users may want to use
74  ./config no-rc5 no-idea no-rsa
75
76 Please note that you will *not* be able to communicate with most of
77 the popular web browsers without RSA support.
78
79
80 * Is OpenSSL thread-safe?
81
82 Yes.  On Windows and many Unix systems, OpenSSL automatically uses the
83 multi-threaded versions of the standard libraries.  If your platform
84 is not one of these, consult the INSTALL file.
85
86 Multi-threaded applications must provide two callback functions to
87 OpenSSL.  This is described in the threads(3) manpage.
88
89
90 * Why do I get a "PRNG not seeded" error message?
91
92 Cryptographic software needs a source of unpredictable data to work
93 correctly.  Many open source operating systems provide a "randomness
94 device" that serves this purpose.  On other systems, applications have
95 to call the RAND_add() or RAND_seed() function with appropriate data
96 before generating keys or performing public key encryption.
97
98 Some broken applications do not do this.  As of version 0.9.5, the
99 OpenSSL functions that need randomness report an error if the random
100 number generator has not been seeded with at least 128 bits of
101 randomness.  If this error occurs, please contact the author of the
102 application you are using.  It is likely that it never worked
103 correctly.  OpenSSL 0.9.5 makes the error visible by refusing to
104 perform potentially insecure encryption.
105
106 Most components of the openssl command line tool try to use the
107 file $HOME/.rnd (or $RANDFILE, if this environment variable is set)
108 for seeding the PRNG.  If this file does not exist or is too short,
109 the "PRNG not seeded" error message may occur.
110
111
112 * Why does the linker complain about undefined symbols?
113
114 Maybe the compilation was interrupted, and make doesn't notice that
115 something is missing.  Run "make clean; make".
116
117 If you used ./Configure instead of ./config, make sure that you
118 selected the right target.  File formats may differ slightly between
119 OS versions (for example sparcv8/sparcv9, or a.out/elf).
120
121 In case you get errors about the following symbols, use the config
122 option "no-asm", as described in INSTALL:
123
124  BF_cbc_encrypt, BF_decrypt, BF_encrypt, CAST_cbc_encrypt,
125  CAST_decrypt, CAST_encrypt, RC4, RC5_32_cbc_encrypt, RC5_32_decrypt,
126  RC5_32_encrypt, bn_add_words, bn_div_words, bn_mul_add_words,
127  bn_mul_comba4, bn_mul_comba8, bn_mul_words, bn_sqr_comba4,
128  bn_sqr_comba8, bn_sqr_words, bn_sub_words, des_decrypt3,
129  des_ede3_cbc_encrypt, des_encrypt, des_encrypt2, des_encrypt3,
130  des_ncbc_encrypt, md5_block_asm_host_order, sha1_block_asm_data_order
131
132 If none of these helps, you may want to try using the current snapshot.
133 If the problem persists, please submit a bug report.
134
135
136 * Where can I get a compiled version of OpenSSL?
137
138 Some applications that use OpenSSL are distributed in binary form.
139 When using such an application, you don't need to install OpenSSL
140 yourself; the application will include the required parts (e.g. DLLs).
141
142 If you want to install OpenSSL on a Windows system and you don't have
143 a C compiler, read the "Mingw32" section of INSTALL.W32 for information
144 on how to obtain and install the free GNU C compiler.
145
146 A number of Linux and *BSD distributions include OpenSSL.