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