ctdb-tests: Avoid segfault by initializing logging
[Samba.git] / source3 / smbd / globals.h
blob69db07a490ba48eafe91635e538d47d7179bd77e
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 #ifdef USE_DMAPI
26 struct smbd_dmapi_context;
27 extern struct smbd_dmapi_context *dmapi_ctx;
28 #endif
30 /* how many write cache buffers have been allocated */
31 extern unsigned int allocated_write_caches;
33 /* A singleton cache to speed up searching by dev/inode. */
34 struct fsp_singleton_cache {
35 files_struct *fsp;
36 struct file_id id;
39 extern const struct mangle_fns *mangle_fns;
41 extern unsigned char *chartest;
42 struct tdb_context;
43 extern struct tdb_context *tdb_mangled_cache;
46 this determines how many characters are used from the original filename
47 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
48 The largest possible value is 6.
50 extern unsigned mangle_prefix;
52 struct msg_state;
54 extern bool logged_ioctl_message;
56 extern int trans_num;
58 extern time_t last_smb_conf_reload_time;
59 extern time_t last_printer_reload_time;
60 extern pid_t background_lpq_updater_pid;
62 /****************************************************************************
63 structure to hold a linked list of queued messages.
64 for processing.
65 ****************************************************************************/
66 extern uint32_t common_flags2;
68 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
69 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
71 struct sec_ctx {
72 struct security_unix_token ut;
73 struct security_token *token;
75 /* A stack of security contexts. We include the current context as being
76 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
77 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
78 extern int sec_ctx_stack_ndx;
79 extern bool become_uid_done;
80 extern bool become_gid_done;
82 extern connection_struct *last_conn;
83 extern uint16_t last_flags;
85 extern uint32_t global_client_caps;
87 extern uint16_t fnf_handle;
89 struct conn_ctx {
90 connection_struct *conn;
91 uint64_t vuid;
93 /* A stack of current_user connection contexts. */
94 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
95 extern int conn_ctx_stack_ndx;
97 struct vfs_init_function_entry;
98 extern struct vfs_init_function_entry *backends;
99 extern char *sparse_buf;
100 extern char *LastDir;
102 struct smbd_parent_context;
103 extern struct smbd_parent_context *am_parent;
104 extern struct memcache *smbd_memcache_ctx;
105 extern bool exit_firsttime;
107 struct tstream_context;
108 struct smbd_smb2_request;
110 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbXsrv_connection *xconn);
112 void smbd_lock_socket(struct smbXsrv_connection *xconn);
113 void smbd_unlock_socket(struct smbXsrv_connection *xconn);
115 NTSTATUS smbd_do_locking(struct smb_request *req,
116 files_struct *fsp,
117 uint8_t type,
118 int32_t timeout,
119 uint16_t num_locks,
120 struct smbd_lock_element *locks,
121 bool *async);
122 NTSTATUS smbd_do_unlocking(struct smb_request *req,
123 files_struct *fsp,
124 uint16_t num_ulocks,
125 struct smbd_lock_element *ulocks);
127 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
128 TALLOC_CTX *mem_ctx,
129 uint16_t info_level,
130 files_struct *fsp,
131 struct smb_filename *smb_fname,
132 bool delete_pending,
133 struct timespec write_time_ts,
134 struct ea_list *ea_list,
135 int lock_data_count,
136 char *lock_data,
137 uint16_t flags2,
138 unsigned int max_data_bytes,
139 size_t *fixed_portion,
140 char **ppdata,
141 unsigned int *pdata_size);
143 NTSTATUS smbd_do_setfsinfo(connection_struct *conn,
144 struct smb_request *req,
145 TALLOC_CTX *mem_ctx,
146 uint16_t info_level,
147 files_struct *fsp,
148 const DATA_BLOB *pdata);
150 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
151 struct smb_request *req,
152 TALLOC_CTX *mem_ctx,
153 uint16_t info_level,
154 files_struct *fsp,
155 struct smb_filename *smb_fname,
156 char **ppdata, int total_data,
157 int *ret_data_size);
159 NTSTATUS smbd_do_qfsinfo(struct smbXsrv_connection *xconn,
160 connection_struct *conn,
161 TALLOC_CTX *mem_ctx,
162 uint16_t info_level,
163 uint16_t flags2,
164 unsigned int max_data_bytes,
165 size_t *fixed_portion,
166 struct smb_filename *smb_fname,
167 char **ppdata,
168 int *ret_data_len);
170 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
171 struct dptr_struct *dirptr,
172 const char *mask,
173 uint32_t dirtype,
174 bool dont_descend,
175 bool ask_sharemode,
176 bool (*match_fn)(TALLOC_CTX *ctx,
177 void *private_data,
178 const char *dname,
179 const char *mask,
180 char **_fname),
181 bool (*mode_fn)(TALLOC_CTX *ctx,
182 void *private_data,
183 struct smb_filename *smb_fname,
184 uint32_t *_mode),
185 void *private_data,
186 char **_fname,
187 struct smb_filename **_smb_fname,
188 uint32_t *_mode,
189 long *_prev_offset);
191 NTSTATUS smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
192 connection_struct *conn,
193 struct dptr_struct *dirptr,
194 uint16_t flags2,
195 const char *path_mask,
196 uint32_t dirtype,
197 int info_level,
198 int requires_resume_key,
199 bool dont_descend,
200 bool ask_sharemode,
201 uint8_t align,
202 bool do_pad,
203 char **ppdata,
204 char *base_data,
205 char *end_data,
206 int space_remaining,
207 bool *got_exact_match,
208 int *_last_entry_off,
209 struct ea_list *name_list,
210 struct file_id *file_id);
212 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
213 const struct smb_filename *smb_fname,
214 bool use_privs,
215 uint32_t access_mask,
216 uint32_t *access_mask_out);
218 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
220 void smbd_server_connection_terminate_ex(struct smbXsrv_connection *xconn,
221 const char *reason,
222 const char *location);
223 #define smbd_server_connection_terminate(xconn, reason) \
224 smbd_server_connection_terminate_ex(xconn, reason, __location__)
226 const char *smb2_opcode_name(uint16_t opcode);
227 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
228 bool smbd_smb2_is_compound(const struct smbd_smb2_request *req);
230 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
231 struct smbXsrv_connection **_xconn);
233 void reply_smb2002(struct smb_request *req, uint16_t choice);
234 void reply_smb20ff(struct smb_request *req, uint16_t choice);
235 void smbd_smb2_process_negprot(struct smbXsrv_connection *xconn,
236 uint64_t expected_seq_low,
237 const uint8_t *inpdu, size_t size);
239 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
241 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
242 NTSTATUS status,
243 DATA_BLOB *info,
244 const char *location);
245 #define smbd_smb2_request_error(req, status) \
246 smbd_smb2_request_error_ex(req, status, NULL, __location__)
247 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
248 NTSTATUS status,
249 DATA_BLOB body, DATA_BLOB *dyn,
250 const char *location);
251 #define smbd_smb2_request_done(req, body, dyn) \
252 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
254 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_connection *xconn,
255 struct smbXsrv_session *session,
256 struct smbXsrv_tcon *tcon,
257 struct smbXsrv_open *op,
258 uint8_t oplock_level);
259 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_connection *xconn,
260 uint16_t new_epoch,
261 uint32_t lease_flags,
262 struct smb2_lease_key *lease_key,
263 uint32_t current_lease_state,
264 uint32_t new_lease_state);
266 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
267 struct tevent_req *subreq,
268 uint32_t defer_time);
270 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
271 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
272 void remove_smb2_chained_fsp(files_struct *fsp);
274 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
275 uint32_t data_length);
277 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
278 size_t expected_body_size);
280 void smb2_request_set_async_internal(struct smbd_smb2_request *req,
281 bool async_internal);
283 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
284 const int dialect_count,
285 uint16_t *dialect);
286 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
287 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
288 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
289 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
290 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
291 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
292 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
293 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
294 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
295 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
296 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
297 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
298 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
299 int err);
300 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_query_directory(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
306 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
307 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
308 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
309 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
310 struct tevent_immediate *im,
311 void *private_data);
313 struct deferred_open_record;
315 /* SMB1 -> SMB2 glue. */
316 void send_break_message_smb2(files_struct *fsp,
317 uint32_t break_from,
318 uint32_t break_to);
319 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
320 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
321 struct smb_request *req,
322 files_struct *fsp,
323 int lock_timeout,
324 int lock_num,
325 uint64_t smblctx,
326 enum brl_type lock_type,
327 enum brl_flavour lock_flav,
328 uint64_t offset,
329 uint64_t count,
330 uint64_t blocking_smblctx);
331 void process_blocking_lock_queue_smb2(
332 struct smbd_server_connection *sconn, struct timeval tv_curr);
333 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
334 struct byte_range_lock *br_lck,
335 enum file_close_type close_type);
336 /* From smbd/smb2_create.c */
337 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
338 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
339 struct timeval *p_request_time,
340 struct deferred_open_record **open_rec);
341 bool open_was_deferred_smb2(
342 struct smbXsrv_connection *xconn, uint64_t mid);
343 void remove_deferred_open_message_smb2(
344 struct smbXsrv_connection *xconn, uint64_t mid);
345 bool schedule_deferred_open_message_smb2(
346 struct smbXsrv_connection *xconn, uint64_t mid);
347 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
348 struct timeval request_time,
349 struct timeval timeout,
350 struct file_id id,
351 struct deferred_open_record *open_rec);
353 struct smbXsrv_client;
355 struct smbXsrv_preauth {
356 uint8_t sha512_value[64];
359 struct smbXsrv_connection {
360 struct smbXsrv_connection *prev, *next;
362 struct smbXsrv_client *client;
365 const struct tsocket_address *local_address;
366 const struct tsocket_address *remote_address;
367 const char *remote_hostname;
369 struct tevent_context *ev_ctx;
370 struct messaging_context *msg_ctx;
372 enum protocol_types protocol;
374 struct {
375 NTSTATUS status;
376 int sock;
377 struct tevent_fd *fde;
379 struct {
380 bool got_session;
381 } nbt;
382 } transport;
384 struct {
385 struct {
387 * fd for the fcntl lock and process shared
388 * robust mutex to coordinate access to the
389 * client socket. When the system supports
390 * process shared robust mutexes, those are
391 * used. If not, then the fcntl lock will be
392 * used.
394 int socket_lock_fd;
395 #ifdef HAVE_ROBUST_MUTEXES
396 pthread_mutex_t *socket_mutex;
397 #endif
400 * fd for the trusted pipe from
401 * echo handler child
403 int trusted_fd;
406 * fde for the trusted_fd
408 struct tevent_fd *trusted_fde;
411 * Reference count for the fcntl lock to
412 * allow recursive locks.
414 int ref_count;
415 } echo_handler;
417 struct {
418 bool encrypted_passwords;
419 bool spnego;
420 struct auth4_context *auth_context;
421 bool done;
423 * Size of the data we can receive. Set by us.
424 * Can be modified by the max xmit parameter.
426 int max_recv;
427 } negprot;
429 struct {
430 bool done_sesssetup;
432 * Size of data we can send to client. Set
433 * by the client for all protocols above CORE.
434 * Set by us for CORE protocol.
436 int max_send;
437 } sessions;
438 struct smb_signing_state *signing_state;
440 struct {
441 uint16_t client_major;
442 uint16_t client_minor;
443 uint32_t client_cap_low;
444 uint32_t client_cap_high;
445 } unix_info;
447 struct msg_state *msg_state;
448 } smb1;
449 struct {
450 struct smbd_smb2_request_read_state {
451 struct smbd_smb2_request *req;
452 struct {
453 uint8_t nbt[NBT_HDR_SIZE];
454 bool done;
455 } hdr;
456 struct iovec vector;
457 bool doing_receivefile;
458 size_t min_recv_size;
459 size_t pktfull;
460 size_t pktlen;
461 uint8_t *pktbuf;
462 } request_read_state;
463 struct smbd_smb2_send_queue *send_queue;
464 size_t send_queue_len;
466 struct {
468 * seq_low is the lowest sequence number
469 * we will accept.
471 uint64_t seq_low;
473 * seq_range is the range of credits we have
474 * granted from the sequence windows starting
475 * at seq_low.
477 * This gets incremented when new credits are
478 * granted and gets decremented when the
479 * lowest sequence number is consumed
480 * (when seq_low gets incremented).
482 uint16_t seq_range;
484 * The number of credits we have currently granted
485 * to the client.
487 * This gets incremented when new credits are
488 * granted and gets decremented when any credit
489 * is comsumed.
491 * Note: the decrementing is different compared
492 * to seq_range.
494 uint16_t granted;
496 * The maximum number of credits we will ever
497 * grant to the client.
499 * Typically we will only grant 1/16th of
500 * max_credits.
502 * This is the "server max credits" parameter.
504 uint16_t max;
506 * a bitmap of size max_credits
508 struct bitmap *bitmap;
509 bool multicredit;
510 } credits;
512 bool allow_2ff;
513 struct {
514 uint32_t capabilities;
515 struct GUID guid;
516 bool guid_verified;
517 uint16_t security_mode;
518 uint16_t num_dialects;
519 uint16_t *dialects;
520 } client;
521 struct {
522 uint32_t capabilities;
523 struct GUID guid;
524 uint16_t security_mode;
525 uint16_t dialect;
526 uint32_t max_trans;
527 uint32_t max_read;
528 uint32_t max_write;
529 uint16_t cipher;
530 } server;
532 struct smbXsrv_preauth preauth;
534 struct smbd_smb2_request *requests;
535 } smb2;
538 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
540 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
541 uint32_t smbXsrv_version_global_current(void);
543 struct smbXsrv_client_table;
544 NTSTATUS smbXsrv_client_global_init(void);
545 NTSTATUS smbXsrv_client_create(TALLOC_CTX *mem_ctx,
546 struct tevent_context *ev_ctx,
547 struct messaging_context *msg_ctx,
548 NTTIME now,
549 struct smbXsrv_client **_client);
550 NTSTATUS smbXsrv_client_update(struct smbXsrv_client *client);
551 NTSTATUS smbXsrv_client_remove(struct smbXsrv_client *client);
552 NTSTATUS smb2srv_client_lookup_global(struct smbXsrv_client *client,
553 struct GUID client_guid,
554 TALLOC_CTX *mem_ctx,
555 struct smbXsrv_client_global0 **_pass);
556 NTSTATUS smb2srv_client_connection_pass(struct smbd_smb2_request *smb2req,
557 struct smbXsrv_client_global0 *global);
559 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
560 enum protocol_types protocol);
562 NTSTATUS smbXsrv_session_global_init(struct messaging_context *msg_ctx);
563 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
564 NTTIME now,
565 struct smbXsrv_session **_session);
566 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
567 struct smbXsrv_connection *conn,
568 struct smbXsrv_channel_global0 **_c);
569 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
570 struct smbXsrv_channel_global0;
571 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
572 const struct smbXsrv_connection *conn,
573 struct smbXsrv_channel_global0 **_c);
574 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
575 const struct smbXsrv_connection *conn,
576 NTTIME now,
577 struct smbXsrv_session_auth0 **_a);
578 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
579 struct smbXsrv_connection *conn,
580 NTTIME now,
581 uint8_t in_flags,
582 uint8_t in_security_mode,
583 struct smbXsrv_session_auth0 **_a);
584 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
585 struct tevent_context *ev,
586 struct smbXsrv_session *session,
587 struct smbd_smb2_request *current_req);
588 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
589 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
590 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
591 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
592 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
593 uint16_t vuid, NTTIME now,
594 struct smbXsrv_session **session);
595 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
596 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
597 uint64_t session_id, NTTIME now,
598 struct smbXsrv_session **session);
599 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
600 uint64_t session_id, NTTIME now,
601 struct smbXsrv_session **session);
602 struct smbXsrv_session_global0;
603 NTSTATUS smbXsrv_session_global_traverse(
604 int (*fn)(struct smbXsrv_session_global0 *, void *),
605 void *private_data);
606 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
607 struct tevent_context *ev,
608 struct smbXsrv_connection *conn,
609 struct auth_session_info *session_info,
610 uint64_t previous_session_id,
611 uint64_t current_session_id);
612 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
614 NTSTATUS smbXsrv_tcon_global_init(void);
615 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
616 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
617 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
618 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
619 NTTIME now,
620 struct smbXsrv_tcon **_tcon);
621 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
622 uint16_t tree_id, NTTIME now,
623 struct smbXsrv_tcon **tcon);
624 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
625 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
626 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
627 NTTIME now,
628 struct smbXsrv_tcon **_tcon);
629 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
630 uint32_t tree_id, NTTIME now,
631 struct smbXsrv_tcon **tcon);
632 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
633 struct smbXsrv_tcon_global0;
634 NTSTATUS smbXsrv_tcon_global_traverse(
635 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
636 void *private_data);
638 NTSTATUS smbXsrv_open_global_init(void);
639 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
640 struct auth_session_info *session_info,
641 NTTIME now,
642 struct smbXsrv_open **_open);
643 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
644 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
645 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
646 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
647 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
648 uint16_t fnum, NTTIME now,
649 struct smbXsrv_open **_open);
650 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
651 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
652 uint64_t persistent_id,
653 uint64_t volatile_id,
654 NTTIME now,
655 struct smbXsrv_open **_open);
656 NTSTATUS smb2srv_open_lookup_replay_cache(struct smbXsrv_connection *conn,
657 const struct GUID *create_guid,
658 NTTIME now,
659 struct smbXsrv_open **_open);
660 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
661 struct auth_session_info *session_info,
662 uint64_t persistent_id,
663 const struct GUID *create_guid,
664 NTTIME now,
665 struct smbXsrv_open **_open);
666 struct smbXsrv_open_global0;
667 NTSTATUS smbXsrv_open_global_traverse(
668 int (*fn)(struct smbXsrv_open_global0 *, void *),
669 void *private_data);
671 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
672 bool smbXsrv_is_encrypted(uint8_t encryption_flags);
673 bool smbXsrv_is_partially_encrypted(uint8_t encryption_flags);
674 bool smbXsrv_set_crypto_flag(uint8_t *flags, uint8_t flag);
675 bool smbXsrv_is_signed(uint8_t signing_flags);
676 bool smbXsrv_is_partially_signed(uint8_t signing_flags);
678 struct smbd_smb2_send_queue {
679 struct smbd_smb2_send_queue *prev, *next;
681 DATA_BLOB *sendfile_header;
682 NTSTATUS *sendfile_status;
683 struct iovec *vector;
684 int count;
686 TALLOC_CTX *mem_ctx;
689 struct smbd_smb2_request {
690 struct smbd_smb2_request *prev, *next;
692 struct smbd_server_connection *sconn;
693 struct smbXsrv_connection *xconn;
695 struct smbd_smb2_send_queue queue_entry;
697 /* the session the request operates on, maybe NULL */
698 struct smbXsrv_session *session;
699 uint64_t last_session_id;
701 /* the tcon the request operates on, maybe NULL */
702 struct smbXsrv_tcon *tcon;
703 uint32_t last_tid;
705 int current_idx;
706 bool do_signing;
707 /* Was the request encrypted? */
708 bool was_encrypted;
709 /* Should we encrypt? */
710 bool do_encryption;
711 struct tevent_timer *async_te;
712 bool compound_related;
715 * Give the implementation of an SMB2 req a way to tell the SMB2 request
716 * processing engine that the internal request is going async, while
717 * preserving synchronous SMB2 behaviour.
719 bool async_internal;
722 * the encryption key for the whole
723 * compound chain
725 DATA_BLOB first_key;
727 * the signing key for the last
728 * request/response of a compound chain
730 DATA_BLOB last_key;
731 struct smbXsrv_preauth *preauth;
733 struct timeval request_time;
735 SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
737 /* fake smb1 request. */
738 struct smb_request *smb1req;
739 struct files_struct *compat_chain_fsp;
742 * Keep track of whether the outstanding request counters
743 * had been updated in dispatch, so that they need to be
744 * adapted again in reply.
746 bool request_counters_updated;
747 uint64_t channel_generation;
750 * The sub request for async backend calls.
751 * This is used for SMB2 Cancel.
753 struct tevent_req *subreq;
755 #define SMBD_SMB2_TF_IOV_OFS 0
756 #define SMBD_SMB2_HDR_IOV_OFS 1
757 #define SMBD_SMB2_BODY_IOV_OFS 2
758 #define SMBD_SMB2_DYN_IOV_OFS 3
760 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
762 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
763 (&req->dir.vector[(idx)+(ofs)])
765 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
766 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
767 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
768 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
769 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
770 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
771 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
772 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
774 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
775 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
776 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
777 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
778 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
779 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
780 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
781 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
782 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
783 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
785 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
786 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
787 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
788 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
789 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
790 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
791 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
792 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
793 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
794 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
796 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
798 struct {
800 * vector[0] TRANSPORT HEADER (empty)
802 * vector[1] SMB2_TRANSFORM (optional)
803 * vector[2] SMB2
804 * vector[3] fixed body
805 * vector[4] dynamic body
809 * vector[5] SMB2_TRANSFORM (optional)
810 * vector[6] SMB2
811 * vector[7] fixed body
812 * vector[8] dynamic body
817 struct iovec *vector;
818 int vector_count;
819 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
820 } in;
821 struct {
822 /* the NBT header is not allocated */
823 uint8_t nbt_hdr[4];
825 * vector[0] TRANSPORT HEADER
827 * vector[1] SMB2_TRANSFORM (optional)
828 * vector[2] SMB2
829 * vector[3] fixed body
830 * vector[4] dynamic body
834 * vector[5] SMB2_TRANSFORM (empty)
835 * vector[6] SMB2
836 * vector[7] fixed body
837 * vector[8] dynamic body
842 struct iovec *vector;
843 int vector_count;
844 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
845 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
846 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
847 uint8_t _body[0x58];
848 } out;
851 struct smbd_server_connection;
852 struct user_struct;
854 struct pending_message_list;
855 struct pending_auth_data;
857 struct user_struct {
858 struct user_struct *next, *prev;
859 uint64_t vuid; /* Tag for this entry. */
861 char *session_keystr; /* used by utmp and pam session code.
862 TDB key string */
863 int homes_snum;
865 struct auth_session_info *session_info;
867 struct smbXsrv_session *session;
870 struct pthreadpool_tevent;
872 struct smbd_server_connection {
873 const struct tsocket_address *local_address;
874 const struct tsocket_address *remote_address;
875 const char *remote_hostname;
876 struct tevent_context *ev_ctx;
877 struct messaging_context *msg_ctx;
878 struct notify_context *notify_ctx;
879 bool using_smb2;
880 bool aapl_zero_file_id; /* Apple-specific */
881 int trans_num;
883 size_t num_users;
884 struct user_struct *users;
886 size_t num_connections;
887 struct connection_struct *connections;
889 size_t num_files;
890 struct files_struct *files;
892 int real_max_open_files;
893 struct fsp_singleton_cache fsp_fi_cache;
895 struct pending_message_list *deferred_open_queue;
898 /* open directory handles. */
899 struct {
900 struct bitmap *dptr_bmap;
901 struct dptr_struct *dirptrs;
902 int dirhandles_open;
903 } searches;
905 uint64_t num_requests;
907 /* Current number of oplocks we have outstanding. */
908 struct {
909 int32_t exclusive_open;
910 int32_t level_II_open;
911 struct kernel_oplocks *kernel_ops;
912 } oplocks;
914 struct {
915 struct notify_mid_map *notify_mid_maps;
917 struct {
918 /* dlink list we store pending lock records on. */
919 struct blocking_lock_record *blocking_lock_queue;
920 /* dlink list we move cancelled lock records onto. */
921 struct blocking_lock_record *blocking_lock_cancelled_queue;
923 /* The event that makes us process our blocking lock queue */
924 struct tevent_timer *brl_timeout;
926 bool blocking_lock_unlock_state;
927 bool blocking_lock_cancel_state;
928 } locks;
929 } smb1;
930 struct {
931 struct {
932 /* The event that makes us process our blocking lock queue */
933 struct tevent_timer *brl_timeout;
934 bool blocking_lock_unlock_state;
935 } locks;
936 } smb2;
938 struct pthreadpool_tevent *pool;
940 struct smbXsrv_client *client;
943 extern struct smbXsrv_client *global_smbXsrv_client;
945 void smbd_init_globals(void);