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      (note that your message will be forwarded to a public mailing list).
 120      Include the output of "./config -t" and the OpenSSL version
 121      number in your message.
 122
 123      [If you encounter assembler error messages, try the "no-asm"
 124      configuration option as an immediate fix.]
 125
 126      Compiling parts of OpenSSL with gcc and others with the system
 127      compiler will result in unresolved symbols on some systems.
 128
 129   3. After a successful build, the libraries should be tested. Run:
 130
 131        $ make test
 132
 133     If a test fails, try removing any compiler optimization flags from
 134     the CFLAGS line in Makefile.ssl and run "make clean; make". Please
 135     send a bug report to <openssl-bugs@openssl.org>, including the
 136     output of "openssl version -a" and of the failed test.
 137
 138   4. If everything tests ok, install OpenSSL with
 139
 140        $ make install
 141
 142      This will create the installation directory (if it does not exist) and
 143      then the following subdirectories:
 144
 145        certs           Initially empty, this is the default location
 146                        for certificate files.
 147        misc            Various scripts.
 148        private         Initially empty, this is the default location
 149                        for private key files.
 150
 151      If you didn't choose a different installation prefix, the
 152      following additional subdirectories will be created:
 153
 154        bin             Contains the openssl binary and a few other
 155                        utility programs.
 156        include/openssl Contains the header files needed if you want to
 157                        compile programs with libcrypto or libssl.
 158        lib             Contains the OpenSSL library files themselves.
 159
 160      Package builders who want to configure the library for standard
 161      locations, but have the package installed somewhere else so that
 162      it can easily be packaged, can use
 163
 164        $ make INSTALL_PREFIX=/tmp/package-root install
 165
 166      (or specify "--install_prefix=/tmp/package-root" as a configure
 167      option).  The specified prefix will be prepended to all
 168      installation target filenames.
 169
 170
 171   NOTE: The header files used to reside directly in the include
 172   directory, but have now been moved to include/openssl so that
 173   OpenSSL can co-exist with other libraries which use some of the
 174   same filenames.  This means that applications that use OpenSSL
 175   should now use C preprocessor directives of the form
 176
 177        #include <openssl/ssl.h>
 178
 179   instead of "#include <ssl.h>", which was used with library versions
 180   up to OpenSSL 0.9.2b.
 181
 182   If you install a new version of OpenSSL over an old library version,
 183   you should delete the old header files in the include directory.
 184
 185   Compatibility issues:
 186
 187   *  COMPILING existing applications
 188
 189      To compile an application that uses old filenames -- e.g.
 190      "#include <ssl.h>" --, it will usually be enough to find
 191      the CFLAGS definition in the application's Makefile and
 192      add a C option such as
 193
 194           -I/usr/local/ssl/include/openssl
 195
 196      to it.
 197
 198      But don't delete the existing -I option that points to
 199      the ..../include directory!  Otherwise, OpenSSL header files
 200      could not #include each other.
 201
 202   *  WRITING applications
 203
 204      To write an application that is able to handle both the new
 205      and the old directory layout, so that it can still be compiled
 206      with library versions up to OpenSSL 0.9.2b without bothering
 207      the user, you can proceed as follows:
 208
 209      -  Always use the new filename of OpenSSL header files,
 210         e.g. #include <openssl/ssl.h>.
 211
 212      -  Create a directory "incl" that contains only a symbolic
 213         link named "openssl", which points to the "include" directory
 214         of OpenSSL.
 215         For example, your application's Makefile might contain the
 216         following rule, if OPENSSLDIR is a pathname (absolute or
 217         relative) of the directory where OpenSSL resides:
 218
 219         incl/openssl:
 220                 -mkdir incl
 221                 cd $(OPENSSLDIR) # Check whether the directory really exists
 222                 -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl
 223
 224         You will have to add "incl/openssl" to the dependencies
 225         of those C files that include some OpenSSL header file.
 226
 227      -  Add "-Iincl" to your CFLAGS.
 228
 229      With these additions, the OpenSSL header files will be available
 230      under both name variants if an old library version is used:
 231      Your application can reach them under names like <openssl/foo.h>,
 232      while the header files still are able to #include each other
 233      with names of the form <foo.h>.
 234
 235
 236  Note on multi-threading
 237  -----------------------
 238
 239  For some systems, the OpenSSL Configure script knows what compiler options
 240  are needed to generate a library that is suitable for multi-threaded
 241  applications.  On these systems, support for multi-threading is enabled
 242  by default; use the "no-threads" option to disable (this should never be
 243  necessary).
 244
 245  On other systems, to enable support for multi-threading, you will have
 246  to specify at least two options: "threads", and a system-dependent option.
 247  (The latter is "-D_REENTRANT" on various systems.)  The default in this
 248  case, obviously, is not to include support for multi-threading (but
 249  you can still use "no-threads" to suppress an annoying warning message
 250  from the Configure script.)
 251