xref: /freebsd/crypto/heimdal/admin/ktutil.8 (revision 45524cd79e498d0465de59a4c8c825709b2662df)
1.\" $Id: ktutil.8,v 1.9 2000/12/16 00:58:49 joda Exp $
2.\"
3.Dd December 16, 2000
4.Dt KTUTIL 8
5.Os HEIMDAL
6.Sh NAME
7.Nm ktutil
8.Nd manage Kerberos keytabs
9.Sh SYNOPSIS
10.Nm
11.Oo Fl k Ar keytab \*(Ba Xo
12.Fl -keytab= Ns Ar keytab
13.Xc
14.Oc
15.Op Fl v | Fl -verbose
16.Op Fl -version
17.Op Fl h | Fl -help
18.Ar command
19.Op Ar args
20.Sh DESCRIPTION
21.Nm
22is a program for managing keytabs.
23.Ar command
24can be one of the following:
25.Bl -tag -width Ds
26.It add Xo
27.Op Fl p Ar principal
28.Op Fl -principal= Ns Ar principal
29.Op Fl V Ar kvno
30.Op Fl -kvno= Ns Ar kvno
31.Op Fl e Ar encype
32.Op Fl -enctype= Ns Ar enctype
33.Op Fl w Ar password
34.Op Fl -password= Ns Ar password
35.Op Fl r
36.Op Fl -random
37.Op Fl s
38.Op Fl -no-salt
39.Xc
40Adds a key to the keytab. Options that are not specified will be
41prompted for.
42.It change Xo
43.Op Fl r Ar realm
44.Op Fl -realm= Ns Ar realm
45.Op Fl -a Ar host
46.Op Fl -admin-server= Ns Ar host
47.Op Fl -s Ar port
48.Op Fl -server-port= Ns Ar port
49.Xc
50Update one or several keys to new versions.  By default, use the admin
51server for the realm of an keytab entry.  Otherwise it will use the
52values specified by the options.
53.Pp
54If no principals are given, all the ones in the keytab are updated.
55.It copy Xo
56.Ar keytab-src
57.Ar keytab-dest
58.Xc
59Copies all the entries from
60.Ar keytab-src
61to
62.Ar keytab-dest .
63.It get Xo
64.Op Fl p Ar admin principal
65.Op Fl -principal= Ns Ar admin principal
66.Op Fl r Ar realm
67.Op Fl -realm= Ns Ar realm
68.Op Fl a Ar admin server
69.Op Fl -admin-server= Ns Ar admin server
70.Op Fl s Ar server port
71.Op Fl -server-port= Ns Ar server port
72.Ar principal
73.Xc
74Get a key for
75.Nm principal
76and store it in a keytab.
77.It list Xo
78.Op Fl -keys
79.Op Fl -timestamp
80.Xc
81List the keys stored in the keytab.
82.It remove Xo
83.Op Fl p Ar principal
84.Op Fl -principal= Ns Ar principal
85.Op Fl V kvno
86.Op Fl -kvno= Ns Ar kvno
87.Op Fl e enctype
88.Op Fl -enctype= Ns Ar enctype
89.Xc
90Removes the specified key or keys. Not specifying a
91.Ar kvno
92removes keys with any version number. Not specifying a
93.Ar enctype
94removes keys of any type.
95.It purge Xo
96.Op Fl -age= Ns Ar age
97.Xc
98Removes all old entries (for which there is a newer version) that are
99older than
100.Ar age
101(default one week).
102.It srvconvert
103.It srv2keytab Xo
104.Op Fl s Ar srvtab
105.Op Fl -srvtab= Ns Ar srvtab
106.Xc
107Converts the version 4 srvtab in
108.Ar srvtab
109to a version 5 keytab and stores it in
110.Ar keytab .
111Identical to:
112.Bd -ragged -offset indent
113.Li ktutil copy
114.Li krb4: Ns Ar srvtab
115.Ar keytab
116.Ed
117.It srvcreate
118.It key2srvtab Xo
119.Op Fl s Ar srvtab
120.Op Fl -srvtab= Ns Ar srvtab
121.Xc
122Converts the version 5 keytab in
123.Ar keytab
124to a version 4 srvtab and stores it in
125.Ar srvtab .
126Identical to:
127.Bd -ragged -offset indent
128.Li ktutil copy
129.Ar keytab
130.Li krb4: Ns Ar srvtab
131.Ed
132.El
133.Sh SEE ALSO
134.Xr kadmin 8
135