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