X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=INSTALL.W32;h=615d1419f13dd8ab36a951fbb7c22d03ba994c46;hp=8aa40023c50ada65b90f738e92097172484ee09c;hb=cfa3747ba95ed154caedf99f847082c72f867a27;hpb=d4d2f98c59a8553781d49b06576774db2929d671 diff --git a/INSTALL.W32 b/INSTALL.W32 index 8aa40023c5..615d1419f1 100644 --- a/INSTALL.W32 +++ b/INSTALL.W32 @@ -1,99 +1,178 @@ -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. See the end of this file for Eric's original comments. -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 I believe distributed in the past with VC++ and it is also part of + the MSDN SDKs. It is no longer distributed as part of VC++ and can be hard + to get hold of. It can be purchased: see Microsoft's site for details at: + http://www.microsoft.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 + + Next you need to build the Makefiles and optionally the assembly language + files. + + If you are using MASM then run: + + > ms\do_masm + + If you are using NASM then run: + + > ms\do_nasm + + If you don't want to use the assembly language files at all then run: + + > ms\do_ms + + 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. + + Then from the VC++ environment at a prompt do: + + > nmake -f ms\ntdll.mak + + 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 + + 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. + + 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. + + You can also build a static version of the library using the Makefile + ms\nt.mak + + Borland C++ builder 3 and 4 + --------------------------- + + * Setup PATH. First must be GNU make then bcb4/bin + + * Run ms\bcb4.bat + + * Run make: + > make -f bcb.mak + + GNU C (Mingw32) + --------------- + + To build OpenSSL, you need the Mingw32 package and GNU make. + + * Compiler installation: + + Mingw32 is available from . GNU make is at + . 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: -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 + > perl Configure Mingw32 + > ms\mw.bat -Troubleshooting. + This will create the library and binaries in out. -Since the Win32 build is only occasionally tested it may not always compile -cleanly. + libcrypto.a and libssl.a are the static libraries. To use the DLLs, + link with libeay32.a and libssl32.a instead. -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: + See troubleshooting if you get error messages about functions not having + a number assigned. -perl util\mkdef.pl crypto ssl update + * You can now try the tests: -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 you anything linked against this version of the library -may need to be recompiled. + > cd out + > ..\ms\test -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. + Troubleshooting + --------------- -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. + 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: -If you get warnings in the code then the compilation will halt. + > perl util\mkdef.pl crypto ssl update -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. + 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. -You might get compilation errors. Again you will have to fix these or -report them. + 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. -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. + In this latter case check out the header file to see if the function is + defined in the header file. -Tweaks. + If you get warnings in the code then the compilation will halt. -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 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. -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 do this then you will no longer be able -to run the OpenSSL binaries under Windows 95 or 98. + You might get compilation errors. Again you will have to fix these or report + them. -You can also build a static version of the library using the Makefile ms\nt.mak + 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. -------------------------------------------------------------------------------- -The orignal Windows build instructions from SSLeay follow. Note: some of this -may be out of date and no longer applicable +The orignal Windows build instructions from SSLeay follow. +Note: some of this may be out of date and no longer applicable. In particular +the Crypto_malloc_init() comment appears to be wrong: you always need to use +the same runtime library as the DLL itself. -------------------------------------------------------------------------------- The Microsoft World.