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