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