]>
Commit | Line | Data |
---|---|---|
26abc8f0 RL |
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 | ||
14 | and one of the following C compilers: | |
15 | ||
16 | * Visual C++ | |
17 | * Borland C | |
18 | * GNU C (Cygwin or MinGW) | |
19 | ||
20 | If you are compiling from a tarball or a CVS snapshot then the Win32 files | |
21 | may well be not up to date. This may mean that some "tweaking" is required to | |
22 | get it all to work. See the trouble shooting section later on for if (when?) | |
23 | it goes wrong. | |
24 | ||
25 | Visual C++ | |
26 | ---------- | |
27 | ||
28 | If you want to compile in the assembly language routines with Visual C++ then | |
29 | you will need an assembler. This is worth doing because it will result in | |
30 | faster code: for example it will typically result in a 2 times speedup in the | |
31 | RSA routines. Currently the following assemblers are supported: | |
32 | ||
33 | * Microsoft MASM (aka "ml") | |
34 | * Free Netwide Assembler NASM. | |
35 | ||
36 | MASM is distributed with most versions of VC++. For the versions where it is | |
37 | not included in VC++, it is also distributed with some Microsoft DDKs, for | |
38 | example the Windows NT 4.0 DDK and the Windows 98 DDK. If you do not have | |
39 | either of these DDKs then you can just download the binaries for the Windows | |
40 | 98 DDK and extract and rename the two files XXXXXml.exe and XXXXXml.err, to | |
41 | ml.exe and ml.err and install somewhere on your PATH. Both DDKs can be | |
42 | downloaded from the Microsoft developers site www.msdn.com. | |
43 | ||
44 | NASM is freely available. Version 0.98 was used during testing: other versions | |
45 | may also work. It is available from many places, see for example: | |
46 | http://www.kernel.org/pub/software/devel/nasm/binaries/win32/ | |
47 | The NASM binary nasmw.exe needs to be installed anywhere on your PATH. | |
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 (Cygwin) | |
123 | -------------- | |
124 | ||
125 | Cygwin provides a bash shell and GNU tools environment running | |
126 | on NT 4.0, Windows 9x, Windows ME, Windows 2000, and Windows XP. | |
127 | Consequently, a make of OpenSSL with Cygwin is closer to a GNU | |
128 | bash environment such as Linux than to other the other Win32 | |
129 | makes. | |
130 | ||
131 | Cygwin implements a Posix/Unix runtime system (cygwin1.dll). | |
132 | It is also possible to create Win32 binaries that only use the | |
133 | Microsoft C runtime system (msvcrt.dll or crtdll.dll) using | |
134 | MinGW. MinGW can be used in the Cygwin development environment | |
135 | or in a standalone setup as described in the following section. | |
136 | ||
137 | To build OpenSSL using Cygwin: | |
138 | ||
139 | * Install Cygwin (see http://cygwin.com/) | |
140 | ||
141 | * Install Perl and ensure it is in the path. Both Cygwin perl | |
142 | (5.6.1-2 or newer) and ActivePerl work. | |
143 | ||
144 | * Run the Cygwin bash shell | |
145 | ||
146 | * $ tar zxvf openssl-x.x.x.tar.gz | |
147 | $ cd openssl-x.x.x | |
148 | ||
149 | To build the Cygwin version of OpenSSL: | |
150 | ||
151 | $ ./config | |
152 | [...] | |
153 | $ make | |
154 | [...] | |
155 | $ make test | |
156 | $ make install | |
157 | ||
158 | This will create a default install in /usr/local/ssl. | |
159 | ||
160 | To build the MinGW version (native Windows) in Cygwin: | |
161 | ||
162 | $ ./Configure mingw | |
163 | [...] | |
164 | $ make | |
165 | [...] | |
166 | $ make test | |
167 | $ make install | |
168 | ||
169 | Cygwin Notes: | |
170 | ||
171 | "make test" and normal file operations may fail in directories | |
172 | mounted as text (i.e. mount -t c:\somewhere /home) due to Cygwin | |
173 | stripping of carriage returns. To avoid this ensure that a binary | |
174 | mount is used, e.g. mount -b c:\somewhere /home. | |
175 | ||
176 | "bc" is not provided in older Cygwin distribution. This causes a | |
177 | non-fatal error in "make test" but is otherwise harmless. If | |
178 | desired and needed, GNU bc can be built with Cygwin without change. | |
179 | ||
180 | GNU C (MinGW) | |
181 | ------------- | |
182 | ||
183 | * Compiler installation: | |
184 | ||
185 | MinGW is available from http://www.mingw.org. Run the installer and | |
186 | set the MinGW bin directory to the PATH in "System Properties" or | |
187 | autoexec.bat. | |
188 | ||
189 | * Compile OpenSSL: | |
190 | ||
191 | > ms\mingw32 | |
192 | ||
193 | This will create the library and binaries in out. In case any problems | |
194 | occur, try | |
195 | > ms\mingw32 no-asm | |
196 | instead. | |
197 | ||
198 | libcrypto.a and libssl.a are the static libraries. To use the DLLs, | |
199 | link with libeay32.a and libssl32.a instead. | |
200 | ||
201 | See troubleshooting if you get error messages about functions not having | |
202 | a number assigned. | |
203 | ||
204 | * You can now try the tests: | |
205 | ||
206 | > cd out | |
207 | > ..\ms\test | |
208 | ||
209 | ||
210 | Installation | |
211 | ------------ | |
212 | ||
213 | If you used the Cygwin procedure above, you have already installed and | |
214 | can skip this section. For all other procedures, there's currently no real | |
215 | installation procedure for Win32. There are, however, some suggestions: | |
216 | ||
217 | - do nothing. The include files are found in the inc32/ subdirectory, | |
218 | all binaries are found in out32dll/ or out32/ depending if you built | |
219 | dynamic or static libraries. | |
220 | ||
221 | - do as is written in INSTALL.Win32 that comes with modssl: | |
222 | ||
223 | $ md c:\openssl | |
224 | $ md c:\openssl\bin | |
225 | $ md c:\openssl\lib | |
226 | $ md c:\openssl\include | |
227 | $ md c:\openssl\include\openssl | |
0ad2c4f8 | 228 | $ copy /b inc32\openssl\* c:\openssl\include\openssl |
26abc8f0 RL |
229 | $ copy /b out32dll\ssleay32.lib c:\openssl\lib |
230 | $ copy /b out32dll\libeay32.lib c:\openssl\lib | |
231 | $ copy /b out32dll\ssleay32.dll c:\openssl\bin | |
232 | $ copy /b out32dll\libeay32.dll c:\openssl\bin | |
233 | $ copy /b out32dll\openssl.exe c:\openssl\bin | |
234 | ||
235 | Of course, you can choose another device than c:. C: is used here | |
236 | because that's usually the first (and often only) harddisk device. | |
237 | Note: in the modssl INSTALL.Win32, p: is used rather than c:. | |
238 | ||
239 | ||
240 | Troubleshooting | |
241 | --------------- | |
242 | ||
243 | Since the Win32 build is only occasionally tested it may not always compile | |
244 | cleanly. If you get an error about functions not having numbers assigned | |
245 | when you run ms\do_ms then this means the Win32 ordinal files are not up to | |
246 | date. You can do: | |
247 | ||
248 | > perl util\mkdef.pl crypto ssl update | |
249 | ||
250 | then ms\do_XXX should not give a warning any more. However the numbers that | |
251 | get assigned by this technique may not match those that eventually get | |
252 | assigned in the CVS tree: so anything linked against this version of the | |
253 | library may need to be recompiled. | |
254 | ||
255 | If you get errors about unresolved symbols there are several possible | |
256 | causes. | |
257 | ||
258 | If this happens when the DLL is being linked and you have disabled some | |
259 | ciphers then it is possible the DEF file generator hasn't removed all | |
260 | the disabled symbols: the easiest solution is to edit the DEF files manually | |
261 | to delete them. The DEF files are ms\libeay32.def ms\ssleay32.def. | |
262 | ||
263 | Another cause is if you missed or ignored the errors about missing numbers | |
264 | mentioned above. | |
265 | ||
266 | If you get warnings in the code then the compilation will halt. | |
267 | ||
268 | The default Makefile for Win32 halts whenever any warnings occur. Since VC++ | |
269 | has its own ideas about warnings which don't always match up to other | |
270 | environments this can happen. The best fix is to edit the file with the | |
271 | warning in and fix it. Alternatively you can turn off the halt on warnings by | |
272 | editing the CFLAG line in the Makefile and deleting the /WX option. | |
273 | ||
274 | You might get compilation errors. Again you will have to fix these or report | |
275 | them. | |
276 | ||
277 | One final comment about compiling applications linked to the OpenSSL library. | |
278 | If you don't use the multithreaded DLL runtime library (/MD option) your | |
279 | program will almost certainly crash because malloc gets confused -- the | |
280 | OpenSSL DLLs are statically linked to one version, the application must | |
281 | not use a different one. You might be able to work around such problems | |
282 | by adding CRYPTO_malloc_init() to your program before any calls to the | |
283 | OpenSSL libraries: This tells the OpenSSL libraries to use the same | |
284 | malloc(), free() and realloc() as the application. However there are many | |
285 | standard library functions used by OpenSSL that call malloc() internally | |
286 | (e.g. fopen()), and OpenSSL cannot change these; so in general you cannot | |
287 | rely on CRYPTO_malloc_init() solving your problem, and you should | |
288 | consistently use the multithreaded library. |