Ugh, BIO_find_type() cannot be passed a NULL.
[openssl.git] / INSTALL.W32
index 6388c4c..2ef764a 100644 (file)
-Building OpenSSL under Win32.
+ INSTALLATION ON THE WIN32 PLATFORM
+ ----------------------------------
 
-Heres a few comments about building OpenSSL in Windows environments. Most of
-this is tested on Win32 but it may also work in Win 3.1 with some modification.
-See the end of this file for Eric's original comments.
+ Heres a few comments about building OpenSSL in Windows environments. Most of
+ this is tested on Win32 but it may also work in Win 3.1 with some
+ modification.
 
-Note: the default Win32 environment is to leave out any Windows NT specific
-features: (currently only BIO_s_log()) if you want NT specific features see
-the "Tweaks" section later.
+ You need Perl for Win32 (available from http://www.activestate.com/ActivePerl)
+ and one of the following C compilers:
 
-You will need perl for Win32 (which can be got from various sources) and Visual
-C++. 
+  * Visual C++
+  * Borland C
+  * GNU C (Mingw32 or Cygwin32)
 
-If you are compiling from a tarball or a CVS snapshot then the Win32 files may
-well be not up to date. This may mean that some "tweaking" is required to get
-it all to work. See the trouble shooting section later on for if (when?) it
-goes wrong.
+ If you want to compile in the assembly language routines with Visual C++ then
+ you will need an assembler. This is worth doing because it will result in
+ faster code: for example it will typically result in a 2 times speedup in the
+ RSA routines. Currently the following assemblers are supported:
 
-Firstly you should run Configure:
+  * Microsoft MASM (aka "ml")
+  * Free Netwide Assembler NASM.
 
-perl Configure VC-WIN32
+ MASM was at one point distributed with VC++. It is now distributed with some
+ Microsoft DDKs, for example the Windows NT 4.0 DDK and the Windows 98 DDK. If
+ you do not have either of these DDKs then you can just download the binaries
+ for the Windows 98 DDK and extract and rename the two files XXXXXml.exe and
+ XXXXXml.err, to ml.exe and ml.err and install somewhere on your PATH. Both
+ DDKs can be downloaded from the Microsoft developers site www.msdn.com.
 
-Then rebuild the Win32 Makefiles and friends:
+ NASM is freely available. Version 0.98 was used during testing: other versions
+ may also work. It is available from many places, see for example:
+ http://www.kernel.org/pub/software/devel/nasm/binaries/win32/
+ The NASM binary nasmw.exe needs to be installed anywhere on your PATH.
 
-ms\do_ms
+ If you are compiling from a tarball or a CVS snapshot then the Win32 files
+ may well be not up to date. This may mean that some "tweaking" is required to
+ get it all to work. See the trouble shooting section later on for if (when?)
+ it goes wrong.
 
-if you get errors about things not having numbers assigned then check the
-troubleshooting section: you probably wont be able to compile it as it stands.
+ Visual C++
+ ----------
 
-then from the VC++ environment at a prompt do:
+ Firstly you should run Configure:
 
-nmake -f ms\ntdll.mak
+ > perl Configure VC-WIN32
 
-you may get a warning about too many rules but if all is well it should all
-compile and you will have some DLLs and executables in out32dll. If you want
-to try the tests then cd to out32dll and run ..\ms\test
+ Next you need to build the Makefiles and optionally the assembly language
+ files:
 
-Troubleshooting.
+ - If you are using MASM then run:
 
-Since the Win32 build is only occasionally tested it may not always compile
-cleanly.
+   > ms\do_masm
 
-If you get an error about functions not having numbers assigned when you
-run ms\do_ms then this means the Win32 ordinal files are not up to date. You
-can do:
+ - If you are using NASM then run:
 
-perl util\mkdef.pl crypto ssl update
+   > ms\do_nasm
 
-then ms\do_ms should not give a warning any more. However the numbers that get
-assigned by this technique may not match those that eventually get assigned
-in the CVS tree: so anything linked against this version of the library
-may need to be recompiled.
+ - If you don't want to use the assembly language files at all then run:
 
-If you get errors about unresolved externals then this means that either you
-didn't read the note above about functions not having numbers assigned or
-someone forgot to add a function to the header file.
+   > ms\do_ms
 
-In this latter case check out the header file to see if the function is defined
-in the header file: it should be defined twice: once with ANSI prototypes and
-once without. If its missing from the non ASNI section then add an entry for
-it: check that ms\do_ms now reports missing numbers and update the numbers as
-above.
+ If you get errors about things not having numbers assigned then check the
+ troubleshooting section: you probably won't be able to compile it as it
+ stands.
 
-If you get warnings in the code then the compilation will halt.
+ Then from the VC++ environment at a prompt do:
 
-The default Makefile for Win32 halts whenever any warnings occur. Since VC++
-has its own ideas about warnings which don't always match up to other
-environments this can happen. The best fix is to edit the file with the warning
-in and fix it. Alternatively you can turn off the halt on warnings by editing
-the CFLAG line in the Makefile and deleting the /WX option.
+ > nmake -f ms\ntdll.mak
 
-You might get compilation errors. Again you will have to fix these or
-report them.
+ If all is well it should compile and you will have some DLLs and executables
+ in out32dll. If you want to try the tests then do:
+ > cd out32dll
+ > ..\ms\test
 
-One final comment about compiling applications linked to the OpenSSL library.
-If you don't use the multithreaded DLL runtime library (/MD option) your
-program will almost certainly crash: see the original SSLeay description below
-for more details.
+ Tweaks:
 
-Tweaks.
+ There are various changes you can make to the Win32 compile environment. By
+ default the library is not compiled with debugging symbols. If you add 'debug'
+ to the mk1mk.pl lines in the do_* batch file then debugging symbols will be
+ compiled in.
 
-There are various changes you can make to the Win32 compile environment. If you
-have the MASM assembler 'ml' then you can try the assembly language code. To
-do this remove the 'no-asm' part from do_ms.bat. You can also add 'debug' here
-to make a debugging version of the library.
+ The default Win32 environment is to leave out any Windows NT specific
+ features.
 
-If you want to enable the NT specific features of OpenSSL (currently only
-the logging BIO) follow the instructions above but call the batch file
-do_nt.bat instead of do_ms.bat.
+ If you want to enable the NT specific features of OpenSSL (currently only the
+ logging BIO) follow the instructions above but call the batch file do_nt.bat
+ instead of do_ms.bat.
 
-You can also build a static version of the library using the Makefile ms\nt.mak
+ You can also build a static version of the library using the Makefile
+ ms\nt.mak
 
---------------------------------------------------------------------------------
-The orignal Windows build instructions from SSLeay follow. Note: some of this
-may be out of date and no longer applicable
---------------------------------------------------------------------------------
+ Borland C++ builder 3 and 4
+ ---------------------------
 
-The Microsoft World.
+ * Setup PATH. First must be GNU make then bcb4/bin 
 
-The good news, to build SSLeay for the Microsft World
+ * Run ms\bcb4.bat
 
-Windows 3.1 DLL's
-perl Configure VC-WIN16
-nmake -f ms\w31dll.mak
+ * Run make:
+   > make -f bcb.mak
 
-Windows NT/95 DLL's
-perl Configure VC-WIN32
-nmake -f ms\ntdll.mak
+ GNU C (Mingw32)
+ ---------------
 
-Now the bad news
-All builds were done using Microsofts Visual C++ 1.52c and [45].x.
-If you are a borland person, you are probably going to have to help me
-finish the stuff in util/pl/BC*pl
-
-All builds were made under Windows NT - this means long filenames, so
-you may have problems under Windows 3.1 but probably not under 95.
-
-Because file pointers don't work in DLL's under Windows 3.1 (well at
-least stdin/stdout don't and I don't like having to differentiate
-between these and other file pointers), I now use the BIO file-pointer
-module, which needs to be linked into your application.  You can either
-use the memory buffer BIO for IO, or compile bss_file.c into your
-application, it is in the apps directory and is just a copy of
-crypto/buffer/bss_file.c with #define APPS_WIN16 added.
-I have not yet automated the makefile to automatically copy it into 'out'
-for a win 3.1 build....
-
-All callbacks passed into SSLeay for Windows 3.1 need to be of type
-_far _loadds.
-
-I don't support building with the pascal calling convention.
-
-The DLL and static builds are large memory model.
-
-To build static libraries for NT/95 or win 3.1
-
-perl util/mk1mf.pl VC-WIN32 > mf-stat.nt
-perl util/mk1mf.pl VC-WIN16 > mf-stat.w31
-for DLL's
-perl util/mk1mf.pl dll VC-WIN32        > mf-dll.nt
-perl util/mk1mf.pl dll VC-WIN16 > mf-dll.w31
-
-Again you will notice that if you dont have perl, you cannot do this.
-
-Now the next importaint issue.  Running Configure!
-I have small assember code files for critical big number library operation
-in crypto/bn/asm.  There is, asm code, object files and uuencode
-object files.  They are
-x86nt32.asm    - 32bit flat memory model assember - suitable Win32
-x86w16.asm     - 16bit assember - used in the msdos build.
-x86w32.asm     - 32bit assember, win 3.1 segments, used for win16 build.
-
-If you feel compelled to build the 16bit maths routines in the windows 3.1
-build,
-perl Configure VC-W31-16
-perl util/mk1mf.pl dll VC-W31-16 > mf-dll.w31
-
-If you hate assember and don't want anything to do with it,
-perl util/mk1mf.pl no-asm VC-WIN16 > mf-dll.w31
-will work for any of the makefile generations.
-
-There are more options to mk1mf.pl but these all leave the temporary
-files in 'tmp' and the output files in 'out' by default.
-
-The NT build is done for console mode.
-
-The Windows 3.1 version of SSLeay uses quickwin, the interface is ugly
-but it is better than nothing.  If you want ugly, try doing anything
-that involves getting a password.  I decided to be ugly instead of
-echoing characters.  For Windows 3.1 I would just sugest using the
-msdos version of the ssleay application for command line work.
-The QuickWin build is primarily for testing.
-
-For both NT and Windows 3.1, I have not written the code so that
-s_client, s_server can take input from the keyboard.  You can happily
-start applications up in separate windows, watch them handshake, and then sit
-there for-ever.  I have not had the time to get this working, and I've
-been able to test things from a unix box to the NT box :-).
-Try running ssleay s_server on the windows box
-(with either -cert ../apps/server.pem -www)
-and run ssleay s_time from another window.
-This often stuffs up on Windows 3.1, but I'm not worried since this is
-probably a problem with my demo applications, not the libraries.
-
-After a build of one of the version of microsoft SSLeay,
-'cd ms' and then run 'test'.  This should check everything out and
-even does a trial run of generating certificates.
-'test.bat' requires that perl be install, you be in the ms directory
-(not the test directory, thats for unix so stay out :-) and that the
-build output directory be ../out 
-
-On a last note, you will probably get division by zero errors and
-stuff after a build.  This is due to your own inability to follow
-instructions :-).
-
-The reasons for the problem is probably one of the following.
-
-1)     You did not run Configure.  This is critical for windows 3.1 when
-       using assember.  The values in crypto/bn/bn.h must match the
-       ones requred for the assember code.  (remember that if you
-       edit crypto/bn/bn.h by hand, it will be clobered the next time
-       you run Configure by the contents of crypto/bn/bn.org).
-       SSLeay version -o will list the compile options.
-       For VC-WIN32 you need bn(64,32) or bn(32,32)
-       For VC-W31-32/VC-WIN16 you need bn(32,32)
-       For VC-W31-16 you need bn(32,16) or bn(16,16)
-       For VC-MSDOS you need bn(32,16) or bn(16,16).
-
-       The first number will be 2 times bigger than the second if
-       BN_LLONG is defined in bn.h and the size of the second number
-       depends on the 'bits' defined at the start of bn.h.  Have a
-       look, it's all reasonably clear.
-       If you want to start messing with 8 bit builds and things like
-       that, build without the assember by re-generating a makefile
-       via 'perl util/mk1mf.pl no-asm'.
-2)     You tried to build under MS-DOS or Windows 3.1 using the /G3
-       option.  Don't.  It is buggy (thats why you just got that
-       error) and unless you want to work out which optimising flag
-       to turn off, I'm not going to help you :-).  I also noticed
-       that code often ran slower when compiled with /G3.
-3)     Under NT/95, malloc goes stupid.  You are probably linking with
-       the wrong library, there are problems if you mix the threaded
-       and non-threaded libraries (due to the DLL being staticly
-       linked with one and the applicaion using another.
-
-Well hopefully thats most of the MS issues handled, see you in ssl-users :-).
-
-eric 30-Aug-1996
-
-SSLeay 0.6.5
-For Windows 95/NT, add CRYPTO_malloc_init() to your program before any
-calls to the SSLeay libraries.  This function will insert callbacks so that
-the SSLeay libraries will use the same malloc(), free() and realloc() as
-your application so 'problem 3)' mentioned above will go away.
-
-There is now DES assember for Windows NT/95.  The file is
-crypto/des/asm/win32.asm and replaces crypto/des/des_enc.c in the build.
-
-There is also Blowfish assember for Windows NT/95.  The file is
-crypto/bf/asm/win32.asm and replaces crypto/bf/bf_enc.c in the build.
-
-eric 25-Jun-1997
+ To build OpenSSL, you need the Mingw32 package and GNU make.
 
+ * Compiler installation:
+
+   Mingw32 is available from <ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/
+   mingw32/egcs-1.1.2/egcs-1.1.2-mingw32.zip>. GNU make is at
+   <ftp://agnes.dida.physik.uni-essen.de/home/janjaap/mingw32/binaries/
+   make-3.76.1.zip>. Install both of them in C:\egcs-1.1.2 and run
+   C:\egcs-1.1.2\mingw32.bat to set the PATH.
+
+ * Compile OpenSSL:
+
+   > ms\mingw32
+
+   This will create the library and binaries in out. In case any problems
+   occur, try
+   > ms\mingw32 no-asm
+   instead.
+
+   libcrypto.a and libssl.a are the static libraries. To use the DLLs,
+   link with libeay32.a and libssl32.a instead.
+
+   See troubleshooting if you get error messages about functions not having
+   a number assigned.
+
+ * You can now try the tests:
+
+   > cd out
+   > ..\ms\test
+
+ GNU C (CygWin32)
+ ---------------
+
+ CygWin32 provides a bash shell and GNU tools environment running on
+ NT 4.0, Windows 9x and Windows 2000. Consequently, a make of OpenSSL
+ with CygWin is closer to a GNU bash environment such as Linux rather
+ than other W32 makes that are based on a single makefile approach.
+ CygWin32 implements Posix/Unix calls through cygwin1.dll, and is
+ contrasted to Mingw32 which links dynamically to msvcrt.dll or
+ crtdll.dll.
+
+ To build OpenSSL using CygWin32:
+
+ * Install CygWin32 (see http://sourceware.cygnus.com/cygwin)
+
+ * Install Perl and ensure it is in the path
+
+ * Run the CygWin bash shell
+
+ * $ tar zxvf openssl-x.x.x.tar.gz
+   $ cd openssl-x.x.x
+   $ ./Configure no-threads CygWin32
+   [...]
+   $ make
+   [...]
+   $ make test
+   $ make install
+
+ This will create a default install in /usr/local/ssl.
+
+ CygWin32 Notes:
+
+ "make test" and normal file operations may fail in directories
+ mounted as text (i.e. mount -t c:\somewhere /home) due to CygWin
+ stripping of carriage returns. To avoid this ensure that a binary
+ mount is used, e.g. mount -b c:\somewhere /home.
+
+ As of version 1.1.1 CygWin32 is relatively unstable in its handling
+ of cr/lf issues. These make procedures succeeded with versions 1.1 and
+ the snapshot 20000524 (Slow!).
+
+ "bc" is not provided in the CygWin32 distribution.  This causes a
+ non-fatal error in "make test" but is otherwise harmless.  If
+ desired, GNU bc can be built with CygWin32 without change.
+
+
+ Installation
+ ------------
+
+ There's currently no real installation procedure for Win32.  There are,
+ however, some suggestions:
+
+    - do nothing.  The include files are found in the inc32/ subdirectory,
+      all binaries are found in out32dll/ or out32/ depending if you built
+      dynamic or static libraries.
+
+    - do as is written in INSTALL.Win32 that comes with modssl:
+
+       $ md c:\openssl 
+       $ md c:\openssl\bin
+       $ md c:\openssl\lib
+       $ md c:\openssl\include
+       $ md c:\openssl\include\openssl
+       $ copy /b inc32\*               c:\openssl\include\openssl
+       $ copy /b out32dll\ssleay32.lib c:\openssl\lib
+       $ copy /b out32dll\libeay32.lib c:\openssl\lib
+       $ copy /b out32dll\ssleay32.dll c:\openssl\bin
+       $ copy /b out32dll\libeay32.dll c:\openssl\bin
+       $ copy /b out32dll\openssl.exe  c:\openssl\bin
+
+      Of course, you can choose another device than c:.  C: is used here
+      because that's usually the first (and often only) harddisk device.
+      Note: in the modssl INSTALL.Win32, p: is used rather than c:.
+
+
+ Troubleshooting
+ ---------------
+
+ Since the Win32 build is only occasionally tested it may not always compile
+ cleanly.  If you get an error about functions not having numbers assigned
+ when you run ms\do_ms then this means the Win32 ordinal files are not up to
+ date. You can do:
+
+ > perl util\mkdef.pl crypto ssl update
+
+ then ms\do_XXX should not give a warning any more. However the numbers that
+ get assigned by this technique may not match those that eventually get
+ assigned in the CVS tree: so anything linked against this version of the
+ library may need to be recompiled.
+
+ If you get errors about unresolved symbols there are several possible
+ causes.
+
+ If this happens when the DLL is being linked and you have disabled some
+ ciphers then it is possible the DEF file generator hasn't removed all
+ the disabled symbols: the easiest solution is to edit the DEF files manually
+ to delete them. The DEF files are ms\libeay32.def ms\ssleay32.def.
+
+ Another cause is if you missed or ignored the errors about missing numbers
+ mentioned above.
+
+ If you get warnings in the code then the compilation will halt.
+
+ The default Makefile for Win32 halts whenever any warnings occur. Since VC++
+ has its own ideas about warnings which don't always match up to other
+ environments this can happen. The best fix is to edit the file with the
+ warning in and fix it. Alternatively you can turn off the halt on warnings by
+ editing the CFLAG line in the Makefile and deleting the /WX option.
+
+ You might get compilation errors. Again you will have to fix these or report
+ them.
+
+ One final comment about compiling applications linked to the OpenSSL library.
+ If you don't use the multithreaded DLL runtime library (/MD option) your
+ program will almost certainly crash because malloc gets confused -- the
+ OpenSSL DLLs are statically linked to one version, the application must
+ not use a different one.  You might be able to work around such problems
+ by adding CRYPTO_malloc_init() to your program before any calls to the
+ OpenSSL libraries: This tells the OpenSSL libraries to use the same
+ malloc(), free() and realloc() as the application.  However there are many
+ standard library functions used by OpenSSL that call malloc() internally
+ (e.g. fopen()), and OpenSSL cannot change these; so in general you cannot
+ rely on CYRPTO_malloc_init() solving your problem, and you should
+ consistently use the multithreaded library.