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

   1 .\" Copyright (c) 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 .\" $Heimdal: krb5_get_creds.3 22071 2007-11-14 20:04:50Z lha $
  33 .\" $NetBSD: krb5_get_creds.3,v 1.1 2008/03/22 08:37:14 mlelstv Exp $
  34 .\"
  35 .Dd June 15, 2006
  36 .Dt KRB5_GET_CREDS 3
  37 .Os
  38 .Sh NAME
  39 .Nm krb5_get_creds ,
  40 .Nm krb5_get_creds_opt_add_options ,
  41 .Nm krb5_get_creds_opt_alloc ,
  42 .Nm krb5_get_creds_opt_free ,
  43 .Nm krb5_get_creds_opt_set_enctype ,
  44 .Nm krb5_get_creds_opt_set_impersonate ,
  45 .Nm krb5_get_creds_opt_set_options ,
  46 .Nm krb5_get_creds_opt_set_ticket
  47 .Nd get credentials from the KDC
  48 .Sh LIBRARY
  49 Kerberos 5 Library (libkrb5, -lkrb5)
  50 .Sh SYNOPSIS
  51 .In krb5/krb5.h
  52 .Ft krb5_error_code
  53 .Fo krb5_get_creds
  54 .Fa "krb5_context context"
  55 .Fa "krb5_get_creds_opt opt"
  56 .Fa "krb5_ccache ccache"
  57 .Fa "krb5_const_principal inprinc"
  58 .Fa "krb5_creds **out_creds"
  59 .Fc
  60 .Ft void
  61 .Fo krb5_get_creds_opt_add_options
  62 .Fa "krb5_context context"
  63 .Fa "krb5_get_creds_opt opt"
  64 .Fa "krb5_flags options"
  65 .Fc
  66 .Ft krb5_error_code
  67 .Fo krb5_get_creds_opt_alloc
  68 .Fa "krb5_context context"
  69 .Fa "krb5_get_creds_opt *opt"
  70 .Fc
  71 .Ft void
  72 .Fo krb5_get_creds_opt_free
  73 .Fa "krb5_context context"
  74 .Fa "krb5_get_creds_opt opt"
  75 .Fc
  76 .Ft void
  77 .Fo krb5_get_creds_opt_set_enctype
  78 .Fa "krb5_context context"
  79 .Fa "krb5_get_creds_opt opt"
  80 .Fa "krb5_enctype enctype"
  81 .Fc
  82 .Ft krb5_error_code
  83 .Fo krb5_get_creds_opt_set_impersonate
  84 .Fa "krb5_context context"
  85 .Fa "krb5_get_creds_opt opt"
  86 .Fa "krb5_const_principal self"
  87 .Fc
  88 .Ft void
  89 .Fo krb5_get_creds_opt_set_options
  90 .Fa "krb5_context context"
  91 .Fa "krb5_get_creds_opt opt"
  92 .Fa "krb5_flags options"
  93 .Fc
  94 .Ft krb5_error_code
  95 .Fo krb5_get_creds_opt_set_ticket
  96 .Fa "krb5_context context"
  97 .Fa "krb5_get_creds_opt opt"
  98 .Fa "const Ticket *ticket"
  99 .Fc
 100 .Sh DESCRIPTION
 101 .Fn krb5_get_creds
 102 fetches credentials specified by
 103 .Fa opt
 104 by first looking in the
 105 .Fa ccache ,
 106 and then it doesn't exists, fetch the credential from the KDC
 107 using the krbtgts in
 108 .Fa ccache .
 109 The credential is returned in
 110 .Fa out_creds
 111 and should be freed using the function
 112 .Fn krb5_free_creds .
 113 .Pp
 114 The structure
 115 .Li krb5_get_creds_opt
 116 controls the behavior of
 117 .Fn krb5_get_creds .
 118 The structure is opaque to consumers that can set the content of the
 119 structure with accessors functions. All accessor functions make copies
 120 of the data that is passed into accessor functions, so external
 121 consumers free the memory before calling
 122 .Fn krb5_get_creds .
 123 .Pp
 124 The structure
 125 .Li krb5_get_creds_opt
 126 is allocated with
 127 .Fn krb5_get_creds_opt_alloc
 128 and freed with
 129 .Fn krb5_get_creds_opt_free .
 130 The free function also frees the content of the structure set by the
 131 accessor functions.
 132 .Pp
 133 .Fn krb5_get_creds_opt_add_options
 134 and
 135 .Fn krb5_get_creds_opt_set_options
 136 adds and sets options to the
 137 .Vt krb5_get_creds_opt
 138 structure .
 139 The possible options to set are
 140 .Bl -tag -width "KRB5_GC_USER_USER" -compact
 141 .It KRB5_GC_CACHED
 142 Only check the
 143 .Fa ccache ,
 144 don't got out on network to fetch credential.
 145 .It KRB5_GC_USER_USER
 146 request a user to user ticket.
 147 This options doesn't store the resulting user to user credential in
 148 the
 149 .Fa ccache .
 150 .It KRB5_GC_EXPIRED_OK
 151 returns the credential even if it is expired, default behavior is trying
 152 to refetch the credential from the KDC.
 153 .It KRB5_GC_NO_STORE
 154 Do not store the resulting credentials in the
 155 .Fa ccache .
 156 .El
 157 .Pp
 158 .Fn krb5_get_creds_opt_set_enctype
 159 sets the preferred encryption type of the application. Don't set this
 160 unless you have to since if there is no match in the KDC, the function
 161 call will fail.
 162 .Pp
 163 .Fn krb5_get_creds_opt_set_impersonate
 164 sets the principal to impersonate., Returns a ticket that have the
 165 impersonation principal as a client and the requestor as the
 166 service. Note that the requested principal have to be the same as the
 167 client principal in the krbtgt.
 168 .Pp
 169 .Fn krb5_get_creds_opt_set_ticket
 170 sets the extra ticket used in user-to-user or contrained delegation use case.
 171 .Sh SEE ALSO
 172 .Xr krb5 3 ,
 173 .Xr krb5_get_credentials 3 ,
 174 .Xr krb5.conf 5