Fix demo comment: 0.9.9 never released.
[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 * What is an 'engine' version?
12 * How do I check the authenticity of the OpenSSL distribution?
13 * How does the versioning scheme work?
14
15 [LEGAL] Legal questions
16
17 * Do I need patent licenses to use OpenSSL?
18 * Can I use OpenSSL with GPL software? 
19
20 [USER] Questions on using the OpenSSL applications
21
22 * Why do I get a "PRNG not seeded" error message?
23 * Why do I get an "unable to write 'random state'" error message?
24 * How do I create certificates or certificate requests?
25 * Why can't I create certificate requests?
26 * Why does <SSL program> fail with a certificate verify error?
27 * Why can I only use weak ciphers when I connect to a server using OpenSSL?
28 * How can I create DSA certificates?
29 * Why can't I make an SSL connection using a DSA certificate?
30 * How can I remove the passphrase on a private key?
31 * Why can't I use OpenSSL certificates with SSL client authentication?
32 * Why does my browser give a warning about a mismatched hostname?
33 * How do I install a CA certificate into a browser?
34 * Why is OpenSSL x509 DN output not conformant to RFC2253?
35 * What is a "128 bit certificate"? Can I create one with OpenSSL?
36 * Why does OpenSSL set the authority key identifier extension incorrectly?
37 * How can I set up a bundle of commercial root CA certificates?
38 * Some secure servers 'hang' with OpenSSL 1.0.1, is this a bug?
39
40 [BUILD] Questions about building and testing OpenSSL
41
42 * Why does the linker complain about undefined symbols?
43 * Why does the OpenSSL test fail with "bc: command not found"?
44 * Why does the OpenSSL test fail with "bc: 1 no implemented"?
45 * Why does the OpenSSL test fail with "bc: stack empty"?
46 * Why does the OpenSSL compilation fail on Alpha Tru64 Unix?
47 * Why does the OpenSSL compilation fail with "ar: command not found"?
48 * Why does the OpenSSL compilation fail on Win32 with VC++?
49 * What is special about OpenSSL on Redhat?
50 * Why does the OpenSSL compilation fail on MacOS X?
51 * Why does the OpenSSL test suite fail on MacOS X?
52 * Why does the OpenSSL test suite fail in BN_sqr test [on a 64-bit platform]?
53 * Why does OpenBSD-i386 build fail on des-586.s with "Unimplemented segment type"?
54 * Why does the OpenSSL test suite fail in sha512t on x86 CPU?
55 * Why does compiler fail to compile sha512.c?
56 * Test suite still fails, what to do?
57 * I think I've found a bug, what should I do?
58 * I'm SURE I've found a bug, how do I report it?
59 * I've found a security issue, how do I report it?
60
61 [PROG] Questions about programming with OpenSSL
62
63 * Is OpenSSL thread-safe?
64 * I've compiled a program under Windows and it crashes: why?
65 * How do I read or write a DER encoded buffer using the ASN1 functions?
66 * OpenSSL uses DER but I need BER format: does OpenSSL support BER?
67 * I've tried using <M_some_evil_pkcs12_macro> and I get errors why?
68 * I've called <some function> and it fails, why?
69 * I just get a load of numbers for the error output, what do they mean?
70 * Why do I get errors about unknown algorithms?
71 * Why can't the OpenSSH configure script detect OpenSSL?
72 * Can I use OpenSSL's SSL library with non-blocking I/O?
73 * Why doesn't my server application receive a client certificate?
74 * Why does compilation fail due to an undefined symbol NID_uniqueIdentifier?
75 * I think I've detected a memory leak, is this a bug?
76 * Why does Valgrind complain about the use of uninitialized data?
77 * Why doesn't a memory BIO work when a file does?
78 * Where are the declarations and implementations of d2i_X509() etc?
79 * When debugging I observe SIGILL during OpenSSL initialization: why?
80
81 ===============================================================================
82
83 [MISC] ========================================================================
84
85 * Which is the current version of OpenSSL?
86
87 The current version is available from <URL: http://www.openssl.org>.
88 OpenSSL 1.0.1e was released on Feb 11, 2013.
89
90 In addition to the current stable release, you can also access daily
91 snapshots of the OpenSSL development version at <URL:
92 ftp://ftp.openssl.org/snapshot/>, or get it by anonymous Git access.
93
94
95 * Where is the documentation?
96
97 OpenSSL is a library that provides cryptographic functionality to
98 applications such as secure web servers.  Be sure to read the
99 documentation of the application you want to use.  The INSTALL file
100 explains how to install this library.
101
102 OpenSSL includes a command line utility that can be used to perform a
103 variety of cryptographic functions.  It is described in the openssl(1)
104 manpage.  Documentation for developers is currently being written. Many
105 manual pages are available; overviews over libcrypto and
106 libssl are given in the crypto(3) and ssl(3) manpages.
107
108 The OpenSSL manpages are installed in /usr/local/ssl/man/ (or a
109 different directory if you specified one as described in INSTALL).
110 In addition, you can read the most current versions at
111 <URL: http://www.openssl.org/docs/>. Note that the online documents refer
112 to the very latest development versions of OpenSSL and may include features
113 not present in released versions. If in doubt refer to the documentation
114 that came with the version of OpenSSL you are using. The pod format
115 documentation is included in each OpenSSL distribution under the docs
116 directory.
117
118 For information on parts of libcrypto that are not yet documented, you
119 might want to read Ariel Glenn's documentation on SSLeay 0.9, OpenSSL's
120 predecessor, at <URL: http://www.columbia.edu/~ariel/ssleay/>.  Much
121 of this still applies to OpenSSL.
122
123 There is some documentation about certificate extensions and PKCS#12
124 in doc/openssl.txt
125
126 The original SSLeay documentation is included in OpenSSL as
127 doc/ssleay.txt.  It may be useful when none of the other resources
128 help, but please note that it reflects the obsolete version SSLeay
129 0.6.6.
130
131
132 * How can I contact the OpenSSL developers?
133
134 The README file describes how to submit bug reports and patches to
135 OpenSSL.  Information on the OpenSSL mailing lists is available from
136 <URL: http://www.openssl.org>.
137
138
139 * Where can I get a compiled version of OpenSSL?
140
141 You can finder pointers to binary distributions in
142 <URL: http://www.openssl.org/related/binaries.html> .
143
144 Some applications that use OpenSSL are distributed in binary form.
145 When using such an application, you don't need to install OpenSSL
146 yourself; the application will include the required parts (e.g. DLLs).
147
148 If you want to build OpenSSL on a Windows system and you don't have
149 a C compiler, read the "Mingw32" section of INSTALL.W32 for information
150 on how to obtain and install the free GNU C compiler.
151
152 A number of Linux and *BSD distributions include OpenSSL.
153
154
155 * Why aren't tools like 'autoconf' and 'libtool' used?
156
157 autoconf will probably be used in future OpenSSL versions. If it was
158 less Unix-centric, it might have been used much earlier.
159
160 * What is an 'engine' version?
161
162 With version 0.9.6 OpenSSL was extended to interface to external crypto
163 hardware. This was realized in a special release '0.9.6-engine'. With
164 version 0.9.7 the changes were merged into the main development line,
165 so that the special release is no longer necessary.
166
167 * How do I check the authenticity of the OpenSSL distribution?
168
169 We provide MD5 digests and ASC signatures of each tarball.
170 Use MD5 to check that a tarball from a mirror site is identical:
171
172    md5sum TARBALL | awk '{print $1;}' | cmp - TARBALL.md5
173
174 You can check authenticity using pgp or gpg. You need the OpenSSL team
175 member public key used to sign it (download it from a key server, see a
176 list of keys at <URL: http://www.openssl.org/about/>). Then
177 just do:
178
179    pgp TARBALL.asc
180
181 * How does the versioning scheme work?
182
183 After the release of OpenSSL 1.0.0 the versioning scheme changed. Letter 
184 releases (e.g. 1.0.1a) can only contain bug and security fixes and no
185 new features. Minor releases change the last number (e.g. 1.0.2) and 
186 can contain new features that retain binary compatibility. Changes to
187 the middle number are considered major releases and neither source nor
188 binary compatibility is guaranteed.
189
190 Therefore the answer to the common question "when will feature X be
191 backported to OpenSSL 1.0.0/0.9.8?" is "never" but it could appear
192 in the next minor release.
193
194 * What happens when the letter release reaches z?
195
196 It was decided after the release of OpenSSL 0.9.8y the next version should
197 be 0.9.8za then 0.9.8zb and so on.
198
199
200 [LEGAL] =======================================================================
201
202 * Do I need patent licenses to use OpenSSL?
203
204 For information on intellectual property rights, please consult a lawyer.
205 The OpenSSL team does not offer legal advice.
206
207 You can configure OpenSSL so as not to use IDEA, MDC2 and RC5 by using
208  ./config no-idea no-mdc2 no-rc5
209
210
211 * Can I use OpenSSL with GPL software?
212
213 On many systems including the major Linux and BSD distributions, yes (the
214 GPL does not place restrictions on using libraries that are part of the
215 normal operating system distribution).
216
217 On other systems, the situation is less clear. Some GPL software copyright
218 holders claim that you infringe on their rights if you use OpenSSL with
219 their software on operating systems that don't normally include OpenSSL.
220
221 If you develop open source software that uses OpenSSL, you may find it
222 useful to choose an other license than the GPL, or state explicitly that
223 "This program is released under the GPL with the additional exemption that
224 compiling, linking, and/or using OpenSSL is allowed."  If you are using
225 GPL software developed by others, you may want to ask the copyright holder
226 for permission to use their software with OpenSSL.
227
228
229 [USER] ========================================================================
230
231 * Why do I get a "PRNG not seeded" error message?
232
233 Cryptographic software needs a source of unpredictable data to work
234 correctly.  Many open source operating systems provide a "randomness
235 device" (/dev/urandom or /dev/random) that serves this purpose.
236 All OpenSSL versions try to use /dev/urandom by default; starting with
237 version 0.9.7, OpenSSL also tries /dev/random if /dev/urandom is not
238 available.
239
240 On other systems, applications have to call the RAND_add() or
241 RAND_seed() function with appropriate data before generating keys or
242 performing public key encryption. (These functions initialize the
243 pseudo-random number generator, PRNG.)  Some broken applications do
244 not do this.  As of version 0.9.5, the OpenSSL functions that need
245 randomness report an error if the random number generator has not been
246 seeded with at least 128 bits of randomness.  If this error occurs and
247 is not discussed in the documentation of the application you are
248 using, please contact the author of that application; it is likely
249 that it never worked correctly.  OpenSSL 0.9.5 and later make the
250 error visible by refusing to perform potentially insecure encryption.
251
252 If you are using Solaris 8, you can add /dev/urandom and /dev/random
253 devices by installing patch 112438 (Sparc) or 112439 (x86), which are
254 available via the Patchfinder at <URL: http://sunsolve.sun.com>
255 (Solaris 9 includes these devices by default). For /dev/random support
256 for earlier Solaris versions, see Sun's statement at
257 <URL: http://sunsolve.sun.com/pub-cgi/retrieve.pl?doc=fsrdb/27606&zone_32=SUNWski>
258 (the SUNWski package is available in patch 105710).
259
260 On systems without /dev/urandom and /dev/random, it is a good idea to
261 use the Entropy Gathering Demon (EGD); see the RAND_egd() manpage for
262 details.  Starting with version 0.9.7, OpenSSL will automatically look
263 for an EGD socket at /var/run/egd-pool, /dev/egd-pool, /etc/egd-pool and
264 /etc/entropy.
265
266 Most components of the openssl command line utility automatically try
267 to seed the random number generator from a file.  The name of the
268 default seeding file is determined as follows: If environment variable
269 RANDFILE is set, then it names the seeding file.  Otherwise if
270 environment variable HOME is set, then the seeding file is $HOME/.rnd.
271 If neither RANDFILE nor HOME is set, versions up to OpenSSL 0.9.6 will
272 use file .rnd in the current directory while OpenSSL 0.9.6a uses no
273 default seeding file at all.  OpenSSL 0.9.6b and later will behave
274 similarly to 0.9.6a, but will use a default of "C:\" for HOME on
275 Windows systems if the environment variable has not been set.
276
277 If the default seeding file does not exist or is too short, the "PRNG
278 not seeded" error message may occur.
279
280 The openssl command line utility will write back a new state to the
281 default seeding file (and create this file if necessary) unless
282 there was no sufficient seeding.
283
284 Pointing $RANDFILE to an Entropy Gathering Daemon socket does not work.
285 Use the "-rand" option of the OpenSSL command line tools instead.
286 The $RANDFILE environment variable and $HOME/.rnd are only used by the
287 OpenSSL command line tools. Applications using the OpenSSL library
288 provide their own configuration options to specify the entropy source,
289 please check out the documentation coming the with application.
290
291
292 * Why do I get an "unable to write 'random state'" error message?
293
294
295 Sometimes the openssl command line utility does not abort with
296 a "PRNG not seeded" error message, but complains that it is
297 "unable to write 'random state'".  This message refers to the
298 default seeding file (see previous answer).  A possible reason
299 is that no default filename is known because neither RANDFILE
300 nor HOME is set.  (Versions up to 0.9.6 used file ".rnd" in the
301 current directory in this case, but this has changed with 0.9.6a.)
302
303
304 * How do I create certificates or certificate requests?
305
306 Check out the CA.pl(1) manual page. This provides a simple wrapper round
307 the 'req', 'verify', 'ca' and 'pkcs12' utilities. For finer control check
308 out the manual pages for the individual utilities and the certificate
309 extensions documentation (in ca(1), req(1), x509v3_config(5) )
310
311
312 * Why can't I create certificate requests?
313
314 You typically get the error:
315
316         unable to find 'distinguished_name' in config
317         problems making Certificate Request
318
319 This is because it can't find the configuration file. Check out the
320 DIAGNOSTICS section of req(1) for more information.
321
322
323 * Why does <SSL program> fail with a certificate verify error?
324
325 This problem is usually indicated by log messages saying something like
326 "unable to get local issuer certificate" or "self signed certificate".
327 When a certificate is verified its root CA must be "trusted" by OpenSSL
328 this typically means that the CA certificate must be placed in a directory
329 or file and the relevant program configured to read it. The OpenSSL program
330 'verify' behaves in a similar way and issues similar error messages: check
331 the verify(1) program manual page for more information.
332
333
334 * Why can I only use weak ciphers when I connect to a server using OpenSSL?
335
336 This is almost certainly because you are using an old "export grade" browser
337 which only supports weak encryption. Upgrade your browser to support 128 bit
338 ciphers.
339
340
341 * How can I create DSA certificates?
342
343 Check the CA.pl(1) manual page for a DSA certificate example.
344
345
346 * Why can't I make an SSL connection to a server using a DSA certificate?
347
348 Typically you'll see a message saying there are no shared ciphers when
349 the same setup works fine with an RSA certificate. There are two possible
350 causes. The client may not support connections to DSA servers most web
351 browsers (including Netscape and MSIE) only support connections to servers
352 supporting RSA cipher suites. The other cause is that a set of DH parameters
353 has not been supplied to the server. DH parameters can be created with the
354 dhparam(1) command and loaded using the SSL_CTX_set_tmp_dh() for example:
355 check the source to s_server in apps/s_server.c for an example.
356
357
358 * How can I remove the passphrase on a private key?
359
360 Firstly you should be really *really* sure you want to do this. Leaving
361 a private key unencrypted is a major security risk. If you decide that
362 you do have to do this check the EXAMPLES sections of the rsa(1) and
363 dsa(1) manual pages.
364
365
366 * Why can't I use OpenSSL certificates with SSL client authentication?
367
368 What will typically happen is that when a server requests authentication
369 it will either not include your certificate or tell you that you have
370 no client certificates (Netscape) or present you with an empty list box
371 (MSIE). The reason for this is that when a server requests a client
372 certificate it includes a list of CAs names which it will accept. Browsers
373 will only let you select certificates from the list on the grounds that
374 there is little point presenting a certificate which the server will
375 reject.
376
377 The solution is to add the relevant CA certificate to your servers "trusted
378 CA list". How you do this depends on the server software in uses. You can
379 print out the servers list of acceptable CAs using the OpenSSL s_client tool:
380
381 openssl s_client -connect www.some.host:443 -prexit
382
383 If your server only requests certificates on certain URLs then you may need
384 to manually issue an HTTP GET command to get the list when s_client connects:
385
386 GET /some/page/needing/a/certificate.html
387
388 If your CA does not appear in the list then this confirms the problem.
389
390
391 * Why does my browser give a warning about a mismatched hostname?
392
393 Browsers expect the server's hostname to match the value in the commonName
394 (CN) field of the certificate. If it does not then you get a warning.
395
396
397 * How do I install a CA certificate into a browser?
398
399 The usual way is to send the DER encoded certificate to the browser as
400 MIME type application/x-x509-ca-cert, for example by clicking on an appropriate
401 link. On MSIE certain extensions such as .der or .cacert may also work, or you
402 can import the certificate using the certificate import wizard.
403
404 You can convert a certificate to DER form using the command:
405
406 openssl x509 -in ca.pem -outform DER -out ca.der
407
408 Occasionally someone suggests using a command such as:
409
410 openssl pkcs12 -export -out cacert.p12 -in cacert.pem -inkey cakey.pem
411
412 DO NOT DO THIS! This command will give away your CAs private key and
413 reduces its security to zero: allowing anyone to forge certificates in
414 whatever name they choose.
415
416 * Why is OpenSSL x509 DN output not conformant to RFC2253?
417
418 The ways to print out the oneline format of the DN (Distinguished Name) have
419 been extended in version 0.9.7 of OpenSSL. Using the new X509_NAME_print_ex()
420 interface, the "-nameopt" option could be introduded. See the manual
421 page of the "openssl x509" commandline tool for details. The old behaviour
422 has however been left as default for the sake of compatibility.
423
424 * What is a "128 bit certificate"? Can I create one with OpenSSL?
425
426 The term "128 bit certificate" is a highly misleading marketing term. It does
427 *not* refer to the size of the public key in the certificate! A certificate
428 containing a 128 bit RSA key would have negligible security.
429
430 There were various other names such as "magic certificates", "SGC
431 certificates", "step up certificates" etc.
432
433 You can't generally create such a certificate using OpenSSL but there is no
434 need to any more. Nowadays web browsers using unrestricted strong encryption
435 are generally available.
436
437 When there were tight restrictions on the export of strong encryption
438 software from the US only weak encryption algorithms could be freely exported
439 (initially 40 bit and then 56 bit). It was widely recognised that this was
440 inadequate. A relaxation of the rules allowed the use of strong encryption but
441 only to an authorised server.
442
443 Two slighly different techniques were developed to support this, one used by
444 Netscape was called "step up", the other used by MSIE was called "Server Gated
445 Cryptography" (SGC). When a browser initially connected to a server it would
446 check to see if the certificate contained certain extensions and was issued by
447 an authorised authority. If these test succeeded it would reconnect using
448 strong encryption.
449
450 Only certain (initially one) certificate authorities could issue the
451 certificates and they generally cost more than ordinary certificates.
452
453 Although OpenSSL can create certificates containing the appropriate extensions
454 the certificate would not come from a permitted authority and so would not
455 be recognized.
456
457 The export laws were later changed to allow almost unrestricted use of strong
458 encryption so these certificates are now obsolete.
459
460
461 * Why does OpenSSL set the authority key identifier (AKID) extension incorrectly?
462
463 It doesn't: this extension is often the cause of confusion.
464
465 Consider a certificate chain A->B->C so that A signs B and B signs C. Suppose
466 certificate C contains AKID.
467
468 The purpose of this extension is to identify the authority certificate B. This
469 can be done either by including the subject key identifier of B or its issuer
470 name and serial number.
471
472 In this latter case because it is identifying certifcate B it must contain the
473 issuer name and serial number of B.
474
475 It is often wrongly assumed that it should contain the subject name of B. If it
476 did this would be redundant information because it would duplicate the issuer
477 name of C.
478
479
480 * How can I set up a bundle of commercial root CA certificates?
481
482 The OpenSSL software is shipped without any root CA certificate as the
483 OpenSSL project does not have any policy on including or excluding
484 any specific CA and does not intend to set up such a policy. Deciding
485 about which CAs to support is up to application developers or
486 administrators.
487
488 Other projects do have other policies so you can for example extract the CA
489 bundle used by Mozilla and/or modssl as described in this article:
490
491   <URL: http://www.mail-archive.com/modssl-users@modssl.org/msg16980.html>
492
493
494 * Some secure servers 'hang' with OpenSSL 1.0.1, is this a bug?
495
496 OpenSSL 1.0.1 is the first release to support TLS 1.2, among other things,
497 this increases the size of the default ClientHello message to more than
498 255 bytes in length. Some software cannot handle this and hangs. For more
499 details and workarounds see:
500
501   <URL: http://rt.openssl.org/Ticket/Display.html?user=guest&pass=guest&id=2771>
502
503
504 [BUILD] =======================================================================
505
506 * Why does the linker complain about undefined symbols?
507
508 Maybe the compilation was interrupted, and make doesn't notice that
509 something is missing.  Run "make clean; make".
510
511 If you used ./Configure instead of ./config, make sure that you
512 selected the right target.  File formats may differ slightly between
513 OS versions (for example sparcv8/sparcv9, or a.out/elf).
514
515 In case you get errors about the following symbols, use the config
516 option "no-asm", as described in INSTALL:
517
518  BF_cbc_encrypt, BF_decrypt, BF_encrypt, CAST_cbc_encrypt,
519  CAST_decrypt, CAST_encrypt, RC4, RC5_32_cbc_encrypt, RC5_32_decrypt,
520  RC5_32_encrypt, bn_add_words, bn_div_words, bn_mul_add_words,
521  bn_mul_comba4, bn_mul_comba8, bn_mul_words, bn_sqr_comba4,
522  bn_sqr_comba8, bn_sqr_words, bn_sub_words, des_decrypt3,
523  des_ede3_cbc_encrypt, des_encrypt, des_encrypt2, des_encrypt3,
524  des_ncbc_encrypt, md5_block_asm_host_order, sha1_block_asm_data_order
525
526 If none of these helps, you may want to try using the current snapshot.
527 If the problem persists, please submit a bug report.
528
529
530 * Why does the OpenSSL test fail with "bc: command not found"?
531
532 You didn't install "bc", the Unix calculator.  If you want to run the
533 tests, get GNU bc from ftp://ftp.gnu.org or from your OS distributor.
534
535
536 * Why does the OpenSSL test fail with "bc: 1 no implemented"?
537
538 On some SCO installations or versions, bc has a bug that gets triggered
539 when you run the test suite (using "make test").  The message returned is
540 "bc: 1 not implemented".
541
542 The best way to deal with this is to find another implementation of bc
543 and compile/install it.  GNU bc (see <URL: http://www.gnu.org/software/software.html>
544 for download instructions) can be safely used, for example.
545
546
547 * Why does the OpenSSL test fail with "bc: stack empty"?
548
549 On some DG/ux versions, bc seems to have a too small stack for calculations
550 that the OpenSSL bntest throws at it.  This gets triggered when you run the
551 test suite (using "make test").  The message returned is "bc: stack empty".
552
553 The best way to deal with this is to find another implementation of bc
554 and compile/install it.  GNU bc (see <URL: http://www.gnu.org/software/software.html>
555 for download instructions) can be safely used, for example.
556
557
558 * Why does the OpenSSL compilation fail on Alpha Tru64 Unix?
559
560 On some Alpha installations running Tru64 Unix and Compaq C, the compilation
561 of crypto/sha/sha_dgst.c fails with the message 'Fatal:  Insufficient virtual
562 memory to continue compilation.'  As far as the tests have shown, this may be
563 a compiler bug.  What happens is that it eats up a lot of resident memory
564 to build something, probably a table.  The problem is clearly in the
565 optimization code, because if one eliminates optimization completely (-O0),
566 the compilation goes through (and the compiler consumes about 2MB of resident
567 memory instead of 240MB or whatever one's limit is currently).
568
569 There are three options to solve this problem:
570
571 1. set your current data segment size soft limit higher.  Experience shows
572 that about 241000 kbytes seems to be enough on an AlphaServer DS10.  You do
573 this with the command 'ulimit -Sd nnnnnn', where 'nnnnnn' is the number of
574 kbytes to set the limit to.
575
576 2. If you have a hard limit that is lower than what you need and you can't
577 get it changed, you can compile all of OpenSSL with -O0 as optimization
578 level.  This is however not a very nice thing to do for those who expect to
579 get the best result from OpenSSL.  A bit more complicated solution is the
580 following:
581
582 ----- snip:start -----
583   make DIRS=crypto SDIRS=sha "`grep '^CFLAG=' Makefile.ssl | \
584        sed -e 's/ -O[0-9] / -O0 /'`"
585   rm `ls crypto/*.o crypto/sha/*.o | grep -v 'sha_dgst\.o'`
586   make
587 ----- snip:end -----
588
589 This will only compile sha_dgst.c with -O0, the rest with the optimization
590 level chosen by the configuration process.  When the above is done, do the
591 test and installation and you're set.
592
593 3. Reconfigure the toolkit with no-sha0 option to leave out SHA0. It 
594 should not be used and is not used in SSL/TLS nor any other recognized
595 protocol in either case.
596
597
598 * Why does the OpenSSL compilation fail with "ar: command not found"?
599
600 Getting this message is quite usual on Solaris 2, because Sun has hidden
601 away 'ar' and other development commands in directories that aren't in
602 $PATH by default.  One of those directories is '/usr/ccs/bin'.  The
603 quickest way to fix this is to do the following (it assumes you use sh
604 or any sh-compatible shell):
605
606 ----- snip:start -----
607   PATH=${PATH}:/usr/ccs/bin; export PATH
608 ----- snip:end -----
609
610 and then redo the compilation.  What you should really do is make sure
611 '/usr/ccs/bin' is permanently in your $PATH, for example through your
612 '.profile' (again, assuming you use a sh-compatible shell).
613
614
615 * Why does the OpenSSL compilation fail on Win32 with VC++?
616
617 Sometimes, you may get reports from VC++ command line (cl) that it
618 can't find standard include files like stdio.h and other weirdnesses.
619 One possible cause is that the environment isn't correctly set up.
620 To solve that problem for VC++ versions up to 6, one should run
621 VCVARS32.BAT which is found in the 'bin' subdirectory of the VC++
622 installation directory (somewhere under 'Program Files').  For VC++
623 version 7 (and up?), which is also called VS.NET, the file is called
624 VSVARS32.BAT instead.
625 This needs to be done prior to running NMAKE, and the changes are only
626 valid for the current DOS session.
627
628
629 * What is special about OpenSSL on Redhat?
630
631 Red Hat Linux (release 7.0 and later) include a preinstalled limited
632 version of OpenSSL. Red Hat has chosen to disable support for IDEA, RC5 and
633 MDC2 in this version. The same may apply to other Linux distributions.
634 Users may therefore wish to install more or all of the features left out.
635
636 To do this you MUST ensure that you do not overwrite the openssl that is in
637 /usr/bin on your Red Hat machine. Several packages depend on this file,
638 including sendmail and ssh. /usr/local/bin is a good alternative choice. The
639 libraries that come with Red Hat 7.0 onwards have different names and so are
640 not affected. (eg For Red Hat 7.2 they are /lib/libssl.so.0.9.6b and
641 /lib/libcrypto.so.0.9.6b with symlinks /lib/libssl.so.2 and
642 /lib/libcrypto.so.2 respectively).
643
644 Please note that we have been advised by Red Hat attempting to recompile the
645 openssl rpm with all the cryptography enabled will not work. All other
646 packages depend on the original Red Hat supplied openssl package. It is also
647 worth noting that due to the way Red Hat supplies its packages, updates to
648 openssl on each distribution never change the package version, only the
649 build number. For example, on Red Hat 7.1, the latest openssl package has
650 version number 0.9.6 and build number 9 even though it contains all the
651 relevant updates in packages up to and including 0.9.6b.
652
653 A possible way around this is to persuade Red Hat to produce a non-US
654 version of Red Hat Linux.
655
656
657 * Why does the OpenSSL compilation fail on MacOS X?
658
659 If the failure happens when trying to build the "openssl" binary, with
660 a large number of undefined symbols, it's very probable that you have
661 OpenSSL 0.9.6b delivered with the operating system (you can find out by
662 running '/usr/bin/openssl version') and that you were trying to build
663 OpenSSL 0.9.7 or newer.  The problem is that the loader ('ld') in
664 MacOS X has a misfeature that's quite difficult to go around.
665 Look in the file PROBLEMS for a more detailed explanation and for possible
666 solutions.
667
668
669 * Why does the OpenSSL test suite fail on MacOS X?
670
671 If the failure happens when running 'make test' and the RC4 test fails,
672 it's very probable that you have OpenSSL 0.9.6b delivered with the
673 operating system (you can find out by running '/usr/bin/openssl version')
674 and that you were trying to build OpenSSL 0.9.6d.  The problem is that
675 the loader ('ld') in MacOS X has a misfeature that's quite difficult to
676 go around and has linked the programs "openssl" and the test programs
677 with /usr/lib/libcrypto.dylib and /usr/lib/libssl.dylib instead of the
678 libraries you just built.
679 Look in the file PROBLEMS for a more detailed explanation and for possible
680 solutions.
681
682 * Why does the OpenSSL test suite fail in BN_sqr test [on a 64-bit platform]?
683
684 Failure in BN_sqr test is most likely caused by a failure to configure the
685 toolkit for current platform or lack of support for the platform in question.
686 Run './config -t' and './apps/openssl version -p'. Do these platform
687 identifiers match? If they don't, then you most likely failed to run
688 ./config and you're hereby advised to do so before filing a bug report.
689 If ./config itself fails to run, then it's most likely problem with your
690 local environment and you should turn to your system administrator (or
691 similar). If identifiers match (and/or no alternative identifier is
692 suggested by ./config script), then the platform is unsupported. There might
693 or might not be a workaround. Most notably on SPARC64 platforms with GNU
694 C compiler you should be able to produce a working build by running
695 './config -m32'. I understand that -m32 might not be what you want/need,
696 but the build should be operational. For further details turn to
697 <openssl-dev@openssl.org>.
698
699 * Why does OpenBSD-i386 build fail on des-586.s with "Unimplemented segment type"?
700
701 As of 0.9.7 assembler routines were overhauled for position independence
702 of the machine code, which is essential for shared library support. For
703 some reason OpenBSD is equipped with an out-of-date GNU assembler which
704 finds the new code offensive. To work around the problem, configure with
705 no-asm (and sacrifice a great deal of performance) or patch your assembler
706 according to <URL: http://www.openssl.org/~appro/gas-1.92.3.OpenBSD.patch>.
707 For your convenience a pre-compiled replacement binary is provided at
708 <URL: http://www.openssl.org/~appro/gas-1.92.3.static.aout.bin>.
709 Reportedly elder *BSD a.out platforms also suffer from this problem and
710 remedy should be same. Provided binary is statically linked and should be
711 working across wider range of *BSD branches, not just OpenBSD.
712
713 * Why does the OpenSSL test suite fail in sha512t on x86 CPU?
714
715 If the test program in question fails withs SIGILL, Illegal Instruction
716 exception, then you more than likely to run SSE2-capable CPU, such as
717 Intel P4, under control of kernel which does not support SSE2
718 instruction extensions. See accompanying INSTALL file and
719 OPENSSL_ia32cap(3) documentation page for further information.
720
721 * Why does compiler fail to compile sha512.c?
722
723 OpenSSL SHA-512 implementation depends on compiler support for 64-bit
724 integer type. Few elder compilers [ULTRIX cc, SCO compiler to mention a
725 couple] lack support for this and therefore are incapable of compiling
726 the module in question. The recommendation is to disable SHA-512 by
727 adding no-sha512 to ./config [or ./Configure] command line. Another
728 possible alternative might be to switch to GCC.
729
730 * Test suite still fails, what to do?
731
732 Another common reason for failure to complete some particular test is
733 simply bad code generated by a buggy component in toolchain or deficiency
734 in run-time environment. There are few cases documented in PROBLEMS file,
735 consult it for possible workaround before you beat the drum. Even if you
736 don't find solution or even mention there, do reserve for possibility of
737 a compiler bug. Compiler bugs might appear in rather bizarre ways, they
738 never make sense, and tend to emerge when you least expect them. In order
739 to identify one, drop optimization level, e.g. by editing CFLAG line in
740 top-level Makefile, recompile and re-run the test.
741
742
743 * I think I've found a bug, what should I do?
744
745 If you are a new user then it is quite likely you haven't found a bug and
746 something is happening you aren't familiar with. Check this FAQ, the associated
747 documentation and the mailing lists for similar queries. If you are still
748 unsure whether it is a bug or not submit a query to the openssl-users mailing
749 list.
750
751 If you think you have found a bug based on the output of static analysis tools
752 then please manually check the issue is genuine. Such tools can produce a
753 LOT of false positives.
754
755
756 * I'm SURE I've found a bug, how do I report it?
757
758 To avoid duplicated reports check the mailing lists and release notes for the
759 relevant version of OpenSSL to see if the problem has been reported already.
760
761 Bug reports with no security implications should be sent to the request
762 tracker. This can be done by mailing the report to <rt@openssl.org> (or its
763 alias <openssl-bugs@openssl.org>), please note that messages sent to the
764 request tracker also appear in the public openssl-dev mailing list.
765
766 The report should be in plain text. Any patches should be sent as
767 plain text attachments because some mailers corrupt patches sent inline.
768 If your issue affects multiple versions of OpenSSL check any patches apply
769 cleanly and, if possible include patches to each affected version.
770
771 The report should be given a meaningful subject line briefly summarising the
772 issue. Just "bug in OpenSSL" or "bug in OpenSSL 0.9.8n" is not very helpful.
773
774 By sending reports to the request tracker the bug can then be given a priority
775 and assigned to the appropriate maintainer. The history of discussions can be
776 accessed and if the issue has been addressed or a reason why not. If patches
777 are only sent to openssl-dev they can be mislaid if a team member has to
778 wade through months of old messages to review the discussion.
779
780 See also <URL: http://www.openssl.org/support/rt.html>
781
782
783 * I've found a security issue, how do I report it?
784
785 If you think your bug has security implications then please send it to
786 openssl-security@openssl.org if you don't get a prompt reply at least 
787 acknowledging receipt then resend or mail it directly to one of the
788 more active team members (e.g. Steve). If you wish to use PGP to send
789 in a report please use one or more of the keys of the team members listed
790 at <URL: http://www.openssl.org/about/>
791
792 [PROG] ========================================================================
793
794 * Is OpenSSL thread-safe?
795
796 Yes (with limitations: an SSL connection may not concurrently be used
797 by multiple threads).  On Windows and many Unix systems, OpenSSL
798 automatically uses the multi-threaded versions of the standard
799 libraries.  If your platform is not one of these, consult the INSTALL
800 file.
801
802 Multi-threaded applications must provide two callback functions to
803 OpenSSL by calling CRYPTO_set_locking_callback() and
804 CRYPTO_set_id_callback(), for all versions of OpenSSL up to and
805 including 0.9.8[abc...]. As of version 1.0.0, CRYPTO_set_id_callback()
806 and associated APIs are deprecated by CRYPTO_THREADID_set_callback()
807 and friends. This is described in the threads(3) manpage.
808
809 * I've compiled a program under Windows and it crashes: why?
810
811 This is usually because you've missed the comment in INSTALL.W32.
812 Your application must link against the same version of the Win32
813 C-Runtime against which your openssl libraries were linked.  The
814 default version for OpenSSL is /MD - "Multithreaded DLL".
815
816 If you are using Microsoft Visual C++'s IDE (Visual Studio), in
817 many cases, your new project most likely defaulted to "Debug
818 Singlethreaded" - /ML.  This is NOT interchangeable with /MD and your
819 program will crash, typically on the first BIO related read or write
820 operation.
821
822 For each of the six possible link stage configurations within Win32,
823 your application must link  against the same by which OpenSSL was
824 built.  If you are using MS Visual C++ (Studio) this can be changed
825 by:
826
827  1. Select Settings... from the Project Menu.
828  2. Select the C/C++ Tab.
829  3. Select "Code Generation from the "Category" drop down list box
830  4. Select the Appropriate library (see table below) from the "Use
831     run-time library" drop down list box.  Perform this step for both
832     your debug and release versions of your application (look at the
833     top left of the settings panel to change between the two)
834
835     Single Threaded           /ML        -  MS VC++ often defaults to
836                                             this for the release
837                                             version of a new project.
838     Debug Single Threaded     /MLd       -  MS VC++ often defaults to
839                                             this for the debug version
840                                             of a new project.
841     Multithreaded             /MT
842     Debug Multithreaded       /MTd
843     Multithreaded DLL         /MD        -  OpenSSL defaults to this.
844     Debug Multithreaded DLL   /MDd
845
846 Note that debug and release libraries are NOT interchangeable.  If you
847 built OpenSSL with /MD your application must use /MD and cannot use /MDd.
848
849 As per 0.9.8 the above limitation is eliminated for .DLLs. OpenSSL
850 .DLLs compiled with some specific run-time option [we insist on the
851 default /MD] can be deployed with application compiled with different
852 option or even different compiler. But there is a catch! Instead of
853 re-compiling OpenSSL toolkit, as you would have to with prior versions,
854 you have to compile small C snippet with compiler and/or options of
855 your choice. The snippet gets installed as
856 <install-root>/include/openssl/applink.c and should be either added to
857 your application project or simply #include-d in one [and only one]
858 of your application source files. Failure to link this shim module
859 into your application manifests itself as fatal "no OPENSSL_Applink"
860 run-time error. An explicit reminder is due that in this situation
861 [mixing compiler options] it is as important to add CRYPTO_malloc_init
862 prior first call to OpenSSL.
863
864 * How do I read or write a DER encoded buffer using the ASN1 functions?
865
866 You have two options. You can either use a memory BIO in conjunction
867 with the i2d_*_bio() or d2i_*_bio() functions or you can use the
868 i2d_*(), d2i_*() functions directly. Since these are often the
869 cause of grief here are some code fragments using PKCS7 as an example:
870
871  unsigned char *buf, *p;
872  int len;
873
874  len = i2d_PKCS7(p7, NULL);
875  buf = OPENSSL_malloc(len); /* or Malloc, error checking omitted */
876  p = buf;
877  i2d_PKCS7(p7, &p);
878
879 At this point buf contains the len bytes of the DER encoding of
880 p7.
881
882 The opposite assumes we already have len bytes in buf:
883
884  unsigned char *p;
885  p = buf;
886  p7 = d2i_PKCS7(NULL, &p, len);
887
888 At this point p7 contains a valid PKCS7 structure or NULL if an error
889 occurred. If an error occurred ERR_print_errors(bio) should give more
890 information.
891
892 The reason for the temporary variable 'p' is that the ASN1 functions
893 increment the passed pointer so it is ready to read or write the next
894 structure. This is often a cause of problems: without the temporary
895 variable the buffer pointer is changed to point just after the data
896 that has been read or written. This may well be uninitialized data
897 and attempts to free the buffer will have unpredictable results
898 because it no longer points to the same address.
899
900 Memory allocation and encoding can also be combined in a single
901 operation by the ASN1 routines:
902
903  unsigned char *buf = NULL;     /* mandatory */
904  int len;
905  len = i2d_PKCS7(p7, &buf);
906  if (len < 0)
907         /* Error */
908  /* Do some things with 'buf' */
909  /* Finished with buf: free it */
910  OPENSSL_free(buf);
911
912 In this special case the "buf" parameter is *not* incremented, it points
913 to the start of the encoding.
914
915
916 * OpenSSL uses DER but I need BER format: does OpenSSL support BER?
917
918 The short answer is yes, because DER is a special case of BER and OpenSSL
919 ASN1 decoders can process BER.
920
921 The longer answer is that ASN1 structures can be encoded in a number of
922 different ways. One set of ways is the Basic Encoding Rules (BER) with various
923 permissible encodings. A restriction of BER is the Distinguished Encoding
924 Rules (DER): these uniquely specify how a given structure is encoded.
925
926 Therefore, because DER is a special case of BER, DER is an acceptable encoding
927 for BER.
928
929
930 * I've tried using <M_some_evil_pkcs12_macro> and I get errors why?
931
932 This usually happens when you try compiling something using the PKCS#12
933 macros with a C++ compiler. There is hardly ever any need to use the
934 PKCS#12 macros in a program, it is much easier to parse and create
935 PKCS#12 files using the PKCS12_parse() and PKCS12_create() functions
936 documented in doc/openssl.txt and with examples in demos/pkcs12. The
937 'pkcs12' application has to use the macros because it prints out 
938 debugging information.
939
940
941 * I've called <some function> and it fails, why?
942
943 Before submitting a report or asking in one of the mailing lists, you
944 should try to determine the cause. In particular, you should call
945 ERR_print_errors() or ERR_print_errors_fp() after the failed call
946 and see if the message helps. Note that the problem may occur earlier
947 than you think -- you should check for errors after every call where
948 it is possible, otherwise the actual problem may be hidden because
949 some OpenSSL functions clear the error state.
950
951
952 * I just get a load of numbers for the error output, what do they mean?
953
954 The actual format is described in the ERR_print_errors() manual page.
955 You should call the function ERR_load_crypto_strings() before hand and
956 the message will be output in text form. If you can't do this (for example
957 it is a pre-compiled binary) you can use the errstr utility on the error
958 code itself (the hex digits after the second colon).
959
960
961 * Why do I get errors about unknown algorithms?
962
963 The cause is forgetting to load OpenSSL's table of algorithms with
964 OpenSSL_add_all_algorithms(). See the manual page for more information. This
965 can cause several problems such as being unable to read in an encrypted
966 PEM file, unable to decrypt a PKCS#12 file or signature failure when
967 verifying certificates.
968
969 * Why can't the OpenSSH configure script detect OpenSSL?
970
971 Several reasons for problems with the automatic detection exist.
972 OpenSSH requires at least version 0.9.5a of the OpenSSL libraries.
973 Sometimes the distribution has installed an older version in the system
974 locations that is detected instead of a new one installed. The OpenSSL
975 library might have been compiled for another CPU or another mode (32/64 bits).
976 Permissions might be wrong.
977
978 The general answer is to check the config.log file generated when running
979 the OpenSSH configure script. It should contain the detailed information
980 on why the OpenSSL library was not detected or considered incompatible.
981
982
983 * Can I use OpenSSL's SSL library with non-blocking I/O?
984
985 Yes; make sure to read the SSL_get_error(3) manual page!
986
987 A pitfall to avoid: Don't assume that SSL_read() will just read from
988 the underlying transport or that SSL_write() will just write to it --
989 it is also possible that SSL_write() cannot do any useful work until
990 there is data to read, or that SSL_read() cannot do anything until it
991 is possible to send data.  One reason for this is that the peer may
992 request a new TLS/SSL handshake at any time during the protocol,
993 requiring a bi-directional message exchange; both SSL_read() and
994 SSL_write() will try to continue any pending handshake.
995
996
997 * Why doesn't my server application receive a client certificate?
998
999 Due to the TLS protocol definition, a client will only send a certificate,
1000 if explicitly asked by the server. Use the SSL_VERIFY_PEER flag of the
1001 SSL_CTX_set_verify() function to enable the use of client certificates.
1002
1003
1004 * Why does compilation fail due to an undefined symbol NID_uniqueIdentifier?
1005
1006 For OpenSSL 0.9.7 the OID table was extended and corrected. In earlier
1007 versions, uniqueIdentifier was incorrectly used for X.509 certificates.
1008 The correct name according to RFC2256 (LDAP) is x500UniqueIdentifier.
1009 Change your code to use the new name when compiling against OpenSSL 0.9.7.
1010
1011
1012 * I think I've detected a memory leak, is this a bug?
1013
1014 In most cases the cause of an apparent memory leak is an OpenSSL internal table
1015 that is allocated when an application starts up. Since such tables do not grow
1016 in size over time they are harmless.
1017
1018 These internal tables can be freed up when an application closes using various
1019 functions.  Currently these include following:
1020
1021 Thread-local cleanup functions:
1022
1023   ERR_remove_state()
1024
1025 Application-global cleanup functions that are aware of usage (and therefore
1026 thread-safe):
1027
1028   ENGINE_cleanup() and CONF_modules_unload()
1029
1030 "Brutal" (thread-unsafe) Application-global cleanup functions:
1031
1032   ERR_free_strings(), EVP_cleanup() and CRYPTO_cleanup_all_ex_data().
1033
1034
1035 * Why does Valgrind complain about the use of uninitialized data?
1036
1037 When OpenSSL's PRNG routines are called to generate random numbers the supplied
1038 buffer contents are mixed into the entropy pool: so it technically does not
1039 matter whether the buffer is initialized at this point or not.  Valgrind (and
1040 other test tools) will complain about this. When using Valgrind, make sure the
1041 OpenSSL library has been compiled with the PURIFY macro defined (-DPURIFY)
1042 to get rid of these warnings.
1043
1044
1045 * Why doesn't a memory BIO work when a file does?
1046
1047 This can occur in several cases for example reading an S/MIME email message.
1048 The reason is that a memory BIO can do one of two things when all the data
1049 has been read from it.
1050
1051 The default behaviour is to indicate that no more data is available and that
1052 the call should be retried, this is to allow the application to fill up the BIO
1053 again if necessary.
1054
1055 Alternatively it can indicate that no more data is available and that EOF has
1056 been reached.
1057
1058 If a memory BIO is to behave in the same way as a file this second behaviour
1059 is needed. This must be done by calling:
1060
1061    BIO_set_mem_eof_return(bio, 0);
1062
1063 See the manual pages for more details.
1064
1065
1066 * Where are the declarations and implementations of d2i_X509() etc?
1067
1068 These are defined and implemented by macros of the form:
1069
1070
1071  DECLARE_ASN1_FUNCTIONS(X509) and IMPLEMENT_ASN1_FUNCTIONS(X509)
1072
1073 The implementation passes an ASN1 "template" defining the structure into an
1074 ASN1 interpreter using generalised functions such as ASN1_item_d2i().
1075
1076 * When debugging I observe SIGILL during OpenSSL initialization: why?
1077
1078 OpenSSL adapts to processor it executes on and for this reason has to
1079 query its capabilities. Unfortunately on some processors the only way
1080 to achieve this for non-privileged code is to attempt instructions
1081 that can cause Illegal Instruction exceptions. The initialization
1082 procedure is coded to handle these exceptions to manipulate corresponding
1083 bits in capabilities vector. This normally appears transparent, except
1084 when you execute it under debugger, which stops prior delivering signal
1085 to handler. Simply resuming execution does the trick, but when debugging
1086 a lot it might feel counterproductive. Two options. Either set explicit
1087 capability environment variable in order to bypass the capability query
1088 (see corresponding crypto/*cap.c for details). Or configure debugger not
1089 to stop upon SIGILL exception, e.g. in gdb case add 'handle SIGILL nostop'
1090 to your .gdbinit.
1091
1092 ===============================================================================