2
0

INSTALL 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  1. INSTALLATION ON THE UNIX PLATFORM
  2. ---------------------------------
  3. [Installation on DOS (with djgpp), Windows, OpenVMS, MacOS (before MacOS X)
  4. and NetWare is described in INSTALL.DJGPP, INSTALL.W32, INSTALL.VMS,
  5. INSTALL.MacOS and INSTALL.NW.
  6. This document describes installation on operating systems in the Unix
  7. family.]
  8. To install OpenSSL, you will need:
  9. * make
  10. * Perl 5
  11. * an ANSI C compiler
  12. * a development environment in form of development libraries and C
  13. header files
  14. * a supported Unix operating system
  15. Quick Start
  16. -----------
  17. If you want to just get on with it, do:
  18. $ ./config
  19. $ make
  20. $ make test
  21. $ make install
  22. [If any of these steps fails, see section Installation in Detail below.]
  23. This will build and install OpenSSL in the default location, which is (for
  24. historical reasons) /usr/local/ssl. If you want to install it anywhere else,
  25. run config like this:
  26. $ ./config --prefix=/usr/local --openssldir=/usr/local/openssl
  27. Configuration Options
  28. ---------------------
  29. There are several options to ./config (or ./Configure) to customize
  30. the build:
  31. --prefix=DIR Install in DIR/bin, DIR/lib, DIR/include/openssl.
  32. Configuration files used by OpenSSL will be in DIR/ssl
  33. or the directory specified by --openssldir.
  34. --openssldir=DIR Directory for OpenSSL files. If no prefix is specified,
  35. the library files and binaries are also installed there.
  36. no-threads Don't try to build with support for multi-threaded
  37. applications.
  38. threads Build with support for multi-threaded applications.
  39. This will usually require additional system-dependent options!
  40. See "Note on multi-threading" below.
  41. no-zlib Don't try to build with support for zlib compression and
  42. decompression.
  43. zlib Build with support for zlib compression/decompression.
  44. zlib-dynamic Like "zlib", but has OpenSSL load the zlib library dynamically
  45. when needed. This is only supported on systems where loading
  46. of shared libraries is supported. This is the default choice.
  47. no-shared Don't try to create shared libraries.
  48. shared In addition to the usual static libraries, create shared
  49. libraries on platforms where it's supported. See "Note on
  50. shared libraries" below.
  51. no-asm Do not use assembler code.
  52. 386 Use the 80386 instruction set only (the default x86 code is
  53. more efficient, but requires at least a 486). Note: Use
  54. compiler flags for any other CPU specific configuration,
  55. e.g. "-m32" to build x86 code on an x64 system.
  56. no-sse2 Exclude SSE2 code pathes. Normally SSE2 extention is
  57. detected at run-time, but the decision whether or not the
  58. machine code will be executed is taken solely on CPU
  59. capability vector. This means that if you happen to run OS
  60. kernel which does not support SSE2 extension on Intel P4
  61. processor, then your application might be exposed to
  62. "illegal instruction" exception. There might be a way
  63. to enable support in kernel, e.g. FreeBSD kernel can be
  64. compiled with CPU_ENABLE_SSE, and there is a way to
  65. disengage SSE2 code pathes upon application start-up,
  66. but if you aim for wider "audience" running such kernel,
  67. consider no-sse2. Both 386 and no-asm options above imply
  68. no-sse2.
  69. no-<cipher> Build without the specified cipher (bf, cast, des, dh, dsa,
  70. hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha).
  71. The crypto/<cipher> directory can be removed after running
  72. "make depend".
  73. -Dxxx, -lxxx, -Lxxx, -fxxx, -mXXX, -Kxxx These system specific options will
  74. be passed through to the compiler to allow you to
  75. define preprocessor symbols, specify additional libraries,
  76. library directories or other compiler options.
  77. Installation in Detail
  78. ----------------------
  79. 1a. Configure OpenSSL for your operation system automatically:
  80. $ ./config [options]
  81. This guesses at your operating system (and compiler, if necessary) and
  82. configures OpenSSL based on this guess. Run ./config -t to see
  83. if it guessed correctly. If you want to use a different compiler, you
  84. are cross-compiling for another platform, or the ./config guess was
  85. wrong for other reasons, go to step 1b. Otherwise go to step 2.
  86. On some systems, you can include debugging information as follows:
  87. $ ./config -d [options]
  88. 1b. Configure OpenSSL for your operating system manually
  89. OpenSSL knows about a range of different operating system, hardware and
  90. compiler combinations. To see the ones it knows about, run
  91. $ ./Configure
  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. $ ./Configure linux-elf [options]
  98. If your system is not available, you will have to edit the Configure
  99. program and add the correct configuration for your system. The
  100. generic configurations "cc" or "gcc" should usually work on 32 bit
  101. systems.
  102. Configure creates the file Makefile.ssl from Makefile.org and
  103. defines various macros in crypto/opensslconf.h (generated from
  104. crypto/opensslconf.h.in).
  105. 2. Build OpenSSL by running:
  106. $ make
  107. This will build the OpenSSL libraries (libcrypto.a and libssl.a) and the
  108. OpenSSL binary ("openssl"). The libraries will be built in the top-level
  109. directory, and the binary will be in the "apps" directory.
  110. If "make" fails, look at the output. There may be reasons for
  111. the failure that aren't problems in OpenSSL itself (like missing
  112. standard headers). If it is a problem with OpenSSL itself, please
  113. report the problem to <openssl-bugs@openssl.org> (note that your
  114. message will be recorded in the request tracker publicly readable
  115. via http://www.openssl.org/support/rt.html and will be forwarded to a
  116. public mailing list). Include the output of "make report" in your message.
  117. Please check out the request tracker. Maybe the bug was already
  118. reported or has already been fixed.
  119. [If you encounter assembler error messages, try the "no-asm"
  120. configuration option as an immediate fix.]
  121. Compiling parts of OpenSSL with gcc and others with the system
  122. compiler will result in unresolved symbols on some systems.
  123. 3. After a successful build, the libraries should be tested. Run:
  124. $ make test
  125. If a test fails, look at the output. There may be reasons for
  126. the failure that isn't a problem in OpenSSL itself (like a missing
  127. or malfunctioning bc). If it is a problem with OpenSSL itself,
  128. try removing any compiler optimization flags from the CFLAG line
  129. in Makefile.ssl and run "make clean; make". Please send a bug
  130. report to <openssl-bugs@openssl.org>, including the output of
  131. "make report" in order to be added to the request tracker at
  132. http://www.openssl.org/support/rt.html.
  133. 4. If everything tests ok, install OpenSSL with
  134. $ make install
  135. This will create the installation directory (if it does not exist) and
  136. then the following subdirectories:
  137. certs Initially empty, this is the default location
  138. for certificate files.
  139. man/man1 Manual pages for the 'openssl' command line tool
  140. man/man3 Manual pages for the libraries (very incomplete)
  141. misc Various scripts.
  142. private Initially empty, this is the default location
  143. for private key files.
  144. If you didn't choose a different installation prefix, the
  145. following additional subdirectories will be created:
  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. lib Contains the OpenSSL library files themselves.
  151. Use "make install_sw" to install the software without documentation,
  152. and "install_docs_html" to install HTML renditions of the manual
  153. pages.
  154. Package builders who want to configure the library for standard
  155. locations, but have the package installed somewhere else so that
  156. it can easily be packaged, can use
  157. $ make INSTALL_PREFIX=/tmp/package-root install
  158. (or specify "--install_prefix=/tmp/package-root" as a configure
  159. option). The specified prefix will be prepended to all
  160. installation target filenames.
  161. NOTE: The header files used to reside directly in the include
  162. directory, but have now been moved to include/openssl so that
  163. OpenSSL can co-exist with other libraries which use some of the
  164. same filenames. This means that applications that use OpenSSL
  165. should now use C preprocessor directives of the form
  166. #include <openssl/ssl.h>
  167. instead of "#include <ssl.h>", which was used with library versions
  168. up to OpenSSL 0.9.2b.
  169. If you install a new version of OpenSSL over an old library version,
  170. you should delete the old header files in the include directory.
  171. Compatibility issues:
  172. * COMPILING existing applications
  173. To compile an application that uses old filenames -- e.g.
  174. "#include <ssl.h>" --, it will usually be enough to find
  175. the CFLAGS definition in the application's Makefile and
  176. add a C option such as
  177. -I/usr/local/ssl/include/openssl
  178. to it.
  179. But don't delete the existing -I option that points to
  180. the ..../include directory! Otherwise, OpenSSL header files
  181. could not #include each other.
  182. * WRITING applications
  183. To write an application that is able to handle both the new
  184. and the old directory layout, so that it can still be compiled
  185. with library versions up to OpenSSL 0.9.2b without bothering
  186. the user, you can proceed as follows:
  187. - Always use the new filename of OpenSSL header files,
  188. e.g. #include <openssl/ssl.h>.
  189. - Create a directory "incl" that contains only a symbolic
  190. link named "openssl", which points to the "include" directory
  191. of OpenSSL.
  192. For example, your application's Makefile might contain the
  193. following rule, if OPENSSLDIR is a pathname (absolute or
  194. relative) of the directory where OpenSSL resides:
  195. incl/openssl:
  196. -mkdir incl
  197. cd $(OPENSSLDIR) # Check whether the directory really exists
  198. -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl
  199. You will have to add "incl/openssl" to the dependencies
  200. of those C files that include some OpenSSL header file.
  201. - Add "-Iincl" to your CFLAGS.
  202. With these additions, the OpenSSL header files will be available
  203. under both name variants if an old library version is used:
  204. Your application can reach them under names like <openssl/foo.h>,
  205. while the header files still are able to #include each other
  206. with names of the form <foo.h>.
  207. Note on multi-threading
  208. -----------------------
  209. For some systems, the OpenSSL Configure script knows what compiler options
  210. are needed to generate a library that is suitable for multi-threaded
  211. applications. On these systems, support for multi-threading is enabled
  212. by default; use the "no-threads" option to disable (this should never be
  213. necessary).
  214. On other systems, to enable support for multi-threading, you will have
  215. to specify at least two options: "threads", and a system-dependent option.
  216. (The latter is "-D_REENTRANT" on various systems.) The default in this
  217. case, obviously, is not to include support for multi-threading (but
  218. you can still use "no-threads" to suppress an annoying warning message
  219. from the Configure script.)
  220. Note on shared libraries
  221. ------------------------
  222. Shared libraries have certain caveats. Binary backward compatibility
  223. can't be guaranteed before OpenSSL version 1.0. The only reason to
  224. use them would be to conserve memory on systems where several programs
  225. are using OpenSSL.
  226. For some systems, the OpenSSL Configure script knows what is needed to
  227. build shared libraries for libcrypto and libssl. On these systems,
  228. the shared libraries are currently not created by default, but giving
  229. the option "shared" will get them created. This method supports Makefile
  230. targets for shared library creation, like linux-shared. Those targets
  231. can currently be used on their own just as well, but this is expected
  232. to change in future versions of OpenSSL.
  233. Note on random number generation
  234. --------------------------------
  235. Availability of cryptographically secure random numbers is required for
  236. secret key generation. OpenSSL provides several options to seed the
  237. internal PRNG. If not properly seeded, the internal PRNG will refuse
  238. to deliver random bytes and a "PRNG not seeded error" will occur.
  239. On systems without /dev/urandom (or similar) device, it may be necessary
  240. to install additional support software to obtain random seed.
  241. Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
  242. and the FAQ for more information.
  243. Note on support for multiple builds
  244. -----------------------------------
  245. OpenSSL is usually built in its source tree. Unfortunately, this doesn't
  246. support building for multiple platforms from the same source tree very well.
  247. It is however possible to build in a separate tree through the use of lots
  248. of symbolic links, which should be prepared like this:
  249. mkdir -p objtree/"`uname -s`-`uname -r`-`uname -m`"
  250. cd objtree/"`uname -s`-`uname -r`-`uname -m`"
  251. (cd $OPENSSL_SOURCE; find . -type f) | while read F; do
  252. mkdir -p `dirname $F`
  253. rm -f $F; ln -s $OPENSSL_SOURCE/$F $F
  254. echo $F '->' $OPENSSL_SOURCE/$F
  255. done
  256. make -f Makefile.org clean
  257. OPENSSL_SOURCE is an environment variable that contains the absolute (this
  258. is important!) path to the OpenSSL source tree.
  259. Also, operations like 'make update' should still be made in the source tree.