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