]>
Commit | Line | Data |
---|---|---|
d5957691 MC |
1 | OPENSSL INSTALLATION |
2 | -------------------- | |
79e259e3 | 3 | |
ea24fe29 | 4 | This document describes installation on all supported operating |
630fe1da RS |
5 | systems (the Unix/Linux family (which includes Mac OS/X), OpenVMS, |
6 | and Windows). | |
4109b97c RE |
7 | |
8 | To install OpenSSL, you will need: | |
79e259e3 | 9 | |
07930a75 RL |
10 | * A make implementation |
11 | * Perl 5 with core modules (please read NOTES.PERL) | |
12 | * The perl module Text::Template (please read NOTES.PERL) | |
73bfb9ad | 13 | * an ANSI C compiler |
d5957691 | 14 | * a development environment in the form of development libraries and C |
d57d85ff | 15 | header files |
2acd8ec7 RL |
16 | * a supported operating system |
17 | ||
e8fd2a4c RL |
18 | For additional platform specific requirements, solutions to specific |
19 | issues and other details, please read one of these: | |
2acd8ec7 | 20 | |
45632ee3 | 21 | * NOTES.UNIX (any supported Unix like system) |
b32b8961 | 22 | * NOTES.VMS (OpenVMS) |
20ab55f4 | 23 | * NOTES.WIN (any supported Windows) |
07930a75 | 24 | * NOTES.DJGPP (DOS platform with DJGPP) |
f39276fd | 25 | * NOTES.ANDROID (obviously Android [NDK]) |
e616c11e | 26 | * NOTES.VALGRIND (testing with Valgrind) |
79e259e3 | 27 | |
ea24fe29 RL |
28 | Notational conventions in this document |
29 | --------------------------------------- | |
30 | ||
31 | Throughout this document, we use the following conventions in command | |
32 | examples: | |
33 | ||
34 | $ command Any line starting with a dollar sign | |
35 | ($) is a command line. | |
36 | ||
37 | { word1 | word2 | word3 } This denotes a mandatory choice, to be | |
38 | replaced with one of the given words. | |
39 | A simple example would be this: | |
40 | ||
41 | $ echo { FOO | BAR | COOKIE } | |
42 | ||
43 | which is to be understood as one of | |
44 | these: | |
45 | ||
46 | $ echo FOO | |
47 | - or - | |
48 | $ echo BAR | |
49 | - or - | |
50 | $ echo COOKIE | |
51 | ||
52 | [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 } | |
53 | except it's optional to give any of | |
54 | those. In addition to the examples | |
55 | above, this would also be valid: | |
56 | ||
57 | $ echo | |
58 | ||
59 | {{ target }} This denotes a mandatory word or | |
60 | sequence of words of some sort. A | |
61 | simple example would be this: | |
62 | ||
63 | $ type {{ filename }} | |
64 | ||
65 | which is to be understood to use the | |
66 | command 'type' on some file name | |
67 | determined by the user. | |
68 | ||
69 | [[ options ]] Similar to {{ target }}, but is | |
70 | optional. | |
71 | ||
72 | Note that the notation assumes spaces around {, }, [, ], {{, }} and | |
73 | [[, ]]. This is to differentiate from OpenVMS directory | |
74 | specifications, which also use [ and ], but without spaces. | |
75 | ||
4109b97c RE |
76 | Quick Start |
77 | ----------- | |
79e259e3 | 78 | |
4109b97c | 79 | If you want to just get on with it, do: |
79e259e3 | 80 | |
886c2e61 | 81 | on Unix (again, this includes Mac OS/X): |
2acd8ec7 RL |
82 | |
83 | $ ./config | |
84 | $ make | |
85 | $ make test | |
86 | $ make install | |
87 | ||
88 | on OpenVMS: | |
89 | ||
90 | $ @config | |
91 | $ mms | |
92 | $ mms test | |
93 | $ mms install | |
79e259e3 | 94 | |
b32b8961 RL |
95 | on Windows (only pick one of the targets for configuration): |
96 | ||
97 | $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE } | |
98 | $ nmake | |
99 | $ nmake test | |
8c16829e | 100 | $ nmake install |
b32b8961 | 101 | |
7c03bb9f MC |
102 | Note that in order to perform the install step above you need to have |
103 | appropriate permissions to write to the installation directory. | |
104 | ||
ea24fe29 | 105 | If any of these steps fails, see section Installation in Detail below. |
b1fe6b43 | 106 | |
2acd8ec7 RL |
107 | This will build and install OpenSSL in the default location, which is: |
108 | ||
109 | Unix: normal installation directories under /usr/local | |
110 | OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the | |
667c6bfe RL |
111 | OpenSSL version number with underscores instead of periods. |
112 | Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL | |
2acd8ec7 | 113 | |
7c03bb9f MC |
114 | The installation directory should be appropriately protected to ensure |
115 | unprivileged users cannot make changes to OpenSSL binaries or files, or install | |
116 | engines. If you already have a pre-installed version of OpenSSL as part of | |
117 | your Operating System it is recommended that you do not overwrite the system | |
118 | version and instead install to somewhere else. | |
119 | ||
2acd8ec7 | 120 | If you want to install it anywhere else, run config like this: |
79e259e3 | 121 | |
2acd8ec7 RL |
122 | On Unix: |
123 | ||
124 | $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl | |
125 | ||
126 | On OpenVMS: | |
127 | ||
128 | $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL] | |
79e259e3 | 129 | |
62f218cb RL |
130 | (Note: if you do add options to the configuration command, please make sure |
131 | you've read more than just this Quick Start, such as relevant NOTES.* files, | |
132 | the options outline below, as configuration options may change the outcome | |
133 | in otherwise unexpected ways) | |
134 | ||
b1fe6b43 UM |
135 | |
136 | Configuration Options | |
137 | --------------------- | |
138 | ||
2d99cee7 | 139 | There are several options to ./config (or ./Configure) to customize |
8c16829e RL |
140 | the build (note that for Windows, the defaults for --prefix and |
141 | --openssldir depend in what configuration is used and what Windows | |
142 | implementation OpenSSL is built on. More notes on this in NOTES.WIN): | |
2613c1fa | 143 | |
54a0d4ce RL |
144 | --api=x.y[.z] |
145 | Build the OpenSSL libraries to support the API for | |
146 | the specified version. If "no-deprecated" is also | |
147 | given, don't build with support for deprecated APIs | |
148 | in or below the specified version number. For example | |
149 | "--api=1.1.0" with "no-deprecated" will remove | |
150 | support for all APIS that were deprecated in | |
151 | OpenSSL version 1.1.0 or below. | |
152 | This is a rather specialized option for developers. | |
153 | If you just intend to remove all deprecated APIs | |
154 | entirely (up to the current version), only specify | |
155 | "-no-deprecated" (see below). | |
156 | If "--api" isn't given, it defaults to the current | |
157 | OpenSSL minor version. | |
462ba4f6 | 158 | |
fa28bfd6 MC |
159 | --cross-compile-prefix=PREFIX |
160 | The PREFIX to include in front of commands for your | |
85afea67 AP |
161 | toolchain. It's likely to have to end with dash, e.g. |
162 | a-b-c- would invoke GNU compiler as a-b-c-gcc, etc. | |
163 | Unfortunately cross-compiling is too case-specific to | |
164 | put together one-size-fits-all instructions. You might | |
165 | have to pass more flags or set up environment variables | |
166 | to actually make it work. Android and iOS cases are | |
f44d7e8b AP |
167 | discussed in corresponding Configurations/15-*.conf |
168 | files. But there are cases when this option alone is | |
85afea67 AP |
169 | sufficient. For example to build the mingw64 target on |
170 | Linux "--cross-compile-prefix=x86_64-w64-mingw32-" | |
171 | works. Naturally provided that mingw packages are | |
172 | installed. Today Debian and Ubuntu users have option to | |
173 | install a number of prepackaged cross-compilers along | |
174 | with corresponding run-time and development packages for | |
175 | "alien" hardware. To give another example | |
176 | "--cross-compile-prefix=mipsel-linux-gnu-" suffices | |
177 | in such case. Needless to mention that you have to | |
178 | invoke ./Configure, not ./config, and pass your target | |
f44d7e8b AP |
179 | name explicitly. Also, note that --openssldir refers |
180 | to target's file system, not one you are building on. | |
fa28bfd6 MC |
181 | |
182 | --debug | |
f44d7e8b AP |
183 | Build OpenSSL with debugging symbols and zero optimization |
184 | level. | |
fa28bfd6 MC |
185 | |
186 | --libdir=DIR | |
187 | The name of the directory under the top of the installation | |
188 | directory tree (see the --prefix option) where libraries will | |
189 | be installed. By default this is "lib". Note that on Windows | |
190 | only ".lib" files will be stored in this location. dll files | |
191 | will always be installed to the "bin" directory. | |
2acd8ec7 | 192 | |
ecabf05e MC |
193 | --openssldir=DIR |
194 | Directory for OpenSSL configuration files, and also the | |
d5957691 MC |
195 | default certificate and key store. Defaults are: |
196 | ||
667c6bfe | 197 | Unix: /usr/local/ssl |
8c16829e RL |
198 | Windows: C:\Program Files\Common Files\SSL |
199 | or C:\Program Files (x86)\Common Files\SSL | |
667c6bfe | 200 | OpenVMS: SYS$COMMON:[OPENSSL-COMMON] |
d5957691 | 201 | |
fa28bfd6 MC |
202 | --prefix=DIR |
203 | The top of the installation directory tree. Defaults are: | |
204 | ||
205 | Unix: /usr/local | |
206 | Windows: C:\Program Files\OpenSSL | |
207 | or C:\Program Files (x86)\OpenSSL | |
208 | OpenVMS: SYS$COMMON:[OPENSSL-'version'] | |
209 | ||
210 | --release | |
211 | Build OpenSSL without debugging symbols. This is the default. | |
212 | ||
213 | --strict-warnings | |
214 | This is a developer flag that switches on various compiler | |
215 | options recommended for OpenSSL development. It only works | |
216 | when using gcc or clang as the compiler. If you are | |
217 | developing a patch for OpenSSL then it is recommended that | |
218 | you use this option where possible. | |
219 | ||
220 | --with-zlib-include=DIR | |
221 | The directory for the location of the zlib include file. This | |
222 | option is only necessary if enable-zlib (see below) is used | |
223 | and the include file is not already on the system include | |
224 | path. | |
225 | ||
226 | --with-zlib-lib=LIB | |
227 | On Unix: this is the directory containing the zlib library. | |
228 | If not provided the system library path will be used. | |
229 | On Windows: this is the filename of the zlib library (with or | |
230 | without a path). This flag must be provided if the | |
231 | zlib-dynamic option is not also used. If zlib-dynamic is used | |
232 | then this flag is optional and a default value ("ZLIB1") is | |
a73d990e | 233 | used if not provided. |
fa28bfd6 MC |
234 | On VMS: this is the filename of the zlib library (with or |
235 | without a path). This flag is optional and if not provided | |
236 | then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is | |
237 | used by default depending on the pointer size chosen. | |
d5957691 | 238 | |
a73d990e DMSP |
239 | |
240 | --with-rand-seed=seed1[,seed2,...] | |
241 | A comma separated list of seeding methods which will be tried | |
242 | by OpenSSL in order to obtain random input (a.k.a "entropy") | |
243 | for seeding its cryptographically secure random number | |
244 | generator (CSPRNG). The current seeding methods are: | |
245 | ||
246 | os: Use a trusted operating system entropy source. | |
247 | This is the default method if such an entropy | |
248 | source exists. | |
14879629 KR |
249 | getrandom: Use the L<getrandom(2)> or equivalent system |
250 | call. | |
3c74e77b | 251 | devrandom: Use the first device from the DEVRANDOM list |
a73d990e DMSP |
252 | which can be opened to read random bytes. The |
253 | DEVRANDOM preprocessor constant expands to | |
254 | "/dev/urandom","/dev/random","/dev/srandom" on | |
255 | most unix-ish operating systems. | |
256 | egd: Check for an entropy generating daemon. | |
257 | rdcpu: Use the RDSEED or RDRAND command if provided by | |
258 | the CPU. | |
259 | librandom: Use librandom (not implemented yet). | |
260 | none: Disable automatic seeding. This is the default | |
261 | on some operating systems where no suitable | |
262 | entropy source exists, or no support for it is | |
263 | implemented yet. | |
264 | ||
265 | For more information, see the section 'Note on random number | |
266 | generation' at the end of this document. | |
267 | ||
ecabf05e MC |
268 | no-afalgeng |
269 | Don't build the AFALG engine. This option will be forced if | |
270 | on a platform that does not support AFALG. | |
271 | ||
69495e3d BP |
272 | enable-ktls |
273 | Build with Kernel TLS support. This option will enable the | |
274 | use of the Kernel TLS data-path, which can improve | |
275 | performance and allow for the use of sendfile and splice | |
276 | system calls on TLS sockets. The Kernel may use TLS | |
277 | accelerators if any are available on the system. | |
278 | This option will be forced off on systems that do not support | |
279 | the Kernel TLS data-path. | |
280 | ||
fa28bfd6 | 281 | enable-asan |
f430ba31 | 282 | Build with the Address sanitiser. This is a developer option |
fa28bfd6 MC |
283 | only. It may not work on all platforms and should never be |
284 | used in production environments. It will only work when used | |
285 | with gcc or clang and should be used in conjunction with the | |
286 | no-shared option. | |
287 | ||
ecabf05e | 288 | no-asm |
f529b5cf AP |
289 | Do not use assembler code. This should be viewed as |
290 | debugging/trouble-shooting option rather than production. | |
291 | On some platforms a small amount of assembler code may | |
292 | still be used even with this option. | |
ecabf05e MC |
293 | |
294 | no-async | |
295 | Do not build support for async operations. | |
d5957691 | 296 | |
ecabf05e MC |
297 | no-autoalginit |
298 | Don't automatically load all supported ciphers and digests. | |
d5957691 MC |
299 | Typically OpenSSL will make available all of its supported |
300 | ciphers and digests. For a statically linked application this | |
301 | may be undesirable if small executable size is an objective. | |
302 | This only affects libcrypto. Ciphers and digests will have to | |
303 | be loaded manually using EVP_add_cipher() and | |
ecabf05e MC |
304 | EVP_add_digest() if this option is used. This option will |
305 | force a non-shared build. | |
d5957691 | 306 | |
ecabf05e MC |
307 | no-autoerrinit |
308 | Don't automatically load all libcrypto/libssl error strings. | |
d5957691 MC |
309 | Typically OpenSSL will automatically load human readable |
310 | error strings. For a statically linked application this may | |
311 | be undesirable if small executable size is an objective. | |
312 | ||
dbabc862 BE |
313 | no-autoload-config |
314 | Don't automatically load the default openssl.cnf file. | |
315 | Typically OpenSSL will automatically load a system config | |
316 | file which configures default ssl options. | |
d5957691 | 317 | |
ac4033d6 RL |
318 | enable-buildtest-c++ |
319 | While testing, generate C++ buildtest files that | |
320 | simply check that the public OpenSSL header files | |
321 | are usable standalone with C++. | |
322 | ||
323 | Enabling this option demands extra care. For any | |
324 | compiler flag given directly as configuration | |
325 | option, you must ensure that it's valid for both | |
326 | the C and the C++ compiler. If not, the C++ build | |
327 | test will most likely break. As an alternative, | |
328 | you can use the language specific variables, CFLAGS | |
284d19c2 | 329 | and CXXFLAGS. |
ac4033d6 | 330 | |
ecabf05e MC |
331 | no-capieng |
332 | Don't build the CAPI engine. This option will be forced if | |
333 | on a platform that does not support CAPI. | |
d5957691 | 334 | |
8869ad4a AK |
335 | no-cmp |
336 | Don't build support for CMP features | |
337 | ||
ecabf05e MC |
338 | no-cms |
339 | Don't build support for CMS features | |
d5957691 | 340 | |
ecabf05e MC |
341 | no-comp |
342 | Don't build support for SSL/TLS compression. If this option | |
343 | is left enabled (the default), then compression will only | |
344 | work if the zlib or zlib-dynamic options are also chosen. | |
d5957691 | 345 | |
ecabf05e MC |
346 | enable-crypto-mdebug |
347 | Build support for debugging memory allocated via | |
348 | OPENSSL_malloc() or OPENSSL_zalloc(). | |
349 | ||
350 | enable-crypto-mdebug-backtrace | |
351 | As for crypto-mdebug, but additionally provide backtrace | |
352 | information for allocated memory. | |
8d054a55 RL |
353 | TO BE USED WITH CARE: this uses GNU C functionality, and |
354 | is therefore not usable for non-GNU config targets. If | |
355 | your build complains about the use of '-rdynamic' or the | |
356 | lack of header file execinfo.h, this option is not for you. | |
357 | ALSO NOTE that even though execinfo.h is available on your | |
358 | system (through Gnulib), the functions might just be stubs | |
359 | that do nothing. | |
ecabf05e MC |
360 | |
361 | no-ct | |
362 | Don't build support for Certificate Transparency. | |
363 | ||
364 | no-deprecated | |
54a0d4ce RL |
365 | Don't build with support for deprecated APIs up |
366 | until and including the version given with | |
367 | "--api" (or the current version of "--api" wasn't | |
368 | given). | |
ecabf05e MC |
369 | |
370 | no-dgram | |
371 | Don't build support for datagram based BIOs. Selecting this | |
372 | option will also force the disabling of DTLS. | |
373 | ||
3b2f8c77 BE |
374 | no-dso |
375 | Don't build support for loading Dynamic Shared Objects. | |
376 | ||
eb3fe0ee EQ |
377 | enable-devcryptoeng |
378 | Build the /dev/crypto engine. It is automatically selected | |
379 | on BSD implementations, in which case it can be disabled with | |
380 | no-devcryptoeng. | |
381 | ||
ecabf05e MC |
382 | no-dynamic-engine |
383 | Don't build the dynamically loaded engines. This only has an | |
384 | effect in a "shared" build | |
385 | ||
386 | no-ec | |
387 | Don't build support for Elliptic Curves. | |
388 | ||
389 | no-ec2m | |
390 | Don't build support for binary Elliptic Curves | |
391 | ||
392 | enable-ec_nistp_64_gcc_128 | |
393 | Enable support for optimised implementations of some commonly | |
b501ab6b RL |
394 | used NIST elliptic curves. |
395 | This is only supported on platforms: | |
396 | - with little-endian storage of non-byte types | |
397 | - that tolerate misaligned memory references | |
398 | - where the compiler: | |
399 | - supports the non-standard type __uint128_t | |
400 | - defines the built-in macro __SIZEOF_INT128__ | |
ecabf05e MC |
401 | |
402 | enable-egd | |
403 | Build support for gathering entropy from EGD (Entropy | |
404 | Gathering Daemon). | |
405 | ||
406 | no-engine | |
407 | Don't build support for loading engines. | |
408 | ||
409 | no-err | |
410 | Don't compile in any error strings. | |
411 | ||
ce2596d4 MC |
412 | enable-external-tests |
413 | Enable building of integration with external test suites. | |
414 | This is a developer option and may not work on all platforms. | |
415 | The only supported external test suite at the current time is | |
5227337a MC |
416 | the BoringSSL test suite. See the file test/README.external |
417 | for further details. | |
ce2596d4 | 418 | |
ecabf05e MC |
419 | no-filenames |
420 | Don't compile in filename and line number information (e.g. | |
421 | for errors and memory allocation). | |
422 | ||
e7545517 MC |
423 | no-fips |
424 | Don't compile the FIPS module | |
425 | ||
255af26c MC |
426 | enable-fuzz-libfuzzer, enable-fuzz-afl |
427 | Build with support for fuzzing using either libfuzzer or AFL. | |
428 | These are developer options only. They may not work on all | |
429 | platforms and should never be used in production environments. | |
430 | See the file fuzz/README.md for further details. | |
fa28bfd6 | 431 | |
ecabf05e MC |
432 | no-gost |
433 | Don't build support for GOST based ciphersuites. Note that | |
434 | if this feature is enabled then GOST ciphersuites are only | |
435 | available if the GOST algorithms are also available through | |
436 | loading an externally supplied engine. | |
437 | ||
d0308923 MC |
438 | no-legacy |
439 | Don't build the legacy provider. Disabling this also disables | |
440 | the legacy algorithms: MD2 (already disabled by default). | |
441 | ||
ecabf05e | 442 | no-makedepend |
05328815 | 443 | Don't generate dependencies. |
ecabf05e | 444 | |
706b6333 RL |
445 | no-module |
446 | Don't build any dynamically loadable engines. This also | |
447 | implies 'no-dynamic-engine'. | |
448 | ||
ecabf05e MC |
449 | no-multiblock |
450 | Don't build support for writing multiple records in one | |
451 | go in libssl (Note: this is a different capability to the | |
452 | pipelining functionality). | |
453 | ||
454 | no-nextprotoneg | |
455 | Don't build support for the NPN TLS extension. | |
456 | ||
457 | no-ocsp | |
458 | Don't build support for OCSP. | |
d5957691 | 459 | |
469ce8ff RL |
460 | no-padlockeng |
461 | no-hw-padlock | |
462 | Don't build the padlock engine. | |
463 | ('no-hw-padlock' is deprecated and should not be used) | |
464 | ||
ecabf05e MC |
465 | no-pic |
466 | Don't build with support for Position Independent Code. | |
d5957691 | 467 | |
41999e7d MC |
468 | no-pinshared By default OpenSSL will attempt to stay in memory until the |
469 | process exits. This is so that libcrypto and libssl can be | |
470 | properly cleaned up automatically via an "atexit()" handler. | |
471 | The handler is registered by libcrypto and cleans up both | |
472 | libraries. On some platforms the atexit() handler will run on | |
473 | unload of libcrypto (if it has been dynamically loaded) | |
474 | rather than at process exit. This option can be used to stop | |
475 | OpenSSL from attempting to stay in memory until the process | |
476 | exits. This could lead to crashes if either libcrypto or | |
477 | libssl have already been unloaded at the point | |
478 | that the atexit handler is invoked, e.g. on a platform which | |
479 | calls atexit() on unload of the library, and libssl is | |
480 | unloaded before libcrypto then a crash is likely to happen. | |
481 | Applications can suppress running of the atexit() handler at | |
482 | run time by using the OPENSSL_INIT_NO_ATEXIT option to | |
483 | OPENSSL_init_crypto(). See the man page for it for further | |
484 | details. | |
485 | ||
ecabf05e MC |
486 | no-posix-io |
487 | Don't use POSIX IO capabilities. | |
488 | ||
489 | no-psk | |
490 | Don't build support for Pre-Shared Key based ciphersuites. | |
491 | ||
492 | no-rdrand | |
493 | Don't use hardware RDRAND capabilities. | |
494 | ||
495 | no-rfc3779 | |
496 | Don't build support for RFC3779 ("X.509 Extensions for IP | |
497 | Addresses and AS Identifiers") | |
498 | ||
ecabf05e MC |
499 | sctp |
500 | Build support for SCTP | |
501 | ||
ce942199 MC |
502 | no-shared |
503 | Do not create shared libraries, only static ones. See "Note | |
504 | on shared libraries" below. | |
d5957691 | 505 | |
ecabf05e MC |
506 | no-sock |
507 | Don't build support for socket BIOs | |
d5957691 | 508 | |
ecabf05e MC |
509 | no-srp |
510 | Don't build support for SRP or SRP based ciphersuites. | |
511 | ||
512 | no-srtp | |
513 | Don't build SRTP support | |
d5957691 | 514 | |
ecabf05e | 515 | no-sse2 |
5ae5dc96 AP |
516 | Exclude SSE2 code paths from 32-bit x86 assembly modules. |
517 | Normally SSE2 extension is detected at run-time, but the | |
518 | decision whether or not the machine code will be executed | |
519 | is taken solely on CPU capability vector. This means that | |
520 | if you happen to run OS kernel which does not support SSE2 | |
521 | extension on Intel P4 processor, then your application | |
522 | might be exposed to "illegal instruction" exception. | |
523 | There might be a way to enable support in kernel, e.g. | |
524 | FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and | |
525 | there is a way to disengage SSE2 code paths upon application | |
526 | start-up, but if you aim for wider "audience" running | |
527 | such kernel, consider no-sse2. Both the 386 and | |
528 | no-asm options imply no-sse2. | |
d5957691 | 529 | |
ecabf05e MC |
530 | enable-ssl-trace |
531 | Build with the SSL Trace capabilities (adds the "-trace" | |
532 | option to s_client and s_server). | |
533 | ||
534 | no-static-engine | |
535 | Don't build the statically linked engines. This only | |
536 | has an impact when not built "shared". | |
537 | ||
538 | no-stdio | |
219b4643 MC |
539 | Don't use anything from the C header file "stdio.h" that |
540 | makes use of the "FILE" type. Only libcrypto and libssl can | |
541 | be built in this way. Using this option will suppress | |
ecabf05e MC |
542 | building the command line applications. Additionally since |
543 | the OpenSSL tests also use the command line applications the | |
544 | tests will also be skipped. | |
545 | ||
93880ce1 RL |
546 | no-tests |
547 | Don't build test programs or run any test. | |
548 | ||
ecabf05e MC |
549 | no-threads |
550 | Don't try to build with support for multi-threaded | |
551 | applications. | |
552 | ||
553 | threads | |
554 | Build with support for multi-threaded applications. Most | |
555 | platforms will enable this by default. However if on a | |
556 | platform where this is not the case then this will usually | |
557 | require additional system-dependent options! See "Note on | |
558 | multi-threading" below. | |
559 | ||
6bc62a62 DMSP |
560 | enable-trace |
561 | Build with support for the integrated tracing api. See manual pages | |
562 | OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details. | |
563 | ||
ecabf05e MC |
564 | no-ts |
565 | Don't build Time Stamping Authority support. | |
566 | ||
fa28bfd6 | 567 | enable-ubsan |
f430ba31 | 568 | Build with the Undefined Behaviour sanitiser. This is a |
fa28bfd6 MC |
569 | developer option only. It may not work on all platforms and |
570 | should never be used in production environments. It will only | |
571 | work when used with gcc or clang and should be used in | |
572 | conjunction with the "-DPEDANTIC" option (or the | |
573 | --strict-warnings option). | |
574 | ||
ecabf05e MC |
575 | no-ui |
576 | Don't build with the "UI" capability (i.e. the set of | |
577 | features enabling text based prompts). | |
578 | ||
579 | enable-unit-test | |
580 | Enable additional unit test APIs. This should not typically | |
581 | be used in production deployments. | |
582 | ||
5ded1ca6 M |
583 | no-uplink |
584 | Don't build support for UPLINK interface. | |
585 | ||
ecabf05e MC |
586 | enable-weak-ssl-ciphers |
587 | Build support for SSL/TLS ciphers that are considered "weak" | |
588 | (e.g. RC4 based ciphersuites). | |
589 | ||
590 | zlib | |
591 | Build with support for zlib compression/decompression. | |
592 | ||
593 | zlib-dynamic | |
594 | Like "zlib", but has OpenSSL load the zlib library | |
595 | dynamically when needed. This is only supported on systems | |
596 | where loading of shared libraries is supported. | |
597 | ||
598 | 386 | |
5ae5dc96 AP |
599 | In 32-bit x86 builds, when generating assembly modules, |
600 | use the 80386 instruction set only (the default x86 code | |
601 | is more efficient, but requires at least a 486). Note: | |
602 | This doesn't affect code generated by compiler, you're | |
603 | likely to complement configuration command line with | |
604 | suitable compiler-specific option. | |
d5957691 | 605 | |
ecabf05e MC |
606 | no-<prot> |
607 | Don't build support for negotiating the specified SSL/TLS | |
f518cef4 MC |
608 | protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, |
609 | tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then | |
610 | all of tls1, tls1_1, tls1_2 and tls1_3 are disabled. | |
611 | Similarly "no-dtls" will disable dtls1 and dtls1_2. The | |
612 | "no-ssl" option is synonymous with "no-ssl3". Note this only | |
613 | affects version negotiation. OpenSSL will still provide the | |
614 | methods for applications to explicitly select the individual | |
615 | protocol versions. | |
ecabf05e MC |
616 | |
617 | no-<prot>-method | |
618 | As for no-<prot> but in addition do not build the methods for | |
619 | applications to explicitly select individual protocol | |
f518cef4 MC |
620 | versions. Note that there is no "no-tls1_3-method" option |
621 | because there is no application method for TLSv1.3. Using | |
034d55cd | 622 | individual protocol methods directly is deprecated. |
f518cef4 | 623 | Applications should use TLS_method() instead. |
ecabf05e MC |
624 | |
625 | enable-<alg> | |
626 | Build with support for the specified algorithm, where <alg> | |
42e22c7c | 627 | is one of: md2 or rc5. |
ecabf05e MC |
628 | |
629 | no-<alg> | |
630 | Build without support for the specified algorithm, where | |
85d6ad34 PMS |
631 | <alg> is one of: aria, bf, blake2, camellia, cast, chacha, |
632 | cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, | |
b1ceb439 TS |
633 | poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, siv, sm2, |
634 | sm3, sm4 or whirlpool. The "ripemd" algorithm is deprecated | |
635 | and if used is synonymous with rmd160. | |
ecabf05e | 636 | |
5b18235a | 637 | -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static |
a74341f9 | 638 | These system specific options will be recognised and |
a3cb4cfc RL |
639 | passed through to the compiler to allow you to define |
640 | preprocessor symbols, specify additional libraries, library | |
641 | directories or other compiler options. It might be worth | |
642 | noting that some compilers generate code specifically for | |
643 | processor the compiler currently executes on. This is not | |
644 | necessarily what you might have in mind, since it might be | |
645 | unsuitable for execution on other, typically older, | |
646 | processor. Consult your compiler documentation. | |
647 | ||
5b18235a RL |
648 | Take note of the VAR=value documentation below and how |
649 | these flags interact with those variables. | |
650 | ||
f246f54f | 651 | -xxx, +xxx, /xxx |
a3cb4cfc | 652 | Additional options that are not otherwise recognised are |
f246f54f DMSP |
653 | passed through as they are to the compiler as well. |
654 | Unix-style options beginning with a '-' or '+' and | |
655 | Windows-style options beginning with a '/' are recognized. | |
656 | Again, consult your compiler documentation. | |
657 | ||
658 | If the option contains arguments separated by spaces, | |
659 | then the URL-style notation %20 can be used for the space | |
660 | character in order to avoid having to quote the option. | |
661 | For example, -opt%20arg gets expanded to -opt arg. | |
662 | In fact, any ASCII character can be encoded as %xx using its | |
663 | hexadecimal encoding. | |
b1fe6b43 | 664 | |
5b18235a RL |
665 | Take note of the VAR=value documentation below and how |
666 | these flags interact with those variables. | |
667 | ||
1786733e | 668 | VAR=value |
80f27877 | 669 | Assignment of environment variable for Configure. These |
1786733e RL |
670 | work just like normal environment variable assignments, |
671 | but are supported on all platforms and are confined to | |
672 | the configuration scripts only. These assignments override | |
673 | the corresponding value in the inherited environment, if | |
674 | there is one. | |
675 | ||
5b18235a RL |
676 | The following variables are used as "make variables" and |
677 | can be used as an alternative to giving preprocessor, | |
678 | compiler and linker options directly as configuration. | |
679 | The following variables are supported: | |
680 | ||
681 | AR The static library archiver. | |
682 | ARFLAGS Flags for the static library archiver. | |
683 | AS The assembler compiler. | |
684 | ASFLAGS Flags for the assembler compiler. | |
685 | CC The C compiler. | |
686 | CFLAGS Flags for the C compiler. | |
687 | CXX The C++ compiler. | |
688 | CXXFLAGS Flags for the C++ compiler. | |
689 | CPP The C/C++ preprocessor. | |
690 | CPPFLAGS Flags for the C/C++ preprocessor. | |
691 | CPPDEFINES List of CPP macro definitions, separated | |
692 | by a platform specific character (':' or | |
693 | space for Unix, ';' for Windows, ',' for | |
ec4c3891 RL |
694 | VMS). This can be used instead of using |
695 | -D (or what corresponds to that on your | |
696 | compiler) in CPPFLAGS. | |
5b18235a RL |
697 | CPPINCLUDES List of CPP inclusion directories, separated |
698 | the same way as for CPPDEFINES. This can | |
ec4c3891 RL |
699 | be used instead of -I (or what corresponds |
700 | to that on your compiler) in CPPFLAGS. | |
5b18235a | 701 | HASHBANGPERL Perl invocation to be inserted after '#!' |
ec4c3891 RL |
702 | in public perl scripts (only relevant on |
703 | Unix). | |
5b18235a RL |
704 | LD The program linker (not used on Unix, $(CC) |
705 | is used there). | |
706 | LDFLAGS Flags for the shared library, DSO and | |
707 | program linker. | |
708 | LDLIBS Extra libraries to use when linking. | |
709 | Takes the form of a space separated list | |
710 | of library specifications on Unix and | |
711 | Windows, and as a comma separated list of | |
712 | libraries on VMS. | |
713 | RANLIB The library archive indexer. | |
46d08509 | 714 | RC The Windows resource compiler. |
715 | RCFLAGS Flags for the Windows resource compiler. | |
5b18235a RL |
716 | RM The command to remove files and directories. |
717 | ||
b9201360 RL |
718 | These cannot be mixed with compiling / linking flags given |
719 | on the command line. In other words, something like this | |
720 | isn't permitted. | |
5b18235a RL |
721 | |
722 | ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE | |
723 | ||
80f27877 RL |
724 | Backward compatibility note: |
725 | ||
726 | To be compatible with older configuration scripts, the | |
727 | environment variables are ignored if compiling / linking | |
728 | flags are given on the command line, except for these: | |
729 | ||
730 | AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC | |
731 | and WINDRES | |
732 | ||
733 | For example, the following command will not see -DBAR: | |
734 | ||
735 | CPPFLAGS=-DBAR ./config -DCOOKIE | |
736 | ||
737 | However, the following will see both set variables: | |
738 | ||
739 | CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \ | |
740 | ./config -DCOOKIE | |
741 | ||
284d19c2 RL |
742 | If CC is set, it is advisable to also set CXX to ensure |
743 | both C and C++ compilers are in the same "family". This | |
744 | becomes relevant with 'enable-external-tests' and | |
745 | 'enable-buildtest-c++'. | |
746 | ||
e7a20669 RL |
747 | reconf |
748 | reconfigure | |
749 | Reconfigure from earlier data. This fetches the previous | |
750 | command line options and environment from data saved in | |
751 | "configdata.pm", and runs the configuration process again, | |
752 | using these options and environment. | |
753 | Note: NO other option is permitted together with "reconf". | |
754 | This means that you also MUST use "./Configure" (or | |
755 | what corresponds to that on non-Unix platforms) directly | |
756 | to invoke this option. | |
757 | Note: The original configuration saves away values for ALL | |
758 | environment variables that were used, and if they weren't | |
759 | defined, they are still saved away with information that | |
760 | they weren't originally defined. This information takes | |
761 | precedence over environment variables that are defined | |
762 | when reconfiguring. | |
79e259e3 | 763 | |
917a1b2e RL |
764 | Displaying configuration data |
765 | ----------------------------- | |
766 | ||
767 | The configuration script itself will say very little, and finishes by | |
768 | creating "configdata.pm". This perl module can be loaded by other scripts | |
769 | to find all the configuration data, and it can also be used as a script to | |
770 | display all sorts of configuration data in a human readable form. | |
771 | ||
772 | For more information, please do: | |
773 | ||
774 | $ ./configdata.pm --help # Unix | |
775 | ||
776 | or | |
777 | ||
778 | $ perl configdata.pm --help # Windows and VMS | |
779 | ||
4109b97c RE |
780 | Installation in Detail |
781 | ---------------------- | |
c9f06e7f | 782 | |
4109b97c | 783 | 1a. Configure OpenSSL for your operation system automatically: |
c9f06e7f | 784 | |
b32b8961 RL |
785 | NOTE: This is not available on Windows. |
786 | ||
ea24fe29 | 787 | $ ./config [[ options ]] # Unix |
2acd8ec7 RL |
788 | |
789 | or | |
790 | ||
ea24fe29 | 791 | $ @config [[ options ]] ! OpenVMS |
2acd8ec7 RL |
792 | |
793 | For the remainder of this text, the Unix form will be used in all | |
794 | examples, please use the appropriate form for your platform. | |
c9f06e7f | 795 | |
4109b97c | 796 | This guesses at your operating system (and compiler, if necessary) and |
b1fe6b43 | 797 | configures OpenSSL based on this guess. Run ./config -t to see |
db209ec2 UM |
798 | if it guessed correctly. If you want to use a different compiler, you |
799 | are cross-compiling for another platform, or the ./config guess was | |
800 | wrong for other reasons, go to step 1b. Otherwise go to step 2. | |
c9f06e7f | 801 | |
b1fe6b43 UM |
802 | On some systems, you can include debugging information as follows: |
803 | ||
ea24fe29 | 804 | $ ./config -d [[ options ]] |
b1fe6b43 | 805 | |
c9f06e7f | 806 | 1b. Configure OpenSSL for your operating system manually |
79e259e3 | 807 | |
4109b97c RE |
808 | OpenSSL knows about a range of different operating system, hardware and |
809 | compiler combinations. To see the ones it knows about, run | |
79e259e3 | 810 | |
2acd8ec7 RL |
811 | $ ./Configure # Unix |
812 | ||
813 | or | |
814 | ||
815 | $ perl Configure # All other platforms | |
816 | ||
817 | For the remainder of this text, the Unix form will be used in all | |
818 | examples, please use the appropriate form for your platform. | |
79e259e3 | 819 | |
4109b97c RE |
820 | Pick a suitable name from the list that matches your system. For most |
821 | operating systems there is a choice between using "cc" or "gcc". When | |
822 | you have identified your system (and if necessary compiler) use this name | |
2acd8ec7 | 823 | as the argument to Configure. For example, a "linux-elf" user would |
4109b97c | 824 | run: |
79e259e3 | 825 | |
ea24fe29 | 826 | $ ./Configure linux-elf [[ options ]] |
79e259e3 | 827 | |
5bb9e2b4 | 828 | If your system isn't listed, you will have to create a configuration |
ea24fe29 | 829 | file named Configurations/{{ something }}.conf and add the correct |
5bb9e2b4 RL |
830 | configuration for your system. See the available configs as examples |
831 | and read Configurations/README and Configurations/README.design for | |
832 | more information. | |
79e259e3 | 833 | |
5bb9e2b4 RL |
834 | The generic configurations "cc" or "gcc" should usually work on 32 bit |
835 | Unix-like systems. | |
836 | ||
fa28bfd6 MC |
837 | Configure creates a build file ("Makefile" on Unix, "makefile" on Windows |
838 | and "descrip.mms" on OpenVMS) from a suitable template in Configurations, | |
839 | and defines various macros in include/openssl/opensslconf.h (generated from | |
840 | include/openssl/opensslconf.h.in). | |
79e259e3 | 841 | |
2acd8ec7 RL |
842 | 1c. Configure OpenSSL for building outside of the source tree. |
843 | ||
844 | OpenSSL can be configured to build in a build directory separate from | |
845 | the directory with the source code. It's done by placing yourself in | |
846 | some other directory and invoking the configuration commands from | |
847 | there. | |
848 | ||
849 | Unix example: | |
850 | ||
851 | $ mkdir /var/tmp/openssl-build | |
852 | $ cd /var/tmp/openssl-build | |
ea24fe29 | 853 | $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]] |
2acd8ec7 RL |
854 | |
855 | or | |
856 | ||
ea24fe29 | 857 | $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]] |
2acd8ec7 RL |
858 | |
859 | OpenVMS example: | |
860 | ||
861 | $ set default sys$login: | |
862 | $ create/dir [.tmp.openssl-build] | |
863 | $ set default [.tmp.openssl-build] | |
ea24fe29 | 864 | $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]] |
2acd8ec7 RL |
865 | |
866 | or | |
867 | ||
ea24fe29 | 868 | $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]] |
2acd8ec7 | 869 | |
b32b8961 RL |
870 | Windows example: |
871 | ||
872 | $ C: | |
873 | $ mkdir \temp-openssl | |
874 | $ cd \temp-openssl | |
ea24fe29 | 875 | $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]] |
b32b8961 | 876 | |
2acd8ec7 RL |
877 | Paths can be relative just as well as absolute. Configure will |
878 | do its best to translate them to relative paths whenever possible. | |
879 | ||
462ba4f6 | 880 | 2. Build OpenSSL by running: |
79e259e3 | 881 | |
2acd8ec7 RL |
882 | $ make # Unix |
883 | $ mms ! (or mmk) OpenVMS | |
b32b8961 | 884 | $ nmake # Windows |
79e259e3 | 885 | |
2acd8ec7 RL |
886 | This will build the OpenSSL libraries (libcrypto.a and libssl.a on |
887 | Unix, corresponding on other platforms) and the OpenSSL binary | |
888 | ("openssl"). The libraries will be built in the top-level directory, | |
889 | and the binary will be in the "apps" subdirectory. | |
79e259e3 | 890 | |
1af66bb7 | 891 | Troubleshooting: |
892 | ||
1e62cc12 RS |
893 | If the build fails, look at the output. There may be reasons |
894 | for the failure that aren't problems in OpenSSL itself (like | |
1af66bb7 | 895 | missing standard headers). |
896 | ||
897 | If the build succeeded previously, but fails after a source or | |
898 | configuration change, it might be helpful to clean the build tree | |
899 | before attempting another build. Use this command: | |
900 | ||
901 | $ make clean # Unix | |
902 | $ mms clean ! (or mmk) OpenVMS | |
903 | $ nmake clean # Windows | |
904 | ||
905 | Assembler error messages can sometimes be sidestepped by using the | |
906 | "no-asm" configuration option. | |
907 | ||
908 | Compiling parts of OpenSSL with gcc and others with the system | |
909 | compiler will result in unresolved symbols on some systems. | |
910 | ||
911 | If you are still having problems you can get help by sending an email | |
912 | to the openssl-users email list (see | |
1e62cc12 RS |
913 | https://www.openssl.org/community/mailinglists.html for details). If |
914 | it is a bug with OpenSSL itself, please open an issue on GitHub, at | |
915 | https://github.com/openssl/openssl/issues. Please review the existing | |
916 | ones first; maybe the bug was already reported or has already been | |
d5957691 | 917 | fixed. |
b1fe6b43 | 918 | |
462ba4f6 | 919 | 3. After a successful build, the libraries should be tested. Run: |
79e259e3 | 920 | |
2acd8ec7 RL |
921 | $ make test # Unix |
922 | $ mms test ! OpenVMS | |
b32b8961 | 923 | $ nmake test # Windows |
79e259e3 | 924 | |
6616429d | 925 | NOTE: you MUST run the tests from an unprivileged account (or |
f430ba31 | 926 | disable your privileges temporarily if your platform allows it). |
6616429d | 927 | |
2e996acf RL |
928 | If some tests fail, look at the output. There may be reasons for |
929 | the failure that isn't a problem in OpenSSL itself (like a | |
930 | malfunction with Perl). You may want increased verbosity, that | |
931 | can be accomplished like this: | |
932 | ||
e3d9a6b5 | 933 | Verbosity on failure only (make macro VERBOSE_FAILURE or VF): |
2acd8ec7 | 934 | |
e3d9a6b5 RL |
935 | $ make VF=1 test # Unix |
936 | $ mms /macro=(VF=1) test ! OpenVMS | |
937 | $ nmake VF=1 test # Windows | |
2e996acf | 938 | |
e3d9a6b5 RL |
939 | Full verbosity (make macro VERBOSE or V): |
940 | ||
941 | $ make V=1 test # Unix | |
942 | $ mms /macro=(V=1) test ! OpenVMS | |
943 | $ nmake V=1 test # Windows | |
b32b8961 | 944 | |
2e996acf RL |
945 | If you want to run just one or a few specific tests, you can use |
946 | the make variable TESTS to specify them, like this: | |
947 | ||
2acd8ec7 RL |
948 | $ make TESTS='test_rsa test_dsa' test # Unix |
949 | $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS | |
b32b8961 | 950 | $ nmake TESTS='test_rsa test_dsa' test # Windows |
2e996acf | 951 | |
2acd8ec7 | 952 | And of course, you can combine (Unix example shown): |
a73d990e | 953 | |
e3d9a6b5 | 954 | $ make VF=1 TESTS='test_rsa test_dsa' test |
2e996acf RL |
955 | |
956 | You can find the list of available tests like this: | |
957 | ||
2acd8ec7 | 958 | $ make list-tests # Unix |
5bb9e2b4 | 959 | $ mms list-tests ! OpenVMS |
b32b8961 | 960 | $ nmake list-tests # Windows |
2e996acf | 961 | |
d40b0622 RL |
962 | Have a look at the manual for the perl module Test::Harness to |
963 | see what other HARNESS_* variables there are. | |
964 | ||
2e996acf | 965 | If you find a problem with OpenSSL itself, try removing any |
2acd8ec7 RL |
966 | compiler optimization flags from the CFLAGS line in Makefile and |
967 | run "make clean; make" or corresponding. | |
2e996acf | 968 | |
0a8ddc17 MC |
969 | To report a bug please open an issue on GitHub, at |
970 | https://github.com/openssl/openssl/issues. | |
b1fe6b43 | 971 | |
b3e718e2 RL |
972 | For more details on how the make variables TESTS can be used, |
973 | see section TESTS in Detail below. | |
974 | ||
462ba4f6 | 975 | 4. If everything tests ok, install OpenSSL with |
79e259e3 | 976 | |
2acd8ec7 RL |
977 | $ make install # Unix |
978 | $ mms install ! OpenVMS | |
fa28bfd6 | 979 | $ nmake install # Windows |
2acd8ec7 | 980 | |
7c03bb9f MC |
981 | Note that in order to perform the install step above you need to have |
982 | appropriate permissions to write to the installation directory. | |
983 | ||
984 | The above commands will install all the software components in this | |
985 | directory tree under PREFIX (the directory given with --prefix or its | |
2acd8ec7 RL |
986 | default): |
987 | ||
988 | Unix: | |
989 | ||
990 | bin/ Contains the openssl binary and a few other | |
991 | utility scripts. | |
992 | include/openssl | |
993 | Contains the header files needed if you want | |
994 | to build your own programs that use libcrypto | |
995 | or libssl. | |
996 | lib Contains the OpenSSL library files. | |
997 | lib/engines Contains the OpenSSL dynamically loadable engines. | |
ea24fe29 RL |
998 | |
999 | share/man/man1 Contains the OpenSSL command line man-pages. | |
1000 | share/man/man3 Contains the OpenSSL library calls man-pages. | |
1001 | share/man/man5 Contains the OpenSSL configuration format man-pages. | |
1002 | share/man/man7 Contains the OpenSSL other misc man-pages. | |
1003 | ||
1004 | share/doc/openssl/html/man1 | |
1005 | share/doc/openssl/html/man3 | |
1006 | share/doc/openssl/html/man5 | |
1007 | share/doc/openssl/html/man7 | |
2acd8ec7 RL |
1008 | Contains the HTML rendition of the man-pages. |
1009 | ||
1010 | OpenVMS ('arch' is replaced with the architecture name, "Alpha" | |
d178ddb3 RL |
1011 | or "ia64", 'sover' is replaced with the shared library version |
1012 | (0101 for 1.1), and 'pz' is replaced with the pointer size | |
1013 | OpenSSL was built with): | |
2acd8ec7 | 1014 | |
d178ddb3 RL |
1015 | [.EXE.'arch'] Contains the openssl binary. |
1016 | [.EXE] Contains a few utility scripts. | |
2acd8ec7 RL |
1017 | [.include.openssl] |
1018 | Contains the header files needed if you want | |
1019 | to build your own programs that use libcrypto | |
1020 | or libssl. | |
1021 | [.LIB.'arch'] Contains the OpenSSL library files. | |
d178ddb3 | 1022 | [.ENGINES'sover''pz'.'arch'] |
2acd8ec7 RL |
1023 | Contains the OpenSSL dynamically loadable engines. |
1024 | [.SYS$STARTUP] Contains startup, login and shutdown scripts. | |
1025 | These define appropriate logical names and | |
1026 | command symbols. | |
d178ddb3 RL |
1027 | [.SYSTEST] Contains the installation verification procedure. |
1028 | [.HTML] Contains the HTML rendition of the manual pages. | |
a73d990e | 1029 | |
2acd8ec7 RL |
1030 | |
1031 | Additionally, install will add the following directories under | |
1032 | OPENSSLDIR (the directory given with --openssldir or its default) | |
1033 | for you convenience: | |
1034 | ||
1035 | certs Initially empty, this is the default location | |
1036 | for certificate files. | |
1037 | private Initially empty, this is the default location | |
1038 | for private key files. | |
1039 | misc Various scripts. | |
60cdb821 | 1040 | |
7c03bb9f MC |
1041 | The installation directory should be appropriately protected to ensure |
1042 | unprivileged users cannot make changes to OpenSSL binaries or files, or | |
1043 | install engines. If you already have a pre-installed version of OpenSSL as | |
1044 | part of your Operating System it is recommended that you do not overwrite | |
1045 | the system version and instead install to somewhere else. | |
1046 | ||
e5f3045f BM |
1047 | Package builders who want to configure the library for standard |
1048 | locations, but have the package installed somewhere else so that | |
1049 | it can easily be packaged, can use | |
1050 | ||
2acd8ec7 RL |
1051 | $ make DESTDIR=/tmp/package-root install # Unix |
1052 | $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS | |
e5f3045f | 1053 | |
3c65577f | 1054 | The specified destination directory will be prepended to all |
2acd8ec7 | 1055 | installation target paths. |
4fd53220 | 1056 | |
2acd8ec7 | 1057 | Compatibility issues with previous OpenSSL versions: |
4fd53220 BM |
1058 | |
1059 | * COMPILING existing applications | |
1060 | ||
62b563b9 RL |
1061 | Starting with version 1.1.0, OpenSSL hides a number of structures |
1062 | that were previously open. This includes all internal libssl | |
1063 | structures and a number of EVP types. Accessor functions have | |
1064 | been added to allow controlled access to the structures' data. | |
4fd53220 | 1065 | |
2acd8ec7 RL |
1066 | This means that some software needs to be rewritten to adapt to |
1067 | the new ways of doing things. This often amounts to allocating | |
1068 | an instance of a structure explicitly where you could previously | |
1069 | allocate them on the stack as automatic variables, and using the | |
1070 | provided accessor functions where you would previously access a | |
1071 | structure's field directly. | |
4fd53220 | 1072 | |
2acd8ec7 RL |
1073 | Some APIs have changed as well. However, older APIs have been |
1074 | preserved when possible. | |
4fd53220 | 1075 | |
fa28bfd6 MC |
1076 | Environment Variables |
1077 | --------------------- | |
1078 | ||
1079 | A number of environment variables can be used to provide additional control | |
1080 | over the build process. Typically these should be defined prior to running | |
1081 | config or Configure. Not all environment variables are relevant to all | |
1082 | platforms. | |
1083 | ||
1084 | AR | |
1085 | The name of the ar executable to use. | |
1086 | ||
ed43fe73 RL |
1087 | BUILDFILE |
1088 | Use a different build file name than the platform default | |
46d08509 | 1089 | ("Makefile" on Unix-like platforms, "makefile" on native Windows, |
ed43fe73 RL |
1090 | "descrip.mms" on OpenVMS). This requires that there is a |
1091 | corresponding build file template. See Configurations/README | |
1092 | for further information. | |
1093 | ||
fa28bfd6 MC |
1094 | CC |
1095 | The compiler to use. Configure will attempt to pick a default | |
1096 | compiler for your platform but this choice can be overridden | |
1097 | using this variable. Set it to the compiler executable you wish | |
1098 | to use, e.g. "gcc" or "clang". | |
1099 | ||
1100 | CROSS_COMPILE | |
1101 | This environment variable has the same meaning as for the | |
1102 | "--cross-compile-prefix" Configure flag described above. If both | |
1103 | are set then the Configure flag takes precedence. | |
1104 | ||
1105 | NM | |
1106 | The name of the nm executable to use. | |
1107 | ||
1108 | OPENSSL_LOCAL_CONFIG_DIR | |
1109 | OpenSSL comes with a database of information about how it | |
bf98d9da RL |
1110 | should be built on different platforms as well as build file |
1111 | templates for those platforms. The database is comprised of | |
1112 | ".conf" files in the Configurations directory. The build | |
1113 | file templates reside there as well as ".tmpl" files. See the | |
fa28bfd6 | 1114 | file Configurations/README for further information about the |
bf98d9da RL |
1115 | format of ".conf" files as well as information on the ".tmpl" |
1116 | files. | |
1117 | In addition to the standard ".conf" and ".tmpl" files, it is | |
1118 | possible to create your own ".conf" and ".tmpl" files and store | |
1119 | them locally, outside the OpenSSL source tree. This environment | |
1120 | variable can be set to the directory where these files are held | |
b509b6d7 BK |
1121 | and will be considered by Configure before it looks in the |
1122 | standard directories. | |
fa28bfd6 MC |
1123 | |
1124 | PERL | |
d513369b | 1125 | The name of the Perl executable to use when building OpenSSL. |
758baa3d AP |
1126 | This variable is used in config script only. Configure on the |
1127 | other hand imposes the interpreter by which it itself was | |
1128 | executed on the whole build procedure. | |
d513369b RL |
1129 | |
1130 | HASHBANGPERL | |
1131 | The command string for the Perl executable to insert in the | |
1132 | #! line of perl scripts that will be publically installed. | |
1133 | Default: /usr/bin/env perl | |
1134 | Note: the value of this variable is added to the same scripts | |
1135 | on all platforms, but it's only relevant on Unix-like platforms. | |
fa28bfd6 MC |
1136 | |
1137 | RC | |
1138 | The name of the rc executable to use. The default will be as | |
1139 | defined for the target platform in the ".conf" file. If not | |
1140 | defined then "windres" will be used. The WINDRES environment | |
1141 | variable is synonymous to this. If both are defined then RC | |
1142 | takes precedence. | |
1143 | ||
1144 | RANLIB | |
1145 | The name of the ranlib executable to use. | |
1146 | ||
1147 | WINDRES | |
1148 | See RC. | |
1149 | ||
1150 | Makefile targets | |
1151 | ---------------- | |
1152 | ||
1153 | The Configure script generates a Makefile in a format relevant to the specific | |
1154 | platform. The Makefiles provide a number of targets that can be used. Not all | |
1155 | targets may be available on all platforms. Only the most common targets are | |
1156 | described here. Examine the Makefiles themselves for the full list. | |
1157 | ||
1158 | all | |
1159 | The default target to build all the software components. | |
1160 | ||
1161 | clean | |
1162 | Remove all build artefacts and return the directory to a "clean" | |
1163 | state. | |
1164 | ||
1165 | depend | |
1166 | Rebuild the dependencies in the Makefiles. This is a legacy | |
62b563b9 | 1167 | option that no longer needs to be used since OpenSSL 1.1.0. |
fa28bfd6 MC |
1168 | |
1169 | install | |
1170 | Install all OpenSSL components. | |
1171 | ||
1172 | install_sw | |
1173 | Only install the OpenSSL software components. | |
1174 | ||
1175 | install_docs | |
1176 | Only install the OpenSSL documentation components. | |
1177 | ||
1178 | install_man_docs | |
1179 | Only install the OpenSSL man pages (Unix only). | |
1180 | ||
1181 | install_html_docs | |
1182 | Only install the OpenSSL html documentation. | |
1183 | ||
1184 | list-tests | |
1185 | Prints a list of all the self test names. | |
1186 | ||
1187 | test | |
1188 | Build and run the OpenSSL self tests. | |
1189 | ||
1190 | uninstall | |
1191 | Uninstall all OpenSSL components. | |
1192 | ||
bf01fbbf RL |
1193 | reconfigure |
1194 | reconf | |
1195 | Re-run the configuration process, as exactly as the last time | |
1196 | as possible. | |
1197 | ||
fa28bfd6 MC |
1198 | update |
1199 | This is a developer option. If you are developing a patch for | |
1200 | OpenSSL you may need to use this if you want to update | |
1201 | automatically generated files; add new error codes or add new | |
1202 | (or change the visibility of) public API functions. (Unix only). | |
4fd53220 | 1203 | |
b3e718e2 RL |
1204 | TESTS in Detail |
1205 | --------------- | |
1206 | ||
1207 | The make variable TESTS supports a versatile set of space separated tokens | |
1208 | with which you can specify a set of tests to be performed. With a "current | |
1209 | set of tests" in mind, initially being empty, here are the possible tokens: | |
1210 | ||
1211 | alltests The current set of tests becomes the whole set of available | |
1212 | tests (as listed when you do 'make list-tests' or similar). | |
1213 | xxx Adds the test 'xxx' to the current set of tests. | |
1214 | -xxx Removes 'xxx' from the current set of tests. If this is the | |
1215 | first token in the list, the current set of tests is first | |
1216 | assigned the whole set of available tests, effectively making | |
d0631327 RL |
1217 | this token equivalent to TESTS="alltests -xxx". |
1218 | nn Adds the test group 'nn' (which is a number) to the current | |
1219 | set of tests. | |
1220 | -nn Removes the test group 'nn' from the current set of tests. | |
1221 | If this is the first token in the list, the current set of | |
1222 | tests is first assigned the whole set of available tests, | |
1223 | effectively making this token equivalent to | |
1224 | TESTS="alltests -xxx". | |
b3e718e2 RL |
1225 | |
1226 | Also, all tokens except for "alltests" may have wildcards, such as *. | |
1227 | (on Unix and Windows, BSD style wildcards are supported, while on VMS, | |
1228 | it's VMS style wildcards) | |
1229 | ||
1230 | Example: All tests except for the fuzz tests: | |
1231 | ||
1232 | $ make TESTS=-test_fuzz test | |
1233 | ||
1234 | or (if you want to be explicit) | |
1235 | ||
1236 | $ make TESTS='alltests -test_fuzz' test | |
1237 | ||
1238 | Example: All tests that have a name starting with "test_ssl" but not those | |
1239 | starting with "test_ssl_": | |
1240 | ||
1241 | $ make TESTS='test_ssl* -test_ssl_*' test | |
1242 | ||
d0631327 RL |
1243 | Example: Only test group 10: |
1244 | ||
1245 | $ make TESTS='10' | |
1246 | ||
1247 | Example: All tests except the slow group (group 99): | |
1248 | ||
1249 | $ make TESTS='-99' | |
1250 | ||
1251 | Example: All tests in test groups 80 to 99 except for tests in group 90: | |
1252 | ||
1253 | $ make TESTS='[89]? -90' | |
1254 | ||
5d2f3e4a P |
1255 | To stochastically verify that the algorithm that produces uniformly distributed |
1256 | random numbers is operating correctly (with a false positive rate of 0.01%): | |
1257 | ||
1258 | $ ./util/shlib_wrap.sh test/bntest -stochastic | |
1259 | ||
5f8d5c96 BM |
1260 | Note on multi-threading |
1261 | ----------------------- | |
1262 | ||
1263 | For some systems, the OpenSSL Configure script knows what compiler options | |
1264 | are needed to generate a library that is suitable for multi-threaded | |
1265 | applications. On these systems, support for multi-threading is enabled | |
1266 | by default; use the "no-threads" option to disable (this should never be | |
1267 | necessary). | |
1268 | ||
1269 | On other systems, to enable support for multi-threading, you will have | |
33d50ef6 | 1270 | to specify at least two options: "threads", and a system-dependent option. |
5f8d5c96 BM |
1271 | (The latter is "-D_REENTRANT" on various systems.) The default in this |
1272 | case, obviously, is not to include support for multi-threading (but | |
1273 | you can still use "no-threads" to suppress an annoying warning message | |
1274 | from the Configure script.) | |
1275 | ||
35d8fa56 | 1276 | OpenSSL provides built-in support for two threading models: pthreads (found on |
8b75603c MC |
1277 | most UNIX/Linux systems), and Windows threads. No other threading models are |
1278 | supported. If your platform does not provide pthreads or Windows threads then | |
1279 | you should Configure with the "no-threads" option. | |
fcc6a1c4 | 1280 | |
4fa3f08f RL |
1281 | Notes on shared libraries |
1282 | ------------------------- | |
fcc6a1c4 | 1283 | |
ce942199 MC |
1284 | For most systems the OpenSSL Configure script knows what is needed to |
1285 | build shared libraries for libcrypto and libssl. On these systems | |
1286 | the shared libraries will be created by default. This can be suppressed and | |
1287 | only static libraries created by using the "no-shared" option. On systems | |
1288 | where OpenSSL does not know how to build shared libraries the "no-shared" | |
1289 | option will be forced and only static libraries will be created. | |
96c930dd | 1290 | |
4fa3f08f RL |
1291 | Shared libraries are named a little differently on different platforms. |
1292 | One way or another, they all have the major OpenSSL version number as | |
1293 | part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of | |
1294 | the name. | |
1295 | ||
46d08509 | 1296 | On most POSIX platforms, shared libraries are named libcrypto.so.1.1 |
4fa3f08f RL |
1297 | and libssl.so.1.1. |
1298 | ||
1299 | on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll | |
1300 | with import libraries libcrypto.dll.a and libssl.dll.a. | |
1301 | ||
1302 | On Windows build with MSVC or using MingW, shared libraries are named | |
1303 | libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll | |
1304 | and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll | |
1305 | and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries | |
1306 | are named libcrypto.lib and libssl.lib, while with MingW, they are named | |
b77b6127 | 1307 | libcrypto.dll.a and libssl.dll.a. |
4fa3f08f RL |
1308 | |
1309 | On VMS, shareable images (VMS speak for shared libraries) are named | |
1310 | ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when | |
1311 | OpenSSL is specifically built for 32-bit pointers, the shareable images | |
1312 | are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe | |
1313 | instead, and when built for 64-bit pointers, they are named | |
1314 | ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe. | |
1315 | ||
96c930dd LJ |
1316 | Note on random number generation |
1317 | -------------------------------- | |
1318 | ||
1319 | Availability of cryptographically secure random numbers is required for | |
1320 | secret key generation. OpenSSL provides several options to seed the | |
a73d990e | 1321 | internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse |
96c930dd | 1322 | to deliver random bytes and a "PRNG not seeded error" will occur. |
4a9476dd | 1323 | |
a73d990e DMSP |
1324 | The seeding method can be configured using the --with-rand-seed option, |
1325 | which can be used to specify a comma separated list of seed methods. | |
1326 | However in most cases OpenSSL will choose a suitable default method, | |
46d08509 | 1327 | so it is not necessary to explicitly provide this option. Note also |
a73d990e DMSP |
1328 | that not all methods are available on all platforms. |
1329 | ||
1330 | I) On operating systems which provide a suitable randomness source (in | |
1331 | form of a system call or system device), OpenSSL will use the optimal | |
1332 | available method to seed the CSPRNG from the operating system's | |
1333 | randomness sources. This corresponds to the option --with-rand-seed=os. | |
1334 | ||
1335 | II) On systems without such a suitable randomness source, automatic seeding | |
1336 | and reseeding is disabled (--with-rand-seed=none) and it may be necessary | |
1337 | to install additional support software to obtain a random seed and reseed | |
1338 | the CSPRNG manually. Please check out the manual pages for RAND_add(), | |
1339 | RAND_bytes(), RAND_egd(), and the FAQ for more information. |