xref: /freebsd/crypto/heimdal/lib/krb5/krb5_get_forwarded_creds.3 (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1.\" Copyright (c) 2004 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 July 26, 2004
35.Dt KRB5_GET_FORWARDED_CREDS 3
36.Os HEIMDAL
37.Sh NAME
38.Nm krb5_get_forwarded_creds ,
39.Nm krb5_fwd_tgt_creds
40.Nd get forwarded credentials from the KDC
41.Sh LIBRARY
42Kerberos 5 Library (libkrb5, -lkrb5)
43.Sh SYNOPSIS
44.In krb5.h
45.Ft krb5_error_code
46.Fo krb5_get_forwarded_creds
47.Fa "krb5_context context"
48.Fa "krb5_auth_context auth_context"
49.Fa "krb5_ccache ccache"
50.Fa "krb5_flags flags"
51.Fa "const char *hostname"
52.Fa "krb5_creds *in_creds"
53.Fa "krb5_data *out_data"
54.Fc
55.Ft krb5_error_code
56.Fo krb5_fwd_tgt_creds
57.Fa "krb5_context context"
58.Fa "krb5_auth_context auth_context"
59.Fa "const char *hostname"
60.Fa "krb5_principal client"
61.Fa "krb5_principal server"
62.Fa "krb5_ccache ccache"
63.Fa "int forwardable"
64.Fa "krb5_data *out_data"
65.Fc
66.Sh DESCRIPTION
67.Fn krb5_get_forwarded_creds
68and
69.Fn krb5_fwd_tgt_creds
70get tickets forwarded to
71.Fa hostname.
72If the tickets that are forwarded are address-less, the forwarded
73tickets will also be address-less, otherwise
74.Fa hostname
75will be used for figure out the address to forward the ticket too.
76.Sh SEE ALSO
77.Xr krb5 3 ,
78.Xr krb5_get_credentials 3 ,
79.Xr krb5.conf 5
80