nightly: remove unused BINARCHIVE
[unleashed.git] / share / man / man1 / chkey.1
blobfe0dfa43751484f6f81e6be53e618458983d1de9
1 '\" te
2 .\" Copyright (C) 2005, Sun Microsystems, Inc. All Rights Reserved
3 .\" Copyright 1989 AT&T
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 CHKEY 1 "Feb 25, 2017"
8 .SH NAME
9 chkey \- change user's secure RPC key pair
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBchkey\fR [\fB-p\fR] [\fB-s\fR nis | files | ldap]
14      [\fB-m\fR \fI<mechanism>\fR]
15 .fi
17 .SH DESCRIPTION
18 .LP
19 \fBchkey\fR is used to change a user's secure \fBRPC\fR public key and secret
20 key pair. \fBchkey\fR prompts for the old secure-rpc password and verifies that
21 it is correct by decrypting the secret key. If the user has not already used
22 \fBkeylogin\fR(1) to decrypt and store the secret key with \fBkeyserv\fR(8),
23 \fBchkey\fR registers the secret key with the local \fBkeyserv\fR(8) daemon.
24 If the secure-rpc password does not match the login password, \fBchkey\fR
25 prompts for the login password. \fBchkey\fR uses the login password to encrypt
26 the user's secret Diffie-Hellman (192 bit) cryptographic key.
27 .sp
28 .LP
29 \fBchkey\fR ensures that the login password and the secure-rpc  password(s) are
30 kept the same, thus enabling password shadowing. See \fBshadow\fR(4).
31 .sp
32 .LP
33 The key pair can be stored in the  \fB/etc/publickey\fR file (see
34 \fBpublickey\fR(4)) or the \fBNIS\fR \fBpublickey\fR map.
35 If a new secret key is generated, it will be
36 registered with the local \fBkeyserv\fR(8) daemon.
37 .sp
38 .LP
39 Keys for specific mechanisms can be changed or reencrypted using the \fB-m\fR
40 option followed by the authentication mechanism name. Multiple  \fB-m\fR
41 options can be used to change one or more keys.
42 .sp
43 .LP
44 If the source of the  \fBpublickey\fR is not specified with the \fB-s\fR
45 option,  \fBchkey\fR consults the  \fBpublickey\fR entry in the name service
46 switch configuration file.  See \fBnsswitch.conf\fR(4). If the  \fBpublickey\fR
47 entry specifies one and only one source, then \fBchkey\fR will change the key
48 in the specified name service. However, if multiple name services are listed,
49 \fBchkey\fR can not decide which source to update and will display an error
50 message. The user should specify the source explicitly with the \fB-s\fR
51 option.
52 .sp
53 .LP
54 Non root users are not allowed to change their key pair in the \fBfiles\fR
55 database.
56 .SH OPTIONS
57 .LP
58 The following options are supported:
59 .sp
60 .ne 2
61 .na
62 \fB\fB-p\fR\fR
63 .ad
64 .RS 18n
65 Re-encrypt the existing secret key with the user's login password.
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fB-s\fR \fBnis\fR\fR
72 .ad
73 .RS 18n
74 Update the \fBNIS\fR database.
75 .RE
77 .sp
78 .ne 2
79 .na
80 \fB\fB-s\fR \fBfiles\fR\fR
81 .ad
82 .RS 18n
83 Update the  \fBfiles\fR database.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fB-s\fR \fBldap\fR\fR
90 .ad
91 .RS 18n
92 Update the  LDAP database.
93 .RE
95 .sp
96 .ne 2
97 .na
98 \fB\fB-m\fR\fI <mechanism>\fR\fR
99 .ad
100 .RS 18n
101 Changes or re-encrypt the secret key for the specified mechanism.
104 .SH FILES
105 .ne 2
107 \fB\fB/etc/nsswitch.conf\fR\fR
109 .RS 22n
114 .ne 2
116 \fB\fB/etc/publickey\fR\fR
118 .RS 22n
122 .SH SEE ALSO
124 \fBkeylogin\fR(1), \fBkeylogout\fR(1), \fBkeyserv\fR(8), \fBnewkey\fR(8),
125 \fBnsswitch.conf\fR(4),
126 \fBpublickey\fR(4), \fBshadow\fR(4), \fBattributes\fR(5)