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