Imported Upstream version 1.15.2
[platform/upstream/krb5.git] / doc / html / _sources / appdev / refs / api / krb5_mk_priv.txt
1 krb5_mk_priv -  Format a KRB-PRIV message. 
2 ===========================================
3
4 ..
5
6 .. c:function:: krb5_error_code krb5_mk_priv(krb5_context context, krb5_auth_context auth_context, const krb5_data * userdata, krb5_data * outbuf, krb5_replay_data * outdata)
7
8 ..
9
10
11 :param:
12
13                   **[in]** **context** - Library context
14
15                   **[in]** **auth_context** - Authentication context
16
17                   **[in]** **userdata** - User data for **KRB-PRIV** message
18
19                   **[out]** **outbuf** - Formatted **KRB-PRIV** message
20
21                   **[out]** **outdata** - Replay cache handle (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 This function is similar to :c:func:`krb5_mk_safe()` , but the message is encrypted and integrity-protected, not just integrity-protected.
40
41
42
43 The local address in *auth_context* must be set, and is used to form the sender address used in the KRB-SAFE message. The remote address is optional; if specified, it will be used to form the receiver address used in the message.
44
45
46
47  
48  
49          - :data:`KRB5_AUTH_CONTEXT_DO_TIME` - Use timestamps in *outdata* 
50  
51  
52          - :data:`KRB5_AUTH_CONTEXT_RET_TIME` - Copy timestamp to *outdata* .
53  
54  
55          - :data:`KRB5_AUTH_CONTEXT_DO_SEQUENCE` - Use local sequence numbers from *auth_context* in replay cache.
56  
57  
58          - :data:`KRB5_AUTH_CONTEXT_RET_SEQUENCE` - Use local sequence numbers from *auth_context* as a sequence number in the encrypted message *outbuf* .
59  
60  
61
62
63
64
65
66
67 ..
68
69
70
71
72
73
74 .. note::
75
76          If the :data:`KRB5_AUTH_CONTEXT_RET_TIME` or :data:`KRB5_AUTH_CONTEXT_RET_SEQUENCE` flag is set in *auth_context* , the *outdata* is required.
77
78          The flags from *auth_context* specify whether sequence numbers or timestamps will be used to identify the message. Valid values are:
79  
80
81
82