Fix typo in -clrext option, but add a compatibility hack because
[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 * I've compiled a program under Windows and it crashes: why?
13 * Why do I get errors about unknown algorithms?
14 * How do I create certificates or certificate requests?
15 * Why can't I create certificate requests?
16 * Why does <SSL program> fail with a certificate verify error?
17 * How can I create DSA certificates?
18 * Why can't I make an SSL connection using a DSA certificate?
19 * Why can't the OpenSSH configure script detect OpenSSL?
20
21
22 * Which is the current version of OpenSSL?
23
24 The current version is available from <URL: http://www.openssl.org>.
25 OpenSSL 0.9.5 was released on February 28th, 2000.
26
27 In addition to the current stable release, you can also access daily
28 snapshots of the OpenSSL development version at <URL:
29 ftp://ftp.openssl.org/snapshot/>, or get it by anonymous CVS access.
30
31
32 * Where is the documentation?
33
34 OpenSSL is a library that provides cryptographic functionality to
35 applications such as secure web servers.  Be sure to read the
36 documentation of the application you want to use.  The INSTALL file
37 explains how to install this library.
38
39 OpenSSL includes a command line utility that can be used to perform a
40 variety of cryptographic functions.  It is described in the openssl(1)
41 manpage.  Documentation for developers is currently being written.  A
42 few manual pages already are available; overviews over libcrypto and
43 libssl are given in the crypto(3) and ssl(3) manpages.
44
45 The OpenSSL manpages are installed in /usr/local/ssl/man/ (or a
46 different directory if you specified one as described in INSTALL).
47 In addition, you can read the most current versions at
48 <URL: http://www.openssl.org/docs/>.
49
50 For information on parts of libcrypto that are not yet documented, you
51 might want to read Ariel Glenn's documentation on SSLeay 0.9, OpenSSL's
52 predecessor, at <URL: http://www.columbia.edu/~ariel/ssleay/>.  Much
53 of this still applies to OpenSSL.
54
55 There is some documentation about certificate extensions and PKCS#12
56 in doc/openssl.txt
57
58 The original SSLeay documentation is included in OpenSSL as
59 doc/ssleay.txt.  It may be useful when none of the other resources
60 help, but please note that it reflects the obsolete version SSLeay
61 0.6.6.
62
63
64 * How can I contact the OpenSSL developers?
65
66 The README file describes how to submit bug reports and patches to
67 OpenSSL.  Information on the OpenSSL mailing lists is available from
68 <URL: http://www.openssl.org>.
69
70
71 * Do I need patent licenses to use OpenSSL?
72
73 The patents section of the README file lists patents that may apply to
74 you if you want to use OpenSSL.  For information on intellectual
75 property rights, please consult a lawyer.  The OpenSSL team does not
76 offer legal advice.
77
78 You can configure OpenSSL so as not to use RC5 and IDEA by using
79  ./config no-rc5 no-idea
80
81 Until the RSA patent expires, U.S. users may want to use
82  ./config no-rc5 no-idea no-rsa
83
84 Please note that you will *not* be able to communicate with most of
85 the popular web browsers without RSA support.
86
87
88 * Is OpenSSL thread-safe?
89
90 Yes (with limitations: an SSL connection may not concurrently be used
91 by multiple threads).  On Windows and many Unix systems, OpenSSL
92 automatically uses the multi-threaded versions of the standard
93 libraries.  If your platform is not one of these, consult the INSTALL
94 file.
95
96 Multi-threaded applications must provide two callback functions to
97 OpenSSL.  This is described in the threads(3) manpage.
98
99
100 * Why do I get a "PRNG not seeded" error message?
101
102 Cryptographic software needs a source of unpredictable data to work
103 correctly.  Many open source operating systems provide a "randomness
104 device" that serves this purpose.  On other systems, applications have
105 to call the RAND_add() or RAND_seed() function with appropriate data
106 before generating keys or performing public key encryption.
107
108 Some broken applications do not do this.  As of version 0.9.5, the
109 OpenSSL functions that need randomness report an error if the random
110 number generator has not been seeded with at least 128 bits of
111 randomness.  If this error occurs, please contact the author of the
112 application you are using.  It is likely that it never worked
113 correctly.  OpenSSL 0.9.5 makes the error visible by refusing to
114 perform potentially insecure encryption.
115
116 Most components of the openssl command line tool try to use the
117 file $HOME/.rnd (or $RANDFILE, if this environment variable is set)
118 for seeding the PRNG.  If this file does not exist or is too short,
119 the "PRNG not seeded" error message may occur.
120 Note that the command "openssl rsa" in OpenSSL 0.9.5 does not do this
121 and will fail on systems without /dev/urandom when trying to
122 password-encrypt an RSA key!  This is a bug in the library;
123 try a later snaphost instead.
124
125
126 * Why does the linker complain about undefined symbols?
127
128 Maybe the compilation was interrupted, and make doesn't notice that
129 something is missing.  Run "make clean; make".
130
131 If you used ./Configure instead of ./config, make sure that you
132 selected the right target.  File formats may differ slightly between
133 OS versions (for example sparcv8/sparcv9, or a.out/elf).
134
135 In case you get errors about the following symbols, use the config
136 option "no-asm", as described in INSTALL:
137
138  BF_cbc_encrypt, BF_decrypt, BF_encrypt, CAST_cbc_encrypt,
139  CAST_decrypt, CAST_encrypt, RC4, RC5_32_cbc_encrypt, RC5_32_decrypt,
140  RC5_32_encrypt, bn_add_words, bn_div_words, bn_mul_add_words,
141  bn_mul_comba4, bn_mul_comba8, bn_mul_words, bn_sqr_comba4,
142  bn_sqr_comba8, bn_sqr_words, bn_sub_words, des_decrypt3,
143  des_ede3_cbc_encrypt, des_encrypt, des_encrypt2, des_encrypt3,
144  des_ncbc_encrypt, md5_block_asm_host_order, sha1_block_asm_data_order
145
146 If none of these helps, you may want to try using the current snapshot.
147 If the problem persists, please submit a bug report.
148
149
150 * Where can I get a compiled version of OpenSSL?
151
152 Some applications that use OpenSSL are distributed in binary form.
153 When using such an application, you don't need to install OpenSSL
154 yourself; the application will include the required parts (e.g. DLLs).
155
156 If you want to install OpenSSL on a Windows system and you don't have
157 a C compiler, read the "Mingw32" section of INSTALL.W32 for information
158 on how to obtain and install the free GNU C compiler.
159
160 A number of Linux and *BSD distributions include OpenSSL.
161
162
163 * I've compiled a program under Windows and it crashes: why?
164
165 This is usually because you've missed the comment in INSTALL.W32. You
166 must link with the multithreaded DLL version of the VC++ runtime library
167 otherwise the conflict will cause a program to crash: typically on the
168 first BIO related read or write operation.
169
170
171 * Why do I get errors about unknown algorithms?
172
173 This can happen under several circumstances such as reading in an
174 encrypted private key or attempting to decrypt a PKCS#12 file. The cause
175 is forgetting to load OpenSSL's table of algorithms with
176 OpenSSL_add_all_algorithms(). See the manual page for more information.
177
178
179 * How do I create certificates or certificate requests?
180
181 Check out the CA.pl(1) manual page. This provides a simple wrapper round
182 the 'req', 'verify', 'ca' and 'pkcs12' utilities. For finer control check
183 out the manual pages for the individual utilities and the certificate
184 extensions documentation (currently in doc/openssl.txt).
185
186
187 * Why can't I create certificate requests?
188
189 You typically get the error:
190
191         unable to find 'distinguished_name' in config
192         problems making Certificate Request
193
194 This is because it can't find the configuration file. Check out the
195 DIAGNOSTICS section of req(1) for more information.
196
197
198 * Why does <SSL program> fail with a certificate verify error?
199
200 This problem is usually indicated by log messages saying something like
201 "unable to get local issuer certificate" or "self signed certificate".
202 When a certificate is verified its root CA must be "trusted" by OpenSSL
203 this typically means that the CA certificate must be placed in a directory
204 or file and the relevant program configured to read it. The OpenSSL program
205 'verify' behaves in a similar way and issues similar error messages: check
206 the verify(1) program manual page for more information.
207
208
209 * How can I create DSA certificates?
210
211 Check the CA.pl(1) manual page for a DSA certificate example.
212
213
214 * Why can't I make an SSL connection to a server using a DSA certificate?
215
216 Typically you'll see a message saying there are no shared ciphers when
217 the same setup works fine with an RSA certificate. There are two possible
218 causes. The client may not support connections to DSA servers most web
219 browsers only support connections to servers supporting RSA cipher suites.
220 The other cause is that a set of DH parameters has not been supplied to
221 the server. DH parameters can be created with the dhparam(1) command and
222 loaded using the SSL_CTX_set_tmp_dh() for example: check the source to
223 s_server in apps/s_server.c for an example.
224
225
226 * Why can't the OpenSSH configure script detect OpenSSL?
227
228 There is a problem with OpenSSH 1.2.2p1, in that the configure script
229 can't find the installed OpenSSL libraries.  The problem is actually
230 a small glitch that is easily solved with the following patch to be
231 applied to the OpenSSH distribution:
232
233 ----- snip:start -----
234 --- openssh-1.2.2p1/configure.in.orig   Thu Mar 23 18:56:58 2000
235 +++ openssh-1.2.2p1/configure.in        Thu Mar 23 18:55:05 2000
236 @@ -152,10 +152,10 @@
237  AC_MSG_CHECKING([for OpenSSL/SSLeay directory])
238  for ssldir in "" $tryssldir /usr /usr/local/openssl /usr/lib/openssl /usr/local/ssl /usr/lib/ssl /usr/local /usr/pkg /opt /opt/openssl ; do
239         if test ! -z "$ssldir" ; then
240 -               LIBS="$saved_LIBS -L$ssldir"
241 +               LIBS="$saved_LIBS -L$ssldir/lib"
242                 CFLAGS="$CFLAGS -I$ssldir/include"
243                 if test "x$need_dash_r" = "x1" ; then
244 -                       LIBS="$LIBS -R$ssldir"
245 +                       LIBS="$LIBS -R$ssldir/lib"
246                 fi
247         fi
248         LIBS="$LIBS -lcrypto"
249 --- openssh-1.2.2p1/configure.orig      Thu Mar 23 18:55:02 2000
250 +++ openssh-1.2.2p1/configure   Thu Mar 23 18:57:08 2000
251 @@ -1890,10 +1890,10 @@
252  echo "configure:1891: checking for OpenSSL/SSLeay directory" >&5
253  for ssldir in "" $tryssldir /usr /usr/local/openssl /usr/lib/openssl /usr/local/ssl /usr/lib/ssl /usr/local /usr/pkg /opt /opt/openssl ; do
254         if test ! -z "$ssldir" ; then
255 -               LIBS="$saved_LIBS -L$ssldir"
256 +               LIBS="$saved_LIBS -L$ssldir/lib"
257                 CFLAGS="$CFLAGS -I$ssldir/include"
258                 if test "x$need_dash_r" = "x1" ; then
259 -                       LIBS="$LIBS -R$ssldir"
260 +                       LIBS="$LIBS -R$ssldir/lib"
261                 fi
262         fi
263         LIBS="$LIBS -lcrypto"
264 ----- snip:end -----