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