crypto/dist/heimdal/lib/krb5/krb5_ticket.3

   1 .\" Copyright (c) 2003 - 2004 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $Heimdal: krb5_ticket.3 19543 2006-12-28 20:48:50Z lha $
  33 .\" $NetBSD$
  34 .\"
  35 .Dd May  1, 2006
  36 .Dt KRB5_TICKET 3
  37 .Os
  38 .Sh NAME
  39 .Nm krb5_ticket ,
  40 .Nm krb5_free_ticket ,
  41 .Nm krb5_copy_ticket ,
  42 .Nm krb5_ticket_get_authorization_data_type ,
  43 .Nm krb5_ticket_get_client ,
  44 .Nm krb5_ticket_get_server ,
  45 .Nm krb5_ticket_get_endtime
  46 .Nd Kerberos 5 ticket access and handling functions
  47 .Sh LIBRARY
  48 Kerberos 5 Library (libkrb5, -lkrb5)
  49 .Sh SYNOPSIS
  50 .In krb5/krb5.h
  51 .Pp
  52 .Li krb5_ticket ;
  53 .Pp
  54 .Ft krb5_error_code
  55 .Fo krb5_free_ticket
  56 .Fa "krb5_context context"
  57 .Fa "krb5_ticket *ticket"
  58 .Fc
  59 .Ft krb5_error_code
  60 .Fo krb5_copy_ticket
  61 .Fa "krb5_context context"
  62 .Fa "const krb5_ticket *from"
  63 .Fa "krb5_ticket **to"
  64 .Fc
  65 .Ft krb5_error_code
  66 .Fo krb5_ticket_get_authorization_data_type
  67 .Fa "krb5_context context"
  68 .Fa "krb5_ticket *ticket"
  69 .Fa "int type"
  70 .Fa "krb5_data *data"
  71 .Fc
  72 .Ft krb5_error_code
  73 .Fo krb5_ticket_get_client
  74 .Fa "krb5_context context"
  75 .Fa "const krb5_ticket *ticket"
  76 .Fa "krb5_principal *client"
  77 .Fc
  78 .Ft krb5_error_code
  79 .Fo krb5_ticket_get_server
  80 .Fa "krb5_context context"
  81 .Fa "const krb5_ticket *ticket"
  82 .Fa "krb5_principal *server"
  83 .Fc
  84 .Ft time_t
  85 .Fo krb5_ticket_get_endtime
  86 .Fa "krb5_context context"
  87 .Fa "const krb5_ticket *ticket"
  88 .Fc
  89 .Sh DESCRIPTION
  90 .Li krb5_ticket
  91 holds a kerberos ticket.
  92 The internals of the structure should never be accessed directly,
  93 functions exist for extracting information.
  94 .Pp
  95 .Fn krb5_free_ticket
  96 frees the
  97 .Fa ticket
  98 and its content.
  99 Used to free the result of
 100 .Fn krb5_copy_ticket
 101 and
 102 .Fn krb5_recvauth .
 103 .Pp
 104 .Fn krb5_copy_ticket
 105 copies the content of the ticket
 106 .Fa from
 107 to the ticket
 108 .Fa to .
 109 The result
 110 .Fa to
 111 should be freed with
 112 .Fn krb5_free_ticket .
 113 .Pp
 114 .Fn krb5_ticket_get_authorization_data_type
 115 fetches the authorization data of the type
 116 .Fa type
 117 from the
 118 .Fa ticket .
 119 If there isn't any authorization data of type
 120 .Fa type ,
 121 .Dv ENOENT
 122 is returned.
 123 .Fa data
 124 needs to be freed with
 125 .Fn krb5_data_free
 126 on success.
 127 .Pp
 128 .Fn krb5_ticket_get_client
 129 and
 130 .Fn krb5_ticket_get_server
 131 returns a copy of the client/server principal from the ticket.
 132 The principal returned should be free using
 133 .Xr krb5_free_principal 3 .
 134 .Pp
 135 .Fn krb5_ticket_get_endtime
 136 return the end time of the ticket.
 137 .Sh SEE ALSO
 138 .Xr krb5 3