93ca701a97a0e1230bdbd3706bc87d0bc85c7d7b
[users/heiko/exim.git] / doc / doc-txt / openssl.txt
1 OpenSSL
2 =======
3
4 The OpenSSL Project documents their supported releases at
5 <https://www.openssl.org/policies/releasestrat.html>.  The Exim
6 Maintainers are unwilling to try to support Exim built with a
7 version of a critical security library which is unmaintained.
8
9 Thus as versions of OpenSSL become unsupported by OpenSSL, they become
10 unsupported by Exim.  Exim might build with older releases of OpenSSL,
11 but that's risky behaviour.
12
13 If your operating system vendor continues to ship an older version of
14 OpenSSL and is diligently backporting security fixes, and they support
15 Exim, then they will be backporting fixes to their packages of Exim too.
16 If you wish to stick purely to packages of OpenSSL, then stick to
17 packages of Exim too.
18
19 If someone maintains "backports", that is worth exploring too.
20
21 Note that a number of OSes use Exim with GnuTLS, not OpenSSL.
22
23 Otherwise, assuming that your operating system has old OpenSSL, and you
24 wish to use current Exim with OpenSSL, then you need to build and
25 install your own, without interfering with the system libraries.
26 Fortunately, this is easy.
27
28 So this only applies if you build Exim yourself.
29
30
31 Build
32 -----
33
34 Extract the current source of OpenSSL.  Change into that directory.
35
36 This assumes that `/opt/openssl` is not in use.  If it is, pick
37 something else.  `/opt/exim/openssl` perhaps.
38
39     ./config --prefix=/opt/openssl --openssldir=/etc/ssl  \
40         -L/opt/openssl/lib -Wl,-R/opt/openssl/lib         \
41         enable-ssl-trace shared
42     make
43     make install
44
45 You now have an installed OpenSSL under /opt/openssl which will not be
46 used by any system programs.
47
48 When you copy `src/EDITME` to `Local/Makefile` to make your build edits,
49 choose the pkg-config approach in that file, but also tell Exim to add
50 the relevant directory into the rpath stamped into the binary:
51
52     PKG_CONFIG_PATH=/opt/openssl/lib/pkgconfig
53
54     SUPPORT_TLS=yes
55     USE_OPENSSL_PC=openssl
56     LDFLAGS+=-ldl -Wl,-rpath,/opt/openssl/lib
57
58 [jgh: I've see /usr/local/lib used]
59
60 The -ldl is needed by OpenSSL 1.0.2+ on Linux and is not needed on most
61 other platforms.  The LDFLAGS is needed because `pkg-config` doesn't know
62 how to emit information about RPATH-stamping, but we can still leverage
63 `pkg-config` for everything else.
64
65 Then build Exim:
66
67     make
68     sudo make install
69
70
71 Confirming
72 ----------
73
74 Run:
75
76     exim -d-all+expand --version
77
78 and look for the `Library version: OpenSSL:` lines.
79
80 To look at the libraries _probably_ found by the linker, use:
81
82     ldd $(which exim)           # most platforms
83     otool -L $(which exim)      # MacOS
84
85 although that does not correctly handle restrictions imposed upon
86 executables which are setuid.
87
88 If the `chrpath` package is installed, then:
89
90     chrpath -l $(which exim)
91
92 will show the DT_RPATH stamped into the binary.
93
94 Your `binutils` package should come with `readelf`, so an alternative
95 is to run:
96
97     readelf -d $(which exim) | grep RPATH
98
99 [jgh: I've seen that spelled RUNPATH]
100
101 Very Advanced
102 -------------
103
104 You can not use $ORIGIN for portably packing OpenSSL in with Exim with
105 normal Exim builds, because Exim is installed setuid which causes the
106 runtime linker to ignore $ORIGIN in DT_RPATH.
107
108 _If_ following the steps for a non-setuid Exim, _then_ you can use:
109
110     EXTRALIBS_EXIM=-ldl '-Wl,-rpath,$$ORIGIN/../lib'
111
112 The doubled `$$` is needed for the make(1) layer and the quotes needed
113 for the shell invoked by make(1) for calling the linker.
114
115 Note that this is sufficiently far outside normal that the build-system
116 doesn't support it by default; you'll want to drop a symlink to the lib
117 directory into the Exim release top-level directory, so that lib exists
118 as a sibling to the build-$platform directory.
119