doc/xml/AdminReference/sect8/kas_listtickets.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="kas_listtickets8">
   3   <refmeta>
   4     <refentrytitle>kas listtickets</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>kas listtickets</refname>
   9     <refpurpose>Displays all of the issuer's tickets (tokens)</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">kas listtickets</emphasis> [<emphasis role="bold">-name</emphasis> &lt;<emphasis>name of server</emphasis>&gt;] [<emphasis role="bold">-long</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  14
  15     <para><emphasis role="bold">kas listt</emphasis> [<emphasis role="bold">-n</emphasis> &lt;<emphasis>name of server</emphasis>&gt;] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  16
  17   </refsect1>
  18   <refsect1>
  19     <title>Description</title>
  20     <para>The <emphasis role="bold">kas listtickets</emphasis> command displays the associated user ID (AFS UID),
  21     cell name, and expiration date of some or all of the issuer's tickets
  22     (tokens), depending on which options are provided:</para>
  23
  24     <itemizedlist>
  25       <listitem>
  26         <para>To display all tokens, provide neither the <emphasis role="bold">-name</emphasis> argument nor <emphasis role="bold">-long</emphasis>
  27         flag. The output is similar to that of the <emphasis role="bold">tokens</emphasis> command.</para>
  28
  29       </listitem>
  30       <listitem>
  31         <para>To display a single token, provide the <emphasis role="bold">-name</emphasis> argument to specify name
  32         of the Authentication Database entry for the entity that accepts the
  33         token. All AFS server processes accept tokens sealed with the key from the
  34         <computeroutput>afs</computeroutput> entry.</para>
  35
  36       </listitem>
  37       <listitem>
  38         <para>To display in addition the octal numbers that constitute the token and
  39         session key, provide the <emphasis role="bold">-long</emphasis> flag.</para>
  40
  41       </listitem>
  42     </itemizedlist>
  43   </refsect1>
  44   <refsect1>
  45     <title>Options</title>
  46     <variablelist>
  47       <varlistentry>
  48         <term><emphasis role="bold">-name</emphasis> &lt;<emphasis>name of server</emphasis>&gt;</term>
  49         <listitem>
  50           <para>Names the Authentication Database entry of the entity (usually a server
  51           process) that accepts the token to display.</para>
  52
  53         </listitem>
  54       </varlistentry>
  55       <varlistentry>
  56         <term><emphasis role="bold">-long</emphasis></term>
  57         <listitem>
  58           <para>Displays the octal numbers that constitute the session key and ticket.</para>
  59
  60         </listitem>
  61       </varlistentry>
  62       <varlistentry>
  63         <term><emphasis role="bold">-help</emphasis></term>
  64         <listitem>
  65           <para>Prints the online help for this command. All other valid options are
  66           ignored.</para>
  67
  68         </listitem>
  69       </varlistentry>
  70     </variablelist>
  71   </refsect1>
  72   <refsect1>
  73     <title>Output</title>
  74     <para>The output reports the AFS UID of the user who owns the token, the service
  75     (usually, <computeroutput>afs</computeroutput>) and cell for which it is valid, and its expiration date,
  76     using the following format. If the message does not specify a cell, the
  77     ticket is for the local cell.</para>
  78
  79 <programlisting>
  80    User's (AFS ID &amp;lt;AFS UID&amp;gt;) tokens for &amp;lt;service&amp;gt;[@&amp;lt;cellname&amp;gt;] \
  81        [Expires &amp;lt;date&amp;gt;]
  82
  83 </programlisting>
  84       <para>If the <emphasis role="bold">-long</emphasis> flag is provided, the output also includes the octal
  85       numbers making up the session key and token, along with the key version
  86       number and the number of bytes in the token (if the number of bytes is not
  87       56, there is an error).</para>
  88
  89       <para>If the marker <computeroutput>[&gt;&gt; POSTDATED &lt;]</computeroutput> appears instead of an expiration
  90       date, the ticket does not become valid until the indicated time. (Only
  91       internal calls can create a postdated ticket; there is no standard
  92       interface that allows users to do this.)</para>
  93
  94     </refsect1>
  95     <refsect1>
  96       <title>Examples</title>
  97       <para>The following two examples are for a user with AFS UID 1020 in the
  98       <computeroutput>abc.com</computeroutput> cell and AFS UID 35 in the <computeroutput>test.abc.com</computeroutput> cell. He is working
  99       on a machine in the first cell and is authenticated in both cells.</para>
 100
 101 <programlisting>
 102    % kas listtickets
 103    User's (AFS ID 1020) tokens for afs [Expires Wed Mar 31 9:30:54 1999]
 104    User's (AFS ID 35@test.abc.com) tokens for afs@test.abc.com \
 105              [Expires Wed Mar 31 13:54:26 1999]
 106
 107 </programlisting>
 108 <programlisting>
 109    % kas listtickets -name afs -long
 110    User's (AFS ID 1020) tokens for afs [Expires Wed Mar 31 9:30:54 1999]
 111    SessionKey: \375\205\351\227\032\310\263\013
 112    Ticket: (kvno = 0, len = 56): \033\005\221\156\203\278\312\058\016\133...
 113
 114 </programlisting>
 115         </refsect1>
 116         <refsect1>
 117           <title>Privilege Required</title>
 118           <para>None, and no password is required.</para>
 119
 120         </refsect1>
 121         <refsect1>
 122           <title>See Also</title>
 123           <para><link linkend="kas8">kas(8)</link>,
 124           <link linkend="tokens1">tokens(1)</link></para>
 125
 126         </refsect1>
 127         <refsect1>
 128           <title>Copyright</title>
 129           <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 130
 131           <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 132           converted from HTML to POD by software written by Chas Williams and Russ
 133           Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 134
 135         </refsect1>
 136       </refentry>