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