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