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