xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_tkt_creds_init.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_tkt_creds_init -  Create a context to get credentials from a KDC's Ticket Granting Service.
2=================================================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_tkt_creds_init(krb5_context context, krb5_ccache ccache, krb5_creds * creds, krb5_flags options, krb5_tkt_creds_context * ctx)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **ccache** - Credential cache handle
16
17	          **[in]** **creds** - Input credentials
18
19	          **[in]** **options** - Options (see KRB5_GC macros)
20
21	          **[out]** **ctx** - New TGS request context
22
23
24..
25
26
27:retval:
28         -   0   Success; otherwise - Kerberos error codes
29
30
31..
32
33
34
35
36
37
38
39This function prepares to obtain credentials matching *creds* , either by retrieving them from *ccache* or by making requests to ticket-granting services beginning with a ticket-granting ticket for the client principal's realm.
40
41
42
43The resulting TGS acquisition context can be used asynchronously with krb5_tkt_creds_step() or synchronously with krb5_tkt_creds_get(). See also krb5_get_credentials() for synchronous use.
44
45
46
47Use krb5_tkt_creds_free() to free *ctx* when it is no longer needed.
48
49
50
51
52
53
54
55
56
57
58..
59
60
61
62
63.. note::
64
65	 New in 1.9
66
67
68