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