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