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