nightly: remove unused BINARCHIVE
[unleashed.git] / share / man / man1 / klist.1
blob4c367f1fc67f623c20779ea9f71280362ba2119f
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) 2004, 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 KLIST 1 "Nov 16, 2006"
8 .SH NAME
9 klist \- list currently held Kerberos tickets
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fB/usr/bin/klist\fR [\fB-e\fR]
14      [ [\fB-c\fR] [\fB-f\fR] [\fB-s\fR] [\fB-a\fR [\fB-n\fR]] [\fIcache_name\fR]]
15      [\fB-k\fR [\fB-t\fR] [\fB-K\fR] [\fIkeytab_file\fR]]
16 .fi
18 .SH DESCRIPTION
19 .sp
20 .LP
21 The \fBklist\fR utility prints the name of the credentials cache, the identity
22 of the principal that the tickets are for (as listed in the ticket file), and
23 the principal names of all Kerberos tickets currently held by the user, along
24 with the issue and expiration time for each authenticator. Principal names are
25 listed in the form \fIname\fR\fB/\fR\fIinstance\fR\fB@\fR\fIrealm\fR, with
26 the '\fB/\fR' omitted if the instance is not included, and the '\fB@\fR' omitted if
27 the realm is  not included.
28 .sp
29 .LP
30 If \fIcache_file\fR or \fIkeytab_name\fR is not specified, \fBklist\fR displays
31 the credentials in the default credentials cache or keytab files as
32 appropriate. By default, your ticket is stored in the file
33 \fB/tmp/krb5cc_\fIuid\fR\fR, where \fIuid\fR is the current user-ID of the
34 user.
35 .SH OPTIONS
36 .sp
37 .LP
38 The following options are supported:
39 .sp
40 .ne 2
41 .na
42 \fB\fB-a\fR\fR
43 .ad
44 .RS 20n
45 Displays list of addresses in credentials. Uses the configured nameservice to
46 translate numeric network addresses to the associated hostname if possible.
47 .RE
49 .sp
50 .ne 2
51 .na
52 \fB\fB-c\fR [\fIcache_name\fR]\fR
53 .ad
54 .RS 20n
55 Lists tickets held in a credentials cache. This is the default if neither
56 \fB-c\fR nor \fB-k\fR is specified.
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fB-e\fR\fR
63 .ad
64 .RS 20n
65 Displays the encryption types of the session key and the ticket for each
66 credential in the credential cache, or each key in the keytab file.
67 .RE
69 .sp
70 .ne 2
71 .na
72 \fB\fB-f\fR\fR
73 .ad
74 .RS 20n
75 Shows the flags present in the credentials, using the following abbreviations:
76 .sp
77 .ne 2
78 .na
79 \fBa\fR
80 .ad
81 .RS 5n
82 Anonymous
83 .RE
85 .sp
86 .ne 2
87 .na
88 \fBA\fR
89 .ad
90 .RS 5n
91 Pre-authenticated
92 .RE
94 .sp
95 .ne 2
96 .na
97 \fBd\fR
98 .ad
99 .RS 5n
100 Post-dated
104 .ne 2
106 \fBD\fR
108 .RS 5n
109 Post-dateable
113 .ne 2
115 \fBf\fR
117 .RS 5n
118 Forwarded
122 .ne 2
124 \fBF\fR
126 .RS 5n
127 Forwardable
131 .ne 2
133 \fBH\fR
135 .RS 5n
136 Hardware authenticated
140 .ne 2
142 \fBi\fR
144 .RS 5n
145 Invalid
149 .ne 2
151 \fBI\fR
153 .RS 5n
154 Initial
158 .ne 2
160 \fBO\fR
162 .RS 5n
163 Okay as delegate
167 .ne 2
169 \fBp\fR
171 .RS 5n
172 Proxy
176 .ne 2
178 \fBP\fR
180 .RS 5n
181 Proxiable
185 .ne 2
187 \fBR\fR
189 .RS 5n
190 Renewable
194 .ne 2
196 \fBT\fR
198 .RS 5n
199 Transit policy checked
205 .ne 2
207 \fB\fB-k\fR [\fIkeytab_file\fR]\fR
209 .RS 20n
210 List keys held in a \fBkeytab\fR file.
214 .ne 2
216 \fB\fB-K\fR\fR
218 .RS 20n
219 Displays the value of the encryption key in each keytab entry in the keytab
220 file.
224 .ne 2
226 \fB\fB-n\fR\fR
228 .RS 20n
229 Shows numeric \fBIP\fR addresses instead of reverse-resolving addresses. Only
230 valid with \fB-a\fR option.
234 .ne 2
236 \fB\fB-s\fR\fR
238 .RS 20n
239 Causes \fBklist\fR to run silently (produce no output), but to still set the
240 exit status according to whether it finds the credentials cache. The exit
241 status is \fB0\fR if \fBklist\fR finds a credentials cache, and `\fB1\fRif it
242 does not, or if the local-realm TGT has expired.
246 .ne 2
248 \fB\fB-t\fR\fR
250 .RS 20n
251 Displays the time entry timestamps for each keytab entry in the keytab file.
254 .SH ENVIRONMENT VARIABLES
257 \fBklist\fR uses the following environment variable:
259 .ne 2
261 \fB\fBKRB5CCNAME\fR\fR
263 .RS 14n
264 Location of the credentials (ticket) cache. See \fBkrb5envvar\fR(5) for syntax
265 and details.
268 .SH FILES
270 .ne 2
272 \fB\fB/tmp/krb5cc_\fIuid\fR\fR\fR
274 .RS 25n
275 Default credentials cache (\fIuid\fR is the decimal \fBUID\fR of the user).
279 .ne 2
281 \fB\fB/etc/krb5/krb5.keytab\fR\fR
283 .RS 25n
284 Default location for the local host's \fBkeytab\fR file.
288 .ne 2
290 \fB\fB/etc/krb5/krb5.conf\fR\fR
292 .RS 25n
293 Default location for the local host's configuration file. See
294 \fBkrb5.conf\fR(4).
297 .SH ATTRIBUTES
300 See \fBattributes\fR(5) for descriptions of the following attributes:
305 box;
306 c | c
307 l | l .
308 ATTRIBUTE TYPE  ATTRIBUTE VALUE
310 Interface Stability     See below.
315 The command arguments are Evolving. The command output is Unstable.
316 .SH SEE ALSO
319 \fBkdestroy\fR(1), \fBkinit\fR(1), \fBkrb5.conf\fR(4), \fBattributes\fR(5),
320 \fBkrb5envvar\fR(5), \fBkerberos\fR(5)
321 .SH BUGS
324 When reading a file as a service key file, very little error checking is
325 performed.