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