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