s3:smb2_server: add SMB3 encryption support
[gd/samba-autobuild/.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                          char **ppdata,
159                          int *ret_data_len);
160
161 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
162                            struct dptr_struct *dirptr,
163                            const char *mask,
164                            uint32_t dirtype,
165                            bool dont_descend,
166                            bool ask_sharemode,
167                            bool (*match_fn)(TALLOC_CTX *ctx,
168                                             void *private_data,
169                                             const char *dname,
170                                             const char *mask,
171                                             char **_fname),
172                            bool (*mode_fn)(TALLOC_CTX *ctx,
173                                            void *private_data,
174                                            struct smb_filename *smb_fname,
175                                            uint32_t *_mode),
176                            void *private_data,
177                            char **_fname,
178                            struct smb_filename **_smb_fname,
179                            uint32_t *_mode,
180                            long *_prev_offset);
181
182 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
183                                connection_struct *conn,
184                                struct dptr_struct *dirptr,
185                                uint16 flags2,
186                                const char *path_mask,
187                                uint32 dirtype,
188                                int info_level,
189                                int requires_resume_key,
190                                bool dont_descend,
191                                bool ask_sharemode,
192                                uint8_t align,
193                                bool do_pad,
194                                char **ppdata,
195                                char *base_data,
196                                char *end_data,
197                                int space_remaining,
198                                bool *out_of_space,
199                                bool *got_exact_match,
200                                int *_last_entry_off,
201                                struct ea_list *name_list);
202
203 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
204                                     const struct smb_filename *smb_fname,
205                                     uint32_t access_mask,
206                                     uint32_t *access_mask_out);
207
208 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
209
210 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
211                                          const char *reason,
212                                          const char *location);
213 #define smbd_server_connection_terminate(sconn, reason) \
214         smbd_server_connection_terminate_ex(sconn, reason, __location__)
215
216 const char *smb2_opcode_name(uint16_t opcode);
217 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
218
219 void reply_smb2002(struct smb_request *req, uint16_t choice);
220 void reply_smb20ff(struct smb_request *req, uint16_t choice);
221 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
222                              uint8_t *inbuf, size_t size);
223
224 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
225                                     NTSTATUS status,
226                                     DATA_BLOB *info,
227                                     const char *location);
228 #define smbd_smb2_request_error(req, status) \
229         smbd_smb2_request_error_ex(req, status, NULL, __location__)
230 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
231                                    NTSTATUS status,
232                                    DATA_BLOB body, DATA_BLOB *dyn,
233                                    const char *location);
234 #define smbd_smb2_request_done(req, body, dyn) \
235         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
236
237 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
238                                      uint64_t file_id_persistent,
239                                      uint64_t file_id_volatile,
240                                      uint8_t oplock_level);
241
242 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
243                                          struct tevent_req *subreq,
244                                          uint32_t defer_time);
245
246 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
247 void remove_smb2_chained_fsp(files_struct *fsp);
248
249 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
250                                                uint32_t data_length);
251
252 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
253                                         size_t expected_body_size);
254
255 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
256 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
257 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
258 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
259 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
260 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
261 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
262 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
264 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
265 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
266 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
267 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
268                                     int err);
269 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
270 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
271 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
272 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
273 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
274 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
278 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
279                                 struct tevent_immediate *im,
280                                 void *private_data);
281
282 /* SMB1 -> SMB2 glue. */
283 void send_break_message_smb2(files_struct *fsp, int level);
284 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
285 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
286                                 struct smb_request *req,
287                                 files_struct *fsp,
288                                 int lock_timeout,
289                                 int lock_num,
290                                 uint64_t smblctx,
291                                 enum brl_type lock_type,
292                                 enum brl_flavour lock_flav,
293                                 uint64_t offset,
294                                 uint64_t count,
295                                 uint64_t blocking_smblctx);
296 void process_blocking_lock_queue_smb2(
297         struct smbd_server_connection *sconn, struct timeval tv_curr);
298 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
299                         struct byte_range_lock *br_lck,
300                         enum file_close_type close_type);
301 /* From smbd/smb2_create.c */
302 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
303 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
304                         struct timeval *p_request_time,
305                         void **pp_state);
306 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
307                             uint64_t mid);
308 void remove_deferred_open_message_smb2(
309         struct smbd_server_connection *sconn, uint64_t mid);
310 bool schedule_deferred_open_message_smb2(
311         struct smbd_server_connection *sconn, uint64_t mid);
312 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
313                         struct timeval request_time,
314                         struct timeval timeout,
315                         struct file_id id,
316                         char *private_data,
317                         size_t priv_len);
318
319 struct smbXsrv_connection {
320         struct smbd_server_connection *sconn;
321
322         const struct tsocket_address *local_address;
323         const struct tsocket_address *remote_address;
324         const char *remote_hostname;
325
326         struct tevent_context *ev_ctx;
327         struct messaging_context *msg_ctx;
328
329         enum protocol_types protocol;
330
331         struct {
332                 struct {
333                         uint32_t capabilities;
334                         struct GUID guid;
335                         uint16_t security_mode;
336                         uint16_t num_dialects;
337                         uint16_t *dialects;
338                 } client;
339                 struct {
340                         uint32_t capabilities;
341                         struct GUID guid;
342                         uint16_t security_mode;
343                         uint16_t dialect;
344                         uint32_t max_trans;
345                         uint32_t max_read;
346                         uint32_t max_write;
347                 } server;
348         } smb2;
349
350         struct msg_state *msg_state;
351
352         /*
353          * Link into libasys for asynchronous operations
354          */
355         struct asys_context *asys_ctx;
356         struct tevent_fd *asys_fde;
357
358         uint64_t smbd_idle_profstamp;
359
360         /*
361          * this session_table is used for SMB1 and SMB2,
362          */
363         struct smbXsrv_session_table *session_table;
364         /*
365          * this tcon_table is only used for SMB1.
366          */
367         struct smbXsrv_tcon_table *tcon_table;
368         /*
369          * this open_table is used for SMB1 and SMB2,
370          * because we have a global sconn->real_max_open_files
371          * limit.
372          */
373         struct smbXsrv_open_table *open_table;
374 };
375
376 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
377 uint32_t smbXsrv_version_global_current(void);
378
379 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
380                                         enum protocol_types protocol);
381
382 NTSTATUS smbXsrv_session_global_init(void);
383 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
384                                 NTTIME now,
385                                 struct smbXsrv_session **_session);
386 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
387 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
388 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
389 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
390 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
391                                 uint16_t vuid, NTTIME now,
392                                 struct smbXsrv_session **session);
393 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
394 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
395                                 uint64_t session_id, NTTIME now,
396                                 struct smbXsrv_session **session);
397 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
398                                         struct tevent_context *ev,
399                                         struct smbXsrv_connection *conn,
400                                         struct auth_session_info *session_info,
401                                         uint64_t previous_session_id,
402                                         uint64_t current_session_id);
403 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
404
405 NTSTATUS smbXsrv_tcon_global_init(void);
406 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
407 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
408 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
409 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
410                              NTTIME now,
411                              struct smbXsrv_tcon **_tcon);
412 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
413                              uint16_t tree_id, NTTIME now,
414                              struct smbXsrv_tcon **tcon);
415 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
416 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
417 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
418                              NTTIME now,
419                              struct smbXsrv_tcon **_tcon);
420 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
421                              uint32_t tree_id, NTTIME now,
422                              struct smbXsrv_tcon **tcon);
423 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
424
425 NTSTATUS smbXsrv_open_global_init(void);
426 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
427                              struct auth_session_info *session_info,
428                              NTTIME now,
429                              struct smbXsrv_open **_open);
430 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
431 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
432 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
433 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
434 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
435                              uint16_t fnum, NTTIME now,
436                              struct smbXsrv_open **_open);
437 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
438 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
439                              uint64_t persistent_id,
440                              uint64_t volatile_id,
441                              NTTIME now,
442                              struct smbXsrv_open **_open);
443
444 struct smbd_smb2_request {
445         struct smbd_smb2_request *prev, *next;
446
447         struct smbd_server_connection *sconn;
448
449         /* the session the request operates on, maybe NULL */
450         struct smbXsrv_session *session;
451         uint64_t last_session_id;
452
453         /* the tcon the request operates on, maybe NULL */
454         struct smbXsrv_tcon *tcon;
455         uint32_t last_tid;
456
457         int current_idx;
458         bool do_signing;
459         bool do_encryption;
460         struct tevent_timer *async_te;
461         bool cancelled;
462         bool compound_related;
463
464         /*
465          * the encryption key for the whole
466          * compound chain
467          */
468         DATA_BLOB first_key;
469         /*
470          * the signing key for the last
471          * request/response of a compound chain
472          */
473         DATA_BLOB last_key;
474
475         struct timeval request_time;
476
477         /* fake smb1 request. */
478         struct smb_request *smb1req;
479         struct files_struct *compat_chain_fsp;
480
481         NTSTATUS next_status;
482
483         /*
484          * The sub request for async backend calls.
485          * This is used for SMB2 Cancel.
486          */
487         struct tevent_req *subreq;
488
489 #define SMBD_SMB2_TF_IOV_OFS 0
490 #define SMBD_SMB2_HDR_IOV_OFS 1
491 #define SMBD_SMB2_BODY_IOV_OFS 2
492 #define SMBD_SMB2_DYN_IOV_OFS 3
493
494 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
495
496 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
497         (&req->dir.vector[(idx)+(ofs)])
498
499 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
500         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
501 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
502         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
503 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
504         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
505 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
506         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
507
508 #define SMBD_SMB2_IN_TF_IOV(req)    SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
509 #define SMBD_SMB2_IN_TF_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
510 #define SMBD_SMB2_IN_HDR_IOV(req)    SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
511 #define SMBD_SMB2_IN_HDR_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
512 #define SMBD_SMB2_IN_BODY_IOV(req)   SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
513 #define SMBD_SMB2_IN_BODY_PTR(req)   (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
514 #define SMBD_SMB2_IN_BODY_LEN(req)   (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
515 #define SMBD_SMB2_IN_DYN_IOV(req)    SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
516 #define SMBD_SMB2_IN_DYN_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
517 #define SMBD_SMB2_IN_DYN_LEN(req)    (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
518
519 #define SMBD_SMB2_OUT_TF_IOV(req)   SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
520 #define SMBD_SMB2_OUT_TF_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
521 #define SMBD_SMB2_OUT_HDR_IOV(req)   SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
522 #define SMBD_SMB2_OUT_HDR_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
523 #define SMBD_SMB2_OUT_BODY_IOV(req)  SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
524 #define SMBD_SMB2_OUT_BODY_PTR(req)  (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
525 #define SMBD_SMB2_OUT_BODY_LEN(req)  (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
526 #define SMBD_SMB2_OUT_DYN_IOV(req)   SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
527 #define SMBD_SMB2_OUT_DYN_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
528 #define SMBD_SMB2_OUT_DYN_LEN(req)   (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
529
530         struct {
531                 /*
532                  * vector[0] TRANSPORT HEADER (empty)
533                  * .
534                  * vector[1] SMB2_TRANSFORM (optional)
535                  * vector[2] SMB2
536                  * vector[3] fixed body
537                  * vector[4] dynamic body
538                  * .
539                  * .
540                  * .
541                  * vector[5] SMB2_TRANSFORM (optional)
542                  * vector[6] SMB2
543                  * vector[7] fixed body
544                  * vector[8] dynamic body
545                  * .
546                  * .
547                  * .
548                  */
549                 struct iovec *vector;
550                 int vector_count;
551         } in;
552         struct {
553                 /* the NBT header is not allocated */
554                 uint8_t nbt_hdr[4];
555                 /*
556                  * vector[0] TRANSPORT HEADER
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 (empty)
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         } out;
576 };
577
578 struct smbd_server_connection;
579 struct user_struct;
580
581 struct pending_message_list;
582 struct pending_auth_data;
583
584 struct user_struct {
585         struct user_struct *next, *prev;
586         uint64_t vuid; /* Tag for this entry. */
587
588         char *session_keystr; /* used by utmp and pam session code.
589                                  TDB key string */
590         int homes_snum;
591
592         struct auth_session_info *session_info;
593
594         struct smbXsrv_session *session;
595 };
596
597 struct smbd_server_connection {
598         int sock;
599         const struct tsocket_address *local_address;
600         const struct tsocket_address *remote_address;
601         const char *remote_hostname;
602         struct tevent_context *ev_ctx;
603         struct messaging_context *msg_ctx;
604         struct sys_notify_context *sys_notify_ctx;
605         struct notify_context *notify_ctx;
606         struct {
607                 bool got_session;
608         } nbt;
609         bool using_smb2;
610         int trans_num;
611
612         size_t num_users;
613         struct user_struct *users;
614
615         size_t num_connections;
616         struct connection_struct *connections;
617
618         size_t num_files;
619         struct files_struct *files;
620
621         int real_max_open_files;
622         struct fsp_singleton_cache fsp_fi_cache;
623
624         struct pending_message_list *deferred_open_queue;
625
626
627         /* open directory handles. */
628         struct {
629                 struct bitmap *dptr_bmap;
630                 struct dptr_struct *dirptrs;
631                 int dirhandles_open;
632         } searches;
633
634         uint64_t num_requests;
635
636         /* Current number of oplocks we have outstanding. */
637         struct {
638                 int32_t exclusive_open;
639                 int32_t level_II_open;
640                 struct kernel_oplocks *kernel_ops;
641         } oplocks;
642
643         struct {
644                 struct fd_event *fde;
645
646                 struct {
647                         /*
648                          * fd for the fcntl lock mutexing access to our sock
649                          */
650                         int socket_lock_fd;
651
652                         /*
653                          * fd for the trusted pipe from
654                          * echo handler child
655                          */
656                         int trusted_fd;
657
658                         /*
659                          * fde for the trusted_fd
660                          */
661                         struct fd_event *trusted_fde;
662
663                         /*
664                          * Reference count for the fcntl lock to
665                          * allow recursive locks.
666                          */
667                         int ref_count;
668                 } echo_handler;
669
670                 struct {
671                         bool encrypted_passwords;
672                         bool spnego;
673                         struct auth4_context *auth_context;
674                         bool done;
675                         /*
676                          * Size of the data we can receive. Set by us.
677                          * Can be modified by the max xmit parameter.
678                          */
679                         int max_recv;
680                 } negprot;
681
682                 struct {
683                         uint16_t client_major;
684                         uint16_t client_minor;
685                         uint32_t client_cap_low;
686                         uint32_t client_cap_high;
687                 } unix_info;
688
689                 struct {
690                         bool done_sesssetup;
691                         /*
692                          * Size of data we can send to client. Set
693                          *  by the client for all protocols above CORE.
694                          *  Set by us for CORE protocol.
695                          */
696                         int max_send;
697                         uint64_t last_session_tag;
698                 } sessions;
699                 struct smb_signing_state *signing_state;
700
701                 struct notify_mid_map *notify_mid_maps;
702
703                 struct {
704                         /* dlink list we store pending lock records on. */
705                         struct blocking_lock_record *blocking_lock_queue;
706                         /* dlink list we move cancelled lock records onto. */
707                         struct blocking_lock_record *blocking_lock_cancelled_queue;
708
709                         /* The event that makes us process our blocking lock queue */
710                         struct timed_event *brl_timeout;
711
712                         bool blocking_lock_unlock_state;
713                         bool blocking_lock_cancel_state;
714                 } locks;
715         } smb1;
716         struct {
717                 struct tevent_queue *recv_queue;
718                 struct tevent_queue *send_queue;
719                 struct tstream_context *stream;
720                 bool negprot_2ff;
721                 struct {
722                         /* The event that makes us process our blocking lock queue */
723                         struct timed_event *brl_timeout;
724                         bool blocking_lock_unlock_state;
725                 } locks;
726                 struct smbd_smb2_request *requests;
727                 /*
728                  * seqnum_low is the lowest sequence number
729                  * we will accept.
730                  */
731                 uint64_t seqnum_low;
732                 /*
733                  * seqnum_range is the range of credits we have
734                  * granted from the sequence windows starting
735                  * at seqnum_low.
736                  *
737                  * This gets incremented when new credits are
738                  * granted and gets decremented when the
739                  * lowest sequence number is consumed
740                  * (when seqnum_low gets incremented).
741                  */
742                 uint16_t seqnum_range;
743                 /*
744                  * credits_grantedThe number of credits we have currently granted
745                  * to the client.
746                  *
747                  * This gets incremented when new credits are
748                  * granted and gets decremented when any credit
749                  * is comsumed.
750                  *
751                  * Note: the decrementing is different compared
752                  *       to seqnum_range.
753                  */
754                 uint16_t credits_granted;
755                 /*
756                  * The maximum number of credits we will ever
757                  * grant to the client.
758                  *
759                  * Typically we will only grant 1/16th of
760                  * max_credits.
761                  *
762                  * This is the "server max credits" parameter.
763                  */
764                 uint16_t max_credits;
765                 /*
766                  * a bitmap of size max_credits
767                  */
768                 struct bitmap *credits_bitmap;
769                 bool supports_multicredit;
770                 uint32_t max_trans;
771                 uint32_t max_read;
772                 uint32_t max_write;
773                 bool compound_related_in_progress;
774         } smb2;
775
776         struct smbXsrv_connection *conn;
777 };
778
779 extern struct smbXsrv_connection *global_smbXsrv_connection;
780
781 void smbd_init_globals(void);