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:
18 $ ./config [if this fails, go to step 1b below]
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,
27 $ ./config --prefix=/usr/local --openssldir=/usr/local/openssl
29 There are several options to ./config to customize the build:
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.
35 --openssldir=DIR Directory for OpenSSL files. If no prefix is specified,
36 the library files and binaries are also installed there.
38 rsaref Build with RSADSI's RSAREF toolkit.
40 no-threads Don't try to build with support for multi-threaded
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.
47 no-asm Build with no assembler code.
49 386 Use the 80386 instruction set only (the default x86 code is
50 more efficient, but requires at least a 486).
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.
56 Installation in Detail
57 ----------------------
59 1a. Configure OpenSSL for your operation system automatically:
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.
68 1b. Configure OpenSSL for your operating system manually
70 OpenSSL knows about a range of different operating system, hardware and
71 compiler combinations. To see the ones it knows about, run
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
81 $ ./Configure linux-elf [--prefix=DIR] [--openssldir=OPENSSLDIR]
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.
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).
91 2. Build OpenSSL by running:
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.
99 3. After a successful build, the libraries should be tested. Run:
103 4. If everything tests ok, install OpenSSL with
107 This will create the installation directory (if it does not exist) and
108 then create the following subdirectories:
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".
116 If you didn't chose a different installation prefix, lib also contains
117 the library files themselves, and the following additional subdirectories
120 bin Contains the openssl binary and a few other
122 include/openssl Contains the header files needed if you want to
123 compile programs with libcrypto or libssl.
125 Package builders who want to configure the library for standard
126 locations, but have the package installed somewhere else so that
127 it can easily be packaged, can use
129 $ make INSTALL_PREFIX=/tmp/package-root install
131 (or specify "-install_prefix=/tmp/package-root" as a configure
132 option). The specified prefix will be prepended to all
133 installation target filenames.
136 NOTE: The header files used to reside directly in the include
137 directory, but have now been moved to include/openssl so that
138 OpenSSL can co-exist with other libraries which use some of the
139 same filenames. This means that applications that use OpenSSL
140 should now use C preprocessor directives of the form
142 #include <openssl/ssl.h>
144 instead of "#include <ssl.h>", which was used with library versions
145 up to OpenSSL 0.9.2b.
147 If you install a new version of OpenSSL over an old library version,
148 you should delete the old header files in the include directory.
150 Compatibility issues:
152 * COMPILING existing applications
154 To compile an application that uses old filenames -- e.g.
155 "#include <ssl.h>" --, it will usually be enough to find
156 the CFLAGS definition in the application's Makefile and
157 add a C option such as
159 -I/usr/local/ssl/include/openssl
163 But don't delete the existing -I option that points to
164 the ..../include directory! Otherwise, OpenSSL header files
165 could not #include each other.
167 * WRITING applications
169 To write an application that is able to handle both the new
170 and the old directory layout, so that it can still be compiled
171 with library versions up to OpenSSL 0.9.2b without bothering
172 the user, you can proceed as follows:
174 - Always use the new filename of OpenSSL header files,
175 e.g. #include <openssl/ssl.h>.
177 - Create a directory "incl" that contains only a symbolic
178 link named "openssl", which points to the "include" directory
180 For example, your application's Makefile might contain the
181 following rule, if OPENSSLDIR is a pathname (absolute or
182 relative) of the directory where OpenSSL resides:
186 cd $(OPENSSLDIR) # Check whether the directory really exists
187 -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl
189 You will have to add "incl/openssl" to the dependencies
190 of those C files that include some OpenSSL header file.
192 - Add "-Iincl" to your CFLAGS.
194 With these additions, the OpenSSL header files will be available
195 under both name variants if an old library version is used:
196 Your application can reach them under names like <openssl/foo.h>,
197 while the header files still are able to #include each other
198 with names of the form <foo.h>.
201 Note on multi-threading
202 -----------------------
204 For some systems, the OpenSSL Configure script knows what compiler options
205 are needed to generate a library that is suitable for multi-threaded
206 applications. On these systems, support for multi-threading is enabled
207 by default; use the "no-threads" option to disable (this should never be
210 On other systems, to enable support for multi-threading, you will have
211 to specifiy at least two options: "threads", and a system-dependent option.
212 (The latter is "-D_REENTRANT" on various systems.) The default in this
213 case, obviously, is not to include support for multi-threading (but
214 you can still use "no-threads" to suppress an annoying warning message
215 from the Configure script.)
218 --------------------------------------------------------------------------------
219 The orignal Unix build instructions from SSLeay follow.
220 Note: some of this may be out of date and no longer applicable
221 --------------------------------------------------------------------------------
223 # When bringing the SSLeay distribution back from the evil intel world
224 # of Windows NT, do the following to make it nice again under unix :-)
225 # You don't normally need to run this.
226 sh util/fixNT.sh # This only works for NT now - eay - 21-Jun-1996
228 # If you have perl, and it is not in /usr/local/bin, you can run
229 perl util/perlpath.pl /new/path
230 # and this will fix the paths in all the scripts. DO NOT put
231 # /new/path/perl, just /new/path. The build
232 # environment always run scripts as 'perl perlscript.pl' but some of the
233 # 'applications' are easier to usr with the path fixed.
235 # Edit crypto/cryptlib.h, tools/c_rehash, and Makefile.ssl
236 # to set the install locations if you don't like
237 # the default location of /usr/local/ssl
239 perl util/ssldir.pl /new/ssl/home
240 # if you have perl, or by hand if not.
242 # If things have been stuffed up with the sym links, run
243 make -f Makefile.ssl links
244 # This will re-populate lib/include with symlinks and for each
245 # directory, link Makefile to Makefile.ssl
247 # Setup the machine dependent stuff for the top level makefile
248 # and some select .h files
249 # If you don't have perl, this will bomb, in which case just edit the
250 # top level Makefile.ssl
251 ./Configure 'system type'
253 # The 'Configure' command contains default configuration parameters
254 # for lots of machines. Configure edits 5 lines in the top level Makefile
255 # It modifies the following values in the following files
256 Makefile.ssl CC CFLAG EX_LIBS BN_MULW
257 crypto/des/des.h DES_LONG
258 crypto/des/des_locl.h DES_PTR
259 crypto/md2/md2.h MD2_INT
260 crypto/rc4/rc4.h RC4_INT
261 crypto/rc4/rc4_enc.c RC4_INDEX
262 crypto/rc2/rc2.h RC2_INT
263 crypto/bf/bf_locl.h BF_INT
264 crypto/idea/idea.h IDEA_INT
265 crypto/bn/bn.h BN_LLONG (and defines one of SIXTY_FOUR_BIT,
266 SIXTY_FOUR_BIT_LONG, THIRTY_TWO_BIT,
267 SIXTEEN_BIT or EIGHT_BIT)
268 Please remember that all these files are actually copies of the file with
269 a .org extention. So if you change crypto/des/des.h, the next time
270 you run Configure, it will be runover by a 'configured' version of
271 crypto/des/des.org. So to make the changer the default, change the .org
272 files. The reason these files have to be edited is because most of
273 these modifications change the size of fundamental data types.
274 While in theory this stuff is optional, it often makes a big
275 difference in performance and when using assember, it is importaint
276 for the 'Bignum bits' match those required by the assember code.
277 A warning for people using gcc with sparc cpu's. Gcc needs the -mv8
278 flag to use the hardware multiply instruction which was not present in
279 earlier versions of the sparc CPU. I define it by default. If you
280 have an old sparc, and it crashes, try rebuilding with this flag
281 removed. I am leaving this flag on by default because it makes
282 things run 4 times faster :-)
284 # clean out all the old stuff
287 # Do a make depend only if you have the makedepend command installed
288 # This is not needed but it does make things nice when developing.
291 # make should build everything
294 # fix up the demo certificate hash directory if it has been stuffed up.
303 # It is worth noting that all the applications are built into the one
304 # program, ssleay, which is then has links from the other programs
306 # The applicatons can be built by themselves, just don't define the
307 # 'MONOLITH' flag. So to build the 'enc' program stand alone,
308 gcc -O2 -Iinclude apps/enc.c apps/apps.c libcrypto.a
310 # Other useful make options are
312 # which generate a 'makefile.one' file which will build the complete
313 # SSLeay distribution with temp. files in './tmp' and 'installable' files
316 # Have a look at running
317 perl util/mk1mf.pl help
318 # this can be used to generate a single makefile and is about the only
319 # way to generate makefiles for windows.
321 # There is actually a final way of building SSLeay.
322 gcc -O2 -c -Icrypto -Iinclude crypto/crypto.c
323 gcc -O2 -c -Issl -Iinclude ssl/ssl.c
324 # and you now have the 2 libraries as single object files :-).
325 # If you want to use the assember code for your particular platform
326 # (DEC alpha/x86 are the main ones, the other assember is just the
327 # output from gcc) you will need to link the assember with the above generated
328 # object file and also do the above compile as
329 gcc -O2 -DBN_ASM -c -Icrypto -Iinclude crypto/crypto.c
331 This last option is probably the best way to go when porting to another
332 platform or building shared libraries. It is not good for development so
333 I don't normally use it.
335 To build shared libararies under unix, have a look in shlib, basically
336 you are on your own, but it is quite easy and all you have to do
337 is compile 2 (or 3) files.
339 For mult-threading, have a read of doc/threads.doc. Again it is quite
340 easy and normally only requires some extra callbacks to be defined
342 The examples for solaris and windows NT/95 are in the mt directory.
348 IRIX 5.x will build as a 32 bit system with mips1 assember.
349 IRIX 6.x will build as a 64 bit system with mips3 assember. It conforms
350 to n32 standards. In theory you can compile the 64 bit assember under
351 IRIX 5.x but you will have to have the correct system software installed.