lib/krb5/krb5_creds.3

   1 .\" Copyright (c) 2004, 2006 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 .\" $Id$
  33 .\"
  34 .Dd May  1, 2006
  35 .Dt KRB5_CREDS 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_creds ,
  39 .Nm krb5_copy_creds ,
  40 .Nm krb5_copy_creds_contents ,
  41 .Nm krb5_free_creds ,
  42 .Nm krb5_free_cred_contents
  43 .Nd Kerberos 5 credential handling functions
  44 .Sh LIBRARY
  45 Kerberos 5 Library (libkrb5, -lkrb5)
  46 .Sh SYNOPSIS
  47 .In krb5.h
  48 .Ft krb5_error_code
  49 .Fo krb5_copy_creds
  50 .Fa "krb5_context context"
  51 .Fa "const krb5_creds *incred"
  52 .Fa "krb5_creds **outcred"
  53 .Fc
  54 .Ft krb5_error_code
  55 .Fo krb5_copy_creds_contents
  56 .Fa "krb5_context context"
  57 .Fa "const krb5_creds *incred"
  58 .Fa "krb5_creds *outcred"
  59 .Fc
  60 .Ft krb5_error_code
  61 .Fo krb5_free_creds
  62 .Fa "krb5_context context"
  63 .Fa "krb5_creds *outcred"
  64 .Fc
  65 .Ft krb5_error_code
  66 .Fo krb5_free_cred_contents
  67 .Fa "krb5_context context"
  68 .Fa "krb5_creds *cred"
  69 .Fc
  70 .Sh DESCRIPTION
  71 .Vt krb5_creds
  72 holds Kerberos credentials:
  73 .Bd -literal -offset
  74 typedef struct krb5_creds {
  75     krb5_principal      client;
  76     krb5_principal      server;
  77     krb5_keyblock       session;
  78     krb5_times          times;
  79     krb5_data           ticket;
  80     krb5_data           second_ticket;
  81     krb5_authdata       authdata;
  82     krb5_addresses      addresses;
  83     krb5_ticket_flags   flags;
  84 } krb5_creds;
  85 .Ed
  86 .Pp
  87 .Fn krb5_copy_creds
  88 makes a copy of
  89 .Fa incred
  90 to
  91 .Fa outcred .
  92 .Fa outcred
  93 should be freed with
  94 .Fn krb5_free_creds
  95 by the caller.
  96 .Pp
  97 .Fn krb5_copy_creds_contents
  98 makes a copy of the content of
  99 .Fa incred
 100 to
 101 .Fa outcreds .
 102 .Fa outcreds
 103 should be freed by the called with
 104 .Fn krb5_free_creds_contents .
 105 .Pp
 106 .Fn krb5_free_creds
 107 frees the content of the
 108 .Fa cred
 109 structure and the structure itself.
 110 .Pp
 111 .Fn krb5_free_cred_contents
 112 frees the content of the
 113 .Fa cred
 114 structure.
 115 .Sh SEE ALSO
 116 .Xr krb5 3 ,
 117 .Xr krb5_compare_creds 3 ,
 118 .Xr krb5_get_init_creds 3 ,
 119 .Xr kerberos 8