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