INSTALL.W32 11 KB

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