Make sure bs is assigned NULL when it's free'd, or there will be an
[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 * Can I use OpenSSL's SSL library with non-blocking I/O?
10 * Why do I get a "PRNG not seeded" error message?
11 * Why does the linker complain about undefined symbols?
12 * Where can I get a compiled version of OpenSSL?
13 * I've compiled a program under Windows and it crashes: why?
14 * How do I read or write a DER encoded buffer using the ASN1 functions?
15 * I've tried using <M_some_evil_pkcs12_macro> and I get errors why?
16 * I've called <some function> and it fails, why?
17 * I just get a load of numbers for the error output, what do they mean?
18 * Why do I get errors about unknown algorithms?
19 * How do I create certificates or certificate requests?
20 * Why can't I create certificate requests?
21 * Why does <SSL program> fail with a certificate verify error?
22 * Why can I only use weak ciphers when I connect to a server using OpenSSL?
23 * How can I create DSA certificates?
24 * Why can't I make an SSL connection using a DSA certificate?
25 * How can I remove the passphrase on a private key?
26 * Why can't the OpenSSH configure script detect OpenSSL?
27 * Why does the OpenSSL test fail with "bc: command not found"?
28 * Why does the OpenSSL test fail with "bc: 1 no implemented"?
29 * Why does the OpenSSL compilation fail on Alpha True64 Unix?
30 * Why does the OpenSSL compilation fail with "ar: command not found"?
31 * Why does the OpenSSL compilation fail on Win32 with VC++?
32 * Why aren't tools like 'autoconf' and 'libtool' used?
33
34
35 * Which is the current version of OpenSSL?
36
37 The current version is available from <URL: http://www.openssl.org>.
38 OpenSSL 0.9.6 was released on September 24th, 2000.
39
40 In addition to the current stable release, you can also access daily
41 snapshots of the OpenSSL development version at <URL:
42 ftp://ftp.openssl.org/snapshot/>, or get it by anonymous CVS access.
43
44
45 * Where is the documentation?
46
47 OpenSSL is a library that provides cryptographic functionality to
48 applications such as secure web servers.  Be sure to read the
49 documentation of the application you want to use.  The INSTALL file
50 explains how to install this library.
51
52 OpenSSL includes a command line utility that can be used to perform a
53 variety of cryptographic functions.  It is described in the openssl(1)
54 manpage.  Documentation for developers is currently being written.  A
55 few manual pages already are available; overviews over libcrypto and
56 libssl are given in the crypto(3) and ssl(3) manpages.
57
58 The OpenSSL manpages are installed in /usr/local/ssl/man/ (or a
59 different directory if you specified one as described in INSTALL).
60 In addition, you can read the most current versions at
61 <URL: http://www.openssl.org/docs/>.
62
63 For information on parts of libcrypto that are not yet documented, you
64 might want to read Ariel Glenn's documentation on SSLeay 0.9, OpenSSL's
65 predecessor, at <URL: http://www.columbia.edu/~ariel/ssleay/>.  Much
66 of this still applies to OpenSSL.
67
68 There is some documentation about certificate extensions and PKCS#12
69 in doc/openssl.txt
70
71 The original SSLeay documentation is included in OpenSSL as
72 doc/ssleay.txt.  It may be useful when none of the other resources
73 help, but please note that it reflects the obsolete version SSLeay
74 0.6.6.
75
76
77 * How can I contact the OpenSSL developers?
78
79 The README file describes how to submit bug reports and patches to
80 OpenSSL.  Information on the OpenSSL mailing lists is available from
81 <URL: http://www.openssl.org>.
82
83
84 * Do I need patent licenses to use OpenSSL?
85
86 The patents section of the README file lists patents that may apply to
87 you if you want to use OpenSSL.  For information on intellectual
88 property rights, please consult a lawyer.  The OpenSSL team does not
89 offer legal advice.
90
91 You can configure OpenSSL so as not to use RC5 and IDEA by using
92  ./config no-rc5 no-idea
93
94
95 * Is OpenSSL thread-safe?
96
97 Yes (with limitations: an SSL connection may not concurrently be used
98 by multiple threads).  On Windows and many Unix systems, OpenSSL
99 automatically uses the multi-threaded versions of the standard
100 libraries.  If your platform is not one of these, consult the INSTALL
101 file.
102
103 Multi-threaded applications must provide two callback functions to
104 OpenSSL.  This is described in the threads(3) manpage.
105
106
107 * Can I use OpenSSL's SSL library with non-blocking I/O?
108
109 Yes; make sure to read the SSL_get_error(3) manual page!
110
111 A pitfall to avoid: Don't assume that SSL_read() will just read from
112 the underlying transport or that SSL_write() will just write to it --
113 it is also possible that SSL_write() cannot do any useful work until
114 there is data to read, or that SSL_read() cannot do anything until it
115 is possible to send data.  One reason for this is that the peer may
116 request a new TLS/SSL handshake at any time during the protocol,
117 requiring a bi-directional message exchange; both SSL_read() and
118 SSL_write() will try to continue any pending handshake.
119
120
121 * Why do I get a "PRNG not seeded" error message?
122
123 Cryptographic software needs a source of unpredictable data to work
124 correctly.  Many open source operating systems provide a "randomness
125 device" that serves this purpose.  On other systems, applications have
126 to call the RAND_add() or RAND_seed() function with appropriate data
127 before generating keys or performing public key encryption.
128
129 Some broken applications do not do this.  As of version 0.9.5, the
130 OpenSSL functions that need randomness report an error if the random
131 number generator has not been seeded with at least 128 bits of
132 randomness.  If this error occurs, please contact the author of the
133 application you are using.  It is likely that it never worked
134 correctly.  OpenSSL 0.9.5 and later make the error visible by refusing
135 to perform potentially insecure encryption.
136
137 On systems without /dev/urandom, it is a good idea to use the Entropy
138 Gathering Demon; see the RAND_egd() manpage for details.
139
140 Most components of the openssl command line tool try to use the
141 file $HOME/.rnd (or $RANDFILE, if this environment variable is set)
142 for seeding the PRNG.  If this file does not exist or is too short,
143 the "PRNG not seeded" error message may occur.
144
145 [Note to OpenSSL 0.9.5 users: The command "openssl rsa" in version
146 0.9.5 does not do this and will fail on systems without /dev/urandom
147 when trying to password-encrypt an RSA key!  This is a bug in the
148 library; try a later version instead.]
149
150 For Solaris 2.6, Tim Nibbe <tnibbe@sprint.net> and others have suggested
151 installing the SUNski package from Sun patch 105710-01 (Sparc) which
152 adds a /dev/random device and make sure it gets used, usually through
153 $RANDFILE.  There are probably similar patches for the other Solaris
154 versions.  However, be warned that /dev/random is usually a blocking
155 device, which may have some effects on OpenSSL.
156
157
158 * Why does the linker complain about undefined symbols?
159
160 Maybe the compilation was interrupted, and make doesn't notice that
161 something is missing.  Run "make clean; make".
162
163 If you used ./Configure instead of ./config, make sure that you
164 selected the right target.  File formats may differ slightly between
165 OS versions (for example sparcv8/sparcv9, or a.out/elf).
166
167 In case you get errors about the following symbols, use the config
168 option "no-asm", as described in INSTALL:
169
170  BF_cbc_encrypt, BF_decrypt, BF_encrypt, CAST_cbc_encrypt,
171  CAST_decrypt, CAST_encrypt, RC4, RC5_32_cbc_encrypt, RC5_32_decrypt,
172  RC5_32_encrypt, bn_add_words, bn_div_words, bn_mul_add_words,
173  bn_mul_comba4, bn_mul_comba8, bn_mul_words, bn_sqr_comba4,
174  bn_sqr_comba8, bn_sqr_words, bn_sub_words, des_decrypt3,
175  des_ede3_cbc_encrypt, des_encrypt, des_encrypt2, des_encrypt3,
176  des_ncbc_encrypt, md5_block_asm_host_order, sha1_block_asm_data_order
177
178 If none of these helps, you may want to try using the current snapshot.
179 If the problem persists, please submit a bug report.
180
181
182 * Where can I get a compiled version of OpenSSL?
183
184 Some applications that use OpenSSL are distributed in binary form.
185 When using such an application, you don't need to install OpenSSL
186 yourself; the application will include the required parts (e.g. DLLs).
187
188 If you want to install OpenSSL on a Windows system and you don't have
189 a C compiler, read the "Mingw32" section of INSTALL.W32 for information
190 on how to obtain and install the free GNU C compiler.
191
192 A number of Linux and *BSD distributions include OpenSSL.
193
194
195 * I've compiled a program under Windows and it crashes: why?
196
197 This is usually because you've missed the comment in INSTALL.W32. You
198 must link with the multithreaded DLL version of the VC++ runtime library
199 otherwise the conflict will cause a program to crash: typically on the
200 first BIO related read or write operation.
201
202
203 * How do I read or write a DER encoded buffer using the ASN1 functions?
204
205 You have two options. You can either use a memory BIO in conjunction
206 with the i2d_XXX_bio() or d2i_XXX_bio() functions or you can use the
207 i2d_XXX(), d2i_XXX() functions directly. Since these are often the
208 cause of grief here are some code fragments using PKCS7 as an example:
209
210 unsigned char *buf, *p;
211 int len;
212
213 len = i2d_PKCS7(p7, NULL);
214 buf = OPENSSL_malloc(len); /* or Malloc, error checking omitted */
215 p = buf;
216 i2d_PKCS7(p7, &p);
217
218 At this point buf contains the len bytes of the DER encoding of
219 p7.
220
221 The opposite assumes we already have len bytes in buf:
222
223 unsigned char *p;
224 p = buf;
225 p7 = d2i_PKCS7(NULL, &p, len);
226
227 At this point p7 contains a valid PKCS7 structure of NULL if an error
228 occurred. If an error occurred ERR_print_errors(bio) should give more
229 information.
230
231 The reason for the temporary variable 'p' is that the ASN1 functions
232 increment the passed pointer so it is ready to read or write the next
233 structure. This is often a cause of problems: without the temporary
234 variable the buffer pointer is changed to point just after the data
235 that has been read or written. This may well be uninitialized data
236 and attempts to free the buffer will have unpredictable results
237 because it no longer points to the same address.
238
239
240 * I've tried using <M_some_evil_pkcs12_macro> and I get errors why?
241
242 This usually happens when you try compiling something using the PKCS#12
243 macros with a C++ compiler. There is hardly ever any need to use the
244 PKCS#12 macros in a program, it is much easier to parse and create
245 PKCS#12 files using the PKCS12_parse() and PKCS12_create() functions
246 documented in doc/openssl.txt and with examples in demos/pkcs12. The
247 'pkcs12' application has to use the macros because it prints out 
248 debugging information.
249
250
251 * I've called <some function> and it fails, why?
252
253 Before submitting a report or asking in one of the mailing lists, you
254 should try to determine the cause. In particular, you should call
255 ERR_print_errors() or ERR_print_errors_fp() after the failed call
256 and see if the message helps. Note that the problem may occur earlier
257 than you think -- you should check for errors after every call where
258 it is possible, otherwise the actual problem may be hidden because
259 some OpenSSL functions clear the error state.
260
261
262 * I just get a load of numbers for the error output, what do they mean?
263
264 The actual format is described in the ERR_print_errors() manual page.
265 You should call the function ERR_load_crypto_strings() before hand and
266 the message will be output in text form. If you can't do this (for example
267 it is a pre-compiled binary) you can use the errstr utility on the error
268 code itself (the hex digits after the second colon).
269
270
271 * Why do I get errors about unknown algorithms?
272
273 This can happen under several circumstances such as reading in an
274 encrypted private key or attempting to decrypt a PKCS#12 file. The cause
275 is forgetting to load OpenSSL's table of algorithms with
276 OpenSSL_add_all_algorithms(). See the manual page for more information.
277
278
279 * How do I create certificates or certificate requests?
280
281 Check out the CA.pl(1) manual page. This provides a simple wrapper round
282 the 'req', 'verify', 'ca' and 'pkcs12' utilities. For finer control check
283 out the manual pages for the individual utilities and the certificate
284 extensions documentation (currently in doc/openssl.txt).
285
286
287 * Why can't I create certificate requests?
288
289 You typically get the error:
290
291         unable to find 'distinguished_name' in config
292         problems making Certificate Request
293
294 This is because it can't find the configuration file. Check out the
295 DIAGNOSTICS section of req(1) for more information.
296
297
298 * Why does <SSL program> fail with a certificate verify error?
299
300 This problem is usually indicated by log messages saying something like
301 "unable to get local issuer certificate" or "self signed certificate".
302 When a certificate is verified its root CA must be "trusted" by OpenSSL
303 this typically means that the CA certificate must be placed in a directory
304 or file and the relevant program configured to read it. The OpenSSL program
305 'verify' behaves in a similar way and issues similar error messages: check
306 the verify(1) program manual page for more information.
307
308
309 * Why can I only use weak ciphers when I connect to a server using OpenSSL?
310
311 This is almost certainly because you are using an old "export grade" browser
312 which only supports weak encryption. Upgrade your browser to support 128 bit
313 ciphers.
314
315
316 * How can I create DSA certificates?
317
318 Check the CA.pl(1) manual page for a DSA certificate example.
319
320
321 * Why can't I make an SSL connection to a server using a DSA certificate?
322
323 Typically you'll see a message saying there are no shared ciphers when
324 the same setup works fine with an RSA certificate. There are two possible
325 causes. The client may not support connections to DSA servers most web
326 browsers (including Netscape and MSIE) only support connections to servers
327 supporting RSA cipher suites. The other cause is that a set of DH parameters
328 has not been supplied to the server. DH parameters can be created with the
329 dhparam(1) command and loaded using the SSL_CTX_set_tmp_dh() for example:
330 check the source to s_server in apps/s_server.c for an example.
331
332
333 * How can I remove the passphrase on a private key?
334
335 Firstly you should be really *really* sure you want to do this. Leaving
336 a private key unencrypted is a major security risk. If you decide that
337 you do have to do this check the EXAMPLES sections of the rsa(1) and
338 dsa(1) manual pages.
339
340
341 * Why can't the OpenSSH configure script detect OpenSSL?
342
343 There is a problem with OpenSSH 1.2.2p1, in that the configure script
344 can't find the installed OpenSSL libraries.  The problem is actually
345 a small glitch that is easily solved with the following patch to be
346 applied to the OpenSSH distribution:
347
348 ----- snip:start -----
349 --- openssh-1.2.2p1/configure.in.orig   Thu Mar 23 18:56:58 2000
350 +++ openssh-1.2.2p1/configure.in        Thu Mar 23 18:55:05 2000
351 @@ -152,10 +152,10 @@
352  AC_MSG_CHECKING([for OpenSSL/SSLeay directory])
353  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
354         if test ! -z "$ssldir" ; then
355 -               LIBS="$saved_LIBS -L$ssldir"
356 +               LIBS="$saved_LIBS -L$ssldir/lib"
357                 CFLAGS="$CFLAGS -I$ssldir/include"
358                 if test "x$need_dash_r" = "x1" ; then
359 -                       LIBS="$LIBS -R$ssldir"
360 +                       LIBS="$LIBS -R$ssldir/lib"
361                 fi
362         fi
363         LIBS="$LIBS -lcrypto"
364 --- openssh-1.2.2p1/configure.orig      Thu Mar 23 18:55:02 2000
365 +++ openssh-1.2.2p1/configure   Thu Mar 23 18:57:08 2000
366 @@ -1890,10 +1890,10 @@
367  echo "configure:1891: checking for OpenSSL/SSLeay directory" >&5
368  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
369         if test ! -z "$ssldir" ; then
370 -               LIBS="$saved_LIBS -L$ssldir"
371 +               LIBS="$saved_LIBS -L$ssldir/lib"
372                 CFLAGS="$CFLAGS -I$ssldir/include"
373                 if test "x$need_dash_r" = "x1" ; then
374 -                       LIBS="$LIBS -R$ssldir"
375 +                       LIBS="$LIBS -R$ssldir/lib"
376                 fi
377         fi
378         LIBS="$LIBS -lcrypto"
379 ----- snip:end -----
380
381
382 * Why does the OpenSSL test fail with "bc: command not found"?
383
384 You didn't install "bc", the Unix calculator.  If you want to run the
385 tests, get GNU bc from ftp://ftp.gnu.org or from your OS distributor.
386
387
388 * Why does the OpenSSL test fail with "bc: 1 no implemented"?
389
390 On some SCO installations or versions, bc has a bug that gets triggered when
391 you run the test suite (using "make test").  The message returned is "bc:
392 1 not implemented".  The best way to deal with this is to find another
393 implementation of bc and compile/install it.  For example, GNU bc (see
394 http://www.gnu.org/software/software.html for download instructions) can
395 be safely used.
396
397
398 * Why does the OpenSSL compilation fail on Alpha True64 Unix?
399
400 On some Alpha installations running True64 Unix and Compaq C, the compilation
401 of crypto/sha/sha_dgst.c fails with the message 'Fatal:  Insufficient virtual
402 memory to continue compilation.'  As far as the tests have shown, this may be
403 a compiler bug.  What happens is that it eats up a lot of resident memory
404 to build something, probably a table.  The problem is clearly in the
405 optimization code, because if one eliminates optimization completely (-O0),
406 the compilation goes through (and the compiler consumes about 2MB of resident
407 memory instead of 240MB or whatever one's limit is currently).
408
409 There are three options to solve this problem:
410
411 1. set your current data segment size soft limit higher.  Experience shows
412 that about 241000 kbytes seems to be enough on an AlphaServer DS10.  You do
413 this with the command 'ulimit -Sd nnnnnn', where 'nnnnnn' is the number of
414 kbytes to set the limit to.
415
416 2. If you have a hard limit that is lower than what you need and you can't
417 get it changed, you can compile all of OpenSSL with -O0 as optimization
418 level.  This is however not a very nice thing to do for those who expect to
419 get the best result from OpenSSL.  A bit more complicated solution is the
420 following:
421
422 ----- snip:start -----
423   make DIRS=crypto SDIRS=sha "`grep '^CFLAG=' Makefile.ssl | \
424        sed -e 's/ -O[0-9] / -O0 /'`"
425   rm `ls crypto/*.o crypto/sha/*.o | grep -v 'sha_dgst\.o'`
426   make
427 ----- snip:end -----
428
429 This will only compile sha_dgst.c with -O0, the rest with the optimization
430 level chosen by the configuration process.  When the above is done, do the
431 test and installation and you're set.
432
433
434 * Why does the OpenSSL compilation fail with "ar: command not found"?
435
436 Getting this message is quite usual on Solaris 2, because Sun has hidden
437 away 'ar' and other development commands in directories that aren't in
438 $PATH by default.  One of those directories is '/usr/ccs/bin'.  The
439 quickest way to fix this is to do the following (it assumes you use sh
440 or any sh-compatible shell):
441
442 ----- snip:start -----
443   PATH=${PATH}:/usr/ccs/bin; export PATH
444 ----- snip:end -----
445
446 and then redo the compilation.  What you should really do is make sure
447 '/usr/ccs/bin' is permanently in your $PATH, for example through your
448 '.profile' (again, assuming you use a sh-compatible shell).
449
450
451 * Why does the OpenSSL compilation fail on Win32 with VC++?
452
453 Sometimes, you may get reports from VC++ command line (cl) that it
454 can't find standard include files like stdio.h and other weirdnesses.
455 One possible cause is that the environment isn't correctly set up.
456 To solve that problem, one should run VCVARS32.BAT which is found in
457 the 'bin' subdirectory of the VC++ installation directory (somewhere
458 under 'Program Files').  This needs to be done prior to running NMAKE,
459 and the changes are only valid for the current DOS session.
460
461
462 * Why aren't tools like 'autoconf' and 'libtool' used?
463
464 autoconf is a nice tool, but is unfortunately very Unix-centric.
465 Although one can come up with solution to have ports keep in track,
466 there's also some work needed for that, and can be quite painful at
467 times.  If there was a 'autoconf'-like tool that generated perl
468 scripts or something similarly general, it would probably be used
469 in OpenSSL much earlier.
470
471 libtool has repeatadly been reported by some members of the OpenSSL
472 development and others to be a pain to use.  So far, those in the
473 development team who have said anything about this have expressed
474 a wish to avoid libtool for that reason.
475