[52d29f7] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[52d29f7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[bbdb0d16] | 7 | <!ENTITY openssl-download-http
|
---|
[17f36b0] | 8 | "https://openssl.org/source/openssl-&openssl-version;.tar.gz">
|
---|
[bbdb0d16] | 9 | <!ENTITY openssl-download-ftp
|
---|
[17f36b0] | 10 | "ftp://openssl.org/source/openssl-&openssl-version;.tar.gz">
|
---|
[a4f37269] | 11 | <!ENTITY openssl-md5sum "7b521dea79ab159e8ec879d2333369fa">
|
---|
[30d6b736] | 12 | <!ENTITY openssl-size "5.1 MB">
|
---|
[a4f37269] | 13 | <!ENTITY openssl-buildsize "70 MB (with tests)">
|
---|
| 14 | <!ENTITY openssl-time "1.5 SBU (with tests)">
|
---|
[52d29f7] | 15 | ]>
|
---|
| 16 |
|
---|
[cef3a2f] | 17 | <sect1 id="openssl" xreflabel="OpenSSL-&openssl-version;">
|
---|
[5a5bbbf] | 18 | <?dbhtml filename="openssl.html"?>
|
---|
| 19 |
|
---|
| 20 | <sect1info>
|
---|
| 21 | <othername>$LastChangedBy$</othername>
|
---|
| 22 | <date>$Date$</date>
|
---|
| 23 | </sect1info>
|
---|
| 24 |
|
---|
| 25 | <title>OpenSSL-&openssl-version;</title>
|
---|
| 26 |
|
---|
| 27 | <indexterm zone="openssl">
|
---|
| 28 | <primary sortas="a-OpenSSL">OpenSSL</primary>
|
---|
| 29 | </indexterm>
|
---|
| 30 |
|
---|
| 31 | <sect2 role="package">
|
---|
| 32 | <title>Introduction to OpenSSL</title>
|
---|
| 33 |
|
---|
[bbdb0d16] | 34 | <para>
|
---|
| 35 | The <application>OpenSSL</application> package contains management tools
|
---|
| 36 | and libraries relating to cryptography. These are useful for providing
|
---|
[45db70f] | 37 | cryptographic functions to other packages, such as
|
---|
[bbdb0d16] | 38 | <application>OpenSSH</application>, email applications and web browsers
|
---|
| 39 | (for accessing HTTPS sites).
|
---|
| 40 | </para>
|
---|
[5a5bbbf] | 41 |
|
---|
[63a26beb] | 42 | &lfs80_checked;
|
---|
[8e848de9] | 43 | &gcc7_checked;
|
---|
[aafcfb8] | 44 |
|
---|
[5a5bbbf] | 45 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 46 | <itemizedlist spacing="compact">
|
---|
| 47 | <listitem>
|
---|
[bbdb0d16] | 48 | <para>
|
---|
| 49 | Download (HTTP): <ulink url="&openssl-download-http;"/>
|
---|
| 50 | </para>
|
---|
[5a5bbbf] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[bbdb0d16] | 53 | <para>
|
---|
| 54 | Download (FTP): <ulink url="&openssl-download-ftp;"/>
|
---|
| 55 | </para>
|
---|
[5a5bbbf] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[bbdb0d16] | 58 | <para>
|
---|
| 59 | Download MD5 sum: &openssl-md5sum;
|
---|
| 60 | </para>
|
---|
[5a5bbbf] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[bbdb0d16] | 63 | <para>
|
---|
| 64 | Download size: &openssl-size;
|
---|
| 65 | </para>
|
---|
[5a5bbbf] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[bbdb0d16] | 68 | <para>
|
---|
| 69 | Estimated disk space required: &openssl-buildsize;
|
---|
| 70 | </para>
|
---|
[5a5bbbf] | 71 | </listitem>
|
---|
| 72 | <listitem>
|
---|
[bbdb0d16] | 73 | <para>
|
---|
| 74 | Estimated build time: &openssl-time;
|
---|
| 75 | </para>
|
---|
[5a5bbbf] | 76 | </listitem>
|
---|
| 77 | </itemizedlist>
|
---|
| 78 |
|
---|
[bbdb0d16] | 79 | <para condition="html" role="usernotes">
|
---|
| 80 | User Notes: <ulink url='&blfs-wiki;/OpenSSL'/>
|
---|
| 81 | </para>
|
---|
[5a5bbbf] | 82 | </sect2>
|
---|
| 83 |
|
---|
| 84 | <sect2 role="installation">
|
---|
| 85 | <title>Installation of OpenSSL</title>
|
---|
| 86 |
|
---|
[bbdb0d16] | 87 | <para>
|
---|
[d5d39eb] | 88 | Install <application>OpenSSL</application> with the following commands:
|
---|
[bbdb0d16] | 89 | </para>
|
---|
[5a5bbbf] | 90 |
|
---|
[f82ac3f] | 91 |
|
---|
[03da570f] | 92 | <screen><userinput>./config --prefix=/usr \
|
---|
[c96921c] | 93 | --openssldir=/etc/ssl \
|
---|
[202d18d] | 94 | --libdir=lib \
|
---|
[c96921c] | 95 | shared \
|
---|
| 96 | zlib-dynamic &&
|
---|
[a4f37269] | 97 | make</userinput></screen>
|
---|
[a181baeb] | 98 |
|
---|
[bbdb0d16] | 99 | <para>
|
---|
[2f1d148] | 100 | To test the results, issue: <command>make test</command>.
|
---|
[bbdb0d16] | 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <para>
|
---|
| 104 | If you want to disable installing the static libraries, use this sed:
|
---|
| 105 | </para>
|
---|
[5a5bbbf] | 106 |
|
---|
[a4f37269] | 107 | <screen><userinput>sed -i 's# libcrypto.a##;s# libssl.a##;/INSTALL_LIBS/s#libcrypto.a##' Makefile</userinput></screen>
|
---|
[bbdb0d16] | 108 |
|
---|
| 109 | <para>
|
---|
| 110 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 111 | </para>
|
---|
[5a5bbbf] | 112 |
|
---|
[1faedf0] | 113 | <!-- dev note: make INSTALL_PREFIX=<DESTDIR> MANDIR=/usr/share/man MANSUFFIX=ssl install -->
|
---|
| 114 |
|
---|
[a4f37269] | 115 | <screen role="root"><userinput>make MANSUFFIX=ssl install &&
|
---|
| 116 | mv -v /usr/share/doc/openssl{,-&openssl-version;} &&
|
---|
| 117 | cp -vfr doc/* /usr/share/doc/openssl-&openssl-version;</userinput></screen>
|
---|
[4c39aff] | 118 |
|
---|
[5a5bbbf] | 119 | </sect2>
|
---|
| 120 |
|
---|
| 121 | <sect2 role="commands">
|
---|
| 122 | <title>Command Explanations</title>
|
---|
| 123 |
|
---|
[bbdb0d16] | 124 | <para>
|
---|
| 125 | <parameter>shared</parameter>: This parameter forces the creation of
|
---|
| 126 | shared libraries along with the static libraries.
|
---|
| 127 | </para>
|
---|
| 128 |
|
---|
| 129 | <para>
|
---|
| 130 | <parameter>zlib-dynamic</parameter>: This parameter adds
|
---|
| 131 | compression/decompression functionality using the
|
---|
| 132 | <filename class="libraryfile">libz</filename> library.
|
---|
| 133 | </para>
|
---|
| 134 |
|
---|
| 135 | <para>
|
---|
| 136 | <option>no-rc5 no-idea</option>: When added to the
|
---|
| 137 | <command>./config</command> command, this will eliminate the building
|
---|
| 138 | of those encryption methods. Patent licenses may be needed for you to
|
---|
| 139 | utilize either of those methods in your projects.
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
| 142 | <para>
|
---|
[a4f37269] | 143 | <command>make MANSUFFIX=ssl install</command>:
|
---|
| 144 | This command appends an "ssl" suffix to the manual page names to avoid
|
---|
| 145 | conflicts with manual pages installed by other packages.
|
---|
[bbdb0d16] | 146 | </para>
|
---|
[4c39aff] | 147 |
|
---|
[5a5bbbf] | 148 | </sect2>
|
---|
| 149 |
|
---|
| 150 | <sect2 role="configuration">
|
---|
| 151 | <title>Configuring OpenSSL</title>
|
---|
| 152 |
|
---|
| 153 | <sect3 id="openssl-config">
|
---|
| 154 | <title>Config Files</title>
|
---|
| 155 |
|
---|
[bbdb0d16] | 156 | <para>
|
---|
[d5d39eb] | 157 | <filename>/etc/ssl/openssl.cnf</filename>
|
---|
[bbdb0d16] | 158 | </para>
|
---|
[5a5bbbf] | 159 |
|
---|
| 160 | <indexterm zone="openssl openssl-config">
|
---|
| 161 | <primary sortas="e-etc-ssl-openssl.cnf">/etc/ssl/openssl.cnf</primary>
|
---|
| 162 | </indexterm>
|
---|
[4c39aff] | 163 |
|
---|
[5a5bbbf] | 164 | </sect3>
|
---|
[d5d39eb] | 165 |
|
---|
[5a5bbbf] | 166 | <sect3>
|
---|
| 167 | <title>Configuration Information</title>
|
---|
| 168 |
|
---|
[bbdb0d16] | 169 | <para>
|
---|
| 170 | Most users will want to install Certificate Authority Certificates
|
---|
[5f91dfd] | 171 | for validation of downloaded certificates. For example, these
|
---|
[d5d39eb] | 172 | certificates can be used by <xref linkend='git'/>,
|
---|
| 173 | <xref linkend='curl'/> or <xref linkend='wget'/> when accessing secure
|
---|
| 174 | (https protocol) sites. To do this, follow the instructions from the
|
---|
| 175 | <xref linkend='cacerts'/> page.
|
---|
[0d7900a] | 176 | </para>
|
---|
[bbdb0d16] | 177 |
|
---|
| 178 | <para>
|
---|
| 179 | Users who just want to use <application>OpenSSL</application> for
|
---|
| 180 | providing functions to other programs such as
|
---|
| 181 | <application>OpenSSH</application> and web browsers do not need to worry
|
---|
[f586237] | 182 | about additional configuration. This is an advanced topic and those
|
---|
[bbdb0d16] | 183 | who do need it would normally be expected to either know how to properly
|
---|
| 184 | update <filename>/etc/ssl/openssl.cnf</filename> or be able to find out
|
---|
| 185 | how to do it.
|
---|
| 186 | </para>
|
---|
[4c39aff] | 187 |
|
---|
[5a5bbbf] | 188 | </sect3>
|
---|
[4c39aff] | 189 |
|
---|
[5a5bbbf] | 190 | </sect2>
|
---|
| 191 |
|
---|
| 192 | <sect2 role="content">
|
---|
| 193 | <title>Contents</title>
|
---|
| 194 |
|
---|
| 195 | <segmentedlist>
|
---|
| 196 | <segtitle>Installed Programs</segtitle>
|
---|
| 197 | <segtitle>Installed Libraries</segtitle>
|
---|
| 198 | <segtitle>Installed Directories</segtitle>
|
---|
| 199 |
|
---|
| 200 | <seglistitem>
|
---|
[bbdb0d16] | 201 | <seg>
|
---|
[4c39aff] | 202 | c_rehash and openssl
|
---|
[d5d39eb] | 203 | </seg>
|
---|
| 204 | <seg>
|
---|
[4de0151] | 205 | libcrypto.{so,a} and libssl.{so,a}
|
---|
[4c39aff] | 206 | </seg>
|
---|
| 207 | <seg>
|
---|
| 208 | /etc/ssl,
|
---|
| 209 | /usr/include/openssl,
|
---|
| 210 | /usr/lib/engines and
|
---|
| 211 | /usr/share/doc/openssl-&openssl-version;
|
---|
[bbdb0d16] | 212 | </seg>
|
---|
[5a5bbbf] | 213 | </seglistitem>
|
---|
| 214 | </segmentedlist>
|
---|
| 215 |
|
---|
| 216 | <variablelist>
|
---|
| 217 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 218 | <?dbfo list-presentation="list"?>
|
---|
| 219 | <?dbhtml list-presentation="table"?>
|
---|
| 220 |
|
---|
| 221 | <varlistentry id="c_rehash">
|
---|
| 222 | <term><command>c_rehash</command></term>
|
---|
| 223 | <listitem>
|
---|
[bbdb0d16] | 224 | <para>
|
---|
| 225 | is a <application>Perl</application> script that scans all files in
|
---|
| 226 | a directory and adds symbolic links to their hash values.
|
---|
| 227 | </para>
|
---|
[5a5bbbf] | 228 | <indexterm zone="openssl c_rehash">
|
---|
| 229 | <primary sortas="b-c_rehash">c_rehash</primary>
|
---|
| 230 | </indexterm>
|
---|
| 231 | </listitem>
|
---|
| 232 | </varlistentry>
|
---|
| 233 |
|
---|
| 234 | <varlistentry id="openssl-prog">
|
---|
| 235 | <term><command>openssl</command></term>
|
---|
| 236 | <listitem>
|
---|
[bbdb0d16] | 237 | <para>
|
---|
| 238 | is a command-line tool for using the various cryptography functions
|
---|
| 239 | of <application>OpenSSL</application>'s crypto library from the
|
---|
| 240 | shell. It can be used for various functions which are documented in
|
---|
| 241 | <command>man 1 openssl</command>.
|
---|
| 242 | </para>
|
---|
[5a5bbbf] | 243 | <indexterm zone="openssl openssl-prog">
|
---|
| 244 | <primary sortas="b-openssl">openssl</primary>
|
---|
| 245 | </indexterm>
|
---|
| 246 | </listitem>
|
---|
| 247 | </varlistentry>
|
---|
| 248 |
|
---|
| 249 | <varlistentry id="libcrypto">
|
---|
[4c39aff] | 250 | <term><filename class="libraryfile">libcrypto.{so,a}</filename></term>
|
---|
[5a5bbbf] | 251 | <listitem>
|
---|
[bbdb0d16] | 252 | <para>
|
---|
| 253 | implements a wide range of cryptographic algorithms used in various
|
---|
| 254 | Internet standards. The services provided by this library are used
|
---|
| 255 | by the <application>OpenSSL</application> implementations of SSL,
|
---|
| 256 | TLS and S/MIME, and they have also been used to implement
|
---|
| 257 | <application>OpenSSH</application>,
|
---|
| 258 | <application>OpenPGP</application>, and other cryptographic
|
---|
| 259 | standards.
|
---|
| 260 | </para>
|
---|
[5a5bbbf] | 261 | <indexterm zone="openssl libcrypto">
|
---|
[3597eb6] | 262 | <primary sortas="c-libcrypto">libcrypto.{so,a}</primary>
|
---|
[5a5bbbf] | 263 | </indexterm>
|
---|
| 264 | </listitem>
|
---|
| 265 | </varlistentry>
|
---|
| 266 |
|
---|
| 267 | <varlistentry id="libssl">
|
---|
[4c39aff] | 268 | <term><filename class="libraryfile">libssl.{so,a}</filename></term>
|
---|
[5a5bbbf] | 269 | <listitem>
|
---|
[bbdb0d16] | 270 | <para>
|
---|
[d78194f3] | 271 | implements the Transport Layer Security (TLS v1) protocol.
|
---|
| 272 | It provides a rich API, documentation
|
---|
[bbdb0d16] | 273 | on which can be found by running <command>man 3 ssl</command>.
|
---|
| 274 | </para>
|
---|
[5a5bbbf] | 275 | <indexterm zone="openssl libssl">
|
---|
[3597eb6] | 276 | <primary sortas="c-libssl">libssl.{so,a}</primary>
|
---|
[5a5bbbf] | 277 | </indexterm>
|
---|
| 278 | </listitem>
|
---|
| 279 | </varlistentry>
|
---|
[4c39aff] | 280 |
|
---|
[5a5bbbf] | 281 | </variablelist>
|
---|
[4c39aff] | 282 |
|
---|
[5a5bbbf] | 283 | </sect2>
|
---|
[4c39aff] | 284 |
|
---|
[f45b1953] | 285 | </sect1>
|
---|