INSTALL revision 55714
1 2 INSTALLATION ON THE UNIX PLATFORM 3 --------------------------------- 4 5 [See INSTALL.W32 for instructions for compiling OpenSSL on Windows systems, 6 and INSTALL.VMS for installing on OpenVMS systems.] 7 8 To install OpenSSL, you will need: 9 10 * Perl 5 11 * an ANSI C compiler 12 * a supported Unix operating system 13 14 Quick Start 15 ----------- 16 17 If you want to just get on with it, do: 18 19 $ ./config 20 $ make 21 $ make test 22 $ make install 23 24 [If any of these steps fails, see section Installation in Detail below.] 25 26 This will build and install OpenSSL in the default location, which is (for 27 historical reasons) /usr/local/ssl. If you want to install it anywhere else, 28 run config like this: 29 30 $ ./config --prefix=/usr/local --openssldir=/usr/local/openssl 31 32 33 Configuration Options 34 --------------------- 35 36 There are several options to ./config to customize the build: 37 38 --prefix=DIR Install in DIR/bin, DIR/lib, DIR/include/openssl. 39 Configuration files used by OpenSSL will be in DIR/ssl 40 or the directory specified by --openssldir. 41 42 --openssldir=DIR Directory for OpenSSL files. If no prefix is specified, 43 the library files and binaries are also installed there. 44 45 rsaref Build with RSADSI's RSAREF toolkit (this assumes that 46 librsaref.a is in the library search path). 47 48 no-threads Don't try to build with support for multi-threaded 49 applications. 50 51 threads Build with support for multi-threaded applications. 52 This will usually require additional system-dependent options! 53 See "Note on multi-threading" below. 54 55 no-asm Do not use assembler code. 56 57 386 Use the 80386 instruction set only (the default x86 code is 58 more efficient, but requires at least a 486). 59 60 no-<cipher> Build without the specified cipher (bf, cast, des, dh, dsa, 61 hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha). 62 The crypto/<cipher> directory can be removed after running 63 "make depend". 64 65 -Dxxx, -lxxx, -Lxxx, -fxxx, -Kxxx These system specific options will 66 be passed through to the compiler to allow you to 67 define preprocessor symbols, specify additional libraries, 68 library directories or other compiler options. 69 70 71 Installation in Detail 72 ---------------------- 73 74 1a. Configure OpenSSL for your operation system automatically: 75 76 $ ./config [options] 77 78 This guesses at your operating system (and compiler, if necessary) and 79 configures OpenSSL based on this guess. Run ./config -t to see 80 if it guessed correctly. If it did not get it correct or you want to 81 use a different compiler then go to step 1b. Otherwise go to step 2. 82 83 On some systems, you can include debugging information as follows: 84 85 $ ./config -d [options] 86 87 1b. Configure OpenSSL for your operating system manually 88 89 OpenSSL knows about a range of different operating system, hardware and 90 compiler combinations. To see the ones it knows about, run 91 92 $ ./Configure 93 94 Pick a suitable name from the list that matches your system. For most 95 operating systems there is a choice between using "cc" or "gcc". When 96 you have identified your system (and if necessary compiler) use this name 97 as the argument to ./Configure. For example, a "linux-elf" user would 98 run: 99 100 $ ./Configure linux-elf [options] 101 102 If your system is not available, you will have to edit the Configure 103 program and add the correct configuration for your system. The 104 generic configurations "cc" or "gcc" should usually work. 105 106 Configure creates the file Makefile.ssl from Makefile.org and 107 defines various macros in crypto/opensslconf.h (generated from 108 crypto/opensslconf.h.in). 109 110 2. Build OpenSSL by running: 111 112 $ make 113 114 This will build the OpenSSL libraries (libcrypto.a and libssl.a) and the 115 OpenSSL binary ("openssl"). The libraries will be built in the top-level 116 directory, and the binary will be in the "apps" directory. 117 118 If "make" fails, please report the problem to <openssl-bugs@openssl.org>. 119 Include the output of "./config -t" and the OpenSSL version 120 number in your message. 121 122 [If you encounter assembler error messages, try the "no-asm" 123 configuration option as an immediate fix. Note that on Solaris x86 124 (not on Sparcs!) you may have to install the GNU assembler to use 125 OpenSSL assembler code -- /usr/ccs/bin/as won't do.] 126 127 Compiling parts of OpenSSL with gcc and others with the system 128 compiler will result in unresolved symbols on some systems. 129 130 3. After a successful build, the libraries should be tested. Run: 131 132 $ make test 133 134 If a test fails, try removing any compiler optimization flags from 135 the CFLAGS line in Makefile.ssl and run "make clean; make". Please 136 send a bug report to <openssl-bugs@openssl.org>, including the 137 output of "openssl version -a" and of the failed test. 138 139 4. If everything tests ok, install OpenSSL with 140 141 $ make install 142 143 This will create the installation directory (if it does not exist) and 144 then the following subdirectories: 145 146 certs Initially empty, this is the default location 147 for certificate files. 148 misc Various scripts. 149 private Initially empty, this is the default location 150 for private key files. 151 152 If you didn't chose a different installation prefix, the 153 following additional subdirectories will be created: 154 155 bin Contains the openssl binary and a few other 156 utility programs. 157 include/openssl Contains the header files needed if you want to 158 compile programs with libcrypto or libssl. 159 lib Contains the OpenSSL library files themselves. 160 161 Package builders who want to configure the library for standard 162 locations, but have the package installed somewhere else so that 163 it can easily be packaged, can use 164 165 $ make INSTALL_PREFIX=/tmp/package-root install 166 167 (or specify "--install_prefix=/tmp/package-root" as a configure 168 option). The specified prefix will be prepended to all 169 installation target filenames. 170 171 172 NOTE: The header files used to reside directly in the include 173 directory, but have now been moved to include/openssl so that 174 OpenSSL can co-exist with other libraries which use some of the 175 same filenames. This means that applications that use OpenSSL 176 should now use C preprocessor directives of the form 177 178 #include <openssl/ssl.h> 179 180 instead of "#include <ssl.h>", which was used with library versions 181 up to OpenSSL 0.9.2b. 182 183 If you install a new version of OpenSSL over an old library version, 184 you should delete the old header files in the include directory. 185 186 Compatibility issues: 187 188 * COMPILING existing applications 189 190 To compile an application that uses old filenames -- e.g. 191 "#include <ssl.h>" --, it will usually be enough to find 192 the CFLAGS definition in the application's Makefile and 193 add a C option such as 194 195 -I/usr/local/ssl/include/openssl 196 197 to it. 198 199 But don't delete the existing -I option that points to 200 the ..../include directory! Otherwise, OpenSSL header files 201 could not #include each other. 202 203 * WRITING applications 204 205 To write an application that is able to handle both the new 206 and the old directory layout, so that it can still be compiled 207 with library versions up to OpenSSL 0.9.2b without bothering 208 the user, you can proceed as follows: 209 210 - Always use the new filename of OpenSSL header files, 211 e.g. #include <openssl/ssl.h>. 212 213 - Create a directory "incl" that contains only a symbolic 214 link named "openssl", which points to the "include" directory 215 of OpenSSL. 216 For example, your application's Makefile might contain the 217 following rule, if OPENSSLDIR is a pathname (absolute or 218 relative) of the directory where OpenSSL resides: 219 220 incl/openssl: 221 -mkdir incl 222 cd $(OPENSSLDIR) # Check whether the directory really exists 223 -ln -s `cd $(OPENSSLDIR); pwd`/include incl/openssl 224 225 You will have to add "incl/openssl" to the dependencies 226 of those C files that include some OpenSSL header file. 227 228 - Add "-Iincl" to your CFLAGS. 229 230 With these additions, the OpenSSL header files will be available 231 under both name variants if an old library version is used: 232 Your application can reach them under names like <openssl/foo.h>, 233 while the header files still are able to #include each other 234 with names of the form <foo.h>. 235 236 237 Note on multi-threading 238 ----------------------- 239 240 For some systems, the OpenSSL Configure script knows what compiler options 241 are needed to generate a library that is suitable for multi-threaded 242 applications. On these systems, support for multi-threading is enabled 243 by default; use the "no-threads" option to disable (this should never be 244 necessary). 245 246 On other systems, to enable support for multi-threading, you will have 247 to specify at least two options: "threads", and a system-dependent option. 248 (The latter is "-D_REENTRANT" on various systems.) The default in this 249 case, obviously, is not to include support for multi-threading (but 250 you can still use "no-threads" to suppress an annoying warning message 251 from the Configure script.) 252 253 254-------------------------------------------------------------------------------- 255The orignal Unix build instructions from SSLeay follow. 256Note: some of this may be out of date and no longer applicable 257-------------------------------------------------------------------------------- 258 259# When bringing the SSLeay distribution back from the evil intel world 260# of Windows NT, do the following to make it nice again under unix :-) 261# You don't normally need to run this. 262sh util/fixNT.sh # This only works for NT now - eay - 21-Jun-1996 263 264# If you have perl, and it is not in /usr/local/bin, you can run 265perl util/perlpath.pl /new/path 266# and this will fix the paths in all the scripts. DO NOT put 267# /new/path/perl, just /new/path. The build 268# environment always run scripts as 'perl perlscript.pl' but some of the 269# 'applications' are easier to usr with the path fixed. 270 271# Edit crypto/cryptlib.h, tools/c_rehash, and Makefile.ssl 272# to set the install locations if you don't like 273# the default location of /usr/local/ssl 274# Do this by running 275perl util/ssldir.pl /new/ssl/home 276# if you have perl, or by hand if not. 277 278# If things have been stuffed up with the sym links, run 279make -f Makefile.ssl links 280# This will re-populate lib/include with symlinks and for each 281# directory, link Makefile to Makefile.ssl 282 283# Setup the machine dependent stuff for the top level makefile 284# and some select .h files 285# If you don't have perl, this will bomb, in which case just edit the 286# top level Makefile.ssl 287./Configure 'system type' 288 289# The 'Configure' command contains default configuration parameters 290# for lots of machines. Configure edits 5 lines in the top level Makefile 291# It modifies the following values in the following files 292Makefile.ssl CC CFLAG EX_LIBS BN_MULW 293crypto/des/des.h DES_LONG 294crypto/des/des_locl.h DES_PTR 295crypto/md2/md2.h MD2_INT 296crypto/rc4/rc4.h RC4_INT 297crypto/rc4/rc4_enc.c RC4_INDEX 298crypto/rc2/rc2.h RC2_INT 299crypto/bf/bf_locl.h BF_INT 300crypto/idea/idea.h IDEA_INT 301crypto/bn/bn.h BN_LLONG (and defines one of SIXTY_FOUR_BIT, 302 SIXTY_FOUR_BIT_LONG, THIRTY_TWO_BIT, 303 SIXTEEN_BIT or EIGHT_BIT) 304Please remember that all these files are actually copies of the file with 305a .org extention. So if you change crypto/des/des.h, the next time 306you run Configure, it will be runover by a 'configured' version of 307crypto/des/des.org. So to make the changer the default, change the .org 308files. The reason these files have to be edited is because most of 309these modifications change the size of fundamental data types. 310While in theory this stuff is optional, it often makes a big 311difference in performance and when using assember, it is importaint 312for the 'Bignum bits' match those required by the assember code. 313A warning for people using gcc with sparc cpu's. Gcc needs the -mv8 314flag to use the hardware multiply instruction which was not present in 315earlier versions of the sparc CPU. I define it by default. If you 316have an old sparc, and it crashes, try rebuilding with this flag 317removed. I am leaving this flag on by default because it makes 318things run 4 times faster :-) 319 320# clean out all the old stuff 321make clean 322 323# Do a make depend only if you have the makedepend command installed 324# This is not needed but it does make things nice when developing. 325make depend 326 327# make should build everything 328make 329 330# fix up the demo certificate hash directory if it has been stuffed up. 331make rehash 332 333# test everything 334make test 335 336# install the lot 337make install 338 339# It is worth noting that all the applications are built into the one 340# program, ssleay, which is then has links from the other programs 341# names to it. 342# The applicatons can be built by themselves, just don't define the 343# 'MONOLITH' flag. So to build the 'enc' program stand alone, 344gcc -O2 -Iinclude apps/enc.c apps/apps.c libcrypto.a 345 346# Other useful make options are 347make makefile.one 348# which generate a 'makefile.one' file which will build the complete 349# SSLeay distribution with temp. files in './tmp' and 'installable' files 350# in './out' 351 352# Have a look at running 353perl util/mk1mf.pl help 354# this can be used to generate a single makefile and is about the only 355# way to generate makefiles for windows. 356 357# There is actually a final way of building SSLeay. 358gcc -O2 -c -Icrypto -Iinclude crypto/crypto.c 359gcc -O2 -c -Issl -Iinclude ssl/ssl.c 360# and you now have the 2 libraries as single object files :-). 361# If you want to use the assember code for your particular platform 362# (DEC alpha/x86 are the main ones, the other assember is just the 363# output from gcc) you will need to link the assember with the above generated 364# object file and also do the above compile as 365gcc -O2 -DBN_ASM -c -Icrypto -Iinclude crypto/crypto.c 366 367This last option is probably the best way to go when porting to another 368platform or building shared libraries. It is not good for development so 369I don't normally use it. 370 371To build shared libararies under unix, have a look in shlib, basically 372you are on your own, but it is quite easy and all you have to do 373is compile 2 (or 3) files. 374 375For mult-threading, have a read of doc/threads.doc. Again it is quite 376easy and normally only requires some extra callbacks to be defined 377by the application. 378The examples for solaris and windows NT/95 are in the mt directory. 379 380have fun 381 382eric 25-Jun-1997 383 384IRIX 5.x will build as a 32 bit system with mips1 assember. 385IRIX 6.x will build as a 64 bit system with mips3 assember. It conforms 386to n32 standards. In theory you can compile the 64 bit assember under 387IRIX 5.x but you will have to have the correct system software installed. 388