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