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