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