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