INSTALL 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044
  1. OPENSSL INSTALLATION
  2. --------------------
  3. This document describes installation on all supported operating
  4. systems (the Linux/Unix family, OpenVMS and Windows)
  5. To install OpenSSL, you will need:
  6. * A make implementation
  7. * Perl 5 with core modules (please read NOTES.PERL)
  8. * The perl module Text::Template (please read NOTES.PERL)
  9. * an ANSI C compiler
  10. * a development environment in the form of development libraries and C
  11. header files
  12. * a supported operating system
  13. For additional platform specific requirements, solutions to specific
  14. issues and other details, please read one of these:
  15. * NOTES.UNIX (any supported Unix like system)
  16. * NOTES.VMS (OpenVMS)
  17. * NOTES.WIN (any supported Windows)
  18. * NOTES.DJGPP (DOS platform with DJGPP)
  19. Notational conventions in this document
  20. ---------------------------------------
  21. Throughout this document, we use the following conventions in command
  22. examples:
  23. $ command Any line starting with a dollar sign
  24. ($) is a command line.
  25. { word1 | word2 | word3 } This denotes a mandatory choice, to be
  26. replaced with one of the given words.
  27. A simple example would be this:
  28. $ echo { FOO | BAR | COOKIE }
  29. which is to be understood as one of
  30. these:
  31. $ echo FOO
  32. - or -
  33. $ echo BAR
  34. - or -
  35. $ echo COOKIE
  36. [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 }
  37. except it's optional to give any of
  38. those. In addition to the examples
  39. above, this would also be valid:
  40. $ echo
  41. {{ target }} This denotes a mandatory word or
  42. sequence of words of some sort. A
  43. simple example would be this:
  44. $ type {{ filename }}
  45. which is to be understood to use the
  46. command 'type' on some file name
  47. determined by the user.
  48. [[ options ]] Similar to {{ target }}, but is
  49. optional.
  50. Note that the notation assumes spaces around {, }, [, ], {{, }} and
  51. [[, ]]. This is to differentiate from OpenVMS directory
  52. specifications, which also use [ and ], but without spaces.
  53. Quick Start
  54. -----------
  55. If you want to just get on with it, do:
  56. on Unix:
  57. $ ./config
  58. $ make
  59. $ make test
  60. $ make install
  61. on OpenVMS:
  62. $ @config
  63. $ mms
  64. $ mms test
  65. $ mms install
  66. on Windows (only pick one of the targets for configuration):
  67. $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
  68. $ nmake
  69. $ nmake test
  70. $ nmake install
  71. If any of these steps fails, see section Installation in Detail below.
  72. This will build and install OpenSSL in the default location, which is:
  73. Unix: normal installation directories under /usr/local
  74. OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
  75. OpenSSL version number with underscores instead of periods.
  76. Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
  77. If you want to install it anywhere else, run config like this:
  78. On Unix:
  79. $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
  80. On OpenVMS:
  81. $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
  82. (Note: if you do add options to the configuration command, please make sure
  83. you've read more than just this Quick Start, such as relevant NOTES.* files,
  84. the options outline below, as configuration options may change the outcome
  85. in otherwise unexpected ways)
  86. Configuration Options
  87. ---------------------
  88. There are several options to ./config (or ./Configure) to customize
  89. the build (note that for Windows, the defaults for --prefix and
  90. --openssldir depend in what configuration is used and what Windows
  91. implementation OpenSSL is built on. More notes on this in NOTES.WIN):
  92. --api=x.y.z
  93. Don't build with support for deprecated APIs below the
  94. specified version number. For example "--api=1.1.0" will
  95. remove support for all APIS that were deprecated in OpenSSL
  96. version 1.1.0 or below.
  97. --cross-compile-prefix=PREFIX
  98. The PREFIX to include in front of commands for your
  99. toolchain. It's likely to have to end with dash, e.g.
  100. a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
  101. Unfortunately cross-compiling is too case-specific to
  102. put together one-size-fits-all instructions. You might
  103. have to pass more flags or set up environment variables
  104. to actually make it work. Android and iOS cases are
  105. discussed in corresponding Configurations/10-main.cf
  106. sections. But there are cases when this option alone is
  107. sufficient. For example to build the mingw64 target on
  108. Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
  109. works. Naturally provided that mingw packages are
  110. installed. Today Debian and Ubuntu users have option to
  111. install a number of prepackaged cross-compilers along
  112. with corresponding run-time and development packages for
  113. "alien" hardware. To give another example
  114. "--cross-compile-prefix=mipsel-linux-gnu-" suffices
  115. in such case. Needless to mention that you have to
  116. invoke ./Configure, not ./config, and pass your target
  117. name explicitly.
  118. --debug
  119. Build OpenSSL with debugging symbols.
  120. --libdir=DIR
  121. The name of the directory under the top of the installation
  122. directory tree (see the --prefix option) where libraries will
  123. be installed. By default this is "lib". Note that on Windows
  124. only ".lib" files will be stored in this location. dll files
  125. will always be installed to the "bin" directory.
  126. --openssldir=DIR
  127. Directory for OpenSSL configuration files, and also the
  128. default certificate and key store. Defaults are:
  129. Unix: /usr/local/ssl
  130. Windows: C:\Program Files\Common Files\SSL
  131. or C:\Program Files (x86)\Common Files\SSL
  132. OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
  133. --prefix=DIR
  134. The top of the installation directory tree. Defaults are:
  135. Unix: /usr/local
  136. Windows: C:\Program Files\OpenSSL
  137. or C:\Program Files (x86)\OpenSSL
  138. OpenVMS: SYS$COMMON:[OPENSSL-'version']
  139. --release
  140. Build OpenSSL without debugging symbols. This is the default.
  141. --strict-warnings
  142. This is a developer flag that switches on various compiler
  143. options recommended for OpenSSL development. It only works
  144. when using gcc or clang as the compiler. If you are
  145. developing a patch for OpenSSL then it is recommended that
  146. you use this option where possible.
  147. --with-zlib-include=DIR
  148. The directory for the location of the zlib include file. This
  149. option is only necessary if enable-zlib (see below) is used
  150. and the include file is not already on the system include
  151. path.
  152. --with-zlib-lib=LIB
  153. On Unix: this is the directory containing the zlib library.
  154. If not provided the system library path will be used.
  155. On Windows: this is the filename of the zlib library (with or
  156. without a path). This flag must be provided if the
  157. zlib-dynamic option is not also used. If zlib-dynamic is used
  158. then this flag is optional and a default value ("ZLIB1") is
  159. used if not provided.
  160. On VMS: this is the filename of the zlib library (with or
  161. without a path). This flag is optional and if not provided
  162. then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
  163. used by default depending on the pointer size chosen.
  164. no-afalgeng
  165. Don't build the AFALG engine. This option will be forced if
  166. on a platform that does not support AFALG.
  167. enable-asan
  168. Build with the Address sanitiser. This is a developer option
  169. only. It may not work on all platforms and should never be
  170. used in production environments. It will only work when used
  171. with gcc or clang and should be used in conjunction with the
  172. no-shared option.
  173. no-asm
  174. Do not use assembler code. On some platforms a small amount
  175. of assembler code may still be used.
  176. no-async
  177. Do not build support for async operations.
  178. no-autoalginit
  179. Don't automatically load all supported ciphers and digests.
  180. Typically OpenSSL will make available all of its supported
  181. ciphers and digests. For a statically linked application this
  182. may be undesirable if small executable size is an objective.
  183. This only affects libcrypto. Ciphers and digests will have to
  184. be loaded manually using EVP_add_cipher() and
  185. EVP_add_digest() if this option is used. This option will
  186. force a non-shared build.
  187. no-autoerrinit
  188. Don't automatically load all libcrypto/libssl error strings.
  189. Typically OpenSSL will automatically load human readable
  190. error strings. For a statically linked application this may
  191. be undesirable if small executable size is an objective.
  192. no-capieng
  193. Don't build the CAPI engine. This option will be forced if
  194. on a platform that does not support CAPI.
  195. no-cms
  196. Don't build support for CMS features
  197. no-comp
  198. Don't build support for SSL/TLS compression. If this option
  199. is left enabled (the default), then compression will only
  200. work if the zlib or zlib-dynamic options are also chosen.
  201. enable-crypto-mdebug
  202. Build support for debugging memory allocated via
  203. OPENSSL_malloc() or OPENSSL_zalloc().
  204. enable-crypto-mdebug-backtrace
  205. As for crypto-mdebug, but additionally provide backtrace
  206. information for allocated memory.
  207. TO BE USED WITH CARE: this uses GNU C functionality, and
  208. is therefore not usable for non-GNU config targets. If
  209. your build complains about the use of '-rdynamic' or the
  210. lack of header file execinfo.h, this option is not for you.
  211. ALSO NOTE that even though execinfo.h is available on your
  212. system (through Gnulib), the functions might just be stubs
  213. that do nothing.
  214. no-ct
  215. Don't build support for Certificate Transparency.
  216. no-deprecated
  217. Don't build with support for any deprecated APIs. This is the
  218. same as using "--api" and supplying the latest version
  219. number.
  220. no-dgram
  221. Don't build support for datagram based BIOs. Selecting this
  222. option will also force the disabling of DTLS.
  223. no-dso
  224. Don't build support for loading Dynamic Shared Objects.
  225. no-dynamic-engine
  226. Don't build the dynamically loaded engines. This only has an
  227. effect in a "shared" build
  228. no-ec
  229. Don't build support for Elliptic Curves.
  230. no-ec2m
  231. Don't build support for binary Elliptic Curves
  232. enable-ec_nistp_64_gcc_128
  233. Enable support for optimised implementations of some commonly
  234. used NIST elliptic curves. This is only supported on some
  235. platforms.
  236. enable-egd
  237. Build support for gathering entropy from EGD (Entropy
  238. Gathering Daemon).
  239. no-engine
  240. Don't build support for loading engines.
  241. no-err
  242. Don't compile in any error strings.
  243. enable-external-tests
  244. Enable building of integration with external test suites.
  245. This is a developer option and may not work on all platforms.
  246. The only supported external test suite at the current time is
  247. the BoringSSL test suite. See the file test/README.external
  248. for further details.
  249. no-filenames
  250. Don't compile in filename and line number information (e.g.
  251. for errors and memory allocation).
  252. enable-fuzz-libfuzzer, enable-fuzz-afl
  253. Build with support for fuzzing using either libfuzzer or AFL.
  254. These are developer options only. They may not work on all
  255. platforms and should never be used in production environments.
  256. See the file fuzz/README.md for further details.
  257. no-gost
  258. Don't build support for GOST based ciphersuites. Note that
  259. if this feature is enabled then GOST ciphersuites are only
  260. available if the GOST algorithms are also available through
  261. loading an externally supplied engine.
  262. no-hw-padlock
  263. Don't build the padlock engine.
  264. no-makedepend
  265. Don't generate dependencies.
  266. no-multiblock
  267. Don't build support for writing multiple records in one
  268. go in libssl (Note: this is a different capability to the
  269. pipelining functionality).
  270. no-nextprotoneg
  271. Don't build support for the NPN TLS extension.
  272. no-ocsp
  273. Don't build support for OCSP.
  274. no-pic
  275. Don't build with support for Position Independent Code.
  276. no-posix-io
  277. Don't use POSIX IO capabilities.
  278. no-psk
  279. Don't build support for Pre-Shared Key based ciphersuites.
  280. no-rdrand
  281. Don't use hardware RDRAND capabilities.
  282. no-rfc3779
  283. Don't build support for RFC3779 ("X.509 Extensions for IP
  284. Addresses and AS Identifiers")
  285. sctp
  286. Build support for SCTP
  287. no-shared
  288. Do not create shared libraries, only static ones. See "Note
  289. on shared libraries" below.
  290. no-sock
  291. Don't build support for socket BIOs
  292. no-srp
  293. Don't build support for SRP or SRP based ciphersuites.
  294. no-srtp
  295. Don't build SRTP support
  296. no-sse2
  297. Exclude SSE2 code paths from 32-bit x86 assembly modules.
  298. Normally SSE2 extension is detected at run-time, but the
  299. decision whether or not the machine code will be executed
  300. is taken solely on CPU capability vector. This means that
  301. if you happen to run OS kernel which does not support SSE2
  302. extension on Intel P4 processor, then your application
  303. might be exposed to "illegal instruction" exception.
  304. There might be a way to enable support in kernel, e.g.
  305. FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
  306. there is a way to disengage SSE2 code paths upon application
  307. start-up, but if you aim for wider "audience" running
  308. such kernel, consider no-sse2. Both the 386 and
  309. no-asm options imply no-sse2.
  310. enable-ssl-trace
  311. Build with the SSL Trace capabilities (adds the "-trace"
  312. option to s_client and s_server).
  313. no-static-engine
  314. Don't build the statically linked engines. This only
  315. has an impact when not built "shared".
  316. no-stdio
  317. Don't use any C "stdio" features. Only libcrypto and libssl
  318. can be built in this way. Using this option will suppress
  319. building the command line applications. Additionally since
  320. the OpenSSL tests also use the command line applications the
  321. tests will also be skipped.
  322. no-tests
  323. Don't build test programs or run any test.
  324. no-threads
  325. Don't try to build with support for multi-threaded
  326. applications.
  327. threads
  328. Build with support for multi-threaded applications. Most
  329. platforms will enable this by default. However if on a
  330. platform where this is not the case then this will usually
  331. require additional system-dependent options! See "Note on
  332. multi-threading" below.
  333. enable-tls13downgrade
  334. TODO(TLS1.3): Make this enabled by default and remove the
  335. option when TLSv1.3 is out of draft
  336. TLSv1.3 offers a downgrade protection mechanism. This is
  337. implemented but disabled by default. It should not typically
  338. be enabled except for testing purposes. Otherwise this could
  339. cause problems if a pre-RFC version of OpenSSL talks to an
  340. RFC implementation (it will erroneously be detected as a
  341. downgrade).
  342. no-ts
  343. Don't build Time Stamping Authority support.
  344. enable-ubsan
  345. Build with the Undefined Behaviour sanitiser. This is a
  346. developer option only. It may not work on all platforms and
  347. should never be used in production environments. It will only
  348. work when used with gcc or clang and should be used in
  349. conjunction with the "-DPEDANTIC" option (or the
  350. --strict-warnings option).
  351. no-ui
  352. Don't build with the "UI" capability (i.e. the set of
  353. features enabling text based prompts).
  354. enable-unit-test
  355. Enable additional unit test APIs. This should not typically
  356. be used in production deployments.
  357. enable-weak-ssl-ciphers
  358. Build support for SSL/TLS ciphers that are considered "weak"
  359. (e.g. RC4 based ciphersuites).
  360. zlib
  361. Build with support for zlib compression/decompression.
  362. zlib-dynamic
  363. Like "zlib", but has OpenSSL load the zlib library
  364. dynamically when needed. This is only supported on systems
  365. where loading of shared libraries is supported.
  366. 386
  367. In 32-bit x86 builds, when generating assembly modules,
  368. use the 80386 instruction set only (the default x86 code
  369. is more efficient, but requires at least a 486). Note:
  370. This doesn't affect code generated by compiler, you're
  371. likely to complement configuration command line with
  372. suitable compiler-specific option.
  373. enable-tls1_3
  374. TODO(TLS1.3): Make this enabled by default
  375. Build support for TLS1.3. Note: This is a WIP feature and
  376. only a single draft version is supported. Implementations
  377. of different draft versions will negotiate TLS 1.2 instead
  378. of (draft) TLS 1.3. Use with caution!!
  379. no-<prot>
  380. Don't build support for negotiating the specified SSL/TLS
  381. protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
  382. dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
  383. tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
  384. disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
  385. with "no-ssl3". Note this only affects version negotiation.
  386. OpenSSL will still provide the methods for applications to
  387. explicitly select the individual protocol versions.
  388. no-<prot>-method
  389. As for no-<prot> but in addition do not build the methods for
  390. applications to explicitly select individual protocol
  391. versions.
  392. enable-<alg>
  393. Build with support for the specified algorithm, where <alg>
  394. is one of: md2 or rc5.
  395. no-<alg>
  396. Build without support for the specified algorithm, where
  397. <alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
  398. des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, poly1305,
  399. rc2, rc4, rmd160, scrypt, seed, siphash or whirlpool. The
  400. "ripemd" algorithm is deprecated and if used is synonymous
  401. with rmd160.
  402. -Dxxx, lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
  403. These system specific options will be recognised and
  404. passed through to the compiler to allow you to define
  405. preprocessor symbols, specify additional libraries, library
  406. directories or other compiler options. It might be worth
  407. noting that some compilers generate code specifically for
  408. processor the compiler currently executes on. This is not
  409. necessarily what you might have in mind, since it might be
  410. unsuitable for execution on other, typically older,
  411. processor. Consult your compiler documentation.
  412. -xxx, +xxx
  413. Additional options that are not otherwise recognised are
  414. passed through as they are to the compiler as well. Again,
  415. consult your compiler documentation.
  416. Installation in Detail
  417. ----------------------
  418. 1a. Configure OpenSSL for your operation system automatically:
  419. NOTE: This is not available on Windows.
  420. $ ./config [[ options ]] # Unix
  421. or
  422. $ @config [[ options ]] ! OpenVMS
  423. For the remainder of this text, the Unix form will be used in all
  424. examples, please use the appropriate form for your platform.
  425. This guesses at your operating system (and compiler, if necessary) and
  426. configures OpenSSL based on this guess. Run ./config -t to see
  427. if it guessed correctly. If you want to use a different compiler, you
  428. are cross-compiling for another platform, or the ./config guess was
  429. wrong for other reasons, go to step 1b. Otherwise go to step 2.
  430. On some systems, you can include debugging information as follows:
  431. $ ./config -d [[ options ]]
  432. 1b. Configure OpenSSL for your operating system manually
  433. OpenSSL knows about a range of different operating system, hardware and
  434. compiler combinations. To see the ones it knows about, run
  435. $ ./Configure # Unix
  436. or
  437. $ perl Configure # All other platforms
  438. For the remainder of this text, the Unix form will be used in all
  439. examples, please use the appropriate form for your platform.
  440. Pick a suitable name from the list that matches your system. For most
  441. operating systems there is a choice between using "cc" or "gcc". When
  442. you have identified your system (and if necessary compiler) use this name
  443. as the argument to Configure. For example, a "linux-elf" user would
  444. run:
  445. $ ./Configure linux-elf [[ options ]]
  446. If your system isn't listed, you will have to create a configuration
  447. file named Configurations/{{ something }}.conf and add the correct
  448. configuration for your system. See the available configs as examples
  449. and read Configurations/README and Configurations/README.design for
  450. more information.
  451. The generic configurations "cc" or "gcc" should usually work on 32 bit
  452. Unix-like systems.
  453. Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
  454. and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
  455. and defines various macros in include/openssl/opensslconf.h (generated from
  456. include/openssl/opensslconf.h.in).
  457. 1c. Configure OpenSSL for building outside of the source tree.
  458. OpenSSL can be configured to build in a build directory separate from
  459. the directory with the source code. It's done by placing yourself in
  460. some other directory and invoking the configuration commands from
  461. there.
  462. Unix example:
  463. $ mkdir /var/tmp/openssl-build
  464. $ cd /var/tmp/openssl-build
  465. $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
  466. or
  467. $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
  468. OpenVMS example:
  469. $ set default sys$login:
  470. $ create/dir [.tmp.openssl-build]
  471. $ set default [.tmp.openssl-build]
  472. $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
  473. or
  474. $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
  475. Windows example:
  476. $ C:
  477. $ mkdir \temp-openssl
  478. $ cd \temp-openssl
  479. $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
  480. Paths can be relative just as well as absolute. Configure will
  481. do its best to translate them to relative paths whenever possible.
  482. 2. Build OpenSSL by running:
  483. $ make # Unix
  484. $ mms ! (or mmk) OpenVMS
  485. $ nmake # Windows
  486. This will build the OpenSSL libraries (libcrypto.a and libssl.a on
  487. Unix, corresponding on other platforms) and the OpenSSL binary
  488. ("openssl"). The libraries will be built in the top-level directory,
  489. and the binary will be in the "apps" subdirectory.
  490. If the build fails, look at the output. There may be reasons
  491. for the failure that aren't problems in OpenSSL itself (like
  492. missing standard headers). If you are having problems you can
  493. get help by sending an email to the openssl-users email list (see
  494. https://www.openssl.org/community/mailinglists.html for details). If
  495. it is a bug with OpenSSL itself, please open an issue on GitHub, at
  496. https://github.com/openssl/openssl/issues. Please review the existing
  497. ones first; maybe the bug was already reported or has already been
  498. fixed.
  499. (If you encounter assembler error messages, try the "no-asm"
  500. configuration option as an immediate fix.)
  501. Compiling parts of OpenSSL with gcc and others with the system
  502. compiler will result in unresolved symbols on some systems.
  503. 3. After a successful build, the libraries should be tested. Run:
  504. $ make test # Unix
  505. $ mms test ! OpenVMS
  506. $ nmake test # Windows
  507. NOTE: you MUST run the tests from an unprivileged account (or
  508. disable your privileges temporarily if your platform allows it).
  509. If some tests fail, look at the output. There may be reasons for
  510. the failure that isn't a problem in OpenSSL itself (like a
  511. malfunction with Perl). You may want increased verbosity, that
  512. can be accomplished like this:
  513. $ make VERBOSE=1 test # Unix
  514. $ mms /macro=(VERBOSE=1) test ! OpenVMS
  515. $ nmake VERBOSE=1 test # Windows
  516. If you want to run just one or a few specific tests, you can use
  517. the make variable TESTS to specify them, like this:
  518. $ make TESTS='test_rsa test_dsa' test # Unix
  519. $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
  520. $ nmake TESTS='test_rsa test_dsa' test # Windows
  521. And of course, you can combine (Unix example shown):
  522. $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
  523. You can find the list of available tests like this:
  524. $ make list-tests # Unix
  525. $ mms list-tests ! OpenVMS
  526. $ nmake list-tests # Windows
  527. Have a look at the manual for the perl module Test::Harness to
  528. see what other HARNESS_* variables there are.
  529. If you find a problem with OpenSSL itself, try removing any
  530. compiler optimization flags from the CFLAGS line in Makefile and
  531. run "make clean; make" or corresponding.
  532. Please send bug reports to <rt@openssl.org>.
  533. For more details on how the make variables TESTS can be used,
  534. see section TESTS in Detail below.
  535. 4. If everything tests ok, install OpenSSL with
  536. $ make install # Unix
  537. $ mms install ! OpenVMS
  538. $ nmake install # Windows
  539. This will install all the software components in this directory
  540. tree under PREFIX (the directory given with --prefix or its
  541. default):
  542. Unix:
  543. bin/ Contains the openssl binary and a few other
  544. utility scripts.
  545. include/openssl
  546. Contains the header files needed if you want
  547. to build your own programs that use libcrypto
  548. or libssl.
  549. lib Contains the OpenSSL library files.
  550. lib/engines Contains the OpenSSL dynamically loadable engines.
  551. share/man/man1 Contains the OpenSSL command line man-pages.
  552. share/man/man3 Contains the OpenSSL library calls man-pages.
  553. share/man/man5 Contains the OpenSSL configuration format man-pages.
  554. share/man/man7 Contains the OpenSSL other misc man-pages.
  555. share/doc/openssl/html/man1
  556. share/doc/openssl/html/man3
  557. share/doc/openssl/html/man5
  558. share/doc/openssl/html/man7
  559. Contains the HTML rendition of the man-pages.
  560. OpenVMS ('arch' is replaced with the architecture name, "Alpha"
  561. or "ia64", 'sover' is replaced with the shared library version
  562. (0101 for 1.1), and 'pz' is replaced with the pointer size
  563. OpenSSL was built with):
  564. [.EXE.'arch'] Contains the openssl binary.
  565. [.EXE] Contains a few utility scripts.
  566. [.include.openssl]
  567. Contains the header files needed if you want
  568. to build your own programs that use libcrypto
  569. or libssl.
  570. [.LIB.'arch'] Contains the OpenSSL library files.
  571. [.ENGINES'sover''pz'.'arch']
  572. Contains the OpenSSL dynamically loadable engines.
  573. [.SYS$STARTUP] Contains startup, login and shutdown scripts.
  574. These define appropriate logical names and
  575. command symbols.
  576. [.SYSTEST] Contains the installation verification procedure.
  577. [.HTML] Contains the HTML rendition of the manual pages.
  578. Additionally, install will add the following directories under
  579. OPENSSLDIR (the directory given with --openssldir or its default)
  580. for you convenience:
  581. certs Initially empty, this is the default location
  582. for certificate files.
  583. private Initially empty, this is the default location
  584. for private key files.
  585. misc Various scripts.
  586. Package builders who want to configure the library for standard
  587. locations, but have the package installed somewhere else so that
  588. it can easily be packaged, can use
  589. $ make DESTDIR=/tmp/package-root install # Unix
  590. $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
  591. The specified destination directory will be prepended to all
  592. installation target paths.
  593. Compatibility issues with previous OpenSSL versions:
  594. * COMPILING existing applications
  595. OpenSSL 1.1.0 hides a number of structures that were previously
  596. open. This includes all internal libssl structures and a number
  597. of EVP types. Accessor functions have been added to allow
  598. controlled access to the structures' data.
  599. This means that some software needs to be rewritten to adapt to
  600. the new ways of doing things. This often amounts to allocating
  601. an instance of a structure explicitly where you could previously
  602. allocate them on the stack as automatic variables, and using the
  603. provided accessor functions where you would previously access a
  604. structure's field directly.
  605. Some APIs have changed as well. However, older APIs have been
  606. preserved when possible.
  607. Environment Variables
  608. ---------------------
  609. A number of environment variables can be used to provide additional control
  610. over the build process. Typically these should be defined prior to running
  611. config or Configure. Not all environment variables are relevant to all
  612. platforms.
  613. AR
  614. The name of the ar executable to use.
  615. BUILDFILE
  616. Use a different build file name than the platform default
  617. ("Makefile" on Unixly platforms, "makefile" on native Windows,
  618. "descrip.mms" on OpenVMS). This requires that there is a
  619. corresponding build file template. See Configurations/README
  620. for further information.
  621. CC
  622. The compiler to use. Configure will attempt to pick a default
  623. compiler for your platform but this choice can be overridden
  624. using this variable. Set it to the compiler executable you wish
  625. to use, e.g. "gcc" or "clang".
  626. CROSS_COMPILE
  627. This environment variable has the same meaning as for the
  628. "--cross-compile-prefix" Configure flag described above. If both
  629. are set then the Configure flag takes precedence.
  630. NM
  631. The name of the nm executable to use.
  632. OPENSSL_LOCAL_CONFIG_DIR
  633. OpenSSL comes with a database of information about how it
  634. should be built on different platforms as well as build file
  635. templates for those platforms. The database is comprised of
  636. ".conf" files in the Configurations directory. The build
  637. file templates reside there as well as ".tmpl" files. See the
  638. file Configurations/README for further information about the
  639. format of ".conf" files as well as information on the ".tmpl"
  640. files.
  641. In addition to the standard ".conf" and ".tmpl" files, it is
  642. possible to create your own ".conf" and ".tmpl" files and store
  643. them locally, outside the OpenSSL source tree. This environment
  644. variable can be set to the directory where these files are held
  645. and will be considered by Configure before it looks in the
  646. standard directories.
  647. PERL
  648. The name of the Perl executable to use when building OpenSSL.
  649. This variable is used in config script only. Configure on the
  650. other hand imposes the interpreter by which it itself was
  651. executed on the whole build procedure.
  652. HASHBANGPERL
  653. The command string for the Perl executable to insert in the
  654. #! line of perl scripts that will be publically installed.
  655. Default: /usr/bin/env perl
  656. Note: the value of this variable is added to the same scripts
  657. on all platforms, but it's only relevant on Unix-like platforms.
  658. RC
  659. The name of the rc executable to use. The default will be as
  660. defined for the target platform in the ".conf" file. If not
  661. defined then "windres" will be used. The WINDRES environment
  662. variable is synonymous to this. If both are defined then RC
  663. takes precedence.
  664. RANLIB
  665. The name of the ranlib executable to use.
  666. WINDRES
  667. See RC.
  668. Makefile targets
  669. ----------------
  670. The Configure script generates a Makefile in a format relevant to the specific
  671. platform. The Makefiles provide a number of targets that can be used. Not all
  672. targets may be available on all platforms. Only the most common targets are
  673. described here. Examine the Makefiles themselves for the full list.
  674. all
  675. The default target to build all the software components.
  676. clean
  677. Remove all build artefacts and return the directory to a "clean"
  678. state.
  679. depend
  680. Rebuild the dependencies in the Makefiles. This is a legacy
  681. option that no longer needs to be used in OpenSSL 1.1.0.
  682. install
  683. Install all OpenSSL components.
  684. install_sw
  685. Only install the OpenSSL software components.
  686. install_docs
  687. Only install the OpenSSL documentation components.
  688. install_man_docs
  689. Only install the OpenSSL man pages (Unix only).
  690. install_html_docs
  691. Only install the OpenSSL html documentation.
  692. list-tests
  693. Prints a list of all the self test names.
  694. test
  695. Build and run the OpenSSL self tests.
  696. uninstall
  697. Uninstall all OpenSSL components.
  698. update
  699. This is a developer option. If you are developing a patch for
  700. OpenSSL you may need to use this if you want to update
  701. automatically generated files; add new error codes or add new
  702. (or change the visibility of) public API functions. (Unix only).
  703. TESTS in Detail
  704. ---------------
  705. The make variable TESTS supports a versatile set of space separated tokens
  706. with which you can specify a set of tests to be performed. With a "current
  707. set of tests" in mind, initially being empty, here are the possible tokens:
  708. alltests The current set of tests becomes the whole set of available
  709. tests (as listed when you do 'make list-tests' or similar).
  710. xxx Adds the test 'xxx' to the current set of tests.
  711. -xxx Removes 'xxx' from the current set of tests. If this is the
  712. first token in the list, the current set of tests is first
  713. assigned the whole set of available tests, effectively making
  714. this token equivalent to TESTS="alltests -xxx".
  715. nn Adds the test group 'nn' (which is a number) to the current
  716. set of tests.
  717. -nn Removes the test group 'nn' from the current set of tests.
  718. If this is the first token in the list, the current set of
  719. tests is first assigned the whole set of available tests,
  720. effectively making this token equivalent to
  721. TESTS="alltests -xxx".
  722. Also, all tokens except for "alltests" may have wildcards, such as *.
  723. (on Unix and Windows, BSD style wildcards are supported, while on VMS,
  724. it's VMS style wildcards)
  725. Example: All tests except for the fuzz tests:
  726. $ make TESTS=-test_fuzz test
  727. or (if you want to be explicit)
  728. $ make TESTS='alltests -test_fuzz' test
  729. Example: All tests that have a name starting with "test_ssl" but not those
  730. starting with "test_ssl_":
  731. $ make TESTS='test_ssl* -test_ssl_*' test
  732. Example: Only test group 10:
  733. $ make TESTS='10'
  734. Example: All tests except the slow group (group 99):
  735. $ make TESTS='-99'
  736. Example: All tests in test groups 80 to 99 except for tests in group 90:
  737. $ make TESTS='[89]? -90'
  738. Note on multi-threading
  739. -----------------------
  740. For some systems, the OpenSSL Configure script knows what compiler options
  741. are needed to generate a library that is suitable for multi-threaded
  742. applications. On these systems, support for multi-threading is enabled
  743. by default; use the "no-threads" option to disable (this should never be
  744. necessary).
  745. On other systems, to enable support for multi-threading, you will have
  746. to specify at least two options: "threads", and a system-dependent option.
  747. (The latter is "-D_REENTRANT" on various systems.) The default in this
  748. case, obviously, is not to include support for multi-threading (but
  749. you can still use "no-threads" to suppress an annoying warning message
  750. from the Configure script.)
  751. OpenSSL provides built-in support for two threading models: pthreads (found on
  752. most UNIX/Linux systems), and Windows threads. No other threading models are
  753. supported. If your platform does not provide pthreads or Windows threads then
  754. you should Configure with the "no-threads" option.
  755. Notes on shared libraries
  756. -------------------------
  757. For most systems the OpenSSL Configure script knows what is needed to
  758. build shared libraries for libcrypto and libssl. On these systems
  759. the shared libraries will be created by default. This can be suppressed and
  760. only static libraries created by using the "no-shared" option. On systems
  761. where OpenSSL does not know how to build shared libraries the "no-shared"
  762. option will be forced and only static libraries will be created.
  763. Shared libraries are named a little differently on different platforms.
  764. One way or another, they all have the major OpenSSL version number as
  765. part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
  766. the name.
  767. On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
  768. and libssl.so.1.1.
  769. on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
  770. with import libraries libcrypto.dll.a and libssl.dll.a.
  771. On Windows build with MSVC or using MingW, shared libraries are named
  772. libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
  773. and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
  774. and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
  775. are named libcrypto.lib and libssl.lib, while with MingW, they are named
  776. libcrypto.dll.a and libssl.dll.a.
  777. On VMS, shareable images (VMS speak for shared libraries) are named
  778. ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
  779. OpenSSL is specifically built for 32-bit pointers, the shareable images
  780. are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
  781. instead, and when built for 64-bit pointers, they are named
  782. ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
  783. Note on random number generation
  784. --------------------------------
  785. Availability of cryptographically secure random numbers is required for
  786. secret key generation. OpenSSL provides several options to seed the
  787. internal PRNG. If not properly seeded, the internal PRNG will refuse
  788. to deliver random bytes and a "PRNG not seeded error" will occur.
  789. On systems without /dev/urandom (or similar) device, it may be necessary
  790. to install additional support software to obtain a random seed.
  791. Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
  792. and the FAQ for more information.