lib: Fix CID 1034723 Explicit null dereferenced
[Samba.git] / source3 / smbd / globals.h
blob3ddafafa49ba1797dcd6f63ffa6b51c526c0fe83
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 extern bool dfree_broken;
35 /* how many write cache buffers have been allocated */
36 extern unsigned int allocated_write_caches;
38 /* A singleton cache to speed up searching by dev/inode. */
39 struct fsp_singleton_cache {
40 files_struct *fsp;
41 struct file_id id;
44 extern const struct mangle_fns *mangle_fns;
46 extern unsigned char *chartest;
47 struct tdb_context;
48 extern struct tdb_context *tdb_mangled_cache;
51 this determines how many characters are used from the original filename
52 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
53 The largest possible value is 6.
55 extern unsigned mangle_prefix;
57 struct msg_state;
59 extern bool logged_ioctl_message;
61 extern int trans_num;
63 extern time_t last_smb_conf_reload_time;
64 extern time_t last_printer_reload_time;
65 extern pid_t background_lpq_updater_pid;
67 /****************************************************************************
68 structure to hold a linked list of queued messages.
69 for processing.
70 ****************************************************************************/
71 extern uint32_t common_flags2;
73 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
74 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
76 struct sec_ctx {
77 struct security_unix_token ut;
78 struct security_token *token;
80 /* A stack of security contexts. We include the current context as being
81 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
82 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
83 extern int sec_ctx_stack_ndx;
84 extern bool become_uid_done;
85 extern bool become_gid_done;
87 extern connection_struct *last_conn;
88 extern uint16_t last_flags;
90 extern uint32_t global_client_caps;
92 extern uint16_t fnf_handle;
94 struct conn_ctx {
95 connection_struct *conn;
96 uint64_t vuid;
98 /* A stack of current_user connection contexts. */
99 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
100 extern int conn_ctx_stack_ndx;
102 struct vfs_init_function_entry;
103 extern struct vfs_init_function_entry *backends;
104 extern char *sparse_buf;
105 extern char *LastDir;
107 struct smbd_parent_context;
108 extern struct smbd_parent_context *am_parent;
109 extern struct memcache *smbd_memcache_ctx;
110 extern bool exit_firsttime;
112 struct tstream_context;
113 struct smbd_smb2_request;
115 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbXsrv_connection *xconn);
117 void smbd_lock_socket(struct smbXsrv_connection *xconn);
118 void smbd_unlock_socket(struct smbXsrv_connection *xconn);
120 NTSTATUS smbd_do_locking(struct smb_request *req,
121 files_struct *fsp,
122 uint8_t type,
123 int32_t timeout,
124 uint16_t num_locks,
125 struct smbd_lock_element *locks,
126 bool *async);
127 NTSTATUS smbd_do_unlocking(struct smb_request *req,
128 files_struct *fsp,
129 uint16_t num_ulocks,
130 struct smbd_lock_element *ulocks);
132 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
133 TALLOC_CTX *mem_ctx,
134 uint16_t info_level,
135 files_struct *fsp,
136 struct smb_filename *smb_fname,
137 bool delete_pending,
138 struct timespec write_time_ts,
139 struct ea_list *ea_list,
140 int lock_data_count,
141 char *lock_data,
142 uint16_t flags2,
143 unsigned int max_data_bytes,
144 size_t *fixed_portion,
145 char **ppdata,
146 unsigned int *pdata_size);
148 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
149 struct smb_request *req,
150 TALLOC_CTX *mem_ctx,
151 uint16_t info_level,
152 files_struct *fsp,
153 struct smb_filename *smb_fname,
154 char **ppdata, int total_data,
155 int *ret_data_size);
157 NTSTATUS smbd_do_qfsinfo(struct smbXsrv_connection *xconn,
158 connection_struct *conn,
159 TALLOC_CTX *mem_ctx,
160 uint16_t info_level,
161 uint16_t flags2,
162 unsigned int max_data_bytes,
163 size_t *fixed_portion,
164 struct smb_filename *smb_fname,
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 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 uint8_t align,
200 bool do_pad,
201 char **ppdata,
202 char *base_data,
203 char *end_data,
204 int space_remaining,
205 bool *got_exact_match,
206 int *_last_entry_off,
207 struct ea_list *name_list);
209 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
210 const struct smb_filename *smb_fname,
211 bool use_privs,
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 smbXsrv_connection *xconn,
218 const char *reason,
219 const char *location);
220 #define smbd_server_connection_terminate(xconn, reason) \
221 smbd_server_connection_terminate_ex(xconn, 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 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
227 struct smbXsrv_connection **_xconn);
229 void reply_smb2002(struct smb_request *req, uint16_t choice);
230 void reply_smb20ff(struct smb_request *req, uint16_t choice);
231 void smbd_smb2_first_negprot(struct smbXsrv_connection *xconn,
232 const uint8_t *inpdu, size_t size);
234 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
236 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
237 NTSTATUS status,
238 DATA_BLOB *info,
239 const char *location);
240 #define smbd_smb2_request_error(req, status) \
241 smbd_smb2_request_error_ex(req, status, NULL, __location__)
242 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
243 NTSTATUS status,
244 DATA_BLOB body, DATA_BLOB *dyn,
245 const char *location);
246 #define smbd_smb2_request_done(req, body, dyn) \
247 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
249 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_connection *xconn,
250 struct smbXsrv_session *session,
251 struct smbXsrv_tcon *tcon,
252 struct smbXsrv_open *op,
253 uint8_t oplock_level);
254 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_connection *xconn,
255 uint16_t new_epoch,
256 uint32_t lease_flags,
257 struct smb2_lease_key *lease_key,
258 uint32_t current_lease_state,
259 uint32_t new_lease_state);
261 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
262 struct tevent_req *subreq,
263 uint32_t defer_time);
265 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
266 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
267 void remove_smb2_chained_fsp(files_struct *fsp);
269 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
270 uint32_t data_length);
272 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
273 size_t expected_body_size);
275 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
276 const int dialect_count,
277 uint16_t *dialect);
278 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
281 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
282 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
283 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
284 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
285 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
286 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
287 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
288 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
289 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
290 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
291 int err);
292 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
293 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
294 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
295 NTSTATUS smbd_smb2_request_process_query_directory(struct smbd_smb2_request *req);
296 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
297 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
298 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
301 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
302 struct tevent_immediate *im,
303 void *private_data);
305 struct deferred_open_record;
307 /* SMB1 -> SMB2 glue. */
308 void send_break_message_smb2(files_struct *fsp,
309 uint32_t break_from,
310 uint32_t break_to);
311 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
312 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
313 struct smb_request *req,
314 files_struct *fsp,
315 int lock_timeout,
316 int lock_num,
317 uint64_t smblctx,
318 enum brl_type lock_type,
319 enum brl_flavour lock_flav,
320 uint64_t offset,
321 uint64_t count,
322 uint64_t blocking_smblctx);
323 void process_blocking_lock_queue_smb2(
324 struct smbd_server_connection *sconn, struct timeval tv_curr);
325 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
326 struct byte_range_lock *br_lck,
327 enum file_close_type close_type);
328 /* From smbd/smb2_create.c */
329 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
330 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
331 struct timeval *p_request_time,
332 struct deferred_open_record **open_rec);
333 bool open_was_deferred_smb2(
334 struct smbXsrv_connection *xconn, uint64_t mid);
335 void remove_deferred_open_message_smb2(
336 struct smbXsrv_connection *xconn, uint64_t mid);
337 bool schedule_deferred_open_message_smb2(
338 struct smbXsrv_connection *xconn, uint64_t mid);
339 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
340 struct timeval request_time,
341 struct timeval timeout,
342 struct file_id id,
343 struct deferred_open_record *open_rec);
345 struct smbXsrv_client;
347 struct smbXsrv_preauth {
348 uint8_t sha512_value[64];
351 struct smbXsrv_connection {
352 struct smbXsrv_connection *prev, *next;
354 struct smbXsrv_client *client;
357 const struct tsocket_address *local_address;
358 const struct tsocket_address *remote_address;
359 const char *remote_hostname;
361 struct tevent_context *ev_ctx;
362 struct messaging_context *msg_ctx;
364 enum protocol_types protocol;
366 struct {
367 NTSTATUS status;
368 int sock;
369 struct tevent_fd *fde;
371 struct {
372 bool got_session;
373 } nbt;
374 } transport;
376 struct {
377 struct {
379 * fd for the fcntl lock and process shared
380 * robust mutex to coordinate access to the
381 * client socket. When the system supports
382 * process shared robust mutexes, those are
383 * used. If not, then the fcntl lock will be
384 * used.
386 int socket_lock_fd;
387 #ifdef HAVE_ROBUST_MUTEXES
388 pthread_mutex_t *socket_mutex;
389 #endif
392 * fd for the trusted pipe from
393 * echo handler child
395 int trusted_fd;
398 * fde for the trusted_fd
400 struct tevent_fd *trusted_fde;
403 * Reference count for the fcntl lock to
404 * allow recursive locks.
406 int ref_count;
407 } echo_handler;
409 struct {
410 bool encrypted_passwords;
411 bool spnego;
412 struct auth4_context *auth_context;
413 bool done;
415 * Size of the data we can receive. Set by us.
416 * Can be modified by the max xmit parameter.
418 int max_recv;
419 } negprot;
421 struct {
422 bool done_sesssetup;
424 * Size of data we can send to client. Set
425 * by the client for all protocols above CORE.
426 * Set by us for CORE protocol.
428 int max_send;
429 } sessions;
430 struct smb_signing_state *signing_state;
432 struct {
433 uint16_t client_major;
434 uint16_t client_minor;
435 uint32_t client_cap_low;
436 uint32_t client_cap_high;
437 } unix_info;
439 struct msg_state *msg_state;
440 } smb1;
441 struct {
442 struct smbd_smb2_request_read_state {
443 struct smbd_smb2_request *req;
444 struct {
445 uint8_t nbt[NBT_HDR_SIZE];
446 bool done;
447 } hdr;
448 struct iovec vector;
449 bool doing_receivefile;
450 size_t min_recv_size;
451 size_t pktfull;
452 size_t pktlen;
453 uint8_t *pktbuf;
454 } request_read_state;
455 struct smbd_smb2_send_queue *send_queue;
456 size_t send_queue_len;
458 struct {
460 * seq_low is the lowest sequence number
461 * we will accept.
463 uint64_t seq_low;
465 * seq_range is the range of credits we have
466 * granted from the sequence windows starting
467 * at seq_low.
469 * This gets incremented when new credits are
470 * granted and gets decremented when the
471 * lowest sequence number is consumed
472 * (when seq_low gets incremented).
474 uint16_t seq_range;
476 * The number of credits we have currently granted
477 * to the client.
479 * This gets incremented when new credits are
480 * granted and gets decremented when any credit
481 * is comsumed.
483 * Note: the decrementing is different compared
484 * to seq_range.
486 uint16_t granted;
488 * The maximum number of credits we will ever
489 * grant to the client.
491 * Typically we will only grant 1/16th of
492 * max_credits.
494 * This is the "server max credits" parameter.
496 uint16_t max;
498 * a bitmap of size max_credits
500 struct bitmap *bitmap;
501 bool multicredit;
502 } credits;
504 bool allow_2ff;
505 struct {
506 uint32_t capabilities;
507 struct GUID guid;
508 uint16_t security_mode;
509 uint16_t num_dialects;
510 uint16_t *dialects;
511 } client;
512 struct {
513 uint32_t capabilities;
514 struct GUID guid;
515 uint16_t security_mode;
516 uint16_t dialect;
517 uint32_t max_trans;
518 uint32_t max_read;
519 uint32_t max_write;
520 uint16_t cipher;
521 } server;
523 struct smbXsrv_preauth preauth;
525 struct smbd_smb2_request *requests;
526 } smb2;
529 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
531 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
532 uint32_t smbXsrv_version_global_current(void);
534 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
535 enum protocol_types protocol);
537 NTSTATUS smbXsrv_session_global_init(void);
538 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
539 NTTIME now,
540 struct smbXsrv_session **_session);
541 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
542 struct smbXsrv_channel_global0;
543 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
544 const struct smbXsrv_connection *conn,
545 struct smbXsrv_channel_global0 **_c);
546 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
547 struct tevent_context *ev,
548 struct smbXsrv_session *session,
549 struct smbd_smb2_request *current_req);
550 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
551 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
552 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
553 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
554 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
555 uint16_t vuid, NTTIME now,
556 struct smbXsrv_session **session);
557 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
558 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
559 uint64_t session_id, NTTIME now,
560 struct smbXsrv_session **session);
561 struct smbXsrv_session_global0;
562 NTSTATUS smbXsrv_session_global_traverse(
563 int (*fn)(struct smbXsrv_session_global0 *, void *),
564 void *private_data);
565 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
566 struct tevent_context *ev,
567 struct smbXsrv_connection *conn,
568 struct auth_session_info *session_info,
569 uint64_t previous_session_id,
570 uint64_t current_session_id);
571 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
573 NTSTATUS smbXsrv_tcon_global_init(void);
574 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
575 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
576 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
577 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
578 NTTIME now,
579 struct smbXsrv_tcon **_tcon);
580 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
581 uint16_t tree_id, NTTIME now,
582 struct smbXsrv_tcon **tcon);
583 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
584 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
585 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
586 NTTIME now,
587 struct smbXsrv_tcon **_tcon);
588 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
589 uint32_t tree_id, NTTIME now,
590 struct smbXsrv_tcon **tcon);
591 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
592 struct smbXsrv_tcon_global0;
593 NTSTATUS smbXsrv_tcon_global_traverse(
594 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
595 void *private_data);
597 NTSTATUS smbXsrv_open_global_init(void);
598 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
599 struct auth_session_info *session_info,
600 NTTIME now,
601 struct smbXsrv_open **_open);
602 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
603 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
604 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
605 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
606 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
607 uint16_t fnum, NTTIME now,
608 struct smbXsrv_open **_open);
609 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
610 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
611 uint64_t persistent_id,
612 uint64_t volatile_id,
613 NTTIME now,
614 struct smbXsrv_open **_open);
615 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
616 struct auth_session_info *session_info,
617 uint64_t persistent_id,
618 const struct GUID *create_guid,
619 NTTIME now,
620 struct smbXsrv_open **_open);
621 struct smbXsrv_open_global0;
622 NTSTATUS smbXsrv_open_global_traverse(
623 int (*fn)(struct smbXsrv_open_global0 *, void *),
624 void *private_data);
626 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
628 struct smbd_smb2_send_queue {
629 struct smbd_smb2_send_queue *prev, *next;
631 DATA_BLOB *sendfile_header;
632 NTSTATUS *sendfile_status;
633 struct iovec *vector;
634 int count;
636 TALLOC_CTX *mem_ctx;
639 struct smbd_smb2_request {
640 struct smbd_smb2_request *prev, *next;
642 struct smbd_server_connection *sconn;
643 struct smbXsrv_connection *xconn;
645 struct smbd_smb2_send_queue queue_entry;
647 /* the session the request operates on, maybe NULL */
648 struct smbXsrv_session *session;
649 uint64_t last_session_id;
651 /* the tcon the request operates on, maybe NULL */
652 struct smbXsrv_tcon *tcon;
653 uint32_t last_tid;
655 int current_idx;
656 bool do_signing;
657 bool do_encryption;
658 struct tevent_timer *async_te;
659 bool compound_related;
662 * the encryption key for the whole
663 * compound chain
665 DATA_BLOB first_key;
667 * the signing key for the last
668 * request/response of a compound chain
670 DATA_BLOB last_key;
671 struct smbXsrv_preauth *preauth;
673 struct timeval request_time;
675 SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
677 /* fake smb1 request. */
678 struct smb_request *smb1req;
679 struct files_struct *compat_chain_fsp;
682 * The sub request for async backend calls.
683 * This is used for SMB2 Cancel.
685 struct tevent_req *subreq;
687 #define SMBD_SMB2_TF_IOV_OFS 0
688 #define SMBD_SMB2_HDR_IOV_OFS 1
689 #define SMBD_SMB2_BODY_IOV_OFS 2
690 #define SMBD_SMB2_DYN_IOV_OFS 3
692 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
694 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
695 (&req->dir.vector[(idx)+(ofs)])
697 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
698 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
699 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
700 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
701 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
702 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
703 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
704 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
706 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
707 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
708 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
709 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
710 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
711 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
712 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
713 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
714 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
715 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
717 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
718 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
719 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
720 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
721 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
722 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
723 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
724 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
725 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
726 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
728 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
730 struct {
732 * vector[0] TRANSPORT HEADER (empty)
734 * vector[1] SMB2_TRANSFORM (optional)
735 * vector[2] SMB2
736 * vector[3] fixed body
737 * vector[4] dynamic body
741 * vector[5] SMB2_TRANSFORM (optional)
742 * vector[6] SMB2
743 * vector[7] fixed body
744 * vector[8] dynamic body
749 struct iovec *vector;
750 int vector_count;
751 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
752 } in;
753 struct {
754 /* the NBT header is not allocated */
755 uint8_t nbt_hdr[4];
757 * vector[0] TRANSPORT HEADER
759 * vector[1] SMB2_TRANSFORM (optional)
760 * vector[2] SMB2
761 * vector[3] fixed body
762 * vector[4] dynamic body
766 * vector[5] SMB2_TRANSFORM (empty)
767 * vector[6] SMB2
768 * vector[7] fixed body
769 * vector[8] dynamic body
774 struct iovec *vector;
775 int vector_count;
776 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
777 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
778 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
779 uint8_t _body[0x58];
780 } out;
783 struct smbd_server_connection;
784 struct user_struct;
786 struct pending_message_list;
787 struct pending_auth_data;
789 struct user_struct {
790 struct user_struct *next, *prev;
791 uint64_t vuid; /* Tag for this entry. */
793 char *session_keystr; /* used by utmp and pam session code.
794 TDB key string */
795 int homes_snum;
797 struct auth_session_info *session_info;
799 struct smbXsrv_session *session;
802 struct smbd_server_connection {
803 const struct tsocket_address *local_address;
804 const struct tsocket_address *remote_address;
805 const char *remote_hostname;
806 struct tevent_context *ev_ctx;
807 struct messaging_context *msg_ctx;
808 struct sys_notify_context *sys_notify_ctx;
809 struct notify_context *notify_ctx;
810 bool using_smb2;
811 int trans_num;
813 size_t num_users;
814 struct user_struct *users;
816 size_t num_connections;
817 struct connection_struct *connections;
819 size_t num_files;
820 struct files_struct *files;
822 int real_max_open_files;
823 struct fsp_singleton_cache fsp_fi_cache;
825 struct pending_message_list *deferred_open_queue;
828 /* open directory handles. */
829 struct {
830 struct bitmap *dptr_bmap;
831 struct dptr_struct *dirptrs;
832 int dirhandles_open;
833 } searches;
835 uint64_t num_requests;
837 /* Current number of oplocks we have outstanding. */
838 struct {
839 int32_t exclusive_open;
840 int32_t level_II_open;
841 struct kernel_oplocks *kernel_ops;
842 } oplocks;
844 struct {
845 struct notify_mid_map *notify_mid_maps;
847 struct {
848 /* dlink list we store pending lock records on. */
849 struct blocking_lock_record *blocking_lock_queue;
850 /* dlink list we move cancelled lock records onto. */
851 struct blocking_lock_record *blocking_lock_cancelled_queue;
853 /* The event that makes us process our blocking lock queue */
854 struct tevent_timer *brl_timeout;
856 bool blocking_lock_unlock_state;
857 bool blocking_lock_cancel_state;
858 } locks;
859 } smb1;
860 struct {
861 struct {
862 /* The event that makes us process our blocking lock queue */
863 struct tevent_timer *brl_timeout;
864 bool blocking_lock_unlock_state;
865 } locks;
866 } smb2;
869 * Link into libasys for asynchronous operations
871 struct asys_context *asys_ctx;
872 struct tevent_fd *asys_fde;
874 struct smbXsrv_client *client;
877 extern struct smbXsrv_client *global_smbXsrv_client;
879 void smbd_init_globals(void);