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]
24 This will build and install OpenSSL in the default location, which is (for
25 historical reasons) /usr/local/ssl. If you want to install it anywhere else,
26 do this after running `sh config':
28 $ perl util/ssldir.pl /new/install/path
30 If anything goes wrong, follow the detailed instructions below. If your
31 operating system is not (yet) supported by OpenSSL, see the section on
32 porting to a new system.
34 Installation in Detail
35 ----------------------
37 1a. Configure OpenSSL for your operation system automatically:
41 This guesses at your operating system (and compiler, if necessary) and
42 configures OpenSSL based on this guess. Check the first line of output to
43 see if it guessed correctly. If it did not get it correct or you want to
44 use a different compiler then go to step 1b. Otherwise go to step 2.
46 1b. Configure OpenSSL for your operating system manually
48 OpenSSL knows about a range of different operating system, hardware and
49 compiler combinations. To see the ones it knows about, run
53 Pick a suitable name from the list that matches your system. For most
54 operating systems there is a choice between using "cc" or "gcc". When
55 you have identified your system (and if necessary compiler) use this name
56 as the argument to ./Configure. For example, a "linux-elf" user would
59 $ ./Configure linux-elf
61 If your system is not available, you will have to edit the Configure
62 program and add the correct configuration for your system.
64 Configure configures various files by converting an existing .org file
65 into the real file. If you edit any files, remember that if a
66 corresponding .org file exists them the next time you run ./Configure
67 your changes will be lost when the file gets re-created from the .org
68 file. The files that are created from .org files are:
81 2. Set the install directory
83 If the install directory will be the default of /usr/local/ssl, skip to
84 the next stage. Otherwise, run
86 $ perl util/ssldir.pl /new/install/path
88 This configures the installation location into the "install" target of
89 the top-level Makefile, and also updates some defines in an include file
90 so that the default certificate directory is under the proper
91 installation directory. It also updates a few utility files used in the
94 3. Build OpenSSL by running:
98 This will build the OpenSSL libraries (libcrypto.a and libssl.a) and the
99 OpenSSL binary ("openssl"). The libraries will be built in the top-level
100 directory, and the binary will be in the "apps" directory.
102 4. After a successful build, the libraries should be tested. Run:
107 (The first line makes the test certificates in the "certs" directory
108 accessable via an hash name, which is required for some of the tests).
110 5. If everything tests ok, install OpenSSL with
114 This will create the installation directory (if it does not exist) and
115 then create the following subdirectories:
117 bin Contains the openssl binary and a few other
119 include Contains the header files needed if you want to
120 compile programs with libcrypto or libssl.
121 lib Contains the library files themselves and the
122 OpenSSL configuration file "openssl.cnf".
123 certs Initially empty, this is the default location
124 for certificate files.
125 private Initially empty, this is the default location
126 for private key files.
129 --------------------------------------------------------------------------------
130 The orignal Unix build instructions from SSLeay follow.
131 Note: some of this may be out of date and no longer applicable
132 --------------------------------------------------------------------------------
134 # When bringing the SSLeay distribution back from the evil intel world
135 # of Windows NT, do the following to make it nice again under unix :-)
136 # You don't normally need to run this.
137 sh util/fixNT.sh # This only works for NT now - eay - 21-Jun-1996
139 # If you have perl, and it is not in /usr/local/bin, you can run
140 perl util/perlpath.pl /new/path
141 # and this will fix the paths in all the scripts. DO NOT put
142 # /new/path/perl, just /new/path. The build
143 # environment always run scripts as 'perl perlscript.pl' but some of the
144 # 'applications' are easier to usr with the path fixed.
146 # Edit crypto/cryptlib.h, tools/c_rehash, and Makefile.ssl
147 # to set the install locations if you don't like
148 # the default location of /usr/local/ssl
150 perl util/ssldir.pl /new/ssl/home
151 # if you have perl, or by hand if not.
153 # If things have been stuffed up with the sym links, run
154 make -f Makefile.ssl links
155 # This will re-populate lib/include with symlinks and for each
156 # directory, link Makefile to Makefile.ssl
158 # Setup the machine dependent stuff for the top level makefile
159 # and some select .h files
160 # If you don't have perl, this will bomb, in which case just edit the
161 # top level Makefile.ssl
162 ./Configure 'system type'
164 # The 'Configure' command contains default configuration parameters
165 # for lots of machines. Configure edits 5 lines in the top level Makefile
166 # It modifies the following values in the following files
167 Makefile.ssl CC CFLAG EX_LIBS BN_MULW
168 crypto/des/des.h DES_LONG
169 crypto/des/des_locl.h DES_PTR
170 crypto/md2/md2.h MD2_INT
171 crypto/rc4/rc4.h RC4_INT
172 crypto/rc4/rc4_enc.c RC4_INDEX
173 crypto/rc2/rc2.h RC2_INT
174 crypto/bf/bf_locl.h BF_INT
175 crypto/idea/idea.h IDEA_INT
176 crypto/bn/bn.h BN_LLONG (and defines one of SIXTY_FOUR_BIT,
177 SIXTY_FOUR_BIT_LONG, THIRTY_TWO_BIT,
178 SIXTEEN_BIT or EIGHT_BIT)
179 Please remember that all these files are actually copies of the file with
180 a .org extention. So if you change crypto/des/des.h, the next time
181 you run Configure, it will be runover by a 'configured' version of
182 crypto/des/des.org. So to make the changer the default, change the .org
183 files. The reason these files have to be edited is because most of
184 these modifications change the size of fundamental data types.
185 While in theory this stuff is optional, it often makes a big
186 difference in performance and when using assember, it is importaint
187 for the 'Bignum bits' match those required by the assember code.
188 A warning for people using gcc with sparc cpu's. Gcc needs the -mv8
189 flag to use the hardware multiply instruction which was not present in
190 earlier versions of the sparc CPU. I define it by default. If you
191 have an old sparc, and it crashes, try rebuilding with this flag
192 removed. I am leaving this flag on by default because it makes
193 things run 4 times faster :-)
195 # clean out all the old stuff
198 # Do a make depend only if you have the makedepend command installed
199 # This is not needed but it does make things nice when developing.
202 # make should build everything
205 # fix up the demo certificate hash directory if it has been stuffed up.
214 # It is worth noting that all the applications are built into the one
215 # program, ssleay, which is then has links from the other programs
217 # The applicatons can be built by themselves, just don't define the
218 # 'MONOLITH' flag. So to build the 'enc' program stand alone,
219 gcc -O2 -Iinclude apps/enc.c apps/apps.c libcrypto.a
221 # Other useful make options are
223 # which generate a 'makefile.one' file which will build the complete
224 # SSLeay distribution with temp. files in './tmp' and 'installable' files
227 # Have a look at running
228 perl util/mk1mf.pl help
229 # this can be used to generate a single makefile and is about the only
230 # way to generate makefiles for windows.
232 # There is actually a final way of building SSLeay.
233 gcc -O2 -c -Icrypto -Iinclude crypto/crypto.c
234 gcc -O2 -c -Issl -Iinclude ssl/ssl.c
235 # and you now have the 2 libraries as single object files :-).
236 # If you want to use the assember code for your particular platform
237 # (DEC alpha/x86 are the main ones, the other assember is just the
238 # output from gcc) you will need to link the assember with the above generated
239 # object file and also do the above compile as
240 gcc -O2 -DBN_ASM -c -Icrypto -Iinclude crypto/crypto.c
242 This last option is probably the best way to go when porting to another
243 platform or building shared libraries. It is not good for development so
244 I don't normally use it.
246 To build shared libararies under unix, have a look in shlib, basically
247 you are on your own, but it is quite easy and all you have to do
248 is compile 2 (or 3) files.
250 For mult-threading, have a read of doc/threads.doc. Again it is quite
251 easy and normally only requires some extra callbacks to be defined
253 The examples for solaris and windows NT/95 are in the mt directory.
259 IRIX 5.x will build as a 32 bit system with mips1 assember.
260 IRIX 6.x will build as a 64 bit system with mips3 assember. It conforms
261 to n32 standards. In theory you can compile the 64 bit assember under
262 IRIX 5.x but you will have to have the correct system software installed.