]>
Commit | Line | Data |
---|---|---|
1 | ||
2 | INSTALLATION ON THE UNIX PLATFORM | |
3 | --------------------------------- | |
4 | ||
5 | [For instructions for compiling OpenSSL on Windows systems, see INSTALL.W32]. | |
6 | ||
7 | To install OpenSSL, you will need: | |
8 | ||
9 | * Perl 5 | |
10 | * an ANSI C compiler | |
11 | * a supported Unix operating system | |
12 | ||
13 | Quick Start | |
14 | ----------- | |
15 | ||
16 | If you want to just get on with it, do: | |
17 | ||
18 | $ ./config [if this fails, go to step 1b below] | |
19 | $ make | |
20 | $ make test | |
21 | $ make install | |
22 | ||
23 | This will build and install OpenSSL in the default location, which is (for | |
24 | historical reasons) /usr/local/ssl. If you want to install it anywhere else, | |
25 | run config like this: | |
26 | ||
27 | $ ./config --prefix=/usr/local --openssldir=/usr/local/openssl | |
28 | ||
29 | There are several options to ./config to customize the build: | |
30 | ||
31 | --prefix=DIR Install in DIR/bin, DIR/lib, DIR/include. Configuration | |
32 | files used by OpenSSL will be in DIR/ssl or the directory | |
33 | specified by --openssldir. | |
34 | ||
35 | --openssldir=DIR Directory for OpenSSL files. If no prefix is specified, | |
36 | the library files and binaries are also installed there. | |
37 | ||
38 | rsaref Build with RSADSI's RSAREF toolkit. | |
39 | ||
40 | no-threads Don't try to build with support for multi-threaded | |
41 | applications. | |
42 | ||
43 | threads Build with support for multi-threaded applications. | |
44 | This will usually require additional system-dependent options! | |
45 | See "Note on multi-threading" below. | |
46 | ||
47 | no-asm Build with no assembler code. | |
48 | ||
49 | 386 Use the 80386 instruction set only (the default x86 code is | |
50 | more efficient, but requires at least a 486). | |
51 | ||
52 | If anything goes wrong, follow the detailed instructions below. If your | |
53 | operating system is not (yet) supported by OpenSSL, see the section on | |
54 | porting to a new system. | |
55 | ||
56 | Installation in Detail | |
57 | ---------------------- | |
58 | ||
59 | 1a. Configure OpenSSL for your operation system automatically: | |
60 | ||
61 | $ ./config | |
62 | ||
63 | This guesses at your operating system (and compiler, if necessary) and | |
64 | configures OpenSSL based on this guess. Run ./config -t -v to see | |
65 | if it guessed correctly. If it did not get it correct or you want to | |
66 | use a different compiler then go to step 1b. Otherwise go to step 2. | |
67 | ||
68 | 1b. Configure OpenSSL for your operating system manually | |
69 | ||
70 | OpenSSL knows about a range of different operating system, hardware and | |
71 | compiler combinations. To see the ones it knows about, run | |
72 | ||
73 | $ ./Configure | |
74 | ||
75 | Pick a suitable name from the list that matches your system. For most | |
76 | operating systems there is a choice between using "cc" or "gcc". When | |
77 | you have identified your system (and if necessary compiler) use this name | |
78 | as the argument to ./Configure. For example, a "linux-elf" user would | |
79 | run: | |
80 | ||
81 | $ ./Configure linux-elf [--prefix=DIR] [--openssldir=OPENSSLDIR] | |
82 | ||
83 | If your system is not available, you will have to edit the Configure | |
84 | program and add the correct configuration for your system. The | |
85 | generic configurations "cc" or "gcc" should usually work. | |
86 | ||
87 | Configure creates the Makefile.ssl from Makefile.org and defines | |
88 | various macros in crypto/opensslconf.h (generated from | |
89 | crypto/opensslconf.h.in). | |
90 | ||
91 | 2. Build OpenSSL by running: | |
92 | ||
93 | $ make | |
94 | ||
95 | This will build the OpenSSL libraries (libcrypto.a and libssl.a) and the | |
96 | OpenSSL binary ("openssl"). The libraries will be built in the top-level | |
97 | directory, and the binary will be in the "apps" directory. | |
98 | ||
99 | 3. After a successful build, the libraries should be tested. Run: | |
100 | ||
101 | $ make test | |
102 | ||
103 | 4. If everything tests ok, install OpenSSL with | |
104 | ||
105 | $ make install | |
106 | ||
107 | This will create the installation directory (if it does not exist) and | |
108 | then create the following subdirectories: | |
109 | ||
110 | certs Initially empty, this is the default location | |
111 | for certificate files. | |
112 | private Initially empty, this is the default location | |
113 | for private key files. | |
114 | lib Contains the OpenSSL configuration file "openssl.cnf". | |
115 | ||
116 | If you didn't chose a different installation prefix, lib also contains | |
117 | the library files themselves, and the following additional subdirectories | |
118 | will be created: | |
119 | ||
120 | bin Contains the openssl binary and a few other | |
121 | utility programs. | |
122 | include/openssl Contains the header files needed if you want to | |
123 | compile programs with libcrypto or libssl. | |
124 | ||
125 | NOTE: The header files used to reside directly in the include | |
126 | directory, but have now been moved to include/openssl so that | |
127 | OpenSSL can co-exist with other libraries which use some of the | |
128 | same filenames. This means that applications that use OpenSSL | |
129 | should now use C preprocessor directives of the form | |
130 | ||
131 | #include <openssl/ssl.h> | |
132 | ||
133 | instead of "#include <ssl.h>", which was used with library versions | |
134 | up to OpenSSL 0.9.2b. | |
135 | ||
136 | If you install a new version of OpenSSL over an old library version, | |
137 | you should delete the old header files in the include directory. | |
138 | ||
139 | Compatibility issues: | |
140 | ||
141 | * COMPILING existing applications | |
142 | ||
143 | To compile an application that uses old filenames -- e.g. | |
144 | "#include <ssl.h>" --, it will usually be enough to find | |
145 | the CFLAGS definition in the application's Makefile and | |
146 | add a C option such as | |
147 | ||
148 | -I/usr/local/ssl/include/openssl | |
149 | ||
150 | to it. | |
151 | ||
152 | But don't delete the existing -I option that points to | |
153 | the ..../include directory! Otherwise, OpenSSL header files | |
154 | could not #include each other. | |
155 | ||
156 | * WRITING applications | |
157 | ||
158 | To write an application that is able to handle both the new | |
159 | and the old directory layout, so that it can still be compiled | |
160 | with library versions up to OpenSSL 0.9.2b without bothering | |
161 | the user, you can proceed as follows: | |
162 | ||
163 | - Always use the new filename of OpenSSL header files, | |
164 | e.g. #include <openssl/ssl.h>. | |
165 | ||
166 | - Create a directory "incl" that contains only a symbolic | |
167 | link named "openssl", which points to the "include" directory | |
168 | of OpenSSL. | |
169 | For example, your application's Makefile might contain the | |
170 | following rule, if OPENSSLDIR is a pathname (absolute or | |
171 | relative) of the directory where OpenSSL resides: | |
172 | ||
173 | incl/openssl: | |
174 | -mkdir incl | |
175 | cd $(OPENSSLDIR) # Check whether the directory really exists | |
176 | -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl | |
177 | ||
178 | You will have to add "incl/openssl" to the dependencies | |
179 | of those C files that include some OpenSSL header file. | |
180 | ||
181 | - Add "-Iincl" to your CFLAGS. | |
182 | ||
183 | With these additions, the OpenSSL header files will be available | |
184 | under both name variants if an old library version is used: | |
185 | Your application can reach them under names like <openssl/foo.h>, | |
186 | while the header files still are able to #include each other | |
187 | with names of the form <foo.h>. | |
188 | ||
189 | ||
190 | Note on multi-threading | |
191 | ----------------------- | |
192 | ||
193 | For some systems, the OpenSSL Configure script knows what compiler options | |
194 | are needed to generate a library that is suitable for multi-threaded | |
195 | applications. On these systems, support for multi-threading is enabled | |
196 | by default; use the "no-threads" option to disable (this should never be | |
197 | necessary). | |
198 | ||
199 | On other systems, to enable support for multi-threading, you will have | |
200 | to specifiy at least two options: "threads", and a system-dependent option. | |
201 | (The latter is "-D_REENTRANT" on various systems.) The default in this | |
202 | case, obviously, is not to include support for multi-threading (but | |
203 | you can still use "no-threads" to suppress an annoying warning message | |
204 | from the Configure script.) | |
205 | ||
206 | ||
207 | -------------------------------------------------------------------------------- | |
208 | The orignal Unix build instructions from SSLeay follow. | |
209 | Note: some of this may be out of date and no longer applicable | |
210 | -------------------------------------------------------------------------------- | |
211 | ||
212 | # When bringing the SSLeay distribution back from the evil intel world | |
213 | # of Windows NT, do the following to make it nice again under unix :-) | |
214 | # You don't normally need to run this. | |
215 | sh util/fixNT.sh # This only works for NT now - eay - 21-Jun-1996 | |
216 | ||
217 | # If you have perl, and it is not in /usr/local/bin, you can run | |
218 | perl util/perlpath.pl /new/path | |
219 | # and this will fix the paths in all the scripts. DO NOT put | |
220 | # /new/path/perl, just /new/path. The build | |
221 | # environment always run scripts as 'perl perlscript.pl' but some of the | |
222 | # 'applications' are easier to usr with the path fixed. | |
223 | ||
224 | # Edit crypto/cryptlib.h, tools/c_rehash, and Makefile.ssl | |
225 | # to set the install locations if you don't like | |
226 | # the default location of /usr/local/ssl | |
227 | # Do this by running | |
228 | perl util/ssldir.pl /new/ssl/home | |
229 | # if you have perl, or by hand if not. | |
230 | ||
231 | # If things have been stuffed up with the sym links, run | |
232 | make -f Makefile.ssl links | |
233 | # This will re-populate lib/include with symlinks and for each | |
234 | # directory, link Makefile to Makefile.ssl | |
235 | ||
236 | # Setup the machine dependent stuff for the top level makefile | |
237 | # and some select .h files | |
238 | # If you don't have perl, this will bomb, in which case just edit the | |
239 | # top level Makefile.ssl | |
240 | ./Configure 'system type' | |
241 | ||
242 | # The 'Configure' command contains default configuration parameters | |
243 | # for lots of machines. Configure edits 5 lines in the top level Makefile | |
244 | # It modifies the following values in the following files | |
245 | Makefile.ssl CC CFLAG EX_LIBS BN_MULW | |
246 | crypto/des/des.h DES_LONG | |
247 | crypto/des/des_locl.h DES_PTR | |
248 | crypto/md2/md2.h MD2_INT | |
249 | crypto/rc4/rc4.h RC4_INT | |
250 | crypto/rc4/rc4_enc.c RC4_INDEX | |
251 | crypto/rc2/rc2.h RC2_INT | |
252 | crypto/bf/bf_locl.h BF_INT | |
253 | crypto/idea/idea.h IDEA_INT | |
254 | crypto/bn/bn.h BN_LLONG (and defines one of SIXTY_FOUR_BIT, | |
255 | SIXTY_FOUR_BIT_LONG, THIRTY_TWO_BIT, | |
256 | SIXTEEN_BIT or EIGHT_BIT) | |
257 | Please remember that all these files are actually copies of the file with | |
258 | a .org extention. So if you change crypto/des/des.h, the next time | |
259 | you run Configure, it will be runover by a 'configured' version of | |
260 | crypto/des/des.org. So to make the changer the default, change the .org | |
261 | files. The reason these files have to be edited is because most of | |
262 | these modifications change the size of fundamental data types. | |
263 | While in theory this stuff is optional, it often makes a big | |
264 | difference in performance and when using assember, it is importaint | |
265 | for the 'Bignum bits' match those required by the assember code. | |
266 | A warning for people using gcc with sparc cpu's. Gcc needs the -mv8 | |
267 | flag to use the hardware multiply instruction which was not present in | |
268 | earlier versions of the sparc CPU. I define it by default. If you | |
269 | have an old sparc, and it crashes, try rebuilding with this flag | |
270 | removed. I am leaving this flag on by default because it makes | |
271 | things run 4 times faster :-) | |
272 | ||
273 | # clean out all the old stuff | |
274 | make clean | |
275 | ||
276 | # Do a make depend only if you have the makedepend command installed | |
277 | # This is not needed but it does make things nice when developing. | |
278 | make depend | |
279 | ||
280 | # make should build everything | |
281 | make | |
282 | ||
283 | # fix up the demo certificate hash directory if it has been stuffed up. | |
284 | make rehash | |
285 | ||
286 | # test everything | |
287 | make test | |
288 | ||
289 | # install the lot | |
290 | make install | |
291 | ||
292 | # It is worth noting that all the applications are built into the one | |
293 | # program, ssleay, which is then has links from the other programs | |
294 | # names to it. | |
295 | # The applicatons can be built by themselves, just don't define the | |
296 | # 'MONOLITH' flag. So to build the 'enc' program stand alone, | |
297 | gcc -O2 -Iinclude apps/enc.c apps/apps.c libcrypto.a | |
298 | ||
299 | # Other useful make options are | |
300 | make makefile.one | |
301 | # which generate a 'makefile.one' file which will build the complete | |
302 | # SSLeay distribution with temp. files in './tmp' and 'installable' files | |
303 | # in './out' | |
304 | ||
305 | # Have a look at running | |
306 | perl util/mk1mf.pl help | |
307 | # this can be used to generate a single makefile and is about the only | |
308 | # way to generate makefiles for windows. | |
309 | ||
310 | # There is actually a final way of building SSLeay. | |
311 | gcc -O2 -c -Icrypto -Iinclude crypto/crypto.c | |
312 | gcc -O2 -c -Issl -Iinclude ssl/ssl.c | |
313 | # and you now have the 2 libraries as single object files :-). | |
314 | # If you want to use the assember code for your particular platform | |
315 | # (DEC alpha/x86 are the main ones, the other assember is just the | |
316 | # output from gcc) you will need to link the assember with the above generated | |
317 | # object file and also do the above compile as | |
318 | gcc -O2 -DBN_ASM -c -Icrypto -Iinclude crypto/crypto.c | |
319 | ||
320 | This last option is probably the best way to go when porting to another | |
321 | platform or building shared libraries. It is not good for development so | |
322 | I don't normally use it. | |
323 | ||
324 | To build shared libararies under unix, have a look in shlib, basically | |
325 | you are on your own, but it is quite easy and all you have to do | |
326 | is compile 2 (or 3) files. | |
327 | ||
328 | For mult-threading, have a read of doc/threads.doc. Again it is quite | |
329 | easy and normally only requires some extra callbacks to be defined | |
330 | by the application. | |
331 | The examples for solaris and windows NT/95 are in the mt directory. | |
332 | ||
333 | have fun | |
334 | ||
335 | eric 25-Jun-1997 | |
336 | ||
337 | IRIX 5.x will build as a 32 bit system with mips1 assember. | |
338 | IRIX 6.x will build as a 64 bit system with mips3 assember. It conforms | |
339 | to n32 standards. In theory you can compile the 64 bit assember under | |
340 | IRIX 5.x but you will have to have the correct system software installed. |