In UI_UTIL_read_pw(), we should look at the size parameter, not at BUFSIZ.
[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
13 [LEGAL] Legal questions
14
15 * Do I need patent licenses to use OpenSSL?
16 * Can I use OpenSSL with GPL software? 
17
18 [USER] Questions on using the OpenSSL applications
19
20 * Why do I get a "PRNG not seeded" error message?
21 * Why do I get an "unable to write 'random state'" error message?
22 * How do I create certificates or certificate requests?
23 * Why can't I create certificate requests?
24 * Why does <SSL program> fail with a certificate verify error?
25 * Why can I only use weak ciphers when I connect to a server using OpenSSL?
26 * How can I create DSA certificates?
27 * Why can't I make an SSL connection using a DSA certificate?
28 * How can I remove the passphrase on a private key?
29 * Why can't I use OpenSSL certificates with SSL client authentication?
30 * Why does my browser give a warning about a mismatched hostname?
31 * How do I install a CA certificate into a browser?
32 * Why is OpenSSL x509 DN output not conformant to RFC2253?
33
34 [BUILD] Questions about building and testing OpenSSL
35
36 * Why does the linker complain about undefined symbols?
37 * Why does the OpenSSL test fail with "bc: command not found"?
38 * Why does the OpenSSL test fail with "bc: 1 no implemented"?
39 * Why does the OpenSSL compilation fail on Alpha Tru64 Unix?
40 * Why does the OpenSSL compilation fail with "ar: command not found"?
41 * Why does the OpenSSL compilation fail on Win32 with VC++?
42 * What is special about OpenSSL on Redhat?
43
44 [PROG] Questions about programming with OpenSSL
45
46 * Is OpenSSL thread-safe?
47 * I've compiled a program under Windows and it crashes: why?
48 * How do I read or write a DER encoded buffer using the ASN1 functions?
49 * I've tried using <M_some_evil_pkcs12_macro> and I get errors why?
50 * I've called <some function> and it fails, why?
51 * I just get a load of numbers for the error output, what do they mean?
52 * Why do I get errors about unknown algorithms?
53 * Why can't the OpenSSH configure script detect OpenSSL?
54 * Can I use OpenSSL's SSL library with non-blocking I/O?
55 * Why doesn't my server application receive a client certificate?
56 * Why does compilation fail due to an undefined symbol NID_uniqueIdentifier?
57
58 ===============================================================================
59
60 [MISC] ========================================================================
61
62 * Which is the current version of OpenSSL?
63
64 The current version is available from <URL: http://www.openssl.org>.
65 OpenSSL 0.9.6d was released on May 9, 2002.
66
67 In addition to the current stable release, you can also access daily
68 snapshots of the OpenSSL development version at <URL:
69 ftp://ftp.openssl.org/snapshot/>, or get it by anonymous CVS access.
70
71
72 * Where is the documentation?
73
74 OpenSSL is a library that provides cryptographic functionality to
75 applications such as secure web servers.  Be sure to read the
76 documentation of the application you want to use.  The INSTALL file
77 explains how to install this library.
78
79 OpenSSL includes a command line utility that can be used to perform a
80 variety of cryptographic functions.  It is described in the openssl(1)
81 manpage.  Documentation for developers is currently being written.  A
82 few manual pages already are available; overviews over libcrypto and
83 libssl are given in the crypto(3) and ssl(3) manpages.
84
85 The OpenSSL manpages are installed in /usr/local/ssl/man/ (or a
86 different directory if you specified one as described in INSTALL).
87 In addition, you can read the most current versions at
88 <URL: http://www.openssl.org/docs/>.
89
90 For information on parts of libcrypto that are not yet documented, you
91 might want to read Ariel Glenn's documentation on SSLeay 0.9, OpenSSL's
92 predecessor, at <URL: http://www.columbia.edu/~ariel/ssleay/>.  Much
93 of this still applies to OpenSSL.
94
95 There is some documentation about certificate extensions and PKCS#12
96 in doc/openssl.txt
97
98 The original SSLeay documentation is included in OpenSSL as
99 doc/ssleay.txt.  It may be useful when none of the other resources
100 help, but please note that it reflects the obsolete version SSLeay
101 0.6.6.
102
103
104 * How can I contact the OpenSSL developers?
105
106 The README file describes how to submit bug reports and patches to
107 OpenSSL.  Information on the OpenSSL mailing lists is available from
108 <URL: http://www.openssl.org>.
109
110
111 * Where can I get a compiled version of OpenSSL?
112
113 Some applications that use OpenSSL are distributed in binary form.
114 When using such an application, you don't need to install OpenSSL
115 yourself; the application will include the required parts (e.g. DLLs).
116
117 If you want to install OpenSSL on a Windows system and you don't have
118 a C compiler, read the "Mingw32" section of INSTALL.W32 for information
119 on how to obtain and install the free GNU C compiler.
120
121 A number of Linux and *BSD distributions include OpenSSL.
122
123
124 * Why aren't tools like 'autoconf' and 'libtool' used?
125
126 autoconf will probably be used in future OpenSSL versions. If it was
127 less Unix-centric, it might have been used much earlier.
128
129 * What is an 'engine' version?
130
131 With version 0.9.6 OpenSSL was extended to interface to external crypto
132 hardware. This was realized in a special release '0.9.6-engine'. With
133 version 0.9.7 (not yet released) the changes were merged into the main
134 development line, so that the special release is no longer necessary.
135
136 [LEGAL] =======================================================================
137
138 * Do I need patent licenses to use OpenSSL?
139
140 The patents section of the README file lists patents that may apply to
141 you if you want to use OpenSSL.  For information on intellectual
142 property rights, please consult a lawyer.  The OpenSSL team does not
143 offer legal advice.
144
145 You can configure OpenSSL so as not to use RC5 and IDEA by using
146  ./config no-rc5 no-idea
147
148
149 * Can I use OpenSSL with GPL software?
150
151 On many systems including the major Linux and BSD distributions, yes (the
152 GPL does not place restrictions on using libraries that are part of the
153 normal operating system distribution).
154
155 On other systems, the situation is less clear. Some GPL software copyright
156 holders claim that you infringe on their rights if you use OpenSSL with
157 their software on operating systems that don't normally include OpenSSL.
158
159 If you develop open source software that uses OpenSSL, you may find it
160 useful to choose an other license than the GPL, or state explicitly that
161 "This program is released under the GPL with the additional exemption that
162 compiling, linking, and/or using OpenSSL is allowed."  If you are using
163 GPL software developed by others, you may want to ask the copyright holder
164 for permission to use their software with OpenSSL.
165
166
167 [USER] ========================================================================
168
169 * Why do I get a "PRNG not seeded" error message?
170
171 Cryptographic software needs a source of unpredictable data to work
172 correctly.  Many open source operating systems provide a "randomness
173 device" that serves this purpose.  On other systems, applications have
174 to call the RAND_add() or RAND_seed() function with appropriate data
175 before generating keys or performing public key encryption.
176 (These functions initialize the pseudo-random number generator, PRNG.)
177
178 Some broken applications do not do this.  As of version 0.9.5, the
179 OpenSSL functions that need randomness report an error if the random
180 number generator has not been seeded with at least 128 bits of
181 randomness.  If this error occurs, please contact the author of the
182 application you are using.  It is likely that it never worked
183 correctly.  OpenSSL 0.9.5 and later make the error visible by refusing
184 to perform potentially insecure encryption.
185
186 On systems without /dev/urandom and /dev/random, it is a good idea to
187 use the Entropy Gathering Demon (EGD); see the RAND_egd() manpage for
188 details.  Starting with version 0.9.7, OpenSSL will automatically look
189 for an EGD socket at /var/run/egd-pool, /dev/egd-pool, /etc/egd-pool and
190 /etc/entropy.
191
192 Most components of the openssl command line utility automatically try
193 to seed the random number generator from a file.  The name of the
194 default seeding file is determined as follows: If environment variable
195 RANDFILE is set, then it names the seeding file.  Otherwise if
196 environment variable HOME is set, then the seeding file is $HOME/.rnd.
197 If neither RANDFILE nor HOME is set, versions up to OpenSSL 0.9.6 will
198 use file .rnd in the current directory while OpenSSL 0.9.6a uses no
199 default seeding file at all.  OpenSSL 0.9.6b and later will behave
200 similarly to 0.9.6a, but will use a default of "C:\" for HOME on
201 Windows systems if the environment variable has not been set.
202
203 If the default seeding file does not exist or is too short, the "PRNG
204 not seeded" error message may occur.
205
206 The openssl command line utility will write back a new state to the
207 default seeding file (and create this file if necessary) unless
208 there was no sufficient seeding.
209
210 Pointing $RANDFILE to an Entropy Gathering Daemon socket does not work.
211 Use the "-rand" option of the OpenSSL command line tools instead.
212 The $RANDFILE environment variable and $HOME/.rnd are only used by the
213 OpenSSL command line tools. Applications using the OpenSSL library
214 provide their own configuration options to specify the entropy source,
215 please check out the documentation coming the with application.
216
217 For Solaris 2.6, Tim Nibbe <tnibbe@sprint.net> and others have suggested
218 installing the SUNski package from Sun patch 105710-01 (Sparc) which
219 adds a /dev/random device and make sure it gets used, usually through
220 $RANDFILE.  There are probably similar patches for the other Solaris
221 versions.  An official statement from Sun with respect to /dev/random
222 support can be found at
223   http://sunsolve.sun.com/pub-cgi/retrieve.pl?doc=fsrdb/27606&zone_32=SUNWski
224 However, be warned that /dev/random is usually a blocking device, which
225 may have some effects on OpenSSL.
226
227
228 * Why do I get an "unable to write 'random state'" error message?
229
230
231 Sometimes the openssl command line utility does not abort with
232 a "PRNG not seeded" error message, but complains that it is
233 "unable to write 'random state'".  This message refers to the
234 default seeding file (see previous answer).  A possible reason
235 is that no default filename is known because neither RANDFILE
236 nor HOME is set.  (Versions up to 0.9.6 used file ".rnd" in the
237 current directory in this case, but this has changed with 0.9.6a.)
238
239
240 * How do I create certificates or certificate requests?
241
242 Check out the CA.pl(1) manual page. This provides a simple wrapper round
243 the 'req', 'verify', 'ca' and 'pkcs12' utilities. For finer control check
244 out the manual pages for the individual utilities and the certificate
245 extensions documentation (currently in doc/openssl.txt).
246
247
248 * Why can't I create certificate requests?
249
250 You typically get the error:
251
252         unable to find 'distinguished_name' in config
253         problems making Certificate Request
254
255 This is because it can't find the configuration file. Check out the
256 DIAGNOSTICS section of req(1) for more information.
257
258
259 * Why does <SSL program> fail with a certificate verify error?
260
261 This problem is usually indicated by log messages saying something like
262 "unable to get local issuer certificate" or "self signed certificate".
263 When a certificate is verified its root CA must be "trusted" by OpenSSL
264 this typically means that the CA certificate must be placed in a directory
265 or file and the relevant program configured to read it. The OpenSSL program
266 'verify' behaves in a similar way and issues similar error messages: check
267 the verify(1) program manual page for more information.
268
269
270 * Why can I only use weak ciphers when I connect to a server using OpenSSL?
271
272 This is almost certainly because you are using an old "export grade" browser
273 which only supports weak encryption. Upgrade your browser to support 128 bit
274 ciphers.
275
276
277 * How can I create DSA certificates?
278
279 Check the CA.pl(1) manual page for a DSA certificate example.
280
281
282 * Why can't I make an SSL connection to a server using a DSA certificate?
283
284 Typically you'll see a message saying there are no shared ciphers when
285 the same setup works fine with an RSA certificate. There are two possible
286 causes. The client may not support connections to DSA servers most web
287 browsers (including Netscape and MSIE) only support connections to servers
288 supporting RSA cipher suites. The other cause is that a set of DH parameters
289 has not been supplied to the server. DH parameters can be created with the
290 dhparam(1) command and loaded using the SSL_CTX_set_tmp_dh() for example:
291 check the source to s_server in apps/s_server.c for an example.
292
293
294 * How can I remove the passphrase on a private key?
295
296 Firstly you should be really *really* sure you want to do this. Leaving
297 a private key unencrypted is a major security risk. If you decide that
298 you do have to do this check the EXAMPLES sections of the rsa(1) and
299 dsa(1) manual pages.
300
301
302 * Why can't I use OpenSSL certificates with SSL client authentication?
303
304 What will typically happen is that when a server requests authentication
305 it will either not include your certificate or tell you that you have
306 no client certificates (Netscape) or present you with an empty list box
307 (MSIE). The reason for this is that when a server requests a client
308 certificate it includes a list of CAs names which it will accept. Browsers
309 will only let you select certificates from the list on the grounds that
310 there is little point presenting a certificate which the server will
311 reject.
312
313 The solution is to add the relevant CA certificate to your servers "trusted
314 CA list". How you do this depends on the server software in uses. You can
315 print out the servers list of acceptable CAs using the OpenSSL s_client tool:
316
317 openssl s_client -connect www.some.host:443 -prexit
318
319 If your server only requests certificates on certain URLs then you may need
320 to manually issue an HTTP GET command to get the list when s_client connects:
321
322 GET /some/page/needing/a/certificate.html
323
324 If your CA does not appear in the list then this confirms the problem.
325
326
327 * Why does my browser give a warning about a mismatched hostname?
328
329 Browsers expect the server's hostname to match the value in the commonName
330 (CN) field of the certificate. If it does not then you get a warning.
331
332
333 * How do I install a CA certificate into a browser?
334
335 The usual way is to send the DER encoded certificate to the browser as
336 MIME type application/x-x509-ca-cert, for example by clicking on an appropriate
337 link. On MSIE certain extensions such as .der or .cacert may also work, or you
338 can import the certificate using the certificate import wizard.
339
340 You can convert a certificate to DER form using the command:
341
342 openssl x509 -in ca.pem -outform DER -out ca.der
343
344 Occasionally someone suggests using a command such as:
345
346 openssl pkcs12 -export -out cacert.p12 -in cacert.pem -inkey cakey.pem
347
348 DO NOT DO THIS! This command will give away your CAs private key and
349 reduces its security to zero: allowing anyone to forge certificates in
350 whatever name they choose.
351
352 * Why is OpenSSL x509 DN output not conformant to RFC2253?
353
354 The ways to print out the oneline format of the DN (Distinguished Name) have
355 been extended in version 0.9.7 of OpenSSL. Using the new X509_NAME_print_ex()
356 interface, the "-nameopt" option could be introduded. See the manual
357 page of the "openssl x509" commandline tool for details. The old behaviour
358 has however been left as default for the sake of compatibility.
359
360 [BUILD] =======================================================================
361
362 * Why does the linker complain about undefined symbols?
363
364 Maybe the compilation was interrupted, and make doesn't notice that
365 something is missing.  Run "make clean; make".
366
367 If you used ./Configure instead of ./config, make sure that you
368 selected the right target.  File formats may differ slightly between
369 OS versions (for example sparcv8/sparcv9, or a.out/elf).
370
371 In case you get errors about the following symbols, use the config
372 option "no-asm", as described in INSTALL:
373
374  BF_cbc_encrypt, BF_decrypt, BF_encrypt, CAST_cbc_encrypt,
375  CAST_decrypt, CAST_encrypt, RC4, RC5_32_cbc_encrypt, RC5_32_decrypt,
376  RC5_32_encrypt, bn_add_words, bn_div_words, bn_mul_add_words,
377  bn_mul_comba4, bn_mul_comba8, bn_mul_words, bn_sqr_comba4,
378  bn_sqr_comba8, bn_sqr_words, bn_sub_words, des_decrypt3,
379  des_ede3_cbc_encrypt, des_encrypt, des_encrypt2, des_encrypt3,
380  des_ncbc_encrypt, md5_block_asm_host_order, sha1_block_asm_data_order
381
382 If none of these helps, you may want to try using the current snapshot.
383 If the problem persists, please submit a bug report.
384
385
386 * Why does the OpenSSL test fail with "bc: command not found"?
387
388 You didn't install "bc", the Unix calculator.  If you want to run the
389 tests, get GNU bc from ftp://ftp.gnu.org or from your OS distributor.
390
391
392 * Why does the OpenSSL test fail with "bc: 1 no implemented"?
393
394 On some SCO installations or versions, bc has a bug that gets triggered
395 when you run the test suite (using "make test").  The message returned is
396 "bc: 1 not implemented".
397
398 The best way to deal with this is to find another implementation of bc
399 and compile/install it.  GNU bc (see http://www.gnu.org/software/software.html
400 for download instructions) can be safely used, for example.
401
402
403 * Why does the OpenSSL compilation fail on Alpha Tru64 Unix?
404
405 On some Alpha installations running Tru64 Unix and Compaq C, the compilation
406 of crypto/sha/sha_dgst.c fails with the message 'Fatal:  Insufficient virtual
407 memory to continue compilation.'  As far as the tests have shown, this may be
408 a compiler bug.  What happens is that it eats up a lot of resident memory
409 to build something, probably a table.  The problem is clearly in the
410 optimization code, because if one eliminates optimization completely (-O0),
411 the compilation goes through (and the compiler consumes about 2MB of resident
412 memory instead of 240MB or whatever one's limit is currently).
413
414 There are three options to solve this problem:
415
416 1. set your current data segment size soft limit higher.  Experience shows
417 that about 241000 kbytes seems to be enough on an AlphaServer DS10.  You do
418 this with the command 'ulimit -Sd nnnnnn', where 'nnnnnn' is the number of
419 kbytes to set the limit to.
420
421 2. If you have a hard limit that is lower than what you need and you can't
422 get it changed, you can compile all of OpenSSL with -O0 as optimization
423 level.  This is however not a very nice thing to do for those who expect to
424 get the best result from OpenSSL.  A bit more complicated solution is the
425 following:
426
427 ----- snip:start -----
428   make DIRS=crypto SDIRS=sha "`grep '^CFLAG=' Makefile.ssl | \
429        sed -e 's/ -O[0-9] / -O0 /'`"
430   rm `ls crypto/*.o crypto/sha/*.o | grep -v 'sha_dgst\.o'`
431   make
432 ----- snip:end -----
433
434 This will only compile sha_dgst.c with -O0, the rest with the optimization
435 level chosen by the configuration process.  When the above is done, do the
436 test and installation and you're set.
437
438
439 * Why does the OpenSSL compilation fail with "ar: command not found"?
440
441 Getting this message is quite usual on Solaris 2, because Sun has hidden
442 away 'ar' and other development commands in directories that aren't in
443 $PATH by default.  One of those directories is '/usr/ccs/bin'.  The
444 quickest way to fix this is to do the following (it assumes you use sh
445 or any sh-compatible shell):
446
447 ----- snip:start -----
448   PATH=${PATH}:/usr/ccs/bin; export PATH
449 ----- snip:end -----
450
451 and then redo the compilation.  What you should really do is make sure
452 '/usr/ccs/bin' is permanently in your $PATH, for example through your
453 '.profile' (again, assuming you use a sh-compatible shell).
454
455
456 * Why does the OpenSSL compilation fail on Win32 with VC++?
457
458 Sometimes, you may get reports from VC++ command line (cl) that it
459 can't find standard include files like stdio.h and other weirdnesses.
460 One possible cause is that the environment isn't correctly set up.
461 To solve that problem, one should run VCVARS32.BAT which is found in
462 the 'bin' subdirectory of the VC++ installation directory (somewhere
463 under 'Program Files').  This needs to be done prior to running NMAKE,
464 and the changes are only valid for the current DOS session.
465
466
467 * What is special about OpenSSL on Redhat?
468
469 Red Hat Linux 7.0 and following versions already have a limited version of
470 openssl already installed. This may well apply to other Linux distributions
471 also. This version does not have support for the IDEA, RC5 and MDC-2
472 algorithms as these are patented within the United States. For information
473 these patent numbers and expiry dates are:
474
475 MDC-2: 4,908,861 13/03/2007
476 IDEA:  5,214,703 25/05/2010
477 RC5:   5,724,428 03/03/2015
478
479 However, Europeans and other non-Americans may wish to install all the
480 features.
481
482 To do this you MUST ensure that you do not overwrite the openssl that is in
483 /usr/bin on your Red Hat machine. Several packages depend on this file,
484 including sendmail and ssh. /usr/local/bin is a good alternative choice. The
485 libraries that come with Red Hat 7.0 onwards have different names and so are
486 not affected. (eg For Red Hat 7.2 they are /lib/libssl.so.0.9.6b and
487 /lib/libcrypto.so.0.9.6b with symlinks /lib/libssl.so.2 and
488 /lib/libcrypto.so.2 respectively).
489
490 Please note that we have been advised by Red Hat attempting to recompile the
491 openssl rpm with all the cryptography enabled will not work. All other
492 packages depend on the original Red Hat supplied openssl package. It is also
493 worth noting that due to the way Red Hat supplies its packages, updates to
494 openssl on each distribution never change the package version, only the
495 build number. For example, on Red Hat 7.1, the latest openssl package has
496 version number 0.9.6 and build number 9 even though it contains all the
497 relevant updates in packages up to and including 0.9.6b.
498
499 A possible way around this is to persuade Red Hat to produce a non-US
500 version of Red Hat Linux.
501
502 [PROG] ========================================================================
503
504 * Is OpenSSL thread-safe?
505
506 Yes (with limitations: an SSL connection may not concurrently be used
507 by multiple threads).  On Windows and many Unix systems, OpenSSL
508 automatically uses the multi-threaded versions of the standard
509 libraries.  If your platform is not one of these, consult the INSTALL
510 file.
511
512 Multi-threaded applications must provide two callback functions to
513 OpenSSL.  This is described in the threads(3) manpage.
514
515
516 * I've compiled a program under Windows and it crashes: why?
517
518 This is usually because you've missed the comment in INSTALL.W32.
519 Your application must link against the same version of the Win32
520 C-Runtime against which your openssl libraries were linked.  The
521 default version for OpenSSL is /MD - "Multithreaded DLL".
522
523 If you are using Microsoft Visual C++'s IDE (Visual Studio), in
524 many cases, your new project most likely defaulted to "Debug
525 Singlethreaded" - /ML.  This is NOT interchangeable with /MD and your
526 program will crash, typically on the first BIO related read or write
527 operation.
528
529 For each of the six possible link stage configurations within Win32,
530 your application must link  against the same by which OpenSSL was
531 built.  If you are using MS Visual C++ (Studio) this can be changed
532 by:
533
534 1.  Select Settings... from the Project Menu.
535 2.  Select the C/C++ Tab.
536 3.  Select "Code Generation from the "Category" drop down list box
537 4.  Select the Appropriate library (see table below) from the "Use
538     run-time library" drop down list box.  Perform this step for both
539     your debug and release versions of your application (look at the
540     top left of the settings panel to change between the two)
541
542     Single Threaded           /ML        -  MS VC++ often defaults to
543                                             this for the release
544                                             version of a new project.
545     Debug Single Threaded     /MLd       -  MS VC++ often defaults to
546                                             this for the debug version
547                                             of a new project.
548     Multithreaded             /MT
549     Debug Multithreaded       /MTd
550     Multithreaded DLL         /MD        -  OpenSSL defaults to this.
551     Debug Multithreaded DLL   /MDd
552
553 Note that debug and release libraries are NOT interchangeable.  If you
554 built OpenSSL with /MD your application must use /MD and cannot use /MDd.
555
556
557 * How do I read or write a DER encoded buffer using the ASN1 functions?
558
559 You have two options. You can either use a memory BIO in conjunction
560 with the i2d_XXX_bio() or d2i_XXX_bio() functions or you can use the
561 i2d_XXX(), d2i_XXX() functions directly. Since these are often the
562 cause of grief here are some code fragments using PKCS7 as an example:
563
564 unsigned char *buf, *p;
565 int len;
566
567 len = i2d_PKCS7(p7, NULL);
568 buf = OPENSSL_malloc(len); /* or Malloc, error checking omitted */
569 p = buf;
570 i2d_PKCS7(p7, &p);
571
572 At this point buf contains the len bytes of the DER encoding of
573 p7.
574
575 The opposite assumes we already have len bytes in buf:
576
577 unsigned char *p;
578 p = buf;
579 p7 = d2i_PKCS7(NULL, &p, len);
580
581 At this point p7 contains a valid PKCS7 structure of NULL if an error
582 occurred. If an error occurred ERR_print_errors(bio) should give more
583 information.
584
585 The reason for the temporary variable 'p' is that the ASN1 functions
586 increment the passed pointer so it is ready to read or write the next
587 structure. This is often a cause of problems: without the temporary
588 variable the buffer pointer is changed to point just after the data
589 that has been read or written. This may well be uninitialized data
590 and attempts to free the buffer will have unpredictable results
591 because it no longer points to the same address.
592
593
594 * I've tried using <M_some_evil_pkcs12_macro> and I get errors why?
595
596 This usually happens when you try compiling something using the PKCS#12
597 macros with a C++ compiler. There is hardly ever any need to use the
598 PKCS#12 macros in a program, it is much easier to parse and create
599 PKCS#12 files using the PKCS12_parse() and PKCS12_create() functions
600 documented in doc/openssl.txt and with examples in demos/pkcs12. The
601 'pkcs12' application has to use the macros because it prints out 
602 debugging information.
603
604
605 * I've called <some function> and it fails, why?
606
607 Before submitting a report or asking in one of the mailing lists, you
608 should try to determine the cause. In particular, you should call
609 ERR_print_errors() or ERR_print_errors_fp() after the failed call
610 and see if the message helps. Note that the problem may occur earlier
611 than you think -- you should check for errors after every call where
612 it is possible, otherwise the actual problem may be hidden because
613 some OpenSSL functions clear the error state.
614
615
616 * I just get a load of numbers for the error output, what do they mean?
617
618 The actual format is described in the ERR_print_errors() manual page.
619 You should call the function ERR_load_crypto_strings() before hand and
620 the message will be output in text form. If you can't do this (for example
621 it is a pre-compiled binary) you can use the errstr utility on the error
622 code itself (the hex digits after the second colon).
623
624
625 * Why do I get errors about unknown algorithms?
626
627 This can happen under several circumstances such as reading in an
628 encrypted private key or attempting to decrypt a PKCS#12 file. The cause
629 is forgetting to load OpenSSL's table of algorithms with
630 OpenSSL_add_all_algorithms(). See the manual page for more information.
631
632
633 * Why can't the OpenSSH configure script detect OpenSSL?
634
635 Several reasons for problems with the automatic detection exist.
636 OpenSSH requires at least version 0.9.5a of the OpenSSL libraries.
637 Sometimes the distribution has installed an older version in the system
638 locations that is detected instead of a new one installed. The OpenSSL
639 library might have been compiled for another CPU or another mode (32/64 bits).
640 Permissions might be wrong.
641
642 The general answer is to check the config.log file generated when running
643 the OpenSSH configure script. It should contain the detailed information
644 on why the OpenSSL library was not detected or considered incompatible.
645
646 * Can I use OpenSSL's SSL library with non-blocking I/O?
647
648 Yes; make sure to read the SSL_get_error(3) manual page!
649
650 A pitfall to avoid: Don't assume that SSL_read() will just read from
651 the underlying transport or that SSL_write() will just write to it --
652 it is also possible that SSL_write() cannot do any useful work until
653 there is data to read, or that SSL_read() cannot do anything until it
654 is possible to send data.  One reason for this is that the peer may
655 request a new TLS/SSL handshake at any time during the protocol,
656 requiring a bi-directional message exchange; both SSL_read() and
657 SSL_write() will try to continue any pending handshake.
658
659
660 * Why doesn't my server application receive a client certificate?
661
662 Due to the TLS protocol definition, a client will only send a certificate,
663 if explicitly asked by the server. Use the SSL_VERIFY_PEER flag of the
664 SSL_CTX_set_verify() function to enable the use of client certificates.
665
666
667 * Why does compilation fail due to an undefined symbol NID_uniqueIdentifier?
668
669 For OpenSSL 0.9.7 the OID table was extended and corrected. In earlier
670 versions, uniqueIdentifier was incorrectly used for X.509 certificates.
671 The correct name according to RFC2256 (LDAP) is x500UniqueIdentifier.
672 Change your code to use the new name when compiling against OpenSSL 0.9.7.
673
674
675 ===============================================================================
676