'\" te
.\" Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
.\" Copyright 1989 AT&T
.TH keyserv 1M "11 Dec 2009" "SunOS 5.11" "System Administration Commands"
.SH NAME
keyserv \- server for storing private encryption keys
.SH SYNOPSIS
.LP
.nf
\fBkeyserv\fR [\fB-c\fR] [\fB-d\fR | \fB-e\fR] [\fB-D\fR] [\fB-n\fR] [\fB-s\fR \fIsizespec\fR]
.fi

.SH DESCRIPTION
.sp
.LP
\fBkeyserv\fR is a daemon that is used for storing the private encryption keys of each user logged into the system. These encryption keys are used for accessing secure network services such as secure \fBNFS\fR.
.sp
.LP
Normally, root's key is read from the file \fB/etc/.rootkey\fR when the daemon is started. This is useful during power-fail reboots when no one is around to type a password.
.sp
.LP
\fBkeyserv\fR does not start up if the system does not have a secure \fBrpc\fR domain configured. Set up the domain name by using the \fB/usr/bin/domainname\fR command. Usually the \fBsvc:/system/identity:domain\fR service reads the domain from \fB/etc/defaultdomain\fR. Invoking the \fBdomainname\fR command without arguments tells you if you have a domain set up.
.sp
.LP
The \fB/etc/default/keyserv\fR file contains the following default parameter settings. See Files.
.sp
.ne 2
.mk
.na
\fB\fBENABLE_NOBODY_KEYS\fR\fR
.ad
.RS 22n
.rt  
Specifies whether default keys for \fBnobody\fR are used. \fBENABLE_NOBODY_KEYS=NO\fR is equivalent to the \fB-d\fR command-line option. The default value for \fBENABLE_NOBODY_KEYS\fR is \fBYES\fR.
.RE

.SH OPTIONS
.sp
.LP
The following options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-c\fR\fR
.ad
.RS 15n
.rt  
Do not use disk caches. This option overrides any \fB-s\fR option.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-D\fR\fR
.ad
.RS 15n
.rt  
Run in debugging mode and log all requests to \fBkeyserv\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-d\fR\fR
.ad
.RS 15n
.rt  
Disable the use of default keys for \fBnobody\fR. See Files.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-e\fR\fR
.ad
.RS 15n
.rt  
Enable the use of default keys for \fBnobody\fR. This is the default behavior. See Files.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-n\fR\fR
.ad
.RS 15n
.rt  
Root's secret key is not read from \fB/etc/.rootkey\fR. Instead, \fBkeyserv\fR prompts the user for the password to decrypt root's key stored in the \fBpublickey\fR database and then stores the decrypted key in \fB/etc/.rootkey\fR for future use. This option is useful if the \fB/etc/.rootkey\fR file ever gets out of date or corrupted.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-s\fR \fIsizespec\fR\fR
.ad
.RS 15n
.rt  
Specify the size of the extended Diffie-Hellman common key disk caches. The \fIsizespec\fR can be one of the following forms: 
.sp
.ne 2
.mk
.na
\fB\fImechtype\fR=\fBsize\fR\fR
.ad
.RS 17n
.rt  
\fBsize\fR is an integer specifying the maximum number of entries in the cache, or an integer immediately followed by the letter \fIM\fR, denoting the maximum size in MB.
.RE

.sp
.ne 2
.mk
.na
\fB\fBsize\fR\fR
.ad
.RS 17n
.rt  
This form of \fIsizespec\fR applies to all caches.
.RE

Note that the \fBdes\fR mechanism, \fBAUTH_DES\fR, does not use a disk cache.
.RE

.SH FILES
.sp
.ne 2
.mk
.na
\fB\fB/etc/.rootkey\fR\fR
.ad
.RS 24n
.rt  

.RE

.sp
.ne 2
.mk
.na
\fB\fB/etc/default/keyserv\fR\fR
.ad
.RS 24n
.rt  
Contains default settings. You can use command-line options to override these settings.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitysystem/core-os
.TE

.SH SEE ALSO
.sp
.LP
\fBkeylogin\fR(1), \fBsvcs\fR(1), \fBkeylogout\fR(1), \fBsvcadm\fR(1M), \fBpublickey\fR(4), \fBattributes\fR(5), \fBsmf\fR(5)
.SH NOTES
.sp
.LP
The \fBkeyserv\fR service is managed by the service management facility, \fBsmf\fR(5), under the service identifier:
.sp
.in +2
.nf
svc:/network/rpc/keyserv:default
.fi
.in -2
.sp

.sp
.LP
Administrative actions on this service, such as enabling, disabling, or requesting restart, can be performed using \fBsvcadm\fR(1M). The service's status can be queried using the \fBsvcs\fR(1) command.