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