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