xref: /freebsd/crypto/krb5/doc/user/user_commands/klist.rst (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1*7f2fe78bSCy Schubert.. _klist(1):
2*7f2fe78bSCy Schubert
3*7f2fe78bSCy Schubertklist
4*7f2fe78bSCy Schubert=====
5*7f2fe78bSCy Schubert
6*7f2fe78bSCy SchubertSYNOPSIS
7*7f2fe78bSCy Schubert--------
8*7f2fe78bSCy Schubert
9*7f2fe78bSCy Schubert**klist**
10*7f2fe78bSCy Schubert[**-e**]
11*7f2fe78bSCy Schubert[[**-c**] [**-l**] [**-A**] [**-f**] [**-s**] [**-a** [**-n**]]]
12*7f2fe78bSCy Schubert[**-C**]
13*7f2fe78bSCy Schubert[**-k** [**-i**] [**-t**] [**-K**]]
14*7f2fe78bSCy Schubert[**-V**]
15*7f2fe78bSCy Schubert[**-d**]
16*7f2fe78bSCy Schubert[*cache_name*\|\ *keytab_name*]
17*7f2fe78bSCy Schubert
18*7f2fe78bSCy Schubert
19*7f2fe78bSCy SchubertDESCRIPTION
20*7f2fe78bSCy Schubert-----------
21*7f2fe78bSCy Schubert
22*7f2fe78bSCy Schubertklist lists the Kerberos principal and Kerberos tickets held in a
23*7f2fe78bSCy Schubertcredentials cache, or the keys held in a keytab file.
24*7f2fe78bSCy Schubert
25*7f2fe78bSCy Schubert
26*7f2fe78bSCy SchubertOPTIONS
27*7f2fe78bSCy Schubert-------
28*7f2fe78bSCy Schubert
29*7f2fe78bSCy Schubert**-e**
30*7f2fe78bSCy Schubert    Displays the encryption types of the session key and the ticket
31*7f2fe78bSCy Schubert    for each credential in the credential cache, or each key in the
32*7f2fe78bSCy Schubert    keytab file.
33*7f2fe78bSCy Schubert
34*7f2fe78bSCy Schubert**-l**
35*7f2fe78bSCy Schubert    If a cache collection is available, displays a table summarizing
36*7f2fe78bSCy Schubert    the caches present in the collection.
37*7f2fe78bSCy Schubert
38*7f2fe78bSCy Schubert**-A**
39*7f2fe78bSCy Schubert    If a cache collection is available, displays the contents of all
40*7f2fe78bSCy Schubert    of the caches in the collection.
41*7f2fe78bSCy Schubert
42*7f2fe78bSCy Schubert**-c**
43*7f2fe78bSCy Schubert    List tickets held in a credentials cache. This is the default if
44*7f2fe78bSCy Schubert    neither **-c** nor **-k** is specified.
45*7f2fe78bSCy Schubert
46*7f2fe78bSCy Schubert**-f**
47*7f2fe78bSCy Schubert    Shows the flags present in the credentials, using the following
48*7f2fe78bSCy Schubert    abbreviations::
49*7f2fe78bSCy Schubert
50*7f2fe78bSCy Schubert        F    Forwardable
51*7f2fe78bSCy Schubert        f    forwarded
52*7f2fe78bSCy Schubert        P    Proxiable
53*7f2fe78bSCy Schubert        p    proxy
54*7f2fe78bSCy Schubert        D    postDateable
55*7f2fe78bSCy Schubert        d    postdated
56*7f2fe78bSCy Schubert        R    Renewable
57*7f2fe78bSCy Schubert        I    Initial
58*7f2fe78bSCy Schubert        i    invalid
59*7f2fe78bSCy Schubert        H    Hardware authenticated
60*7f2fe78bSCy Schubert        A    preAuthenticated
61*7f2fe78bSCy Schubert        T    Transit policy checked
62*7f2fe78bSCy Schubert        O    Okay as delegate
63*7f2fe78bSCy Schubert        a    anonymous
64*7f2fe78bSCy Schubert
65*7f2fe78bSCy Schubert**-s**
66*7f2fe78bSCy Schubert    Causes klist to run silently (produce no output).  klist will exit
67*7f2fe78bSCy Schubert    with status 1 if the credentials cache cannot be read or is
68*7f2fe78bSCy Schubert    expired, and with status 0 otherwise.
69*7f2fe78bSCy Schubert
70*7f2fe78bSCy Schubert**-a**
71*7f2fe78bSCy Schubert    Display list of addresses in credentials.
72*7f2fe78bSCy Schubert
73*7f2fe78bSCy Schubert**-n**
74*7f2fe78bSCy Schubert    Show numeric addresses instead of reverse-resolving addresses.
75*7f2fe78bSCy Schubert
76*7f2fe78bSCy Schubert**-C**
77*7f2fe78bSCy Schubert    List configuration data that has been stored in the credentials
78*7f2fe78bSCy Schubert    cache when klist encounters it.  By default, configuration data
79*7f2fe78bSCy Schubert    is not listed.
80*7f2fe78bSCy Schubert
81*7f2fe78bSCy Schubert**-k**
82*7f2fe78bSCy Schubert    List keys held in a keytab file.
83*7f2fe78bSCy Schubert
84*7f2fe78bSCy Schubert**-i**
85*7f2fe78bSCy Schubert    In combination with **-k**, defaults to using the default client
86*7f2fe78bSCy Schubert    keytab instead of the default acceptor keytab, if no name is
87*7f2fe78bSCy Schubert    given.
88*7f2fe78bSCy Schubert
89*7f2fe78bSCy Schubert**-t**
90*7f2fe78bSCy Schubert    Display the time entry timestamps for each keytab entry in the
91*7f2fe78bSCy Schubert    keytab file.
92*7f2fe78bSCy Schubert
93*7f2fe78bSCy Schubert**-K**
94*7f2fe78bSCy Schubert    Display the value of the encryption key in each keytab entry in
95*7f2fe78bSCy Schubert    the keytab file.
96*7f2fe78bSCy Schubert
97*7f2fe78bSCy Schubert**-d**
98*7f2fe78bSCy Schubert    Display the authdata types (if any) for each entry.
99*7f2fe78bSCy Schubert
100*7f2fe78bSCy Schubert**-V**
101*7f2fe78bSCy Schubert    Display the Kerberos version number and exit.
102*7f2fe78bSCy Schubert
103*7f2fe78bSCy SchubertIf *cache_name* or *keytab_name* is not specified, klist will display
104*7f2fe78bSCy Schubertthe credentials in the default credentials cache or keytab file as
105*7f2fe78bSCy Schubertappropriate.  If the **KRB5CCNAME** environment variable is set, its
106*7f2fe78bSCy Schubertvalue is used to locate the default ticket cache.
107*7f2fe78bSCy Schubert
108*7f2fe78bSCy Schubert
109*7f2fe78bSCy SchubertENVIRONMENT
110*7f2fe78bSCy Schubert-----------
111*7f2fe78bSCy Schubert
112*7f2fe78bSCy SchubertSee :ref:`kerberos(7)` for a description of Kerberos environment
113*7f2fe78bSCy Schubertvariables.
114*7f2fe78bSCy Schubert
115*7f2fe78bSCy Schubert
116*7f2fe78bSCy SchubertFILES
117*7f2fe78bSCy Schubert-----
118*7f2fe78bSCy Schubert
119*7f2fe78bSCy Schubert|ccache|
120*7f2fe78bSCy Schubert    Default location of Kerberos 5 credentials cache
121*7f2fe78bSCy Schubert
122*7f2fe78bSCy Schubert|keytab|
123*7f2fe78bSCy Schubert    Default location for the local host's keytab file.
124*7f2fe78bSCy Schubert
125*7f2fe78bSCy Schubert
126*7f2fe78bSCy SchubertSEE ALSO
127*7f2fe78bSCy Schubert--------
128*7f2fe78bSCy Schubert
129*7f2fe78bSCy Schubert:ref:`kinit(1)`, :ref:`kdestroy(1)`, :ref:`kerberos(7)`
130