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