threads mapage.
[openssl.git] / FAQ
1 OpenSSL  -  Frequently Asked Questions
2 --------------------------------------
3
4 * Where is the documentation?
5 * How can I contact the OpenSSL developers?
6 * Do I need patent licenses to use OpenSSL?
7 * Is OpenSSL thread-safe?
8 * Why do I get a "PRNG not seeded" error message?
9
10
11 * Where is the documentation?
12
13 OpenSSL is a library that provides cryptographic functionality to
14 applications such as secure web servers.  Be sure to read the
15 documentation of the application you want to use.  The INSTALL file
16 explains how to install this library.
17
18 OpenSSL includes a command line utility that can be used to perform a
19 variety of cryptographic functions.  It is described in the openssl(1)
20 manpage.  Documentation for developers is currently being written.  A
21 few manual pages already are available; overviews over libcrypto and
22 libssl are given in the crypto(3) and ssl(3) manpages.
23
24 The OpenSSL manpages are installed in /usr/local/ssl/man/ (or a
25 different directory if you specified one as described in INSTALL).
26 In addition, you can read the most current versions at
27 <URL: http://www.openssl.org/docs/>.
28
29 For information on parts of libcrypto that are not yet documented, you
30 might want to read Ariel Glenn's documentation on SSLeay 0.9, OpenSSL's
31 predecessor, at <URL: http://www.columbia.edu/~ariel/ssleay/>.  Much
32 of this still applies to OpenSSL.
33
34 The original SSLeay documentation is included in OpenSSL as
35 doc/ssleay.txt.  It may be useful when none of the other ressources
36 help, but please note that it reflects the obsolete version SSLeay
37 0.6.6.
38
39
40 * How can I contact the OpenSSL developers?
41
42 The README file describes how to submit bug reports and patches to
43 OpenSSL.  Information on the OpenSSL mailing lists is available from
44 <URL: http://www.openssl.org>.
45
46
47 * Do I need patent licenses to use OpenSSL?
48
49 The patents section of the README file lists patents that may apply to
50 you if you want to use OpenSSL.  For information on intellectual
51 property rights, please consult a lawyer.  The OpenSSL team does not
52 offer legal advice.
53
54 You can configure OpenSSL so as not to use RC5 and IDEA by using
55  ./config no-rc5 no-idea
56
57 Until the RSA patent expires, U.S. users may want to use
58  ./config no-rc5 no-idea no-rsa
59
60 Please note that you will *not* be able to communicate with most of
61 the popular web browsers without RSA support.
62
63
64 * Is OpenSSL thread-safe?
65
66 Yes.  On Windows and many Unix systems, OpenSSL automatically uses the
67 multi-threaded versions of the standard libraries.  If your platform
68 is not one of these, consult the INSTALL file.
69
70 Multi-threaded applications must provide two callback functions to
71 OpenSSL.  This is described in the threads(3) manpage.
72
73
74 * Why do I get a "PRNG not seeded" error message?
75
76 Cryptographic software needs a source of unpredictable data to work
77 correctly.  Many open source operating systems provide a "randomness
78 device" that serves this purpose.  On other systems, applications have
79 to call the RAND_add() or RAND_seed() function with appropriate data
80 before generating keys or performing public key encryption.
81
82 Some broken applications do not do this.  As of version 0.9.5, the
83 OpenSSL functions that need randomness report an error if the random
84 number generator has not been seeded with at least 128 bits of
85 randomness.  If this error occurs, please contact the author of the
86 application you are using.  It is likely that it never worked
87 correctly.  OpenSSL 0.9.5 makes the error visible by refusing to
88 perform potentially insecure encryption.