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