smbd: avoid calling SMB_VFS_FGET_NT_ACL() if do_not_check_mask already covers all
[Samba.git] / source3 / smbd / globals.h
blobefcf02f0d2471d45dda8d8355d5f80a7e9ef324e
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 #ifndef _SOURCE3_SMBD_GLOBALS_H_
22 #define _SOURCE3_SMBD_GLOBALS_H_
24 #include "system/select.h"
25 #include "librpc/gen_ndr/smbXsrv.h"
26 #include "smbprofile.h"
28 #ifdef USE_DMAPI
29 struct smbd_dmapi_context;
30 extern struct smbd_dmapi_context *dmapi_ctx;
31 #endif
33 /* A singleton cache to speed up searching by dev/inode. */
34 struct fsp_singleton_cache {
35 files_struct *fsp;
36 struct file_id id;
39 extern const struct mangle_fns *mangle_fns;
41 extern unsigned char *chartest;
42 struct tdb_context;
43 extern struct tdb_context *tdb_mangled_cache;
46 this determines how many characters are used from the original filename
47 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
48 The largest possible value is 6.
50 extern unsigned mangle_prefix;
52 struct msg_state;
54 extern bool logged_ioctl_message;
56 extern int trans_num;
58 extern time_t last_smb_conf_reload_time;
59 extern time_t last_printer_reload_time;
60 extern pid_t background_lpq_updater_pid;
62 /****************************************************************************
63 structure to hold a linked list of queued messages.
64 for processing.
65 ****************************************************************************/
66 extern uint32_t common_flags2;
68 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
69 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
71 struct sec_ctx {
72 struct security_unix_token ut;
73 struct security_token *token;
75 /* A stack of security contexts. We include the current context as being
76 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
77 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
78 extern int sec_ctx_stack_ndx;
79 extern bool become_uid_done;
80 extern bool become_gid_done;
82 extern connection_struct *last_conn;
83 extern uint16_t last_flags;
85 extern uint32_t global_client_caps;
87 extern uint16_t fnf_handle;
89 struct conn_ctx {
90 connection_struct *conn;
91 uint64_t vuid;
92 userdom_struct user_info;
94 /* A stack of current_user connection contexts. */
95 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
96 extern int conn_ctx_stack_ndx;
98 struct vfs_init_function_entry;
99 extern struct vfs_init_function_entry *backends;
100 extern char *sparse_buf;
101 extern char *LastDir;
103 struct smbd_parent_context;
104 extern struct smbd_parent_context *am_parent;
105 extern struct memcache *smbd_memcache_ctx;
106 extern bool exit_firsttime;
108 struct tstream_context;
109 struct smbd_smb2_request;
111 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbXsrv_connection *xconn);
113 void smbd_lock_socket(struct smbXsrv_connection *xconn);
114 void smbd_unlock_socket(struct smbXsrv_connection *xconn);
116 struct GUID smbd_request_guid(struct smb_request *smb1req, uint16_t idx);
118 NTSTATUS smbd_do_unlocking(struct smb_request *req,
119 files_struct *fsp,
120 uint16_t num_ulocks,
121 struct smbd_lock_element *ulocks);
123 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
124 TALLOC_CTX *mem_ctx,
125 struct smb_request *req,
126 uint16_t info_level,
127 files_struct *fsp,
128 struct smb_filename *smb_fname,
129 bool delete_pending,
130 struct timespec write_time_ts,
131 struct ea_list *ea_list,
132 int lock_data_count,
133 char *lock_data,
134 uint16_t flags2,
135 unsigned int max_data_bytes,
136 size_t *fixed_portion,
137 char **ppdata,
138 unsigned int *pdata_size);
140 NTSTATUS smbd_do_setfsinfo(connection_struct *conn,
141 struct smb_request *req,
142 TALLOC_CTX *mem_ctx,
143 uint16_t info_level,
144 files_struct *fsp,
145 const DATA_BLOB *pdata);
147 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
148 struct smb_request *req,
149 TALLOC_CTX *mem_ctx,
150 uint16_t info_level,
151 files_struct *fsp,
152 struct smb_filename *smb_fname,
153 char **ppdata, int total_data,
154 int *ret_data_size);
156 NTSTATUS smbd_do_qfsinfo(struct smbXsrv_connection *xconn,
157 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 get_dosmode,
174 bool (*match_fn)(TALLOC_CTX *ctx,
175 void *private_data,
176 const char *dname,
177 const char *mask,
178 char **_fname),
179 bool (*mode_fn)(TALLOC_CTX *ctx,
180 void *private_data,
181 struct files_struct *dirfsp,
182 struct smb_filename *atname,
183 struct smb_filename *smb_fname,
184 bool get_dosmode,
185 uint32_t *_mode),
186 void *private_data,
187 char **_fname,
188 struct smb_filename **_smb_fname,
189 uint32_t *_mode,
190 long *_prev_offset);
192 NTSTATUS smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
193 connection_struct *conn,
194 struct dptr_struct *dirptr,
195 uint16_t flags2,
196 const char *path_mask,
197 uint32_t dirtype,
198 int info_level,
199 int requires_resume_key,
200 bool dont_descend,
201 bool ask_sharemode,
202 bool get_dosmode,
203 uint8_t align,
204 bool do_pad,
205 char **ppdata,
206 char *base_data,
207 char *end_data,
208 int space_remaining,
209 struct smb_filename **smb_fname,
210 bool *got_exact_match,
211 int *_last_entry_off,
212 struct ea_list *name_list,
213 struct file_id *file_id);
215 NTSTATUS smbd_calculate_access_mask_fsp(struct files_struct *dirsfp,
216 struct files_struct *fsp,
217 bool use_privs,
218 uint32_t access_mask,
219 uint32_t *access_mask_out);
221 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
223 void smbXsrv_connection_disconnect_transport(struct smbXsrv_connection *xconn,
224 NTSTATUS status);
225 size_t smbXsrv_client_valid_connections(struct smbXsrv_client *client);
226 void smbd_server_connection_terminate_ex(struct smbXsrv_connection *xconn,
227 const char *reason,
228 const char *location);
229 #define smbd_server_connection_terminate(xconn, reason) \
230 smbd_server_connection_terminate_ex(xconn, reason, __location__)
232 void smbd_server_disconnect_client_ex(struct smbXsrv_client *client,
233 const char *reason,
234 const char *location);
235 #define smbd_server_disconnect_client(__client, __reason) \
236 smbd_server_disconnect_client_ex(__client, __reason, __location__)
238 const char *smb2_opcode_name(uint16_t opcode);
239 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
240 bool smbd_smb2_is_compound(const struct smbd_smb2_request *req);
242 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
243 NTTIME now, struct smbXsrv_connection **_xconn);
245 NTSTATUS reply_smb2002(struct smb_request *req, uint16_t choice);
246 NTSTATUS reply_smb20ff(struct smb_request *req, uint16_t choice);
247 NTSTATUS smbd_smb2_process_negprot(struct smbXsrv_connection *xconn,
248 uint64_t expected_seq_low,
249 const uint8_t *inpdu, size_t size);
250 NTSTATUS smb2_multi_protocol_reply_negprot(struct smb_request *req);
252 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
254 bool smbXsrv_server_multi_channel_enabled(void);
256 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
257 NTSTATUS status,
258 DATA_BLOB *info,
259 const char *location);
260 #define smbd_smb2_request_error(req, status) \
261 smbd_smb2_request_error_ex(req, status, NULL, __location__)
262 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
263 NTSTATUS status,
264 DATA_BLOB body, DATA_BLOB *dyn,
265 const char *location);
266 #define smbd_smb2_request_done(req, body, dyn) \
267 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
269 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_client *client,
270 struct smbXsrv_open *op,
271 uint8_t oplock_level);
272 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_client *client,
273 uint16_t new_epoch,
274 uint32_t lease_flags,
275 struct smb2_lease_key *lease_key,
276 uint32_t current_lease_state,
277 uint32_t new_lease_state);
279 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
280 struct tevent_req *subreq,
281 uint32_t defer_time);
283 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
284 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
285 void remove_smb2_chained_fsp(files_struct *fsp);
287 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
288 uint32_t data_length);
290 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
291 size_t expected_body_size);
293 void smb2_request_set_async_internal(struct smbd_smb2_request *req,
294 bool async_internal);
296 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
297 const int dialect_count,
298 uint16_t *dialect);
299 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
306 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
307 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
308 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
309 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
310 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
311 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
312 int err);
313 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
314 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
315 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
316 NTSTATUS smbd_smb2_request_process_query_directory(struct smbd_smb2_request *req);
317 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
318 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
319 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
320 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
321 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
322 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
323 struct tevent_immediate *im,
324 void *private_data);
326 struct deferred_open_record;
328 /* SMB1 -> SMB2 glue. */
329 void send_break_message_smb2(files_struct *fsp,
330 uint32_t break_from,
331 uint32_t break_to);
332 /* From smbd/smb2_create.c */
333 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
334 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
335 struct timeval *p_request_time,
336 struct deferred_open_record **open_rec);
337 bool open_was_deferred_smb2(
338 struct smbXsrv_connection *xconn, uint64_t mid);
339 void remove_deferred_open_message_smb2(
340 struct smbXsrv_connection *xconn, uint64_t mid);
341 bool schedule_deferred_open_message_smb2(
342 struct smbXsrv_connection *xconn, uint64_t mid);
343 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
344 struct timeval request_time,
345 struct timeval timeout,
346 struct file_id id,
347 struct deferred_open_record *open_rec);
349 struct smbXsrv_client;
351 struct smbXsrv_preauth {
352 uint8_t sha512_value[64];
355 struct smbXsrv_connection {
356 struct smbXsrv_connection *prev, *next;
358 struct smbXsrv_client *client;
360 NTTIME connect_time;
361 uint64_t channel_id;
362 const struct tsocket_address *local_address;
363 const struct tsocket_address *remote_address;
364 const char *remote_hostname;
365 bool has_cluster_movable_ip;
367 enum protocol_types protocol;
369 struct {
370 NTSTATUS status;
371 bool terminating;
372 struct tevent_queue *shutdown_wait_queue;
373 int sock;
374 struct tevent_fd *fde;
376 struct {
377 bool got_session;
378 } nbt;
379 } transport;
381 struct {
382 bool force_unacked_timeout;
383 uint64_t unacked_bytes;
384 uint32_t rto_usecs;
385 struct tevent_req *checker_subreq;
386 struct smbd_smb2_send_queue *queue;
387 } ack;
389 #if defined(WITH_SMB1SERVER)
390 struct {
391 struct {
393 * fd for the fcntl lock and process shared
394 * robust mutex to coordinate access to the
395 * client socket. When the system supports
396 * process shared robust mutexes, those are
397 * used. If not, then the fcntl lock will be
398 * used.
400 int socket_lock_fd;
401 #ifdef HAVE_ROBUST_MUTEXES
402 pthread_mutex_t *socket_mutex;
403 #endif
406 * fd for the trusted pipe from
407 * echo handler child
409 int trusted_fd;
412 * fde for the trusted_fd
414 struct tevent_fd *trusted_fde;
417 * Reference count for the fcntl lock to
418 * allow recursive locks.
420 int ref_count;
421 } echo_handler;
423 struct {
424 bool encrypted_passwords;
425 bool spnego;
426 struct auth4_context *auth_context;
427 bool done;
429 * Size of the data we can receive. Set by us.
430 * Can be modified by the max xmit parameter.
432 int max_recv;
433 } negprot;
435 struct {
436 bool done_sesssetup;
438 * Size of data we can send to client. Set
439 * by the client for all protocols above CORE.
440 * Set by us for CORE protocol.
442 int max_send;
443 } sessions;
444 struct smb1_signing_state *signing_state;
446 struct {
447 uint16_t client_major;
448 uint16_t client_minor;
449 uint32_t client_cap_low;
450 uint32_t client_cap_high;
451 } unix_info;
453 struct msg_state *msg_state;
454 } smb1;
455 #endif
456 struct {
457 struct smbd_smb2_request_read_state {
458 struct smbd_smb2_request *req;
459 struct {
460 uint8_t nbt[NBT_HDR_SIZE];
461 bool done;
462 } hdr;
463 struct iovec vector;
464 bool doing_receivefile;
465 size_t min_recv_size;
466 size_t pktfull;
467 size_t pktlen;
468 uint8_t *pktbuf;
469 } request_read_state;
470 struct smbd_smb2_send_queue *send_queue;
471 size_t send_queue_len;
473 struct {
475 * seq_low is the lowest sequence number
476 * we will accept.
478 uint64_t seq_low;
480 * seq_range is the range of credits we have
481 * granted from the sequence windows starting
482 * at seq_low.
484 * This gets incremented when new credits are
485 * granted and gets decremented when the
486 * lowest sequence number is consumed
487 * (when seq_low gets incremented).
489 uint16_t seq_range;
491 * The number of credits we have currently granted
492 * to the client.
494 * This gets incremented when new credits are
495 * granted and gets decremented when any credit
496 * is comsumed.
498 * Note: the decrementing is different compared
499 * to seq_range.
501 uint16_t granted;
503 * The maximum number of credits we will ever
504 * grant to the client.
506 * Typically we will only grant 1/16th of
507 * max_credits.
509 * This is the "server max credits" parameter.
511 uint16_t max;
513 * a bitmap of size max_credits
515 struct bitmap *bitmap;
516 bool multicredit;
517 } credits;
519 bool allow_2ff;
520 struct {
521 uint32_t capabilities;
522 struct GUID guid;
523 bool guid_verified;
524 uint16_t security_mode;
525 uint16_t num_dialects;
526 uint16_t *dialects;
527 } client;
528 struct {
529 uint32_t capabilities;
530 struct GUID guid;
531 uint16_t security_mode;
532 uint16_t dialect;
533 uint32_t max_trans;
534 uint32_t max_read;
535 uint32_t max_write;
536 uint16_t sign_algo;
537 uint16_t cipher;
538 bool posix_extensions_negotiated;
539 } server;
541 struct smbXsrv_preauth preauth;
543 struct smbd_smb2_request *requests;
545 struct {
546 uint8_t read_body_padding;
547 } smbtorture;
549 bool signing_mandatory;
550 } smb2;
553 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
555 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
556 uint32_t smbXsrv_version_global_current(void);
558 struct smbXsrv_client_table;
559 NTSTATUS smbXsrv_client_global_init(void);
560 NTSTATUS smbXsrv_client_create(TALLOC_CTX *mem_ctx,
561 struct tevent_context *ev_ctx,
562 struct messaging_context *msg_ctx,
563 NTTIME now,
564 struct smbXsrv_client **_client);
565 NTSTATUS smbXsrv_client_remove(struct smbXsrv_client *client);
566 struct tevent_req *smb2srv_client_mc_negprot_send(TALLOC_CTX *mem_ctx,
567 struct tevent_context *ev,
568 struct smbd_smb2_request *smb2req);
569 NTSTATUS smb2srv_client_mc_negprot_recv(struct tevent_req *req);
571 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
572 enum protocol_types protocol);
574 NTSTATUS smbXsrv_session_global_init(struct messaging_context *msg_ctx);
575 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
576 NTTIME now,
577 struct smbXsrv_session **_session);
578 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
579 struct smbXsrv_connection *conn,
580 NTTIME now,
581 struct smbXsrv_channel_global0 **_c);
582 NTSTATUS smbXsrv_session_remove_channel(struct smbXsrv_session *session,
583 struct smbXsrv_connection *xconn);
584 NTSTATUS smbXsrv_session_disconnect_xconn(struct smbXsrv_connection *xconn);
585 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
586 struct smbXsrv_channel_global0;
587 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
588 const struct smbXsrv_connection *conn,
589 struct smbXsrv_channel_global0 **_c);
590 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
591 const struct smbXsrv_connection *conn,
592 NTTIME now,
593 struct smbXsrv_session_auth0 **_a);
594 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
595 struct smbXsrv_connection *conn,
596 NTTIME now,
597 uint8_t in_flags,
598 uint8_t in_security_mode,
599 struct smbXsrv_session_auth0 **_a);
600 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
601 struct tevent_context *ev,
602 struct smbXsrv_session *session,
603 struct smbd_smb2_request *current_req);
604 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
605 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
606 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_client *client);
607 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
608 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
609 uint16_t vuid, NTTIME now,
610 struct smbXsrv_session **session);
611 NTSTATUS smbXsrv_session_info_lookup(struct smbXsrv_client *client,
612 uint64_t session_wire_id,
613 struct auth_session_info **si);
614 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
615 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
616 uint64_t session_id, NTTIME now,
617 struct smbXsrv_session **session);
618 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
619 uint64_t session_id, NTTIME now,
620 struct smbXsrv_session **session);
621 NTSTATUS smb2srv_session_lookup_global(struct smbXsrv_client *client,
622 uint64_t session_wire_id,
623 TALLOC_CTX *mem_ctx,
624 struct smbXsrv_session **session);
625 NTSTATUS get_valid_smbXsrv_session(struct smbXsrv_client *client,
626 uint64_t session_wire_id,
627 struct smbXsrv_session **session);
628 NTSTATUS smbXsrv_session_local_traverse(
629 struct smbXsrv_client *client,
630 int (*caller_cb)(struct smbXsrv_session *session,
631 void *caller_data),
632 void *caller_data);
633 struct smbXsrv_session_global0;
634 NTSTATUS smbXsrv_session_global_traverse(
635 int (*fn)(struct smbXsrv_session_global0 *, void *),
636 void *private_data);
637 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
638 struct tevent_context *ev,
639 struct smbXsrv_connection *conn,
640 struct auth_session_info *session_info,
641 uint64_t previous_session_id,
642 uint64_t current_session_id);
643 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
645 NTSTATUS smbXsrv_tcon_global_init(void);
646 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
647 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
648 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
649 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
650 NTTIME now,
651 struct smbXsrv_tcon **_tcon);
652 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
653 uint16_t tree_id, NTTIME now,
654 struct smbXsrv_tcon **tcon);
655 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_client *client);
656 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
657 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
658 NTTIME now,
659 struct smbXsrv_tcon **_tcon);
660 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
661 uint32_t tree_id, NTTIME now,
662 struct smbXsrv_tcon **tcon);
663 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
664 struct smbXsrv_tcon_global0;
665 NTSTATUS smbXsrv_tcon_global_traverse(
666 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
667 void *private_data);
670 bool smbXsrv_is_encrypted(uint8_t encryption_flags);
671 bool smbXsrv_is_partially_encrypted(uint8_t encryption_flags);
672 bool smbXsrv_set_crypto_flag(uint8_t *flags, uint8_t flag);
673 bool smbXsrv_is_signed(uint8_t signing_flags);
674 bool smbXsrv_is_partially_signed(uint8_t signing_flags);
676 struct smbd_smb2_send_queue {
677 struct smbd_smb2_send_queue *prev, *next;
679 DATA_BLOB *sendfile_header;
680 uint32_t sendfile_body_size;
681 NTSTATUS *sendfile_status;
682 struct iovec *vector;
683 int count;
685 struct {
686 struct tevent_req *req;
687 struct timeval timeout;
688 uint64_t required_acked_bytes;
689 } ack;
691 TALLOC_CTX *mem_ctx;
694 struct smbd_smb2_request {
695 struct smbd_smb2_request *prev, *next;
697 struct smbd_server_connection *sconn;
698 struct smbXsrv_connection *xconn;
700 struct smbd_smb2_send_queue queue_entry;
702 /* the session the request operates on, maybe NULL */
703 struct smbXsrv_session *session;
704 uint64_t last_session_id;
706 /* the tcon the request operates on, maybe NULL */
707 struct smbXsrv_tcon *tcon;
708 uint32_t last_tid;
710 int current_idx;
711 bool do_signing;
712 /* Was the request encrypted? */
713 bool was_encrypted;
714 /* Should we encrypt? */
715 bool do_encryption;
716 struct tevent_timer *async_te;
717 bool compound_related;
718 NTSTATUS compound_create_err;
721 * Give the implementation of an SMB2 req a way to tell the SMB2 request
722 * processing engine that the internal request is going async, while
723 * preserving synchronous SMB2 behaviour.
725 bool async_internal;
728 * the encryption key for the whole
729 * compound chain
731 struct smb2_signing_key *first_enc_key;
733 * the signing key for the last
734 * request/response of a compound chain
736 struct smb2_signing_key *last_sign_key;
737 struct smbXsrv_preauth *preauth;
739 struct timeval request_time;
741 SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
743 /* fake smb1 request. */
744 struct smb_request *smb1req;
745 struct files_struct *compat_chain_fsp;
748 * Keep track of whether the outstanding request counters
749 * had been updated in dispatch, so that they need to be
750 * adapted again in reply.
752 bool request_counters_updated;
753 uint64_t channel_generation;
756 * The sub request for async backend calls.
757 * This is used for SMB2 Cancel.
759 struct tevent_req *subreq;
761 #define SMBD_SMB2_TF_IOV_OFS 0
762 #define SMBD_SMB2_HDR_IOV_OFS 1
763 #define SMBD_SMB2_BODY_IOV_OFS 2
764 #define SMBD_SMB2_DYN_IOV_OFS 3
766 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
768 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
769 (&req->dir.vector[(idx)+(ofs)])
771 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
772 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
773 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
774 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
775 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
776 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
777 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
778 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
780 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
781 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
782 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
783 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
784 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
785 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
786 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
787 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
788 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
789 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
791 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
792 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
793 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
794 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
795 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
796 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
797 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
798 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
799 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
800 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
802 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
804 struct {
806 * vector[0] TRANSPORT HEADER (empty)
808 * vector[1] SMB2_TRANSFORM (optional)
809 * vector[2] SMB2
810 * vector[3] fixed body
811 * vector[4] dynamic body
815 * vector[5] SMB2_TRANSFORM (optional)
816 * vector[6] SMB2
817 * vector[7] fixed body
818 * vector[8] dynamic body
823 struct iovec *vector;
824 int vector_count;
825 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
826 } in;
827 struct {
828 /* the NBT header is not allocated */
829 uint8_t nbt_hdr[4];
831 * vector[0] TRANSPORT HEADER
833 * vector[1] SMB2_TRANSFORM (optional)
834 * vector[2] SMB2
835 * vector[3] fixed body
836 * vector[4] dynamic body
840 * vector[5] SMB2_TRANSFORM (empty)
841 * vector[6] SMB2
842 * vector[7] fixed body
843 * vector[8] dynamic body
848 struct iovec *vector;
849 int vector_count;
850 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
851 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
852 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
853 uint8_t _body[0x58];
854 } out;
857 struct smbd_server_connection;
859 struct pending_message_list;
860 struct pending_auth_data;
862 struct pthreadpool_tevent;
863 struct dcesrv_context;
865 struct smbd_server_connection {
866 const struct tsocket_address *local_address;
867 const struct tsocket_address *remote_address;
868 const char *remote_hostname;
869 struct tevent_context *ev_ctx;
870 struct messaging_context *msg_ctx;
871 struct dcesrv_context *dce_ctx;
872 struct notify_context *notify_ctx;
873 bool using_smb2;
874 int trans_num;
876 size_t num_users;
878 size_t num_connections;
879 struct connection_struct *connections;
881 size_t num_files;
882 struct files_struct *files;
884 int real_max_open_files;
885 struct fsp_singleton_cache fsp_fi_cache;
887 struct pending_message_list *deferred_open_queue;
890 /* open directory handles. */
891 struct {
892 struct bitmap *dptr_bmap;
893 struct dptr_struct *dirptrs;
894 } searches;
896 uint64_t num_requests;
898 /* Current number of oplocks we have outstanding. */
899 struct {
900 int32_t exclusive_open;
901 int32_t level_II_open;
902 struct kernel_oplocks *kernel_ops;
903 } oplocks;
905 struct notify_mid_map *notify_mid_maps;
907 struct pthreadpool_tevent *pool;
909 struct smbXsrv_client *client;
912 extern struct smbXsrv_client *global_smbXsrv_client;
914 void smbd_init_globals(void);
916 /****************************************************************************
917 The buffer we keep around whilst an aio request is in process.
918 *****************************************************************************/
920 struct aio_extra {
921 files_struct *fsp;
922 struct smb_request *smbreq;
923 DATA_BLOB outbuf;
924 struct lock_struct lock;
925 size_t nbyte;
926 off_t offset;
927 bool write_through;
930 #endif /* _SOURCE3_SMBD_GLOBALS_H_ */