NOTES.WIN 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. NOTES FOR THE WINDOWS PLATFORMS
  2. ===============================
  3. Windows targets can be classified as "native", ones that use Windows API
  4. directly, and "hosted" which rely on POSIX-compatible layer. "Native"
  5. targets are VC-* (where "VC" stems from abbreviating Microsoft Visual C
  6. compiler) and mingw[64]. "Hosted" platforms are Cygwin and MSYS[2]. Even
  7. though the latter is not directly supported by OpenSSL Team, it's #1
  8. popular choice for building MinGW targets. In the nutshell MinGW builds
  9. are always cross-compiled. On Linux and Cygwin they look exactly as such
  10. and require --cross-compile-prefix option. While on MSYS[2] it's solved
  11. rather by placing gcc that produces "MinGW binary" code 1st on $PATH.
  12. This is customarily source of confusion. "Hosted" applications "live" in
  13. emulated file system name space with POSIX-y root, mount points, /dev
  14. and even /proc. Confusion is intensified by the fact that MSYS2 shell
  15. (or rather emulated execve(2) call) examines the binary it's about to
  16. start, and if it's found *not* to be linked with MSYS2 POSIX-y thing,
  17. command line arguments that look like file names get translated from
  18. emulated name space to "native". For example '/c/some/where' becomes
  19. 'c:\some\where', '/dev/null' - 'nul'. This creates an illusion that
  20. there is no difference between MSYS2 shell and "MinGW binary", but
  21. there is. Just keep in mind that "MinGW binary" "experiences" Windows
  22. system in exactly same way as one produced by VC, and in its essence
  23. is indistinguishable from the latter. (Which by the way is why
  24. it's referred to in quotes here, as "MinGW binary", it's just as
  25. "native" as it can get.)
  26. Visual C++ builds, a.k.a. VC-*
  27. ==============================
  28. Requirement details
  29. -------------------
  30. In addition to the requirements and instructions listed in INSTALL,
  31. these are required as well:
  32. - Perl. We recommend ActiveState Perl, available from
  33. https://www.activestate.com/ActivePerl. Another viable alternative
  34. appears to be Strawberry Perl, http://strawberryperl.com.
  35. You also need the perl module Text::Template, available on CPAN.
  36. Please read NOTES.PERL for more information.
  37. - Microsoft Visual C compiler. Since we can't test them all, there is
  38. unavoidable uncertainty about which versions are supported. Latest
  39. version along with couple of previous are certainly supported. On
  40. the other hand oldest one is known not to work. Everything between
  41. falls into best-effort category.
  42. - Netwide Assembler, a.k.a. NASM, available from http://www.nasm.us,
  43. is required if you intend to utilize assembler modules. Note that NASM
  44. is the only supported assembler. The Microsoft provided assembler is NOT
  45. supported.
  46. Installation directories
  47. ------------------------
  48. The default installation directories are derived from environment
  49. variables.
  50. For VC-WIN32, the following defaults are use:
  51. PREFIX: %ProgramFiles(86)%\OpenSSL
  52. OPENSSLDIR: %CommonProgramFiles(86)%\SSL
  53. For VC-WIN64, the following defaults are use:
  54. PREFIX: %ProgramW6432%\OpenSSL
  55. OPENSSLDIR: %CommonProgramW6432%\SSL
  56. Should those environment variables not exist (on a pure Win32
  57. installation for examples), these fallbacks are used:
  58. PREFIX: %ProgramFiles%\OpenSSL
  59. OPENSSLDIR: %CommonProgramFiles%\SSL
  60. ALSO NOTE that those directories are usually write protected, even if
  61. your account is in the Administrators group. To work around that,
  62. start the command prompt by right-clicking on it and choosing "Run as
  63. Administrator" before running 'nmake install'. The other solution
  64. is, of course, to choose a different set of directories by using
  65. --prefix and --openssldir when configuring.
  66. mingw and mingw64
  67. =================
  68. * MSYS2 shell and development environment installation:
  69. Download MSYS2 from https://msys2.github.io/ and follow installation
  70. instructions. Once up and running install even make, perl, (git if
  71. needed,) mingw-w64-i686-gcc and/or mingw-w64-x86_64-gcc. You should
  72. have corresponding MinGW items on your start menu, use *them*, not
  73. generic MSYS2. As implied in opening note, difference between them
  74. is which compiler is found 1st on $PATH. At this point ./config
  75. should recognize correct target, roll as if it was Unix...
  76. * It is also possible to build mingw[64] on Linux or Cygwin by
  77. configuring with corresponding --cross-compile-prefix= option. For
  78. example
  79. ./Configure mingw --cross-compile-prefix=i686-w64-mingw32- ...
  80. or
  81. ./Configure mingw64 --cross-compile-prefix=x86_64-w64-mingw32- ...
  82. This naturally implies that you've installed corresponding add-on
  83. packages.
  84. Linking your application
  85. ========================
  86. This section applies to all "native" builds.
  87. If you link with static OpenSSL libraries then you're expected to
  88. additionally link your application with WS2_32.LIB, GDI32.LIB,
  89. ADVAPI32.LIB, CRYPT32.LIB and USER32.LIB. Those developing
  90. non-interactive service applications might feel concerned about
  91. linking with GDI32.LIB and USER32.LIB, as they are justly associated
  92. with interactive desktop, which is not available to service
  93. processes. The toolkit is designed to detect in which context it's
  94. currently executed, GUI, console app or service, and act accordingly,
  95. namely whether or not to actually make GUI calls. Additionally those
  96. who wish to /DELAYLOAD:GDI32.DLL and /DELAYLOAD:USER32.DLL and
  97. actually keep them off service process should consider implementing
  98. and exporting from .exe image in question own _OPENSSL_isservice not
  99. relying on USER32.DLL. E.g., on Windows Vista and later you could:
  100. __declspec(dllexport) __cdecl BOOL _OPENSSL_isservice(void)
  101. { DWORD sess;
  102. if (ProcessIdToSessionId(GetCurrentProcessId(),&sess))
  103. return sess==0;
  104. return FALSE;
  105. }
  106. If you link with OpenSSL .DLLs, then you're expected to include into
  107. your application code small "shim" snippet, which provides glue between
  108. OpenSSL BIO layer and your compiler run-time. See the OPENSSL_Applink
  109. manual page for further details.
  110. Cygwin, "hosted" environment
  111. ============================
  112. Cygwin implements a Posix/Unix runtime system (cygwin1.dll) on top of the
  113. Windows subsystem and provides a bash shell and GNU tools environment.
  114. Consequently, a make of OpenSSL with Cygwin is virtually identical to the
  115. Unix procedure.
  116. To build OpenSSL using Cygwin, you need to:
  117. * Install Cygwin (see https://cygwin.com/)
  118. * Install Cygwin Perl and ensure it is in the path. Recall that
  119. as least 5.10.0 is required.
  120. * Run the Cygwin bash shell
  121. Apart from that, follow the Unix instructions in INSTALL.
  122. NOTE: "make test" and normal file operations may fail in directories
  123. mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin
  124. stripping of carriage returns. To avoid this ensure that a binary
  125. mount is used, e.g. mount -b c:\somewhere /home.