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