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