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