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