lib: Make ctdbd_db_attach return 0/errno
[Samba.git] / source3 / smbd / globals.h
blobb567a5869e7096777ad9cd6fa2abe93573a9afd5
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"
23 #include "smbprofile.h"
25 extern int aio_pending_size;
26 extern int outstanding_aio_calls;
28 #ifdef USE_DMAPI
29 struct smbd_dmapi_context;
30 extern struct smbd_dmapi_context *dmapi_ctx;
31 #endif
33 /* how many write cache buffers have been allocated */
34 extern unsigned int allocated_write_caches;
36 /* A singleton cache to speed up searching by dev/inode. */
37 struct fsp_singleton_cache {
38 files_struct *fsp;
39 struct file_id id;
42 extern const struct mangle_fns *mangle_fns;
44 extern unsigned char *chartest;
45 struct tdb_context;
46 extern struct tdb_context *tdb_mangled_cache;
49 this determines how many characters are used from the original filename
50 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
51 The largest possible value is 6.
53 extern unsigned mangle_prefix;
55 struct msg_state;
57 extern bool logged_ioctl_message;
59 extern int trans_num;
61 extern time_t last_smb_conf_reload_time;
62 extern time_t last_printer_reload_time;
63 extern pid_t background_lpq_updater_pid;
65 /****************************************************************************
66 structure to hold a linked list of queued messages.
67 for processing.
68 ****************************************************************************/
69 extern uint32_t common_flags2;
71 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
72 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
74 struct sec_ctx {
75 struct security_unix_token ut;
76 struct security_token *token;
78 /* A stack of security contexts. We include the current context as being
79 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
80 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
81 extern int sec_ctx_stack_ndx;
82 extern bool become_uid_done;
83 extern bool become_gid_done;
85 extern connection_struct *last_conn;
86 extern uint16_t last_flags;
88 extern uint32_t global_client_caps;
90 extern uint16_t fnf_handle;
92 struct conn_ctx {
93 connection_struct *conn;
94 uint64_t vuid;
96 /* A stack of current_user connection contexts. */
97 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
98 extern int conn_ctx_stack_ndx;
100 struct vfs_init_function_entry;
101 extern struct vfs_init_function_entry *backends;
102 extern char *sparse_buf;
103 extern char *LastDir;
105 struct smbd_parent_context;
106 extern struct smbd_parent_context *am_parent;
107 extern struct memcache *smbd_memcache_ctx;
108 extern bool exit_firsttime;
110 struct tstream_context;
111 struct smbd_smb2_request;
113 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbXsrv_connection *xconn);
115 void smbd_lock_socket(struct smbXsrv_connection *xconn);
116 void smbd_unlock_socket(struct smbXsrv_connection *xconn);
118 NTSTATUS smbd_do_locking(struct smb_request *req,
119 files_struct *fsp,
120 uint8_t type,
121 int32_t timeout,
122 uint16_t num_locks,
123 struct smbd_lock_element *locks,
124 bool *async);
125 NTSTATUS smbd_do_unlocking(struct smb_request *req,
126 files_struct *fsp,
127 uint16_t num_ulocks,
128 struct smbd_lock_element *ulocks);
130 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
131 TALLOC_CTX *mem_ctx,
132 uint16_t info_level,
133 files_struct *fsp,
134 struct smb_filename *smb_fname,
135 bool delete_pending,
136 struct timespec write_time_ts,
137 struct ea_list *ea_list,
138 int lock_data_count,
139 char *lock_data,
140 uint16_t flags2,
141 unsigned int max_data_bytes,
142 size_t *fixed_portion,
143 char **ppdata,
144 unsigned int *pdata_size);
146 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
147 struct smb_request *req,
148 TALLOC_CTX *mem_ctx,
149 uint16_t info_level,
150 files_struct *fsp,
151 struct smb_filename *smb_fname,
152 char **ppdata, int total_data,
153 int *ret_data_size);
155 NTSTATUS smbd_do_qfsinfo(struct smbXsrv_connection *xconn,
156 connection_struct *conn,
157 TALLOC_CTX *mem_ctx,
158 uint16_t info_level,
159 uint16_t flags2,
160 unsigned int max_data_bytes,
161 size_t *fixed_portion,
162 struct smb_filename *smb_fname,
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 NTSTATUS smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
188 connection_struct *conn,
189 struct dptr_struct *dirptr,
190 uint16_t flags2,
191 const char *path_mask,
192 uint32_t 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 *got_exact_match,
204 int *_last_entry_off,
205 struct ea_list *name_list);
207 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
208 const struct smb_filename *smb_fname,
209 bool use_privs,
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 smbXsrv_connection *xconn,
216 const char *reason,
217 const char *location);
218 #define smbd_server_connection_terminate(xconn, reason) \
219 smbd_server_connection_terminate_ex(xconn, 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 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
225 struct smbXsrv_connection **_xconn);
227 void reply_smb2002(struct smb_request *req, uint16_t choice);
228 void reply_smb20ff(struct smb_request *req, uint16_t choice);
229 void smbd_smb2_process_negprot(struct smbXsrv_connection *xconn,
230 uint64_t expected_seq_low,
231 const uint8_t *inpdu, size_t size);
233 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
235 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
236 NTSTATUS status,
237 DATA_BLOB *info,
238 const char *location);
239 #define smbd_smb2_request_error(req, status) \
240 smbd_smb2_request_error_ex(req, status, NULL, __location__)
241 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
242 NTSTATUS status,
243 DATA_BLOB body, DATA_BLOB *dyn,
244 const char *location);
245 #define smbd_smb2_request_done(req, body, dyn) \
246 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
248 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_connection *xconn,
249 struct smbXsrv_session *session,
250 struct smbXsrv_tcon *tcon,
251 struct smbXsrv_open *op,
252 uint8_t oplock_level);
253 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_connection *xconn,
254 uint16_t new_epoch,
255 uint32_t lease_flags,
256 struct smb2_lease_key *lease_key,
257 uint32_t current_lease_state,
258 uint32_t new_lease_state);
260 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
261 struct tevent_req *subreq,
262 uint32_t defer_time);
264 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
265 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
266 void remove_smb2_chained_fsp(files_struct *fsp);
268 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
269 uint32_t data_length);
271 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
272 size_t expected_body_size);
274 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
275 const int dialect_count,
276 uint16_t *dialect);
277 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
281 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
282 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
283 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
284 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
285 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
286 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
287 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
288 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
289 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
290 int err);
291 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
292 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
293 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
294 NTSTATUS smbd_smb2_request_process_query_directory(struct smbd_smb2_request *req);
295 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
296 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
297 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
298 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
300 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
301 struct tevent_immediate *im,
302 void *private_data);
304 struct deferred_open_record;
306 /* SMB1 -> SMB2 glue. */
307 void send_break_message_smb2(files_struct *fsp,
308 uint32_t break_from,
309 uint32_t break_to);
310 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
311 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
312 struct smb_request *req,
313 files_struct *fsp,
314 int lock_timeout,
315 int lock_num,
316 uint64_t smblctx,
317 enum brl_type lock_type,
318 enum brl_flavour lock_flav,
319 uint64_t offset,
320 uint64_t count,
321 uint64_t blocking_smblctx);
322 void process_blocking_lock_queue_smb2(
323 struct smbd_server_connection *sconn, struct timeval tv_curr);
324 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
325 struct byte_range_lock *br_lck,
326 enum file_close_type close_type);
327 /* From smbd/smb2_create.c */
328 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
329 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
330 struct timeval *p_request_time,
331 struct deferred_open_record **open_rec);
332 bool open_was_deferred_smb2(
333 struct smbXsrv_connection *xconn, uint64_t mid);
334 void remove_deferred_open_message_smb2(
335 struct smbXsrv_connection *xconn, uint64_t mid);
336 bool schedule_deferred_open_message_smb2(
337 struct smbXsrv_connection *xconn, uint64_t mid);
338 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
339 struct timeval request_time,
340 struct timeval timeout,
341 struct file_id id,
342 struct deferred_open_record *open_rec);
344 struct smbXsrv_client;
346 struct smbXsrv_preauth {
347 uint8_t sha512_value[64];
350 struct smbXsrv_connection {
351 struct smbXsrv_connection *prev, *next;
353 struct smbXsrv_client *client;
356 const struct tsocket_address *local_address;
357 const struct tsocket_address *remote_address;
358 const char *remote_hostname;
360 struct tevent_context *ev_ctx;
361 struct messaging_context *msg_ctx;
363 enum protocol_types protocol;
365 struct {
366 NTSTATUS status;
367 int sock;
368 struct tevent_fd *fde;
370 struct {
371 bool got_session;
372 } nbt;
373 } transport;
375 struct {
376 struct {
378 * fd for the fcntl lock and process shared
379 * robust mutex to coordinate access to the
380 * client socket. When the system supports
381 * process shared robust mutexes, those are
382 * used. If not, then the fcntl lock will be
383 * used.
385 int socket_lock_fd;
386 #ifdef HAVE_ROBUST_MUTEXES
387 pthread_mutex_t *socket_mutex;
388 #endif
391 * fd for the trusted pipe from
392 * echo handler child
394 int trusted_fd;
397 * fde for the trusted_fd
399 struct tevent_fd *trusted_fde;
402 * Reference count for the fcntl lock to
403 * allow recursive locks.
405 int ref_count;
406 } echo_handler;
408 struct {
409 bool encrypted_passwords;
410 bool spnego;
411 struct auth4_context *auth_context;
412 bool done;
414 * Size of the data we can receive. Set by us.
415 * Can be modified by the max xmit parameter.
417 int max_recv;
418 } negprot;
420 struct {
421 bool done_sesssetup;
423 * Size of data we can send to client. Set
424 * by the client for all protocols above CORE.
425 * Set by us for CORE protocol.
427 int max_send;
428 } sessions;
429 struct smb_signing_state *signing_state;
431 struct {
432 uint16_t client_major;
433 uint16_t client_minor;
434 uint32_t client_cap_low;
435 uint32_t client_cap_high;
436 } unix_info;
438 struct msg_state *msg_state;
439 } smb1;
440 struct {
441 struct smbd_smb2_request_read_state {
442 struct smbd_smb2_request *req;
443 struct {
444 uint8_t nbt[NBT_HDR_SIZE];
445 bool done;
446 } hdr;
447 struct iovec vector;
448 bool doing_receivefile;
449 size_t min_recv_size;
450 size_t pktfull;
451 size_t pktlen;
452 uint8_t *pktbuf;
453 } request_read_state;
454 struct smbd_smb2_send_queue *send_queue;
455 size_t send_queue_len;
457 struct {
459 * seq_low is the lowest sequence number
460 * we will accept.
462 uint64_t seq_low;
464 * seq_range is the range of credits we have
465 * granted from the sequence windows starting
466 * at seq_low.
468 * This gets incremented when new credits are
469 * granted and gets decremented when the
470 * lowest sequence number is consumed
471 * (when seq_low gets incremented).
473 uint16_t seq_range;
475 * The number of credits we have currently granted
476 * to the client.
478 * This gets incremented when new credits are
479 * granted and gets decremented when any credit
480 * is comsumed.
482 * Note: the decrementing is different compared
483 * to seq_range.
485 uint16_t granted;
487 * The maximum number of credits we will ever
488 * grant to the client.
490 * Typically we will only grant 1/16th of
491 * max_credits.
493 * This is the "server max credits" parameter.
495 uint16_t max;
497 * a bitmap of size max_credits
499 struct bitmap *bitmap;
500 bool multicredit;
501 } credits;
503 bool allow_2ff;
504 struct {
505 uint32_t capabilities;
506 struct GUID guid;
507 uint16_t security_mode;
508 uint16_t num_dialects;
509 uint16_t *dialects;
510 } client;
511 struct {
512 uint32_t capabilities;
513 struct GUID guid;
514 uint16_t security_mode;
515 uint16_t dialect;
516 uint32_t max_trans;
517 uint32_t max_read;
518 uint32_t max_write;
519 uint16_t cipher;
520 } server;
522 struct smbXsrv_preauth preauth;
524 struct smbd_smb2_request *requests;
525 } smb2;
528 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
530 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
531 uint32_t smbXsrv_version_global_current(void);
533 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
534 enum protocol_types protocol);
536 NTSTATUS smbXsrv_session_global_init(void);
537 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
538 NTTIME now,
539 struct smbXsrv_session **_session);
540 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
541 struct smbXsrv_connection *conn,
542 struct smbXsrv_channel_global0 **_c);
543 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
544 struct smbXsrv_channel_global0;
545 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
546 const struct smbXsrv_connection *conn,
547 struct smbXsrv_channel_global0 **_c);
548 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
549 const struct smbXsrv_connection *conn,
550 NTTIME now,
551 struct smbXsrv_session_auth0 **_a);
552 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
553 struct smbXsrv_connection *conn,
554 NTTIME now,
555 uint8_t in_flags,
556 uint8_t in_security_mode,
557 struct smbXsrv_session_auth0 **_a);
558 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
559 struct tevent_context *ev,
560 struct smbXsrv_session *session,
561 struct smbd_smb2_request *current_req);
562 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
563 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
564 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
565 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
566 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
567 uint16_t vuid, NTTIME now,
568 struct smbXsrv_session **session);
569 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
570 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
571 uint64_t session_id, NTTIME now,
572 struct smbXsrv_session **session);
573 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
574 uint64_t session_id, NTTIME now,
575 struct smbXsrv_session **session);
576 struct smbXsrv_session_global0;
577 NTSTATUS smbXsrv_session_global_traverse(
578 int (*fn)(struct smbXsrv_session_global0 *, void *),
579 void *private_data);
580 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
581 struct tevent_context *ev,
582 struct smbXsrv_connection *conn,
583 struct auth_session_info *session_info,
584 uint64_t previous_session_id,
585 uint64_t current_session_id);
586 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
588 NTSTATUS smbXsrv_tcon_global_init(void);
589 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
590 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
591 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
592 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
593 NTTIME now,
594 struct smbXsrv_tcon **_tcon);
595 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
596 uint16_t tree_id, NTTIME now,
597 struct smbXsrv_tcon **tcon);
598 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
599 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
600 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
601 NTTIME now,
602 struct smbXsrv_tcon **_tcon);
603 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
604 uint32_t tree_id, NTTIME now,
605 struct smbXsrv_tcon **tcon);
606 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
607 struct smbXsrv_tcon_global0;
608 NTSTATUS smbXsrv_tcon_global_traverse(
609 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
610 void *private_data);
612 NTSTATUS smbXsrv_open_global_init(void);
613 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
614 struct auth_session_info *session_info,
615 NTTIME now,
616 struct smbXsrv_open **_open);
617 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
618 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
619 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
620 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
621 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
622 uint16_t fnum, NTTIME now,
623 struct smbXsrv_open **_open);
624 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
625 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
626 uint64_t persistent_id,
627 uint64_t volatile_id,
628 NTTIME now,
629 struct smbXsrv_open **_open);
630 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
631 struct auth_session_info *session_info,
632 uint64_t persistent_id,
633 const struct GUID *create_guid,
634 NTTIME now,
635 struct smbXsrv_open **_open);
636 struct smbXsrv_open_global0;
637 NTSTATUS smbXsrv_open_global_traverse(
638 int (*fn)(struct smbXsrv_open_global0 *, void *),
639 void *private_data);
641 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
643 struct smbd_smb2_send_queue {
644 struct smbd_smb2_send_queue *prev, *next;
646 DATA_BLOB *sendfile_header;
647 NTSTATUS *sendfile_status;
648 struct iovec *vector;
649 int count;
651 TALLOC_CTX *mem_ctx;
654 struct smbd_smb2_request {
655 struct smbd_smb2_request *prev, *next;
657 struct smbd_server_connection *sconn;
658 struct smbXsrv_connection *xconn;
660 struct smbd_smb2_send_queue queue_entry;
662 /* the session the request operates on, maybe NULL */
663 struct smbXsrv_session *session;
664 uint64_t last_session_id;
666 /* the tcon the request operates on, maybe NULL */
667 struct smbXsrv_tcon *tcon;
668 uint32_t last_tid;
670 int current_idx;
671 bool do_signing;
672 /* Was the request encrypted? */
673 bool was_encrypted;
674 /* Should we encrypt? */
675 bool do_encryption;
676 struct tevent_timer *async_te;
677 bool compound_related;
680 * the encryption key for the whole
681 * compound chain
683 DATA_BLOB first_key;
685 * the signing key for the last
686 * request/response of a compound chain
688 DATA_BLOB last_key;
689 struct smbXsrv_preauth *preauth;
691 struct timeval request_time;
693 SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
695 /* fake smb1 request. */
696 struct smb_request *smb1req;
697 struct files_struct *compat_chain_fsp;
700 * The sub request for async backend calls.
701 * This is used for SMB2 Cancel.
703 struct tevent_req *subreq;
705 #define SMBD_SMB2_TF_IOV_OFS 0
706 #define SMBD_SMB2_HDR_IOV_OFS 1
707 #define SMBD_SMB2_BODY_IOV_OFS 2
708 #define SMBD_SMB2_DYN_IOV_OFS 3
710 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
712 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
713 (&req->dir.vector[(idx)+(ofs)])
715 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
716 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
717 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
718 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
719 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
720 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
721 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
722 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
724 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
725 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
726 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
727 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
728 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
729 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
730 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
731 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
732 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
733 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
735 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
736 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
737 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
738 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
739 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
740 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
741 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
742 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
743 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
744 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
746 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
748 struct {
750 * vector[0] TRANSPORT HEADER (empty)
752 * vector[1] SMB2_TRANSFORM (optional)
753 * vector[2] SMB2
754 * vector[3] fixed body
755 * vector[4] dynamic body
759 * vector[5] SMB2_TRANSFORM (optional)
760 * vector[6] SMB2
761 * vector[7] fixed body
762 * vector[8] dynamic body
767 struct iovec *vector;
768 int vector_count;
769 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
770 } in;
771 struct {
772 /* the NBT header is not allocated */
773 uint8_t nbt_hdr[4];
775 * vector[0] TRANSPORT HEADER
777 * vector[1] SMB2_TRANSFORM (optional)
778 * vector[2] SMB2
779 * vector[3] fixed body
780 * vector[4] dynamic body
784 * vector[5] SMB2_TRANSFORM (empty)
785 * vector[6] SMB2
786 * vector[7] fixed body
787 * vector[8] dynamic body
792 struct iovec *vector;
793 int vector_count;
794 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
795 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
796 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
797 uint8_t _body[0x58];
798 } out;
801 struct smbd_server_connection;
802 struct user_struct;
804 struct pending_message_list;
805 struct pending_auth_data;
807 struct user_struct {
808 struct user_struct *next, *prev;
809 uint64_t vuid; /* Tag for this entry. */
811 char *session_keystr; /* used by utmp and pam session code.
812 TDB key string */
813 int homes_snum;
815 struct auth_session_info *session_info;
817 struct smbXsrv_session *session;
820 struct smbd_server_connection {
821 const struct tsocket_address *local_address;
822 const struct tsocket_address *remote_address;
823 const char *remote_hostname;
824 struct tevent_context *ev_ctx;
825 struct messaging_context *msg_ctx;
826 struct sys_notify_context *sys_notify_ctx;
827 struct notify_context *notify_ctx;
828 bool using_smb2;
829 int trans_num;
831 size_t num_users;
832 struct user_struct *users;
834 size_t num_connections;
835 struct connection_struct *connections;
837 size_t num_files;
838 struct files_struct *files;
840 int real_max_open_files;
841 struct fsp_singleton_cache fsp_fi_cache;
843 struct pending_message_list *deferred_open_queue;
846 /* open directory handles. */
847 struct {
848 struct bitmap *dptr_bmap;
849 struct dptr_struct *dirptrs;
850 int dirhandles_open;
851 } searches;
853 uint64_t num_requests;
855 /* Current number of oplocks we have outstanding. */
856 struct {
857 int32_t exclusive_open;
858 int32_t level_II_open;
859 struct kernel_oplocks *kernel_ops;
860 } oplocks;
862 struct {
863 struct notify_mid_map *notify_mid_maps;
865 struct {
866 /* dlink list we store pending lock records on. */
867 struct blocking_lock_record *blocking_lock_queue;
868 /* dlink list we move cancelled lock records onto. */
869 struct blocking_lock_record *blocking_lock_cancelled_queue;
871 /* The event that makes us process our blocking lock queue */
872 struct tevent_timer *brl_timeout;
874 bool blocking_lock_unlock_state;
875 bool blocking_lock_cancel_state;
876 } locks;
877 } smb1;
878 struct {
879 struct {
880 /* The event that makes us process our blocking lock queue */
881 struct tevent_timer *brl_timeout;
882 bool blocking_lock_unlock_state;
883 } locks;
884 } smb2;
887 * Link into libasys for asynchronous operations
889 struct asys_context *asys_ctx;
890 struct tevent_fd *asys_fde;
892 struct smbXsrv_client *client;
895 extern struct smbXsrv_client *global_smbXsrv_client;
897 void smbd_init_globals(void);