xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_mk_req_extended.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_mk_req_extended -  Create a KRB_AP_REQ message using supplied credentials.
2================================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_mk_req_extended(krb5_context context, krb5_auth_context * auth_context, krb5_flags ap_req_options, krb5_data * in_data, krb5_creds * in_creds, krb5_data * outbuf)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[inout]** **auth_context** - Pre-existing or newly created auth context
16
17	          **[in]** **ap_req_options** - Options (see AP_OPTS macros)
18
19	          **[in]** **in_data** - Application data to be checksummed in the authenticator, or NULL
20
21	          **[in]** **in_creds** - Credentials for the service with valid ticket and key
22
23	          **[out]** **outbuf** - **AP-REQ** message
24
25
26..
27
28
29:retval:
30         -   0   Success; otherwise - Kerberos error codes
31
32
33..
34
35
36
37
38
39
40
41Valid *ap_req_options* are:
42
43	 - #AP_OPTS_USE_SESSION_KEY - Use the session key when creating the request used for user to user authentication.
44
45
46	 - #AP_OPTS_MUTUAL_REQUIRED - Request a mutual authentication packet from the receiver.
47
48
49	 - #AP_OPTS_USE_SUBKEY - Generate a subsession key from the current session key obtained from the credentials.
50
51 This function creates a KRB_AP_REQ message using supplied credentials *in_creds* . *auth_context* may point to an existing auth context or to NULL, in which case a new one will be created. If *in_data* is non-null, a checksum of it will be included in the authenticator contained in the KRB_AP_REQ message. Use krb5_free_data_contents() to free *outbuf* when it is no longer needed.
52
53
54
55On successful return, the authenticator is stored in *auth_context* with the *client* and *checksum* fields nulled out. (This is to prevent pointer-sharing problems; the caller should not need these fields anyway, since the caller supplied them.)
56
57
58
59
60
61
62
63
64
65
66..
67
68.. seealso::
69         krb5_mk_req()
70
71
72
73
74
75