6324 Add an `ndp' tool for manipulating the neighbors table
[illumos-gate.git] / usr / src / man / man1m / newkey.1m
blobc7433ddf356581e81c4234f6b7aac10a0d4a8d7f
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 NEWKEY 1M "Nov 13, 2003"
8 .SH NAME
9 newkey \- create a new Diffie-Hellman key pair in the publickey database
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBnewkey\fR \fB-h\fR \fIhostname\fR [\fB-s\fR nisplus | nis | files | ldap]
14 .fi
16 .LP
17 .nf
18 \fBnewkey\fR \fB-u\fR \fIusername\fR [\fB-s\fR nisplus | nis | files | ldap]
19 .fi
21 .SH DESCRIPTION
22 .sp
23 .LP
24 \fBnewkey\fR establishes new public keys for users and machines on the network.
25 These keys are needed when using secure \fBRPC\fR or secure \fBNFS\fR service.
26 .sp
27 .LP
28 \fBnewkey\fR prompts for a password for the given \fIusername\fR or
29 \fBhostname\fR and then creates a new public/secret Diffie-Hellman 192 bit key
30 pair for the user or host. The secret key is encrypted with the given password.
31 The key pair can be stored in the \fB/etc/publickey\fR file, the NIS
32 \fBpublickey\fR map, or the NIS+ \fBcred.org_dir\fR table.
33 .sp
34 .LP
35 \fBnewkey\fR consults the \fBpublickey\fR entry in the name service switch
36 configuration file (see \fBnsswitch.conf\fR(4)) to determine which naming
37 service is used to store the secure \fBRPC\fR keys. If the \fBpublickey\fR
38 entry specifies a unique name service, \fBnewkey\fR will add the key in the
39 specified name service. However, if there are multiple name services listed,
40 \fBnewkey\fR cannot decide which source to update and will display an error
41 message. The user is required to specify the source explicitly with the
42 \fB-s\fR option.
43 .sp
44 .LP
45 In the case of NIS, \fBnewkey\fR should be run by the superuser on the master
46 NIS server for that domain. In the case of NIS+, \fBnewkey\fR should be run by
47 the superuser on a machine which has permission to update the
48 \fBcred.org_dir\fR table of the new user/host domain.
49 .sp
50 .LP
51 In the case of NIS+, \fBnisaddcred\fR(1M) should be used to add new keys.
52 \fBnewkey\fR cannot be used to create keys other than 192-bit Diffie-Hellman.
53 .sp
54 .LP
55 In the case of LDAP, \fBnewkey\fR should be run by the superuser on a machine
56 that also recognizes the directory manager's bind distinguished name (DN) and
57 password to perform an LDAP update for the host.
58 .SH OPTIONS
59 .sp
60 .ne 2
61 .na
62 \fB\fB-h\fR \fIhostname\fR\fR
63 .ad
64 .RS 15n
65 Create a new public/secret key pair for the privileged user at the given
66 \fBhostname\fR. Prompts for a password for the given \fBhostname\fR.
67 .RE
69 .sp
70 .ne 2
71 .na
72 \fB\fB-u\fR \fIusername\fR\fR
73 .ad
74 .RS 15n
75 Create a new public/secret key pair for the given \fIusername\fR. Prompts for a
76 password for the given \fIusername\fR.
77 .RE
79 .sp
80 .ne 2
81 .na
82 \fB\fB-s\fR \fBnisplus\fR\fR
83 .ad
84 .br
85 .na
86 \fB\fB-s\fR \fBnis\fR\fR
87 .ad
88 .br
89 .na
90 \fB\fB-s\fR \fBfiles\fR\fR
91 .ad
92 .br
93 .na
94 \fB\fB-s\fR \fBldap\fR\fR
95 .ad
96 .RS 15n
97 Update the database in the specified source: \fBnisplus\fR (for NIS+),
98 \fBnis\fR (for NIS), \fBfiles\fR, or \fBldap\fR (LDAP). Other sources may be
99 available in the future.
102 .SH SEE ALSO
105 \fBchkey\fR(1), \fBkeylogin\fR(1), \fBnisaddcred\fR(1M), \fBnisclient\fR(1M),
106 \fBnsswitch.conf\fR(4), \fBpublickey\fR(4), \fBattributes\fR(5)
107 .SH NOTES
110 NIS+ might not be supported in future releases of the Solaris operating system.
111 Tools to aid the migration from NIS+ to LDAP are available in the current
112 Solaris release. For more information, visit
113 http://www.sun.com/directory/nisplus/transition.html.