xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_rd_cred.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_rd_cred -  Read and validate a KRB-CRED message.
2======================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_rd_cred(krb5_context context, krb5_auth_context auth_context, krb5_data * creddata, krb5_creds *** creds_out, krb5_replay_data * rdata_out)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **auth_context** - Authentication context
16
17	          **[in]** **creddata** - **KRB-CRED** message
18
19	          **[out]** **creds_out** - Null-terminated array of forwarded credentials
20
21	          **[out]** **rdata_out** - Replay data (NULL if not needed)
22
23
24..
25
26
27:retval:
28         -   0   Success; otherwise - Kerberos error codes
29
30
31..
32
33
34
35
36
37
38
39 *creddata* will be decrypted using the receiving subkey if it is present in *auth_context* , or the session key if the receiving subkey is not present or fails to decrypt the message.
40
41
42
43Use krb5_free_tgt_creds() to free *creds_out* when it is no longer needed.
44
45
46
47
48
49
50
51
52
53
54..
55
56
57
58
59
60
61.. note::
62
63	 The *rdata_out* argument is required if the #KRB5_AUTH_CONTEXT_RET_TIME or #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in *auth_context* .`
64
65
66
67
68