Attempt to bring the 'engine' documentation up to date w.r.t missing
[openssl.git] / INSTALL
1
2  INSTALLATION ON THE UNIX PLATFORM
3  ---------------------------------
4
5  [Installation on DOS (with djgpp), Windows, OpenVMS, MacOS (before MacOS X)
6   and NetWare is described in INSTALL.DJGPP, INSTALL.W32, INSTALL.VMS,
7   INSTALL.MacOS and INSTALL.NW.
8   
9   This document describes installation on operating systems in the Unix
10   family.]
11
12  To install OpenSSL, you will need:
13
14   * make
15   * Perl 5
16   * an ANSI C compiler
17   * a development environment in form of development libraries and C
18     header files
19   * a supported Unix operating system
20
21  Quick Start
22  -----------
23
24  If you want to just get on with it, do:
25
26   $ ./config
27   $ make
28   $ make test
29   $ make install
30
31  [If any of these steps fails, see section Installation in Detail below.]
32
33  This will build and install OpenSSL in the default location, which is (for
34  historical reasons) /usr/local/ssl. If you want to install it anywhere else,
35  run config like this:
36
37   $ ./config --prefix=/usr/local --openssldir=/usr/local/openssl
38
39
40  Configuration Options
41  ---------------------
42
43  There are several options to ./config (or ./Configure) to customize
44  the build:
45
46   --prefix=DIR  Install in DIR/bin, DIR/lib, DIR/include/openssl.
47                 Configuration files used by OpenSSL will be in DIR/ssl
48                 or the directory specified by --openssldir.
49
50   --openssldir=DIR Directory for OpenSSL files. If no prefix is specified,
51                 the library files and binaries are also installed there.
52
53   no-threads    Don't try to build with support for multi-threaded
54                 applications.
55
56   threads       Build with support for multi-threaded applications.
57                 This will usually require additional system-dependent options!
58                 See "Note on multi-threading" below.
59
60   no-zlib       Don't try to build with support for zlib compression and
61                 decompression.
62
63   zlib          Build with support for zlib compression/decompression.
64
65   zlib-dynamic  Like "zlib", but has OpenSSL load the zlib library dynamically
66                 when needed.  This is only supported on systems where loading
67                 of shared libraries is supported.  This is the default choice.
68
69   no-shared     Don't try to create shared libraries.
70
71   shared        In addition to the usual static libraries, create shared
72                 libraries on platforms where it's supported.  See "Note on
73                 shared libraries" below.
74
75   no-asm        Do not use assembler code.
76
77   386           Use the 80386 instruction set only (the default x86 code is
78                 more efficient, but requires at least a 486).
79
80   no-<cipher>   Build without the specified cipher (bf, cast, des, dh, dsa,
81                 hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha).
82                 The crypto/<cipher> directory can be removed after running
83                 "make depend".
84
85   -Dxxx, -lxxx, -Lxxx, -fxxx, -Kxxx These system specific options will
86                 be passed through to the compiler to allow you to
87                 define preprocessor symbols, specify additional libraries,
88                 library directories or other compiler options.
89
90
91  Installation in Detail
92  ----------------------
93
94  1a. Configure OpenSSL for your operation system automatically:
95
96        $ ./config [options]
97
98      This guesses at your operating system (and compiler, if necessary) and
99      configures OpenSSL based on this guess. Run ./config -t to see
100      if it guessed correctly. If you want to use a different compiler, you
101      are cross-compiling for another platform, or the ./config guess was
102      wrong for other reasons, go to step 1b. Otherwise go to step 2.
103
104      On some systems, you can include debugging information as follows:
105
106        $ ./config -d [options]
107
108  1b. Configure OpenSSL for your operating system manually
109
110      OpenSSL knows about a range of different operating system, hardware and
111      compiler combinations. To see the ones it knows about, run
112
113        $ ./Configure
114
115      Pick a suitable name from the list that matches your system. For most
116      operating systems there is a choice between using "cc" or "gcc".  When
117      you have identified your system (and if necessary compiler) use this name
118      as the argument to ./Configure. For example, a "linux-elf" user would
119      run:
120
121        $ ./Configure linux-elf [options]
122
123      If your system is not available, you will have to edit the Configure
124      program and add the correct configuration for your system. The
125      generic configurations "cc" or "gcc" should usually work on 32 bit
126      systems.
127
128      Configure creates the file Makefile.ssl from Makefile.org and
129      defines various macros in crypto/opensslconf.h (generated from
130      crypto/opensslconf.h.in).
131
132   2. Build OpenSSL by running:
133
134        $ make
135
136      This will build the OpenSSL libraries (libcrypto.a and libssl.a) and the
137      OpenSSL binary ("openssl"). The libraries will be built in the top-level
138      directory, and the binary will be in the "apps" directory.
139
140      If "make" fails, look at the output.  There may be reasons for
141      the failure that aren't problems in OpenSSL itself (like missing
142      standard headers).  If it is a problem with OpenSSL itself, please
143      report the problem to <openssl-bugs@openssl.org> (note that your
144      message will be recorded in the request tracker publicly readable
145      via http://www.openssl.org/support/rt2.html and will be forwarded to a
146      public mailing list). Include the output of "make report" in your message.
147      Please check out the request tracker. Maybe the bug was already
148      reported or has already been fixed.
149
150      [If you encounter assembler error messages, try the "no-asm"
151      configuration option as an immediate fix.]
152
153      Compiling parts of OpenSSL with gcc and others with the system
154      compiler will result in unresolved symbols on some systems.
155
156   3. After a successful build, the libraries should be tested. Run:
157
158        $ make test
159
160      If a test fails, look at the output.  There may be reasons for
161      the failure that isn't a problem in OpenSSL itself (like a missing
162      or malfunctioning bc).  If it is a problem with OpenSSL itself,
163      try removing any compiler optimization flags from the CFLAG line
164      in Makefile.ssl and run "make clean; make". Please send a bug
165      report to <openssl-bugs@openssl.org>, including the output of
166      "make report" in order to be added to the request tracker at
167      http://www.openssl.org/support/rt2.html.
168
169   4. If everything tests ok, install OpenSSL with
170
171        $ make install
172
173      This will create the installation directory (if it does not exist) and
174      then the following subdirectories:
175
176        certs           Initially empty, this is the default location
177                        for certificate files.
178        man/man1        Manual pages for the 'openssl' command line tool
179        man/man3        Manual pages for the libraries (very incomplete)
180        misc            Various scripts.
181        private         Initially empty, this is the default location
182                        for private key files.
183
184      If you didn't choose a different installation prefix, the
185      following additional subdirectories will be created:
186
187        bin             Contains the openssl binary and a few other 
188                        utility programs. 
189        include/openssl Contains the header files needed if you want to
190                        compile programs with libcrypto or libssl.
191        lib             Contains the OpenSSL library files themselves.
192
193      Package builders who want to configure the library for standard
194      locations, but have the package installed somewhere else so that
195      it can easily be packaged, can use
196
197        $ make INSTALL_PREFIX=/tmp/package-root install
198
199      (or specify "--install_prefix=/tmp/package-root" as a configure
200      option).  The specified prefix will be prepended to all
201      installation target filenames.
202
203
204   NOTE: The header files used to reside directly in the include
205   directory, but have now been moved to include/openssl so that
206   OpenSSL can co-exist with other libraries which use some of the
207   same filenames.  This means that applications that use OpenSSL
208   should now use C preprocessor directives of the form
209
210        #include <openssl/ssl.h>
211
212   instead of "#include <ssl.h>", which was used with library versions
213   up to OpenSSL 0.9.2b.
214
215   If you install a new version of OpenSSL over an old library version,
216   you should delete the old header files in the include directory.
217
218   Compatibility issues:
219
220   *  COMPILING existing applications
221
222      To compile an application that uses old filenames -- e.g.
223      "#include <ssl.h>" --, it will usually be enough to find
224      the CFLAGS definition in the application's Makefile and
225      add a C option such as
226
227           -I/usr/local/ssl/include/openssl
228
229      to it.
230
231      But don't delete the existing -I option that points to
232      the ..../include directory!  Otherwise, OpenSSL header files
233      could not #include each other.
234
235   *  WRITING applications
236
237      To write an application that is able to handle both the new
238      and the old directory layout, so that it can still be compiled
239      with library versions up to OpenSSL 0.9.2b without bothering
240      the user, you can proceed as follows:
241
242      -  Always use the new filename of OpenSSL header files,
243         e.g. #include <openssl/ssl.h>.
244
245      -  Create a directory "incl" that contains only a symbolic
246         link named "openssl", which points to the "include" directory
247         of OpenSSL.
248         For example, your application's Makefile might contain the
249         following rule, if OPENSSLDIR is a pathname (absolute or
250         relative) of the directory where OpenSSL resides:
251
252         incl/openssl:
253                 -mkdir incl
254                 cd $(OPENSSLDIR) # Check whether the directory really exists
255                 -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl
256
257         You will have to add "incl/openssl" to the dependencies
258         of those C files that include some OpenSSL header file.
259
260      -  Add "-Iincl" to your CFLAGS.
261
262      With these additions, the OpenSSL header files will be available
263      under both name variants if an old library version is used:
264      Your application can reach them under names like <openssl/foo.h>,
265      while the header files still are able to #include each other
266      with names of the form <foo.h>.
267
268
269  Note on multi-threading
270  -----------------------
271
272  For some systems, the OpenSSL Configure script knows what compiler options
273  are needed to generate a library that is suitable for multi-threaded
274  applications.  On these systems, support for multi-threading is enabled
275  by default; use the "no-threads" option to disable (this should never be
276  necessary).
277
278  On other systems, to enable support for multi-threading, you will have
279  to specify at least two options: "threads", and a system-dependent option.
280  (The latter is "-D_REENTRANT" on various systems.)  The default in this
281  case, obviously, is not to include support for multi-threading (but
282  you can still use "no-threads" to suppress an annoying warning message
283  from the Configure script.)
284
285
286  Note on shared libraries
287  ------------------------
288
289  Shared library is currently an experimental feature.  The only reason to
290  have them would be to conserve memory on systems where several program
291  are using OpenSSL.  Binary backward compatibility can't be guaranteed
292  before OpenSSL version 1.0.
293
294  For some systems, the OpenSSL Configure script knows what is needed to
295  build shared libraries for libcrypto and libssl.  On these systems,
296  the shared libraries are currently not created by default, but giving
297  the option "shared" will get them created.  This method supports Makefile
298  targets for shared library creation, like linux-shared.  Those targets
299  can currently be used on their own just as well, but this is expected
300  to change in future versions of OpenSSL.
301
302  Note on random number generation
303  --------------------------------
304
305  Availability of cryptographically secure random numbers is required for
306  secret key generation. OpenSSL provides several options to seed the
307  internal PRNG. If not properly seeded, the internal PRNG will refuse
308  to deliver random bytes and a "PRNG not seeded error" will occur.
309  On systems without /dev/urandom (or similar) device, it may be necessary
310  to install additional support software to obtain random seed.
311  Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
312  and the FAQ for more information.
313
314  Note on support for multiple builds
315  -----------------------------------
316
317  OpenSSL is usually built in it's source tree.  Unfortunately, this doesn't
318  support building for multiple platforms from the same source tree very well.
319  It is however possible to build in a separate tree through the use of lots
320  of symbolic links, which should be prepared like this:
321
322         mkdir -p objtree/"`uname -s`-`uname -r`-`uname -m`"
323         cd objtree/"`uname -s`-`uname -r`-`uname -m`"
324         (cd $OPENSSL_SOURCE; find . -type f) | while read F; do
325                 mkdir -p `dirname $F`
326                 rm -f $F; ln -s $OPENSSL_SOURCE/$F $F
327                 echo $F '->' $OPENSSL_SOURCE/$F
328         done
329         make -f Makefile.org clean
330
331  OPENSSL_SOURCE is an environment variable that contains the absolute (this
332  is important!) path to the OpenSSL source tree.
333
334  Also, operations like 'make update' should still be made in the source tree.