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