[52d29f7] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[52d29f7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[5a5bbbf] | 7 | <!ENTITY openssl-download-http "http://www.openssl.org/source/openssl-&openssl-version;.tar.gz">
|
---|
| 8 | <!ENTITY openssl-download-ftp "ftp://ftp.openssl.org/source/openssl-&openssl-version;.tar.gz">
|
---|
[3b5e12a] | 9 | <!ENTITY openssl-md5sum "991615f73338a571b6a1be7d74906934">
|
---|
[5a5bbbf] | 10 | <!ENTITY openssl-size "3.0 MB">
|
---|
| 11 | <!ENTITY openssl-buildsize "35 MB">
|
---|
[3b5e12a] | 12 | <!ENTITY openssl-time "0.9 SBU">
|
---|
[52d29f7] | 13 | ]>
|
---|
| 14 |
|
---|
[cef3a2f] | 15 | <sect1 id="openssl" xreflabel="OpenSSL-&openssl-version;">
|
---|
[5a5bbbf] | 16 | <?dbhtml filename="openssl.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>OpenSSL-&openssl-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="openssl">
|
---|
| 26 | <primary sortas="a-OpenSSL">OpenSSL</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to OpenSSL</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>OpenSSL</application> package contains management
|
---|
| 33 | tools and libraries relating to cryptography. These are useful for
|
---|
| 34 | providing cryptography functions to other packages, notably
|
---|
| 35 | <application>OpenSSH</application>, email applications and web browsers
|
---|
| 36 | (for accessing HTTPS sites).</para>
|
---|
| 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>Download (HTTP): <ulink url="&openssl-download-http;"/></para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download (FTP): <ulink url="&openssl-download-ftp;"/></para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download MD5 sum: &openssl-md5sum;</para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download size: &openssl-size;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Estimated disk space required: &openssl-buildsize;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Estimated build time: &openssl-time;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | </itemizedlist>
|
---|
| 59 |
|
---|
| 60 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 61 | <itemizedlist spacing='compact'>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>Required patch: <ulink
|
---|
| 64 | url="&patch-root;/openssl-&openssl-version;-fix_manpages-1.patch"/></para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
[3b5e12a] | 68 | <itemizedlist spacing='compact'>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>Required patch: <ulink
|
---|
| 71 | url="&patch-root;/openssl-&openssl-version;-arc4random-1.patch"/></para>
|
---|
| 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
| 74 |
|
---|
[5a5bbbf] | 75 | <bridgehead renderas="sect3">OpenSSL Dependencies</bridgehead>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 78 | <para><xref linkend="bc"/> (recommended
|
---|
| 79 | if you run the test suite during the build)</para>
|
---|
| 80 |
|
---|
| 81 | </sect2>
|
---|
| 82 |
|
---|
| 83 | <sect2 role="installation">
|
---|
| 84 | <title>Installation of OpenSSL</title>
|
---|
| 85 |
|
---|
| 86 | <para>Install <application>OpenSSL</application> by running
|
---|
| 87 | the following commands:</para>
|
---|
| 88 |
|
---|
| 89 | <screen><userinput>patch -Np1 -i ../openssl-&openssl-version;-fix_manpages-1.patch &&
|
---|
[3b5e12a] | 90 | patch -Np1 -i ../openssl-&openssl-version;-arc4random-1.patch &&
|
---|
[52d29f7] | 91 | ./config --openssldir=/etc/ssl --prefix=/usr shared &&
|
---|
[5a5bbbf] | 92 | make MANDIR=/usr/share/man</userinput></screen>
|
---|
| 93 |
|
---|
| 94 | <para>To test the results, issue: <command>make test</command>.</para>
|
---|
| 95 |
|
---|
| 96 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 97 |
|
---|
| 98 | <screen role="root"><userinput>make MANDIR=/usr/share/man install &&
|
---|
| 99 | cp -v -r certs /etc/ssl</userinput></screen>
|
---|
| 100 |
|
---|
| 101 | </sect2>
|
---|
| 102 |
|
---|
| 103 | <sect2 role="commands">
|
---|
| 104 | <title>Command Explanations</title>
|
---|
| 105 |
|
---|
| 106 | <para><option>no-rc5 no-idea</option>: When added to the
|
---|
| 107 | <command>./config</command> command, this will eliminate the building
|
---|
| 108 | of those encryption methods. Patent licenses may be needed for you to
|
---|
| 109 | utilize either of those methods in your projects.</para>
|
---|
| 110 |
|
---|
| 111 | <para><command>make MANDIR=/usr/share/man; make MANDIR=/usr/share/man
|
---|
| 112 | install</command>: These commands install
|
---|
| 113 | <application>OpenSSL</application> with the man pages in
|
---|
| 114 | <filename class='directory'>/usr/share/man</filename> instead of
|
---|
| 115 | <filename class='directory'>/etc/ssl/man</filename>.</para>
|
---|
| 116 |
|
---|
| 117 | <para><command>cp -v -r certs /etc/ssl</command>: The certificates must
|
---|
| 118 | be copied manually since the install script skips this step.</para>
|
---|
| 119 |
|
---|
| 120 | </sect2>
|
---|
| 121 |
|
---|
| 122 | <sect2 role="configuration">
|
---|
| 123 | <title>Configuring OpenSSL</title>
|
---|
| 124 |
|
---|
| 125 | <sect3 id="openssl-config">
|
---|
| 126 | <title>Config Files</title>
|
---|
| 127 |
|
---|
| 128 | <para><filename>/etc/ssl/openssl.cnf</filename></para>
|
---|
| 129 |
|
---|
| 130 | <indexterm zone="openssl openssl-config">
|
---|
| 131 | <primary sortas="e-etc-ssl-openssl.cnf">/etc/ssl/openssl.cnf</primary>
|
---|
| 132 | </indexterm>
|
---|
| 133 |
|
---|
| 134 | </sect3>
|
---|
| 135 |
|
---|
| 136 | <sect3>
|
---|
| 137 | <title>Configuration Information</title>
|
---|
| 138 |
|
---|
| 139 | <para>Most people who just want to use <application>OpenSSL</application>
|
---|
| 140 | for providing functions to other programs such as
|
---|
| 141 | <application>OpenSSH</application> and web browsers won't need to worry
|
---|
| 142 | about configuring <application>OpenSSL</application>. Configuring
|
---|
| 143 | <application>OpenSSL</application> is an advanced topic and so those
|
---|
| 144 | who do would normally be expected to either know how to do it or to be
|
---|
| 145 | able to find out how to do it.</para>
|
---|
| 146 |
|
---|
| 147 | </sect3>
|
---|
| 148 |
|
---|
| 149 | </sect2>
|
---|
| 150 |
|
---|
| 151 | <sect2 role="content">
|
---|
| 152 | <title>Contents</title>
|
---|
| 153 |
|
---|
| 154 | <segmentedlist>
|
---|
| 155 | <segtitle>Installed Programs</segtitle>
|
---|
| 156 | <segtitle>Installed Libraries</segtitle>
|
---|
| 157 | <segtitle>Installed Directories</segtitle>
|
---|
| 158 |
|
---|
| 159 | <seglistitem>
|
---|
| 160 | <seg>c_rehash, openssl, and openssl_fips_fingerprint</seg>
|
---|
| 161 | <seg>libcrypto.[so,a] and libssl.[so,a]</seg>
|
---|
| 162 | <seg>/etc/ssl and /usr/include/ssl</seg>
|
---|
| 163 | </seglistitem>
|
---|
| 164 | </segmentedlist>
|
---|
| 165 |
|
---|
| 166 | <variablelist>
|
---|
| 167 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 168 | <?dbfo list-presentation="list"?>
|
---|
| 169 | <?dbhtml list-presentation="table"?>
|
---|
| 170 |
|
---|
| 171 | <varlistentry id="c_rehash">
|
---|
| 172 | <term><command>c_rehash</command></term>
|
---|
| 173 | <listitem>
|
---|
| 174 | <para>is a <application>Perl</application> script that scans
|
---|
| 175 | all files in a directory and adds symbolic links to their hash
|
---|
| 176 | values.</para>
|
---|
| 177 | <indexterm zone="openssl c_rehash">
|
---|
| 178 | <primary sortas="b-c_rehash">c_rehash</primary>
|
---|
| 179 | </indexterm>
|
---|
| 180 | </listitem>
|
---|
| 181 | </varlistentry>
|
---|
| 182 |
|
---|
| 183 | <varlistentry id="openssl-prog">
|
---|
| 184 | <term><command>openssl</command></term>
|
---|
| 185 | <listitem>
|
---|
| 186 | <para>is a command-line tool for using the various cryptography
|
---|
| 187 | functions of <application>OpenSSL</application>'s crypto
|
---|
| 188 | library from the shell. It can be used for various functions which are
|
---|
| 189 | documented in <command>man 1 openssl</command>.</para>
|
---|
| 190 | <indexterm zone="openssl openssl-prog">
|
---|
| 191 | <primary sortas="b-openssl">openssl</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
| 196 | <varlistentry id="libcrypto">
|
---|
| 197 | <term><filename class='libraryfile'>libcrypto.[so,a]</filename></term>
|
---|
| 198 | <listitem>
|
---|
| 199 | <para>implements a wide range of cryptographic algorithms used in
|
---|
| 200 | various Internet standards. The services provided by this library
|
---|
| 201 | are used by the <application>OpenSSL</application> implementations of
|
---|
| 202 | SSL, TLS and S/MIME, and they have also been used to implement
|
---|
| 203 | <application>OpenSSH</application>, <application>OpenPGP</application>,
|
---|
| 204 | and other cryptographic standards.</para>
|
---|
| 205 | <indexterm zone="openssl libcrypto">
|
---|
| 206 | <primary sortas="c-libcrypto">libcrypto.[so,a]</primary>
|
---|
| 207 | </indexterm>
|
---|
| 208 | </listitem>
|
---|
| 209 | </varlistentry>
|
---|
| 210 |
|
---|
| 211 | <varlistentry id="libssl">
|
---|
| 212 | <term><filename class='libraryfile'>libssl.[so,a]</filename></term>
|
---|
| 213 | <listitem>
|
---|
| 214 | <para>implements the Secure Sockets Layer (SSL v2/v3) and Transport
|
---|
| 215 | Layer Security (TLS v1) protocols. It provides a rich API, documentation
|
---|
| 216 | on which can be found by running <command>man 3 ssl</command>.</para>
|
---|
| 217 | <indexterm zone="openssl libssl">
|
---|
| 218 | <primary sortas="c-libssl">libssl.[so,a]</primary>
|
---|
| 219 | </indexterm>
|
---|
| 220 | </listitem>
|
---|
| 221 | </varlistentry>
|
---|
| 222 |
|
---|
| 223 | </variablelist>
|
---|
| 224 |
|
---|
| 225 | </sect2>
|
---|
[f45b1953] | 226 |
|
---|
| 227 | </sect1>
|
---|