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