NOTES-Windows.txt 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. NOTES FOR WINDOWS PLATFORMS
  2. ===========================
  3. There are various options to build and run OpenSSL on the Windows platforms.
  4. "Native" OpenSSL uses the Windows APIs directly at run time.
  5. To build a native OpenSSL you can either use:
  6. Microsoft Visual C++ (MSVC) C compiler on the command line
  7. or
  8. MinGW cross compiler
  9. run on the GNU-like development environment MSYS2
  10. or run on Linux or Cygwin
  11. "Hosted" OpenSSL relies on an external POSIX compatibility layer
  12. for building (using GNU/Unix shell, compiler, and tools) and at run time.
  13. For this option you can use Cygwin.
  14. Visual C++ native builds, aka VC-*
  15. =====================================
  16. Requirement details
  17. -------------------
  18. In addition to the requirements and instructions listed in INSTALL.md,
  19. these are required as well:
  20. - Perl.
  21. We recommend Strawberry Perl, available from http://strawberryperl.com/
  22. Please read NOTES.PERL for more information, including the use of CPAN.
  23. An alternative is ActiveState Perl, https://www.activestate.com/ActivePerl
  24. for which you may need to explicitly build the Perl module Win32/Console.pm
  25. via https://platform.activestate.com/ActiveState and then download it.
  26. - Microsoft Visual C compiler.
  27. Since these are proprietary and ever-changing we cannot test them all.
  28. Older versions may not work. Use a recent version wherever possible.
  29. - Netwide Assembler (NASM), available from https://www.nasm.us
  30. Note that NASM is the only supported assembler.
  31. Quick start
  32. -----------
  33. 1. Install Perl
  34. 2. Install NASM
  35. 3. Make sure both Perl and NASM are on your %PATH%
  36. 4. Use Visual Studio Developer Command Prompt with administrative privileges,
  37. choosing one of its variants depending on the intended architecture.
  38. Or run "cmd" and execute "vcvarsall.bat" with one of the options x86,
  39. x86_amd64, x86_arm, x86_arm64, amd64, amd64_x86, amd64_arm, or amd64_arm64.
  40. This sets up the environment variables needed for nmake.exe, cl.exe, etc.
  41. See also https://docs.microsoft.com/cpp/build/building-on-the-command-line
  42. 5. From the root of the OpenSSL source directory enter
  43. perl Configure VC-WIN32 if you want 32-bit OpenSSL or
  44. perl Configure VC-WIN64A if you want 64-bit OpenSSL or
  45. perl Configure to let Configure figure out the platform
  46. 6. nmake
  47. 7. nmake test
  48. 8. nmake install
  49. For the full installation instructions, or if anything goes wrong at any stage,
  50. check the INSTALL.md file.
  51. Installation directories
  52. ------------------------
  53. The default installation directories are derived from environment
  54. variables.
  55. For VC-WIN32, the following defaults are use:
  56. PREFIX: %ProgramFiles(86)%\OpenSSL
  57. OPENSSLDIR: %CommonProgramFiles(86)%\SSL
  58. For VC-WIN64, the following defaults are use:
  59. PREFIX: %ProgramW6432%\OpenSSL
  60. OPENSSLDIR: %CommonProgramW6432%\SSL
  61. Should those environment variables not exist (on a pure Win32
  62. installation for examples), these fallbacks are used:
  63. PREFIX: %ProgramFiles%\OpenSSL
  64. OPENSSLDIR: %CommonProgramFiles%\SSL
  65. ALSO NOTE that those directories are usually write protected, even if
  66. your account is in the Administrators group. To work around that,
  67. start the command prompt by right-clicking on it and choosing "Run as
  68. Administrator" before running 'nmake install'. The other solution
  69. is, of course, to choose a different set of directories by using
  70. --prefix and --openssldir when configuring.
  71. Special notes for Universal Windows Platform builds, aka VC-*-UWP
  72. --------------------------------------------------------------------
  73. - UWP targets only support building the static and dynamic libraries.
  74. - You should define the platform type to "uwp" and the target arch via
  75. "vcvarsall.bat" before you compile. For example, if you want to build
  76. "arm64" builds, you should run "vcvarsall.bat x86_arm64 uwp".
  77. Native OpenSSL built using MinGW
  78. ================================
  79. MinGW offers an alternative way to build native OpenSSL, by cross compilation.
  80. * Usually the build is done on Windows in a GNU-like environment called MSYS2.
  81. MSYS2 provides GNU tools, a Unix-like command prompt,
  82. and a UNIX compatibility layer for applications.
  83. However, in this context it is only used for building OpenSSL.
  84. The resulting OpenSSL does not rely on MSYS2 to run and is fully native.
  85. Requirement details
  86. - MSYS2 shell, from https://www.msys2.org/
  87. - Perl, at least version 5.10.0, which usually comes pre-installed with MSYS2
  88. - make, installed using "pacman -S make" into the MSYS2 environment
  89. - MinGW[64] compiler: mingw-w64-i686-gcc and/or mingw-w64-x86_64-gcc.
  90. These compilers must be on your MSYS2 $PATH.
  91. A common error is to not have these on your $PATH.
  92. The MSYS2 version of gcc will not work correctly here.
  93. In the MSYS2 shell do the configuration depending on the target architecture:
  94. ./Configure mingw ...
  95. or
  96. ./Configure mingw64 ...
  97. or
  98. ./Configure ...
  99. for the default architecture.
  100. Apart from that, follow the Unix / Linux instructions in INSTALL.md.
  101. * It is also possible to build mingw[64] on Linux or Cygwin.
  102. In this case configure with the corresponding --cross-compile-prefix= option.
  103. For example
  104. ./Configure mingw --cross-compile-prefix=i686-w64-mingw32- ...
  105. or
  106. ./Configure mingw64 --cross-compile-prefix=x86_64-w64-mingw32- ...
  107. This requires that you've installed the necessary add-on packages for
  108. mingw[64] cross compilation.
  109. Linking your application
  110. ========================
  111. This section applies to all "native" builds.
  112. If you link with static OpenSSL libraries then you're expected to
  113. additionally link your application with WS2_32.LIB, GDI32.LIB,
  114. ADVAPI32.LIB, CRYPT32.LIB and USER32.LIB. Those developing
  115. non-interactive service applications might feel concerned about
  116. linking with GDI32.LIB and USER32.LIB, as they are justly associated
  117. with interactive desktop, which is not available to service
  118. processes. The toolkit is designed to detect in which context it's
  119. currently executed, GUI, console app or service, and act accordingly,
  120. namely whether or not to actually make GUI calls. Additionally those
  121. who wish to /DELAYLOAD:GDI32.DLL and /DELAYLOAD:USER32.DLL and
  122. actually keep them off service process should consider implementing
  123. and exporting from .exe image in question own _OPENSSL_isservice not
  124. relying on USER32.DLL. E.g., on Windows Vista and later you could:
  125. __declspec(dllexport) __cdecl BOOL _OPENSSL_isservice(void)
  126. { DWORD sess;
  127. if (ProcessIdToSessionId(GetCurrentProcessId(),&sess))
  128. return sess==0;
  129. return FALSE;
  130. }
  131. If you link with OpenSSL .DLLs, then you're expected to include into
  132. your application code a small "shim" snippet, which provides
  133. the glue between the OpenSSL BIO layer and your compiler run-time.
  134. See also the OPENSSL_Applink manual page.
  135. Hosted OpenSSL built using Cygwin
  136. =================================
  137. Cygwin implements a POSIX/Unix runtime system (cygwin1.dll) on top of the
  138. Windows subsystem and provides a Bash shell and GNU tools environment.
  139. Consequently, a build of OpenSSL with Cygwin is virtually identical to the
  140. Unix procedure.
  141. To build OpenSSL using Cygwin, you need to:
  142. * Install Cygwin, see https://cygwin.com/
  143. * Install Cygwin Perl, at least version 5.10.0
  144. and ensure it is in the $PATH
  145. * Run the Cygwin Bash shell
  146. Apart from that, follow the Unix / Linux instructions in INSTALL.md.
  147. NOTE: "make test" and normal file operations may fail in directories
  148. mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin
  149. stripping of carriage returns. To avoid this ensure that a binary
  150. mount is used, e.g. mount -b c:\somewhere /home.