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