usr/src/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 "Dec 2, 2005"
   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 .sp
  18 .LP
  19 The \fBkeylogin\fR command prompts for a password, and uses it to decrypt the
  20 user's secret key. The key can be found in the \fB/etc/publickey\fR file (see
  21 \fBpublickey\fR(4)) or the  NIS map ``publickey.byname'' or the  NIS+ table
  22 ``cred.org_dir'' in the user's home domain. The sources and their lookup order
  23 are specified in the \fB/etc/nsswitch.conf\fR file. See \fBnsswitch.conf\fR(4).
  24 Once decrypted, the user's secret key is stored by the local key server
  25 process, \fBkeyserv\fR(1M). This stored key is used when issuing requests to
  26 any secure RPC services, such as \fBNFS\fR or NIS+. The program
  27 \fBkeylogout\fR(1) can be used to delete the key stored by \fBkeyserv\fR
  28 \fB\&.\fR
  29 .sp
  30 .LP
  31 \fBkeylogin\fR fails if it cannot get the caller's key, or the password given
  32 is incorrect. For a new user or host, a new key can be added using
  33 \fBnewkey\fR(1M), \fBnisaddcred\fR(1M), or \fBnisclient\fR(1M).
  34 .sp
  35 .LP
  36 If multiple authentication mechanisms are configured for the system, each of
  37 the configured mechanism's secret key is decrypted and stored by
  38 \fBkeyserv\fR(1M). See \fBnisauthconf\fR(1M) for information on configuring
  39 multiple authentication mechanisms.
  40 .SH OPTIONS
  41 .sp
  42 .LP
  43 The following options are supported:
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fB-r\fR\fR
  48 .ad
  49 .RS 6n
  50 Update the \fB/etc/.rootkey\fR file. This file holds the unencrypted secret key
  51 of the superuser. Only the superuser can use this option. It is used so that
  52 processes running as superuser can issue authenticated requests without
  53 requiring that the administrator explicitly run \fBkeylogin\fR as superuser at
  54 system startup time. See \fBkeyserv\fR(1M). The \fB-r\fR option should be used
  55 by the administrator when the host's entry in the publickey database has
  56 changed, and the \fB/etc/.rootkey\fR file has become out-of-date with  respect
  57 to the actual key pair stored in the publickey database. The permissions on the
  58 \fB/etc/.rootkey\fR file are such that it can be read and written by the
  59 superuser but by no other user on the system.
  60 .sp
  61 If multiple authentication mechanisms are configured for the system, each of
  62 the configured mechanism's secret keys is stored in the \fB/etc/.rootkey\fR
  63 file.
  64 .RE
  65
  66 .SH FILES
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fB/etc/.rootkey\fR\fR
  71 .ad
  72 .RS 17n
  73 superuser's secret key
  74 .RE
  75
  76 .SH SEE ALSO
  77 .sp
  78 .LP
  79 \fBchkey\fR(1), \fBkeylogout\fR(1), \fBlogin\fR(1), \fBkeyserv\fR(1M),
  80 \fBnewkey\fR(1M), \fBnisaddcred\fR(1M), \fBnisauthconf\fR(1M),
  81 \fBnisclient\fR(1M), \fBnsswitch.conf\fR(4), \fBpublickey\fR(4),
  82 \fBattributes\fR(5)
  83 .SH NOTES
  84 .sp
  85 .LP
  86 NIS+ might not be supported in future releases of the Solaris operating system.
  87 Tools to aid the migration from NIS+ to LDAP are available in the current
  88 Solaris release. For more information, visit
  89 http://www.sun.com/directory/nisplus/transition.html.