docs: use the entities popt.common.samba.server and stdarg.help in samba(8)
[Samba.git] / source4 / winbind / wb_server.h
blob9b03004b28558953fbbd1c55edb72a5995632d5f
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;
39 struct wbsrv_samconn {
40 struct wbsrv_domain *domain;
41 void *private_data;
43 struct composite_context (*seqnum_send)(struct wbsrv_samconn *);
44 NTSTATUS (*seqnum_recv)(struct composite_context *, uint64_t *);
47 struct wb_dom_info {
48 const char *name;
49 const char *dns_name;
50 const struct dom_sid *sid;
51 struct nbt_dc_name *dc;
54 struct wbsrv_domain {
55 struct wbsrv_domain *next, *prev;
57 struct wb_dom_info *info;
59 /* Details for the server we are currently talking to */
60 const char *dc_address;
61 const char *dc_name;
63 struct libnet_context *libnet_ctx;
65 struct dcerpc_binding *lsa_binding;
67 struct dcerpc_binding *samr_binding;
69 struct dcerpc_pipe *netlogon_pipe;
70 struct dcerpc_binding *netlogon_binding;
71 /* netlogon_creds usage needs to be queued */
72 struct tevent_queue *netlogon_queue;
76 state of a listen socket and it's protocol information
78 struct wbsrv_listen_socket {
79 const char *socket_path;
80 struct wbsrv_service *service;
81 bool privileged;
85 state of an open winbind connection
87 struct wbsrv_connection {
88 /* stream connection we belong to */
89 struct stream_connection *conn;
91 /* the listening socket we belong to, it holds protocol hooks */
92 struct wbsrv_listen_socket *listen_socket;
94 /* storage for protocol specific data */
95 void *protocol_private_data;
97 /* how many calls are pending */
98 uint32_t pending_calls;
100 struct tstream_context *tstream;
102 struct tevent_queue *send_queue;
104 struct loadparm_context *lp_ctx;
107 #define WBSRV_SAMBA3_SET_STRING(dest, src) do { \
108 memset(dest, 0, sizeof(dest));\
109 strlcpy((dest), (src) ? (src) : "", sizeof(dest));\
110 } while(0)
113 state of a pwent query
115 struct wbsrv_pwent {
116 /* Current UserList structure, contains 1+ user structs */
117 struct libnet_UserList *user_list;
119 /* Index of the next user struct in the current UserList struct */
120 uint32_t page_index;
122 /* The libnet_ctx to use for the libnet_UserList call */
123 struct libnet_context *libnet_ctx;
126 state of a grent query
128 struct wbsrv_grent {
129 /* Current UserList structure, contains 1+ user structs */
130 struct libnet_GroupList *group_list;
132 /* Index of the next user struct in the current UserList struct */
133 uint32_t page_index;
135 /* The libnet_ctx to use for the libnet_UserList call */
136 struct libnet_context *libnet_ctx;
140 state of one request
142 NOTE about async replies:
143 if the backend wants to reply later:
145 - it should set the WBSRV_CALL_FLAGS_REPLY_ASYNC flag, and may set a
146 talloc_destructor on the this structure or on the private_data (if it's a
147 talloc child of this structure), so that wbsrv_terminate_connection
148 called by another call clean up the whole connection correct.
149 - When the backend is ready to reply it should call wbsrv_send_reply(call),
150 wbsrv_send_reply implies talloc_free(call), so the backend should use
151 talloc_reference(call), if it needs it later.
152 - If wbsrv_send_reply doesn't return NT_STATUS_OK, the backend function
153 should call, wbsrv_terminate_connection(call->wbconn, nt_errstr(status));
154 return;
157 struct wbsrv_samba3_call {
158 #define WBSRV_CALL_FLAGS_REPLY_ASYNC 0x00000001
159 uint32_t flags;
161 /* the connection the call belongs to */
162 struct wbsrv_connection *wbconn;
164 /* here the backend can store stuff like composite_context's ... */
165 void *private_data;
167 /* the request structure of the samba3 protocol */
168 struct winbindd_request *request;
170 /* the response structure of the samba3 protocol*/
171 struct winbindd_response *response;
173 DATA_BLOB in;
174 DATA_BLOB out;
175 struct iovec out_iov[1];
178 struct netr_LMSessionKey;
179 struct netr_UserSessionKey;
180 struct winbind_SamLogon;
181 struct winbind_DsrUpdateReadOnlyServerDnsRecords;
183 #include "winbind/wb_async_helpers.h"
184 #include "winbind/wb_proto.h"