879c5b6bcc9a177fba83bacd876c17cbdfb687c3
[openafs.git] / doc / man-pages / pod8 / kas_listtickets.pod
1 =head1 NAME
2
3 kas listtickets - Displays all of the issuer's tickets (tokens)
4
5 =head1 SYNOPSIS
6
7 B<kas listtickets> [B<-name> <I<name of server>>] [B<-long>] [B<-help>]
8
9 B<kas listt> [B<-n> <I<name of server>>] [B<-l>] [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The B<kas listtickets> command displays the associated user ID (AFS UID),
14 cell name, and expiration date of some or all of the issuer's tickets
15 (tokens), depending on which options are provided:
16
17 =over 4
18
19 =item *
20
21 To display all tokens, provide neither the B<-name> argument nor B<-long>
22 flag. The output is similar to that of the B<tokens> command.
23
24 =item *
25
26 To display a single token, provide the B<-name> argument to specify name
27 of the Authentication Database entry for the entity that accepts the
28 token. All AFS server processes accept tokens sealed with the key from the
29 C<afs> entry.
30
31 =item *
32
33 To display in addition the octal numbers that constitute the token and
34 session key, provide the B<-long> flag.
35
36 =back
37
38 =head1 OPTIONS
39
40 =over 4
41
42 =item B<-name> <I<name of server>>
43
44 Names the Authentication Database entry of the entity (usually a server
45 process) that accepts the token to display.
46
47 =item B<-long>
48
49 Displays the octal numbers that constitute the session key and ticket.
50
51 =item B<-help>
52
53 Prints the online help for this command. All other valid options are
54 ignored.
55
56 =back
57
58 =head1 OUTPUT
59
60 The output reports the AFS UID of the user who owns the token, the service
61 (usually, C<afs>) and cell for which it is valid, and its expiration date,
62 using the following format. If the message does not specify a cell, the
63 ticket is for the local cell.
64
65    User's (AFS ID <AFS UID>) tokens for <service>[@<cellname>] \
66        [Expires <date>]
67
68 If the B<-long> flag is provided, the output also includes the octal
69 numbers making up the session key and token, along with the key version
70 number and the number of bytes in the token (if the number of bytes is not
71 56, there is an error).
72
73 If the marker C<<< [>> POSTDATED <] >>> appears instead of an expiration
74 date, the ticket does not become valid until the indicated time. (Only
75 internal calls can create a postdated ticket; there is no standard
76 interface that allows users to do this.)
77
78 =head1 EXAMPLES
79
80 The following two examples are for a user with AFS UID 1020 in the
81 C<abc.com> cell and AFS UID 35 in the C<test.abc.com> cell. He is working
82 on a machine in the first cell and is authenticated in both cells.
83
84    % kas listtickets
85    User's (AFS ID 1020) tokens for afs [Expires Wed Mar 31 9:30:54 1999]
86    User's (AFS ID 35@test.abc.com) tokens for afs@test.abc.com \
87              [Expires Wed Mar 31 13:54:26 1999]
88
89    % kas listtickets -name afs -long
90    User's (AFS ID 1020) tokens for afs [Expires Wed Mar 31 9:30:54 1999]
91    SessionKey: \375\205\351\227\032\310\263\013
92    Ticket: (kvno = 0, len = 56): \033\005\221\156\203\278\312\058\016\133...
93
94 =head1 PRIVILEGE REQUIRED
95
96 None, and no password is required.
97
98 =head1 SEE ALSO
99
100 L<kas(8)>,
101 L<tokens(1)>
102
103 =head1 COPYRIGHT
104
105 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
106
107 This documentation is covered by the IBM Public License Version 1.0.  It was
108 converted from HTML to POD by software written by Chas Williams and Russ
109 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.