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 "./config -t" and the OpenSSL version
121 number in your message.
123 [If you encounter assembler error messages, try the "no-asm"
124 configuration option as an immediate fix.]
126 Compiling parts of OpenSSL with gcc and others with the system
127 compiler will result in unresolved symbols on some systems.
129 3. After a successful build, the libraries should be tested. Run:
133 If a test fails, try removing any compiler optimization flags from
134 the CFLAGS line in Makefile.ssl and run "make clean; make". Please
135 send a bug report to <openssl-bugs@openssl.org>, including the
136 output of "openssl version -a" and of the failed test.
138 4. If everything tests ok, install OpenSSL with
142 This will create the installation directory (if it does not exist) and
143 then the following subdirectories:
145 certs Initially empty, this is the default location
146 for certificate files.
147 misc Various scripts.
148 private Initially empty, this is the default location
149 for private key files.
151 If you didn't choose a different installation prefix, the
152 following additional subdirectories will be created:
154 bin Contains the openssl binary and a few other
156 include/openssl Contains the header files needed if you want to
157 compile programs with libcrypto or libssl.
158 lib Contains the OpenSSL library files themselves.
160 Package builders who want to configure the library for standard
161 locations, but have the package installed somewhere else so that
162 it can easily be packaged, can use
164 $ make INSTALL_PREFIX=/tmp/package-root install
166 (or specify "--install_prefix=/tmp/package-root" as a configure
167 option). The specified prefix will be prepended to all
168 installation target filenames.
171 NOTE: The header files used to reside directly in the include
172 directory, but have now been moved to include/openssl so that
173 OpenSSL can co-exist with other libraries which use some of the
174 same filenames. This means that applications that use OpenSSL
175 should now use C preprocessor directives of the form
177 #include <openssl/ssl.h>
179 instead of "#include <ssl.h>", which was used with library versions
180 up to OpenSSL 0.9.2b.
182 If you install a new version of OpenSSL over an old library version,
183 you should delete the old header files in the include directory.
185 Compatibility issues:
187 * COMPILING existing applications
189 To compile an application that uses old filenames -- e.g.
190 "#include <ssl.h>" --, it will usually be enough to find
191 the CFLAGS definition in the application's Makefile and
192 add a C option such as
194 -I/usr/local/ssl/include/openssl
198 But don't delete the existing -I option that points to
199 the ..../include directory! Otherwise, OpenSSL header files
200 could not #include each other.
202 * WRITING applications
204 To write an application that is able to handle both the new
205 and the old directory layout, so that it can still be compiled
206 with library versions up to OpenSSL 0.9.2b without bothering
207 the user, you can proceed as follows:
209 - Always use the new filename of OpenSSL header files,
210 e.g. #include <openssl/ssl.h>.
212 - Create a directory "incl" that contains only a symbolic
213 link named "openssl", which points to the "include" directory
215 For example, your application's Makefile might contain the
216 following rule, if OPENSSLDIR is a pathname (absolute or
217 relative) of the directory where OpenSSL resides:
221 cd $(OPENSSLDIR) # Check whether the directory really exists
222 -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl
224 You will have to add "incl/openssl" to the dependencies
225 of those C files that include some OpenSSL header file.
227 - Add "-Iincl" to your CFLAGS.
229 With these additions, the OpenSSL header files will be available
230 under both name variants if an old library version is used:
231 Your application can reach them under names like <openssl/foo.h>,
232 while the header files still are able to #include each other
233 with names of the form <foo.h>.
236 Note on multi-threading
237 -----------------------
239 For some systems, the OpenSSL Configure script knows what compiler options
240 are needed to generate a library that is suitable for multi-threaded
241 applications. On these systems, support for multi-threading is enabled
242 by default; use the "no-threads" option to disable (this should never be
245 On other systems, to enable support for multi-threading, you will have
246 to specify at least two options: "threads", and a system-dependent option.
247 (The latter is "-D_REENTRANT" on various systems.) The default in this
248 case, obviously, is not to include support for multi-threading (but
249 you can still use "no-threads" to suppress an annoying warning message
250 from the Configure script.)
253 --------------------------------------------------------------------------------
254 The orignal Unix build instructions from SSLeay follow.
255 Note: some of this may be out of date and no longer applicable
256 --------------------------------------------------------------------------------
258 # When bringing the SSLeay distribution back from the evil intel world
259 # of Windows NT, do the following to make it nice again under unix :-)
260 # You don't normally need to run this.
261 sh util/fixNT.sh # This only works for NT now - eay - 21-Jun-1996
263 # If you have perl, and it is not in /usr/local/bin, you can run
264 perl util/perlpath.pl /new/path
265 # and this will fix the paths in all the scripts. DO NOT put
266 # /new/path/perl, just /new/path. The build
267 # environment always run scripts as 'perl perlscript.pl' but some of the
268 # 'applications' are easier to usr with the path fixed.
270 # Edit crypto/cryptlib.h, tools/c_rehash, and Makefile.ssl
271 # to set the install locations if you don't like
272 # the default location of /usr/local/ssl
274 perl util/ssldir.pl /new/ssl/home
275 # if you have perl, or by hand if not.
277 # If things have been stuffed up with the sym links, run
278 make -f Makefile.ssl links
279 # This will re-populate lib/include with symlinks and for each
280 # directory, link Makefile to Makefile.ssl
282 # Setup the machine dependent stuff for the top level makefile
283 # and some select .h files
284 # If you don't have perl, this will bomb, in which case just edit the
285 # top level Makefile.ssl
286 ./Configure 'system type'
288 # The 'Configure' command contains default configuration parameters
289 # for lots of machines. Configure edits 5 lines in the top level Makefile
290 # It modifies the following values in the following files
291 Makefile.ssl CC CFLAG EX_LIBS BN_MULW
292 crypto/des/des.h DES_LONG
293 crypto/des/des_locl.h DES_PTR
294 crypto/md2/md2.h MD2_INT
295 crypto/rc4/rc4.h RC4_INT
296 crypto/rc4/rc4_enc.c RC4_INDEX
297 crypto/rc2/rc2.h RC2_INT
298 crypto/bf/bf_locl.h BF_INT
299 crypto/idea/idea.h IDEA_INT
300 crypto/bn/bn.h BN_LLONG (and defines one of SIXTY_FOUR_BIT,
301 SIXTY_FOUR_BIT_LONG, THIRTY_TWO_BIT,
302 SIXTEEN_BIT or EIGHT_BIT)
303 Please remember that all these files are actually copies of the file with
304 a .org extention. So if you change crypto/des/des.h, the next time
305 you run Configure, it will be runover by a 'configured' version of
306 crypto/des/des.org. So to make the changer the default, change the .org
307 files. The reason these files have to be edited is because most of
308 these modifications change the size of fundamental data types.
309 While in theory this stuff is optional, it often makes a big
310 difference in performance and when using assember, it is importaint
311 for the 'Bignum bits' match those required by the assember code.
312 A warning for people using gcc with sparc cpu's. Gcc needs the -mv8
313 flag to use the hardware multiply instruction which was not present in
314 earlier versions of the sparc CPU. I define it by default. If you
315 have an old sparc, and it crashes, try rebuilding with this flag
316 removed. I am leaving this flag on by default because it makes
317 things run 4 times faster :-)
319 # clean out all the old stuff
322 # Do a make depend only if you have the makedepend command installed
323 # This is not needed but it does make things nice when developing.
326 # make should build everything
329 # fix up the demo certificate hash directory if it has been stuffed up.
338 # It is worth noting that all the applications are built into the one
339 # program, ssleay, which is then has links from the other programs
341 # The applicatons can be built by themselves, just don't define the
342 # 'MONOLITH' flag. So to build the 'enc' program stand alone,
343 gcc -O2 -Iinclude apps/enc.c apps/apps.c libcrypto.a
345 # Other useful make options are
347 # which generate a 'makefile.one' file which will build the complete
348 # SSLeay distribution with temp. files in './tmp' and 'installable' files
351 # Have a look at running
352 perl util/mk1mf.pl help
353 # this can be used to generate a single makefile and is about the only
354 # way to generate makefiles for windows.
356 # There is actually a final way of building SSLeay.
357 gcc -O2 -c -Icrypto -Iinclude crypto/crypto.c
358 gcc -O2 -c -Issl -Iinclude ssl/ssl.c
359 # and you now have the 2 libraries as single object files :-).
360 # If you want to use the assember code for your particular platform
361 # (DEC alpha/x86 are the main ones, the other assember is just the
362 # output from gcc) you will need to link the assember with the above generated
363 # object file and also do the above compile as
364 gcc -O2 -DBN_ASM -c -Icrypto -Iinclude crypto/crypto.c
366 This last option is probably the best way to go when porting to another
367 platform or building shared libraries. It is not good for development so
368 I don't normally use it.
370 To build shared libararies under unix, have a look in shlib, basically
371 you are on your own, but it is quite easy and all you have to do
372 is compile 2 (or 3) files.
374 For mult-threading, have a read of doc/threads.doc. Again it is quite
375 easy and normally only requires some extra callbacks to be defined
377 The examples for solaris and windows NT/95 are in the mt directory.
383 IRIX 5.x will build as a 32 bit system with mips1 assember.
384 IRIX 6.x will build as a 64 bit system with mips3 assember. It conforms
385 to n32 standards. In theory you can compile the 64 bit assember under
386 IRIX 5.x but you will have to have the correct system software installed.