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