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