INSTALL.W32

   1
   2  INSTALLATION ON THE WIN32 PLATFORM
   3  ----------------------------------
   4
   5  [Instructions for building for Windows CE can be found in INSTALL.WCE]
   6  [Instructions for building for Win64 can be found in INSTALL.W64]
   7
   8  Heres a few comments about building OpenSSL in Windows environments.  Most
   9  of this is tested on Win32 but it may also work in Win 3.1 with some
  10  modification.
  11
  12  You need Perl for Win32.  Unless you will build on Cygwin, you will need
  13  ActiveState Perl, available from http://www.activestate.com/ActivePerl.
  14
  15  and one of the following C compilers:
  16
  17   * Visual C++
  18   * Borland C
  19   * GNU C (Cygwin or MinGW)
  20
  21  If you are compiling from a tarball or a CVS snapshot then the Win32 files
  22  may well be not up to date. This may mean that some "tweaking" is required to
  23  get it all to work. See the trouble shooting section later on for if (when?)
  24  it goes wrong.
  25
  26  Visual C++
  27  ----------
  28
  29  If you want to compile in the assembly language routines with Visual C++ then
  30  you will need an assembler. This is worth doing because it will result in
  31  faster code: for example it will typically result in a 2 times speedup in the
  32  RSA routines. Assembler choice is limited to Free Netwise Assember, NASM,
  33  available for download from http://sourceforge.net/projects/nasm/, even in
  34  binary form. The NASM binary, nasmw.exe needs to be installed anywhere on
  35  your %PATH%.
  36
  37  Firstly you should run Configure:
  38
  39  > perl Configure VC-WIN32 --prefix=c:/some/openssl/dir
  40
  41 Where the prefix argument specifies where OpenSSL will be installed to.
  42
  43  Next you need to build the Makefiles and optionally the assembly language
  44  files:
  45
  46  - If you are using NASM then run:
  47
  48    > ms\do_nasm
  49
  50  - If you don't want to use the assembly language files at all then run:
  51
  52    > ms\do_ms
  53
  54  If you get errors about things not having numbers assigned then check the
  55  troubleshooting section: you probably won't be able to compile it as it
  56  stands.
  57
  58  Then from the VC++ environment at a prompt do:
  59
  60  > nmake -f ms\ntdll.mak
  61
  62  If all is well it should compile and you will have some DLLs and executables
  63  in out32dll. If you want to try the tests then do:
  64
  65  > nmake -f ms\ntdll.mak test
  66
  67
  68 To install OpenSSL to the specified location do:
  69
  70 > nmake -f ms\ntdll.mak install
  71
  72  Tweaks:
  73
  74  There are various changes you can make to the Win32 compile environment. By
  75  default the library is not compiled with debugging symbols. If you add 'debug'
  76  to the mk1mf.pl lines in the do_* batch file then debugging symbols will be
  77  compiled in. Note that mk1mf.pl expects the platform to be the last argument
  78  on the command line, so 'debug' must appear before that, as all other options.
  79
  80
  81  By default in 0.9.8 OpenSSL will compile builtin ENGINES into the libeay32.dll
  82  shared library. If you specify the "no-static-engine" option on the command
  83  line to Configure the shared library build (ms\ntdll.mak) will compile the
  84  engines as separate DLLs.
  85
  86  The default Win32 environment is to leave out any Windows NT specific
  87  features.
  88
  89  If you want to enable the NT specific features of OpenSSL (currently only the
  90  logging BIO) follow the instructions above but call the batch file do_nt.bat
  91  instead of do_ms.bat.
  92
  93  You can also build a static version of the library using the Makefile
  94  ms\nt.mak
  95
  96
  97
  98  Borland C++ builder 5
  99  ---------------------
 100
 101  * Configure for building with Borland Builder:
 102    > perl Configure BC-32
 103
 104  * Create the appropriate makefile
 105    > ms\do_nasm
 106
 107  * Build
 108    > make -f ms\bcb.mak
 109
 110  Borland C++ builder 3 and 4
 111  ---------------------------
 112
 113  * Setup PATH. First must be GNU make then bcb4/bin
 114
 115  * Run ms\bcb4.bat
 116
 117  * Run make:
 118    > make -f bcb.mak
 119
 120  GNU C (Cygwin)
 121  --------------
 122
 123  Cygwin provides a bash shell and GNU tools environment running
 124  on NT 4.0, Windows 9x, Windows ME, Windows 2000, and Windows XP.
 125  Consequently, a make of OpenSSL with Cygwin is closer to a GNU
 126  bash environment such as Linux than to other the other Win32
 127  makes.
 128
 129  Cygwin implements a Posix/Unix runtime system (cygwin1.dll).
 130  It is also possible to create Win32 binaries that only use the
 131  Microsoft C runtime system (msvcrt.dll or crtdll.dll) using
 132  MinGW. MinGW can be used in the Cygwin development environment
 133  or in a standalone setup as described in the following section.
 134
 135  To build OpenSSL using Cygwin:
 136
 137  * Install Cygwin (see http://cygwin.com/)
 138
 139  * Install Perl and ensure it is in the path. Both Cygwin perl
 140    (5.6.1-2 or newer) and ActivePerl work.
 141
 142  * Run the Cygwin bash shell
 143
 144  * $ tar zxvf openssl-x.x.x.tar.gz
 145    $ cd openssl-x.x.x
 146
 147    To build the Cygwin version of OpenSSL:
 148
 149    $ ./config
 150    [...]
 151    $ make
 152    [...]
 153    $ make test
 154    $ make install
 155
 156    This will create a default install in /usr/local/ssl.
 157
 158    To build the MinGW version (native Windows) in Cygwin:
 159
 160    $ ./Configure mingw
 161    [...]
 162    $ make
 163    [...]
 164    $ make test
 165    $ make install
 166
 167  Cygwin Notes:
 168
 169  "make test" and normal file operations may fail in directories
 170  mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin
 171  stripping of carriage returns. To avoid this ensure that a binary
 172  mount is used, e.g. mount -b c:\somewhere /home.
 173
 174  "bc" is not provided in older Cygwin distribution.  This causes a
 175  non-fatal error in "make test" but is otherwise harmless.  If
 176  desired and needed, GNU bc can be built with Cygwin without change.
 177
 178  GNU C (MinGW)
 179  -------------
 180
 181  * Compiler installation:
 182
 183    MinGW is available from http://www.mingw.org. Run the installer and
 184    set the MinGW bin directory to the PATH in "System Properties" or
 185    autoexec.bat.
 186
 187  * Compile OpenSSL:
 188
 189    > ms\mingw32
 190
 191    This will create the library and binaries in out. In case any problems
 192    occur, try
 193    > ms\mingw32 no-asm
 194    instead.
 195
 196    libcrypto.a and libssl.a are the static libraries. To use the DLLs,
 197    link with libeay32.a and libssl32.a instead.
 198
 199    See troubleshooting if you get error messages about functions not having
 200    a number assigned.
 201
 202  * You can now try the tests:
 203
 204    > cd out
 205    > ..\ms\test
 206
 207
 208  Installation
 209  ------------
 210
 211  If you used the Cygwin procedure above, you have already installed and
 212  can skip this section.  For all other procedures, there's currently no real
 213  installation procedure for Win32.  There are, however, some suggestions:
 214
 215     - do nothing.  The include files are found in the inc32/ subdirectory,
 216       all binaries are found in out32dll/ or out32/ depending if you built
 217       dynamic or static libraries.
 218
 219     - do as is written in INSTALL.Win32 that comes with modssl:
 220
 221         $ md c:\openssl
 222         $ md c:\openssl\bin
 223         $ md c:\openssl\lib
 224         $ md c:\openssl\include
 225         $ md c:\openssl\include\openssl
 226         $ copy /b inc32\openssl\*       c:\openssl\include\openssl
 227         $ copy /b out32dll\ssleay32.lib c:\openssl\lib
 228         $ copy /b out32dll\libeay32.lib c:\openssl\lib
 229         $ copy /b out32dll\ssleay32.dll c:\openssl\bin
 230         $ copy /b out32dll\libeay32.dll c:\openssl\bin
 231         $ copy /b out32dll\openssl.exe  c:\openssl\bin
 232
 233       Of course, you can choose another device than c:.  C: is used here
 234       because that's usually the first (and often only) harddisk device.
 235       Note: in the modssl INSTALL.Win32, p: is used rather than c:.
 236
 237
 238  Troubleshooting
 239  ---------------
 240
 241  Since the Win32 build is only occasionally tested it may not always compile
 242  cleanly.  If you get an error about functions not having numbers assigned
 243  when you run ms\do_ms then this means the Win32 ordinal files are not up to
 244  date. You can do:
 245
 246  > perl util\mkdef.pl crypto ssl update
 247
 248  then ms\do_XXX should not give a warning any more. However the numbers that
 249  get assigned by this technique may not match those that eventually get
 250  assigned in the CVS tree: so anything linked against this version of the
 251  library may need to be recompiled.
 252
 253  If you get errors about unresolved symbols there are several possible
 254  causes.
 255
 256  If this happens when the DLL is being linked and you have disabled some
 257  ciphers then it is possible the DEF file generator hasn't removed all
 258  the disabled symbols: the easiest solution is to edit the DEF files manually
 259  to delete them. The DEF files are ms\libeay32.def ms\ssleay32.def.
 260
 261  Another cause is if you missed or ignored the errors about missing numbers
 262  mentioned above.
 263
 264  If you get warnings in the code then the compilation will halt.
 265
 266  The default Makefile for Win32 halts whenever any warnings occur. Since VC++
 267  has its own ideas about warnings which don't always match up to other
 268  environments this can happen. The best fix is to edit the file with the
 269  warning in and fix it. Alternatively you can turn off the halt on warnings by
 270  editing the CFLAG line in the Makefile and deleting the /WX option.
 271
 272  You might get compilation errors. Again you will have to fix these or report
 273  them.
 274
 275  One final comment about compiling applications linked to the OpenSSL library.
 276  If you don't use the multithreaded DLL runtime library (/MD option) your
 277  program will almost certainly crash because malloc gets confused -- the
 278  OpenSSL DLLs are statically linked to one version, the application must
 279  not use a different one.  You might be able to work around such problems
 280  by adding CRYPTO_malloc_init() to your program before any calls to the
 281  OpenSSL libraries: This tells the OpenSSL libraries to use the same
 282  malloc(), free() and realloc() as the application.  However there are many
 283  standard library functions used by OpenSSL that call malloc() internally
 284  (e.g. fopen()), and OpenSSL cannot change these; so in general you cannot
 285  rely on CRYPTO_malloc_init() solving your problem, and you should
 286  consistently use the multithreaded library.
 287
 288  Linking your application
 289  ------------------------
 290
 291  If you link with static OpenSSL libraries [those built with ms/nt.mak],
 292  then you're expected to additionally link your application with
 293  WSOCK32.LIB, ADVAPI32.LIB, GDI32.LIB and USER32.LIB. Those developing
 294  non-interactive service applications might feel concerned about linking
 295  with latter two, as they are justly associated with interactive desktop,
 296  which is not available to service processes. The toolkit is designed
 297  to detect in which context it's currently executed, GUI, console app
 298  or service, and act accordingly, namely whether or not to actually make
 299  GUI calls.
 300
 301  If you link with OpenSSL .DLLs, then you're expected to include into
 302  your application code small "shim" snippet, which provides glue between
 303  OpenSSL BIO layer and your compiler run-time. Look up OPENSSL_Applink
 304  reference page for further details.