Explain configuration options more completely.
[openssl.git] / INSTALL
1
2  INSTALLATION ON THE UNIX PLATFORM
3  ---------------------------------
4
5  [Installation on Windows, OpenVMS and MacOS (before MacOS X) is described
6   in INSTALL.W32, INSTALL.VMS and INSTALL.MacOS.]
7
8  To install OpenSSL, you will need:
9
10   * Perl 5
11   * an ANSI C compiler
12   * a supported Unix operating system
13
14  Quick Start
15  -----------
16
17  If you want to just get on with it, do:
18
19   $ ./config
20   $ make
21   $ make test
22   $ make install
23
24  [If any of these steps fails, see section Installation in Detail below.]
25
26  This will build and install OpenSSL in the default location, which is (for
27  historical reasons) /usr/local/ssl. If you want to install it anywhere else,
28  run config like this:
29
30   $ ./config --prefix=/usr/local --openssldir=/usr/local/openssl
31
32
33  Configuration Options
34  ---------------------
35
36  There are several options to ./config (or ./Configure) to customize
37  the build:
38
39   --prefix=DIR  Install in DIR/bin, DIR/lib, DIR/include/openssl.
40                 Configuration files used by OpenSSL will be in DIR/ssl
41                 or the directory specified by --openssldir.
42
43   --openssldir=DIR Directory for OpenSSL files. If no prefix is specified,
44                 the library files and binaries are also installed there.
45
46   rsaref        Build with RSADSI's RSAREF toolkit (this assumes that
47                 librsaref.a is in the library search path).
48
49   no-threads    Don't try to build with support for multi-threaded
50                 applications.
51
52   threads       Build with support for multi-threaded applications.
53                 This will usually require additional system-dependent options!
54                 See "Note on multi-threading" below.
55
56   no-asm        Do not use assembler code.
57
58   386           Use the 80386 instruction set only (the default x86 code is
59                 more efficient, but requires at least a 486).
60
61   no-<cipher>   Build without the specified cipher (bf, cast, des, dh, dsa,
62                 hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha).
63                 The crypto/<cipher> directory can be removed after running
64                 "make depend".
65
66   -Dxxx, -lxxx, -Lxxx, -fxxx, -Kxxx These system specific options will
67                 be passed through to the compiler to allow you to
68                 define preprocessor symbols, specify additional libraries,
69                 library directories or other compiler options.
70
71
72  Installation in Detail
73  ----------------------
74
75  1a. Configure OpenSSL for your operation system automatically:
76
77        $ ./config [options]
78
79      This guesses at your operating system (and compiler, if necessary) and
80      configures OpenSSL based on this guess. Run ./config -t to see
81      if it guessed correctly. If you want to use a different compiler, you
82      are cross-compiling for another platform, or the ./config guess was
83      wrong for other reasons, go to step 1b. Otherwise go to step 2.
84
85      On some systems, you can include debugging information as follows:
86
87        $ ./config -d [options]
88
89  1b. Configure OpenSSL for your operating system manually
90
91      OpenSSL knows about a range of different operating system, hardware and
92      compiler combinations. To see the ones it knows about, run
93
94        $ ./Configure
95
96      Pick a suitable name from the list that matches your system. For most
97      operating systems there is a choice between using "cc" or "gcc".  When
98      you have identified your system (and if necessary compiler) use this name
99      as the argument to ./Configure. For example, a "linux-elf" user would
100      run:
101
102        $ ./Configure linux-elf [options]
103
104      If your system is not available, you will have to edit the Configure
105      program and add the correct configuration for your system. The
106      generic configurations "cc" or "gcc" should usually work on 32 bit
107      systems.
108
109      Configure creates the file Makefile.ssl from Makefile.org and
110      defines various macros in crypto/opensslconf.h (generated from
111      crypto/opensslconf.h.in).
112
113   2. Build OpenSSL by running:
114
115        $ make
116
117      This will build the OpenSSL libraries (libcrypto.a and libssl.a) and the
118      OpenSSL binary ("openssl"). The libraries will be built in the top-level
119      directory, and the binary will be in the "apps" directory.
120
121      If "make" fails, please report the problem to <openssl-bugs@openssl.org>
122      (note that your message will be forwarded to a public mailing list).
123      Include the output of "make report" in your message.
124
125      [If you encounter assembler error messages, try the "no-asm"
126      configuration option as an immediate fix.]
127
128      Compiling parts of OpenSSL with gcc and others with the system
129      compiler will result in unresolved symbols on some systems.
130
131   3. After a successful build, the libraries should be tested. Run:
132
133        $ make test
134
135     If a test fails, try removing any compiler optimization flags from
136     the CFLAGS line in Makefile.ssl and run "make clean; make". Please
137     send a bug report to <openssl-bugs@openssl.org>, including the
138     output of "make report".
139
140   4. If everything tests ok, install OpenSSL with
141
142        $ make install
143
144      This will create the installation directory (if it does not exist) and
145      then the following subdirectories:
146
147        certs           Initially empty, this is the default location
148                        for certificate files.
149        man/man1        Manual pages for the 'openssl' command line tool
150        man/man3        Manual pages for the libraries (very incomplete)
151        misc            Various scripts.
152        private         Initially empty, this is the default location
153                        for private key files.
154
155      If you didn't choose a different installation prefix, the
156      following additional subdirectories will be created:
157
158        bin             Contains the openssl binary and a few other 
159                        utility programs. 
160        include/openssl Contains the header files needed if you want to
161                        compile programs with libcrypto or libssl.
162        lib             Contains the OpenSSL library files themselves.
163
164      Package builders who want to configure the library for standard
165      locations, but have the package installed somewhere else so that
166      it can easily be packaged, can use
167
168        $ make INSTALL_PREFIX=/tmp/package-root install
169
170      (or specify "--install_prefix=/tmp/package-root" as a configure
171      option).  The specified prefix will be prepended to all
172      installation target filenames.
173
174
175   NOTE: The header files used to reside directly in the include
176   directory, but have now been moved to include/openssl so that
177   OpenSSL can co-exist with other libraries which use some of the
178   same filenames.  This means that applications that use OpenSSL
179   should now use C preprocessor directives of the form
180
181        #include <openssl/ssl.h>
182
183   instead of "#include <ssl.h>", which was used with library versions
184   up to OpenSSL 0.9.2b.
185
186   If you install a new version of OpenSSL over an old library version,
187   you should delete the old header files in the include directory.
188
189   Compatibility issues:
190
191   *  COMPILING existing applications
192
193      To compile an application that uses old filenames -- e.g.
194      "#include <ssl.h>" --, it will usually be enough to find
195      the CFLAGS definition in the application's Makefile and
196      add a C option such as
197
198           -I/usr/local/ssl/include/openssl
199
200      to it.
201
202      But don't delete the existing -I option that points to
203      the ..../include directory!  Otherwise, OpenSSL header files
204      could not #include each other.
205
206   *  WRITING applications
207
208      To write an application that is able to handle both the new
209      and the old directory layout, so that it can still be compiled
210      with library versions up to OpenSSL 0.9.2b without bothering
211      the user, you can proceed as follows:
212
213      -  Always use the new filename of OpenSSL header files,
214         e.g. #include <openssl/ssl.h>.
215
216      -  Create a directory "incl" that contains only a symbolic
217         link named "openssl", which points to the "include" directory
218         of OpenSSL.
219         For example, your application's Makefile might contain the
220         following rule, if OPENSSLDIR is a pathname (absolute or
221         relative) of the directory where OpenSSL resides:
222
223         incl/openssl:
224                 -mkdir incl
225                 cd $(OPENSSLDIR) # Check whether the directory really exists
226                 -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl
227
228         You will have to add "incl/openssl" to the dependencies
229         of those C files that include some OpenSSL header file.
230
231      -  Add "-Iincl" to your CFLAGS.
232
233      With these additions, the OpenSSL header files will be available
234      under both name variants if an old library version is used:
235      Your application can reach them under names like <openssl/foo.h>,
236      while the header files still are able to #include each other
237      with names of the form <foo.h>.
238
239
240  Note on multi-threading
241  -----------------------
242
243  For some systems, the OpenSSL Configure script knows what compiler options
244  are needed to generate a library that is suitable for multi-threaded
245  applications.  On these systems, support for multi-threading is enabled
246  by default; use the "no-threads" option to disable (this should never be
247  necessary).
248
249  On other systems, to enable support for multi-threading, you will have
250  to specify at least two options: "threads", and a system-dependent option.
251  (The latter is "-D_REENTRANT" on various systems.)  The default in this
252  case, obviously, is not to include support for multi-threading (but
253  you can still use "no-threads" to suppress an annoying warning message
254  from the Configure script.)
255