]>
Commit | Line | Data |
---|---|---|
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-sse2 Exclude SSE2 code pathes. Normally SSE2 extention is | |
81 | detected at run-time, but the decision whether or not the | |
82 | machine code will be executed is taken solely on CPU | |
83 | capability vector. This means that if you happen to run OS | |
84 | kernel which does not support SSE2 extension on Intel P4 | |
85 | processor, then your application might be exposed to | |
86 | "illegal instruction" exception. There might be a way | |
87 | to enable support in kernel, e.g. FreeBSD kernel can be | |
88 | compiled with CPU_ENABLE_SSE, and there is a way to | |
89 | disengage SSE2 code pathes upon application start-up, | |
90 | but if you aim for wider "audience" running such kernel, | |
91 | consider no-sse2. Both 386 and no-asm options above imply | |
92 | no-sse2. | |
93 | ||
94 | no-<cipher> Build without the specified cipher (bf, cast, des, dh, dsa, | |
95 | hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha). | |
96 | The crypto/<cipher> directory can be removed after running | |
97 | "make depend". | |
98 | ||
99 | -Dxxx, -lxxx, -Lxxx, -fxxx, -Kxxx These system specific options will | |
100 | be passed through to the compiler to allow you to | |
101 | define preprocessor symbols, specify additional libraries, | |
102 | library directories or other compiler options. | |
103 | ||
104 | ||
105 | Installation in Detail | |
106 | ---------------------- | |
107 | ||
108 | 1a. Configure OpenSSL for your operation system automatically: | |
109 | ||
110 | $ ./config [options] | |
111 | ||
112 | This guesses at your operating system (and compiler, if necessary) and | |
113 | configures OpenSSL based on this guess. Run ./config -t to see | |
114 | if it guessed correctly. If you want to use a different compiler, you | |
115 | are cross-compiling for another platform, or the ./config guess was | |
116 | wrong for other reasons, go to step 1b. Otherwise go to step 2. | |
117 | ||
118 | On some systems, you can include debugging information as follows: | |
119 | ||
120 | $ ./config -d [options] | |
121 | ||
122 | 1b. Configure OpenSSL for your operating system manually | |
123 | ||
124 | OpenSSL knows about a range of different operating system, hardware and | |
125 | compiler combinations. To see the ones it knows about, run | |
126 | ||
127 | $ ./Configure | |
128 | ||
129 | Pick a suitable name from the list that matches your system. For most | |
130 | operating systems there is a choice between using "cc" or "gcc". When | |
131 | you have identified your system (and if necessary compiler) use this name | |
132 | as the argument to ./Configure. For example, a "linux-elf" user would | |
133 | run: | |
134 | ||
135 | $ ./Configure linux-elf [options] | |
136 | ||
137 | If your system is not available, you will have to edit the Configure | |
138 | program and add the correct configuration for your system. The | |
139 | generic configurations "cc" or "gcc" should usually work on 32 bit | |
140 | systems. | |
141 | ||
142 | Configure creates the file Makefile.ssl from Makefile.org and | |
143 | defines various macros in crypto/opensslconf.h (generated from | |
144 | crypto/opensslconf.h.in). | |
145 | ||
146 | 2. Build OpenSSL by running: | |
147 | ||
148 | $ make | |
149 | ||
150 | This will build the OpenSSL libraries (libcrypto.a and libssl.a) and the | |
151 | OpenSSL binary ("openssl"). The libraries will be built in the top-level | |
152 | directory, and the binary will be in the "apps" directory. | |
153 | ||
154 | If "make" fails, look at the output. There may be reasons for | |
155 | the failure that aren't problems in OpenSSL itself (like missing | |
156 | standard headers). If it is a problem with OpenSSL itself, please | |
157 | report the problem to <openssl-bugs@openssl.org> (note that your | |
158 | message will be recorded in the request tracker publicly readable | |
159 | via http://www.openssl.org/support/rt2.html and will be forwarded to a | |
160 | public mailing list). Include the output of "make report" in your message. | |
161 | Please check out the request tracker. Maybe the bug was already | |
162 | reported or has already been fixed. | |
163 | ||
164 | [If you encounter assembler error messages, try the "no-asm" | |
165 | configuration option as an immediate fix.] | |
166 | ||
167 | Compiling parts of OpenSSL with gcc and others with the system | |
168 | compiler will result in unresolved symbols on some systems. | |
169 | ||
170 | 3. After a successful build, the libraries should be tested. Run: | |
171 | ||
172 | $ make test | |
173 | ||
174 | If a test fails, look at the output. There may be reasons for | |
175 | the failure that isn't a problem in OpenSSL itself (like a missing | |
176 | or malfunctioning bc). If it is a problem with OpenSSL itself, | |
177 | try removing any compiler optimization flags from the CFLAG line | |
178 | in Makefile.ssl and run "make clean; make". Please send a bug | |
179 | report to <openssl-bugs@openssl.org>, including the output of | |
180 | "make report" in order to be added to the request tracker at | |
181 | http://www.openssl.org/support/rt2.html. | |
182 | ||
183 | 4. If everything tests ok, install OpenSSL with | |
184 | ||
185 | $ make install | |
186 | ||
187 | This will create the installation directory (if it does not exist) and | |
188 | then the following subdirectories: | |
189 | ||
190 | certs Initially empty, this is the default location | |
191 | for certificate files. | |
192 | man/man1 Manual pages for the 'openssl' command line tool | |
193 | man/man3 Manual pages for the libraries (very incomplete) | |
194 | misc Various scripts. | |
195 | private Initially empty, this is the default location | |
196 | for private key files. | |
197 | ||
198 | If you didn't choose a different installation prefix, the | |
199 | following additional subdirectories will be created: | |
200 | ||
201 | bin Contains the openssl binary and a few other | |
202 | utility programs. | |
203 | include/openssl Contains the header files needed if you want to | |
204 | compile programs with libcrypto or libssl. | |
205 | lib Contains the OpenSSL library files themselves. | |
206 | ||
207 | Package builders who want to configure the library for standard | |
208 | locations, but have the package installed somewhere else so that | |
209 | it can easily be packaged, can use | |
210 | ||
211 | $ make INSTALL_PREFIX=/tmp/package-root install | |
212 | ||
213 | (or specify "--install_prefix=/tmp/package-root" as a configure | |
214 | option). The specified prefix will be prepended to all | |
215 | installation target filenames. | |
216 | ||
217 | ||
218 | NOTE: The header files used to reside directly in the include | |
219 | directory, but have now been moved to include/openssl so that | |
220 | OpenSSL can co-exist with other libraries which use some of the | |
221 | same filenames. This means that applications that use OpenSSL | |
222 | should now use C preprocessor directives of the form | |
223 | ||
224 | #include <openssl/ssl.h> | |
225 | ||
226 | instead of "#include <ssl.h>", which was used with library versions | |
227 | up to OpenSSL 0.9.2b. | |
228 | ||
229 | If you install a new version of OpenSSL over an old library version, | |
230 | you should delete the old header files in the include directory. | |
231 | ||
232 | Compatibility issues: | |
233 | ||
234 | * COMPILING existing applications | |
235 | ||
236 | To compile an application that uses old filenames -- e.g. | |
237 | "#include <ssl.h>" --, it will usually be enough to find | |
238 | the CFLAGS definition in the application's Makefile and | |
239 | add a C option such as | |
240 | ||
241 | -I/usr/local/ssl/include/openssl | |
242 | ||
243 | to it. | |
244 | ||
245 | But don't delete the existing -I option that points to | |
246 | the ..../include directory! Otherwise, OpenSSL header files | |
247 | could not #include each other. | |
248 | ||
249 | * WRITING applications | |
250 | ||
251 | To write an application that is able to handle both the new | |
252 | and the old directory layout, so that it can still be compiled | |
253 | with library versions up to OpenSSL 0.9.2b without bothering | |
254 | the user, you can proceed as follows: | |
255 | ||
256 | - Always use the new filename of OpenSSL header files, | |
257 | e.g. #include <openssl/ssl.h>. | |
258 | ||
259 | - Create a directory "incl" that contains only a symbolic | |
260 | link named "openssl", which points to the "include" directory | |
261 | of OpenSSL. | |
262 | For example, your application's Makefile might contain the | |
263 | following rule, if OPENSSLDIR is a pathname (absolute or | |
264 | relative) of the directory where OpenSSL resides: | |
265 | ||
266 | incl/openssl: | |
267 | -mkdir incl | |
268 | cd $(OPENSSLDIR) # Check whether the directory really exists | |
269 | -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl | |
270 | ||
271 | You will have to add "incl/openssl" to the dependencies | |
272 | of those C files that include some OpenSSL header file. | |
273 | ||
274 | - Add "-Iincl" to your CFLAGS. | |
275 | ||
276 | With these additions, the OpenSSL header files will be available | |
277 | under both name variants if an old library version is used: | |
278 | Your application can reach them under names like <openssl/foo.h>, | |
279 | while the header files still are able to #include each other | |
280 | with names of the form <foo.h>. | |
281 | ||
282 | ||
283 | Note on multi-threading | |
284 | ----------------------- | |
285 | ||
286 | For some systems, the OpenSSL Configure script knows what compiler options | |
287 | are needed to generate a library that is suitable for multi-threaded | |
288 | applications. On these systems, support for multi-threading is enabled | |
289 | by default; use the "no-threads" option to disable (this should never be | |
290 | necessary). | |
291 | ||
292 | On other systems, to enable support for multi-threading, you will have | |
293 | to specify at least two options: "threads", and a system-dependent option. | |
294 | (The latter is "-D_REENTRANT" on various systems.) The default in this | |
295 | case, obviously, is not to include support for multi-threading (but | |
296 | you can still use "no-threads" to suppress an annoying warning message | |
297 | from the Configure script.) | |
298 | ||
299 | ||
300 | Note on shared libraries | |
301 | ------------------------ | |
302 | ||
303 | Shared library is currently an experimental feature. The only reason to | |
304 | have them would be to conserve memory on systems where several program | |
305 | are using OpenSSL. Binary backward compatibility can't be guaranteed | |
306 | before OpenSSL version 1.0. | |
307 | ||
308 | For some systems, the OpenSSL Configure script knows what is needed to | |
309 | build shared libraries for libcrypto and libssl. On these systems, | |
310 | the shared libraries are currently not created by default, but giving | |
311 | the option "shared" will get them created. This method supports Makefile | |
312 | targets for shared library creation, like linux-shared. Those targets | |
313 | can currently be used on their own just as well, but this is expected | |
314 | to change in future versions of OpenSSL. | |
315 | ||
316 | Note on random number generation | |
317 | -------------------------------- | |
318 | ||
319 | Availability of cryptographically secure random numbers is required for | |
320 | secret key generation. OpenSSL provides several options to seed the | |
321 | internal PRNG. If not properly seeded, the internal PRNG will refuse | |
322 | to deliver random bytes and a "PRNG not seeded error" will occur. | |
323 | On systems without /dev/urandom (or similar) device, it may be necessary | |
324 | to install additional support software to obtain random seed. | |
325 | Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(), | |
326 | and the FAQ for more information. | |
327 | ||
328 | Note on support for multiple builds | |
329 | ----------------------------------- | |
330 | ||
331 | OpenSSL is usually built in it's source tree. Unfortunately, this doesn't | |
332 | support building for multiple platforms from the same source tree very well. | |
333 | It is however possible to build in a separate tree through the use of lots | |
334 | of symbolic links, which should be prepared like this: | |
335 | ||
336 | mkdir -p objtree/"`uname -s`-`uname -r`-`uname -m`" | |
337 | cd objtree/"`uname -s`-`uname -r`-`uname -m`" | |
338 | (cd $OPENSSL_SOURCE; find . -type f) | while read F; do | |
339 | mkdir -p `dirname $F` | |
340 | rm -f $F; ln -s $OPENSSL_SOURCE/$F $F | |
341 | echo $F '->' $OPENSSL_SOURCE/$F | |
342 | done | |
343 | make -f Makefile.org clean | |
344 | ||
345 | OPENSSL_SOURCE is an environment variable that contains the absolute (this | |
346 | is important!) path to the OpenSSL source tree. | |
347 | ||
348 | Also, operations like 'make update' should still be made in the source tree. |