.\" Copyright (c) 2003 - 2004 Kungliga Tekniska Högskolan
.\" (Royal Institute of Technology, Stockholm, Sweden).
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" 3. Neither the name of the Institute nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: krb5_ticket.3 19543 2006-12-28 20:48:50Z lha $
.\"
.Dd May  1, 2006
.Dt KRB5_TICKET 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_ticket ,
.Nm krb5_free_ticket ,
.Nm krb5_copy_ticket ,
.Nm krb5_ticket_get_authorization_data_type ,
.Nm krb5_ticket_get_client ,
.Nm krb5_ticket_get_server ,
.Nm krb5_ticket_get_endtime
.Nd Kerberos 5 ticket access and handling functions
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.In krb5.h
.Pp
.Li krb5_ticket ;
.Pp
.Ft krb5_error_code
.Fo krb5_free_ticket
.Fa "krb5_context context"
.Fa "krb5_ticket *ticket"
.Fc
.Ft krb5_error_code
.Fo krb5_copy_ticket
.Fa "krb5_context context"
.Fa "const krb5_ticket *from"
.Fa "krb5_ticket **to"
.Fc
.Ft krb5_error_code
.Fo krb5_ticket_get_authorization_data_type
.Fa "krb5_context context"
.Fa "krb5_ticket *ticket"
.Fa "int type"
.Fa "krb5_data *data"
.Fc
.Ft krb5_error_code
.Fo krb5_ticket_get_client
.Fa "krb5_context context"
.Fa "const krb5_ticket *ticket"
.Fa "krb5_principal *client"
.Fc
.Ft krb5_error_code
.Fo krb5_ticket_get_server
.Fa "krb5_context context"
.Fa "const krb5_ticket *ticket"
.Fa "krb5_principal *server"
.Fc
.Ft time_t
.Fo krb5_ticket_get_endtime
.Fa "krb5_context context"
.Fa "const krb5_ticket *ticket"
.Fc
.Sh DESCRIPTION
.Li krb5_ticket
holds a kerberos ticket.
The internals of the structure should never be accessed directly,
functions exist for extracting information.
.Pp
.Fn krb5_free_ticket
frees the
.Fa ticket
and its content.
Used to free the result of
.Fn krb5_copy_ticket
and
.Fn krb5_recvauth .
.Pp
.Fn krb5_copy_ticket
copies the content of the ticket
.Fa from
to the ticket
.Fa to .
The result
.Fa to
should be freed with
.Fn krb5_free_ticket .
.Pp
.Fn krb5_ticket_get_authorization_data_type
fetches the authorization data of the type
.Fa type
from the
.Fa ticket .
If there isn't any authorization data of type
.Fa type ,
.Dv ENOENT
is returned.
.Fa data
needs to be freed with
.Fn krb5_data_free
on success.
.Pp
.Fn krb5_ticket_get_client
and
.Fn krb5_ticket_get_server
returns a copy of the client/server principal from the ticket.
The principal returned should be free using
.Xr krb5_free_principal 3 .
.Pp
.Fn krb5_ticket_get_endtime
return the end time of the ticket.
.Sh SEE ALSO
.Xr krb5 3