Remove the compound_related_in_progress state from the smb2 global state.
[samba.git] / source3 / smbd / globals.h
1 /*
2    Unix SMB/Netbios implementation.
3    smbd globals
4    Copyright (C) Stefan Metzmacher 2009
5    Copyright (C) Jeremy Allison 2010
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include "system/select.h"
22 #include "librpc/gen_ndr/smbXsrv.h"
23
24 extern int aio_pending_size;
25 extern int outstanding_aio_calls;
26
27 #ifdef USE_DMAPI
28 struct smbd_dmapi_context;
29 extern struct smbd_dmapi_context *dmapi_ctx;
30 #endif
31
32 extern bool dfree_broken;
33
34 /* how many write cache buffers have been allocated */
35 extern unsigned int allocated_write_caches;
36
37 /* A singleton cache to speed up searching by dev/inode. */
38 struct fsp_singleton_cache {
39         files_struct *fsp;
40         struct file_id id;
41 };
42
43 extern const struct mangle_fns *mangle_fns;
44
45 extern unsigned char *chartest;
46 struct tdb_context;
47 extern struct tdb_context *tdb_mangled_cache;
48
49 /*
50   this determines how many characters are used from the original filename
51   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
52   The largest possible value is 6.
53 */
54 extern unsigned mangle_prefix;
55
56 struct msg_state;
57
58 extern bool logged_ioctl_message;
59
60 extern int trans_num;
61
62 extern time_t last_smb_conf_reload_time;
63 extern time_t last_printer_reload_time;
64 extern pid_t background_lpq_updater_pid;
65
66 /****************************************************************************
67  structure to hold a linked list of queued messages.
68  for processing.
69 ****************************************************************************/
70 extern uint32_t common_flags2;
71
72 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
73 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
74
75 struct sec_ctx {
76         struct security_unix_token ut;
77         struct security_token *token;
78 };
79 /* A stack of security contexts.  We include the current context as being
80    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
81 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
82 extern int sec_ctx_stack_ndx;
83 extern bool become_uid_done;
84 extern bool become_gid_done;
85
86 extern connection_struct *last_conn;
87 extern uint16_t last_flags;
88
89 extern uint32_t global_client_caps;
90
91 extern uint16_t fnf_handle;
92
93 struct conn_ctx {
94         connection_struct *conn;
95         uint64_t vuid;
96 };
97 /* A stack of current_user connection contexts. */
98 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
99 extern int conn_ctx_stack_ndx;
100
101 struct vfs_init_function_entry;
102 extern struct vfs_init_function_entry *backends;
103 extern char *sparse_buf;
104 extern char *LastDir;
105
106 struct smbd_parent_context;
107 extern struct smbd_parent_context *am_parent;
108 extern struct memcache *smbd_memcache_ctx;
109 extern bool exit_firsttime;
110
111 struct tstream_context;
112 struct smbd_smb2_request;
113
114 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
115
116 void smbd_lock_socket(struct smbd_server_connection *sconn);
117 void smbd_unlock_socket(struct smbd_server_connection *sconn);
118
119 NTSTATUS smbd_do_locking(struct smb_request *req,
120                          files_struct *fsp,
121                          uint8_t type,
122                          int32_t timeout,
123                          uint16_t num_ulocks,
124                          struct smbd_lock_element *ulocks,
125                          uint16_t num_locks,
126                          struct smbd_lock_element *locks,
127                          bool *async);
128
129 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
130                                TALLOC_CTX *mem_ctx,
131                                uint16_t info_level,
132                                files_struct *fsp,
133                                struct smb_filename *smb_fname,
134                                bool delete_pending,
135                                struct timespec write_time_ts,
136                                struct ea_list *ea_list,
137                                int lock_data_count,
138                                char *lock_data,
139                                uint16_t flags2,
140                                unsigned int max_data_bytes,
141                                char **ppdata,
142                                unsigned int *pdata_size);
143
144 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
145                                 struct smb_request *req,
146                                 TALLOC_CTX *mem_ctx,
147                                 uint16_t info_level,
148                                 files_struct *fsp,
149                                 struct smb_filename *smb_fname,
150                                 char **ppdata, int total_data,
151                                 int *ret_data_size);
152
153 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
154                          TALLOC_CTX *mem_ctx,
155                          uint16_t info_level,
156                          uint16_t flags2,
157                          unsigned int max_data_bytes,
158                          struct smb_filename *smb_fname,
159                          char **ppdata,
160                          int *ret_data_len);
161
162 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
163                            struct dptr_struct *dirptr,
164                            const char *mask,
165                            uint32_t dirtype,
166                            bool dont_descend,
167                            bool ask_sharemode,
168                            bool (*match_fn)(TALLOC_CTX *ctx,
169                                             void *private_data,
170                                             const char *dname,
171                                             const char *mask,
172                                             char **_fname),
173                            bool (*mode_fn)(TALLOC_CTX *ctx,
174                                            void *private_data,
175                                            struct smb_filename *smb_fname,
176                                            uint32_t *_mode),
177                            void *private_data,
178                            char **_fname,
179                            struct smb_filename **_smb_fname,
180                            uint32_t *_mode,
181                            long *_prev_offset);
182
183 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
184                                connection_struct *conn,
185                                struct dptr_struct *dirptr,
186                                uint16 flags2,
187                                const char *path_mask,
188                                uint32 dirtype,
189                                int info_level,
190                                int requires_resume_key,
191                                bool dont_descend,
192                                bool ask_sharemode,
193                                uint8_t align,
194                                bool do_pad,
195                                char **ppdata,
196                                char *base_data,
197                                char *end_data,
198                                int space_remaining,
199                                bool *out_of_space,
200                                bool *got_exact_match,
201                                int *_last_entry_off,
202                                struct ea_list *name_list);
203
204 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
205                                     const struct smb_filename *smb_fname,
206                                     bool use_privs,
207                                     uint32_t access_mask,
208                                     uint32_t *access_mask_out);
209
210 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
211
212 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
213                                          const char *reason,
214                                          const char *location);
215 #define smbd_server_connection_terminate(sconn, reason) \
216         smbd_server_connection_terminate_ex(sconn, reason, __location__)
217
218 const char *smb2_opcode_name(uint16_t opcode);
219 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
220
221 void reply_smb2002(struct smb_request *req, uint16_t choice);
222 void reply_smb20ff(struct smb_request *req, uint16_t choice);
223 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
224                              uint8_t *inbuf, size_t size);
225
226 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
227                                     NTSTATUS status,
228                                     DATA_BLOB *info,
229                                     const char *location);
230 #define smbd_smb2_request_error(req, status) \
231         smbd_smb2_request_error_ex(req, status, NULL, __location__)
232 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
233                                    NTSTATUS status,
234                                    DATA_BLOB body, DATA_BLOB *dyn,
235                                    const char *location);
236 #define smbd_smb2_request_done(req, body, dyn) \
237         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
238
239 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
240                                      struct smbXsrv_session *session,
241                                      struct smbXsrv_tcon *tcon,
242                                      struct smbXsrv_open *op,
243                                      uint8_t oplock_level);
244
245 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
246                                          struct tevent_req *subreq,
247                                          uint32_t defer_time);
248
249 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
250 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
251 void remove_smb2_chained_fsp(files_struct *fsp);
252
253 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
254                                                uint32_t data_length);
255
256 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
257                                         size_t expected_body_size);
258
259 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
260 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
261 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
262 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
264 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
266 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
267 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
268 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
269 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
270 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
271 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
272                                     int err);
273 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
274 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
281 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
282 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
283                                 struct tevent_immediate *im,
284                                 void *private_data);
285
286 /* SMB1 -> SMB2 glue. */
287 void send_break_message_smb2(files_struct *fsp, int level);
288 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
289 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
290                                 struct smb_request *req,
291                                 files_struct *fsp,
292                                 int lock_timeout,
293                                 int lock_num,
294                                 uint64_t smblctx,
295                                 enum brl_type lock_type,
296                                 enum brl_flavour lock_flav,
297                                 uint64_t offset,
298                                 uint64_t count,
299                                 uint64_t blocking_smblctx);
300 void process_blocking_lock_queue_smb2(
301         struct smbd_server_connection *sconn, struct timeval tv_curr);
302 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
303                         struct byte_range_lock *br_lck,
304                         enum file_close_type close_type);
305 /* From smbd/smb2_create.c */
306 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
307 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
308                         struct timeval *p_request_time,
309                         void **pp_state);
310 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
311                             uint64_t mid);
312 void remove_deferred_open_message_smb2(
313         struct smbd_server_connection *sconn, uint64_t mid);
314 bool schedule_deferred_open_message_smb2(
315         struct smbd_server_connection *sconn, uint64_t mid);
316 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
317                         struct timeval request_time,
318                         struct timeval timeout,
319                         struct file_id id,
320                         char *private_data,
321                         size_t priv_len);
322
323 struct smbXsrv_connection {
324         struct smbd_server_connection *sconn;
325
326         const struct tsocket_address *local_address;
327         const struct tsocket_address *remote_address;
328         const char *remote_hostname;
329
330         struct tevent_context *ev_ctx;
331         struct messaging_context *msg_ctx;
332
333         enum protocol_types protocol;
334
335         struct {
336                 struct {
337                         uint32_t capabilities;
338                         struct GUID guid;
339                         uint16_t security_mode;
340                         uint16_t num_dialects;
341                         uint16_t *dialects;
342                 } client;
343                 struct {
344                         uint32_t capabilities;
345                         struct GUID guid;
346                         uint16_t security_mode;
347                         uint16_t dialect;
348                         uint32_t max_trans;
349                         uint32_t max_read;
350                         uint32_t max_write;
351                 } server;
352         } smb2;
353
354         struct msg_state *msg_state;
355
356         /*
357          * Link into libasys for asynchronous operations
358          */
359         struct asys_context *asys_ctx;
360         struct tevent_fd *asys_fde;
361
362         uint64_t smbd_idle_profstamp;
363
364         /*
365          * this session_table is used for SMB1 and SMB2,
366          */
367         struct smbXsrv_session_table *session_table;
368         /*
369          * this tcon_table is only used for SMB1.
370          */
371         struct smbXsrv_tcon_table *tcon_table;
372         /*
373          * this open_table is used for SMB1 and SMB2,
374          * because we have a global sconn->real_max_open_files
375          * limit.
376          */
377         struct smbXsrv_open_table *open_table;
378 };
379
380 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
381 uint32_t smbXsrv_version_global_current(void);
382
383 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
384                                         enum protocol_types protocol);
385
386 NTSTATUS smbXsrv_session_global_init(void);
387 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
388                                 NTTIME now,
389                                 struct smbXsrv_session **_session);
390 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
391 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
392 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
393 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
394 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
395                                 uint16_t vuid, NTTIME now,
396                                 struct smbXsrv_session **session);
397 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
398 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
399                                 uint64_t session_id, NTTIME now,
400                                 struct smbXsrv_session **session);
401 struct smbXsrv_session_global0;
402 NTSTATUS smbXsrv_session_global_traverse(
403                         int (*fn)(struct smbXsrv_session_global0 *, void *),
404                         void *private_data);
405 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
406                                         struct tevent_context *ev,
407                                         struct smbXsrv_connection *conn,
408                                         struct auth_session_info *session_info,
409                                         uint64_t previous_session_id,
410                                         uint64_t current_session_id);
411 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
412
413 NTSTATUS smbXsrv_tcon_global_init(void);
414 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
415 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
416 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
417 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
418                              NTTIME now,
419                              struct smbXsrv_tcon **_tcon);
420 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
421                              uint16_t tree_id, NTTIME now,
422                              struct smbXsrv_tcon **tcon);
423 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
424 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
425 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
426                              NTTIME now,
427                              struct smbXsrv_tcon **_tcon);
428 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
429                              uint32_t tree_id, NTTIME now,
430                              struct smbXsrv_tcon **tcon);
431 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
432 struct smbXsrv_tcon_global0;
433 NTSTATUS smbXsrv_tcon_global_traverse(
434                         int (*fn)(struct smbXsrv_tcon_global0 *, void *),
435                         void *private_data);
436
437 NTSTATUS smbXsrv_open_global_init(void);
438 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
439                              struct auth_session_info *session_info,
440                              NTTIME now,
441                              struct smbXsrv_open **_open);
442 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
443 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
444 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
445 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
446 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
447                              uint16_t fnum, NTTIME now,
448                              struct smbXsrv_open **_open);
449 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
450 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
451                              uint64_t persistent_id,
452                              uint64_t volatile_id,
453                              NTTIME now,
454                              struct smbXsrv_open **_open);
455 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
456                                struct auth_session_info *session_info,
457                                uint64_t persistent_id,
458                                struct GUID create_guid,
459                                NTTIME now,
460                                struct smbXsrv_open **_open);
461 struct smbXsrv_open_global0;
462 NTSTATUS smbXsrv_open_global_traverse(
463         int (*fn)(struct smbXsrv_open_global0 *, void *),
464         void *private_data);
465
466 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
467
468
469 struct smbd_smb2_request {
470         struct smbd_smb2_request *prev, *next;
471
472         struct smbd_server_connection *sconn;
473
474         /* the session the request operates on, maybe NULL */
475         struct smbXsrv_session *session;
476         uint64_t last_session_id;
477
478         /* the tcon the request operates on, maybe NULL */
479         struct smbXsrv_tcon *tcon;
480         uint32_t last_tid;
481
482         int current_idx;
483         bool do_signing;
484         bool do_encryption;
485         struct tevent_timer *async_te;
486         bool compound_related;
487
488         /*
489          * the encryption key for the whole
490          * compound chain
491          */
492         DATA_BLOB first_key;
493         /*
494          * the signing key for the last
495          * request/response of a compound chain
496          */
497         DATA_BLOB last_key;
498
499         struct timeval request_time;
500
501         /* fake smb1 request. */
502         struct smb_request *smb1req;
503         struct files_struct *compat_chain_fsp;
504
505         /*
506          * The sub request for async backend calls.
507          * This is used for SMB2 Cancel.
508          */
509         struct tevent_req *subreq;
510
511 #define SMBD_SMB2_TF_IOV_OFS 0
512 #define SMBD_SMB2_HDR_IOV_OFS 1
513 #define SMBD_SMB2_BODY_IOV_OFS 2
514 #define SMBD_SMB2_DYN_IOV_OFS 3
515
516 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
517
518 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
519         (&req->dir.vector[(idx)+(ofs)])
520
521 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
522         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
523 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
524         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
525 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
526         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
527 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
528         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
529
530 #define SMBD_SMB2_IN_TF_IOV(req)    SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
531 #define SMBD_SMB2_IN_TF_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
532 #define SMBD_SMB2_IN_HDR_IOV(req)    SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
533 #define SMBD_SMB2_IN_HDR_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
534 #define SMBD_SMB2_IN_BODY_IOV(req)   SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
535 #define SMBD_SMB2_IN_BODY_PTR(req)   (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
536 #define SMBD_SMB2_IN_BODY_LEN(req)   (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
537 #define SMBD_SMB2_IN_DYN_IOV(req)    SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
538 #define SMBD_SMB2_IN_DYN_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
539 #define SMBD_SMB2_IN_DYN_LEN(req)    (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
540
541 #define SMBD_SMB2_OUT_TF_IOV(req)   SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
542 #define SMBD_SMB2_OUT_TF_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
543 #define SMBD_SMB2_OUT_HDR_IOV(req)   SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
544 #define SMBD_SMB2_OUT_HDR_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
545 #define SMBD_SMB2_OUT_BODY_IOV(req)  SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
546 #define SMBD_SMB2_OUT_BODY_PTR(req)  (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
547 #define SMBD_SMB2_OUT_BODY_LEN(req)  (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
548 #define SMBD_SMB2_OUT_DYN_IOV(req)   SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
549 #define SMBD_SMB2_OUT_DYN_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
550 #define SMBD_SMB2_OUT_DYN_LEN(req)   (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
551
552 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
553
554         struct {
555                 /*
556                  * vector[0] TRANSPORT HEADER (empty)
557                  * .
558                  * vector[1] SMB2_TRANSFORM (optional)
559                  * vector[2] SMB2
560                  * vector[3] fixed body
561                  * vector[4] dynamic body
562                  * .
563                  * .
564                  * .
565                  * vector[5] SMB2_TRANSFORM (optional)
566                  * vector[6] SMB2
567                  * vector[7] fixed body
568                  * vector[8] dynamic body
569                  * .
570                  * .
571                  * .
572                  */
573                 struct iovec *vector;
574                 int vector_count;
575         } in;
576         struct {
577                 /* the NBT header is not allocated */
578                 uint8_t nbt_hdr[4];
579                 /*
580                  * vector[0] TRANSPORT HEADER
581                  * .
582                  * vector[1] SMB2_TRANSFORM (optional)
583                  * vector[2] SMB2
584                  * vector[3] fixed body
585                  * vector[4] dynamic body
586                  * .
587                  * .
588                  * .
589                  * vector[5] SMB2_TRANSFORM (empty)
590                  * vector[6] SMB2
591                  * vector[7] fixed body
592                  * vector[8] dynamic body
593                  * .
594                  * .
595                  * .
596                  */
597                 struct iovec *vector;
598                 int vector_count;
599         } out;
600 };
601
602 struct smbd_server_connection;
603 struct user_struct;
604
605 struct pending_message_list;
606 struct pending_auth_data;
607
608 struct user_struct {
609         struct user_struct *next, *prev;
610         uint64_t vuid; /* Tag for this entry. */
611
612         char *session_keystr; /* used by utmp and pam session code.
613                                  TDB key string */
614         int homes_snum;
615
616         struct auth_session_info *session_info;
617
618         struct smbXsrv_session *session;
619 };
620
621 struct smbd_server_connection {
622         int sock;
623         const struct tsocket_address *local_address;
624         const struct tsocket_address *remote_address;
625         const char *remote_hostname;
626         struct tevent_context *ev_ctx;
627         struct messaging_context *msg_ctx;
628         struct sys_notify_context *sys_notify_ctx;
629         struct notify_context *notify_ctx;
630         struct {
631                 bool got_session;
632         } nbt;
633         bool using_smb2;
634         int trans_num;
635
636         size_t num_users;
637         struct user_struct *users;
638
639         size_t num_connections;
640         struct connection_struct *connections;
641
642         size_t num_files;
643         struct files_struct *files;
644
645         int real_max_open_files;
646         struct fsp_singleton_cache fsp_fi_cache;
647
648         struct pending_message_list *deferred_open_queue;
649
650
651         /* open directory handles. */
652         struct {
653                 struct bitmap *dptr_bmap;
654                 struct dptr_struct *dirptrs;
655                 int dirhandles_open;
656         } searches;
657
658         uint64_t num_requests;
659
660         /* Current number of oplocks we have outstanding. */
661         struct {
662                 int32_t exclusive_open;
663                 int32_t level_II_open;
664                 struct kernel_oplocks *kernel_ops;
665         } oplocks;
666
667         struct {
668                 struct tevent_fd *fde;
669
670                 struct {
671                         /*
672                          * fd for the fcntl lock mutexing access to our sock
673                          */
674                         int socket_lock_fd;
675
676                         /*
677                          * fd for the trusted pipe from
678                          * echo handler child
679                          */
680                         int trusted_fd;
681
682                         /*
683                          * fde for the trusted_fd
684                          */
685                         struct tevent_fd *trusted_fde;
686
687                         /*
688                          * Reference count for the fcntl lock to
689                          * allow recursive locks.
690                          */
691                         int ref_count;
692                 } echo_handler;
693
694                 struct {
695                         bool encrypted_passwords;
696                         bool spnego;
697                         struct auth4_context *auth_context;
698                         bool done;
699                         /*
700                          * Size of the data we can receive. Set by us.
701                          * Can be modified by the max xmit parameter.
702                          */
703                         int max_recv;
704                 } negprot;
705
706                 struct {
707                         uint16_t client_major;
708                         uint16_t client_minor;
709                         uint32_t client_cap_low;
710                         uint32_t client_cap_high;
711                 } unix_info;
712
713                 struct {
714                         bool done_sesssetup;
715                         /*
716                          * Size of data we can send to client. Set
717                          *  by the client for all protocols above CORE.
718                          *  Set by us for CORE protocol.
719                          */
720                         int max_send;
721                         uint64_t last_session_tag;
722                 } sessions;
723                 struct smb_signing_state *signing_state;
724
725                 struct notify_mid_map *notify_mid_maps;
726
727                 struct {
728                         /* dlink list we store pending lock records on. */
729                         struct blocking_lock_record *blocking_lock_queue;
730                         /* dlink list we move cancelled lock records onto. */
731                         struct blocking_lock_record *blocking_lock_cancelled_queue;
732
733                         /* The event that makes us process our blocking lock queue */
734                         struct tevent_timer *brl_timeout;
735
736                         bool blocking_lock_unlock_state;
737                         bool blocking_lock_cancel_state;
738                 } locks;
739         } smb1;
740         struct {
741                 struct tevent_queue *recv_queue;
742                 struct tevent_queue *send_queue;
743                 struct tstream_context *stream;
744                 bool negprot_2ff;
745                 struct {
746                         /* The event that makes us process our blocking lock queue */
747                         struct tevent_timer *brl_timeout;
748                         bool blocking_lock_unlock_state;
749                 } locks;
750                 struct smbd_smb2_request *requests;
751                 /*
752                  * seqnum_low is the lowest sequence number
753                  * we will accept.
754                  */
755                 uint64_t seqnum_low;
756                 /*
757                  * seqnum_range is the range of credits we have
758                  * granted from the sequence windows starting
759                  * at seqnum_low.
760                  *
761                  * This gets incremented when new credits are
762                  * granted and gets decremented when the
763                  * lowest sequence number is consumed
764                  * (when seqnum_low gets incremented).
765                  */
766                 uint16_t seqnum_range;
767                 /*
768                  * credits_grantedThe number of credits we have currently granted
769                  * to the client.
770                  *
771                  * This gets incremented when new credits are
772                  * granted and gets decremented when any credit
773                  * is comsumed.
774                  *
775                  * Note: the decrementing is different compared
776                  *       to seqnum_range.
777                  */
778                 uint16_t credits_granted;
779                 /*
780                  * The maximum number of credits we will ever
781                  * grant to the client.
782                  *
783                  * Typically we will only grant 1/16th of
784                  * max_credits.
785                  *
786                  * This is the "server max credits" parameter.
787                  */
788                 uint16_t max_credits;
789                 /*
790                  * a bitmap of size max_credits
791                  */
792                 struct bitmap *credits_bitmap;
793                 bool supports_multicredit;
794                 uint32_t max_trans;
795                 uint32_t max_read;
796                 uint32_t max_write;
797         } smb2;
798
799         struct smbXsrv_connection *conn;
800 };
801
802 extern struct smbXsrv_connection *global_smbXsrv_connection;
803
804 void smbd_init_globals(void);