Several of the EVP_CIPHER structures had the get and set asn1 parameter
[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.  See the end of this file for Eric's original comments.
8
9  You will Perl for Win32 (available from http://activestate.com/ActivePerl)
10  and one of the following C compilers:
11
12   * Visual C++
13   * Borland C
14   * GNU C (Mingw32 or Cygwin32)
15
16  If you are compiling from a tarball or a CVS snapshot then the Win32 files
17  may well be not up to date. This may mean that some "tweaking" is required to
18  get it all to work. See the trouble shooting section later on for if (when?)
19  it goes wrong.
20
21  Visual C++
22  ----------
23
24  Firstly you should run Configure and build the Win32 Makefiles:
25
26  > perl Configure VC-WIN32
27  > ms\do_ms
28
29  If you get errors about things not having numbers assigned then check the
30  troubleshooting section: you probably wont be able to compile it as it
31  stands.
32
33  Then from the VC++ environment at a prompt do:
34
35  > nmake -f ms\ntdll.mak
36
37  If all is well it should compile and you will have some DLLs and executables
38  in out32dll. If you want to try the tests then do:
39  
40  > cd out32dll
41  > ..\ms\test
42
43  Tweaks:
44
45  There are various changes you can make to the Win32 compile environment. If
46  you have the MASM assembler 'ml' then you can try the assembly language code.
47  To do this remove the 'no-asm' part from do_ms.bat. You can also add 'debug'
48  here to make a debugging version of the library.
49
50  The default Win32 environment is to leave out any Windows NT specific
51  features.
52
53  If you want to enable the NT specific features of OpenSSL (currently only the
54  logging BIO) follow the instructions above but call the batch file do_nt.bat
55  instead of do_ms.bat.
56
57  You can also build a static version of the library using the Makefile
58  ms\nt.mak
59
60  Borland C++ builder 3 and 4
61  ---------------------------
62
63  * Setup PATH. First must be GNU make then bcb4/bin 
64
65  * Run ms\bcb4.bat
66
67  * Run make:
68    > make -f bcb.mak
69
70  GNU C (Mingw32)
71  ---------------
72
73  To build OpenSSL, you need the Mingw32 package and GNU make.
74
75  * Compiler installation:
76
77    Mingw32 is available from <ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/
78    mingw32/egcs-1.1.2/egcs-1.1.2-mingw32.zip>. GNU make is at
79    <ftp://agnes.dida.physik.uni-essen.de/home/janjaap/mingw32/binaries/
80    make-3.76.1.zip>. Install both of them in C:\egcs-1.1.2 and run
81    C:\egcs-1.1.2\mingw32.bat to set the PATH.
82
83  * Compile OpenSSL:
84
85    Run ms\mw.bat
86
87    This will create the library and binaries in out.
88
89    libcrypto.a and libssl.a are the static libraries. To use the DLLs,
90    link with libeay32.a and libssl32.a instead.
91
92    See troubleshooting if you get error messages about functions not having
93    a number assigned.
94
95  * You can now try the tests:
96
97    > cd out
98    > ..\ms\test
99
100  Troubleshooting
101  ---------------
102
103  Since the Win32 build is only occasionally tested it may not always compile
104  cleanly.  If you get an error about functions not having numbers assigned
105  when you run ms\do_ms then this means the Win32 ordinal files are not up to
106  date. You can do:
107
108  > perl util\mkdef.pl crypto ssl update
109
110  then ms\do_ms should not give a warning any more. However the numbers that
111  get assigned by this technique may not match those that eventually get
112  assigned in the CVS tree: so anything linked against this version of the
113  library may need to be recompiled.
114
115  If you get errors about unresolved externals then this means that either you
116  didn't read the note above about functions not having numbers assigned or
117  someone forgot to add a function to the header file.
118
119  In this latter case check out the header file to see if the function is
120  defined in the header file.
121
122  If you get warnings in the code then the compilation will halt.
123
124  The default Makefile for Win32 halts whenever any warnings occur. Since VC++
125  has its own ideas about warnings which don't always match up to other
126  environments this can happen. The best fix is to edit the file with the
127  warning in and fix it. Alternatively you can turn off the halt on warnings by
128  editing the CFLAG line in the Makefile and deleting the /WX option.
129
130  You might get compilation errors. Again you will have to fix these or report
131  them.
132
133  One final comment about compiling applications linked to the OpenSSL library.
134  If you don't use the multithreaded DLL runtime library (/MD option) your
135  program will almost certainly crash: see the original SSLeay description
136  below for more details.
137
138 --------------------------------------------------------------------------------
139 The orignal Windows build instructions from SSLeay follow. 
140 Note: some of this may be out of date and no longer applicable. In particular
141 the Crypto_malloc_init() comment appears to be wrong: you always need to use
142 the same runtime library as the DLL itself.
143 --------------------------------------------------------------------------------
144
145 The Microsoft World.
146
147 The good news, to build SSLeay for the Microsft World
148
149 Windows 3.1 DLL's
150 perl Configure VC-WIN16
151 nmake -f ms\w31dll.mak
152
153 Windows NT/95 DLL's
154 perl Configure VC-WIN32
155 nmake -f ms\ntdll.mak
156
157 Now the bad news
158 All builds were done using Microsofts Visual C++ 1.52c and [45].x.
159 If you are a borland person, you are probably going to have to help me
160 finish the stuff in util/pl/BC*pl
161
162 All builds were made under Windows NT - this means long filenames, so
163 you may have problems under Windows 3.1 but probably not under 95.
164
165 Because file pointers don't work in DLL's under Windows 3.1 (well at
166 least stdin/stdout don't and I don't like having to differentiate
167 between these and other file pointers), I now use the BIO file-pointer
168 module, which needs to be linked into your application.  You can either
169 use the memory buffer BIO for IO, or compile bss_file.c into your
170 application, it is in the apps directory and is just a copy of
171 crypto/buffer/bss_file.c with #define APPS_WIN16 added.
172 I have not yet automated the makefile to automatically copy it into 'out'
173 for a win 3.1 build....
174
175 All callbacks passed into SSLeay for Windows 3.1 need to be of type
176 _far _loadds.
177
178 I don't support building with the pascal calling convention.
179
180 The DLL and static builds are large memory model.
181
182 To build static libraries for NT/95 or win 3.1
183
184 perl util/mk1mf.pl VC-WIN32 > mf-stat.nt
185 perl util/mk1mf.pl VC-WIN16 > mf-stat.w31
186 for DLL's
187 perl util/mk1mf.pl dll VC-WIN32 > mf-dll.nt
188 perl util/mk1mf.pl dll VC-WIN16 > mf-dll.w31
189
190 Again you will notice that if you dont have perl, you cannot do this.
191
192 Now the next importaint issue.  Running Configure!
193 I have small assember code files for critical big number library operation
194 in crypto/bn/asm.  There is, asm code, object files and uuencode
195 object files.  They are
196 x86nt32.asm     - 32bit flat memory model assember - suitable Win32
197 x86w16.asm      - 16bit assember - used in the msdos build.
198 x86w32.asm      - 32bit assember, win 3.1 segments, used for win16 build.
199
200 If you feel compelled to build the 16bit maths routines in the windows 3.1
201 build,
202 perl Configure VC-W31-16
203 perl util/mk1mf.pl dll VC-W31-16 > mf-dll.w31
204
205 If you hate assember and don't want anything to do with it,
206 perl util/mk1mf.pl no-asm VC-WIN16 > mf-dll.w31
207 will work for any of the makefile generations.
208
209 There are more options to mk1mf.pl but these all leave the temporary
210 files in 'tmp' and the output files in 'out' by default.
211
212 The NT build is done for console mode.
213
214 The Windows 3.1 version of SSLeay uses quickwin, the interface is ugly
215 but it is better than nothing.  If you want ugly, try doing anything
216 that involves getting a password.  I decided to be ugly instead of
217 echoing characters.  For Windows 3.1 I would just sugest using the
218 msdos version of the ssleay application for command line work.
219 The QuickWin build is primarily for testing.
220
221 For both NT and Windows 3.1, I have not written the code so that
222 s_client, s_server can take input from the keyboard.  You can happily
223 start applications up in separate windows, watch them handshake, and then sit
224 there for-ever.  I have not had the time to get this working, and I've
225 been able to test things from a unix box to the NT box :-).
226 Try running ssleay s_server on the windows box
227 (with either -cert ../apps/server.pem -www)
228 and run ssleay s_time from another window.
229 This often stuffs up on Windows 3.1, but I'm not worried since this is
230 probably a problem with my demo applications, not the libraries.
231
232 After a build of one of the version of microsoft SSLeay,
233 'cd ms' and then run 'test'.  This should check everything out and
234 even does a trial run of generating certificates.
235 'test.bat' requires that perl be install, you be in the ms directory
236 (not the test directory, thats for unix so stay out :-) and that the
237 build output directory be ../out 
238
239 On a last note, you will probably get division by zero errors and
240 stuff after a build.  This is due to your own inability to follow
241 instructions :-).
242
243 The reasons for the problem is probably one of the following.
244
245 1)      You did not run Configure.  This is critical for windows 3.1 when
246         using assember.  The values in crypto/bn/bn.h must match the
247         ones requred for the assember code.  (remember that if you
248         edit crypto/bn/bn.h by hand, it will be clobered the next time
249         you run Configure by the contents of crypto/bn/bn.org).
250         SSLeay version -o will list the compile options.
251         For VC-WIN32 you need bn(64,32) or bn(32,32)
252         For VC-W31-32/VC-WIN16 you need bn(32,32)
253         For VC-W31-16 you need bn(32,16) or bn(16,16)
254         For VC-MSDOS you need bn(32,16) or bn(16,16).
255
256         The first number will be 2 times bigger than the second if
257         BN_LLONG is defined in bn.h and the size of the second number
258         depends on the 'bits' defined at the start of bn.h.  Have a
259         look, it's all reasonably clear.
260         If you want to start messing with 8 bit builds and things like
261         that, build without the assember by re-generating a makefile
262         via 'perl util/mk1mf.pl no-asm'.
263 2)      You tried to build under MS-DOS or Windows 3.1 using the /G3
264         option.  Don't.  It is buggy (thats why you just got that
265         error) and unless you want to work out which optimising flag
266         to turn off, I'm not going to help you :-).  I also noticed
267         that code often ran slower when compiled with /G3.
268 3)      Under NT/95, malloc goes stupid.  You are probably linking with
269         the wrong library, there are problems if you mix the threaded
270         and non-threaded libraries (due to the DLL being staticly
271         linked with one and the applicaion using another.
272
273 Well hopefully thats most of the MS issues handled, see you in ssl-users :-).
274
275 eric 30-Aug-1996
276
277 SSLeay 0.6.5
278 For Windows 95/NT, add CRYPTO_malloc_init() to your program before any
279 calls to the SSLeay libraries.  This function will insert callbacks so that
280 the SSLeay libraries will use the same malloc(), free() and realloc() as
281 your application so 'problem 3)' mentioned above will go away.
282
283 There is now DES assember for Windows NT/95.  The file is
284 crypto/des/asm/win32.asm and replaces crypto/des/des_enc.c in the build.
285
286 There is also Blowfish assember for Windows NT/95.  The file is
287 crypto/bf/asm/win32.asm and replaces crypto/bf/bf_enc.c in the build.
288
289 eric 25-Jun-1997
290