2 INSTALLATION ON THE WIN32 PLATFORM
3 ----------------------------------
5 [Instructions for building for Windows CE can be found in INSTALL.WCE]
6 [Instructions for building for Win64 can be found in INSTALL.W64]
8 Heres a few comments about building OpenSSL in Windows environments. Most
9 of this is tested on Win32 but it may also work in Win 3.1 with some
12 You need Perl for Win32. Unless you will build on Cygwin, you will need
13 ActiveState Perl, available from http://www.activestate.com/ActivePerl.
15 and one of the following C compilers:
19 * GNU C (Cygwin or MinGW)
21 If you are compiling from a tarball or a CVS snapshot then the Win32 files
22 may well be not up to date. This may mean that some "tweaking" is required to
23 get it all to work. See the trouble shooting section later on for if (when?)
29 If you want to compile in the assembly language routines with Visual C++ then
30 you will need an assembler. This is worth doing because it will result in
31 faster code: for example it will typically result in a 2 times speedup in the
32 RSA routines. Currently the following assemblers are supported:
34 * Microsoft MASM (aka "ml")
35 * Free Netwide Assembler NASM.
37 MASM is distributed with most versions of VC++. For the versions where it is
38 not included in VC++, it is also distributed with some Microsoft DDKs, for
39 example the Windows NT 4.0 DDK and the Windows 98 DDK. If you do not have
40 either of these DDKs then you can just download the binaries for the Windows
41 98 DDK and extract and rename the two files XXXXXml.exe and XXXXXml.err, to
42 ml.exe and ml.err and install somewhere on your PATH. Both DDKs can be
43 downloaded from the Microsoft developers site www.msdn.com.
45 NASM is freely available. Version 0.98 was used during testing: other versions
46 may also work. It is available from many places, see for example:
47 http://www.kernel.org/pub/software/devel/nasm/binaries/win32/
48 The NASM binary nasmw.exe needs to be installed anywhere on your PATH.
50 Firstly you should run Configure:
52 > perl Configure VC-WIN32
54 Next you need to build the Makefiles and optionally the assembly language
57 - If you are using MASM then run:
61 - If you are using NASM then run:
65 - If you don't want to use the assembly language files at all then run:
69 If you get errors about things not having numbers assigned then check the
70 troubleshooting section: you probably won't be able to compile it as it
73 Then from the VC++ environment at a prompt do:
75 > nmake -f ms\ntdll.mak
77 If all is well it should compile and you will have some DLLs and executables
78 in out32dll. If you want to try the tests then do:
85 There are various changes you can make to the Win32 compile environment. By
86 default the library is not compiled with debugging symbols. If you add 'debug'
87 to the mk1mf.pl lines in the do_* batch file then debugging symbols will be
88 compiled in. Note that mk1mf.pl expects the platform to be the last argument
89 on the command line, so 'debug' must appear before that, as all other options.
91 The default Win32 environment is to leave out any Windows NT specific
94 If you want to enable the NT specific features of OpenSSL (currently only the
95 logging BIO) follow the instructions above but call the batch file do_nt.bat
98 You can also build a static version of the library using the Makefile
101 Borland C++ builder 5
102 ---------------------
104 * Configure for building with Borland Builder:
105 > perl Configure BC-32
107 * Create the appropriate makefile
113 Borland C++ builder 3 and 4
114 ---------------------------
116 * Setup PATH. First must be GNU make then bcb4/bin
126 Cygwin provides a bash shell and GNU tools environment running
127 on NT 4.0, Windows 9x, Windows ME, Windows 2000, and Windows XP.
128 Consequently, a make of OpenSSL with Cygwin is closer to a GNU
129 bash environment such as Linux than to other the other Win32
132 Cygwin implements a Posix/Unix runtime system (cygwin1.dll).
133 It is also possible to create Win32 binaries that only use the
134 Microsoft C runtime system (msvcrt.dll or crtdll.dll) using
135 MinGW. MinGW can be used in the Cygwin development environment
136 or in a standalone setup as described in the following section.
138 To build OpenSSL using Cygwin:
140 * Install Cygwin (see http://cygwin.com/)
142 * Install Perl and ensure it is in the path. Both Cygwin perl
143 (5.6.1-2 or newer) and ActivePerl work.
145 * Run the Cygwin bash shell
147 * $ tar zxvf openssl-x.x.x.tar.gz
150 To build the Cygwin version of OpenSSL:
159 This will create a default install in /usr/local/ssl.
161 To build the MinGW version (native Windows) in Cygwin:
172 "make test" and normal file operations may fail in directories
173 mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin
174 stripping of carriage returns. To avoid this ensure that a binary
175 mount is used, e.g. mount -b c:\somewhere /home.
177 "bc" is not provided in older Cygwin distribution. This causes a
178 non-fatal error in "make test" but is otherwise harmless. If
179 desired and needed, GNU bc can be built with Cygwin without change.
184 * Compiler installation:
186 MinGW is available from http://www.mingw.org. Run the installer and
187 set the MinGW bin directory to the PATH in "System Properties" or
194 This will create the library and binaries in out. In case any problems
199 libcrypto.a and libssl.a are the static libraries. To use the DLLs,
200 link with libeay32.a and libssl32.a instead.
202 See troubleshooting if you get error messages about functions not having
205 * You can now try the tests:
214 If you used the Cygwin procedure above, you have already installed and
215 can skip this section. For all other procedures, there's currently no real
216 installation procedure for Win32. There are, however, some suggestions:
218 - do nothing. The include files are found in the inc32/ subdirectory,
219 all binaries are found in out32dll/ or out32/ depending if you built
220 dynamic or static libraries.
222 - do as is written in INSTALL.Win32 that comes with modssl:
227 $ md c:\openssl\include
228 $ md c:\openssl\include\openssl
229 $ copy /b inc32\openssl\* c:\openssl\include\openssl
230 $ copy /b out32dll\ssleay32.lib c:\openssl\lib
231 $ copy /b out32dll\libeay32.lib c:\openssl\lib
232 $ copy /b out32dll\ssleay32.dll c:\openssl\bin
233 $ copy /b out32dll\libeay32.dll c:\openssl\bin
234 $ copy /b out32dll\openssl.exe c:\openssl\bin
236 Of course, you can choose another device than c:. C: is used here
237 because that's usually the first (and often only) harddisk device.
238 Note: in the modssl INSTALL.Win32, p: is used rather than c:.
244 Since the Win32 build is only occasionally tested it may not always compile
245 cleanly. If you get an error about functions not having numbers assigned
246 when you run ms\do_ms then this means the Win32 ordinal files are not up to
249 > perl util\mkdef.pl crypto ssl update
251 then ms\do_XXX should not give a warning any more. However the numbers that
252 get assigned by this technique may not match those that eventually get
253 assigned in the CVS tree: so anything linked against this version of the
254 library may need to be recompiled.
256 If you get errors about unresolved symbols there are several possible
259 If this happens when the DLL is being linked and you have disabled some
260 ciphers then it is possible the DEF file generator hasn't removed all
261 the disabled symbols: the easiest solution is to edit the DEF files manually
262 to delete them. The DEF files are ms\libeay32.def ms\ssleay32.def.
264 Another cause is if you missed or ignored the errors about missing numbers
267 If you get warnings in the code then the compilation will halt.
269 The default Makefile for Win32 halts whenever any warnings occur. Since VC++
270 has its own ideas about warnings which don't always match up to other
271 environments this can happen. The best fix is to edit the file with the
272 warning in and fix it. Alternatively you can turn off the halt on warnings by
273 editing the CFLAG line in the Makefile and deleting the /WX option.
275 You might get compilation errors. Again you will have to fix these or report
278 One final comment about compiling applications linked to the OpenSSL library.
279 If you don't use the multithreaded DLL runtime library (/MD option) your
280 program will almost certainly crash because malloc gets confused -- the
281 OpenSSL DLLs are statically linked to one version, the application must
282 not use a different one. You might be able to work around such problems
283 by adding CRYPTO_malloc_init() to your program before any calls to the
284 OpenSSL libraries: This tells the OpenSSL libraries to use the same
285 malloc(), free() and realloc() as the application. However there are many
286 standard library functions used by OpenSSL that call malloc() internally
287 (e.g. fopen()), and OpenSSL cannot change these; so in general you cannot
288 rely on CRYPTO_malloc_init() solving your problem, and you should
289 consistently use the multithreaded library.
291 Linking your application
292 ------------------------
294 If you link with static OpenSSL libraries [those built with ms/nt.mak],
295 then you're expected to additionally link your application with
296 WSOCK32.LIB, ADVAPI32.LIB, GDI32.LIB and USER32.LIB. Those developing
297 non-interactive service applications might feel concerned about linking
298 with latter two, as they are justly associated with interactive desktop,
299 which is not available to service processes. The toolkit is designed
300 to detect in which context it's currently executed, GUI, console app
301 or service, and act accordingly, namely whether or not to actually make
304 If you link with OpenSSL .DLLs, then you're expected to include into
305 your application code small "shim" snippet, which provides glue between
306 OpenSSL BIO layer and your compiler run-time. Look up OPENSSL_Applink
307 reference page for further details.