update FAQ
[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 CVS 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.
113
114 For information on parts of libcrypto that are not yet documented, you
115 might want to read Ariel Glenn's documentation on SSLeay 0.9, OpenSSL's
116 predecessor, at <URL: http://www.columbia.edu/~ariel/ssleay/>.  Much
117 of this still applies to OpenSSL.
118
119 There is some documentation about certificate extensions and PKCS#12
120 in doc/openssl.txt
121
122 The original SSLeay documentation is included in OpenSSL as
123 doc/ssleay.txt.  It may be useful when none of the other resources
124 help, but please note that it reflects the obsolete version SSLeay
125 0.6.6.
126
127
128 * How can I contact the OpenSSL developers?
129
130 The README file describes how to submit bug reports and patches to
131 OpenSSL.  Information on the OpenSSL mailing lists is available from
132 <URL: http://www.openssl.org>.
133
134
135 * Where can I get a compiled version of OpenSSL?
136
137 You can finder pointers to binary distributions in
138 <URL: http://www.openssl.org/related/binaries.html> .
139
140 Some applications that use OpenSSL are distributed in binary form.
141 When using such an application, you don't need to install OpenSSL
142 yourself; the application will include the required parts (e.g. DLLs).
143
144 If you want to build OpenSSL on a Windows system and you don't have
145 a C compiler, read the "Mingw32" section of INSTALL.W32 for information
146 on how to obtain and install the free GNU C compiler.
147
148 A number of Linux and *BSD distributions include OpenSSL.
149
150
151 * Why aren't tools like 'autoconf' and 'libtool' used?
152
153 autoconf will probably be used in future OpenSSL versions. If it was
154 less Unix-centric, it might have been used much earlier.
155
156 * What is an 'engine' version?
157
158 With version 0.9.6 OpenSSL was extended to interface to external crypto
159 hardware. This was realized in a special release '0.9.6-engine'. With
160 version 0.9.7 the changes were merged into the main development line,
161 so that the special release is no longer necessary.
162
163 * How do I check the authenticity of the OpenSSL distribution?
164
165 We provide MD5 digests and ASC signatures of each tarball.
166 Use MD5 to check that a tarball from a mirror site is identical:
167
168    md5sum TARBALL | awk '{print $1;}' | cmp - TARBALL.md5
169
170 You can check authenticity using pgp or gpg. You need the OpenSSL team
171 member public key used to sign it (download it from a key server, see a
172 list of keys at <URL: http://www.openssl.org/about/>). Then
173 just do:
174
175    pgp TARBALL.asc
176
177 * How does the versioning scheme work?
178
179 After the release of OpenSSL 1.0.0 the versioning scheme changed. Letter 
180 releases (e.g. 1.0.1a) can only contain bug and security fixes and no
181 new features. Minor releases change the last number (e.g. 1.0.2) and 
182 can contain new features that retain binary compatibility. Changes to
183 the middle number are considered major releases and neither source nor
184 binary compatibility is guaranteed.
185
186 Therefore the answer to the common question "when will feature X be
187 backported to OpenSSL 1.0.0/0.9.8?" is "never" but it could appear
188 in the next minor release.
189
190 [LEGAL] =======================================================================
191
192 * Do I need patent licenses to use OpenSSL?
193
194 The patents section of the README file lists patents that may apply to
195 you if you want to use OpenSSL.  For information on intellectual
196 property rights, please consult a lawyer.  The OpenSSL team does not
197 offer legal advice.
198
199 You can configure OpenSSL so as not to use IDEA, MDC2 and RC5 by using
200  ./config no-idea no-mdc2 no-rc5
201
202
203 * Can I use OpenSSL with GPL software?
204
205 On many systems including the major Linux and BSD distributions, yes (the
206 GPL does not place restrictions on using libraries that are part of the
207 normal operating system distribution).
208
209 On other systems, the situation is less clear. Some GPL software copyright
210 holders claim that you infringe on their rights if you use OpenSSL with
211 their software on operating systems that don't normally include OpenSSL.
212
213 If you develop open source software that uses OpenSSL, you may find it
214 useful to choose an other license than the GPL, or state explicitly that
215 "This program is released under the GPL with the additional exemption that
216 compiling, linking, and/or using OpenSSL is allowed."  If you are using
217 GPL software developed by others, you may want to ask the copyright holder
218 for permission to use their software with OpenSSL.
219
220
221 [USER] ========================================================================
222
223 * Why do I get a "PRNG not seeded" error message?
224
225 Cryptographic software needs a source of unpredictable data to work
226 correctly.  Many open source operating systems provide a "randomness
227 device" (/dev/urandom or /dev/random) that serves this purpose.
228 All OpenSSL versions try to use /dev/urandom by default; starting with
229 version 0.9.7, OpenSSL also tries /dev/random if /dev/urandom is not
230 available.
231
232 On other systems, applications have to call the RAND_add() or
233 RAND_seed() function with appropriate data before generating keys or
234 performing public key encryption. (These functions initialize the
235 pseudo-random number generator, PRNG.)  Some broken applications do
236 not do this.  As of version 0.9.5, the OpenSSL functions that need
237 randomness report an error if the random number generator has not been
238 seeded with at least 128 bits of randomness.  If this error occurs and
239 is not discussed in the documentation of the application you are
240 using, please contact the author of that application; it is likely
241 that it never worked correctly.  OpenSSL 0.9.5 and later make the
242 error visible by refusing to perform potentially insecure encryption.
243
244 If you are using Solaris 8, you can add /dev/urandom and /dev/random
245 devices by installing patch 112438 (Sparc) or 112439 (x86), which are
246 available via the Patchfinder at <URL: http://sunsolve.sun.com>
247 (Solaris 9 includes these devices by default). For /dev/random support
248 for earlier Solaris versions, see Sun's statement at
249 <URL: http://sunsolve.sun.com/pub-cgi/retrieve.pl?doc=fsrdb/27606&zone_32=SUNWski>
250 (the SUNWski package is available in patch 105710).
251
252 On systems without /dev/urandom and /dev/random, it is a good idea to
253 use the Entropy Gathering Demon (EGD); see the RAND_egd() manpage for
254 details.  Starting with version 0.9.7, OpenSSL will automatically look
255 for an EGD socket at /var/run/egd-pool, /dev/egd-pool, /etc/egd-pool and
256 /etc/entropy.
257
258 Most components of the openssl command line utility automatically try
259 to seed the random number generator from a file.  The name of the
260 default seeding file is determined as follows: If environment variable
261 RANDFILE is set, then it names the seeding file.  Otherwise if
262 environment variable HOME is set, then the seeding file is $HOME/.rnd.
263 If neither RANDFILE nor HOME is set, versions up to OpenSSL 0.9.6 will
264 use file .rnd in the current directory while OpenSSL 0.9.6a uses no
265 default seeding file at all.  OpenSSL 0.9.6b and later will behave
266 similarly to 0.9.6a, but will use a default of "C:\" for HOME on
267 Windows systems if the environment variable has not been set.
268
269 If the default seeding file does not exist or is too short, the "PRNG
270 not seeded" error message may occur.
271
272 The openssl command line utility will write back a new state to the
273 default seeding file (and create this file if necessary) unless
274 there was no sufficient seeding.
275
276 Pointing $RANDFILE to an Entropy Gathering Daemon socket does not work.
277 Use the "-rand" option of the OpenSSL command line tools instead.
278 The $RANDFILE environment variable and $HOME/.rnd are only used by the
279 OpenSSL command line tools. Applications using the OpenSSL library
280 provide their own configuration options to specify the entropy source,
281 please check out the documentation coming the with application.
282
283
284 * Why do I get an "unable to write 'random state'" error message?
285
286
287 Sometimes the openssl command line utility does not abort with
288 a "PRNG not seeded" error message, but complains that it is
289 "unable to write 'random state'".  This message refers to the
290 default seeding file (see previous answer).  A possible reason
291 is that no default filename is known because neither RANDFILE
292 nor HOME is set.  (Versions up to 0.9.6 used file ".rnd" in the
293 current directory in this case, but this has changed with 0.9.6a.)
294
295
296 * How do I create certificates or certificate requests?
297
298 Check out the CA.pl(1) manual page. This provides a simple wrapper round
299 the 'req', 'verify', 'ca' and 'pkcs12' utilities. For finer control check
300 out the manual pages for the individual utilities and the certificate
301 extensions documentation (currently in doc/openssl.txt).
302
303
304 * Why can't I create certificate requests?
305
306 You typically get the error:
307
308         unable to find 'distinguished_name' in config
309         problems making Certificate Request
310
311 This is because it can't find the configuration file. Check out the
312 DIAGNOSTICS section of req(1) for more information.
313
314
315 * Why does <SSL program> fail with a certificate verify error?
316
317 This problem is usually indicated by log messages saying something like
318 "unable to get local issuer certificate" or "self signed certificate".
319 When a certificate is verified its root CA must be "trusted" by OpenSSL
320 this typically means that the CA certificate must be placed in a directory
321 or file and the relevant program configured to read it. The OpenSSL program
322 'verify' behaves in a similar way and issues similar error messages: check
323 the verify(1) program manual page for more information.
324
325
326 * Why can I only use weak ciphers when I connect to a server using OpenSSL?
327
328 This is almost certainly because you are using an old "export grade" browser
329 which only supports weak encryption. Upgrade your browser to support 128 bit
330 ciphers.
331
332
333 * How can I create DSA certificates?
334
335 Check the CA.pl(1) manual page for a DSA certificate example.
336
337
338 * Why can't I make an SSL connection to a server using a DSA certificate?
339
340 Typically you'll see a message saying there are no shared ciphers when
341 the same setup works fine with an RSA certificate. There are two possible
342 causes. The client may not support connections to DSA servers most web
343 browsers (including Netscape and MSIE) only support connections to servers
344 supporting RSA cipher suites. The other cause is that a set of DH parameters
345 has not been supplied to the server. DH parameters can be created with the
346 dhparam(1) command and loaded using the SSL_CTX_set_tmp_dh() for example:
347 check the source to s_server in apps/s_server.c for an example.
348
349
350 * How can I remove the passphrase on a private key?
351
352 Firstly you should be really *really* sure you want to do this. Leaving
353 a private key unencrypted is a major security risk. If you decide that
354 you do have to do this check the EXAMPLES sections of the rsa(1) and
355 dsa(1) manual pages.
356
357
358 * Why can't I use OpenSSL certificates with SSL client authentication?
359
360 What will typically happen is that when a server requests authentication
361 it will either not include your certificate or tell you that you have
362 no client certificates (Netscape) or present you with an empty list box
363 (MSIE). The reason for this is that when a server requests a client
364 certificate it includes a list of CAs names which it will accept. Browsers
365 will only let you select certificates from the list on the grounds that
366 there is little point presenting a certificate which the server will
367 reject.
368
369 The solution is to add the relevant CA certificate to your servers "trusted
370 CA list". How you do this depends on the server software in uses. You can
371 print out the servers list of acceptable CAs using the OpenSSL s_client tool:
372
373 openssl s_client -connect www.some.host:443 -prexit
374
375 If your server only requests certificates on certain URLs then you may need
376 to manually issue an HTTP GET command to get the list when s_client connects:
377
378 GET /some/page/needing/a/certificate.html
379
380 If your CA does not appear in the list then this confirms the problem.
381
382
383 * Why does my browser give a warning about a mismatched hostname?
384
385 Browsers expect the server's hostname to match the value in the commonName
386 (CN) field of the certificate. If it does not then you get a warning.
387
388
389 * How do I install a CA certificate into a browser?
390
391 The usual way is to send the DER encoded certificate to the browser as
392 MIME type application/x-x509-ca-cert, for example by clicking on an appropriate
393 link. On MSIE certain extensions such as .der or .cacert may also work, or you
394 can import the certificate using the certificate import wizard.
395
396 You can convert a certificate to DER form using the command:
397
398 openssl x509 -in ca.pem -outform DER -out ca.der
399
400 Occasionally someone suggests using a command such as:
401
402 openssl pkcs12 -export -out cacert.p12 -in cacert.pem -inkey cakey.pem
403
404 DO NOT DO THIS! This command will give away your CAs private key and
405 reduces its security to zero: allowing anyone to forge certificates in
406 whatever name they choose.
407
408 * Why is OpenSSL x509 DN output not conformant to RFC2253?
409
410 The ways to print out the oneline format of the DN (Distinguished Name) have
411 been extended in version 0.9.7 of OpenSSL. Using the new X509_NAME_print_ex()
412 interface, the "-nameopt" option could be introduded. See the manual
413 page of the "openssl x509" commandline tool for details. The old behaviour
414 has however been left as default for the sake of compatibility.
415
416 * What is a "128 bit certificate"? Can I create one with OpenSSL?
417
418 The term "128 bit certificate" is a highly misleading marketing term. It does
419 *not* refer to the size of the public key in the certificate! A certificate
420 containing a 128 bit RSA key would have negligible security.
421
422 There were various other names such as "magic certificates", "SGC
423 certificates", "step up certificates" etc.
424
425 You can't generally create such a certificate using OpenSSL but there is no
426 need to any more. Nowadays web browsers using unrestricted strong encryption
427 are generally available.
428
429 When there were tight restrictions on the export of strong encryption
430 software from the US only weak encryption algorithms could be freely exported
431 (initially 40 bit and then 56 bit). It was widely recognised that this was
432 inadequate. A relaxation of the rules allowed the use of strong encryption but
433 only to an authorised server.
434
435 Two slighly different techniques were developed to support this, one used by
436 Netscape was called "step up", the other used by MSIE was called "Server Gated
437 Cryptography" (SGC). When a browser initially connected to a server it would
438 check to see if the certificate contained certain extensions and was issued by
439 an authorised authority. If these test succeeded it would reconnect using
440 strong encryption.
441
442 Only certain (initially one) certificate authorities could issue the
443 certificates and they generally cost more than ordinary certificates.
444
445 Although OpenSSL can create certificates containing the appropriate extensions
446 the certificate would not come from a permitted authority and so would not
447 be recognized.
448
449 The export laws were later changed to allow almost unrestricted use of strong
450 encryption so these certificates are now obsolete.
451
452
453 * Why does OpenSSL set the authority key identifier (AKID) extension incorrectly?
454
455 It doesn't: this extension is often the cause of confusion.
456
457 Consider a certificate chain A->B->C so that A signs B and B signs C. Suppose
458 certificate C contains AKID.
459
460 The purpose of this extension is to identify the authority certificate B. This
461 can be done either by including the subject key identifier of B or its issuer
462 name and serial number.
463
464 In this latter case because it is identifying certifcate B it must contain the
465 issuer name and serial number of B.
466
467 It is often wrongly assumed that it should contain the subject name of B. If it
468 did this would be redundant information because it would duplicate the issuer
469 name of C.
470
471
472 * How can I set up a bundle of commercial root CA certificates?
473
474 The OpenSSL software is shipped without any root CA certificate as the
475 OpenSSL project does not have any policy on including or excluding
476 any specific CA and does not intend to set up such a policy. Deciding
477 about which CAs to support is up to application developers or
478 administrators.
479
480 Other projects do have other policies so you can for example extract the CA
481 bundle used by Mozilla and/or modssl as described in this article:
482
483   <URL: http://www.mail-archive.com/modssl-users@modssl.org/msg16980.html>
484
485
486 [BUILD] =======================================================================
487
488 * Why does the linker complain about undefined symbols?
489
490 Maybe the compilation was interrupted, and make doesn't notice that
491 something is missing.  Run "make clean; make".
492
493 If you used ./Configure instead of ./config, make sure that you
494 selected the right target.  File formats may differ slightly between
495 OS versions (for example sparcv8/sparcv9, or a.out/elf).
496
497 In case you get errors about the following symbols, use the config
498 option "no-asm", as described in INSTALL:
499
500  BF_cbc_encrypt, BF_decrypt, BF_encrypt, CAST_cbc_encrypt,
501  CAST_decrypt, CAST_encrypt, RC4, RC5_32_cbc_encrypt, RC5_32_decrypt,
502  RC5_32_encrypt, bn_add_words, bn_div_words, bn_mul_add_words,
503  bn_mul_comba4, bn_mul_comba8, bn_mul_words, bn_sqr_comba4,
504  bn_sqr_comba8, bn_sqr_words, bn_sub_words, des_decrypt3,
505  des_ede3_cbc_encrypt, des_encrypt, des_encrypt2, des_encrypt3,
506  des_ncbc_encrypt, md5_block_asm_host_order, sha1_block_asm_data_order
507
508 If none of these helps, you may want to try using the current snapshot.
509 If the problem persists, please submit a bug report.
510
511
512 * Why does the OpenSSL test fail with "bc: command not found"?
513
514 You didn't install "bc", the Unix calculator.  If you want to run the
515 tests, get GNU bc from ftp://ftp.gnu.org or from your OS distributor.
516
517
518 * Why does the OpenSSL test fail with "bc: 1 no implemented"?
519
520 On some SCO installations or versions, bc has a bug that gets triggered
521 when you run the test suite (using "make test").  The message returned is
522 "bc: 1 not implemented".
523
524 The best way to deal with this is to find another implementation of bc
525 and compile/install it.  GNU bc (see <URL: http://www.gnu.org/software/software.html>
526 for download instructions) can be safely used, for example.
527
528
529 * Why does the OpenSSL test fail with "bc: stack empty"?
530
531 On some DG/ux versions, bc seems to have a too small stack for calculations
532 that the OpenSSL bntest throws at it.  This gets triggered when you run the
533 test suite (using "make test").  The message returned is "bc: stack empty".
534
535 The best way to deal with this is to find another implementation of bc
536 and compile/install it.  GNU bc (see <URL: http://www.gnu.org/software/software.html>
537 for download instructions) can be safely used, for example.
538
539
540 * Why does the OpenSSL compilation fail on Alpha Tru64 Unix?
541
542 On some Alpha installations running Tru64 Unix and Compaq C, the compilation
543 of crypto/sha/sha_dgst.c fails with the message 'Fatal:  Insufficient virtual
544 memory to continue compilation.'  As far as the tests have shown, this may be
545 a compiler bug.  What happens is that it eats up a lot of resident memory
546 to build something, probably a table.  The problem is clearly in the
547 optimization code, because if one eliminates optimization completely (-O0),
548 the compilation goes through (and the compiler consumes about 2MB of resident
549 memory instead of 240MB or whatever one's limit is currently).
550
551 There are three options to solve this problem:
552
553 1. set your current data segment size soft limit higher.  Experience shows
554 that about 241000 kbytes seems to be enough on an AlphaServer DS10.  You do
555 this with the command 'ulimit -Sd nnnnnn', where 'nnnnnn' is the number of
556 kbytes to set the limit to.
557
558 2. If you have a hard limit that is lower than what you need and you can't
559 get it changed, you can compile all of OpenSSL with -O0 as optimization
560 level.  This is however not a very nice thing to do for those who expect to
561 get the best result from OpenSSL.  A bit more complicated solution is the
562 following:
563
564 ----- snip:start -----
565   make DIRS=crypto SDIRS=sha "`grep '^CFLAG=' Makefile.ssl | \
566        sed -e 's/ -O[0-9] / -O0 /'`"
567   rm `ls crypto/*.o crypto/sha/*.o | grep -v 'sha_dgst\.o'`
568   make
569 ----- snip:end -----
570
571 This will only compile sha_dgst.c with -O0, the rest with the optimization
572 level chosen by the configuration process.  When the above is done, do the
573 test and installation and you're set.
574
575 3. Reconfigure the toolkit with no-sha0 option to leave out SHA0. It 
576 should not be used and is not used in SSL/TLS nor any other recognized
577 protocol in either case.
578
579
580 * Why does the OpenSSL compilation fail with "ar: command not found"?
581
582 Getting this message is quite usual on Solaris 2, because Sun has hidden
583 away 'ar' and other development commands in directories that aren't in
584 $PATH by default.  One of those directories is '/usr/ccs/bin'.  The
585 quickest way to fix this is to do the following (it assumes you use sh
586 or any sh-compatible shell):
587
588 ----- snip:start -----
589   PATH=${PATH}:/usr/ccs/bin; export PATH
590 ----- snip:end -----
591
592 and then redo the compilation.  What you should really do is make sure
593 '/usr/ccs/bin' is permanently in your $PATH, for example through your
594 '.profile' (again, assuming you use a sh-compatible shell).
595
596
597 * Why does the OpenSSL compilation fail on Win32 with VC++?
598
599 Sometimes, you may get reports from VC++ command line (cl) that it
600 can't find standard include files like stdio.h and other weirdnesses.
601 One possible cause is that the environment isn't correctly set up.
602 To solve that problem for VC++ versions up to 6, one should run
603 VCVARS32.BAT which is found in the 'bin' subdirectory of the VC++
604 installation directory (somewhere under 'Program Files').  For VC++
605 version 7 (and up?), which is also called VS.NET, the file is called
606 VSVARS32.BAT instead.
607 This needs to be done prior to running NMAKE, and the changes are only
608 valid for the current DOS session.
609
610
611 * What is special about OpenSSL on Redhat?
612
613 Red Hat Linux (release 7.0 and later) include a preinstalled limited
614 version of OpenSSL. For patent reasons, support for IDEA, RC5 and MDC2
615 is disabled in this version. The same may apply to other Linux distributions.
616 Users may therefore wish to install more or all of the features left out.
617
618 To do this you MUST ensure that you do not overwrite the openssl that is in
619 /usr/bin on your Red Hat machine. Several packages depend on this file,
620 including sendmail and ssh. /usr/local/bin is a good alternative choice. The
621 libraries that come with Red Hat 7.0 onwards have different names and so are
622 not affected. (eg For Red Hat 7.2 they are /lib/libssl.so.0.9.6b and
623 /lib/libcrypto.so.0.9.6b with symlinks /lib/libssl.so.2 and
624 /lib/libcrypto.so.2 respectively).
625
626 Please note that we have been advised by Red Hat attempting to recompile the
627 openssl rpm with all the cryptography enabled will not work. All other
628 packages depend on the original Red Hat supplied openssl package. It is also
629 worth noting that due to the way Red Hat supplies its packages, updates to
630 openssl on each distribution never change the package version, only the
631 build number. For example, on Red Hat 7.1, the latest openssl package has
632 version number 0.9.6 and build number 9 even though it contains all the
633 relevant updates in packages up to and including 0.9.6b.
634
635 A possible way around this is to persuade Red Hat to produce a non-US
636 version of Red Hat Linux.
637
638 FYI: Patent numbers and expiry dates of US patents:
639 MDC-2: 4,908,861 13/03/2007
640 IDEA:  5,214,703 25/05/2010
641 RC5:   5,724,428 03/03/2015
642
643
644 * Why does the OpenSSL compilation fail on MacOS X?
645
646 If the failure happens when trying to build the "openssl" binary, with
647 a large number of undefined symbols, it's very probable that you have
648 OpenSSL 0.9.6b delivered with the operating system (you can find out by
649 running '/usr/bin/openssl version') and that you were trying to build
650 OpenSSL 0.9.7 or newer.  The problem is that the loader ('ld') in
651 MacOS X has a misfeature that's quite difficult to go around.
652 Look in the file PROBLEMS for a more detailed explanation and for possible
653 solutions.
654
655
656 * Why does the OpenSSL test suite fail on MacOS X?
657
658 If the failure happens when running 'make test' and the RC4 test fails,
659 it's very probable that you have OpenSSL 0.9.6b delivered with the
660 operating system (you can find out by running '/usr/bin/openssl version')
661 and that you were trying to build OpenSSL 0.9.6d.  The problem is that
662 the loader ('ld') in MacOS X has a misfeature that's quite difficult to
663 go around and has linked the programs "openssl" and the test programs
664 with /usr/lib/libcrypto.dylib and /usr/lib/libssl.dylib instead of the
665 libraries you just built.
666 Look in the file PROBLEMS for a more detailed explanation and for possible
667 solutions.
668
669 * Why does the OpenSSL test suite fail in BN_sqr test [on a 64-bit platform]?
670
671 Failure in BN_sqr test is most likely caused by a failure to configure the
672 toolkit for current platform or lack of support for the platform in question.
673 Run './config -t' and './apps/openssl version -p'. Do these platform
674 identifiers match? If they don't, then you most likely failed to run
675 ./config and you're hereby advised to do so before filing a bug report.
676 If ./config itself fails to run, then it's most likely problem with your
677 local environment and you should turn to your system administrator (or
678 similar). If identifiers match (and/or no alternative identifier is
679 suggested by ./config script), then the platform is unsupported. There might
680 or might not be a workaround. Most notably on SPARC64 platforms with GNU
681 C compiler you should be able to produce a working build by running
682 './config -m32'. I understand that -m32 might not be what you want/need,
683 but the build should be operational. For further details turn to
684 <openssl-dev@openssl.org>.
685
686 * Why does OpenBSD-i386 build fail on des-586.s with "Unimplemented segment type"?
687
688 As of 0.9.7 assembler routines were overhauled for position independence
689 of the machine code, which is essential for shared library support. For
690 some reason OpenBSD is equipped with an out-of-date GNU assembler which
691 finds the new code offensive. To work around the problem, configure with
692 no-asm (and sacrifice a great deal of performance) or patch your assembler
693 according to <URL: http://www.openssl.org/~appro/gas-1.92.3.OpenBSD.patch>.
694 For your convenience a pre-compiled replacement binary is provided at
695 <URL: http://www.openssl.org/~appro/gas-1.92.3.static.aout.bin>.
696 Reportedly elder *BSD a.out platforms also suffer from this problem and
697 remedy should be same. Provided binary is statically linked and should be
698 working across wider range of *BSD branches, not just OpenBSD.
699
700 * Why does the OpenSSL test suite fail in sha512t on x86 CPU?
701
702 If the test program in question fails withs SIGILL, Illegal Instruction
703 exception, then you more than likely to run SSE2-capable CPU, such as
704 Intel P4, under control of kernel which does not support SSE2
705 instruction extentions. See accompanying INSTALL file and
706 OPENSSL_ia32cap(3) documentation page for further information.
707
708 * Why does compiler fail to compile sha512.c?
709
710 OpenSSL SHA-512 implementation depends on compiler support for 64-bit
711 integer type. Few elder compilers [ULTRIX cc, SCO compiler to mention a
712 couple] lack support for this and therefore are incapable of compiling
713 the module in question. The recommendation is to disable SHA-512 by
714 adding no-sha512 to ./config [or ./Configure] command line. Another
715 possible alternative might be to switch to GCC.
716
717 * Test suite still fails, what to do?
718
719 Another common reason for failure to complete some particular test is
720 simply bad code generated by a buggy component in toolchain or deficiency
721 in run-time environment. There are few cases documented in PROBLEMS file,
722 consult it for possible workaround before you beat the drum. Even if you
723 don't find solution or even mention there, do reserve for possibility of
724 a compiler bug. Compiler bugs might appear in rather bizarre ways, they
725 never make sense, and tend to emerge when you least expect them. In order
726 to identify one, drop optimization level, e.g. by editing CFLAG line in
727 top-level Makefile, recompile and re-run the test.
728
729 * I think I've found a bug, what should I do?
730
731 If you are a new user then it is quite likely you haven't found a bug and
732 something is happening you aren't familiar with. Check this FAQ, the associated
733 documentation and the mailing lists for similar queries. If you are still
734 unsure whether it is a bug or not submit a query to the openssl-users mailing
735 list.
736
737
738 * I'm SURE I've found a bug, how do I report it?
739
740 Bug reports with no security implications should be sent to the request
741 tracker. This can be done by mailing the report to <rt@openssl.org> (or its
742 alias <openssl-bugs@openssl.org>), please note that messages sent to the
743 request tracker also appear in the public openssl-dev mailing list.
744
745 The report should be in plain text. Any patches should be sent as
746 plain text attachments because some mailers corrupt patches sent inline.
747 If your issue affects multiple versions of OpenSSL check any patches apply
748 cleanly and, if possible include patches to each affected version.
749
750 The report should be given a meaningful subject line briefly summarising the
751 issue. Just "bug in OpenSSL" or "bug in OpenSSL 0.9.8n" is not very helpful.
752
753 By sending reports to the request tracker the bug can then be given a priority
754 and assigned to the appropriate maintainer. The history of discussions can be
755 accessed and if the issue has been addressed or a reason why not. If patches
756 are only sent to openssl-dev they can be mislaid if a team member has to
757 wade through months of old messages to review the discussion.
758
759 See also <URL: http://www.openssl.org/support/rt.html>
760
761
762 * I've found a security issue, how do I report it?
763
764 If you think your bug has security implications then please send it to
765 openssl-security@openssl.org if you don't get a prompt reply at least 
766 acknowledging receipt then resend or mail it directly to one of the
767 more active team members (e.g. Steve).
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 ===============================================================================