share/man/man8/keyserv.8

   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 8 "Feb 25, 2017"
   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 .LP
  18 \fBkeyserv\fR is a daemon that is used for storing the private encryption keys
  19 of each user logged into the system. These encryption keys are used for
  20 accessing secure network services such as secure \fBNFS\fR.
  21 .sp
  22 .LP
  23 Normally, root's key is read from the file \fB/etc/.rootkey\fR when the daemon
  24 is started. This is useful during power-fail reboots when no one is around to
  25 type a password.
  26 .sp
  27 .LP
  28 \fBkeyserv\fR does not start up if the system does not have a secure \fBrpc\fR
  29 domain configured. Set up the domain name by using the
  30 \fB/usr/bin/domainname\fR command. Usually the
  31 \fBsvc:/system/identity:domain\fR service reads the domain from
  32 \fB/etc/defaultdomain\fR. Invoking the \fBdomainname\fR command without
  33 arguments tells you if you have a domain set up.
  34 .sp
  35 .LP
  36 The \fB/etc/default/keyserv\fR file contains the following default parameter
  37 settings. See .
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBENABLE_NOBODY_KEYS\fR\fR
  42 .ad
  43 .RS 22n
  44 Specifies whether default keys for \fBnobody\fR are used.
  45 \fBENABLE_NOBODY_KEYS=NO\fR is equivalent to the \fB-d\fR command-line option.
  46 The default value for \fBENABLE_NOBODY_KEYS\fR is \fBYES\fR.
  47 .RE
  48
  49 .SH OPTIONS
  50 .LP
  51 The following options are supported:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-c\fR\fR
  56 .ad
  57 .RS 15n
  58 Do not use disk caches. This option overrides any \fB-s\fR option.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-D\fR\fR
  65 .ad
  66 .RS 15n
  67 Run in debugging mode and log all requests to \fBkeyserv\fR.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB-d\fR\fR
  74 .ad
  75 .RS 15n
  76 Disable the use of default keys for \fBnobody\fR. See .
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fB-e\fR\fR
  83 .ad
  84 .RS 15n
  85 Enable the use of default keys for \fBnobody\fR. This is the default behavior.
  86 See .
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-n\fR\fR
  93 .ad
  94 .RS 15n
  95 Root's secret key is not read from \fB/etc/.rootkey\fR. Instead, \fBkeyserv\fR
  96 prompts the user for the password to decrypt root's key stored in the
  97 \fBpublickey\fR database and then stores the decrypted key in
  98 \fB/etc/.rootkey\fR for future use. This option is useful if the
  99 \fB/etc/.rootkey\fR file ever gets out of date or corrupted.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fB-s\fR \fIsizespec\fR\fR
 106 .ad
 107 .RS 15n
 108 Specify the size of the extended Diffie-Hellman common key disk caches. The
 109 \fIsizespec\fR can be one of the following forms:
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fImechtype\fR=\fBsize\fR\fR
 114 .ad
 115 .RS 17n
 116 \fBsize\fR is an integer specifying the maximum number of entries in the cache,
 117 or an integer immediately followed by the letter \fIM\fR, denoting the maximum
 118 size in MB.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBsize\fR\fR
 125 .ad
 126 .RS 17n
 127 This form of \fIsizespec\fR applies to all caches.
 128 .RE
 129
 130 .SH FILES
 131 .ne 2
 132 .na
 133 \fB\fB/etc/.rootkey\fR\fR
 134 .ad
 135 .RS 24n
 136
 137 .RE
 138
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fB/etc/default/keyserv\fR\fR
 143 .ad
 144 .RS 24n
 145 Contains default settings. You can use command-line options to override these
 146 settings.
 147 .RE
 148
 149 .SH SEE ALSO
 150 .LP
 151 \fBkeylogin\fR(1), \fBsvcs\fR(1), \fBkeylogout\fR(1),
 152 \fBsvcadm\fR(8), \fBpublickey\fR(4), \fBattributes\fR(5), \fBsmf\fR(5)
 153 .SH NOTES
 154 .LP
 155 The \fBkeyserv\fR service is managed by the service management facility,
 156 \fBsmf\fR(5), under the service identifier:
 157 .sp
 158 .in +2
 159 .nf
 160 svc:/network/rpc/keyserv:default
 161 .fi
 162 .in -2
 163 .sp
 164
 165 .sp
 166 .LP
 167 Administrative actions on this service, such as enabling, disabling, or
 168 requesting restart, can be performed using \fBsvcadm\fR(8). The service's
 169 status can be queried using the \fBsvcs\fR(1) command.