INSTALL.W32

   1
   2  INSTALLATION ON THE WIN32 PLATFORM
   3  ----------------------------------
   4
   5  Heres a few comments about building OpenSSL in Windows environments.  Most
   6  of this is tested on Win32 but it may also work in Win 3.1 with some
   7  modification.
   8
   9  You need Perl for Win32.  Unless you will build on Cygwin, you will need
  10  ActiveState Perl, available from http://www.activestate.com/ActivePerl.
  11  For Cygwin users, there's more info in the Cygwin section.
  12
  13  and one of the following C compilers:
  14
  15   * Visual C++
  16   * Borland C
  17   * GNU C (Mingw32 or Cygwin)
  18
  19  If you want to compile in the assembly language routines with Visual C++ then
  20  you will need an assembler. This is worth doing because it will result in
  21  faster code: for example it will typically result in a 2 times speedup in the
  22  RSA routines. Currently the following assemblers are supported:
  23
  24   * Microsoft MASM (aka "ml")
  25   * Free Netwide Assembler NASM.
  26
  27  MASM was at one point distributed with VC++. It is now distributed with some
  28  Microsoft DDKs, for example the Windows NT 4.0 DDK and the Windows 98 DDK. If
  29  you do not have either of these DDKs then you can just download the binaries
  30  for the Windows 98 DDK and extract and rename the two files XXXXXml.exe and
  31  XXXXXml.err, to ml.exe and ml.err and install somewhere on your PATH. Both
  32  DDKs can be downloaded from the Microsoft developers site www.msdn.com.
  33
  34  NASM is freely available. Version 0.98 was used during testing: other versions
  35  may also work. It is available from many places, see for example:
  36  http://www.kernel.org/pub/software/devel/nasm/binaries/win32/
  37  The NASM binary nasmw.exe needs to be installed anywhere on your PATH.
  38
  39  If you are compiling from a tarball or a CVS snapshot then the Win32 files
  40  may well be not up to date. This may mean that some "tweaking" is required to
  41  get it all to work. See the trouble shooting section later on for if (when?)
  42  it goes wrong.
  43
  44  Visual C++
  45  ----------
  46
  47  Firstly you should run Configure:
  48
  49  > perl Configure VC-WIN32
  50
  51  Next you need to build the Makefiles and optionally the assembly language
  52  files:
  53
  54  - If you are using MASM then run:
  55
  56    > ms\do_masm
  57
  58  - If you are using NASM then run:
  59
  60    > ms\do_nasm
  61
  62  - If you don't want to use the assembly language files at all then run:
  63
  64    > ms\do_ms
  65
  66  If you get errors about things not having numbers assigned then check the
  67  troubleshooting section: you probably won't be able to compile it as it
  68  stands.
  69
  70  Then from the VC++ environment at a prompt do:
  71
  72  > nmake -f ms\ntdll.mak
  73
  74  If all is well it should compile and you will have some DLLs and executables
  75  in out32dll. If you want to try the tests then do:
  76
  77  > cd out32dll
  78  > ..\ms\test
  79
  80  Tweaks:
  81
  82  There are various changes you can make to the Win32 compile environment. By
  83  default the library is not compiled with debugging symbols. If you add 'debug'
  84  to the mk1mf.pl lines in the do_* batch file then debugging symbols will be
  85  compiled in.
  86
  87  The default Win32 environment is to leave out any Windows NT specific
  88  features.
  89
  90  If you want to enable the NT specific features of OpenSSL (currently only the
  91  logging BIO) follow the instructions above but call the batch file do_nt.bat
  92  instead of do_ms.bat.
  93
  94  You can also build a static version of the library using the Makefile
  95  ms\nt.mak
  96
  97  Borland C++ builder 3 and 4
  98  ---------------------------
  99
 100  * Setup PATH. First must be GNU make then bcb4/bin
 101
 102  * Run ms\bcb4.bat
 103
 104  * Run make:
 105    > make -f bcb.mak
 106
 107  GNU C (Mingw32)
 108  ---------------
 109
 110  To build OpenSSL, you need the Mingw32 package and GNU make.
 111
 112  * Compiler installation:
 113
 114    Mingw32 is available from <ftp://ftp.xraylith.wisc.edu/pub/khan/
 115    gnu-win32/mingw32/gcc-2.95.2/gcc-2.95.2-msvcrt.exe>. GNU make is at
 116    <ftp://agnes.dida.physik.uni-essen.de/home/janjaap/mingw32/binaries/
 117    make-3.76.1.zip>. Install both of them in C:\egcs-1.1.2 and run
 118    C:\egcs-1.1.2\mingw32.bat to set the PATH.
 119
 120  * Compile OpenSSL:
 121
 122    > ms\mingw32
 123
 124    This will create the library and binaries in out. In case any problems
 125    occur, try
 126    > ms\mingw32 no-asm
 127    instead.
 128
 129    libcrypto.a and libssl.a are the static libraries. To use the DLLs,
 130    link with libeay32.a and libssl32.a instead.
 131
 132    See troubleshooting if you get error messages about functions not having
 133    a number assigned.
 134
 135  * You can now try the tests:
 136
 137    > cd out
 138    > ..\ms\test
 139
 140  GNU C (Cygwin)
 141  --------------
 142
 143  Cygwin provides a bash shell and GNU tools environment running on
 144  NT 4.0, Windows 9x and Windows 2000. Consequently, a make of OpenSSL
 145  with Cygwin is closer to a GNU bash environment such as Linux rather
 146  than other W32 makes that are based on a single makefile approach.
 147  Cygwin implements Posix/Unix calls through cygwin1.dll, and is
 148  contrasted to Mingw32 which links dynamically to msvcrt.dll or
 149  crtdll.dll.
 150
 151  To build OpenSSL using Cygwin:
 152
 153  * Install Cygwin (see http://sourceware.cygnus.com/cygwin)
 154
 155  * Install Perl and ensure it is in the path (recent Cygwin perl
 156    (version 5.6.1-2 of the latter has been reported to work) or
 157    ActivePerl)
 158
 159  * Run the Cygwin bash shell
 160
 161  * $ tar zxvf openssl-x.x.x.tar.gz
 162    $ cd openssl-x.x.x
 163    $ ./config
 164    [...]
 165    $ make
 166    [...]
 167    $ make test
 168    $ make install
 169
 170  This will create a default install in /usr/local/ssl.
 171
 172  Cygwin Notes:
 173
 174  "make test" and normal file operations may fail in directories
 175  mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin
 176  stripping of carriage returns. To avoid this ensure that a binary
 177  mount is used, e.g. mount -b c:\somewhere /home.
 178
 179  As of version 1.1.1 Cygwin is relatively unstable in its handling
 180  of cr/lf issues. These make procedures succeeded with versions 1.1 and
 181  the snapshot 20000524 (Slow!).
 182
 183  "bc" is not provided in the Cygwin distribution.  This causes a
 184  non-fatal error in "make test" but is otherwise harmless.  If
 185  desired, GNU bc can be built with Cygwin without change.
 186
 187
 188  Installation
 189  ------------
 190
 191  If you used the Cygwin procedure above, you have already installed and
 192  can skip this section.  For all other procedures, there's currently no real
 193  installation procedure for Win32.  There are, however, some suggestions:
 194
 195     - do nothing.  The include files are found in the inc32/ subdirectory,
 196       all binaries are found in out32dll/ or out32/ depending if you built
 197       dynamic or static libraries.
 198
 199     - do as is written in INSTALL.Win32 that comes with modssl:
 200
 201         $ md c:\openssl
 202         $ md c:\openssl\bin
 203         $ md c:\openssl\lib
 204         $ md c:\openssl\include
 205         $ md c:\openssl\include\openssl
 206         $ copy /b inc32\*               c:\openssl\include\openssl
 207         $ copy /b out32dll\ssleay32.lib c:\openssl\lib
 208         $ copy /b out32dll\libeay32.lib c:\openssl\lib
 209         $ copy /b out32dll\ssleay32.dll c:\openssl\bin
 210         $ copy /b out32dll\libeay32.dll c:\openssl\bin
 211         $ copy /b out32dll\openssl.exe  c:\openssl\bin
 212
 213       Of course, you can choose another device than c:.  C: is used here
 214       because that's usually the first (and often only) harddisk device.
 215       Note: in the modssl INSTALL.Win32, p: is used rather than c:.
 216
 217
 218  Troubleshooting
 219  ---------------
 220
 221  Since the Win32 build is only occasionally tested it may not always compile
 222  cleanly.  If you get an error about functions not having numbers assigned
 223  when you run ms\do_ms then this means the Win32 ordinal files are not up to
 224  date. You can do:
 225
 226  > perl util\mkdef.pl crypto ssl update
 227
 228  then ms\do_XXX should not give a warning any more. However the numbers that
 229  get assigned by this technique may not match those that eventually get
 230  assigned in the CVS tree: so anything linked against this version of the
 231  library may need to be recompiled.
 232
 233  If you get errors about unresolved symbols there are several possible
 234  causes.
 235
 236  If this happens when the DLL is being linked and you have disabled some
 237  ciphers then it is possible the DEF file generator hasn't removed all
 238  the disabled symbols: the easiest solution is to edit the DEF files manually
 239  to delete them. The DEF files are ms\libeay32.def ms\ssleay32.def.
 240
 241  Another cause is if you missed or ignored the errors about missing numbers
 242  mentioned above.
 243
 244  If you get warnings in the code then the compilation will halt.
 245
 246  The default Makefile for Win32 halts whenever any warnings occur. Since VC++
 247  has its own ideas about warnings which don't always match up to other
 248  environments this can happen. The best fix is to edit the file with the
 249  warning in and fix it. Alternatively you can turn off the halt on warnings by
 250  editing the CFLAG line in the Makefile and deleting the /WX option.
 251
 252  You might get compilation errors. Again you will have to fix these or report
 253  them.
 254
 255  One final comment about compiling applications linked to the OpenSSL library.
 256  If you don't use the multithreaded DLL runtime library (/MD option) your
 257  program will almost certainly crash because malloc gets confused -- the
 258  OpenSSL DLLs are statically linked to one version, the application must
 259  not use a different one.  You might be able to work around such problems
 260  by adding CRYPTO_malloc_init() to your program before any calls to the
 261  OpenSSL libraries: This tells the OpenSSL libraries to use the same
 262  malloc(), free() and realloc() as the application.  However there are many
 263  standard library functions used by OpenSSL that call malloc() internally
 264  (e.g. fopen()), and OpenSSL cannot change these; so in general you cannot
 265  rely on CRYPTO_malloc_init() solving your problem, and you should
 266  consistently use the multithreaded library.