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