Correct a couple of command errors.
[openssl.git] / FAQ
1 OpenSSL  -  Frequently Asked Questions
2 --------------------------------------
3
4 * Which is the current version of OpenSSL?
5 * Where is the documentation?
6 * How can I contact the OpenSSL developers?
7 * Do I need patent licenses to use OpenSSL?
8 * Is OpenSSL thread-safe?
9 * Why do I get a "PRNG not seeded" error message?
10 * Why does the linker complain about undefined symbols?
11 * Where can I get a compiled version of OpenSSL?
12
13
14 * Which is the current version of OpenSSL?
15
16 The current version is available from <URL: http://www.openssl.org>.
17 OpenSSL 0.9.4 was released on August 9th, 1999.
18
19 In addition to the current stable release, you can also access daily
20 snapshots of the OpenSSL development version at <URL:
21 ftp://ftp.openssl.org/snapshot/>, or get it by anonymous CVS access.
22
23
24 * Where is the documentation?
25
26 OpenSSL is a library that provides cryptographic functionality to
27 applications such as secure web servers.  Be sure to read the
28 documentation of the application you want to use.  The INSTALL file
29 explains how to install this library.
30
31 OpenSSL includes a command line utility that can be used to perform a
32 variety of cryptographic functions.  It is described in the openssl(1)
33 manpage.  Documentation for developers is currently being written.  A
34 few manual pages already are available; overviews over libcrypto and
35 libssl are given in the crypto(3) and ssl(3) manpages.
36
37 The OpenSSL manpages are installed in /usr/local/ssl/man/ (or a
38 different directory if you specified one as described in INSTALL).
39 In addition, you can read the most current versions at
40 <URL: http://www.openssl.org/docs/>.
41
42 For information on parts of libcrypto that are not yet documented, you
43 might want to read Ariel Glenn's documentation on SSLeay 0.9, OpenSSL's
44 predecessor, at <URL: http://www.columbia.edu/~ariel/ssleay/>.  Much
45 of this still applies to OpenSSL.
46
47 The original SSLeay documentation is included in OpenSSL as
48 doc/ssleay.txt.  It may be useful when none of the other ressources
49 help, but please note that it reflects the obsolete version SSLeay
50 0.6.6.
51
52
53 * How can I contact the OpenSSL developers?
54
55 The README file describes how to submit bug reports and patches to
56 OpenSSL.  Information on the OpenSSL mailing lists is available from
57 <URL: http://www.openssl.org>.
58
59
60 * Do I need patent licenses to use OpenSSL?
61
62 The patents section of the README file lists patents that may apply to
63 you if you want to use OpenSSL.  For information on intellectual
64 property rights, please consult a lawyer.  The OpenSSL team does not
65 offer legal advice.
66
67 You can configure OpenSSL so as not to use RC5 and IDEA by using
68  ./config no-rc5 no-idea
69
70 Until the RSA patent expires, U.S. users may want to use
71  ./config no-rc5 no-idea no-rsa
72
73 Please note that you will *not* be able to communicate with most of
74 the popular web browsers without RSA support.
75
76
77 * Is OpenSSL thread-safe?
78
79 Yes.  On Windows and many Unix systems, OpenSSL automatically uses the
80 multi-threaded versions of the standard libraries.  If your platform
81 is not one of these, consult the INSTALL file.
82
83 Multi-threaded applications must provide two callback functions to
84 OpenSSL.  This is described in the threads(3) manpage.
85
86
87 * Why do I get a "PRNG not seeded" error message?
88
89 Cryptographic software needs a source of unpredictable data to work
90 correctly.  Many open source operating systems provide a "randomness
91 device" that serves this purpose.  On other systems, applications have
92 to call the RAND_add() or RAND_seed() function with appropriate data
93 before generating keys or performing public key encryption.
94
95 Some broken applications do not do this.  As of version 0.9.5, the
96 OpenSSL functions that need randomness report an error if the random
97 number generator has not been seeded with at least 128 bits of
98 randomness.  If this error occurs, please contact the author of the
99 application you are using.  It is likely that it never worked
100 correctly.  OpenSSL 0.9.5 makes the error visible by refusing to
101 perform potentially insecure encryption.
102
103
104 * Why does the linker complain about undefined symbols?
105
106 Maybe the compilation was interruped, and make doesn't notice that
107 something is missing.  Run "make clean; make".
108
109 If you used ./Configure instead of ./config, make sure that you
110 selected the right target.  File formats may differ slightly between
111 OS versions (for example sparcv8/sparcv9, or a.out/elf).
112
113 If that doesn't help, you may want to try using the current snapshot.
114 If the problem persists, please submit a bug report.
115
116
117 * Where can I get a compiled version of OpenSSL?
118
119 Some applications that use OpenSSL are distributed in binary form.
120 When using such an application, you don't need to install OpenSSL
121 yourself; the application will include the required parts (e.g. DLLs).
122
123 If you want to install OpenSSL on a Windows system and you don't have
124 a C compiler, read the "Mingw32" section of INSTALL.W32 for information
125 on how to obtain and install the free GNU C compiler.
126
127 A number of Linux and *BSD distributions include OpenSSL.