2 INSTALLATION ON THE WIN32 PLATFORM
3 ----------------------------------
5 Heres a few comments about building OpenSSL in Windows environments. Most
6 of this is tested on Win32 but it may also work in Win 3.1 with some
9 You need Perl for Win32. Unless you will build on Cygwin, you will need
10 ActiveState Perl, available from http://www.activestate.com/ActivePerl.
11 For Cygwin users, there's more info in the Cygwin section.
13 and one of the following C compilers:
17 * GNU C (Mingw32 or Cygwin)
19 If you want to compile in the assembly language routines with Visual C++ then
20 you will need an assembler. This is worth doing because it will result in
21 faster code: for example it will typically result in a 2 times speedup in the
22 RSA routines. Currently the following assemblers are supported:
24 * Microsoft MASM (aka "ml")
25 * Free Netwide Assembler NASM.
27 MASM was at one point distributed with VC++. It is now distributed with some
28 Microsoft DDKs, for example the Windows NT 4.0 DDK and the Windows 98 DDK. If
29 you do not have either of these DDKs then you can just download the binaries
30 for the Windows 98 DDK and extract and rename the two files XXXXXml.exe and
31 XXXXXml.err, to ml.exe and ml.err and install somewhere on your PATH. Both
32 DDKs can be downloaded from the Microsoft developers site www.msdn.com.
34 NASM is freely available. Version 0.98 was used during testing: other versions
35 may also work. It is available from many places, see for example:
36 http://www.kernel.org/pub/software/devel/nasm/binaries/win32/
37 The NASM binary nasmw.exe needs to be installed anywhere on your PATH.
39 If you are compiling from a tarball or a CVS snapshot then the Win32 files
40 may well be not up to date. This may mean that some "tweaking" is required to
41 get it all to work. See the trouble shooting section later on for if (when?)
47 Firstly you should run Configure:
49 > perl Configure VC-WIN32
51 Next you need to build the Makefiles and optionally the assembly language
54 - If you are using MASM then run:
58 - If you are using NASM then run:
62 - If you don't want to use the assembly language files at all then run:
66 If you get errors about things not having numbers assigned then check the
67 troubleshooting section: you probably won't be able to compile it as it
70 Then from the VC++ environment at a prompt do:
72 > nmake -f ms\ntdll.mak
74 If all is well it should compile and you will have some DLLs and executables
75 in out32dll. If you want to try the tests then do:
82 There are various changes you can make to the Win32 compile environment. By
83 default the library is not compiled with debugging symbols. If you add 'debug'
84 to the mk1mf.pl lines in the do_* batch file then debugging symbols will be
85 compiled in. Note that mk1mf.pl expects the platform to be the last argument
86 on the command line, so 'debug' must appear before that, as all other options.
88 The default Win32 environment is to leave out any Windows NT specific
91 If you want to enable the NT specific features of OpenSSL (currently only the
92 logging BIO) follow the instructions above but call the batch file do_nt.bat
95 You can also build a static version of the library using the Makefile
101 * Configure for building with Borland Builder:
102 > perl Configure BC-32
104 * Create the appropriate makefile
110 Borland C++ builder 3 and 4
111 ---------------------------
113 * Setup PATH. First must be GNU make then bcb4/bin
123 To build OpenSSL, you need the Mingw32 package and GNU make.
125 * Compiler installation:
127 Mingw32 is available from <ftp://ftp.xraylith.wisc.edu/pub/khan/
128 gnu-win32/mingw32/gcc-2.95.2/gcc-2.95.2-msvcrt.exe>. Extract it
129 to a directory such as C:\gcc-2.95.2 and add c:\gcc-2.95.2\bin to
130 the PATH environment variable in "System Properties"; or edit and
131 run C:\gcc-2.95.2\mingw32.bat to set the PATH.
137 This will create the library and binaries in out. In case any problems
142 libcrypto.a and libssl.a are the static libraries. To use the DLLs,
143 link with libeay32.a and libssl32.a instead.
145 See troubleshooting if you get error messages about functions not having
148 * You can now try the tests:
156 Cygwin provides a bash shell and GNU tools environment running
157 on NT 4.0, Windows 9x, Windows ME, Windows 2000, and Windows XP.
158 Consequently, a make of OpenSSL with Cygwin is closer to a GNU
159 bash environment such as Linux than to other W32 makes which are
160 based on a single makefile approach. Cygwin implements Posix/Unix
161 calls through cygwin1.dll, and is contrasted to Mingw32 which links
162 dynamically to msvcrt.dll or crtdll.dll.
164 To build OpenSSL using Cygwin:
166 * Install Cygwin (see http://cygwin.com/)
168 * Install Perl and ensure it is in the path (recent Cygwin perl
169 (version 5.6.1-2 of the latter has been reported to work) or
172 * Run the Cygwin bash shell
174 * $ tar zxvf openssl-x.x.x.tar.gz
183 This will create a default install in /usr/local/ssl.
187 "make test" and normal file operations may fail in directories
188 mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin
189 stripping of carriage returns. To avoid this ensure that a binary
190 mount is used, e.g. mount -b c:\somewhere /home.
192 "bc" is not provided in older Cygwin distribution. This causes a
193 non-fatal error in "make test" but is otherwise harmless. If
194 desired and needed, GNU bc can be built with Cygwin without change.
200 If you used the Cygwin procedure above, you have already installed and
201 can skip this section. For all other procedures, there's currently no real
202 installation procedure for Win32. There are, however, some suggestions:
204 - do nothing. The include files are found in the inc32/ subdirectory,
205 all binaries are found in out32dll/ or out32/ depending if you built
206 dynamic or static libraries.
208 - do as is written in INSTALL.Win32 that comes with modssl:
213 $ md c:\openssl\include
214 $ md c:\openssl\include\openssl
215 $ copy /b inc32\* c:\openssl\include\openssl
216 $ copy /b out32dll\ssleay32.lib c:\openssl\lib
217 $ copy /b out32dll\libeay32.lib c:\openssl\lib
218 $ copy /b out32dll\ssleay32.dll c:\openssl\bin
219 $ copy /b out32dll\libeay32.dll c:\openssl\bin
220 $ copy /b out32dll\openssl.exe c:\openssl\bin
222 Of course, you can choose another device than c:. C: is used here
223 because that's usually the first (and often only) harddisk device.
224 Note: in the modssl INSTALL.Win32, p: is used rather than c:.
230 Since the Win32 build is only occasionally tested it may not always compile
231 cleanly. If you get an error about functions not having numbers assigned
232 when you run ms\do_ms then this means the Win32 ordinal files are not up to
235 > perl util\mkdef.pl crypto ssl update
237 then ms\do_XXX should not give a warning any more. However the numbers that
238 get assigned by this technique may not match those that eventually get
239 assigned in the CVS tree: so anything linked against this version of the
240 library may need to be recompiled.
242 If you get errors about unresolved symbols there are several possible
245 If this happens when the DLL is being linked and you have disabled some
246 ciphers then it is possible the DEF file generator hasn't removed all
247 the disabled symbols: the easiest solution is to edit the DEF files manually
248 to delete them. The DEF files are ms\libeay32.def ms\ssleay32.def.
250 Another cause is if you missed or ignored the errors about missing numbers
253 If you get warnings in the code then the compilation will halt.
255 The default Makefile for Win32 halts whenever any warnings occur. Since VC++
256 has its own ideas about warnings which don't always match up to other
257 environments this can happen. The best fix is to edit the file with the
258 warning in and fix it. Alternatively you can turn off the halt on warnings by
259 editing the CFLAG line in the Makefile and deleting the /WX option.
261 You might get compilation errors. Again you will have to fix these or report
264 One final comment about compiling applications linked to the OpenSSL library.
265 If you don't use the multithreaded DLL runtime library (/MD option) your
266 program will almost certainly crash because malloc gets confused -- the
267 OpenSSL DLLs are statically linked to one version, the application must
268 not use a different one. You might be able to work around such problems
269 by adding CRYPTO_malloc_init() to your program before any calls to the
270 OpenSSL libraries: This tells the OpenSSL libraries to use the same
271 malloc(), free() and realloc() as the application. However there are many
272 standard library functions used by OpenSSL that call malloc() internally
273 (e.g. fopen()), and OpenSSL cannot change these; so in general you cannot
274 rely on CRYPTO_malloc_init() solving your problem, and you should
275 consistently use the multithreaded library.