X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=INSTALL.W32;h=76beee31822f9d057f0af5b96ded720d144881cd;hp=4f30700885e4e96ef77b7a177f7290b08030fcf6;hb=9c54e18bf037aad58dd19346fe23866a444df05c;hpb=2fdf5d7c2354b76bcc429b5f2c582a580e12d50d diff --git a/INSTALL.W32 b/INSTALL.W32 index 4f30700885..76beee3182 100644 --- a/INSTALL.W32 +++ b/INSTALL.W32 @@ -2,34 +2,32 @@ 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. + [Instructions for building for Windows CE can be found in INSTALL.WCE] + [Instructions for building for Win64 can be found in INSTALL.W64] - You need Perl for Win32 (available from http://www.activestate.com/ActivePerl) - and one of the following C compilers: + Here are a few comments about building OpenSSL for Win32 environments, + such as Windows NT and Windows 9x. It should be noted though that + Windows 9x are not ordinarily tested. Its mention merely means that we + attempt to maintain certain programming discipline and pay attention + to backward compatibility issues, in other words it's kind of expected + to work on Windows 9x, but no regression tests are actually performed. - * Visual C++ - * Borland C - * GNU C (Mingw32 or Cygwin32) + On additional note newer OpenSSL versions are compiled and linked with + Winsock 2. This means that minimum OS requirement was elevated to NT 4 + and Windows 98 [there is Winsock 2 update for Windows 95 though]. - 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: + - you need Perl for Win32. Unless you will build on Cygwin, you will need + ActiveState Perl, available from http://www.activestate.com/ActivePerl. - * Microsoft MASM (aka "ml") - * Free Netwide Assembler NASM. + - one of the following C compilers: - 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/ + * Visual C++ + * Borland C + * GNU C (Cygwin or MinGW) - 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. +- even though optional for non-gcc builds, Netwide Assembler, a.k.a. + NASM, available from http://sourceforge.net/projects/nasm is + recommended. 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 @@ -39,16 +37,18 @@ Visual C++ ---------- - Firstly you should run Configure: + If you want to compile in the assembly language routines with Visual + C++, then you will need already mentioned Netwide Assembler binary, + nasmw.exe, to be available on your %PATH%. - > perl Configure VC-WIN32 + Firstly you should run Configure: - Next you need to build the Makefiles and optionally the assembly language - files: + > perl Configure VC-WIN32 --prefix=c:/some/openssl/dir - - If you are using MASM then run: + Where the prefix argument specifies where OpenSSL will be installed to. - > ms\do_masm + Next you need to build the Makefiles and optionally the assembly + language files: - If you are using NASM then run: @@ -59,36 +59,62 @@ > 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 + troubleshooting section: you probably won't 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: + 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 + > nmake -f ms\ntdll.mak test + + + To install OpenSSL to the specified location do: + + > nmake -f ms\ntdll.mak install 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. By default the library is not compiled with debugging + symbols. If you add 'debug' to the mk1mf.pl lines in the do_* batch + file then debugging symbols will be compiled in. Note that mk1mf.pl + expects the platform to be the last argument on the command line, so + 'debug' must appear before that, as all other options. + + + By default in 0.9.8 OpenSSL will compile builtin ENGINES into the + libeay32.dll shared library. If you specify the "no-static-engine" + option on the command line to Configure the shared library build + (ms\ntdll.mak) will compile the engines as separate DLLs. 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 + + + Borland C++ builder 5 + --------------------- + + * Configure for building with Borland Builder: + > perl Configure BC-32 + + * Create the appropriate makefile + > ms\do_nasm + + * Build + > make -f ms\bcb.mak + Borland C++ builder 3 and 4 --------------------------- @@ -99,36 +125,119 @@ * Run make: > make -f bcb.mak - GNU C (Mingw32) - --------------- + GNU C (Cygwin) + -------------- + + Cygwin implements a Posix/Unix runtime system (cygwin1.dll) on top of + Win32 subsystem and provides a bash shell and GNU tools environment. + Consequently, a make of OpenSSL with Cygwin is virtually identical to + Unix procedure. It is also possible to create Win32 binaries that only + use the Microsoft C runtime system (msvcrt.dll or crtdll.dll) using + MinGW. MinGW can be used in the Cygwin development environment or in a + standalone setup as described in the following section. + + To build OpenSSL using Cygwin: - To build OpenSSL, you need the Mingw32 package and GNU make. + * Install Cygwin (see http://cygwin.com/) - * Compiler installation: + * Install Perl and ensure it is in the path. Both Cygwin perl + (5.6.1-2 or newer) and ActivePerl work. - 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. + * Run the Cygwin bash shell + + * $ tar zxvf openssl-x.x.x.tar.gz + $ cd openssl-x.x.x + + To build the Cygwin version of OpenSSL: + + $ ./config + [...] + $ make + [...] + $ make test + $ make install + + This will create a default install in /usr/local/ssl. + + To build the MinGW version (native Windows) in Cygwin: + + $ ./Configure mingw + [...] + $ make + [...] + $ make test + $ make install + + Cygwin 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. + + "bc" is not provided in older Cygwin distribution. This causes a + non-fatal error in "make test" but is otherwise harmless. If + desired and needed, GNU bc can be built with Cygwin without change. + + GNU C (MinGW/MSYS) + ------------- + + * Compiler and shell environment installation: + + MinGW and MSYS are available from http://www.mingw.org/, both are + required. Run the installers and do whatever magic they say it takes + to start MSYS bash shell with GNU tools on its PATH. * Compile OpenSSL: - > perl Configure Mingw32 - > ms\mw.bat + $ ./config + [...] + $ make + [...] + $ make test + + This will create the library and binaries in root source directory + and openssl.exe application in apps directory. - This will create the library and binaries in out. + It is also possible to cross-compile it on Linux by configuring + with './Configure --cross-compile-prefix=i386-mingw32- mingw ...'. + 'make test' is naturally not applicable then. 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. + See troubleshooting if you get error messages about functions not + having a number assigned. + + Installation + ------------ + + If you used the Cygwin procedure above, you have already installed and + can skip this section. For all other procedures, there's currently no real + installation procedure for Win32. There are, however, some suggestions: - * You can now try the tests: + - 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\openssl\* 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:. - > cd out - > ..\ms\test Troubleshooting --------------- @@ -145,12 +254,16 @@ 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 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. + If you get errors about unresolved symbols there are several possible + causes. - In this latter case check out the header file to see if the function is - defined in the header file. + 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. @@ -165,6 +278,31 @@ 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. - + 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 CRYPTO_malloc_init() solving your problem, and you should + consistently use the multithreaded library. + + Linking your application + ------------------------ + + If you link with static OpenSSL libraries [those built with ms/nt.mak], + then you're expected to additionally link your application with + WS2_32.LIB, ADVAPI32.LIB, GDI32.LIB and USER32.LIB. Those developing + non-interactive service applications might feel concerned about linking + with the latter two, as they are justly associated with interactive + desktop, which is not available to service processes. The toolkit is + designed to detect in which context it's currently executed, GUI, + console app or service, and act accordingly, namely whether or not to + actually make GUI calls. + + If you link with OpenSSL .DLLs, then you're expected to include into + your application code small "shim" snippet, which provides glue between + OpenSSL BIO layer and your compiler run-time. Look up OPENSSL_Applink + reference page for further details.