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