usr/src/man/man1m/k5srvutil.1m

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH K5SRVUTIL 1M "Jul 25, 2015"
   7 .SH NAME
   8 k5srvutil \- host key table (keytab) manipulation utility
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/k5srvutil\fR \fIoperation\fR [\fB-ik\fR] [\fB-f\fR \fIfilename\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .LP
  17 The \fBk5srvutil\fR command allows a system manager to list or change keys
  18 currently in his keytab or to add new keys to the keytab.
  19 .sp
  20 .LP
  21 The operand \fIoperation\fR must be one of the following:
  22 .sp
  23 .ne 2
  24 .na
  25 \fB\fBlist\fR\fR
  26 .ad
  27 .RS 10n
  28 Lists the keys in a keytab, showing version number and principal name.
  29 .RE
  30
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fBchange\fR\fR
  35 .ad
  36 .RS 10n
  37 Changes all the keys in the keytab to new randomly-generated keys, updating the
  38 keys in the Kerberos server's database to match those by using the \fBkadmin\fR
  39 protocol. If a key's version number does not match the version number stored in
  40 the Kerberos server's database, the operation fails. The old keys are retained
  41 so that existing tickets continue to work. If the \fB-i\fR flag is specified,
  42 \fBk5srvutil\fR prompts for \fByes\fR or \fBno\fR before changing each key. If
  43 the \fB-k\fR option is used, the old and new keys are displayed.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBdelold\fR\fR
  50 .ad
  51 .RS 10n
  52 Deletes keys that are not the most recent version from the keytab. This
  53 operation should be used at some point after a change operation to remove old
  54 keys. If the \fB-i\fR flag is specified, \fBk5srvutil\fR asks the user whether
  55 the old keys associated with each principal should be removed.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBdelete\fR\fR
  62 .ad
  63 .RS 10n
  64 Deletes particular keys in the keytab, interactively prompting for each key.
  65 .RE
  66
  67 .sp
  68 .LP
  69 In all cases, the default keytab file is \fB/etc/krb5/krb5.keytab\fR unless
  70 overridden by the \fB-f\fR option.
  71 .sp
  72 .LP
  73 \fBk5srvutil\fR uses the \fBkadmin\fR(1M) program to edit the keytab in place.
  74 However, old keys are retained, so they are available in case of failure.
  75 .SH OPTIONS
  76 .LP
  77 The following options are supported:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fB-f\fR \fIfilename\fR\fR
  82 .ad
  83 .RS 15n
  84 Specify a keytab file other than the default file, \fB/etc/krb5/krb5.keytab\fR.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB-i\fR\fR
  91 .ad
  92 .RS 15n
  93 Prompts user before changing keys when using the \fBchange\fR or \fBdelold\fR
  94 operands.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fB-k\fR\fR
 101 .ad
 102 .RS 15n
 103 Displays old and new keys when using the \fBchange\fR operand.
 104 .RE
 105
 106 .SH ATTRIBUTES
 107 .LP
 108 See \fBattributes\fR(5) for descriptions of the following attributes:
 109 .sp
 110
 111 .sp
 112 .TS
 113 box;
 114 c | c
 115 l | l .
 116 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 117 _
 118 Interface Stability     Committed
 119 .TE
 120
 121 .SH SEE ALSO
 122 .LP
 123 \fBktutil\fR(1), \fBkadmin\fR(1M), \fBattributes\fR(5)