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