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