INSTALL.W32 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. INSTALLATION ON THE WIN32 PLATFORM
  2. ----------------------------------
  3. [Instructions for building for Windows CE can be found in INSTALL.WCE]
  4. [Instructions for building for Win64 can be found in INSTALL.W64]
  5. Here are a few comments about building OpenSSL for Win32 environments,
  6. such as Windows NT and Windows 9x. It should be noted though that
  7. Windows 9x are not ordinarily tested. Its mention merely means that we
  8. attempt to maintain certain programming discipline and pay attention
  9. to backward compatibility issues, in other words it's kind of expected
  10. to work on Windows 9x, but no regression tests are actually performed.
  11. On additional note newer OpenSSL versions are compiled and linked with
  12. Winsock 2. This means that minimum OS requirement was elevated to NT 4
  13. and Windows 98 [there is Winsock 2 update for Windows 95 though].
  14. - you need Perl for Win32. Unless you will build on Cygwin, you will need
  15. ActiveState Perl, available from http://www.activestate.com/ActivePerl.
  16. - one of the following C compilers:
  17. * Visual C++
  18. * Borland C
  19. * GNU C (Cygwin or MinGW)
  20. - Netwide Assembler, a.k.a. NASM, available from http://nasm.sourceforge.net/
  21. is required if you intend to utilize assembler modules. Note that NASM
  22. is now the only supported assembler.
  23. If you are compiling from a tarball or a CVS snapshot then the Win32 files
  24. may well be not up to date. This may mean that some "tweaking" is required to
  25. get it all to work. See the trouble shooting section later on for if (when?)
  26. it goes wrong.
  27. Visual C++
  28. ----------
  29. If you want to compile in the assembly language routines with Visual
  30. C++, then you will need already mentioned Netwide Assembler binary,
  31. nasmw.exe or nasm.exe, to be available on your %PATH%.
  32. Firstly you should run Configure with platform VC-WIN32:
  33. > perl Configure VC-WIN32 --prefix=c:\some\openssl\dir
  34. Where the prefix argument specifies where OpenSSL will be installed to.
  35. Next you need to build the Makefiles and optionally the assembly
  36. language files:
  37. - If you are using NASM then run:
  38. > ms\do_nasm
  39. - If you don't want to use the assembly language files at all then run:
  40. > perl Configure VC-WIN32 no-asm --prefix=c:/some/openssl/dir
  41. > ms\do_ms
  42. If you get errors about things not having numbers assigned then check the
  43. troubleshooting section: you probably won't be able to compile it as it
  44. stands.
  45. Then from the VC++ environment at a prompt do:
  46. > nmake -f ms\ntdll.mak
  47. If all is well it should compile and you will have some DLLs and
  48. executables in out32dll. If you want to try the tests then do:
  49. > nmake -f ms\ntdll.mak test
  50. To install OpenSSL to the specified location do:
  51. > nmake -f ms\ntdll.mak install
  52. Tweaks:
  53. There are various changes you can make to the Win32 compile
  54. environment. By default the library is not compiled with debugging
  55. symbols. If you use the platform debug-VC-WIN32 instead of VC-WIN32
  56. then debugging symbols will be compiled in.
  57. By default in 1.0.0 OpenSSL will compile builtin ENGINES into the
  58. separate shared librariesy. If you specify the "enable-static-engine"
  59. option on the command line to Configure the shared library build
  60. (ms\ntdll.mak) will compile the engines into libeay32.dll instead.
  61. The default Win32 environment is to leave out any Windows NT specific
  62. features.
  63. If you want to enable the NT specific features of OpenSSL (currently
  64. only the logging BIO) follow the instructions above but call the batch
  65. file do_nt.bat instead of do_ms.bat.
  66. You can also build a static version of the library using the Makefile
  67. ms\nt.mak
  68. Borland C++ builder 5
  69. ---------------------
  70. * Configure for building with Borland Builder:
  71. > perl Configure BC-32
  72. * Create the appropriate makefile
  73. > ms\do_nasm
  74. * Build
  75. > make -f ms\bcb.mak
  76. Borland C++ builder 3 and 4
  77. ---------------------------
  78. * Setup PATH. First must be GNU make then bcb4/bin
  79. * Run ms\bcb4.bat
  80. * Run make:
  81. > make -f bcb.mak
  82. GNU C (Cygwin)
  83. --------------
  84. Cygwin implements a Posix/Unix runtime system (cygwin1.dll) on top of
  85. Win32 subsystem and provides a bash shell and GNU tools environment.
  86. Consequently, a make of OpenSSL with Cygwin is virtually identical to
  87. Unix procedure. It is also possible to create Win32 binaries that only
  88. use the Microsoft C runtime system (msvcrt.dll or crtdll.dll) using
  89. MinGW. MinGW can be used in the Cygwin development environment or in a
  90. standalone setup as described in the following section.
  91. To build OpenSSL using Cygwin:
  92. * Install Cygwin (see http://cygwin.com/)
  93. * Install Perl and ensure it is in the path. Both Cygwin perl
  94. (5.6.1-2 or newer) and ActivePerl work.
  95. * Run the Cygwin bash shell
  96. * $ tar zxvf openssl-x.x.x.tar.gz
  97. $ cd openssl-x.x.x
  98. To build the Cygwin version of OpenSSL:
  99. $ ./config
  100. [...]
  101. $ make
  102. [...]
  103. $ make test
  104. $ make install
  105. This will create a default install in /usr/local/ssl.
  106. To build the MinGW version (native Windows) in Cygwin:
  107. $ ./Configure mingw
  108. [...]
  109. $ make
  110. [...]
  111. $ make test
  112. $ make install
  113. Cygwin Notes:
  114. "make test" and normal file operations may fail in directories
  115. mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin
  116. stripping of carriage returns. To avoid this ensure that a binary
  117. mount is used, e.g. mount -b c:\somewhere /home.
  118. "bc" is not provided in older Cygwin distribution. This causes a
  119. non-fatal error in "make test" but is otherwise harmless. If
  120. desired and needed, GNU bc can be built with Cygwin without change.
  121. GNU C (MinGW/MSYS)
  122. -------------
  123. * Compiler and shell environment installation:
  124. MinGW and MSYS are available from http://www.mingw.org/, both are
  125. required. Run the installers and do whatever magic they say it takes
  126. to start MSYS bash shell with GNU tools on its PATH.
  127. * Compile OpenSSL:
  128. $ ./config
  129. [...]
  130. $ make
  131. [...]
  132. $ make test
  133. This will create the library and binaries in root source directory
  134. and openssl.exe application in apps directory.
  135. It is also possible to cross-compile it on Linux by configuring
  136. with './Configure --cross-compile-prefix=i386-mingw32- mingw ...'.
  137. 'make test' is naturally not applicable then.
  138. libcrypto.a and libssl.a are the static libraries. To use the DLLs,
  139. link with libeay32.a and libssl32.a instead.
  140. See troubleshooting if you get error messages about functions not
  141. having a number assigned.
  142. Installation
  143. ------------
  144. If you used the Cygwin procedure above, you have already installed and
  145. can skip this section. For all other procedures, there's currently no real
  146. installation procedure for Win32. There are, however, some suggestions:
  147. - do nothing. The include files are found in the inc32/ subdirectory,
  148. all binaries are found in out32dll/ or out32/ depending if you built
  149. dynamic or static libraries.
  150. - do as is written in INSTALL.Win32 that comes with modssl:
  151. $ md c:\openssl
  152. $ md c:\openssl\bin
  153. $ md c:\openssl\lib
  154. $ md c:\openssl\include
  155. $ md c:\openssl\include\openssl
  156. $ copy /b inc32\openssl\* c:\openssl\include\openssl
  157. $ copy /b out32dll\ssleay32.lib c:\openssl\lib
  158. $ copy /b out32dll\libeay32.lib c:\openssl\lib
  159. $ copy /b out32dll\ssleay32.dll c:\openssl\bin
  160. $ copy /b out32dll\libeay32.dll c:\openssl\bin
  161. $ copy /b out32dll\openssl.exe c:\openssl\bin
  162. Of course, you can choose another device than c:. C: is used here
  163. because that's usually the first (and often only) harddisk device.
  164. Note: in the modssl INSTALL.Win32, p: is used rather than c:.
  165. Troubleshooting
  166. ---------------
  167. Since the Win32 build is only occasionally tested it may not always compile
  168. cleanly. If you get an error about functions not having numbers assigned
  169. when you run ms\do_ms then this means the Win32 ordinal files are not up to
  170. date. You can do:
  171. > perl util\mkdef.pl crypto ssl update
  172. then ms\do_XXX should not give a warning any more. However the numbers that
  173. get assigned by this technique may not match those that eventually get
  174. assigned in the CVS tree: so anything linked against this version of the
  175. library may need to be recompiled.
  176. If you get errors about unresolved symbols there are several possible
  177. causes.
  178. If this happens when the DLL is being linked and you have disabled some
  179. ciphers then it is possible the DEF file generator hasn't removed all
  180. the disabled symbols: the easiest solution is to edit the DEF files manually
  181. to delete them. The DEF files are ms\libeay32.def ms\ssleay32.def.
  182. Another cause is if you missed or ignored the errors about missing numbers
  183. mentioned above.
  184. If you get warnings in the code then the compilation will halt.
  185. The default Makefile for Win32 halts whenever any warnings occur. Since VC++
  186. has its own ideas about warnings which don't always match up to other
  187. environments this can happen. The best fix is to edit the file with the
  188. warning in and fix it. Alternatively you can turn off the halt on warnings by
  189. editing the CFLAG line in the Makefile and deleting the /WX option.
  190. You might get compilation errors. Again you will have to fix these or report
  191. them.
  192. One final comment about compiling applications linked to the OpenSSL library.
  193. If you don't use the multithreaded DLL runtime library (/MD option) your
  194. program will almost certainly crash because malloc gets confused -- the
  195. OpenSSL DLLs are statically linked to one version, the application must
  196. not use a different one. You might be able to work around such problems
  197. by adding CRYPTO_malloc_init() to your program before any calls to the
  198. OpenSSL libraries: This tells the OpenSSL libraries to use the same
  199. malloc(), free() and realloc() as the application. However there are many
  200. standard library functions used by OpenSSL that call malloc() internally
  201. (e.g. fopen()), and OpenSSL cannot change these; so in general you cannot
  202. rely on CRYPTO_malloc_init() solving your problem, and you should
  203. consistently use the multithreaded library.
  204. Linking your application
  205. ------------------------
  206. If you link with static OpenSSL libraries [those built with ms/nt.mak],
  207. then you're expected to additionally link your application with
  208. WS2_32.LIB, ADVAPI32.LIB, GDI32.LIB and USER32.LIB. Those developing
  209. non-interactive service applications might feel concerned about linking
  210. with the latter two, as they are justly associated with interactive
  211. desktop, which is not available to service processes. The toolkit is
  212. designed to detect in which context it's currently executed, GUI,
  213. console app or service, and act accordingly, namely whether or not to
  214. actually make GUI calls.
  215. If you link with OpenSSL .DLLs, then you're expected to include into
  216. your application code small "shim" snippet, which provides glue between
  217. OpenSSL BIO layer and your compiler run-time. Look up OPENSSL_Applink
  218. reference page for further details.