krb5_get_credentials and friends
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@14067 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
124
lib/krb5/krb5_get_credentials.3
Normal file
124
lib/krb5/krb5_get_credentials.3
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
.\" Copyright (c) 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$
|
||||||
|
.\"
|
||||||
|
.Dd July 26, 2004
|
||||||
|
.Dt KRB5_GET_CREDENTIALS 3
|
||||||
|
.Os HEIMDAL
|
||||||
|
.Sh NAME
|
||||||
|
.Nm krb5_get_credentials ,
|
||||||
|
.Nm krb5_get_credentials_with_flags ,
|
||||||
|
.Nm krb5_get_cred_from_kdc ,
|
||||||
|
.Nm krb5_get_cred_from_kdc_opt
|
||||||
|
.Nd get credentials from the KDC using krbtgt
|
||||||
|
.Sh LIBRARY
|
||||||
|
Kerberos 5 Library (libkrb5, -lkrb5)
|
||||||
|
.Sh SYNOPSIS
|
||||||
|
.In krb5.h
|
||||||
|
.Ft krb5_error_code
|
||||||
|
.Fo krb5_get_credentials
|
||||||
|
.Fa "krb5_context context"
|
||||||
|
.Fa "krb5_flags options"
|
||||||
|
.Fa "krb5_ccache ccache"
|
||||||
|
.Fa "krb5_creds *in_creds"
|
||||||
|
.Fa "krb5_creds **out_creds"
|
||||||
|
.Fc
|
||||||
|
.Ft krb5_error_code
|
||||||
|
.Fo krb5_get_credentials
|
||||||
|
.Fa "krb5_context context"
|
||||||
|
.Fa "krb5_flags options"
|
||||||
|
.Fa "krb5_kdc_flags flags"
|
||||||
|
.Fa "krb5_ccache ccache"
|
||||||
|
.Fa "krb5_creds *in_creds"
|
||||||
|
.Fa "krb5_creds **out_creds"
|
||||||
|
.Fc
|
||||||
|
.Ft krb5_error_code
|
||||||
|
.Fo krb5_get_cred_from_kdc
|
||||||
|
.Fa "krb5_context context"
|
||||||
|
.Fa "krb5_ccache ccache"
|
||||||
|
.Fa "krb5_creds *in_creds"
|
||||||
|
.Fa "krb5_creds **out_creds"
|
||||||
|
.Fa "krb5_creds ***ret_tgts"
|
||||||
|
.Fc
|
||||||
|
.Ft krb5_error_code
|
||||||
|
.Fo krb5_get_cred_from_kdc_opt
|
||||||
|
.Fa "krb5_context context"
|
||||||
|
.Fa "krb5_ccache ccache"
|
||||||
|
.Fa "krb5_creds *in_creds"
|
||||||
|
.Fa "krb5_creds **out_creds"
|
||||||
|
.Fa "krb5_creds ***ret_tgts"
|
||||||
|
.Fa "krb5_flags flags"
|
||||||
|
.Fc
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
.Fn krb5_get_credentials_with_flags
|
||||||
|
get credentials by first looking in the
|
||||||
|
.Fa ccache
|
||||||
|
and then fetch the credential from the KDC using the krbtgt in
|
||||||
|
.Fa ccache .
|
||||||
|
Valid flags to pass into
|
||||||
|
.Fa options
|
||||||
|
argument are:
|
||||||
|
.Pp
|
||||||
|
.Bl -tag -width "KRB5_GC_USER_USER" -compact
|
||||||
|
.It KRB5_GC_CACHED
|
||||||
|
Only check the
|
||||||
|
.Fa ccache ,
|
||||||
|
don't got out on network to fetch credential.
|
||||||
|
.It KRB5_GC_USER_USER
|
||||||
|
request a user to user ticket.
|
||||||
|
This options doesn't store the resulting user to user credential in
|
||||||
|
the
|
||||||
|
.Fa ccache.
|
||||||
|
.El
|
||||||
|
.Pp
|
||||||
|
.Fa Flags
|
||||||
|
are KDCOptions, note the caller must fill in the bit-field and not
|
||||||
|
use the integer associated structure.
|
||||||
|
.Pp
|
||||||
|
.Fn krb5_get_credentials
|
||||||
|
works the same way as
|
||||||
|
.Fn krb5_get_credentials_with_flags
|
||||||
|
except that the
|
||||||
|
.Fa flags
|
||||||
|
field is missing.
|
||||||
|
.Pp
|
||||||
|
.Fn krb5_get_cred_from_kdc
|
||||||
|
and
|
||||||
|
.Fn krb5_get_cred_from_kdc_opt
|
||||||
|
fetches the credential from the KDC very much like
|
||||||
|
.Fn krb5_get_credentials, but doesn't look in the
|
||||||
|
.Fa ccache
|
||||||
|
if the credential exists there first.
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr krb5 3 ,
|
||||||
|
.Xr krb5_get_forwarded_creds 3 ,
|
||||||
|
.Xr krb5.conf 5
|
||||||
Reference in New Issue
Block a user