xref: /freebsd/crypto/heimdal/lib/krb5/krb5_creds.3 (revision 6a068746777241722b2b32c5d0bc443a2a64d80b)

.\" Copyright (c) 2004, 2006 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$
.\"
.Dd May  1, 2006
.Dt KRB5_CREDS 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_creds ,
.Nm krb5_copy_creds ,
.Nm krb5_copy_creds_contents ,
.Nm krb5_free_creds ,
.Nm krb5_free_cred_contents
.Nd Kerberos 5 credential handling functions
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.In krb5.h
.Ft krb5_error_code
.Fo krb5_copy_creds
.Fa "krb5_context context"
.Fa "const krb5_creds *incred"
.Fa "krb5_creds **outcred"
.Fc
.Ft krb5_error_code
.Fo krb5_copy_creds_contents
.Fa "krb5_context context"
.Fa "const krb5_creds *incred"
.Fa "krb5_creds *outcred"
.Fc
.Ft krb5_error_code
.Fo krb5_free_creds
.Fa "krb5_context context"
.Fa "krb5_creds *outcred"
.Fc
.Ft krb5_error_code
.Fo krb5_free_cred_contents
.Fa "krb5_context context"
.Fa "krb5_creds *cred"
.Fc
.Sh DESCRIPTION
.Vt krb5_creds
holds Kerberos credentials:
.Bd -literal -offset
typedef struct krb5_creds {
    krb5_principal	client;
    krb5_principal	server;
    krb5_keyblock	session;
    krb5_times		times;
    krb5_data		ticket;
    krb5_data		second_ticket;
    krb5_authdata	authdata;
    krb5_addresses	addresses;
    krb5_ticket_flags	flags;
} krb5_creds;
.Ed
.Pp
.Fn krb5_copy_creds
makes a copy of
.Fa incred
to
.Fa outcred .
.Fa outcred
should be freed with
.Fn krb5_free_creds
by the caller.
.Pp
.Fn krb5_copy_creds_contents
makes a copy of the content of
.Fa incred
to
.Fa outcreds .
.Fa outcreds
should be freed by the called with
.Fn krb5_free_creds_contents .
.Pp
.Fn krb5_free_creds
frees the content of the
.Fa cred
structure and the structure itself.
.Pp
.Fn krb5_free_cred_contents
frees the content of the
.Fa cred
structure.
.Sh SEE ALSO
.Xr krb5 3 ,
.Xr krb5_compare_creds 3 ,
.Xr krb5_get_init_creds 3 ,
.Xr kerberos 8