Add instructions for building the MinGW target in Cygwin, and
[openssl.git] / INSTALL.W32
1  \r
3  ----------------------------------\r
4 \r
5  [Instructions for building for Windows CE can be found in INSTALL.WCE]\r
6 \r
7  Heres a few comments about building OpenSSL in Windows environments.  Most\r
8  of this is tested on Win32 but it may also work in Win 3.1 with some\r
9  modification.\r
10 \r
11  You need Perl for Win32.  Unless you will build on Cygwin, you will need\r
12  ActiveState Perl, available from\r
13 \r
14  and one of the following C compilers:\r
15 \r
16   * Visual C++\r
17   * Borland C\r
18   * GNU C (Cygwin or MinGW)\r
19 \r
20  If you are compiling from a tarball or a CVS snapshot then the Win32 files\r
21  may well be not up to date. This may mean that some "tweaking" is required to\r
22  get it all to work. See the trouble shooting section later on for if (when?)\r
23  it goes wrong.\r
24 \r
25  Visual C++\r
26  ----------\r
27 \r
28  If you want to compile in the assembly language routines with Visual C++ then\r
29  you will need an assembler. This is worth doing because it will result in\r
30  faster code: for example it will typically result in a 2 times speedup in the\r
31  RSA routines. Currently the following assemblers are supported:\r
32 \r
33   * Microsoft MASM (aka "ml")\r
34   * Free Netwide Assembler NASM.\r
35 \r
36  MASM is distributed with most versions of VC++. For the versions where it is\r
37  not included in VC++, it is also distributed with some Microsoft DDKs, for\r
38  example the Windows NT 4.0 DDK and the Windows 98 DDK. If you do not have\r
39  either of these DDKs then you can just download the binaries for the Windows\r
40  98 DDK and extract and rename the two files XXXXXml.exe and XXXXXml.err, to\r
41  ml.exe and ml.err and install somewhere on your PATH. Both DDKs can be\r
42  downloaded from the Microsoft developers site\r
43 \r
44  NASM is freely available. Version 0.98 was used during testing: other versions\r
45  may also work. It is available from many places, see for example:\r
47  The NASM binary nasmw.exe needs to be installed anywhere on your PATH.\r
48 \r
49  Firstly you should run Configure:\r
50 \r
51  > perl Configure VC-WIN32\r
52 \r
53  Next you need to build the Makefiles and optionally the assembly language\r
54  files:\r
55 \r
56  - If you are using MASM then run:\r
57 \r
58    > ms\do_masm\r
59 \r
60  - If you are using NASM then run:\r
61 \r
62    > ms\do_nasm\r
63 \r
64  - If you don't want to use the assembly language files at all then run:\r
65 \r
66    > ms\do_ms\r
67 \r
68  If you get errors about things not having numbers assigned then check the\r
69  troubleshooting section: you probably won't be able to compile it as it\r
70  stands.\r
71 \r
72  Then from the VC++ environment at a prompt do:\r
73 \r
74  > nmake -f ms\ntdll.mak\r
75 \r
76  If all is well it should compile and you will have some DLLs and executables\r
77  in out32dll. If you want to try the tests then do:\r
78  \r
79  > cd out32dll\r
80  > ..\ms\test\r
81 \r
82  Tweaks:\r
83 \r
84  There are various changes you can make to the Win32 compile environment. By\r
85  default the library is not compiled with debugging symbols. If you add 'debug'\r
86  to the lines in the do_* batch file then debugging symbols will be\r
87  compiled in. Note that expects the platform to be the last argument\r
88  on the command line, so 'debug' must appear before that, as all other options.\r
89 \r
90  The default Win32 environment is to leave out any Windows NT specific\r
91  features.\r
92 \r
93  If you want to enable the NT specific features of OpenSSL (currently only the\r
94  logging BIO) follow the instructions above but call the batch file do_nt.bat\r
95  instead of do_ms.bat.\r
96 \r
97  You can also build a static version of the library using the Makefile\r
98  ms\nt.mak\r
99 \r
100  Borland C++ builder 5\r
101  ---------------------\r
102 \r
103  * Configure for building with Borland Builder:\r
104    > perl Configure BC-32\r
105 \r
106  * Create the appropriate makefile\r
107    > ms\do_nasm\r
108 \r
109  * Build\r
110    > make -f ms\bcb.mak\r
111 \r
112  Borland C++ builder 3 and 4\r
113  ---------------------------\r
114 \r
115  * Setup PATH. First must be GNU make then bcb4/bin \r
116 \r
117  * Run ms\bcb4.bat\r
118 \r
119  * Run make:\r
120    > make -f bcb.mak\r
121 \r
122  GNU C (Cygwin)\r
123  --------------\r
124 \r
125  Cygwin provides a bash shell and GNU tools environment running\r
126  on NT 4.0, Windows 9x, Windows ME, Windows 2000, and Windows XP.\r
127  Consequently, a make of OpenSSL with Cygwin is closer to a GNU\r
128  bash environment such as Linux than to other the other Win32\r
129  makes.\r
130 \r
131  Cygwin implements a Posix/Unix runtime system (cygwin1.dll).\r
132  It is also possible to create Win32 binaries that only use the\r
133  Microsoft C runtime system (msvcrt.dll or crtdll.dll) using\r
134  MinGW. MinGW can be used in the Cygwin development environment\r
135  or in a standalone setup as described in the following section.\r
136 \r
137  To build OpenSSL using Cygwin:\r
138 \r
139  * Install Cygwin (see\r
140 \r
141  * Install Perl and ensure it is in the path. Both Cygwin perl\r
142    (5.6.1-2 or newer) and ActivePerl work.\r
143 \r
144  * Run the Cygwin bash shell\r
145 \r
146  * $ tar zxvf openssl-x.x.x.tar.gz\r
147    $ cd openssl-x.x.x\r
148 \r
149    To build the Cygwin version of OpenSSL:\r
150 \r
151    $ ./config\r
152    [...]\r
153    $ make\r
154    [...]\r
155    $ make test\r
156    $ make install\r
157 \r
158    This will create a default install in /usr/local/ssl.\r
159 \r
160    To build the MinGW version (native Windows) in Cygwin:\r
161 \r
162    $ ./Configure mingw\r
163    [...]\r
164    $ make\r
165    [...]\r
166    $ make test\r
167    $ make install\r
168 \r
169  Cygwin Notes:\r
170 \r
171  "make test" and normal file operations may fail in directories\r
172  mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin\r
173  stripping of carriage returns. To avoid this ensure that a binary\r
174  mount is used, e.g. mount -b c:\somewhere /home.\r
175 \r
176  "bc" is not provided in older Cygwin distribution.  This causes a\r
177  non-fatal error in "make test" but is otherwise harmless.  If\r
178  desired and needed, GNU bc can be built with Cygwin without change.\r
179 \r
180  GNU C (MinGW)\r
181  -------------\r
182 \r
183  * Compiler installation:\r
184 \r
185    MinGW is available from Run the installer and\r
186    set the MinGW bin directory to the PATH in "System Properties" or\r
187    autoexec.bat.\r
188 \r
189  * Compile OpenSSL:\r
190 \r
191    > ms\mingw32\r
192 \r
193    This will create the library and binaries in out. In case any problems\r
194    occur, try\r
195    > ms\mingw32 no-asm\r
196    instead.\r
197 \r
198    libcrypto.a and libssl.a are the static libraries. To use the DLLs,\r
199    link with libeay32.a and libssl32.a instead.\r
200 \r
201    See troubleshooting if you get error messages about functions not having\r
202    a number assigned.\r
203 \r
204  * You can now try the tests:\r
205 \r
206    > cd out\r
207    > ..\ms\test\r
208 \r
209 \r
210  Installation\r
211  ------------\r
212 \r
213  If you used the Cygwin procedure above, you have already installed and\r
214  can skip this section.  For all other procedures, there's currently no real\r
215  installation procedure for Win32.  There are, however, some suggestions:\r
216 \r
217     - do nothing.  The include files are found in the inc32/ subdirectory,\r
218       all binaries are found in out32dll/ or out32/ depending if you built\r
219       dynamic or static libraries.\r
220 \r
221     - do as is written in INSTALL.Win32 that comes with modssl:\r
222 \r
223         $ md c:\openssl \r
224         $ md c:\openssl\bin\r
225         $ md c:\openssl\lib\r
226         $ md c:\openssl\include\r
227         $ md c:\openssl\include\openssl\r
228         $ copy /b inc32\*               c:\openssl\include\openssl\r
229         $ copy /b out32dll\ssleay32.lib c:\openssl\lib\r
230         $ copy /b out32dll\libeay32.lib c:\openssl\lib\r
231         $ copy /b out32dll\ssleay32.dll c:\openssl\bin\r
232         $ copy /b out32dll\libeay32.dll c:\openssl\bin\r
233         $ copy /b out32dll\openssl.exe  c:\openssl\bin\r
234 \r
235       Of course, you can choose another device than c:.  C: is used here\r
236       because that's usually the first (and often only) harddisk device.\r
237       Note: in the modssl INSTALL.Win32, p: is used rather than c:.\r
238 \r
239 \r
240  Troubleshooting\r
241  ---------------\r
242 \r
243  Since the Win32 build is only occasionally tested it may not always compile\r
244  cleanly.  If you get an error about functions not having numbers assigned\r
245  when you run ms\do_ms then this means the Win32 ordinal files are not up to\r
246  date. You can do:\r
247 \r
248  > perl util\ crypto ssl update\r
249 \r
250  then ms\do_XXX should not give a warning any more. However the numbers that\r
251  get assigned by this technique may not match those that eventually get\r
252  assigned in the CVS tree: so anything linked against this version of the\r
253  library may need to be recompiled.\r
254 \r
255  If you get errors about unresolved symbols there are several possible\r
256  causes.\r
257 \r
258  If this happens when the DLL is being linked and you have disabled some\r
259  ciphers then it is possible the DEF file generator hasn't removed all\r
260  the disabled symbols: the easiest solution is to edit the DEF files manually\r
261  to delete them. The DEF files are ms\libeay32.def ms\ssleay32.def.\r
262 \r
263  Another cause is if you missed or ignored the errors about missing numbers\r
264  mentioned above.\r
265 \r
266  If you get warnings in the code then the compilation will halt.\r
267 \r
268  The default Makefile for Win32 halts whenever any warnings occur. Since VC++\r
269  has its own ideas about warnings which don't always match up to other\r
270  environments this can happen. The best fix is to edit the file with the\r
271  warning in and fix it. Alternatively you can turn off the halt on warnings by\r
272  editing the CFLAG line in the Makefile and deleting the /WX option.\r
273 \r
274  You might get compilation errors. Again you will have to fix these or report\r
275  them.\r
276 \r
277  One final comment about compiling applications linked to the OpenSSL library.\r
278  If you don't use the multithreaded DLL runtime library (/MD option) your\r
279  program will almost certainly crash because malloc gets confused -- the\r
280  OpenSSL DLLs are statically linked to one version, the application must\r
281  not use a different one.  You might be able to work around such problems\r
282  by adding CRYPTO_malloc_init() to your program before any calls to the\r
283  OpenSSL libraries: This tells the OpenSSL libraries to use the same\r
284  malloc(), free() and realloc() as the application.  However there are many\r
285  standard library functions used by OpenSSL that call malloc() internally\r
286  (e.g. fopen()), and OpenSSL cannot change these; so in general you cannot\r
287  rely on CRYPTO_malloc_init() solving your problem, and you should\r
288  consistently use the multithreaded library.\r