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