smbd: Add missing {}
[Samba.git] / source3 / smbd / globals.h
blob70148fb76aed1f3a17f37d13f2dddce8be8061be
1 /*
2 Unix SMB/Netbios implementation.
3 smbd globals
4 Copyright (C) Stefan Metzmacher 2009
5 Copyright (C) Jeremy Allison 2010
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.
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.
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/>.
21 #include "system/select.h"
22 #include "librpc/gen_ndr/smbXsrv.h"
24 extern int aio_pending_size;
25 extern int outstanding_aio_calls;
27 #ifdef USE_DMAPI
28 struct smbd_dmapi_context;
29 extern struct smbd_dmapi_context *dmapi_ctx;
30 #endif
32 extern bool dfree_broken;
34 /* how many write cache buffers have been allocated */
35 extern unsigned int allocated_write_caches;
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;
43 extern const struct mangle_fns *mangle_fns;
45 extern unsigned char *chartest;
46 struct tdb_context;
47 extern struct tdb_context *tdb_mangled_cache;
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.
54 extern unsigned mangle_prefix;
56 struct msg_state;
58 extern bool logged_ioctl_message;
60 extern int trans_num;
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;
66 /****************************************************************************
67 structure to hold a linked list of queued messages.
68 for processing.
69 ****************************************************************************/
70 extern uint32_t common_flags2;
72 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
73 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
75 struct sec_ctx {
76 struct security_unix_token ut;
77 struct security_token *token;
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;
86 extern connection_struct *last_conn;
87 extern uint16_t last_flags;
89 extern uint32_t global_client_caps;
91 extern uint16_t fnf_handle;
93 struct conn_ctx {
94 connection_struct *conn;
95 uint64_t vuid;
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;
101 struct vfs_init_function_entry;
102 extern struct vfs_init_function_entry *backends;
103 extern char *sparse_buf;
104 extern char *LastDir;
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;
111 struct tstream_context;
112 struct smbd_smb2_request;
114 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
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);
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);
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);
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);
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);
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);
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);
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);
215 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
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__)
223 const char *smb2_opcode_name(uint16_t opcode);
224 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
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);
231 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
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__)
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);
252 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
253 struct tevent_req *subreq,
254 uint32_t defer_time);
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);
260 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
261 uint32_t data_length);
263 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
264 size_t expected_body_size);
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);
296 struct deferred_open_record;
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);
334 struct smbXsrv_connection {
335 struct smbd_server_connection *sconn;
337 const struct tsocket_address *local_address;
338 const struct tsocket_address *remote_address;
339 const char *remote_hostname;
341 struct tevent_context *ev_ctx;
342 struct messaging_context *msg_ctx;
344 enum protocol_types protocol;
346 struct {
347 struct {
348 uint32_t capabilities;
349 struct GUID guid;
350 uint16_t security_mode;
351 uint16_t num_dialects;
352 uint16_t *dialects;
353 } client;
354 struct {
355 uint32_t capabilities;
356 struct GUID guid;
357 uint16_t security_mode;
358 uint16_t dialect;
359 uint32_t max_trans;
360 uint32_t max_read;
361 uint32_t max_write;
362 } server;
363 } smb2;
365 struct msg_state *msg_state;
368 * Link into libasys for asynchronous operations
370 struct asys_context *asys_ctx;
371 struct tevent_fd *asys_fde;
373 uint64_t smbd_idle_profstamp;
376 * this session_table is used for SMB1 and SMB2,
378 struct smbXsrv_session_table *session_table;
379 uint64_t last_session_id;
381 * this tcon_table is only used for SMB1.
383 struct smbXsrv_tcon_table *tcon_table;
385 * this open_table is used for SMB1 and SMB2,
386 * because we have a global sconn->real_max_open_files
387 * limit.
389 struct smbXsrv_open_table *open_table;
392 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
393 uint32_t smbXsrv_version_global_current(void);
395 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
396 enum protocol_types protocol);
398 NTSTATUS smbXsrv_session_global_init(void);
399 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
400 NTTIME now,
401 struct smbXsrv_session **_session);
402 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
403 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
404 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
405 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
406 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
407 uint16_t vuid, NTTIME now,
408 struct smbXsrv_session **session);
409 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
410 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
411 uint64_t session_id, NTTIME now,
412 struct smbXsrv_session **session);
413 struct smbXsrv_session_global0;
414 NTSTATUS smbXsrv_session_global_traverse(
415 int (*fn)(struct smbXsrv_session_global0 *, void *),
416 void *private_data);
417 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
418 struct tevent_context *ev,
419 struct smbXsrv_connection *conn,
420 struct auth_session_info *session_info,
421 uint64_t previous_session_id,
422 uint64_t current_session_id);
423 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
425 NTSTATUS smbXsrv_tcon_global_init(void);
426 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
427 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
428 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
429 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
430 NTTIME now,
431 struct smbXsrv_tcon **_tcon);
432 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
433 uint16_t tree_id, NTTIME now,
434 struct smbXsrv_tcon **tcon);
435 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
436 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
437 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
438 NTTIME now,
439 struct smbXsrv_tcon **_tcon);
440 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
441 uint32_t tree_id, NTTIME now,
442 struct smbXsrv_tcon **tcon);
443 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
444 struct smbXsrv_tcon_global0;
445 NTSTATUS smbXsrv_tcon_global_traverse(
446 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
447 void *private_data);
449 NTSTATUS smbXsrv_open_global_init(void);
450 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
451 struct auth_session_info *session_info,
452 NTTIME now,
453 struct smbXsrv_open **_open);
454 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
455 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
456 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
457 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
458 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
459 uint16_t fnum, NTTIME now,
460 struct smbXsrv_open **_open);
461 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
462 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
463 uint64_t persistent_id,
464 uint64_t volatile_id,
465 NTTIME now,
466 struct smbXsrv_open **_open);
467 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
468 struct auth_session_info *session_info,
469 uint64_t persistent_id,
470 const struct GUID *create_guid,
471 NTTIME now,
472 struct smbXsrv_open **_open);
473 struct smbXsrv_open_global0;
474 NTSTATUS smbXsrv_open_global_traverse(
475 int (*fn)(struct smbXsrv_open_global0 *, void *),
476 void *private_data);
478 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
480 struct smbd_smb2_send_queue {
481 struct smbd_smb2_send_queue *prev, *next;
483 DATA_BLOB *sendfile_header;
484 struct iovec *vector;
485 int count;
487 TALLOC_CTX *mem_ctx;
490 struct smbd_smb2_request {
491 struct smbd_smb2_request *prev, *next;
493 struct smbd_server_connection *sconn;
495 struct smbd_smb2_send_queue queue_entry;
497 /* the session the request operates on, maybe NULL */
498 struct smbXsrv_session *session;
499 uint64_t last_session_id;
501 /* the tcon the request operates on, maybe NULL */
502 struct smbXsrv_tcon *tcon;
503 uint32_t last_tid;
505 int current_idx;
506 bool do_signing;
507 bool do_encryption;
508 struct tevent_timer *async_te;
509 bool compound_related;
512 * the encryption key for the whole
513 * compound chain
515 DATA_BLOB first_key;
517 * the signing key for the last
518 * request/response of a compound chain
520 DATA_BLOB last_key;
522 struct timeval request_time;
524 /* fake smb1 request. */
525 struct smb_request *smb1req;
526 struct files_struct *compat_chain_fsp;
529 * The sub request for async backend calls.
530 * This is used for SMB2 Cancel.
532 struct tevent_req *subreq;
534 #define SMBD_SMB2_TF_IOV_OFS 0
535 #define SMBD_SMB2_HDR_IOV_OFS 1
536 #define SMBD_SMB2_BODY_IOV_OFS 2
537 #define SMBD_SMB2_DYN_IOV_OFS 3
539 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
541 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
542 (&req->dir.vector[(idx)+(ofs)])
544 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
545 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
546 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
547 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
548 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
549 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
550 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
551 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
553 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
554 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
555 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
556 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
557 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
558 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
559 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
560 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
561 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
562 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
564 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
565 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
566 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
567 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
568 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
569 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
570 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
571 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
572 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
573 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
575 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
577 struct {
579 * vector[0] TRANSPORT HEADER (empty)
581 * vector[1] SMB2_TRANSFORM (optional)
582 * vector[2] SMB2
583 * vector[3] fixed body
584 * vector[4] dynamic body
588 * vector[5] SMB2_TRANSFORM (optional)
589 * vector[6] SMB2
590 * vector[7] fixed body
591 * vector[8] dynamic body
596 struct iovec *vector;
597 int vector_count;
598 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
599 } in;
600 struct {
601 /* the NBT header is not allocated */
602 uint8_t nbt_hdr[4];
604 * vector[0] TRANSPORT HEADER
606 * vector[1] SMB2_TRANSFORM (optional)
607 * vector[2] SMB2
608 * vector[3] fixed body
609 * vector[4] dynamic body
613 * vector[5] SMB2_TRANSFORM (empty)
614 * vector[6] SMB2
615 * vector[7] fixed body
616 * vector[8] dynamic body
621 struct iovec *vector;
622 int vector_count;
623 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
624 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
625 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
626 uint8_t _body[0x58];
627 } out;
630 struct smbd_server_connection;
631 struct user_struct;
633 struct pending_message_list;
634 struct pending_auth_data;
636 struct user_struct {
637 struct user_struct *next, *prev;
638 uint64_t vuid; /* Tag for this entry. */
640 char *session_keystr; /* used by utmp and pam session code.
641 TDB key string */
642 int homes_snum;
644 struct auth_session_info *session_info;
646 struct smbXsrv_session *session;
649 struct smbd_server_connection {
650 NTSTATUS status;
651 int sock;
652 const struct tsocket_address *local_address;
653 const struct tsocket_address *remote_address;
654 const char *remote_hostname;
655 struct tevent_context *ev_ctx;
656 struct messaging_context *msg_ctx;
657 struct sys_notify_context *sys_notify_ctx;
658 struct notify_context *notify_ctx;
659 struct {
660 bool got_session;
661 } nbt;
662 bool using_smb2;
663 int trans_num;
665 size_t num_users;
666 struct user_struct *users;
668 size_t num_connections;
669 struct connection_struct *connections;
671 size_t num_files;
672 struct files_struct *files;
674 int real_max_open_files;
675 struct fsp_singleton_cache fsp_fi_cache;
677 struct pending_message_list *deferred_open_queue;
680 /* open directory handles. */
681 struct {
682 struct bitmap *dptr_bmap;
683 struct dptr_struct *dirptrs;
684 int dirhandles_open;
685 } searches;
687 uint64_t num_requests;
689 /* Current number of oplocks we have outstanding. */
690 struct {
691 int32_t exclusive_open;
692 int32_t level_II_open;
693 struct kernel_oplocks *kernel_ops;
694 } oplocks;
696 struct {
697 struct tevent_fd *fde;
699 struct {
702 * fd for the fcntl lock and process shared
703 * robust mutex to coordinate access to the
704 * client socket. When the system supports
705 * process shared robust mutexes, those are
706 * used. If not, then the fcntl lock will be
707 * used.
709 int socket_lock_fd;
710 #ifdef HAVE_ROBUST_MUTEXES
711 pthread_mutex_t *socket_mutex;
712 #endif
715 * fd for the trusted pipe from
716 * echo handler child
718 int trusted_fd;
721 * fde for the trusted_fd
723 struct tevent_fd *trusted_fde;
726 * Reference count for the fcntl lock to
727 * allow recursive locks.
729 int ref_count;
730 } echo_handler;
732 struct {
733 bool encrypted_passwords;
734 bool spnego;
735 struct auth4_context *auth_context;
736 bool done;
738 * Size of the data we can receive. Set by us.
739 * Can be modified by the max xmit parameter.
741 int max_recv;
742 } negprot;
744 struct {
745 uint16_t client_major;
746 uint16_t client_minor;
747 uint32_t client_cap_low;
748 uint32_t client_cap_high;
749 } unix_info;
751 struct {
752 bool done_sesssetup;
754 * Size of data we can send to client. Set
755 * by the client for all protocols above CORE.
756 * Set by us for CORE protocol.
758 int max_send;
759 } sessions;
760 struct smb_signing_state *signing_state;
762 struct notify_mid_map *notify_mid_maps;
764 struct {
765 /* dlink list we store pending lock records on. */
766 struct blocking_lock_record *blocking_lock_queue;
767 /* dlink list we move cancelled lock records onto. */
768 struct blocking_lock_record *blocking_lock_cancelled_queue;
770 /* The event that makes us process our blocking lock queue */
771 struct tevent_timer *brl_timeout;
773 bool blocking_lock_unlock_state;
774 bool blocking_lock_cancel_state;
775 } locks;
776 } smb1;
777 struct {
778 struct smbd_smb2_request_read_state {
779 struct smbd_smb2_request *req;
780 struct {
781 uint8_t nbt[NBT_HDR_SIZE];
782 bool done;
783 } hdr;
784 struct iovec vector;
785 bool doing_receivefile;
786 size_t min_recv_size;
787 size_t pktfull;
788 size_t pktlen;
789 uint8_t *pktbuf;
790 } request_read_state;
791 struct smbd_smb2_send_queue *send_queue;
792 size_t send_queue_len;
793 struct tevent_fd *fde;
794 bool negprot_2ff;
795 struct {
796 /* The event that makes us process our blocking lock queue */
797 struct tevent_timer *brl_timeout;
798 bool blocking_lock_unlock_state;
799 } locks;
800 struct smbd_smb2_request *requests;
802 * seqnum_low is the lowest sequence number
803 * we will accept.
805 uint64_t seqnum_low;
807 * seqnum_range is the range of credits we have
808 * granted from the sequence windows starting
809 * at seqnum_low.
811 * This gets incremented when new credits are
812 * granted and gets decremented when the
813 * lowest sequence number is consumed
814 * (when seqnum_low gets incremented).
816 uint16_t seqnum_range;
818 * credits_grantedThe number of credits we have currently granted
819 * to the client.
821 * This gets incremented when new credits are
822 * granted and gets decremented when any credit
823 * is comsumed.
825 * Note: the decrementing is different compared
826 * to seqnum_range.
828 uint16_t credits_granted;
830 * The maximum number of credits we will ever
831 * grant to the client.
833 * Typically we will only grant 1/16th of
834 * max_credits.
836 * This is the "server max credits" parameter.
838 uint16_t max_credits;
840 * a bitmap of size max_credits
842 struct bitmap *credits_bitmap;
843 bool supports_multicredit;
844 uint32_t max_trans;
845 uint32_t max_read;
846 uint32_t max_write;
847 } smb2;
849 struct smbXsrv_connection *conn;
852 extern struct smbXsrv_connection *global_smbXsrv_connection;
854 void smbd_init_globals(void);