s3:smbd: add smbXsrv_session infrastructure
[Samba/gebeck_regimport.git] / source3 / smbd / globals.h
blobe452ae7aa13cd33f01e1a3fb8885ea4ca6a41301
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;
118 struct smbd_smb2_session;
119 struct smbd_smb2_tcon;
121 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
123 void smbd_lock_socket(struct smbd_server_connection *sconn);
124 void smbd_unlock_socket(struct smbd_server_connection *sconn);
126 NTSTATUS smbd_do_locking(struct smb_request *req,
127 files_struct *fsp,
128 uint8_t type,
129 int32_t timeout,
130 uint16_t num_ulocks,
131 struct smbd_lock_element *ulocks,
132 uint16_t num_locks,
133 struct smbd_lock_element *locks,
134 bool *async);
136 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
137 TALLOC_CTX *mem_ctx,
138 uint16_t info_level,
139 files_struct *fsp,
140 struct smb_filename *smb_fname,
141 bool delete_pending,
142 struct timespec write_time_ts,
143 struct ea_list *ea_list,
144 int lock_data_count,
145 char *lock_data,
146 uint16_t flags2,
147 unsigned int max_data_bytes,
148 char **ppdata,
149 unsigned int *pdata_size);
151 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
152 struct smb_request *req,
153 TALLOC_CTX *mem_ctx,
154 uint16_t info_level,
155 files_struct *fsp,
156 struct smb_filename *smb_fname,
157 char **ppdata, int total_data,
158 int *ret_data_size);
160 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
161 TALLOC_CTX *mem_ctx,
162 uint16_t info_level,
163 uint16_t flags2,
164 unsigned int max_data_bytes,
165 char **ppdata,
166 int *ret_data_len);
168 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
169 struct dptr_struct *dirptr,
170 const char *mask,
171 uint32_t dirtype,
172 bool dont_descend,
173 bool ask_sharemode,
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 smb_filename *smb_fname,
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 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
190 connection_struct *conn,
191 struct dptr_struct *dirptr,
192 uint16 flags2,
193 const char *path_mask,
194 uint32 dirtype,
195 int info_level,
196 int requires_resume_key,
197 bool dont_descend,
198 bool ask_sharemode,
199 uint8_t align,
200 bool do_pad,
201 char **ppdata,
202 char *base_data,
203 char *end_data,
204 int space_remaining,
205 bool *out_of_space,
206 bool *got_exact_match,
207 int *_last_entry_off,
208 struct ea_list *name_list);
210 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
211 const struct smb_filename *smb_fname,
212 uint32_t access_mask,
213 uint32_t *access_mask_out);
215 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
217 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
218 const char *reason,
219 const char *location);
220 #define smbd_server_connection_terminate(sconn, reason) \
221 smbd_server_connection_terminate_ex(sconn, reason, __location__)
223 const char *smb2_opcode_name(uint16_t opcode);
224 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
226 void reply_smb2002(struct smb_request *req, uint16_t choice);
227 void reply_smb20ff(struct smb_request *req, uint16_t choice);
228 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
229 const uint8_t *inbuf, size_t size);
231 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
232 NTSTATUS status,
233 DATA_BLOB *info,
234 const char *location);
235 #define smbd_smb2_request_error(req, status) \
236 smbd_smb2_request_error_ex(req, status, NULL, __location__)
237 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
238 NTSTATUS status,
239 DATA_BLOB body, DATA_BLOB *dyn,
240 const char *location);
241 #define smbd_smb2_request_done(req, body, dyn) \
242 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
244 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
245 uint64_t file_id_persistent,
246 uint64_t file_id_volatile,
247 uint8_t oplock_level);
249 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
250 struct tevent_req *subreq,
251 uint32_t defer_time);
253 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
254 void remove_smb2_chained_fsp(files_struct *fsp);
256 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
257 uint32_t data_length);
259 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
260 size_t expected_body_size);
262 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
264 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
266 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
267 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
268 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
269 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
270 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
271 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
272 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
273 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
274 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
281 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
282 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
283 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
284 struct tevent_immediate *im,
285 void *private_data);
287 /* SMB1 -> SMB2 glue. */
288 void send_break_message_smb2(files_struct *fsp, int level);
289 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
290 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
291 struct smb_request *req,
292 files_struct *fsp,
293 int lock_timeout,
294 int lock_num,
295 uint64_t smblctx,
296 enum brl_type lock_type,
297 enum brl_flavour lock_flav,
298 uint64_t offset,
299 uint64_t count,
300 uint64_t blocking_smblctx);
301 void process_blocking_lock_queue_smb2(
302 struct smbd_server_connection *sconn, struct timeval tv_curr);
303 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
304 struct byte_range_lock *br_lck,
305 enum file_close_type close_type);
306 /* From smbd/smb2_create.c */
307 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
308 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
309 struct timeval *p_request_time,
310 void **pp_state);
311 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
312 uint64_t mid);
313 void remove_deferred_open_message_smb2(
314 struct smbd_server_connection *sconn, uint64_t mid);
315 void schedule_deferred_open_message_smb2(
316 struct smbd_server_connection *sconn, uint64_t mid);
317 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
318 struct timeval request_time,
319 struct timeval timeout,
320 struct file_id id,
321 char *private_data,
322 size_t priv_len);
324 struct smbXsrv_connection {
325 struct smbd_server_connection *sconn;
327 const struct tsocket_address *local_address;
328 const struct tsocket_address *remote_address;
329 const char *remote_hostname;
331 struct tevent_context *ev_ctx;
332 struct messaging_context *msg_ctx;
334 enum protocol_types protocol;
336 struct {
337 struct {
338 uint32_t capabilities;
339 struct GUID guid;
340 uint16_t security_mode;
341 uint16_t num_dialects;
342 uint16_t *dialects;
343 } client;
344 struct {
345 uint32_t capabilities;
346 struct GUID guid;
347 uint16_t security_mode;
348 uint16_t dialect;
349 uint32_t max_trans;
350 uint32_t max_read;
351 uint32_t max_write;
352 } server;
353 } smb2;
355 struct msg_state *msg_state;
357 uint64_t smbd_idle_profstamp;
359 struct smbXsrv_session_table *session_table;
362 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
363 uint32_t smbXsrv_version_global_current(void);
365 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
366 enum protocol_types protocol);
368 NTSTATUS smbXsrv_session_global_init(void);
369 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
370 NTTIME now,
371 struct smbXsrv_session **_session);
372 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
373 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
374 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
375 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
376 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
377 uint16_t vuid, NTTIME now,
378 struct smbXsrv_session **session);
379 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
380 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
381 uint64_t session_id, NTTIME now,
382 struct smbXsrv_session **session);
384 struct smbd_smb2_request {
385 struct smbd_smb2_request *prev, *next;
387 TALLOC_CTX *mem_pool;
388 struct smbd_smb2_request **parent;
390 struct smbd_server_connection *sconn;
392 /* the session the request operates on, maybe NULL */
393 struct smbd_smb2_session *session;
394 uint64_t last_session_id;
396 /* the tcon the request operates on, maybe NULL */
397 struct smbd_smb2_tcon *tcon;
398 uint32_t last_tid;
400 int current_idx;
401 bool do_signing;
402 struct tevent_timer *async_te;
403 bool cancelled;
404 bool compound_related;
406 struct timeval request_time;
408 /* fake smb1 request. */
409 struct smb_request *smb1req;
410 struct files_struct *compat_chain_fsp;
412 NTSTATUS next_status;
415 * The sub request for async backend calls.
416 * This is used for SMB2 Cancel.
418 struct tevent_req *subreq;
420 struct {
421 /* the NBT header is not allocated */
422 uint8_t nbt_hdr[4];
424 * vector[0] NBT
426 * vector[1] SMB2
427 * vector[2] fixed body
428 * vector[3] dynamic body
432 * vector[4] SMB2
433 * vector[5] fixed body
434 * vector[6] dynamic body
439 struct iovec *vector;
440 int vector_count;
441 } in;
442 struct {
443 /* the NBT header is not allocated */
444 uint8_t nbt_hdr[4];
446 * vector[0] NBT
448 * vector[1] SMB2
449 * vector[2] fixed body
450 * vector[3] dynamic body
454 * vector[4] SMB2
455 * vector[5] fixed body
456 * vector[6] dynamic body
461 struct iovec *vector;
462 int vector_count;
463 } out;
466 struct smbd_server_connection;
467 struct user_struct;
469 struct smbd_smb2_session {
470 struct smbd_smb2_session *prev, *next;
471 struct smbd_server_connection *sconn;
472 NTSTATUS status;
473 uint64_t vuid;
474 struct gensec_security *gensec_security;
475 struct auth_session_info *session_info;
476 DATA_BLOB session_key;
477 bool do_signing;
479 struct user_struct *compat_vuser;
481 struct {
482 /* an id tree used to allocate tids */
483 struct idr_context *idtree;
485 /* this is the limit of tid values for this connection */
486 uint32_t limit;
488 struct smbd_smb2_tcon *list;
489 } tcons;
492 struct smbd_smb2_tcon {
493 struct smbd_smb2_tcon *prev, *next;
494 struct smbd_smb2_session *session;
495 uint32_t tid;
496 int snum;
497 connection_struct *compat_conn;
500 struct pending_message_list;
501 struct pending_auth_data;
503 struct user_struct {
504 struct user_struct *next, *prev;
505 uint64_t vuid; /* Tag for this entry. */
507 char *session_keystr; /* used by utmp and pam session code.
508 TDB key string */
509 int homes_snum;
511 struct auth_session_info *session_info;
513 struct gensec_security *gensec_security;
516 struct smbd_server_connection {
517 int sock;
518 const struct tsocket_address *local_address;
519 const struct tsocket_address *remote_address;
520 const char *remote_hostname;
521 struct tevent_context *ev_ctx;
522 struct messaging_context *msg_ctx;
523 struct sys_notify_context *sys_notify_ctx;
524 struct notify_context *notify_ctx;
525 struct {
526 bool got_session;
527 } nbt;
528 bool using_smb2;
529 int trans_num;
531 size_t num_users;
532 struct user_struct *users;
534 size_t num_connections;
535 struct connection_struct *connections;
537 size_t num_files;
538 struct files_struct *files;
540 struct bitmap *file_bmap;
541 int real_max_open_files;
542 struct fsp_singleton_cache fsp_fi_cache;
543 unsigned long file_gen_counter;
544 int first_file;
546 struct pending_message_list *deferred_open_queue;
549 /* open directory handles. */
550 struct {
551 struct bitmap *dptr_bmap;
552 struct dptr_struct *dirptrs;
553 int dirhandles_open;
554 } searches;
556 uint64_t num_requests;
558 /* Current number of oplocks we have outstanding. */
559 struct {
560 int32_t exclusive_open;
561 int32_t level_II_open;
562 struct kernel_oplocks *kernel_ops;
563 } oplocks;
565 struct {
566 struct fd_event *fde;
568 struct {
570 * fd for the fcntl lock mutexing access to our sock
572 int socket_lock_fd;
575 * fd for the trusted pipe from
576 * echo handler child
578 int trusted_fd;
581 * fde for the trusted_fd
583 struct fd_event *trusted_fde;
586 * Reference count for the fcntl lock to
587 * allow recursive locks.
589 int ref_count;
590 } echo_handler;
592 struct {
593 bool encrypted_passwords;
594 bool spnego;
595 struct auth4_context *auth_context;
596 bool done;
598 * Size of the data we can receive. Set by us.
599 * Can be modified by the max xmit parameter.
601 int max_recv;
602 } negprot;
604 struct {
605 uint16_t client_major;
606 uint16_t client_minor;
607 uint32_t client_cap_low;
608 uint32_t client_cap_high;
609 } unix_info;
611 struct {
612 bool done_sesssetup;
614 * Size of data we can send to client. Set
615 * by the client for all protocols above CORE.
616 * Set by us for CORE protocol.
618 int max_send;
619 uint64_t last_session_tag;
622 * this holds info on user ids that are already
623 * validated for this VC
625 uint16_t next_vuid;
626 } sessions;
627 struct {
628 /* number of open connections */
629 struct bitmap *bmap;
630 } tcons;
631 struct smb_signing_state *signing_state;
633 struct notify_mid_map *notify_mid_maps;
635 struct {
636 /* dlink list we store pending lock records on. */
637 struct blocking_lock_record *blocking_lock_queue;
638 /* dlink list we move cancelled lock records onto. */
639 struct blocking_lock_record *blocking_lock_cancelled_queue;
641 /* The event that makes us process our blocking lock queue */
642 struct timed_event *brl_timeout;
644 bool blocking_lock_unlock_state;
645 bool blocking_lock_cancel_state;
646 } locks;
647 } smb1;
648 struct {
649 struct tevent_queue *recv_queue;
650 struct tevent_queue *send_queue;
651 struct tstream_context *stream;
652 bool negprot_2ff;
653 struct {
654 /* an id tree used to allocate vuids */
655 /* this holds info on session vuids that are already
656 * validated for this VC */
657 struct idr_context *idtree;
659 /* this is the limit of vuid values for this connection */
660 uint64_t limit;
662 struct smbd_smb2_session *list;
663 } sessions;
664 struct {
665 /* The event that makes us process our blocking lock queue */
666 struct timed_event *brl_timeout;
667 bool blocking_lock_unlock_state;
668 } locks;
669 struct smbd_smb2_request *requests;
670 uint64_t seqnum_low;
671 uint32_t credits_granted;
672 uint32_t max_credits;
673 uint32_t max_trans;
674 uint32_t max_read;
675 uint32_t max_write;
676 bool supports_multicredit;
677 struct bitmap *credits_bitmap;
678 bool compound_related_in_progress;
679 } smb2;
681 struct smbXsrv_connection *conn;
684 extern struct smbXsrv_connection *global_smbXsrv_connection;
686 void smbd_init_globals(void);