e3a5da424a8d89ca0615296d67233026d3bf7eec
[platform/upstream/krb5.git] / doc / html / _sources / appdev / refs / api / krb5_mk_req.txt
1 krb5_mk_req -  Create a KRB_AP_REQ message. 
2 ============================================
3
4 ..
5
6 .. c:function:: krb5_error_code krb5_mk_req(krb5_context context, krb5_auth_context * auth_context, krb5_flags ap_req_options, char * service, char * hostname, krb5_data * in_data, krb5_ccache ccache, 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** - :data:`AP_OPTS` options
18
19                   **[in]** **service** - Service name, or NULL to use **"host"**
20
21                   **[in]** **hostname** - Host name, or NULL to use local hostname
22
23                   **[in]** **in_data** - Application data to be checksummed in the authenticator, or NULL
24
25                   **[in]** **ccache** - Credential cache used to obtain credentials for the desired service.
26
27                   **[out]** **outbuf** - **AP-REQ** message
28
29
30 ..
31
32
33 :retval:
34          -   0   Success; otherwise - Kerberos error codes
35
36
37 ..
38
39
40
41
42
43
44
45 This function is similar to :c:func:`krb5_mk_req_extended()` except that it uses a given *hostname* , *service* , and *ccache* to construct a service principal name and obtain credentials.
46
47
48
49 Use :c:func:`krb5_free_data_contents()` to free *outbuf* when it is no longer needed.
50
51
52
53
54
55
56
57
58
59
60 ..
61
62
63
64
65