WHATSNEW: Add release notes for Samba 4.1.19.
[Samba.git] / source4 / winbind / wb_server.h
blob26c404d12bdb2f684186820c7ff62c93fb4eb638
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 wb_dom_info *info;
61 /* Details for the server we are currently talking to */
62 const char *dc_address;
63 const char *dc_name;
65 struct libnet_context *libnet_ctx;
67 struct dcerpc_binding *lsa_binding;
69 struct dcerpc_binding *samr_binding;
71 struct dcerpc_pipe *netlogon_pipe;
72 struct dcerpc_binding *netlogon_binding;
73 /* netlogon_creds usage needs to be queued */
74 struct tevent_queue *netlogon_queue;
78 state of a listen socket and it's protocol information
80 struct wbsrv_listen_socket {
81 const char *socket_path;
82 struct wbsrv_service *service;
83 bool privileged;
87 state of an open winbind connection
89 struct wbsrv_connection {
90 /* for the broken_connections DLIST */
91 struct wbsrv_connection *prev, *next;
93 /* stream connection we belong to */
94 struct stream_connection *conn;
96 /* the listening socket we belong to, it holds protocol hooks */
97 struct wbsrv_listen_socket *listen_socket;
99 /* storage for protocol specific data */
100 void *protocol_private_data;
102 /* how many calls are pending (do not terminate the connection with calls pending a reply) */
103 uint32_t pending_calls;
105 /* is this connection pending termination? If so, why? */
106 const char *terminate;
108 struct tstream_context *tstream;
110 struct tevent_queue *send_queue;
112 struct loadparm_context *lp_ctx;
115 #define WBSRV_SAMBA3_SET_STRING(dest, src) do { \
116 memset(dest, 0, sizeof(dest));\
117 strlcpy((dest), (src) ? (src) : "", sizeof(dest));\
118 } while(0)
121 state of a pwent query
123 struct wbsrv_pwent {
124 /* Current UserList structure, contains 1+ user structs */
125 struct libnet_UserList *user_list;
127 /* Index of the next user struct in the current UserList struct */
128 uint32_t page_index;
130 /* The libnet_ctx to use for the libnet_UserList call */
131 struct libnet_context *libnet_ctx;
134 state of a grent query
136 struct wbsrv_grent {
137 /* Current UserList structure, contains 1+ user structs */
138 struct libnet_GroupList *group_list;
140 /* Index of the next user struct in the current UserList struct */
141 uint32_t page_index;
143 /* The libnet_ctx to use for the libnet_UserList call */
144 struct libnet_context *libnet_ctx;
148 state of one request
150 NOTE about async replies:
151 if the backend wants to reply later:
153 - it should set the WBSRV_CALL_FLAGS_REPLY_ASYNC flag, and may set a
154 talloc_destructor on the this structure or on the private_data (if it's a
155 talloc child of this structure), so that wbsrv_terminate_connection
156 called by another call clean up the whole connection correct.
157 - When the backend is ready to reply it should call wbsrv_send_reply(call),
158 wbsrv_send_reply implies talloc_free(call), so the backend should use
159 talloc_reference(call), if it needs it later.
160 - If wbsrv_send_reply doesn't return NT_STATUS_OK, the backend function
161 should call, wbsrv_terminate_connection(call->wbconn, nt_errstr(status));
162 return;
165 struct wbsrv_samba3_call {
166 #define WBSRV_CALL_FLAGS_REPLY_ASYNC 0x00000001
167 uint32_t flags;
169 /* the connection the call belongs to */
170 struct wbsrv_connection *wbconn;
172 /* here the backend can store stuff like composite_context's ... */
173 void *private_data;
175 /* the request structure of the samba3 protocol */
176 struct winbindd_request *request;
178 /* the response structure of the samba3 protocol*/
179 struct winbindd_response *response;
181 DATA_BLOB in;
182 DATA_BLOB out;
183 struct iovec out_iov[1];
186 struct netr_LMSessionKey;
187 struct netr_UserSessionKey;
188 struct winbind_SamLogon;
189 struct winbind_DsrUpdateReadOnlyServerDnsRecords;
191 #include "winbind/wb_async_helpers.h"
192 #include "winbind/wb_proto.h"