.\" A man page for nss_pcache
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
.\" You may obtain a copy of the License at
.\"
.\"      http://www.apache.org/licenses/LICENSE-2.0
.\"
.\" Unless required by applicable law or agreed to in writing, software
.\" distributed under the License is distributed on an "AS IS" BASIS,
.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.\" Author: Rob Crittenden <rcritten@redhat.com>
.\"
.TH "nss_pcache" "8" "Jul 1 2013" "Rob Crittenden" ""
.SH "NAME"
nss_pcache \- Helper program used to store token password pins

.SH "SYNOPSIS"
nss_pcache <semid> <fips on/off> <directory> [prefix]

.SH "DESCRIPTION"
A helper program used by the Apache \fBhttpd\fP mod_nss plug-in to store the NSS PKCS #11 token password pins between restarts of Apache.
.PP
Whenever an Apache \fBhttpd\fP process configured to use the mod_nss plug-in is started, this program will be automatically invoked via reference to the mod_nss configuration file stored under \fB/etc/httpd/conf.d/nss.conf\fP which contains the following default entry:
.IP
#   Pass Phrase Helper:
.br
#   This helper program stores the token password pins between
.br
#   restarts of Apache.
.br
#
.br
#   NOTE:  Located at '/usr/sbin/nss_pcache' prior
.br
#          to 'mod_nss-1.0.8-22'.
.br
#
.br
NSSPassPhraseHelper /usr/libexec/nss_pcache

.SH OPTIONS
.TP
.B <semid>
The semaphore which corresponds to the mod_nss plug-in registered with the Apache \fBhttpd\fP process during startup.
.TP
.B <fips on/off>
Specifies whether FIPS mode should be enabled, \fBon\fP, or disabled, \fBoff\fP.  By default, FIPS mode is disabled, and no variable is specified in \fB/etc/httpd/conf.d/nss.conf\fP.  To enable FIPS mode, establish password access for the specified NSS security databases, and specify the following variable in  \fB/etc/httpd/conf.d/nss.conf\fP:
.IP
.TS
tab(;);
ll,ll.
;NSSFIPS on
.TE
.TP
.B <directory>
Specifies the destination directory of the NSS databases that will be associated with this executable specified by the following entry in \fB/etc/httpd/conf.d/nss.conf\fP:
.IP
.TS
tab(;);
ll,ll.
;#   Server Certificate Database:
;#   The NSS security database directory that holds the
;#   certificates and keys. The database consists
;#   of 3 files: cert8.db, key3.db and secmod.db.
;#   Provide the directory that these files exist.
;NSSCertificateDatabase /etc/httpd/alias
.TE
.TP
.B [prefix]
Optional prefix to attach prior to the names of the NSS certificate and key databases contained in the directory referenced by the previous argument and specified by the following entry in \fB/etc/httpd/conf.d/nss.conf\fP (must be uncommented in order to be utilized):
.IP
.TS
tab(;);
ll,ll.
;#   Database Prefix:
;#   In order to be able to store multiple NSS databases
;#   in one directory they need unique names. This option
;#   sets the database prefix used for cert8.db and key3.db.
;#NSSDBPrefix my-prefix-
.TE

.SH BUGS
Report bugs to http://bugzilla.redhat.com.

.SH AUTHORS
Rob Crittenden <rcritten@redhat.com>.

.SH COPYRIGHT
Copyright (c) 2013 Red Hat, Inc. This is licensed under the Apache License, Version 2.0 (the "License"); no one may use this file except in compliance with the License. A copy of this license is available at http://www.apache.org/licenses/LICENSE-2.0.
.PP
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.