849544bf17d3f02fc889bde9b1b070c6051695bf
[openssl.git] / INSTALL.W32
1  
2  INSTALLATION ON THE WIN32 PLATFORM
3  ----------------------------------
4
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]
7
8  Here are a few comments about building OpenSSL for Win32 environments,
9  such as Windows NT and Windows 9x. It should be noted though that
10  Windows 9x are not ordinarily tested. Its mention merely means that we
11  attempt to maintain certain programming discipline and pay attention
12  to backward compatibility issues, in other words it's kind of expected
13  to work on Windows 9x, but no regression tests are actually performed.
14
15  On additional note newer OpenSSL versions are compiled and linked with
16  Winsock 2. This means that minimum OS requirement was elevated to NT 4
17  and Windows 98 [there is Winsock 2 update for Windows 95 though].
18
19  - you need Perl for Win32.  Unless you will build on Cygwin, you will need
20    ActiveState Perl, available from http://www.activestate.com/ActivePerl.
21
22  - one of the following C compilers:
23
24   * Visual C++
25   * Borland C
26   * GNU C (Cygwin or MinGW)
27
28 - Netwide Assembler, a.k.a. NASM, available from http://nasm.sourceforge.net/
29   is required if you intend to utilize assembler modules. Note that NASM
30   is now the only supported assembler.
31
32  If you are compiling from a tarball or a CVS snapshot then the Win32 files
33  may well be not up to date. This may mean that some "tweaking" is required to
34  get it all to work. See the trouble shooting section later on for if (when?)
35  it goes wrong.
36
37  Visual C++
38  ----------
39
40  If you want to compile in the assembly language routines with Visual
41  C++, then you will need already mentioned Netwide Assembler binary,
42  nasmw.exe or nasm.exe, to be available on your %PATH%.
43
44  Firstly you should run Configure:
45
46  > perl Configure VC-WIN32 --prefix=c:\some\openssl\dir
47
48  Where the prefix argument specifies where OpenSSL will be installed to.
49
50  Next you need to build the Makefiles and optionally the assembly
51  language files:
52
53  - If you are using NASM then run:
54
55    > ms\do_nasm
56
57  - If you don't want to use the assembly language files at all then run:
58
59    > perl Configure VC-WIN32 no-asm --prefix=c:/some/openssl/dir
60    > ms\do_ms
61
62  If you get errors about things not having numbers assigned then check the
63  troubleshooting section: you probably won't be able to compile it as it
64  stands.
65
66  Then from the VC++ environment at a prompt do:
67
68  > nmake -f ms\ntdll.mak
69
70  If all is well it should compile and you will have some DLLs and
71  executables in out32dll. If you want to try the tests then do:
72  
73  > nmake -f ms\ntdll.mak test
74
75
76  To install OpenSSL to the specified location do:
77
78  > nmake -f ms\ntdll.mak install
79
80  Tweaks:
81
82  There are various changes you can make to the Win32 compile
83  environment. By default the library is not compiled with debugging
84  symbols. If you add 'debug' to the mk1mf.pl lines in the do_* batch
85  file then debugging symbols will be compiled in. Note that mk1mf.pl
86  expects the platform to be the last argument on the command line, so
87  'debug' must appear before that, as all other options.
88
89
90  By default in 0.9.8 OpenSSL will compile builtin ENGINES into the
91  libeay32.dll shared library. If you specify the "no-static-engine"
92  option on the command line to Configure the shared library build
93  (ms\ntdll.mak) will compile the engines as separate DLLs.
94
95  The default Win32 environment is to leave out any Windows NT specific
96  features.
97
98  If you want to enable the NT specific features of OpenSSL (currently
99  only the logging BIO) follow the instructions above but call the batch
100  file do_nt.bat instead of do_ms.bat.
101
102  You can also build a static version of the library using the Makefile
103  ms\nt.mak
104
105
106
107  Borland C++ builder 5
108  ---------------------
109
110  * Configure for building with Borland Builder:
111    > perl Configure BC-32
112
113  * Create the appropriate makefile
114    > ms\do_nasm
115
116  * Build
117    > make -f ms\bcb.mak
118
119  Borland C++ builder 3 and 4
120  ---------------------------
121
122  * Setup PATH. First must be GNU make then bcb4/bin 
123
124  * Run ms\bcb4.bat
125
126  * Run make:
127    > make -f bcb.mak
128
129  GNU C (Cygwin)
130  --------------
131
132  Cygwin implements a Posix/Unix runtime system (cygwin1.dll) on top of
133  Win32 subsystem and provides a bash shell and GNU tools environment.
134  Consequently, a make of OpenSSL with Cygwin is virtually identical to
135  Unix procedure. It is also possible to create Win32 binaries that only
136  use the Microsoft C runtime system (msvcrt.dll or crtdll.dll) using
137  MinGW. MinGW can be used in the Cygwin development environment or in a
138  standalone setup as described in the following section.
139
140  To build OpenSSL using Cygwin:
141
142  * Install Cygwin (see http://cygwin.com/)
143
144  * Install Perl and ensure it is in the path. Both Cygwin perl
145    (5.6.1-2 or newer) and ActivePerl work.
146
147  * Run the Cygwin bash shell
148
149  * $ tar zxvf openssl-x.x.x.tar.gz
150    $ cd openssl-x.x.x
151
152    To build the Cygwin version of OpenSSL:
153
154    $ ./config
155    [...]
156    $ make
157    [...]
158    $ make test
159    $ make install
160
161    This will create a default install in /usr/local/ssl.
162
163    To build the MinGW version (native Windows) in Cygwin:
164
165    $ ./Configure mingw
166    [...]
167    $ make
168    [...]
169    $ make test
170    $ make install
171
172  Cygwin Notes:
173
174  "make test" and normal file operations may fail in directories
175  mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin
176  stripping of carriage returns. To avoid this ensure that a binary
177  mount is used, e.g. mount -b c:\somewhere /home.
178
179  "bc" is not provided in older Cygwin distribution.  This causes a
180  non-fatal error in "make test" but is otherwise harmless.  If
181  desired and needed, GNU bc can be built with Cygwin without change.
182
183  GNU C (MinGW/MSYS)
184  -------------
185
186  * Compiler and shell environment installation:
187
188    MinGW and MSYS are available from http://www.mingw.org/, both are
189    required. Run the installers and do whatever magic they say it takes
190    to start MSYS bash shell with GNU tools on its PATH.
191
192  * Compile OpenSSL:
193
194    $ ./config
195    [...]
196    $ make
197    [...]
198    $ make test
199
200    This will create the library and binaries in root source directory
201    and openssl.exe application in apps directory.
202
203    It is also possible to cross-compile it on Linux by configuring
204    with './Configure --cross-compile-prefix=i386-mingw32- mingw ...'.
205    'make test' is naturally not applicable then.
206
207    libcrypto.a and libssl.a are the static libraries. To use the DLLs,
208    link with libeay32.a and libssl32.a instead.
209
210    See troubleshooting if you get error messages about functions not
211    having a number assigned.
212
213  Installation
214  ------------
215
216  If you used the Cygwin procedure above, you have already installed and
217  can skip this section.  For all other procedures, there's currently no real
218  installation procedure for Win32.  There are, however, some suggestions:
219
220     - do nothing.  The include files are found in the inc32/ subdirectory,
221       all binaries are found in out32dll/ or out32/ depending if you built
222       dynamic or static libraries.
223
224     - do as is written in INSTALL.Win32 that comes with modssl:
225
226         $ md c:\openssl 
227         $ md c:\openssl\bin
228         $ md c:\openssl\lib
229         $ md c:\openssl\include
230         $ md c:\openssl\include\openssl
231         $ copy /b inc32\openssl\*       c:\openssl\include\openssl
232         $ copy /b out32dll\ssleay32.lib c:\openssl\lib
233         $ copy /b out32dll\libeay32.lib c:\openssl\lib
234         $ copy /b out32dll\ssleay32.dll c:\openssl\bin
235         $ copy /b out32dll\libeay32.dll c:\openssl\bin
236         $ copy /b out32dll\openssl.exe  c:\openssl\bin
237
238       Of course, you can choose another device than c:.  C: is used here
239       because that's usually the first (and often only) harddisk device.
240       Note: in the modssl INSTALL.Win32, p: is used rather than c:.
241
242
243  Troubleshooting
244  ---------------
245
246  Since the Win32 build is only occasionally tested it may not always compile
247  cleanly.  If you get an error about functions not having numbers assigned
248  when you run ms\do_ms then this means the Win32 ordinal files are not up to
249  date. You can do:
250
251  > perl util\mkdef.pl crypto ssl update
252
253  then ms\do_XXX should not give a warning any more. However the numbers that
254  get assigned by this technique may not match those that eventually get
255  assigned in the CVS tree: so anything linked against this version of the
256  library may need to be recompiled.
257
258  If you get errors about unresolved symbols there are several possible
259  causes.
260
261  If this happens when the DLL is being linked and you have disabled some
262  ciphers then it is possible the DEF file generator hasn't removed all
263  the disabled symbols: the easiest solution is to edit the DEF files manually
264  to delete them. The DEF files are ms\libeay32.def ms\ssleay32.def.
265
266  Another cause is if you missed or ignored the errors about missing numbers
267  mentioned above.
268
269  If you get warnings in the code then the compilation will halt.
270
271  The default Makefile for Win32 halts whenever any warnings occur. Since VC++
272  has its own ideas about warnings which don't always match up to other
273  environments this can happen. The best fix is to edit the file with the
274  warning in and fix it. Alternatively you can turn off the halt on warnings by
275  editing the CFLAG line in the Makefile and deleting the /WX option.
276
277  You might get compilation errors. Again you will have to fix these or report
278  them.
279
280  One final comment about compiling applications linked to the OpenSSL library.
281  If you don't use the multithreaded DLL runtime library (/MD option) your
282  program will almost certainly crash because malloc gets confused -- the
283  OpenSSL DLLs are statically linked to one version, the application must
284  not use a different one.  You might be able to work around such problems
285  by adding CRYPTO_malloc_init() to your program before any calls to the
286  OpenSSL libraries: This tells the OpenSSL libraries to use the same
287  malloc(), free() and realloc() as the application.  However there are many
288  standard library functions used by OpenSSL that call malloc() internally
289  (e.g. fopen()), and OpenSSL cannot change these; so in general you cannot
290  rely on CRYPTO_malloc_init() solving your problem, and you should
291  consistently use the multithreaded library.
292
293  Linking your application
294  ------------------------
295
296  If you link with static OpenSSL libraries [those built with ms/nt.mak],
297  then you're expected to additionally link your application with
298  WS2_32.LIB, ADVAPI32.LIB, GDI32.LIB and USER32.LIB. Those developing
299  non-interactive service applications might feel concerned about linking
300  with the latter two, as they are justly associated with interactive
301  desktop, which is not available to service processes. The toolkit is
302  designed to detect in which context it's currently executed, GUI,
303  console app or service, and act accordingly, namely whether or not to
304  actually make GUI calls.
305
306  If you link with OpenSSL .DLLs, then you're expected to include into
307  your application code small "shim" snippet, which provides glue between
308  OpenSSL BIO layer and your compiler run-time. Look up OPENSSL_Applink
309  reference page for further details.