summaryrefslogtreecommitdiff
path: root/usr/src/man/man1m/k5srvutil.1m
blob: 8102ae221db1f2fa98bc2dd80c75b4dd536c601e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
'\" te
.\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
.\" 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.
.\" 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.
.\" 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]
.TH k5srvutil 1M "29 Aug 2006" "SunOS 5.11" "System Administration Commands"
.SH NAME
k5srvutil \- host key table (keytab) manipulation utility
.SH SYNOPSIS
.LP
.nf
\fB/usr/sbin/k5srvutil\fR \fIoperation\fR [\fB-ik\fR] [\fB-f\fR \fIfilename\fR]
.fi

.SH DESCRIPTION
.sp
.LP
The \fBk5srvutil\fR command allows a system manager to list or change keys
currently in his keytab or to add new keys to the keytab.
.sp
.LP
The operand \fIoperation\fR must be one of the following:
.sp
.ne 2
.mk
.na
\fB\fBlist\fR\fR
.ad
.RS 10n
.rt  
Lists the keys in a keytab, showing version number and principal name.
.RE

.sp
.ne 2
.mk
.na
\fB\fBchange\fR\fR
.ad
.RS 10n
.rt  
Changes all the keys in the keytab to new randomly-generated keys, updating the
keys in the Kerberos server's database to match those by using the \fBkadmin\fR
protocol. If a key's version number does not match the version number stored in
the Kerberos server's database, the operation fails. The old keys are retained
so that existing tickets continue to work. If the \fB-i\fR flag is specified,
\fBk5srvutil\fR prompts for \fByes\fR or \fBno\fR before changing each key. If
the \fB-k\fR option is used, the old and new keys are displayed.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdelold\fR\fR
.ad
.RS 10n
.rt  
Deletes keys that are not the most recent version from the keytab. This
operation should be used at some point after a change operation to remove old
keys. If the \fB-i\fR flag is specified, \fBk5srvutil\fR asks the user whether
the old keys associated with each principal should be removed.
.RE

.sp
.ne 2
.mk
.na
\fB\fBdelete\fR\fR
.ad
.RS 10n
.rt  
Deletes particular keys in the keytab, interactively prompting for each key.
.RE

.sp
.LP
In all cases, the default keytab file is \fB/etc/krb5.keytab\fR file unless
this is overridden by the \fB-f\fR option.
.sp
.LP
\fBk5srvutil\fR uses the \fBkadmin\fR(1M) program to edit the keytab in place.
However, old keys are retained, so they are available in case of failure.
.SH OPTIONS
.sp
.LP
The following options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-f\fR \fIfilename\fR\fR
.ad
.RS 15n
.rt  
Specify a keytab file other than the default file, \fB/etc/krb5.keytab\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-i\fR\fR
.ad
.RS 15n
.rt  
Prompts user before changing keys when using the \fBchange\fR or \fBdelold\fR
operands.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-k\fR\fR
.ad
.RS 15n
.rt  
Displays old and new keys when using the \fBchange\fR operand.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
.TE

.SH SEE ALSO
.sp
.LP
\fBktutil\fR(1), \fBkadmin\fR(1M), \fBattributes\fR(5)