s3:smbd: make use of smbXsrv_tcon and smbXsrv_session for smb2
[Samba/gebeck_regimport.git] / source3 / smbd / globals.h
bloba68c2034c8a25b46cdb1ba0f209a01f59c118c18
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 #if defined(HAVE_AIO)
25 struct aio_extra;
26 extern struct aio_extra *aio_list_head;
27 extern struct tevent_signal *aio_signal_event;
28 extern int aio_pending_size;
29 extern int outstanding_aio_calls;
30 #endif
32 #ifdef USE_DMAPI
33 struct smbd_dmapi_context;
34 extern struct smbd_dmapi_context *dmapi_ctx;
35 #endif
37 extern bool dfree_broken;
39 /* how many write cache buffers have been allocated */
40 extern unsigned int allocated_write_caches;
42 /* A singleton cache to speed up searching by dev/inode. */
43 struct fsp_singleton_cache {
44 files_struct *fsp;
45 struct file_id id;
48 extern const struct mangle_fns *mangle_fns;
50 extern unsigned char *chartest;
51 struct tdb_context;
52 extern struct tdb_context *tdb_mangled_cache;
55 this determines how many characters are used from the original filename
56 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
57 The largest possible value is 6.
59 extern unsigned mangle_prefix;
61 struct msg_state;
63 extern bool logged_ioctl_message;
65 extern int trans_num;
67 extern time_t last_smb_conf_reload_time;
68 extern time_t last_printer_reload_time;
69 extern pid_t background_lpq_updater_pid;
71 /****************************************************************************
72 structure to hold a linked list of queued messages.
73 for processing.
74 ****************************************************************************/
75 extern uint32_t common_flags2;
77 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
78 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
80 struct sec_ctx {
81 struct security_unix_token ut;
82 struct security_token *token;
84 /* A stack of security contexts. We include the current context as being
85 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
86 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
87 extern int sec_ctx_stack_ndx;
88 extern bool become_uid_done;
89 extern bool become_gid_done;
91 extern connection_struct *last_conn;
92 extern uint16_t last_flags;
94 extern uint32_t global_client_caps;
96 extern uint16_t fnf_handle;
98 struct conn_ctx {
99 connection_struct *conn;
100 uint64_t vuid;
102 /* A stack of current_user connection contexts. */
103 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
104 extern int conn_ctx_stack_ndx;
106 struct vfs_init_function_entry;
107 extern struct vfs_init_function_entry *backends;
108 extern char *sparse_buf;
109 extern char *LastDir;
111 struct smbd_parent_context;
112 extern struct smbd_parent_context *am_parent;
113 extern struct memcache *smbd_memcache_ctx;
114 extern bool exit_firsttime;
116 struct tstream_context;
117 struct smbd_smb2_request;
119 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
121 void smbd_lock_socket(struct smbd_server_connection *sconn);
122 void smbd_unlock_socket(struct smbd_server_connection *sconn);
124 NTSTATUS smbd_do_locking(struct smb_request *req,
125 files_struct *fsp,
126 uint8_t type,
127 int32_t timeout,
128 uint16_t num_ulocks,
129 struct smbd_lock_element *ulocks,
130 uint16_t num_locks,
131 struct smbd_lock_element *locks,
132 bool *async);
134 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
135 TALLOC_CTX *mem_ctx,
136 uint16_t info_level,
137 files_struct *fsp,
138 struct smb_filename *smb_fname,
139 bool delete_pending,
140 struct timespec write_time_ts,
141 struct ea_list *ea_list,
142 int lock_data_count,
143 char *lock_data,
144 uint16_t flags2,
145 unsigned int max_data_bytes,
146 char **ppdata,
147 unsigned int *pdata_size);
149 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
150 struct smb_request *req,
151 TALLOC_CTX *mem_ctx,
152 uint16_t info_level,
153 files_struct *fsp,
154 struct smb_filename *smb_fname,
155 char **ppdata, int total_data,
156 int *ret_data_size);
158 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
159 TALLOC_CTX *mem_ctx,
160 uint16_t info_level,
161 uint16_t flags2,
162 unsigned int max_data_bytes,
163 char **ppdata,
164 int *ret_data_len);
166 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
167 struct dptr_struct *dirptr,
168 const char *mask,
169 uint32_t dirtype,
170 bool dont_descend,
171 bool ask_sharemode,
172 bool (*match_fn)(TALLOC_CTX *ctx,
173 void *private_data,
174 const char *dname,
175 const char *mask,
176 char **_fname),
177 bool (*mode_fn)(TALLOC_CTX *ctx,
178 void *private_data,
179 struct smb_filename *smb_fname,
180 uint32_t *_mode),
181 void *private_data,
182 char **_fname,
183 struct smb_filename **_smb_fname,
184 uint32_t *_mode,
185 long *_prev_offset);
187 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
188 connection_struct *conn,
189 struct dptr_struct *dirptr,
190 uint16 flags2,
191 const char *path_mask,
192 uint32 dirtype,
193 int info_level,
194 int requires_resume_key,
195 bool dont_descend,
196 bool ask_sharemode,
197 uint8_t align,
198 bool do_pad,
199 char **ppdata,
200 char *base_data,
201 char *end_data,
202 int space_remaining,
203 bool *out_of_space,
204 bool *got_exact_match,
205 int *_last_entry_off,
206 struct ea_list *name_list);
208 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
209 const struct smb_filename *smb_fname,
210 uint32_t access_mask,
211 uint32_t *access_mask_out);
213 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
215 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
216 const char *reason,
217 const char *location);
218 #define smbd_server_connection_terminate(sconn, reason) \
219 smbd_server_connection_terminate_ex(sconn, reason, __location__)
221 const char *smb2_opcode_name(uint16_t opcode);
222 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
224 void reply_smb2002(struct smb_request *req, uint16_t choice);
225 void reply_smb20ff(struct smb_request *req, uint16_t choice);
226 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
227 const uint8_t *inbuf, size_t size);
229 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
230 NTSTATUS status,
231 DATA_BLOB *info,
232 const char *location);
233 #define smbd_smb2_request_error(req, status) \
234 smbd_smb2_request_error_ex(req, status, NULL, __location__)
235 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
236 NTSTATUS status,
237 DATA_BLOB body, DATA_BLOB *dyn,
238 const char *location);
239 #define smbd_smb2_request_done(req, body, dyn) \
240 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
242 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
243 uint64_t file_id_persistent,
244 uint64_t file_id_volatile,
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 void remove_smb2_chained_fsp(files_struct *fsp);
254 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
255 uint32_t data_length);
257 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
258 size_t expected_body_size);
260 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
261 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
262 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
264 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
266 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
267 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
268 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
269 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
270 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
271 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
272 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
273 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
274 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
281 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
282 struct tevent_immediate *im,
283 void *private_data);
285 /* SMB1 -> SMB2 glue. */
286 void send_break_message_smb2(files_struct *fsp, int level);
287 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
288 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
289 struct smb_request *req,
290 files_struct *fsp,
291 int lock_timeout,
292 int lock_num,
293 uint64_t smblctx,
294 enum brl_type lock_type,
295 enum brl_flavour lock_flav,
296 uint64_t offset,
297 uint64_t count,
298 uint64_t blocking_smblctx);
299 void process_blocking_lock_queue_smb2(
300 struct smbd_server_connection *sconn, struct timeval tv_curr);
301 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
302 struct byte_range_lock *br_lck,
303 enum file_close_type close_type);
304 /* From smbd/smb2_create.c */
305 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
306 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
307 struct timeval *p_request_time,
308 void **pp_state);
309 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
310 uint64_t mid);
311 void remove_deferred_open_message_smb2(
312 struct smbd_server_connection *sconn, uint64_t mid);
313 void schedule_deferred_open_message_smb2(
314 struct smbd_server_connection *sconn, uint64_t mid);
315 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
316 struct timeval request_time,
317 struct timeval timeout,
318 struct file_id id,
319 char *private_data,
320 size_t priv_len);
322 struct smbXsrv_connection {
323 struct smbd_server_connection *sconn;
325 const struct tsocket_address *local_address;
326 const struct tsocket_address *remote_address;
327 const char *remote_hostname;
329 struct tevent_context *ev_ctx;
330 struct messaging_context *msg_ctx;
332 enum protocol_types protocol;
334 struct {
335 struct {
336 uint32_t capabilities;
337 struct GUID guid;
338 uint16_t security_mode;
339 uint16_t num_dialects;
340 uint16_t *dialects;
341 } client;
342 struct {
343 uint32_t capabilities;
344 struct GUID guid;
345 uint16_t security_mode;
346 uint16_t dialect;
347 uint32_t max_trans;
348 uint32_t max_read;
349 uint32_t max_write;
350 } server;
351 } smb2;
353 struct msg_state *msg_state;
355 uint64_t smbd_idle_profstamp;
357 struct smbXsrv_session_table *session_table;
358 struct smbXsrv_tcon_table *tcon_table;
361 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
362 uint32_t smbXsrv_version_global_current(void);
364 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
365 enum protocol_types protocol);
367 NTSTATUS smbXsrv_session_global_init(void);
368 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
369 NTTIME now,
370 struct smbXsrv_session **_session);
371 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
372 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
373 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
374 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
375 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
376 uint16_t vuid, NTTIME now,
377 struct smbXsrv_session **session);
378 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
379 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
380 uint64_t session_id, NTTIME now,
381 struct smbXsrv_session **session);
383 NTSTATUS smbXsrv_tcon_global_init(void);
384 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
385 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
386 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
387 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
388 NTTIME now,
389 struct smbXsrv_tcon **_tcon);
390 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
391 uint16_t tree_id, NTTIME now,
392 struct smbXsrv_tcon **tcon);
393 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
394 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
395 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
396 NTTIME now,
397 struct smbXsrv_tcon **_tcon);
398 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
399 uint32_t tree_id, NTTIME now,
400 struct smbXsrv_tcon **tcon);
401 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
403 struct smbd_smb2_request {
404 struct smbd_smb2_request *prev, *next;
406 TALLOC_CTX *mem_pool;
407 struct smbd_smb2_request **parent;
409 struct smbd_server_connection *sconn;
411 /* the session the request operates on, maybe NULL */
412 struct smbXsrv_session *session;
413 uint64_t last_session_id;
415 /* the tcon the request operates on, maybe NULL */
416 struct smbXsrv_tcon *tcon;
417 uint32_t last_tid;
419 int current_idx;
420 bool do_signing;
421 struct tevent_timer *async_te;
422 bool cancelled;
423 bool compound_related;
425 struct timeval request_time;
427 /* fake smb1 request. */
428 struct smb_request *smb1req;
429 struct files_struct *compat_chain_fsp;
431 NTSTATUS next_status;
434 * The sub request for async backend calls.
435 * This is used for SMB2 Cancel.
437 struct tevent_req *subreq;
439 struct {
440 /* the NBT header is not allocated */
441 uint8_t nbt_hdr[4];
443 * vector[0] NBT
445 * vector[1] SMB2
446 * vector[2] fixed body
447 * vector[3] dynamic body
451 * vector[4] SMB2
452 * vector[5] fixed body
453 * vector[6] dynamic body
458 struct iovec *vector;
459 int vector_count;
460 } in;
461 struct {
462 /* the NBT header is not allocated */
463 uint8_t nbt_hdr[4];
465 * vector[0] NBT
467 * vector[1] SMB2
468 * vector[2] fixed body
469 * vector[3] dynamic body
473 * vector[4] SMB2
474 * vector[5] fixed body
475 * vector[6] dynamic body
480 struct iovec *vector;
481 int vector_count;
482 } out;
485 struct smbd_server_connection;
486 struct user_struct;
488 struct pending_message_list;
489 struct pending_auth_data;
491 struct user_struct {
492 struct user_struct *next, *prev;
493 uint64_t vuid; /* Tag for this entry. */
495 char *session_keystr; /* used by utmp and pam session code.
496 TDB key string */
497 int homes_snum;
499 struct auth_session_info *session_info;
501 struct gensec_security *gensec_security;
503 struct smbXsrv_session0 *session;
506 struct smbd_server_connection {
507 int sock;
508 const struct tsocket_address *local_address;
509 const struct tsocket_address *remote_address;
510 const char *remote_hostname;
511 struct tevent_context *ev_ctx;
512 struct messaging_context *msg_ctx;
513 struct sys_notify_context *sys_notify_ctx;
514 struct notify_context *notify_ctx;
515 struct {
516 bool got_session;
517 } nbt;
518 bool using_smb2;
519 int trans_num;
521 size_t num_users;
522 struct user_struct *users;
524 size_t num_connections;
525 struct connection_struct *connections;
527 size_t num_files;
528 struct files_struct *files;
530 struct bitmap *file_bmap;
531 int real_max_open_files;
532 struct fsp_singleton_cache fsp_fi_cache;
533 unsigned long file_gen_counter;
534 int first_file;
536 struct pending_message_list *deferred_open_queue;
539 /* open directory handles. */
540 struct {
541 struct bitmap *dptr_bmap;
542 struct dptr_struct *dirptrs;
543 int dirhandles_open;
544 } searches;
546 uint64_t num_requests;
548 /* Current number of oplocks we have outstanding. */
549 struct {
550 int32_t exclusive_open;
551 int32_t level_II_open;
552 struct kernel_oplocks *kernel_ops;
553 } oplocks;
555 struct {
556 struct fd_event *fde;
558 struct {
560 * fd for the fcntl lock mutexing access to our sock
562 int socket_lock_fd;
565 * fd for the trusted pipe from
566 * echo handler child
568 int trusted_fd;
571 * fde for the trusted_fd
573 struct fd_event *trusted_fde;
576 * Reference count for the fcntl lock to
577 * allow recursive locks.
579 int ref_count;
580 } echo_handler;
582 struct {
583 bool encrypted_passwords;
584 bool spnego;
585 struct auth4_context *auth_context;
586 bool done;
588 * Size of the data we can receive. Set by us.
589 * Can be modified by the max xmit parameter.
591 int max_recv;
592 } negprot;
594 struct {
595 uint16_t client_major;
596 uint16_t client_minor;
597 uint32_t client_cap_low;
598 uint32_t client_cap_high;
599 } unix_info;
601 struct {
602 bool done_sesssetup;
604 * Size of data we can send to client. Set
605 * by the client for all protocols above CORE.
606 * Set by us for CORE protocol.
608 int max_send;
609 uint64_t last_session_tag;
612 * this holds info on user ids that are already
613 * validated for this VC
615 uint16_t next_vuid;
616 } sessions;
617 struct {
618 /* number of open connections */
619 struct bitmap *bmap;
620 } tcons;
621 struct smb_signing_state *signing_state;
623 struct notify_mid_map *notify_mid_maps;
625 struct {
626 /* dlink list we store pending lock records on. */
627 struct blocking_lock_record *blocking_lock_queue;
628 /* dlink list we move cancelled lock records onto. */
629 struct blocking_lock_record *blocking_lock_cancelled_queue;
631 /* The event that makes us process our blocking lock queue */
632 struct timed_event *brl_timeout;
634 bool blocking_lock_unlock_state;
635 bool blocking_lock_cancel_state;
636 } locks;
637 } smb1;
638 struct {
639 struct tevent_queue *recv_queue;
640 struct tevent_queue *send_queue;
641 struct tstream_context *stream;
642 bool negprot_2ff;
643 struct {
644 /* The event that makes us process our blocking lock queue */
645 struct timed_event *brl_timeout;
646 bool blocking_lock_unlock_state;
647 } locks;
648 struct smbd_smb2_request *requests;
649 uint64_t seqnum_low;
650 uint32_t credits_granted;
651 uint32_t max_credits;
652 uint32_t max_trans;
653 uint32_t max_read;
654 uint32_t max_write;
655 bool supports_multicredit;
656 struct bitmap *credits_bitmap;
657 bool compound_related_in_progress;
658 } smb2;
660 struct smbXsrv_connection *conn;
663 extern struct smbXsrv_connection *global_smbXsrv_connection;
665 void smbd_init_globals(void);