2 INSTALLATION ON THE UNIX PLATFORM
3 ---------------------------------
5 [For instructions for compiling OpenSSL on Windows systems, see INSTALL.W32].
7 To install OpenSSL, you will need:
11 * a supported Unix operating system
16 If you want to just get on with it, do:
23 [If any of these steps fails, see section Installation in Detail below.
24 During "./config", you will see the message
25 c_rehash: rehashing skipped ('openssl' program not available).
26 This is inevitable at that stage and does not indicate any error.]
28 This will build and install OpenSSL in the default location, which is (for
29 historical reasons) /usr/local/ssl. If you want to install it anywhere else,
32 $ ./config --prefix=/usr/local --openssldir=/usr/local/openssl
38 There are several options to ./config to customize the build:
40 --prefix=DIR Install in DIR/bin, DIR/lib, DIR/include/openssl.
41 Configuration files used by OpenSSL will be in DIR/ssl
42 or the directory specified by --openssldir.
44 --openssldir=DIR Directory for OpenSSL files. If no prefix is specified,
45 the library files and binaries are also installed there.
47 rsaref Build with RSADSI's RSAREF toolkit (this assumes that
48 librsaref.a is in the library search path).
50 no-threads Don't try to build with support for multi-threaded
53 threads Build with support for multi-threaded applications.
54 This will usually require additional system-dependent options!
55 See "Note on multi-threading" below.
57 no-asm Do not use assembler code.
59 386 Use the 80386 instruction set only (the default x86 code is
60 more efficient, but requires at least a 486).
62 no-<cipher> Build without the specified cipher (bf, cast, des, dh, dsa,
63 hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha).
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 Include the output of "./config -t" and the OpenSSL version
120 number in your message.
122 3. After a successful build, the libraries should be tested. Run:
126 If a test fails, try removing any compiler optimization flags from
127 the CFLAGS line in Makefile.ssl and run "make clean; make". Please
128 send a bug report to <openssl-bugs@openssl.org>, including the
129 output of "openssl version -a" and of the failed test.
131 4. If everything tests ok, install OpenSSL with
135 This will create the installation directory (if it does not exist) and
136 then create the following subdirectories:
138 certs Initially empty, this is the default location
139 for certificate files.
140 lib Contains the OpenSSL configuration file "openssl.cnf".
141 misc Various scripts.
142 private Initially empty, this is the default location
143 for private key files.
145 If you didn't chose a different installation prefix, lib also contains
146 the library files themselves, and the following additional subdirectories
149 bin Contains the openssl binary and a few other
151 include/openssl Contains the header files needed if you want to
152 compile programs with libcrypto or libssl.
154 Package builders who want to configure the library for standard
155 locations, but have the package installed somewhere else so that
156 it can easily be packaged, can use
158 $ make INSTALL_PREFIX=/tmp/package-root install
160 (or specify "--install_prefix=/tmp/package-root" as a configure
161 option). The specified prefix will be prepended to all
162 installation target filenames.
165 NOTE: The header files used to reside directly in the include
166 directory, but have now been moved to include/openssl so that
167 OpenSSL can co-exist with other libraries which use some of the
168 same filenames. This means that applications that use OpenSSL
169 should now use C preprocessor directives of the form
171 #include <openssl/ssl.h>
173 instead of "#include <ssl.h>", which was used with library versions
174 up to OpenSSL 0.9.2b.
176 If you install a new version of OpenSSL over an old library version,
177 you should delete the old header files in the include directory.
179 Compatibility issues:
181 * COMPILING existing applications
183 To compile an application that uses old filenames -- e.g.
184 "#include <ssl.h>" --, it will usually be enough to find
185 the CFLAGS definition in the application's Makefile and
186 add a C option such as
188 -I/usr/local/ssl/include/openssl
192 But don't delete the existing -I option that points to
193 the ..../include directory! Otherwise, OpenSSL header files
194 could not #include each other.
196 * WRITING applications
198 To write an application that is able to handle both the new
199 and the old directory layout, so that it can still be compiled
200 with library versions up to OpenSSL 0.9.2b without bothering
201 the user, you can proceed as follows:
203 - Always use the new filename of OpenSSL header files,
204 e.g. #include <openssl/ssl.h>.
206 - Create a directory "incl" that contains only a symbolic
207 link named "openssl", which points to the "include" directory
209 For example, your application's Makefile might contain the
210 following rule, if OPENSSLDIR is a pathname (absolute or
211 relative) of the directory where OpenSSL resides:
215 cd $(OPENSSLDIR) # Check whether the directory really exists
216 -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl
218 You will have to add "incl/openssl" to the dependencies
219 of those C files that include some OpenSSL header file.
221 - Add "-Iincl" to your CFLAGS.
223 With these additions, the OpenSSL header files will be available
224 under both name variants if an old library version is used:
225 Your application can reach them under names like <openssl/foo.h>,
226 while the header files still are able to #include each other
227 with names of the form <foo.h>.
230 Note on multi-threading
231 -----------------------
233 For some systems, the OpenSSL Configure script knows what compiler options
234 are needed to generate a library that is suitable for multi-threaded
235 applications. On these systems, support for multi-threading is enabled
236 by default; use the "no-threads" option to disable (this should never be
239 On other systems, to enable support for multi-threading, you will have
240 to specifiy at least two options: "threads", and a system-dependent option.
241 (The latter is "-D_REENTRANT" on various systems.) The default in this
242 case, obviously, is not to include support for multi-threading (but
243 you can still use "no-threads" to suppress an annoying warning message
244 from the Configure script.)
247 --------------------------------------------------------------------------------
248 The orignal Unix build instructions from SSLeay follow.
249 Note: some of this may be out of date and no longer applicable
250 --------------------------------------------------------------------------------
252 # When bringing the SSLeay distribution back from the evil intel world
253 # of Windows NT, do the following to make it nice again under unix :-)
254 # You don't normally need to run this.
255 sh util/fixNT.sh # This only works for NT now - eay - 21-Jun-1996
257 # If you have perl, and it is not in /usr/local/bin, you can run
258 perl util/perlpath.pl /new/path
259 # and this will fix the paths in all the scripts. DO NOT put
260 # /new/path/perl, just /new/path. The build
261 # environment always run scripts as 'perl perlscript.pl' but some of the
262 # 'applications' are easier to usr with the path fixed.
264 # Edit crypto/cryptlib.h, tools/c_rehash, and Makefile.ssl
265 # to set the install locations if you don't like
266 # the default location of /usr/local/ssl
268 perl util/ssldir.pl /new/ssl/home
269 # if you have perl, or by hand if not.
271 # If things have been stuffed up with the sym links, run
272 make -f Makefile.ssl links
273 # This will re-populate lib/include with symlinks and for each
274 # directory, link Makefile to Makefile.ssl
276 # Setup the machine dependent stuff for the top level makefile
277 # and some select .h files
278 # If you don't have perl, this will bomb, in which case just edit the
279 # top level Makefile.ssl
280 ./Configure 'system type'
282 # The 'Configure' command contains default configuration parameters
283 # for lots of machines. Configure edits 5 lines in the top level Makefile
284 # It modifies the following values in the following files
285 Makefile.ssl CC CFLAG EX_LIBS BN_MULW
286 crypto/des/des.h DES_LONG
287 crypto/des/des_locl.h DES_PTR
288 crypto/md2/md2.h MD2_INT
289 crypto/rc4/rc4.h RC4_INT
290 crypto/rc4/rc4_enc.c RC4_INDEX
291 crypto/rc2/rc2.h RC2_INT
292 crypto/bf/bf_locl.h BF_INT
293 crypto/idea/idea.h IDEA_INT
294 crypto/bn/bn.h BN_LLONG (and defines one of SIXTY_FOUR_BIT,
295 SIXTY_FOUR_BIT_LONG, THIRTY_TWO_BIT,
296 SIXTEEN_BIT or EIGHT_BIT)
297 Please remember that all these files are actually copies of the file with
298 a .org extention. So if you change crypto/des/des.h, the next time
299 you run Configure, it will be runover by a 'configured' version of
300 crypto/des/des.org. So to make the changer the default, change the .org
301 files. The reason these files have to be edited is because most of
302 these modifications change the size of fundamental data types.
303 While in theory this stuff is optional, it often makes a big
304 difference in performance and when using assember, it is importaint
305 for the 'Bignum bits' match those required by the assember code.
306 A warning for people using gcc with sparc cpu's. Gcc needs the -mv8
307 flag to use the hardware multiply instruction which was not present in
308 earlier versions of the sparc CPU. I define it by default. If you
309 have an old sparc, and it crashes, try rebuilding with this flag
310 removed. I am leaving this flag on by default because it makes
311 things run 4 times faster :-)
313 # clean out all the old stuff
316 # Do a make depend only if you have the makedepend command installed
317 # This is not needed but it does make things nice when developing.
320 # make should build everything
323 # fix up the demo certificate hash directory if it has been stuffed up.
332 # It is worth noting that all the applications are built into the one
333 # program, ssleay, which is then has links from the other programs
335 # The applicatons can be built by themselves, just don't define the
336 # 'MONOLITH' flag. So to build the 'enc' program stand alone,
337 gcc -O2 -Iinclude apps/enc.c apps/apps.c libcrypto.a
339 # Other useful make options are
341 # which generate a 'makefile.one' file which will build the complete
342 # SSLeay distribution with temp. files in './tmp' and 'installable' files
345 # Have a look at running
346 perl util/mk1mf.pl help
347 # this can be used to generate a single makefile and is about the only
348 # way to generate makefiles for windows.
350 # There is actually a final way of building SSLeay.
351 gcc -O2 -c -Icrypto -Iinclude crypto/crypto.c
352 gcc -O2 -c -Issl -Iinclude ssl/ssl.c
353 # and you now have the 2 libraries as single object files :-).
354 # If you want to use the assember code for your particular platform
355 # (DEC alpha/x86 are the main ones, the other assember is just the
356 # output from gcc) you will need to link the assember with the above generated
357 # object file and also do the above compile as
358 gcc -O2 -DBN_ASM -c -Icrypto -Iinclude crypto/crypto.c
360 This last option is probably the best way to go when porting to another
361 platform or building shared libraries. It is not good for development so
362 I don't normally use it.
364 To build shared libararies under unix, have a look in shlib, basically
365 you are on your own, but it is quite easy and all you have to do
366 is compile 2 (or 3) files.
368 For mult-threading, have a read of doc/threads.doc. Again it is quite
369 easy and normally only requires some extra callbacks to be defined
371 The examples for solaris and windows NT/95 are in the mt directory.
377 IRIX 5.x will build as a 32 bit system with mips1 assember.
378 IRIX 6.x will build as a 64 bit system with mips3 assember. It conforms
379 to n32 standards. In theory you can compile the 64 bit assember under
380 IRIX 5.x but you will have to have the correct system software installed.