share/man/man1/keylogin.1

   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 KEYLOGIN 1 "Feb 25, 2017"
   8 .SH NAME
   9 keylogin \- decrypt and store secret key with keyserv
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/bin/keylogin\fR [\fB-r\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .LP
  18 The \fBkeylogin\fR command prompts for a password, and uses it to decrypt the
  19 user's secret key. The key can be found in the \fB/etc/publickey\fR file (see
  20 \fBpublickey\fR(4)) or the  NIS map ``publickey.byname''
  21 in the user's home domain. The sources and their lookup order
  22 are specified in the \fB/etc/nsswitch.conf\fR file. See \fBnsswitch.conf\fR(4).
  23 Once decrypted, the user's secret key is stored by the local key server
  24 process, \fBkeyserv\fR(8). This stored key is used when issuing requests to
  25 any secure RPC services, such as \fBNFS\fR. The program
  26 \fBkeylogout\fR(1) can be used to delete the key stored by \fBkeyserv\fR
  27 \fB\&.\fR
  28 .sp
  29 .LP
  30 \fBkeylogin\fR fails if it cannot get the caller's key, or the password given
  31 is incorrect. For a new user or host, a new key can be added using
  32 \fBnewkey\fR(8).
  33 .SH OPTIONS
  34 .LP
  35 The following options are supported:
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fB-r\fR\fR
  40 .ad
  41 .RS 6n
  42 Update the \fB/etc/.rootkey\fR file. This file holds the unencrypted secret key
  43 of the superuser. Only the superuser can use this option. It is used so that
  44 processes running as superuser can issue authenticated requests without
  45 requiring that the administrator explicitly run \fBkeylogin\fR as superuser at
  46 system startup time. See \fBkeyserv\fR(8). The \fB-r\fR option should be used
  47 by the administrator when the host's entry in the publickey database has
  48 changed, and the \fB/etc/.rootkey\fR file has become out-of-date with  respect
  49 to the actual key pair stored in the publickey database. The permissions on the
  50 \fB/etc/.rootkey\fR file are such that it can be read and written by the
  51 superuser but by no other user on the system.
  52 .RE
  53
  54 .SH FILES
  55 .ne 2
  56 .na
  57 \fB\fB/etc/.rootkey\fR\fR
  58 .ad
  59 .RS 17n
  60 superuser's secret key
  61 .RE
  62
  63 .SH SEE ALSO
  64 .LP
  65 \fBchkey\fR(1), \fBkeylogout\fR(1), \fBlogin\fR(1), \fBkeyserv\fR(8),
  66 \fBnewkey\fR(8), \fBnsswitch.conf\fR(4), \fBpublickey\fR(4),
  67 \fBattributes\fR(5)