chapter06/openssl.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-openssl" role="wrap">
   9   <?dbhtml filename="openssl.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>openssl</productname>
  13     <productnumber>&openssl-version;</productnumber>
  14     <address>&openssl-url;</address>
  15   </sect1info>
  16
  17   <title>OpenSSL-&openssl-version;</title>
  18
  19   <indexterm zone="ch-system-openssl">
  20     <primary sortas="a-OpenSSL">OpenSSL</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The OpenSSL package contains  management tools and libraries relating
  27     to cryptography. These are useful for providing cryptographic functions
  28     to other packages, such as OpenSSH, email applications and web browsers
  29     (for accessing HTTPS sites).  </para>
  30
  31     <segmentedlist>
  32       <segtitle>&buildtime;</segtitle>
  33       <segtitle>&diskspace;</segtitle>
  34
  35       <seglistitem>
  36         <seg>&openssl-ch6-sbu;</seg>
  37         <seg>&openssl-ch6-du;</seg>
  38       </seglistitem>
  39     </segmentedlist>
  40
  41   </sect2>
  42
  43   <sect2 role="installation">
  44     <title>Installation of OpenSSL</title>
  45
  46     <para>Prepare OpenSSL for compilation:</para>
  47
  48 <screen><userinput remap="configure">./config --prefix=/usr         \
  49          --openssldir=/etc/ssl \
  50          --libdir=lib          \
  51          shared                \
  52          zlib-dynamic</userinput></screen>
  53
  54     <para>Compile the package:</para>
  55
  56 <screen><userinput remap="make">make</userinput></screen>
  57
  58     <para>To test the results, issue:</para>
  59
  60 <screen><userinput remap="test">make test</userinput></screen>
  61 <!--
  62     <para>One subtest in the test 40-test_rehash.t fails in the lfs chroot
  63     environment, but passes when run as a regular user.</para>
  64 -->
  65     <para>Install the package:</para>
  66
  67 <screen><userinput remap="install">sed -i '/INSTALL_LIBS/s/libcrypto.a libssl.a//' Makefile
  68 make MANSUFFIX=ssl install</userinput></screen>
  69
  70     <para>If desired, install the documentation:</para>
  71
  72 <screen><userinput remap="install">mv -v /usr/share/doc/openssl /usr/share/doc/openssl-&openssl-version;
  73 cp -vfr doc/* /usr/share/doc/openssl-&openssl-version;</userinput></screen>
  74
  75   </sect2>
  76
  77   <sect2 id="contents-openssl" role="content">
  78     <title>Contents of OpenSSL</title>
  79
  80     <segmentedlist>
  81       <segtitle>Installed programs</segtitle>
  82       <segtitle>Installed libraries</segtitle>
  83       <segtitle>Installed directories</segtitle>
  84
  85       <seglistitem>
  86         <seg>
  87           c_rehash and openssl
  88         </seg>
  89         <seg>
  90           libcrypto.{so,a} and libssl.{so,a}
  91         </seg>
  92         <seg>
  93           /etc/ssl,
  94           /usr/include/openssl,
  95           /usr/lib/engines and
  96           /usr/share/doc/openssl-&openssl-version;
  97         </seg>
  98       </seglistitem>
  99     </segmentedlist>
 100
 101     <variablelist>
 102       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 103       <?dbfo list-presentation="list"?>
 104       <?dbhtml list-presentation="table"?>
 105
 106       <varlistentry id="c_rehash">
 107         <term><command>c_rehash</command></term>
 108         <listitem>
 109           <para>
 110             is a <application>Perl</application> script that scans all files in
 111             a directory and adds symbolic links to their hash values.
 112           </para>
 113           <indexterm zone="ch-system-openssl c_rehash">
 114             <primary sortas="b-c_rehash">c_rehash</primary>
 115           </indexterm>
 116         </listitem>
 117       </varlistentry>
 118
 119       <varlistentry id="openssl-prog">
 120         <term><command>openssl</command></term>
 121         <listitem>
 122           <para>
 123             is a command-line tool for using the various cryptography functions
 124             of <application>OpenSSL</application>'s crypto library from the
 125             shell. It can be used for various functions which are documented in
 126             <command>man 1 openssl</command>.
 127           </para>
 128           <indexterm zone="ch-system-openssl openssl-prog">
 129             <primary sortas="b-openssl">openssl</primary>
 130           </indexterm>
 131         </listitem>
 132       </varlistentry>
 133
 134       <varlistentry id="libcrypto">
 135         <term><filename class="libraryfile">libcrypto.so</filename></term>
 136         <listitem>
 137           <para>
 138             implements a wide range of cryptographic algorithms used in various
 139             Internet standards. The services provided by  this library are used
 140             by the <application>OpenSSL</application> implementations of SSL,
 141             TLS and S/MIME, and they have also been used to implement
 142             <application>OpenSSH</application>,
 143             <application>OpenPGP</application>, and other cryptographic
 144             standards.
 145           </para>
 146           <indexterm zone="ch-system-openssl libcrypto">
 147             <primary sortas="c-libcrypto">libcrypto.so</primary>
 148           </indexterm>
 149         </listitem>
 150       </varlistentry>
 151
 152       <varlistentry id="libssl">
 153         <term><filename class="libraryfile">libssl.so</filename></term>
 154         <listitem>
 155           <para>
 156             implements the Transport Layer Security (TLS v1) protocol.
 157             It provides a rich API, documentation
 158             on which can be found by running <command>man 3 ssl</command>.
 159           </para>
 160           <indexterm zone="ch-system-openssl libssl">
 161             <primary sortas="c-libssl">libssl.so</primary>
 162           </indexterm>
 163         </listitem>
 164       </varlistentry>
 165
 166     </variablelist>
 167
 168   </sect2>
 169
 170 </sect1>