INSTALL.W32

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