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 nss-download-http "http://ftp.mozilla.org/pub/mozilla.org/security/nss/releases/NSS_3_11_RTM/src/nss-&nss-version;.tar.gz">
|
---|
8 | <!ENTITY nss-download-ftp "ftp://ftp.mozilla.org/pub/mozilla.org/security/nss/releases/NSS_3_11_RTM/src/nss-&nss-version;.tar.gz">
|
---|
9 | <!ENTITY nss-md5sum "9be73bd73e361e5e36edf77f456fa20a">
|
---|
10 | <!ENTITY nss-size "5.0 MB">
|
---|
11 | <!ENTITY nss-buildsize "67.6 MB">
|
---|
12 | <!ENTITY nss-time "1.0 SBU (additional 0.5 SBU to run the test suite)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="nss" xreflabel="NSS-&nss-version;">
|
---|
16 | <?dbhtml filename="nss.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | <keywordset>
|
---|
22 | <keyword role="package">nss-&nss-version;.tar</keyword>
|
---|
23 | <keyword role="ftpdir">nss</keyword>
|
---|
24 | </keywordset>
|
---|
25 | </sect1info>
|
---|
26 |
|
---|
27 | <title>NSS-&nss-version;</title>
|
---|
28 |
|
---|
29 | <indexterm zone="nss">
|
---|
30 | <primary sortas="a-NSS">NSS</primary>
|
---|
31 | </indexterm>
|
---|
32 |
|
---|
33 | <sect2 role="package">
|
---|
34 | <title>Introduction to NSS</title>
|
---|
35 |
|
---|
36 | <para>The Network Security Services (<application>NSS</application>)
|
---|
37 | package is a set of libraries designed to support cross-platform
|
---|
38 | development of security-enabled client and server applications.
|
---|
39 | Applications built with NSS can support SSL v2 and v3, TLS, PKCS #5,
|
---|
40 | PKCS #7, PKCS #11, PKCS #12, S/MIME, X.509 v3 certificates, and other
|
---|
41 | security standards. This is useful for implementing SSL and S/MIME or
|
---|
42 | other Internet security standards into an application.</para>
|
---|
43 |
|
---|
44 | <para>The <application>NSS</application> package requires the Netscape
|
---|
45 | Portable Runtime (NSPR) libraries as a prerequisite for building. The
|
---|
46 | <application>NSS</application> package tarball contains the code necessary
|
---|
47 | to build the NSPR libraries. These libraries are built and installed using
|
---|
48 | the instructions below. Essentially, the <application>NSS</application>
|
---|
49 | package is now a combined <application>NSS</application>/NSPR
|
---|
50 | installation.</para>
|
---|
51 |
|
---|
52 |
|
---|
53 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
54 | <itemizedlist spacing="compact">
|
---|
55 | <listitem>
|
---|
56 | <para>Download (HTTP): <ulink url="&nss-download-http;"/></para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>Download (FTP): <ulink url="&nss-download-ftp;"/></para>
|
---|
60 | </listitem>
|
---|
61 | <listitem>
|
---|
62 | <para>Download MD5 sum: &nss-md5sum;</para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>Download size: &nss-size;</para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>Estimated disk space required: &nss-buildsize;</para>
|
---|
69 | </listitem>
|
---|
70 | <listitem>
|
---|
71 | <para>Estimated build time: &nss-time;</para>
|
---|
72 | </listitem>
|
---|
73 | </itemizedlist>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
76 | <itemizedlist spacing="compact">
|
---|
77 | <listitem>
|
---|
78 | <para>Required patch: <ulink
|
---|
79 | url="&patch-root;/nss-&nss-version;-fedora_fixes-1.patch"/></para>
|
---|
80 | </listitem>
|
---|
81 | </itemizedlist>
|
---|
82 |
|
---|
83 | <!--
|
---|
84 | <bridgehead renderas="sect3">NSS Dependencies</bridgehead>
|
---|
85 |
|
---|
86 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
87 | <para role="required"><xref linkend=""/></para>
|
---|
88 |
|
---|
89 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
90 | <para role="optional"><ulink
|
---|
91 | url="http://www.some.url/">DEPENDENCY</ulink></para>
|
---|
92 | -->
|
---|
93 |
|
---|
94 | </sect2>
|
---|
95 |
|
---|
96 | <sect2 role="installation">
|
---|
97 | <title>Installation of NSS</title>
|
---|
98 |
|
---|
99 | <para>Install <application>NSS</application> by running the following
|
---|
100 | commands:</para>
|
---|
101 |
|
---|
102 | <screen><userinput>bash
|
---|
103 |
|
---|
104 | export WORKINGDIR=$PWD &&
|
---|
105 | export BUILD_OPT=1 &&
|
---|
106 |
|
---|
107 | patch -Np1 -i ../nss-&nss-version;-fedora_fixes-1.patch &&
|
---|
108 |
|
---|
109 | cd mozilla/security/nss &&
|
---|
110 | make nss_build_all &&
|
---|
111 | cd ../.. &&
|
---|
112 |
|
---|
113 | export NSS_LINUXDIR=$(basename `ls -d $WORKINGDIR/mozilla/dist/Linux*`)</userinput></screen>
|
---|
114 |
|
---|
115 | <para>To test the results, you'll need to set the domain name of your
|
---|
116 | system in the <envar>DOMSUF</envar> environment variable. Most of the tests
|
---|
117 | will fail if you don't provide the correct domain name. A self-generated
|
---|
118 | log file will be parsed at the end of the test to display how many tests
|
---|
119 | passed. It should return 770. To run the tests, ensure you change the
|
---|
120 | <command>export DOMSUF</command> command below to an appropriate value,
|
---|
121 | e.g., <parameter>mydomain.com</parameter> and issue the following
|
---|
122 | commands:</para>
|
---|
123 |
|
---|
124 | <screen><userinput>bash
|
---|
125 |
|
---|
126 | export DOMSUF=<replaceable>[validdomain.name]</replaceable> &&
|
---|
127 | export PATH=$PATH:$WORKINGDIR/mozilla/dist/$NSS_LINUXDIR/bin &&
|
---|
128 | export TEST_RESULTSDIR=$WORKINGDIR/mozilla/tests_results/security &&
|
---|
129 |
|
---|
130 | cd security/nss/tests &&
|
---|
131 | sed -i 's/gmake/make/' common/init.sh &&
|
---|
132 | ./all.sh &&
|
---|
133 |
|
---|
134 | grep Passed $TEST_RESULTSDIR/$(hostname).1/results.html | wc -l &&
|
---|
135 |
|
---|
136 | exit</userinput></screen>
|
---|
137 |
|
---|
138 | <caution>
|
---|
139 | <para>If you switch to the <systemitem class="username">root</systemitem>
|
---|
140 | user using a method that does not inherit the environment from the
|
---|
141 | unprivileged user, ensure that
|
---|
142 | <systemitem class="username">root</systemitem>'s
|
---|
143 | <envar>NSS_LINUXDIR</envar> environment variable is set correctly before
|
---|
144 | proceeding with the installation commands.</para>
|
---|
145 | </caution>
|
---|
146 |
|
---|
147 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
148 |
|
---|
149 | <screen role="root"><userinput>install -v -m755 nsprpub/$NSS_LINUXDIR/config/nspr-config \
|
---|
150 | security/nss/cmd/config/nss-config \
|
---|
151 | /usr/bin &&
|
---|
152 | install -v -m755 -d /usr/lib/pkgconfig &&
|
---|
153 | install -v -m644 nsprpub/lib/pkgconfig/nspr.pc \
|
---|
154 | security/nss/lib/pkgconfig/nss.pc \
|
---|
155 | /usr/lib/pkgconfig &&
|
---|
156 |
|
---|
157 | cd dist &&
|
---|
158 |
|
---|
159 | install -v -m755 $NSS_LINUXDIR/lib/*.so /usr/lib &&
|
---|
160 | install -v -m644 $NSS_LINUXDIR/lib/{*.chk,libcrmf.a} /usr/lib &&
|
---|
161 |
|
---|
162 | install -v -m755 -d /usr/include/{nss,nspr} &&
|
---|
163 | install -v -m644 {public,private}/nss/* /usr/include/nss &&
|
---|
164 | cp -v -RL $NSS_LINUXDIR/include/* /usr/include/nspr &&
|
---|
165 | chmod -v 644 /usr/include/nspr/prvrsion.h</userinput></screen>
|
---|
166 |
|
---|
167 | <para>Now as the unprivileged user, exit the <command>bash</command>
|
---|
168 | shell started at the beginning of the installation to restore the
|
---|
169 | environment to the original state.</para>
|
---|
170 |
|
---|
171 | <screen><userinput>exit</userinput></screen>
|
---|
172 |
|
---|
173 | </sect2>
|
---|
174 |
|
---|
175 | <sect2 role="commands">
|
---|
176 | <title>Command Explanations</title>
|
---|
177 |
|
---|
178 | <para><command>bash</command>: Shells are started as many environment
|
---|
179 | variables are created during the installation process. Exiting the shells
|
---|
180 | serves the purpose of restoring the environment and returning back to the
|
---|
181 | original directory when the installation is complete.</para>
|
---|
182 |
|
---|
183 | <para><command>export WORKINGDIR=$PWD</command>: This variable is set
|
---|
184 | because many of the commands are dependent on knowing the full path of
|
---|
185 | certain directories. <envar>WORKINGDIR</envar> establishes a known path
|
---|
186 | so that all others can be determined relative to this.</para>
|
---|
187 |
|
---|
188 | <para><command>export BUILD_OPT=1</command>: This variable is set so that
|
---|
189 | the build is performed with no debugging symbols built into the binaries
|
---|
190 | and that the default compiler optimizations are used.</para>
|
---|
191 |
|
---|
192 | <para><command>export NSS_LINUXDIR=...</command>: This variable is set so
|
---|
193 | that the exact name of the architecture specific directories where the
|
---|
194 | binaries are stored in the source tree can be determined.</para>
|
---|
195 |
|
---|
196 | <para><command>make nss_build_all</command>: This command builds the NSPR
|
---|
197 | and <application>NSS</application> libraries and creates a
|
---|
198 | <filename class='directory'>dist</filename> directory which houses all the
|
---|
199 | programs, libraries and interface headers. None of the programs created by
|
---|
200 | this process are installed onto the system using the default instructions.
|
---|
201 | If you need any of these programs installed, you can find them in the
|
---|
202 | <filename class='directory'>mozilla/dist/bin</filename> directory of the
|
---|
203 | source tree.</para>
|
---|
204 |
|
---|
205 | <para><command>export PATH=...</command>: This command sets the
|
---|
206 | <envar>PATH</envar> environment variable to include the executables in
|
---|
207 | the source tree as some of them are required to run the test suite.</para>
|
---|
208 |
|
---|
209 | <para><command>sed -i 's/gmake/make/' common/init.sh</command>: This
|
---|
210 | command changes the command used to compile some test programs.</para>
|
---|
211 |
|
---|
212 | </sect2>
|
---|
213 |
|
---|
214 | <sect2 role="content">
|
---|
215 | <title>Contents</title>
|
---|
216 |
|
---|
217 | <segmentedlist>
|
---|
218 | <segtitle>Installed Programs</segtitle>
|
---|
219 | <segtitle>Installed Libraries</segtitle>
|
---|
220 | <segtitle>Installed Directories</segtitle>
|
---|
221 |
|
---|
222 | <seglistitem>
|
---|
223 | <seg>nspr-config and nss-config</seg>
|
---|
224 | <seg>libcrmf.a, libfreebl3.so, libnspr4.so, libnss3.so, libnssckbi.so,
|
---|
225 | libplc4.so, libplds4.so, libsmime3.so, libsoftokn3.so and
|
---|
226 | libssl3.so</seg>
|
---|
227 | <seg>/usr/include/nspr and /usr/include/nss</seg>
|
---|
228 | </seglistitem>
|
---|
229 | </segmentedlist>
|
---|
230 |
|
---|
231 | <variablelist>
|
---|
232 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
233 | <?dbfo list-presentation="list"?>
|
---|
234 | <?dbhtml list-presentation="table"?>
|
---|
235 |
|
---|
236 | <varlistentry id="nspr-config">
|
---|
237 | <term><command>nspr-config</command></term>
|
---|
238 | <listitem>
|
---|
239 | <para>is used to determine the NSPR installation settings
|
---|
240 | of the installed NSPR libraries.</para>
|
---|
241 | <indexterm zone="nss nspr-config">
|
---|
242 | <primary sortas="b-nspr-config">nspr-config</primary>
|
---|
243 | </indexterm>
|
---|
244 | </listitem>
|
---|
245 | </varlistentry>
|
---|
246 |
|
---|
247 | <varlistentry id="nss-config">
|
---|
248 | <term><command>nss-config</command></term>
|
---|
249 | <listitem>
|
---|
250 | <para>is used to determine the NSS library settings
|
---|
251 | of the installed NSS libraries.</para>
|
---|
252 | <indexterm zone="nss nss-config">
|
---|
253 | <primary sortas="b-nss-config">nss-config</primary>
|
---|
254 | </indexterm>
|
---|
255 | </listitem>
|
---|
256 | </varlistentry>
|
---|
257 | </variablelist>
|
---|
258 |
|
---|
259 | <para>The <filename class='libraryfile'>libnspr4.so</filename>,
|
---|
260 | <filename class='libraryfile'>libplc4.so</filename> and
|
---|
261 | <filename class='libraryfile'>libplds4.so</filename> libraries make up the
|
---|
262 | Netscape Portable Runtime (NSPR) libraries. These libraries provide a
|
---|
263 | platform-neutral API for system level and libc like functions. The API
|
---|
264 | is used in the Mozilla client, many of the Netscape/AOL/iPlanet offerings
|
---|
265 | and other software applications.</para>
|
---|
266 |
|
---|
267 | <para>The <filename class='libraryfile'>libcrmf.a</filename>,
|
---|
268 | <filename class='libraryfile'>libfreebl.so</filename>,
|
---|
269 | <filename class='libraryfile'>libnss3.so</filename>,
|
---|
270 | <filename class='libraryfile'>libnssckbi.so</filename>,
|
---|
271 | <filename class='libraryfile'>libsmime3.so</filename>,
|
---|
272 | <filename class='libraryfile'>libsoftokn3.so</filename> and
|
---|
273 | <filename class='libraryfile'>libnssl3.so</filename> libraries make up
|
---|
274 | the <application>NSS</application> libraries.</para>
|
---|
275 |
|
---|
276 | </sect2>
|
---|
277 |
|
---|
278 | </sect1>
|
---|