INSTALL@ 88135

Last change on this file since 88135 was 87984, checked in by vboxsync, 4 years ago
openssl-1.1.1j: Applied and adjusted our OpenSSL changes to 1.1.1j. bugref:9963
File size: 56.5 KB

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

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/libs/openssl-1.1.1j/INSTALL@ 88135

Download in other formats: