usr/src/man/man1m/keyserv.1m

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Copyright (C) 2005, Sun Microsystems, Inc. All Rights Reserved
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH KEYSERV 1M "Jan 4, 2002"
   8 .SH NAME
   9 keyserv \- server for storing private encryption keys
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBkeyserv\fR [\fB-c\fR] [\fB-d\fR | \fB-e\fR] [\fB-D\fR] [\fB-n\fR] [\fB-s\fR \fIsizespec\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 \fBkeyserv\fR is a daemon that is used for storing the private encryption keys
  20 of each user logged into the system. These encryption keys are used for
  21 accessing secure network services such as secure \fBNFS\fR and NIS+.
  22 .sp
  23 .LP
  24 Normally, root's key is read from the file \fB/etc/.rootkey\fR when the daemon
  25 is started. This is useful during power-fail reboots when no one is around to
  26 type a password.
  27 .sp
  28 .LP
  29 \fBkeyserv\fR does not start up if the system does not have a secure \fBrpc\fR
  30 domain configured. Set up the domain name by using the
  31 \fB/usr/bin/domainname\fR command. Usually the
  32 \fBsvc:/system/identity:domain\fR service reads the domain from
  33 \fB/etc/defaultdomain\fR. Invoking the \fBdomainname\fR command without
  34 arguments tells you if you have a domain set up.
  35 .sp
  36 .LP
  37 The \fB/etc/default/keyserv\fR file contains the following default parameter
  38 settings. See .
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBENABLE_NOBODY_KEYS\fR\fR
  43 .ad
  44 .RS 22n
  45 Specifies whether default keys for \fBnobody\fR are used.
  46 \fBENABLE_NOBODY_KEYS=NO\fR is equivalent to the \fB-d\fR command-line option.
  47 The default value for \fBENABLE_NOBODY_KEYS\fR is \fBYES\fR.
  48 .RE
  49
  50 .SH OPTIONS
  51 .sp
  52 .LP
  53 The following options are supported:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fB-c\fR\fR
  58 .ad
  59 .RS 15n
  60 Do not use disk caches. This option overrides any \fB-s\fR option.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fB-D\fR\fR
  67 .ad
  68 .RS 15n
  69 Run in debugging mode and log all requests to \fBkeyserv\fR.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB-d\fR\fR
  76 .ad
  77 .RS 15n
  78 Disable the use of default keys for \fBnobody\fR. See .
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB-e\fR\fR
  85 .ad
  86 .RS 15n
  87 Enable the use of default keys for \fBnobody\fR. This is the default behavior.
  88 See .
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-n\fR\fR
  95 .ad
  96 .RS 15n
  97 Root's secret key is not read from \fB/etc/.rootkey\fR. Instead, \fBkeyserv\fR
  98 prompts the user for the password to decrypt root's key stored in the
  99 \fBpublickey\fR database and then stores the decrypted key in
 100 \fB/etc/.rootkey\fR for future use. This option is useful if the
 101 \fB/etc/.rootkey\fR file ever gets out of date or corrupted.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-s\fR \fIsizespec\fR\fR
 108 .ad
 109 .RS 15n
 110 Specify the size of the extended Diffie-Hellman common key disk caches. The
 111 \fIsizespec\fR can be one of the following forms:
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fImechtype\fR=\fBsize\fR\fR
 116 .ad
 117 .RS 17n
 118 \fBsize\fR is an integer specifying the maximum number of entries in the cache,
 119 or an integer immediately followed by the letter \fIM\fR, denoting the maximum
 120 size in MB.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBsize\fR\fR
 127 .ad
 128 .RS 17n
 129 This form of \fIsizespec\fR applies to all caches.
 130 .RE
 131
 132 See \fBnisauthconf\fR(1M) for mechanism types. Note that the \fBdes\fR
 133 mechanism, \fBAUTH_DES\fR, does not use a disk cache.
 134 .RE
 135
 136 .SH FILES
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fB/etc/.rootkey\fR\fR
 141 .ad
 142 .RS 24n
 143
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fB/etc/default/keyserv\fR\fR
 150 .ad
 151 .RS 24n
 152 Contains default settings. You can use command-line options to override these
 153 settings.
 154 .RE
 155
 156 .SH SEE ALSO
 157 .sp
 158 .LP
 159 \fBkeylogin\fR(1), \fBsvcs\fR(1), \fBkeylogout\fR(1), \fBnisauthconf\fR(1M),
 160 \fBsvcadm\fR(1M), \fBpublickey\fR(4), \fBattributes\fR(5), \fBsmf\fR(5)
 161 .sp
 162 .LP
 163 http://www.sun.com/directory/nisplus/transition.html
 164 .SH NOTES
 165 .sp
 166 .LP
 167 NIS+ might not be supported in future releases of the Solaris operating system.
 168 Tools to aid the migration from NIS+ to LDAP are available in the current
 169 Solaris release. For more information, visit
 170 http://www.sun.com/directory/nisplus/transition.html.
 171 .sp
 172 .LP
 173 The \fBkeyserv\fR service is managed by the service management facility,
 174 \fBsmf\fR(5), under the service identifier:
 175 .sp
 176 .in +2
 177 .nf
 178 svc:/network/rpc/keyserv:default
 179 .fi
 180 .in -2
 181 .sp
 182
 183 .sp
 184 .LP
 185 Administrative actions on this service, such as enabling, disabling, or
 186 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
 187 status can be queried using the \fBsvcs\fR(1) command.