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