torture: convert torture_comment() -> torture_result() so we can knownfail flapping...
[Samba/wip.git] / source4 / winbind / wb_server.h
blobea93de60c83edb8f5e67b64dbe5d87594301c85c
1 /*
2 Unix SMB/CIFS implementation.
3 Main winbindd server routines
5 Copyright (C) Stefan Metzmacher 2005
6 Copyright (C) Andrew Tridgell 2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "nsswitch/winbind_nss_config.h"
23 #include "nsswitch/winbind_struct_protocol.h"
24 #include "winbind/idmap.h"
25 #include "libnet/libnet.h"
27 /* this struct stores global data for the winbind task */
28 struct wbsrv_service {
29 struct task_server *task;
31 const struct dom_sid *primary_sid;
32 enum netr_SchannelType sec_channel_type;
33 struct wbsrv_domain *domains;
34 struct idmap_context *idmap_ctx;
35 const char *priv_pipe_dir;
36 const char *pipe_dir;
38 struct wbsrv_connection *broken_connections;
41 struct wbsrv_samconn {
42 struct wbsrv_domain *domain;
43 void *private_data;
45 struct composite_context (*seqnum_send)(struct wbsrv_samconn *);
46 NTSTATUS (*seqnum_recv)(struct composite_context *, uint64_t *);
49 struct wb_dom_info {
50 const char *name;
51 const char *dns_name;
52 const struct dom_sid *sid;
53 struct nbt_dc_name *dc;
56 struct wbsrv_domain {
57 struct wbsrv_domain *next, *prev;
59 struct wbsrv_service *service;
61 struct wb_dom_info *info;
63 /* Details for the server we are currently talking to */
64 const char *dc_address;
65 const char *dc_name;
67 struct libnet_context *libnet_ctx;
69 struct dcerpc_binding *lsa_binding;
71 struct dcerpc_binding *samr_binding;
73 struct dcerpc_pipe *netlogon_pipe;
74 struct dcerpc_binding *netlogon_binding;
75 /* netlogon_creds usage needs to be queued */
76 struct tevent_queue *netlogon_queue;
80 state of a listen socket and it's protocol information
82 struct wbsrv_listen_socket {
83 const char *socket_path;
84 struct wbsrv_service *service;
85 bool privileged;
89 state of an open winbind connection
91 struct wbsrv_connection {
92 /* for the broken_connections DLIST */
93 struct wbsrv_connection *prev, *next;
95 /* stream connection we belong to */
96 struct stream_connection *conn;
98 /* the listening socket we belong to, it holds protocol hooks */
99 struct wbsrv_listen_socket *listen_socket;
101 /* storage for protocol specific data */
102 void *protocol_private_data;
104 /* how many calls are pending (do not terminate the connection with calls pending a reply) */
105 uint32_t pending_calls;
107 /* is this connection pending termination? If so, why? */
108 const char *terminate;
110 struct tstream_context *tstream;
112 struct tevent_queue *send_queue;
114 struct loadparm_context *lp_ctx;
117 #define WBSRV_SAMBA3_SET_STRING(dest, src) do { \
118 memset(dest, 0, sizeof(dest));\
119 strlcpy((dest), (src) ? (src) : "", sizeof(dest));\
120 } while(0)
123 state of a pwent query
125 struct wbsrv_pwent {
126 /* Current UserList structure, contains 1+ user structs */
127 struct libnet_UserList *user_list;
129 /* Index of the next user struct in the current UserList struct */
130 uint32_t page_index;
132 /* The libnet_ctx to use for the libnet_UserList call */
133 struct libnet_context *libnet_ctx;
136 state of a grent query
138 struct wbsrv_grent {
139 /* Current UserList structure, contains 1+ user structs */
140 struct libnet_GroupList *group_list;
142 /* Index of the next user struct in the current UserList struct */
143 uint32_t page_index;
145 /* The libnet_ctx to use for the libnet_UserList call */
146 struct libnet_context *libnet_ctx;
150 state of one request
152 NOTE about async replies:
153 if the backend wants to reply later:
155 - it should set the WBSRV_CALL_FLAGS_REPLY_ASYNC flag, and may set a
156 talloc_destructor on the this structure or on the private_data (if it's a
157 talloc child of this structure), so that wbsrv_terminate_connection
158 called by another call clean up the whole connection correct.
159 - When the backend is ready to reply it should call wbsrv_send_reply(call),
160 wbsrv_send_reply implies talloc_free(call), so the backend should use
161 talloc_reference(call), if it needs it later.
162 - If wbsrv_send_reply doesn't return NT_STATUS_OK, the backend function
163 should call, wbsrv_terminate_connection(call->wbconn, nt_errstr(status));
164 return;
167 struct wbsrv_samba3_call {
168 #define WBSRV_CALL_FLAGS_REPLY_ASYNC 0x00000001
169 uint32_t flags;
171 /* the connection the call belongs to */
172 struct wbsrv_connection *wbconn;
174 /* here the backend can store stuff like composite_context's ... */
175 void *private_data;
177 /* the request structure of the samba3 protocol */
178 struct winbindd_request *request;
180 /* the response structure of the samba3 protocol*/
181 struct winbindd_response *response;
183 DATA_BLOB in;
184 DATA_BLOB out;
185 struct iovec out_iov[1];
188 struct netr_LMSessionKey;
189 struct netr_UserSessionKey;
190 struct winbind_SamLogon;
191 struct winbind_DsrUpdateReadOnlyServerDnsRecords;
193 #include "winbind/wb_async_helpers.h"
194 #include "winbind/wb_proto.h"