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