[e5474751] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 | ]>
|
---|
| 7 |
|
---|
| 8 | <sect1 id="ch-system-openssl" role="wrap">
|
---|
| 9 | <?dbhtml filename="openssl.html"?>
|
---|
| 10 |
|
---|
| 11 | <sect1info condition="script">
|
---|
| 12 | <productname>openssl</productname>
|
---|
| 13 | <productnumber>&openssl-version;</productnumber>
|
---|
| 14 | <address>&openssl-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
| 17 | <title>OpenSSL-&openssl-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="ch-system-openssl">
|
---|
| 20 | <primary sortas="a-OpenSSL">OpenSSL</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title/>
|
---|
| 25 |
|
---|
| 26 | <para>The OpenSSL package contains management tools and libraries relating
|
---|
| 27 | to cryptography. These are useful for providing cryptographic functions
|
---|
[6a156bab] | 28 | to other packages, such as OpenSSH, email applications, and web browsers
|
---|
[e5474751] | 29 | (for accessing HTTPS sites). </para>
|
---|
| 30 |
|
---|
| 31 | <segmentedlist>
|
---|
| 32 | <segtitle>&buildtime;</segtitle>
|
---|
| 33 | <segtitle>&diskspace;</segtitle>
|
---|
| 34 |
|
---|
| 35 | <seglistitem>
|
---|
[fb386e0] | 36 | <seg>&openssl-fin-sbu;</seg>
|
---|
| 37 | <seg>&openssl-fin-du;</seg>
|
---|
[e5474751] | 38 | </seglistitem>
|
---|
| 39 | </segmentedlist>
|
---|
| 40 |
|
---|
| 41 | </sect2>
|
---|
| 42 |
|
---|
| 43 | <sect2 role="installation">
|
---|
| 44 | <title>Installation of OpenSSL</title>
|
---|
[f1b9d9d] | 45 | <!--
|
---|
[e5e442c] | 46 | <para>First fix a problem with some advanced architectures with avx512
|
---|
[0d80e532] | 47 | capability:</para>
|
---|
| 48 |
|
---|
| 49 | <screen><userinput remap="pre">sed -e '/bn_reduce.*m1/i\ factor_size /= sizeof(BN_ULONG) * 8;' \
|
---|
| 50 | -i crypto/bn/rsaz_exp_x2.c</userinput></screen>
|
---|
[f1b9d9d] | 51 | -->
|
---|
[e5474751] | 52 | <para>Prepare OpenSSL for compilation:</para>
|
---|
| 53 |
|
---|
| 54 | <screen><userinput remap="configure">./config --prefix=/usr \
|
---|
| 55 | --openssldir=/etc/ssl \
|
---|
| 56 | --libdir=lib \
|
---|
| 57 | shared \
|
---|
| 58 | zlib-dynamic</userinput></screen>
|
---|
| 59 |
|
---|
| 60 | <para>Compile the package:</para>
|
---|
| 61 |
|
---|
| 62 | <screen><userinput remap="make">make</userinput></screen>
|
---|
| 63 |
|
---|
| 64 | <para>To test the results, issue:</para>
|
---|
| 65 |
|
---|
| 66 | <screen><userinput remap="test">make test</userinput></screen>
|
---|
[a751c8d] | 67 |
|
---|
[ed48f326] | 68 | <para>One test, 30-test_afalg.t, is known to fail if the host kernel
|
---|
| 69 | does not have <option>CONFIG_CRYPTO_USER_API_SKCIPHER</option> enabled,
|
---|
| 70 | or does not have any options providing an AES with CBC implementation
|
---|
| 71 | (for example, the combination of <option>CONFIG_CRYPTO_AES</option>
|
---|
| 72 | and <option>CONFIG_CRYPTO_CBC</option>, or
|
---|
| 73 | <option>CONFIG_CRYPTO_AES_NI_INTEL</option> if the CPU supports AES-NI)
|
---|
| 74 | enabled. If it fails, it can safely be ignored.</para>
|
---|
[a751c8d] | 75 |
|
---|
[e5474751] | 76 | <para>Install the package:</para>
|
---|
| 77 |
|
---|
| 78 | <screen><userinput remap="install">sed -i '/INSTALL_LIBS/s/libcrypto.a libssl.a//' Makefile
|
---|
| 79 | make MANSUFFIX=ssl install</userinput></screen>
|
---|
| 80 |
|
---|
[f82ef49] | 81 | <para>Add the version to the documentation directory name, to be
|
---|
| 82 | consistent with other packages:</para>
|
---|
[e5474751] | 83 |
|
---|
[f82ef49] | 84 | <screen><userinput remap="install">mv -v /usr/share/doc/openssl /usr/share/doc/openssl-&openssl-version;</userinput></screen>
|
---|
| 85 |
|
---|
| 86 | <para>If desired, install some additional documentation:</para>
|
---|
| 87 |
|
---|
| 88 | <screen><userinput remap="install">cp -vfr doc/* /usr/share/doc/openssl-&openssl-version;</userinput></screen>
|
---|
[e5474751] | 89 |
|
---|
[6df63e4] | 90 | <note>
|
---|
| 91 | <para>
|
---|
| 92 | You should update OpenSSL when a new version which fixes vulnerabilities
|
---|
[0d7dbaf] | 93 | is announced. Since OpenSSL 3.0.0, the OpenSSL versioning scheme
|
---|
| 94 | follows the MAJOR.MINOR.PATCH format. API/ABI compatibility
|
---|
[5042efcc] | 95 | is guaranteed for the same MAJOR version number. Because LFS
|
---|
[0d7dbaf] | 96 | installs only the shared libraries, there is no need to recompile
|
---|
| 97 | packages which link to
|
---|
| 98 | <filename class="libraryfile">libcrypto.so</filename> or
|
---|
[6df63e4] | 99 | <filename class="libraryfile">libssl.so</filename>
|
---|
[5042efcc] | 100 | <emphasis>when upgrading to a version with the same MAJOR version
|
---|
| 101 | number</emphasis>.
|
---|
[6df63e4] | 102 | </para>
|
---|
| 103 |
|
---|
[ad09ba4] | 104 | <!-- https://bugzilla.mindrot.org/show_bug.cgi?id=3548 -->
|
---|
[bbaf00d] | 105 | <para>
|
---|
| 106 | If <application>OpenSSH</application> is installed, it will be an
|
---|
| 107 | exception of the general rule above. It contains an
|
---|
| 108 | over-restrictive OpenSSL version check, so both SSH client and SSH
|
---|
[ad09ba4] | 109 | server will refuse to start if OpenSSL
|
---|
[bbaf00d] | 110 | is updated with MAJOR version number unchanged but MINOR version
|
---|
| 111 | number changed. You need to rebuild
|
---|
| 112 | <application>OpenSSH</application> after such an upgrade.
|
---|
| 113 | <emphasis role='bold'>If <application>OpenSSH</application> is being
|
---|
| 114 | used to access the system, you must rebuild and reinstall it
|
---|
| 115 | after upgrading OpenSSL to a new MINOR version number before logout
|
---|
| 116 | or you won't be able to login via SSH anymore.</emphasis>
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
[6df63e4] | 119 | <para>
|
---|
| 120 | However, any running programs linked to those libraries need to be stopped
|
---|
[59fef4c] | 121 | and restarted. Read the related entries in
|
---|
| 122 | <xref linkend='pkgmgmt-upgrade-issues'/> for details.
|
---|
[6df63e4] | 123 | </para>
|
---|
| 124 |
|
---|
| 125 | </note>
|
---|
| 126 |
|
---|
[e5474751] | 127 | </sect2>
|
---|
| 128 |
|
---|
| 129 | <sect2 id="contents-openssl" role="content">
|
---|
| 130 | <title>Contents of OpenSSL</title>
|
---|
| 131 |
|
---|
| 132 | <segmentedlist>
|
---|
| 133 | <segtitle>Installed programs</segtitle>
|
---|
| 134 | <segtitle>Installed libraries</segtitle>
|
---|
| 135 | <segtitle>Installed directories</segtitle>
|
---|
| 136 |
|
---|
| 137 | <seglistitem>
|
---|
| 138 | <seg>
|
---|
| 139 | c_rehash and openssl
|
---|
| 140 | </seg>
|
---|
| 141 | <seg>
|
---|
[68a5dcb9] | 142 | libcrypto.so and libssl.so
|
---|
[e5474751] | 143 | </seg>
|
---|
| 144 | <seg>
|
---|
| 145 | /etc/ssl,
|
---|
| 146 | /usr/include/openssl,
|
---|
| 147 | /usr/lib/engines and
|
---|
| 148 | /usr/share/doc/openssl-&openssl-version;
|
---|
| 149 | </seg>
|
---|
| 150 | </seglistitem>
|
---|
| 151 | </segmentedlist>
|
---|
| 152 |
|
---|
| 153 | <variablelist>
|
---|
| 154 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 155 | <?dbfo list-presentation="list"?>
|
---|
| 156 | <?dbhtml list-presentation="table"?>
|
---|
| 157 |
|
---|
| 158 | <varlistentry id="c_rehash">
|
---|
| 159 | <term><command>c_rehash</command></term>
|
---|
| 160 | <listitem>
|
---|
| 161 | <para>
|
---|
[0b0fa07] | 162 | is a <application>Perl</application> script that
|
---|
| 163 | scans all files in a directory and adds symbolic links to their
|
---|
| 164 | hash values. Use of <command>c_rehash</command> is considered
|
---|
| 165 | obsolete and should be replaced by
|
---|
| 166 | <command>openssl rehash</command> command
|
---|
[e5474751] | 167 | </para>
|
---|
| 168 | <indexterm zone="ch-system-openssl c_rehash">
|
---|
| 169 | <primary sortas="b-c_rehash">c_rehash</primary>
|
---|
| 170 | </indexterm>
|
---|
| 171 | </listitem>
|
---|
| 172 | </varlistentry>
|
---|
| 173 |
|
---|
| 174 | <varlistentry id="openssl-prog">
|
---|
| 175 | <term><command>openssl</command></term>
|
---|
| 176 | <listitem>
|
---|
| 177 | <para>
|
---|
| 178 | is a command-line tool for using the various cryptography functions
|
---|
| 179 | of <application>OpenSSL</application>'s crypto library from the
|
---|
| 180 | shell. It can be used for various functions which are documented in
|
---|
[8d35535] | 181 | <command>man 1 openssl</command>
|
---|
[e5474751] | 182 | </para>
|
---|
| 183 | <indexterm zone="ch-system-openssl openssl-prog">
|
---|
| 184 | <primary sortas="b-openssl">openssl</primary>
|
---|
| 185 | </indexterm>
|
---|
| 186 | </listitem>
|
---|
| 187 | </varlistentry>
|
---|
| 188 |
|
---|
| 189 | <varlistentry id="libcrypto">
|
---|
| 190 | <term><filename class="libraryfile">libcrypto.so</filename></term>
|
---|
| 191 | <listitem>
|
---|
| 192 | <para>
|
---|
| 193 | implements a wide range of cryptographic algorithms used in various
|
---|
| 194 | Internet standards. The services provided by this library are used
|
---|
| 195 | by the <application>OpenSSL</application> implementations of SSL,
|
---|
| 196 | TLS and S/MIME, and they have also been used to implement
|
---|
| 197 | <application>OpenSSH</application>,
|
---|
| 198 | <application>OpenPGP</application>, and other cryptographic
|
---|
[8d35535] | 199 | standards
|
---|
[e5474751] | 200 | </para>
|
---|
| 201 | <indexterm zone="ch-system-openssl libcrypto">
|
---|
| 202 | <primary sortas="c-libcrypto">libcrypto.so</primary>
|
---|
| 203 | </indexterm>
|
---|
| 204 | </listitem>
|
---|
| 205 | </varlistentry>
|
---|
| 206 |
|
---|
| 207 | <varlistentry id="libssl">
|
---|
| 208 | <term><filename class="libraryfile">libssl.so</filename></term>
|
---|
| 209 | <listitem>
|
---|
| 210 | <para>
|
---|
| 211 | implements the Transport Layer Security (TLS v1) protocol.
|
---|
| 212 | It provides a rich API, documentation
|
---|
[ce536f9] | 213 | on which can be found by running <command>man 7 ssl</command>
|
---|
[e5474751] | 214 | </para>
|
---|
| 215 | <indexterm zone="ch-system-openssl libssl">
|
---|
| 216 | <primary sortas="c-libssl">libssl.so</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
| 219 | </varlistentry>
|
---|
| 220 |
|
---|
| 221 | </variablelist>
|
---|
| 222 |
|
---|
| 223 | </sect2>
|
---|
| 224 |
|
---|
| 225 | </sect1>
|
---|