usr/src/man/man1/ktutil.1

   1 '\" te
   2 .\" Copyright 1987, 1989 by the Student Information Processing Board of the Massachusetts Institute of Technology.  For copying and distribution information,  please see the file kerberosv5/mit-sipb-copyright.h.
   3 .\" Portions Copyright (c) 2006, 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 KTUTIL 1 "Nov 16, 2006"
   8 .SH NAME
   9 ktutil \- Kerberos keytab maintenance utility
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/bin/ktutil\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBktutil\fR command is an interactive command-line interface utility for
  20 managing  the keylist in keytab files. You must read in a keytab's keylist
  21 before you can manage it. Also, the user running the \fBktutil\fR command must
  22 have read/write permissions on the keytab. For example, if a keytab is owned by
  23 root, which it typically is, \fBktutil\fR must be run as root to have the
  24 appropriate permissions.
  25 .SH COMMANDS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fBclear_list\fR\fR
  30 .ad
  31 .br
  32 .na
  33 \fB\fBclear\fR\fR
  34 .ad
  35 .RS 23n
  36 Clears the current keylist.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBread_kt\fR \fIfile\fR\fR
  43 .ad
  44 .br
  45 .na
  46 \fB\fBrkt\fR \fIfile\fR\fR
  47 .ad
  48 .RS 23n
  49 Reads a keytab into the current keylist. You must specify a keytab \fIfile\fR
  50 to read.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBwrite_kt\fR \fIfile\fR\fR
  57 .ad
  58 .br
  59 .na
  60 \fB\fBwkt\fR \fIfile\fR\fR
  61 .ad
  62 .RS 23n
  63 Writes the current keylist to a keytab \fIfile\fR. You must specify a keytab
  64 file to write. If the keytab file already exists, the current keylist is
  65 appended to the existing keytab file.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBadd_entry\fR \fInumber\fR\fR
  72 .ad
  73 .br
  74 .na
  75 \fB\fBaddent\fR \fInumber\fR\fR
  76 .ad
  77 .RS 23n
  78 Adds an entry to the current keylist. Specify the entry by the keylist slot
  79 number.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBdelete_entry\fR \fInumber\fR\fR
  86 .ad
  87 .br
  88 .na
  89 \fB\fBdelent\fR \fInumber\fR\fR
  90 .ad
  91 .RS 23n
  92 Deletes an entry from the current keylist. Specify the entry by the keylist
  93 slot number.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBlist\fR\fR
 100 .ad
 101 .br
 102 .na
 103 \fB\fBl\fR\fR
 104 .ad
 105 .RS 23n
 106 Lists the current keylist.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBlist_request\fR\fR
 113 .ad
 114 .br
 115 .na
 116 \fB\fBlr\fR\fR
 117 .ad
 118 .RS 23n
 119 Lists available requests (commands).
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBquit\fR\fR
 126 .ad
 127 .br
 128 .na
 129 \fB\fBexit\fR\fR
 130 .ad
 131 .br
 132 .na
 133 \fB\fBq\fR\fR
 134 .ad
 135 .RS 23n
 136 Exits utility.
 137 .RE
 138
 139 .SH EXAMPLES
 140 .LP
 141 \fBExample 1 \fRDeleting a principal from a file
 142 .sp
 143 .LP
 144 The following example deletes the \fBhost/denver@ACME.com\fR principal from the
 145 \fB/etc/krb5/krb5.keytab\fR file. Notice that if you want to delete an entry
 146 from an existing keytab, you must first write the keylist to a temporary keytab
 147 and then overwrite the existing keytab with the temporary keytab. This is
 148 because the \fBwkt\fR command actually appends the current keylist to an
 149 existing keytab, so you can't use it to overwrite a keytab.
 150
 151 .sp
 152 .in +2
 153 .nf
 154 example# \fB/usr/krb5/bin/ktutil\fR
 155     ktutil: rkt /etc/krb5/krb5.keytab
 156     ktutil: list
 157 slot KVNO Principal
 158 ---- ---- ---------------------------------------
 159    1    8 host/vail@ACME.COM
 160    2    5 host/denver@ACME.COM
 161     ktutil:delent 2
 162     ktutil:l
 163 slot KVNO Principal
 164 ---- ---- --------------------------------------
 165    1    8 host/vail@ACME.COM
 166     ktutil:wkt /tmp/krb5.keytab
 167     ktutil:q
 168 example# \fBmv /tmp/krb5.keytab /etc/krb5/krb5.keytab\fR
 169 .fi
 170 .in -2
 171 .sp
 172
 173 .SH FILES
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB/etc/krb5/krb5.keytab\fR\fR
 178 .ad
 179 .RS 25n
 180 keytab file for Kerberos clients
 181 .RE
 182
 183 .SH ATTRIBUTES
 184 .sp
 185 .LP
 186 See \fBattributes\fR(5) for descriptions of the following attributes:
 187 .sp
 188
 189 .sp
 190 .TS
 191 box;
 192 c | c
 193 l | l .
 194 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 195 _
 196 Interface Stability     See below.
 197 .TE
 198
 199 .sp
 200 .LP
 201 The command arguments are Evolving. The command output is Unstable.
 202 .SH SEE ALSO
 203 .sp
 204 .LP
 205 \fBkadmin\fR(1M), \fBk5srvutil\fR(1M), \fBattributes\fR(5), \fBkerberos\fR(5)