s3:smbd: add support for async interim SMB2 responses and prepare SMB2 cancel
[metze/samba/wip.git] / source3 / smbd / globals.h
1 /*
2    Unix SMB/Netbios implementation.
3    smbd globals
4    Copyright (C) Stefan Metzmacher 2009
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #if defined(WITH_AIO)
21 struct aio_extra;
22 extern struct aio_extra *aio_list_head;
23 extern struct tevent_signal *aio_signal_event;
24 extern int aio_pending_size;
25 extern int outstanding_aio_calls;
26 #endif
27
28 /* dlink list we store pending lock records on. */
29 extern struct blocking_lock_record *blocking_lock_queue;
30
31 /* dlink list we move cancelled lock records onto. */
32 extern struct blocking_lock_record *blocking_lock_cancelled_queue;
33
34 /* The event that makes us process our blocking lock queue */
35 extern struct timed_event *brl_timeout;
36
37 extern bool blocking_lock_unlock_state;
38 extern bool blocking_lock_cancel_state;
39
40 #ifdef USE_DMAPI
41 struct smbd_dmapi_context;
42 extern struct smbd_dmapi_context *dmapi_ctx;
43 #endif
44
45 extern bool dfree_broken;
46
47 extern struct bitmap *dptr_bmap;
48 //struct dptr_struct;
49 extern struct dptr_struct *dirptrs;
50 extern int dirhandles_open;
51
52 /* how many write cache buffers have been allocated */
53 extern unsigned int allocated_write_caches;
54
55 extern int real_max_open_files;
56 extern struct bitmap *file_bmap;
57 extern files_struct *Files;
58 extern int files_used;
59 /* A singleton cache to speed up searching by dev/inode. */
60 struct fsp_singleton_cache {
61         files_struct *fsp;
62         struct file_id id;
63 };
64 extern struct fsp_singleton_cache fsp_fi_cache;
65 extern unsigned long file_gen_counter;
66 extern int first_file;
67
68 extern const struct mangle_fns *mangle_fns;
69
70 extern unsigned char *chartest;
71 extern TDB_CONTEXT *tdb_mangled_cache;
72
73 /* these tables are used to provide fast tests for characters */
74 extern unsigned char char_flags[256];
75 /*
76   this determines how many characters are used from the original filename
77   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
78   The largest possible value is 6.
79 */
80 extern unsigned mangle_prefix;
81 extern unsigned char base_reverse[256];
82
83 extern char *last_from;
84 extern char *last_to;
85
86 struct msg_state;
87 extern struct msg_state *smbd_msg_state;
88
89 extern bool logged_ioctl_message;
90
91 extern int trans_num;
92
93 extern pid_t mypid;
94 extern time_t last_smb_conf_reload_time;
95 extern time_t last_printer_reload_time;
96 /****************************************************************************
97  structure to hold a linked list of queued messages.
98  for processing.
99 ****************************************************************************/
100 struct pending_message_list;
101 extern struct pending_message_list *deferred_open_queue;
102 extern uint32_t common_flags2;
103
104 struct smb_srv_trans_enc_ctx;
105 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
106 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
107
108 struct sec_ctx {
109         UNIX_USER_TOKEN ut;
110         NT_USER_TOKEN *token;
111 };
112 /* A stack of security contexts.  We include the current context as being
113    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
114 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
115 extern int sec_ctx_stack_ndx;
116 extern bool become_uid_done;
117 extern bool become_gid_done;
118
119 extern connection_struct *last_conn;
120 extern uint16_t last_flags;
121
122 extern struct db_context *session_db_ctx_ptr;
123
124 extern uint32_t global_client_caps;
125
126 extern uint16_t fnf_handle;
127
128 struct conn_ctx {
129         connection_struct *conn;
130         uint16 vuid;
131 };
132 /* A stack of current_user connection contexts. */
133 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
134 extern int conn_ctx_stack_ndx;
135
136 struct vfs_init_function_entry;
137 extern struct vfs_init_function_entry *backends;
138 extern char *sparse_buf;
139 extern char *LastDir;
140
141 /* Current number of oplocks we have outstanding. */
142 extern int32_t exclusive_oplocks_open;
143 extern int32_t level_II_oplocks_open;
144 extern bool global_client_failed_oplock_break;
145 extern struct kernel_oplocks *koplocks;
146
147 extern struct notify_mid_map *notify_changes_by_mid;
148
149 extern int am_parent;
150 extern int server_fd;
151 extern struct event_context *smbd_event_ctx;
152 extern struct messaging_context *smbd_msg_ctx;
153 extern struct memcache *smbd_memcache_ctx;
154 extern bool exit_firsttime;
155 struct child_pid;
156 extern struct child_pid *children;
157 extern int num_children;
158
159 struct tstream_context;
160 struct smbd_smb2_request;
161 struct smbd_smb2_session;
162 struct smbd_smb2_tcon;
163
164 DATA_BLOB negprot_spnego(void);
165
166 NTSTATUS smb2_signing_sign_pdu(DATA_BLOB session_key,
167                                struct iovec *vector,
168                                int count);
169 NTSTATUS smb2_signing_check_pdu(DATA_BLOB session_key,
170                                 const struct iovec *vector,
171                                 int count);
172
173 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
174                                          const char *reason,
175                                          const char *location);
176 #define smbd_server_connection_terminate(sconn, reason) \
177         smbd_server_connection_terminate_ex(sconn, reason, __location__)
178
179 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
180
181 void reply_smb2002(struct smb_request *req, uint16_t choice);
182 void smbd_smb2_first_negprot(struct smbd_server_connection *conn,
183                              const uint8_t *inbuf, size_t size);
184
185 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
186                                     NTSTATUS status,
187                                     DATA_BLOB *info,
188                                     const char *location);
189 #define smbd_smb2_request_error(req, status) \
190         smbd_smb2_request_error_ex(req, status, NULL, __location__)
191 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
192                                    NTSTATUS status,
193                                    DATA_BLOB body, DATA_BLOB *dyn,
194                                    const char *location);
195 #define smbd_smb2_request_done(req, body, dyn) \
196         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
197
198 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
199                                      uint64_t file_id_persistent,
200                                      uint64_t file_id_volatile,
201                                      uint8_t oplock_level);
202
203 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req);
204
205 NTSTATUS smbd_smb2_request_check_session(struct smbd_smb2_request *req);
206 NTSTATUS smbd_smb2_request_check_tcon(struct smbd_smb2_request *req);
207
208 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
209
210 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
211 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
212 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
213 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
214 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
215 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
216 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
217 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
218 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
219 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
220 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
221 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
222
223 struct smbd_smb2_request {
224         struct smbd_smb2_request *prev, *next;
225
226         TALLOC_CTX *mem_pool;
227         struct smbd_smb2_request **parent;
228
229         struct smbd_server_connection *conn;
230
231         /* the session the request operates on, maybe NULL */
232         struct smbd_smb2_session *session;
233
234         /* the tcon the request operates on, maybe NULL */
235         struct smbd_smb2_tcon *tcon;
236
237         int current_idx;
238         bool do_signing;
239
240         struct files_struct *compat_chain_fsp;
241
242         NTSTATUS next_status;
243
244         struct {
245                 /* the NBT header is not allocated */
246                 uint8_t nbt_hdr[4];
247                 /*
248                  * vector[0] NBT
249                  * .
250                  * vector[1] SMB2
251                  * vector[2] fixed body
252                  * vector[3] dynamic body
253                  * .
254                  * .
255                  * .
256                  * vector[4] SMB2
257                  * vector[5] fixed body
258                  * vector[6] dynamic body
259                  * .
260                  * .
261                  * .
262                  */
263                 struct iovec *vector;
264                 int vector_count;
265         } in;
266         struct {
267                 /* the NBT header is not allocated */
268                 uint8_t nbt_hdr[4];
269                 /*
270                  * vector[0] NBT
271                  * .
272                  * vector[1] SMB2
273                  * vector[2] fixed body
274                  * vector[3] dynamic body
275                  * .
276                  * .
277                  * .
278                  * vector[4] SMB2
279                  * vector[5] fixed body
280                  * vector[6] dynamic body
281                  * .
282                  * .
283                  * .
284                  */
285                 struct iovec *vector;
286                 int vector_count;
287         } out;
288 };
289
290 struct smbd_server_connection;
291
292 struct smbd_smb2_session {
293         struct smbd_smb2_session *prev, *next;
294         struct smbd_server_connection *conn;
295         NTSTATUS status;
296         uint64_t vuid;
297         AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
298         struct auth_serversupplied_info *server_info;
299         DATA_BLOB session_key;
300         bool do_signing;
301
302         user_struct *compat_vuser;
303
304         struct {
305                 /* an id tree used to allocate tids */
306                 struct idr_context *idtree;
307
308                 /* this is the limit of tid values for this connection */
309                 uint32_t limit;
310
311                 struct smbd_smb2_tcon *list;
312         } tcons;
313 };
314
315 struct smbd_smb2_tcon {
316         struct smbd_smb2_tcon *prev, *next;
317         struct smbd_smb2_session *session;
318         uint32_t tid;
319         int snum;
320         connection_struct *compat_conn;
321 };
322
323 struct pending_auth_data;
324
325 struct smbd_server_connection {
326         struct {
327                 bool got_session;
328         } nbt;
329         bool allow_smb2;
330         struct {
331                 struct fd_event *fde;
332                 uint64_t num_requests;
333                 struct {
334                         bool encrypted_passwords;
335                         bool spnego;
336                         struct auth_context *auth_context;
337                         bool done;
338                         /*
339                          * Size of the data we can receive. Set by us.
340                          * Can be modified by the max xmit parameter.
341                          */
342                         int max_recv;
343                 } negprot;
344
345                 struct {
346                         bool done_sesssetup;
347                         /*
348                          * Size of data we can send to client. Set
349                          *  by the client for all protocols above CORE.
350                          *  Set by us for CORE protocol.
351                          */
352                         int max_send;
353                         uint16_t last_session_tag;
354
355                         /* users from session setup */
356                         char *session_userlist;
357                         /* workgroup from session setup. */
358                         char *session_workgroup;
359                         /*
360                          * this holds info on user ids that are already
361                          * validated for this VC
362                          */
363                         user_struct *validated_users;
364                         uint16_t next_vuid;
365                         int num_validated_vuids;
366 #ifdef HAVE_NETGROUP
367                         char *my_yp_domain;
368 #endif
369                 } sessions;
370                 struct {
371                         connection_struct *Connections;
372                         /* number of open connections */
373                         struct bitmap *bmap;
374                         int num_open;
375                 } tcons;
376                 struct smb_signing_state *signing_state;
377                 /* List to store partial SPNEGO auth fragments. */
378                 struct pending_auth_data *pd_list;
379         } smb1;
380         struct {
381                 struct tevent_context *event_ctx;
382                 struct tevent_queue *recv_queue;
383                 struct tevent_queue *send_queue;
384                 struct tstream_context *stream;
385                 struct {
386                         /* an id tree used to allocate vuids */
387                         /* this holds info on session vuids that are already
388                          * validated for this VC */
389                         struct idr_context *idtree;
390
391                         /* this is the limit of vuid values for this connection */
392                         uint64_t limit;
393
394                         struct smbd_smb2_session *list;
395                 } sessions;
396                 struct smbd_smb2_request *requests;
397         } smb2;
398 };
399
400 extern struct smbd_server_connection *smbd_server_conn;
401
402 void smbd_init_globals(void);