libsmb: Use clistr_smb2_extract_snapshot_token() in cli_smb2_create_fnum_send()
[Samba.git] / source3 / smbd / globals.h
blobd1c0d145de757060b2189d8caea745591919a348
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 uint32_t global_client_caps;
84 extern uint16_t fnf_handle;
86 struct conn_ctx {
87 connection_struct *conn;
88 uint64_t vuid;
89 userdom_struct user_info;
91 /* A stack of current_user connection contexts. */
92 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
93 extern int conn_ctx_stack_ndx;
95 struct vfs_init_function_entry;
96 extern struct vfs_init_function_entry *backends;
97 extern char *sparse_buf;
98 extern char *LastDir;
100 struct smbd_parent_context;
101 extern struct smbd_parent_context *am_parent;
102 extern struct memcache *smbd_memcache_ctx;
103 extern bool exit_firsttime;
105 struct tstream_context;
106 struct smbd_smb2_request;
108 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbXsrv_connection *xconn);
110 void smbd_lock_socket(struct smbXsrv_connection *xconn);
111 void smbd_unlock_socket(struct smbXsrv_connection *xconn);
113 struct GUID smbd_request_guid(struct smb_request *smb1req, uint16_t idx);
115 NTSTATUS smbd_do_unlocking(struct smb_request *req,
116 files_struct *fsp,
117 uint16_t num_ulocks,
118 struct smbd_lock_element *ulocks);
120 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
121 TALLOC_CTX *mem_ctx,
122 struct smb_request *req,
123 uint16_t info_level,
124 files_struct *fsp,
125 struct smb_filename *smb_fname,
126 bool delete_pending,
127 struct timespec write_time_ts,
128 struct ea_list *ea_list,
129 int lock_data_count,
130 char *lock_data,
131 uint16_t flags2,
132 unsigned int max_data_bytes,
133 size_t *fixed_portion,
134 char **ppdata,
135 unsigned int *pdata_size);
137 NTSTATUS smbd_do_setfsinfo(connection_struct *conn,
138 struct smb_request *req,
139 TALLOC_CTX *mem_ctx,
140 uint16_t info_level,
141 files_struct *fsp,
142 const DATA_BLOB *pdata);
144 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
145 struct smb_request *req,
146 TALLOC_CTX *mem_ctx,
147 uint16_t info_level,
148 files_struct *fsp,
149 struct smb_filename *smb_fname,
150 char **ppdata, int total_data,
151 int *ret_data_size);
153 NTSTATUS smbd_do_qfsinfo(struct smbXsrv_connection *xconn,
154 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 get_dosmode,
171 bool (*match_fn)(TALLOC_CTX *ctx,
172 void *private_data,
173 const char *dname,
174 const char *mask,
175 char **_fname),
176 bool (*mode_fn)(TALLOC_CTX *ctx,
177 void *private_data,
178 struct files_struct *dirfsp,
179 struct smb_filename *atname,
180 struct smb_filename *smb_fname,
181 bool get_dosmode,
182 uint32_t *_mode),
183 void *private_data,
184 char **_fname,
185 struct smb_filename **_smb_fname,
186 uint32_t *_mode,
187 long *_prev_offset);
189 NTSTATUS smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
190 connection_struct *conn,
191 struct dptr_struct *dirptr,
192 uint16_t flags2,
193 const char *path_mask,
194 uint32_t dirtype,
195 int info_level,
196 int requires_resume_key,
197 bool dont_descend,
198 bool ask_sharemode,
199 bool get_dosmode,
200 uint8_t align,
201 bool do_pad,
202 char **ppdata,
203 char *base_data,
204 char *end_data,
205 int space_remaining,
206 struct smb_filename **smb_fname,
207 bool *got_exact_match,
208 int *_last_entry_off,
209 struct ea_list *name_list,
210 struct file_id *file_id);
212 NTSTATUS smbd_calculate_access_mask_fsp(struct files_struct *dirsfp,
213 struct files_struct *fsp,
214 bool use_privs,
215 uint32_t access_mask,
216 uint32_t *access_mask_out);
218 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
220 void smbXsrv_connection_disconnect_transport(struct smbXsrv_connection *xconn,
221 NTSTATUS status);
222 size_t smbXsrv_client_valid_connections(struct smbXsrv_client *client);
223 void smbd_server_connection_terminate_ex(struct smbXsrv_connection *xconn,
224 const char *reason,
225 const char *location);
226 #define smbd_server_connection_terminate(xconn, reason) \
227 smbd_server_connection_terminate_ex(xconn, reason, __location__)
229 void smbd_server_disconnect_client_ex(struct smbXsrv_client *client,
230 const char *reason,
231 const char *location);
232 #define smbd_server_disconnect_client(__client, __reason) \
233 smbd_server_disconnect_client_ex(__client, __reason, __location__)
235 const char *smb2_opcode_name(uint16_t opcode);
236 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
237 bool smbd_smb2_is_compound(const struct smbd_smb2_request *req);
238 bool smbd_smb2_is_last_in_compound(const struct smbd_smb2_request *req);
240 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
241 NTTIME now, struct smbXsrv_connection **_xconn);
243 NTSTATUS reply_smb2002(struct smb_request *req, uint16_t choice);
244 NTSTATUS reply_smb20ff(struct smb_request *req, uint16_t choice);
245 NTSTATUS smbd_smb2_process_negprot(struct smbXsrv_connection *xconn,
246 uint64_t expected_seq_low,
247 const uint8_t *inpdu, size_t size);
248 NTSTATUS smb2_multi_protocol_reply_negprot(struct smb_request *req);
250 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
252 bool smbXsrv_server_multi_channel_enabled(void);
254 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
255 NTSTATUS status,
256 uint8_t error_context_count,
257 DATA_BLOB *info,
258 const char *location);
259 #define smbd_smb2_request_error(req, status) \
260 smbd_smb2_request_error_ex(req, status, 0, NULL, __location__)
261 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
262 NTSTATUS status,
263 DATA_BLOB body, DATA_BLOB *dyn,
264 const char *location);
265 #define smbd_smb2_request_done(req, body, dyn) \
266 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
268 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_client *client,
269 struct smbXsrv_open *op,
270 uint8_t oplock_level);
271 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_client *client,
272 uint16_t new_epoch,
273 uint32_t lease_flags,
274 struct smb2_lease_key *lease_key,
275 uint32_t current_lease_state,
276 uint32_t new_lease_state);
278 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
279 struct tevent_req *subreq,
280 uint32_t defer_time);
282 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
283 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
284 void remove_smb2_chained_fsp(files_struct *fsp);
286 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
287 uint32_t data_length);
289 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
290 size_t expected_body_size);
292 void smb2_request_set_async_internal(struct smbd_smb2_request *req,
293 bool async_internal);
295 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
296 const int dialect_count,
297 uint16_t *dialect);
298 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
306 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
307 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
308 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
309 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
310 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
311 int err);
312 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
313 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
314 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
315 NTSTATUS smbd_smb2_request_process_query_directory(struct smbd_smb2_request *req);
316 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
317 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
318 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
319 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
320 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
321 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
322 struct tevent_immediate *im,
323 void *private_data);
325 struct deferred_open_record;
327 /* SMB1 -> SMB2 glue. */
328 void send_break_message_smb2(files_struct *fsp,
329 uint32_t break_from,
330 uint32_t break_to);
331 /* From smbd/smb2_create.c */
332 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
333 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
334 struct timeval *p_request_time,
335 struct deferred_open_record **open_rec);
336 bool open_was_deferred_smb2(
337 struct smbXsrv_connection *xconn, uint64_t mid);
338 void remove_deferred_open_message_smb2(
339 struct smbXsrv_connection *xconn, uint64_t mid);
340 bool schedule_deferred_open_message_smb2(
341 struct smbXsrv_connection *xconn, uint64_t mid);
342 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
343 struct timeval request_time,
344 struct timeval timeout,
345 struct file_id id,
346 struct deferred_open_record *open_rec);
348 struct smbXsrv_client;
350 struct smbXsrv_preauth {
351 uint8_t sha512_value[64];
354 struct smbXsrv_connection {
355 struct smbXsrv_connection *prev, *next;
357 struct smbXsrv_client *client;
359 NTTIME connect_time;
360 uint64_t channel_id;
361 const struct tsocket_address *local_address;
362 const struct tsocket_address *remote_address;
363 const char *remote_hostname;
364 bool has_cluster_movable_ip;
366 enum protocol_types protocol;
368 struct {
369 NTSTATUS status;
370 bool terminating;
371 struct tevent_queue *shutdown_wait_queue;
372 int sock;
373 struct tevent_fd *fde;
375 struct {
376 bool got_session;
377 } nbt;
378 } transport;
380 struct {
381 bool force_unacked_timeout;
382 uint64_t unacked_bytes;
383 uint32_t rto_usecs;
384 struct tevent_req *checker_subreq;
385 struct smbd_smb2_send_queue *queue;
386 } ack;
388 #if defined(WITH_SMB1SERVER)
389 struct {
390 struct {
392 * fd for the fcntl lock and process shared
393 * robust mutex to coordinate access to the
394 * client socket. When the system supports
395 * process shared robust mutexes, those are
396 * used. If not, then the fcntl lock will be
397 * used.
399 int socket_lock_fd;
400 #ifdef HAVE_ROBUST_MUTEXES
401 pthread_mutex_t *socket_mutex;
402 #endif
405 * fd for the trusted pipe from
406 * echo handler child
408 int trusted_fd;
411 * fde for the trusted_fd
413 struct tevent_fd *trusted_fde;
416 * Reference count for the fcntl lock to
417 * allow recursive locks.
419 int ref_count;
420 } echo_handler;
422 struct {
423 bool encrypted_passwords;
424 bool spnego;
425 struct auth4_context *auth_context;
426 bool done;
428 * Size of the data we can receive. Set by us.
429 * Can be modified by the max xmit parameter.
431 int max_recv;
432 } negprot;
434 struct {
435 bool done_sesssetup;
437 * Size of data we can send to client. Set
438 * by the client for all protocols above CORE.
439 * Set by us for CORE protocol.
441 int max_send;
442 } sessions;
443 struct smb1_signing_state *signing_state;
445 struct {
446 uint16_t client_major;
447 uint16_t client_minor;
448 uint32_t client_cap_low;
449 uint32_t client_cap_high;
450 } unix_info;
452 struct msg_state *msg_state;
453 } smb1;
454 #endif
455 struct {
456 struct smbd_smb2_request_read_state {
457 struct smbd_smb2_request *req;
458 struct {
459 uint8_t nbt[NBT_HDR_SIZE];
460 bool done;
461 } hdr;
462 struct iovec vector;
463 bool doing_receivefile;
464 size_t min_recv_size;
465 size_t pktfull;
466 size_t pktlen;
467 uint8_t *pktbuf;
468 } request_read_state;
469 struct smbd_smb2_send_queue *send_queue;
470 size_t send_queue_len;
472 struct {
474 * seq_low is the lowest sequence number
475 * we will accept.
477 uint64_t seq_low;
479 * seq_range is the range of credits we have
480 * granted from the sequence windows starting
481 * at seq_low.
483 * This gets incremented when new credits are
484 * granted and gets decremented when the
485 * lowest sequence number is consumed
486 * (when seq_low gets incremented).
488 uint16_t seq_range;
490 * The number of credits we have currently granted
491 * to the client.
493 * This gets incremented when new credits are
494 * granted and gets decremented when any credit
495 * is comsumed.
497 * Note: the decrementing is different compared
498 * to seq_range.
500 uint16_t granted;
502 * The maximum number of credits we will ever
503 * grant to the client.
505 * Typically we will only grant 1/16th of
506 * max_credits.
508 * This is the "server max credits" parameter.
510 uint16_t max;
512 * a bitmap of size max_credits
514 struct bitmap *bitmap;
515 bool multicredit;
516 } credits;
518 bool allow_2ff;
519 struct {
520 uint32_t capabilities;
521 struct GUID guid;
522 bool guid_verified;
523 uint16_t security_mode;
524 uint16_t num_dialects;
525 uint16_t *dialects;
526 } client;
527 struct {
528 uint32_t capabilities;
529 struct GUID guid;
530 uint16_t security_mode;
531 uint16_t dialect;
532 uint32_t max_trans;
533 uint32_t max_read;
534 uint32_t max_write;
535 uint16_t sign_algo;
536 uint16_t cipher;
537 bool posix_extensions_negotiated;
538 } server;
540 struct smbXsrv_preauth preauth;
542 struct smbd_smb2_request *requests;
544 struct {
545 uint8_t read_body_padding;
546 } smbtorture;
548 bool signing_mandatory;
549 } smb2;
552 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
554 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
555 uint32_t smbXsrv_version_global_current(void);
557 struct smbXsrv_client_table;
558 NTSTATUS smbXsrv_client_global_init(void);
559 NTSTATUS smbXsrv_client_create(TALLOC_CTX *mem_ctx,
560 struct tevent_context *ev_ctx,
561 struct messaging_context *msg_ctx,
562 NTTIME now,
563 struct smbXsrv_client **_client);
564 NTSTATUS smbXsrv_client_remove(struct smbXsrv_client *client);
565 struct tevent_req *smb2srv_client_mc_negprot_send(TALLOC_CTX *mem_ctx,
566 struct tevent_context *ev,
567 struct smbd_smb2_request *smb2req);
568 NTSTATUS smb2srv_client_mc_negprot_recv(struct tevent_req *req);
570 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
571 enum protocol_types protocol);
573 NTSTATUS smbXsrv_session_global_init(struct messaging_context *msg_ctx);
574 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
575 NTTIME now,
576 struct smbXsrv_session **_session);
577 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
578 struct smbXsrv_connection *conn,
579 NTTIME now,
580 struct smbXsrv_channel_global0 **_c);
581 NTSTATUS smbXsrv_session_remove_channel(struct smbXsrv_session *session,
582 struct smbXsrv_connection *xconn);
583 NTSTATUS smbXsrv_session_disconnect_xconn(struct smbXsrv_connection *xconn);
584 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
585 struct smbXsrv_channel_global0;
586 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
587 const struct smbXsrv_connection *conn,
588 struct smbXsrv_channel_global0 **_c);
589 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
590 const struct smbXsrv_connection *conn,
591 NTTIME now,
592 struct smbXsrv_session_auth0 **_a);
593 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
594 struct smbXsrv_connection *conn,
595 NTTIME now,
596 uint8_t in_flags,
597 uint8_t in_security_mode,
598 struct smbXsrv_session_auth0 **_a);
599 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
600 struct tevent_context *ev,
601 struct smbXsrv_session *session,
602 struct smbd_smb2_request *current_req);
603 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
604 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
605 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_client *client);
606 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
607 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
608 uint16_t vuid, NTTIME now,
609 struct smbXsrv_session **session);
610 NTSTATUS smbXsrv_session_info_lookup(struct smbXsrv_client *client,
611 uint64_t session_wire_id,
612 struct auth_session_info **si);
613 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
614 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
615 uint64_t session_id, NTTIME now,
616 struct smbXsrv_session **session);
617 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
618 uint64_t session_id, NTTIME now,
619 struct smbXsrv_session **session);
620 NTSTATUS smb2srv_session_lookup_global(struct smbXsrv_client *client,
621 uint64_t session_wire_id,
622 TALLOC_CTX *mem_ctx,
623 struct smbXsrv_session **session);
624 NTSTATUS get_valid_smbXsrv_session(struct smbXsrv_client *client,
625 uint64_t session_wire_id,
626 struct smbXsrv_session **session);
627 NTSTATUS smbXsrv_session_local_traverse(
628 struct smbXsrv_client *client,
629 int (*caller_cb)(struct smbXsrv_session *session,
630 void *caller_data),
631 void *caller_data);
632 struct smbXsrv_session_global0;
633 NTSTATUS smbXsrv_session_global_traverse(
634 int (*fn)(struct smbXsrv_session_global0 *, void *),
635 void *private_data);
636 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
637 struct tevent_context *ev,
638 struct smbXsrv_connection *conn,
639 struct auth_session_info *session_info,
640 uint64_t previous_session_id,
641 uint64_t current_session_id);
642 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
644 NTSTATUS smbXsrv_tcon_global_init(void);
645 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
646 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
647 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
648 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
649 NTTIME now,
650 struct smbXsrv_tcon **_tcon);
651 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
652 uint16_t tree_id, NTTIME now,
653 struct smbXsrv_tcon **tcon);
654 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_client *client);
655 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
656 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
657 NTTIME now,
658 struct smbXsrv_tcon **_tcon);
659 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
660 uint32_t tree_id, NTTIME now,
661 struct smbXsrv_tcon **tcon);
662 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
663 struct smbXsrv_tcon_global0;
664 NTSTATUS smbXsrv_tcon_global_traverse(
665 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
666 void *private_data);
669 bool smbXsrv_is_encrypted(uint8_t encryption_flags);
670 bool smbXsrv_is_partially_encrypted(uint8_t encryption_flags);
671 bool smbXsrv_set_crypto_flag(uint8_t *flags, uint8_t flag);
672 bool smbXsrv_is_signed(uint8_t signing_flags);
673 bool smbXsrv_is_partially_signed(uint8_t signing_flags);
675 struct smbd_smb2_send_queue {
676 struct smbd_smb2_send_queue *prev, *next;
678 DATA_BLOB *sendfile_header;
679 uint32_t sendfile_body_size;
680 NTSTATUS *sendfile_status;
681 struct iovec *vector;
682 int count;
684 struct {
685 struct tevent_req *req;
686 struct timeval timeout;
687 uint64_t required_acked_bytes;
688 } ack;
690 TALLOC_CTX *mem_ctx;
693 struct smbd_smb2_request {
694 struct smbd_smb2_request *prev, *next;
696 struct smbd_server_connection *sconn;
697 struct smbXsrv_connection *xconn;
699 struct smbd_smb2_send_queue queue_entry;
701 /* the session the request operates on, maybe NULL */
702 struct smbXsrv_session *session;
703 uint64_t last_session_id;
705 /* the tcon the request operates on, maybe NULL */
706 struct smbXsrv_tcon *tcon;
707 uint32_t last_tid;
709 int current_idx;
710 bool do_signing;
711 /* Was the request encrypted? */
712 bool was_encrypted;
713 /* Should we encrypt? */
714 bool do_encryption;
715 struct tevent_timer *async_te;
716 bool compound_related;
717 NTSTATUS compound_create_err;
720 * Give the implementation of an SMB2 req a way to tell the SMB2 request
721 * processing engine that the internal request is going async, while
722 * preserving synchronous SMB2 behaviour.
724 bool async_internal;
727 * the encryption key for the whole
728 * compound chain
730 struct smb2_signing_key *first_enc_key;
732 * the signing key for the last
733 * request/response of a compound chain
735 struct smb2_signing_key *last_sign_key;
736 struct smbXsrv_preauth *preauth;
738 struct timeval request_time;
740 SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
742 /* fake smb1 request. */
743 struct smb_request *smb1req;
744 struct files_struct *compat_chain_fsp;
747 * Keep track of whether the outstanding request counters
748 * had been updated in dispatch, so that they need to be
749 * adapted again in reply.
751 bool request_counters_updated;
752 uint64_t channel_generation;
755 * The sub request for async backend calls.
756 * This is used for SMB2 Cancel.
758 struct tevent_req *subreq;
760 #define SMBD_SMB2_TF_IOV_OFS 0
761 #define SMBD_SMB2_HDR_IOV_OFS 1
762 #define SMBD_SMB2_BODY_IOV_OFS 2
763 #define SMBD_SMB2_DYN_IOV_OFS 3
765 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
767 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
768 (&req->dir.vector[(idx)+(ofs)])
770 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
771 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
772 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
773 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
774 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
775 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
776 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
777 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
779 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
780 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
781 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
782 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
783 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
784 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
785 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
786 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
787 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
788 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
790 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
791 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
792 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
793 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
794 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
795 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
796 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
797 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
798 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
799 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
801 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
803 struct {
805 * vector[0] TRANSPORT HEADER (empty)
807 * vector[1] SMB2_TRANSFORM (optional)
808 * vector[2] SMB2
809 * vector[3] fixed body
810 * vector[4] dynamic body
814 * vector[5] SMB2_TRANSFORM (optional)
815 * vector[6] SMB2
816 * vector[7] fixed body
817 * vector[8] dynamic body
822 struct iovec *vector;
823 int vector_count;
824 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
825 } in;
826 struct {
827 /* the NBT header is not allocated */
828 uint8_t nbt_hdr[4];
830 * vector[0] TRANSPORT HEADER
832 * vector[1] SMB2_TRANSFORM (optional)
833 * vector[2] SMB2
834 * vector[3] fixed body
835 * vector[4] dynamic body
839 * vector[5] SMB2_TRANSFORM (empty)
840 * vector[6] SMB2
841 * vector[7] fixed body
842 * vector[8] dynamic body
847 struct iovec *vector;
848 int vector_count;
849 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
850 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
851 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
852 uint8_t _body[0x58];
853 } out;
856 struct smbd_server_connection;
858 struct pending_message_list;
859 struct pending_auth_data;
861 struct pthreadpool_tevent;
862 struct dcesrv_context;
864 struct smbd_server_connection {
865 const struct tsocket_address *local_address;
866 const struct tsocket_address *remote_address;
867 const char *remote_hostname;
868 struct tevent_context *ev_ctx;
869 struct messaging_context *msg_ctx;
870 struct dcesrv_context *dce_ctx;
871 struct notify_context *notify_ctx;
872 bool using_smb2;
873 int trans_num;
875 size_t num_users;
877 size_t num_connections;
878 struct connection_struct *connections;
880 size_t num_files;
881 struct files_struct *files;
883 int real_max_open_files;
884 struct fsp_singleton_cache fsp_fi_cache;
886 struct pending_message_list *deferred_open_queue;
889 /* open directory handles. */
890 struct {
891 struct bitmap *dptr_bmap;
892 struct dptr_struct *dirptrs;
893 } searches;
895 uint64_t num_requests;
897 /* Current number of oplocks we have outstanding. */
898 struct {
899 int32_t exclusive_open;
900 int32_t level_II_open;
901 struct kernel_oplocks *kernel_ops;
902 } oplocks;
904 struct notify_mid_map *notify_mid_maps;
906 struct pthreadpool_tevent *pool;
908 struct smbXsrv_client *client;
911 extern struct smbXsrv_client *global_smbXsrv_client;
913 void smbd_init_globals(void);
915 /****************************************************************************
916 The buffer we keep around whilst an aio request is in process.
917 *****************************************************************************/
919 struct aio_extra {
920 files_struct *fsp;
921 struct smb_request *smbreq;
922 DATA_BLOB outbuf;
923 struct lock_struct lock;
924 size_t nbyte;
925 off_t offset;
926 bool write_through;
929 #endif /* _SOURCE3_SMBD_GLOBALS_H_ */