File: krb5_sendauth.txt

package info (click to toggle)
krb5 1.15-1%2Bdeb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 54,220 kB
  • ctags: 32,381
  • sloc: ansic: 310,596; cpp: 16,220; exp: 13,350; python: 7,990; makefile: 7,223; sh: 6,185; perl: 3,518; asm: 1,460; yacc: 1,006; xml: 503; awk: 396; csh: 147; lisp: 104; sed: 43
file content (98 lines) | stat: -rw-r--r-- 2,783 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
krb5_sendauth -  Client function for sendauth protocol. 
========================================================

..

.. c:function:: krb5_error_code krb5_sendauth(krb5_context context, krb5_auth_context * auth_context, krb5_pointer fd, char * appl_version, krb5_principal client, krb5_principal server, krb5_flags ap_req_options, krb5_data * in_data, krb5_creds * in_creds, krb5_ccache ccache, krb5_error ** error, krb5_ap_rep_enc_part ** rep_result, krb5_creds ** out_creds)

..


:param:

	          **[in]** **context** - Library context

	          **[inout]** **auth_context** - Pre-existing or newly created auth context

	          **[in]** **fd** - File descriptor that describes network socket

	          **[in]** **appl_version** - Application protocol version to be matched with the receiver's application version

	          **[in]** **client** - Client principal

	          **[in]** **server** - Server principal

	          **[in]** **ap_req_options** - :data:`AP_OPTS` options

	          **[in]** **in_data** - Data to be sent to the server

	          **[in]** **in_creds** - Input credentials, or NULL to use *ccache*

	          **[in]** **ccache** - Credential cache

	          **[out]** **error** - If non-null, contains KRB_ERROR message returned from server

	          **[out]** **rep_result** - If non-null and *ap_req_options* is :data:`AP_OPTS_MUTUAL_REQUIRED` , contains the result of mutual authentication exchange

	          **[out]** **out_creds** - If non-null, the retrieved credentials


..


:retval:
         -   0   Success; otherwise - Kerberos error codes


..







This function performs the client side of a sendauth/recvauth exchange by sending and receiving messages over *fd* .



Credentials may be specified in three ways:



 
 
	 - If *in_creds* is NULL, credentials are obtained with :c:func:`krb5_get_credentials()` using the principals *client* and *server* . *server* must be non-null; *client* may NULL to use the default principal of *ccache* .
 
 
 
	 - If *in_creds* is non-null, but does not contain a ticket, credentials for the exchange are obtained with :c:func:`krb5_get_credentials()` using *in_creds* . In this case, the values of *client* and *server* are unused.
 
 
 
	 - If *in_creds* is a complete credentials structure, it used directly. In this case, the values of *client* , *server* , and *ccache* are unused.
 
 If the server is using a different application protocol than that specified in *appl_version* , an error will be returned.



Use :c:func:`krb5_free_creds()` to free *out_creds* , :c:func:`krb5_free_ap_rep_enc_part()` to free *rep_result* , and :c:func:`krb5_free_error()` to free *error* when they are no longer needed.










..

.. seealso::
         :c:func:`krb5_recvauth()`