2 INSTALLATION ON WINDOWS PLATFORMS
3 ---------------------------------
5 [Instructions for building for Windows CE can be found in INSTALL.WCE]
7 Here are a few comments about building OpenSSL for Windows environments.
9 - you need Perl. Unless you will build on Cygwin, you will need
10 ActiveState Perl, available from http://www.activestate.com/ActivePerl.
11 You also need the perl module Text::Template, available on CPAN.
12 Please read README.PERL for more information.
14 - one of the following C compilers:
17 * GNU C (Cygwin or MinGW)
19 - Netwide Assembler, a.k.a. NASM, available from http://www.nasm.us,
20 is required if you intend to utilize assembler modules. Note that NASM
21 is now the only supported assembler. Without this the "Configure" step below
22 must be done with the "no-asm" option. The Microsoft provided assembler is NOT
28 If you want to compile in the assembly language routines with Visual
29 C++, then you will need the Netwide Assembler binary, nasmw.exe or nasm.exe, to
30 be available on your %PATH%.
32 Firstly you should run Configure and generate the Makefiles. If you don't want
33 the assembly language files then add the "no-asm" option (without quotes) to
34 the Configure lines below.
38 > perl Configure VC-WIN32 --prefix=c:\some\openssl\dir
41 Note: replace the last line above with the following if not using the assembly
48 > perl Configure VC-WIN64A --prefix=c:\some\openssl\dir
53 > perl Configure VC-WIN64I --prefix=c:\some\openssl\dir
56 Where the prefix argument specifies where OpenSSL will be installed to.
58 Then from the VC++ environment at a prompt do the following. Note, your %PATH%
59 and other environment variables should be set up for 32-bit or 64-bit
60 development as appropriate.
62 > nmake -f ms\ntdll.mak
64 If all is well it should compile and you will have some DLLs and
65 executables in out32dll. If you want to try the tests then do:
67 > nmake -f ms\ntdll.mak test
69 To install OpenSSL to the specified location do:
71 > nmake -f ms\ntdll.mak install
75 There are various changes you can make to the Windows compile
76 environment. By default the library is not compiled with debugging
77 symbols. If you add --debug to the Configure lines above then debugging symbols
80 By default in 1.1.0 OpenSSL will compile builtin ENGINES into separate shared
81 libraries. If you specify the "enable-static-engine" option on the command line
82 to Configure the shared library build (ms\ntdll.mak) will compile the engines
83 into libcrypto32.dll instead.
85 You can also build a static version of the library using the Makefile
91 Cygwin implements a Posix/Unix runtime system (cygwin1.dll) on top of the
92 Windows subsystem and provides a bash shell and GNU tools environment.
93 Consequently, a make of OpenSSL with Cygwin is virtually identical to the
94 Unix procedure. It is also possible to create Windows binaries that only
95 use the Microsoft C runtime system (msvcrt.dll or crtdll.dll) using
96 MinGW. MinGW can be used in the Cygwin development environment or in a
97 standalone setup as described in the following section.
99 To build OpenSSL using Cygwin:
101 * Install Cygwin (see http://cygwin.com/)
103 * Install Perl and ensure it is in the path. Both Cygwin perl
104 (5.6.1-2 or newer) and ActivePerl work.
106 * Run the Cygwin bash shell
108 * $ tar zxvf openssl-x.x.x.tar.gz
111 To build the Cygwin version of OpenSSL:
120 This will create a default install in /usr/local/ssl.
122 To build the MinGW version (native Windows) in Cygwin:
133 "make test" and normal file operations may fail in directories
134 mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin
135 stripping of carriage returns. To avoid this ensure that a binary
136 mount is used, e.g. mount -b c:\somewhere /home.
141 * Compiler and shell environment installation:
143 MinGW and MSYS are available from http://www.mingw.org/, both are
144 required. Run the installers and do whatever magic they say it takes
145 to start MSYS bash shell with GNU tools on its PATH.
155 This will create the library and binaries in root source directory
156 and openssl.exe application in apps directory.
158 It is also possible to cross-compile it on Linux by configuring
159 with './Configure --cross-compile-prefix=i386-mingw32- mingw ...'. Other
160 possible targets include x86_64-w64-mingw32- and i686-w64-mingw32-.
162 libcrypto.a and libssl.a are the static libraries. To use the DLLs,
163 link with libcrypto32.a and libssl32.a instead.
165 Linking your application
166 ------------------------
168 If you link with static OpenSSL libraries [those built with ms/nt.mak],
169 then you're expected to additionally link your application with
170 WS2_32.LIB, ADVAPI32.LIB, GDI32.LIB and USER32.LIB. Those developing
171 non-interactive service applications might feel concerned about linking
172 with the latter two, as they are justly associated with interactive
173 desktop, which is not available to service processes. The toolkit is
174 designed to detect in which context it's currently executed, GUI,
175 console app or service, and act accordingly, namely whether or not to
176 actually make GUI calls. Additionally those who wish to
177 /DELAYLOAD:GDI32.DLL and /DELAYLOAD:USER32.DLL and actually keep them
178 off service process should consider implementing and exporting from
179 .exe image in question own _OPENSSL_isservice not relying on USER32.DLL.
180 E.g., on Windows Vista and later you could:
182 __declspec(dllexport) __cdecl BOOL _OPENSSL_isservice(void)
184 if (ProcessIdToSessionId(GetCurrentProcessId(),&sess))
189 If you link with OpenSSL .DLLs, then you're expected to include into
190 your application code small "shim" snippet, which provides glue between
191 OpenSSL BIO layer and your compiler run-time. See the OPENSSL_Applink
192 manual page for further details.