source: postlfs/security/openssl.xml@ 17fb537e

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY openssl-download-http "http://www.openssl.org/source/openssl-&openssl-version;.tar.gz">
<!ENTITY openssl-download-ftp "ftp://ftp.openssl.org/source/openssl-&openssl-version;.tar.gz">
<!ENTITY openssl-size "3.0 MB">
<!ENTITY openssl-buildsize "35 MB">
<!ENTITY openssl-time "1.16 SBU">
]>

<sect1 id="openssl" xreflabel="OpenSSL-&openssl-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="openssl.html"?>
<title>OpenSSL-&openssl-version;</title>
<indexterm zone="openssl">
<primary sortas="a-OpenSSL">OpenSSL</primary></indexterm>

<sect2>
<title>Introduction to <application>Open<acronym>SSL</acronym></application>
</title>

<para>The <application>Open<acronym>SSL</acronym></application> package 
contains management tools and libraries relating to cryptography.  These are 
useful for providing cryptography functions to other packages, notably 
<application>OpenSSH</application>, email applications and web browsers (for 
accessing <acronym>HTTPS</acronym> sites).</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): 
<ulink url="&openssl-download-http;"/></para></listitem>
<listitem><para>Download (FTP): 
<ulink url="&openssl-download-ftp;"/></para></listitem>
<listitem><para>Download size: &openssl-size;</para></listitem>
<listitem><para>Estimated disk space required: 
&openssl-buildsize;</para></listitem>
<listitem><para>Estimated build time: 
&openssl-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title><application>Open<acronym>SSL</acronym></application> 
dependencies</title>
<sect4><title>Optional</title>
<para><xref linkend="bc"/> (recommended
if you run the test suite during the build)</para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Open<acronym>SSL</acronym></application>
</title>

<para>Install <application>Open<acronym>SSL</acronym></application> by running 
the following commands:</para>

<screen><userinput><command>sed 's/^passwd/openssl-passwd/' doc/apps/passwd.pod \
    > doc/apps/openssl-passwd.pod &amp;&amp;
rm doc/apps/passwd.pod &amp;&amp;
mv doc/crypto/{,openssl_}threads.pod &amp;&amp;
./config --openssldir=/etc/ssl --prefix=/usr shared &amp;&amp;
sed -i 's%SHLIBDIRS= fips crypto ssl%SHLIBDIRS= crypto ssl%g' Makefile &amp;&amp;
make MANDIR=/usr/share/man</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make MANDIR=/usr/share/man install &amp;&amp;
cp -r certs /etc/ssl</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><option>no-rc5 no-idea</option>: When added to the
<command>./config</command> command, this will eliminate the building of those
encryption methods. Patent licenses may be needed for you to utilize either of
those methods in your projects.</para>

<para><command>rm doc/apps/passwd.pod</command>: This command prevents
<application>Open<acronym>SSL</acronym></application> from installing its
passwd man page over an existing man page with the same name.</para>

<para><command>mv doc/crypto/{,openssl_}threads.pod</command>: This
commands prevents <application>Open<acronym>SSL</acronym></application> from
overwriting an existing man page from <application>Perl</application>.</para>

<para><command>sed -i 's%SHLIBDIRS= fips crypto ssl%SHLIBDIRS= crypto ssl%g' 
Makefile</command>: This command prevents installation of the non-existent 
<filename class="libraryfile">libfips</filename> library.</para>

<para><command>make MANDIR=/usr/share/man; make MANDIR=/usr/share/man 
install</command>: These commands install 
<application>Open<acronym>SSL</acronym></application> with the man pages in 
<filename class='directory'>/usr/share/man</filename> instead of 
<filename class='directory'>/etc/ssl/man</filename>.</para>

<para><command>cp -r certs /etc/ssl</command>: The certificates must be copied 
manually since the install script skips this step.</para>

</sect2>

<sect2>
<title>Configuring <application>OpenSSL</application></title>

<sect3 id="openssl-config"><title>Config files</title>
<para><filename>/etc/ssl/openssl.cnf</filename></para>
<indexterm zone="openssl openssl-config">
<primary sortas="e-etc-ssl-openssl.cnf">/etc/ssl/openssl.cnf</primary>
</indexterm>
</sect3>

<sect3><title>Configuration Information</title>

<para>Most people who just want to use 
<application>Open<acronym>SSL</acronym></application> for providing functions
to other programs such as <application>Open<acronym>SSH</acronym></application> 
and web browsers won't need to worry about configuring 
<application>Open<acronym>SSL</acronym></application>. Configuring
<application>Open<acronym>SSL</acronym></application> is an advanced topic and 
so those who do would normally be expected to either know how to do it
or to be able to find out how to do it.</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>c_rehash and openssl</seg>
<seg>libcrypto.[so,a] and libssl.[so,a]</seg>
<seg>/etc/ssl and /usr/include/ssl</seg>
</seglistitem>
</segmentedlist>

<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>

<varlistentry id="c_rehash">
<term><command>c_rehash</command></term>
<listitem><para>is a <application>Perl</application> script that scans all 
files in a directory and adds symbolic links to their hash values.</para>
<indexterm zone="openssl c_rehash">
<primary sortas="b-c_rehash">c_rehash</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="openssl-prog">
<term><command>openssl</command></term>
<listitem><para>is a command-line tool for using the various cryptography 
functions of <application>Open<acronym>SSL</acronym></application>'s crypto 
library from the shell. It can be used for various functions which are 
documented in <command>man 1 openssl</command>.</para>
<indexterm zone="openssl openssl-prog">
<primary sortas="b-openssl">openssl</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="libcrypto">
<term><filename class='libraryfile'>libcrypto</filename></term>
<listitem><para>implements a wide range of cryptographic algorithms used in 
various Internet standards. The services provided by  this library are used by 
the <application>Open<acronym>SSL</acronym></application> implementations of 
<acronym>SSL</acronym>, <acronym>TLS</acronym> and <acronym>S/MIME</acronym>, 
and they have also been used to implement 
<application>Open<acronym>SSH</acronym></application>, 
<application>Open<acronym>PGP</acronym></application>, and other cryptographic 
standards.</para>
<indexterm zone="openssl libcrypto">
<primary sortas="c-libcrypto">libcrypto.[so,a]</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="libssl">
<term><filename class='libraryfile'>libssl</filename></term>
<listitem><para>implements the Secure Sockets Layer (<acronym>SSL</acronym> 
v2/v3) and Transport Layer Security (<acronym>TLS</acronym> v1) protocols. It 
provides a rich <acronym>API</acronym>, documentation on which can be found by 
running <command>man 3 ssl</command>.</para>
<indexterm zone="openssl libssl">
<primary sortas="c-libssl">libssl.[so,a]</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>