[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 |
|
---|
[984a23f] | 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>
|
---|
[f45b1953] | 21 |
|
---|
[52d29f7] | 22 | <sect2>
|
---|
[5b5ecb9] | 23 | <title>Introduction to <application>Open<acronym>SSL</acronym></application>
|
---|
| 24 | </title>
|
---|
[396508b] | 25 |
|
---|
[5b5ecb9] | 26 | <para>The <application>Open<acronym>SSL</acronym></application> package contains
|
---|
| 27 | management tools and libraries relating to cryptography. These are useful for
|
---|
| 28 | providing cryptography functions to other packages, notably
|
---|
| 29 | <application>OpenSSH</application>, email applications and web browsers (for
|
---|
[e4cac96f] | 30 | accessing <acronym>HTTPS</acronym> sites).</para>
|
---|
[396508b] | 31 |
|
---|
[52d29f7] | 32 | <sect3><title>Package information</title>
|
---|
| 33 | <itemizedlist spacing='compact'>
|
---|
| 34 | <listitem><para>Download (HTTP): <ulink url="&openssl-download-http;"/></para></listitem>
|
---|
| 35 | <listitem><para>Download (FTP): <ulink url="&openssl-download-ftp;"/></para></listitem>
|
---|
| 36 | <listitem><para>Download size: &openssl-size;</para></listitem>
|
---|
[396508b] | 37 | <listitem><para>Estimated disk space required: &openssl-buildsize;</para></listitem>
|
---|
[52d29f7] | 38 | <listitem><para>Estimated build time: &openssl-time;</para></listitem></itemizedlist>
|
---|
| 39 | </sect3>
|
---|
[5b5ecb9] | 40 |
|
---|
| 41 | <sect3><title><application>Open<acronym>SSL</acronym></application>
|
---|
| 42 | dependencies</title>
|
---|
| 43 | <sect4><title>Optional</title>
|
---|
[da4aff6] | 44 | <para><xref linkend="bc"/> (recommended
|
---|
[5b5ecb9] | 45 | if you run the test suite during the build)</para></sect4>
|
---|
| 46 | </sect3>
|
---|
| 47 |
|
---|
[52d29f7] | 48 | </sect2>
|
---|
| 49 |
|
---|
| 50 | <sect2>
|
---|
[5b5ecb9] | 51 | <title>Installation of <application>Open<acronym>SSL</acronym></application>
|
---|
| 52 | </title>
|
---|
[396508b] | 53 |
|
---|
[5b5ecb9] | 54 | <para>Install <application>Open<acronym>SSL</acronym></application> by running
|
---|
| 55 | the following commands:</para>
|
---|
[52d29f7] | 56 |
|
---|
| 57 | <screen><userinput><command>sed 's/^passwd/openssl-passwd/' doc/apps/passwd.pod \
|
---|
| 58 | > doc/apps/openssl-passwd.pod &&
|
---|
| 59 | rm doc/apps/passwd.pod &&
|
---|
| 60 | mv doc/crypto/{,openssl_}threads.pod &&
|
---|
| 61 | ./config --openssldir=/etc/ssl --prefix=/usr shared &&
|
---|
[24a7f96] | 62 | sed -i 's%SHLIBDIRS= fips crypto ssl%SHLIBDIRS= crypto ssl%g' Makefile &&
|
---|
[52d29f7] | 63 | make MANDIR=/usr/share/man &&
|
---|
| 64 | make MANDIR=/usr/share/man install &&
|
---|
[e4cac96f] | 65 | cp -r certs /etc/ssl</command></userinput></screen>
|
---|
[396508b] | 66 |
|
---|
[52d29f7] | 67 | </sect2>
|
---|
| 68 |
|
---|
| 69 | <sect2>
|
---|
| 70 | <title>Command explanations</title>
|
---|
[396508b] | 71 |
|
---|
[52d29f7] | 72 | <para><option>no-rc5 no-idea</option>: When added to the
|
---|
| 73 | <command>./config</command> command, this will eliminate the building of those
|
---|
| 74 | encryption methods. Patent licenses may be needed for you to utilize either of
|
---|
| 75 | those methods in your projects.</para>
|
---|
[396508b] | 76 |
|
---|
[52d29f7] | 77 | <para><command>rm doc/apps/passwd.pod</command>: This command prevents
|
---|
| 78 | <application>Open<acronym>SSL</acronym></application> from installing its
|
---|
| 79 | passwd man page over an existing man page with the same name.</para>
|
---|
[396508b] | 80 |
|
---|
[52d29f7] | 81 | <para><command>mv doc/crypto/{,openssl_}threads.pod</command>: This
|
---|
| 82 | commands prevents <application>Open<acronym>SSL</acronym></application> from
|
---|
| 83 | overwriting an existing man page from <application>Perl</application>.</para>
|
---|
[24a7f96] | 84 |
|
---|
| 85 | <para><command>sed -i 's%SHLIBDIRS= fips crypto ssl%SHLIBDIRS= crypto ssl%g' Makefile</command>:
|
---|
| 86 | This command prevents installation of the non-existent <filename
|
---|
| 87 | class="libraryfile">libfips</filename> library.</para>
|
---|
[396508b] | 88 |
|
---|
[52d29f7] | 89 | <para><screen><command>make MANDIR=/usr/share/man
|
---|
| 90 | make MANDIR=/usr/share/man install</command></screen> These
|
---|
[5b5ecb9] | 91 | commands install <application>Open<acronym>SSL</acronym></application> with the
|
---|
| 92 | man pages in <filename class='directory'>/usr/share/man</filename> instead of
|
---|
| 93 | the default which is <filename class='directory'>/etc/ssl/man</filename>.</para>
|
---|
[396508b] | 94 |
|
---|
[5b5ecb9] | 95 | <para><command>cp -r certs /etc/ssl</command>: The certificates must be copied
|
---|
| 96 | manually since the install script skips this step.</para>
|
---|
[396508b] | 97 |
|
---|
[52d29f7] | 98 | </sect2>
|
---|
| 99 |
|
---|
| 100 | <sect2>
|
---|
| 101 | <title>Configuring <application>OpenSSL</application></title>
|
---|
[396508b] | 102 |
|
---|
[52d29f7] | 103 | <sect3><title>Config files</title>
|
---|
| 104 | <para><filename>/etc/ssl/openssl.cnf</filename></para>
|
---|
| 105 | </sect3>
|
---|
[396508b] | 106 |
|
---|
[52d29f7] | 107 | <sect3><title>Configuration Information</title>
|
---|
[396508b] | 108 |
|
---|
[5b5ecb9] | 109 | <para>Most people who just want to use
|
---|
| 110 | <application>Open<acronym>SSL</acronym></application> for providing functions
|
---|
| 111 | to other programs such as <application>Open<acronym>SSH</acronym></application>
|
---|
| 112 | and web browsers won't need to worry about configuring
|
---|
| 113 | <application>Open<acronym>SSL</acronym></application>. Configuring
|
---|
| 114 | <application>Open<acronym>SSL</acronym></application> is an advanced topic and
|
---|
[52d29f7] | 115 | so those who do would normally be expected to either know how to do it
|
---|
| 116 | or to be able to find out how to do it.</para>
|
---|
| 117 | </sect3>
|
---|
[396508b] | 118 |
|
---|
[52d29f7] | 119 | </sect2>
|
---|
| 120 |
|
---|
| 121 | <sect2>
|
---|
| 122 | <title>Contents</title>
|
---|
[396508b] | 123 |
|
---|
[5b5ecb9] | 124 | <para>The <application>Open<acronym>SSL</acronym></application> package
|
---|
| 125 | contains <command>c_rehash</command>, <command>openssl</command>,
|
---|
| 126 | <filename class='libraryfile'>libcrypto</filename> libraries and
|
---|
| 127 | <filename class='libraryfile'>libssl</filename> libraries.</para>
|
---|
[396508b] | 128 |
|
---|
[52d29f7] | 129 | </sect2>
|
---|
[396508b] | 130 |
|
---|
[52d29f7] | 131 | <sect2><title>Description</title>
|
---|
[396508b] | 132 |
|
---|
[52d29f7] | 133 | <sect3><title>c_rehash</title>
|
---|
[396508b] | 134 |
|
---|
[52d29f7] | 135 | <para><command>c_rehash</command> is a <application>Perl</application> script
|
---|
| 136 | that scans all files in a directory and adds symbolic links to their hash
|
---|
| 137 | values.</para>
|
---|
[396508b] | 138 |
|
---|
[52d29f7] | 139 | </sect3>
|
---|
| 140 |
|
---|
| 141 | <sect3><title>openssl</title>
|
---|
[396508b] | 142 |
|
---|
[52d29f7] | 143 | <para>The <command>openssl</command> program is a command-line tool for using
|
---|
| 144 | the various cryptography functions of
|
---|
| 145 | <application>Open<acronym>SSL</acronym></application>'s
|
---|
| 146 | crypto library from the shell. It can be used for various functions which are
|
---|
| 147 | documented in <command>man 1 openssl</command>.</para>
|
---|
[396508b] | 148 |
|
---|
[52d29f7] | 149 | </sect3>
|
---|
[396508b] | 150 |
|
---|
[52d29f7] | 151 | <sect3><title>libcrypto</title>
|
---|
[396508b] | 152 |
|
---|
[5b5ecb9] | 153 | <para>The <application>Open<acronym>SSL</acronym></application> crypto library
|
---|
| 154 | implements a wide range of cryptographic algorithms used in various Internet
|
---|
| 155 | standards. The services provided by this library are used by the
|
---|
| 156 | <application>Open<acronym>SSL</acronym></application> implementations of
|
---|
| 157 | <acronym>SSL</acronym>, <acronym>TLS</acronym> and <acronym>S/MIME</acronym>,
|
---|
| 158 | and they have also been used to implement
|
---|
| 159 | <application>Open<acronym>SSH</acronym></application>,
|
---|
| 160 | <application>Open<acronym>PGP</acronym></application>, and other cryptographic
|
---|
| 161 | standards.</para>
|
---|
[396508b] | 162 |
|
---|
[52d29f7] | 163 | </sect3>
|
---|
[396508b] | 164 |
|
---|
[52d29f7] | 165 | <sect3><title>libssl</title>
|
---|
[396508b] | 166 |
|
---|
[5b5ecb9] | 167 | <para>The <application>Open<acronym>SSL</acronym></application>
|
---|
| 168 | <acronym>SSL</acronym> library implements the Secure Sockets Layer
|
---|
| 169 | (<acronym>SSL</acronym> v2/v3) and Transport Layer Security
|
---|
| 170 | (<acronym>TLS</acronym> v1) protocols. It provides a rich
|
---|
| 171 | <acronym>API</acronym>, documentation on which can be found by running
|
---|
[52d29f7] | 172 | <command>man 3 ssl</command>.</para>
|
---|
[396508b] | 173 |
|
---|
[52d29f7] | 174 | </sect3>
|
---|
[396508b] | 175 |
|
---|
[52d29f7] | 176 | </sect2>
|
---|
[f45b1953] | 177 |
|
---|
| 178 | </sect1>
|
---|