Add test for 'samba-tool user edit'
[Samba.git] / source3 / smbd / globals.h
blobae5ecf40138910317037aa2bfae94956d3b4b349
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);
229 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
230 struct smbXsrv_connection **_xconn);
232 void reply_smb2002(struct smb_request *req, uint16_t choice);
233 void reply_smb20ff(struct smb_request *req, uint16_t choice);
234 void smbd_smb2_process_negprot(struct smbXsrv_connection *xconn,
235 uint64_t expected_seq_low,
236 const uint8_t *inpdu, size_t size);
238 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
240 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
241 NTSTATUS status,
242 DATA_BLOB *info,
243 const char *location);
244 #define smbd_smb2_request_error(req, status) \
245 smbd_smb2_request_error_ex(req, status, NULL, __location__)
246 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
247 NTSTATUS status,
248 DATA_BLOB body, DATA_BLOB *dyn,
249 const char *location);
250 #define smbd_smb2_request_done(req, body, dyn) \
251 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
253 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_connection *xconn,
254 struct smbXsrv_session *session,
255 struct smbXsrv_tcon *tcon,
256 struct smbXsrv_open *op,
257 uint8_t oplock_level);
258 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_connection *xconn,
259 uint16_t new_epoch,
260 uint32_t lease_flags,
261 struct smb2_lease_key *lease_key,
262 uint32_t current_lease_state,
263 uint32_t new_lease_state);
265 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
266 struct tevent_req *subreq,
267 uint32_t defer_time);
269 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
270 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
271 void remove_smb2_chained_fsp(files_struct *fsp);
273 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
274 uint32_t data_length);
276 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
277 size_t expected_body_size);
279 void smb2_request_set_async_internal(struct smbd_smb2_request *req,
280 bool async_internal);
282 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
283 const int dialect_count,
284 uint16_t *dialect);
285 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
286 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
287 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
288 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
289 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
290 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
291 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
292 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
293 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
294 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
295 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
296 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
297 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
298 int err);
299 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_query_directory(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
306 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
307 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
308 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
309 struct tevent_immediate *im,
310 void *private_data);
312 struct deferred_open_record;
314 /* SMB1 -> SMB2 glue. */
315 void send_break_message_smb2(files_struct *fsp,
316 uint32_t break_from,
317 uint32_t break_to);
318 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
319 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
320 struct smb_request *req,
321 files_struct *fsp,
322 int lock_timeout,
323 int lock_num,
324 uint64_t smblctx,
325 enum brl_type lock_type,
326 enum brl_flavour lock_flav,
327 uint64_t offset,
328 uint64_t count,
329 uint64_t blocking_smblctx);
330 void process_blocking_lock_queue_smb2(
331 struct smbd_server_connection *sconn, struct timeval tv_curr);
332 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
333 struct byte_range_lock *br_lck,
334 enum file_close_type close_type);
335 /* From smbd/smb2_create.c */
336 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
337 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
338 struct timeval *p_request_time,
339 struct deferred_open_record **open_rec);
340 bool open_was_deferred_smb2(
341 struct smbXsrv_connection *xconn, uint64_t mid);
342 void remove_deferred_open_message_smb2(
343 struct smbXsrv_connection *xconn, uint64_t mid);
344 bool schedule_deferred_open_message_smb2(
345 struct smbXsrv_connection *xconn, uint64_t mid);
346 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
347 struct timeval request_time,
348 struct timeval timeout,
349 struct file_id id,
350 struct deferred_open_record *open_rec);
352 struct smbXsrv_client;
354 struct smbXsrv_preauth {
355 uint8_t sha512_value[64];
358 struct smbXsrv_connection {
359 struct smbXsrv_connection *prev, *next;
361 struct smbXsrv_client *client;
364 const struct tsocket_address *local_address;
365 const struct tsocket_address *remote_address;
366 const char *remote_hostname;
368 struct tevent_context *ev_ctx;
369 struct messaging_context *msg_ctx;
371 enum protocol_types protocol;
373 struct {
374 NTSTATUS status;
375 int sock;
376 struct tevent_fd *fde;
378 struct {
379 bool got_session;
380 } nbt;
381 } transport;
383 struct {
384 struct {
386 * fd for the fcntl lock and process shared
387 * robust mutex to coordinate access to the
388 * client socket. When the system supports
389 * process shared robust mutexes, those are
390 * used. If not, then the fcntl lock will be
391 * used.
393 int socket_lock_fd;
394 #ifdef HAVE_ROBUST_MUTEXES
395 pthread_mutex_t *socket_mutex;
396 #endif
399 * fd for the trusted pipe from
400 * echo handler child
402 int trusted_fd;
405 * fde for the trusted_fd
407 struct tevent_fd *trusted_fde;
410 * Reference count for the fcntl lock to
411 * allow recursive locks.
413 int ref_count;
414 } echo_handler;
416 struct {
417 bool encrypted_passwords;
418 bool spnego;
419 struct auth4_context *auth_context;
420 bool done;
422 * Size of the data we can receive. Set by us.
423 * Can be modified by the max xmit parameter.
425 int max_recv;
426 } negprot;
428 struct {
429 bool done_sesssetup;
431 * Size of data we can send to client. Set
432 * by the client for all protocols above CORE.
433 * Set by us for CORE protocol.
435 int max_send;
436 } sessions;
437 struct smb_signing_state *signing_state;
439 struct {
440 uint16_t client_major;
441 uint16_t client_minor;
442 uint32_t client_cap_low;
443 uint32_t client_cap_high;
444 } unix_info;
446 struct msg_state *msg_state;
447 } smb1;
448 struct {
449 struct smbd_smb2_request_read_state {
450 struct smbd_smb2_request *req;
451 struct {
452 uint8_t nbt[NBT_HDR_SIZE];
453 bool done;
454 } hdr;
455 struct iovec vector;
456 bool doing_receivefile;
457 size_t min_recv_size;
458 size_t pktfull;
459 size_t pktlen;
460 uint8_t *pktbuf;
461 } request_read_state;
462 struct smbd_smb2_send_queue *send_queue;
463 size_t send_queue_len;
465 struct {
467 * seq_low is the lowest sequence number
468 * we will accept.
470 uint64_t seq_low;
472 * seq_range is the range of credits we have
473 * granted from the sequence windows starting
474 * at seq_low.
476 * This gets incremented when new credits are
477 * granted and gets decremented when the
478 * lowest sequence number is consumed
479 * (when seq_low gets incremented).
481 uint16_t seq_range;
483 * The number of credits we have currently granted
484 * to the client.
486 * This gets incremented when new credits are
487 * granted and gets decremented when any credit
488 * is comsumed.
490 * Note: the decrementing is different compared
491 * to seq_range.
493 uint16_t granted;
495 * The maximum number of credits we will ever
496 * grant to the client.
498 * Typically we will only grant 1/16th of
499 * max_credits.
501 * This is the "server max credits" parameter.
503 uint16_t max;
505 * a bitmap of size max_credits
507 struct bitmap *bitmap;
508 bool multicredit;
509 } credits;
511 bool allow_2ff;
512 struct {
513 uint32_t capabilities;
514 struct GUID guid;
515 bool guid_verified;
516 uint16_t security_mode;
517 uint16_t num_dialects;
518 uint16_t *dialects;
519 } client;
520 struct {
521 uint32_t capabilities;
522 struct GUID guid;
523 uint16_t security_mode;
524 uint16_t dialect;
525 uint32_t max_trans;
526 uint32_t max_read;
527 uint32_t max_write;
528 uint16_t cipher;
529 } server;
531 struct smbXsrv_preauth preauth;
533 struct smbd_smb2_request *requests;
534 } smb2;
537 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
539 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
540 uint32_t smbXsrv_version_global_current(void);
542 struct smbXsrv_client_table;
543 NTSTATUS smbXsrv_client_global_init(void);
544 NTSTATUS smbXsrv_client_create(TALLOC_CTX *mem_ctx,
545 struct tevent_context *ev_ctx,
546 struct messaging_context *msg_ctx,
547 NTTIME now,
548 struct smbXsrv_client **_client);
549 NTSTATUS smbXsrv_client_update(struct smbXsrv_client *client);
550 NTSTATUS smbXsrv_client_remove(struct smbXsrv_client *client);
551 NTSTATUS smb2srv_client_lookup_global(struct smbXsrv_client *client,
552 struct GUID client_guid,
553 TALLOC_CTX *mem_ctx,
554 struct smbXsrv_client_global0 **_pass);
555 NTSTATUS smb2srv_client_connection_pass(struct smbd_smb2_request *smb2req,
556 struct smbXsrv_client_global0 *global);
558 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
559 enum protocol_types protocol);
561 NTSTATUS smbXsrv_session_global_init(struct messaging_context *msg_ctx);
562 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
563 NTTIME now,
564 struct smbXsrv_session **_session);
565 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
566 struct smbXsrv_connection *conn,
567 struct smbXsrv_channel_global0 **_c);
568 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
569 struct smbXsrv_channel_global0;
570 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
571 const struct smbXsrv_connection *conn,
572 struct smbXsrv_channel_global0 **_c);
573 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
574 const struct smbXsrv_connection *conn,
575 NTTIME now,
576 struct smbXsrv_session_auth0 **_a);
577 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
578 struct smbXsrv_connection *conn,
579 NTTIME now,
580 uint8_t in_flags,
581 uint8_t in_security_mode,
582 struct smbXsrv_session_auth0 **_a);
583 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
584 struct tevent_context *ev,
585 struct smbXsrv_session *session,
586 struct smbd_smb2_request *current_req);
587 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
588 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
589 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
590 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
591 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
592 uint16_t vuid, NTTIME now,
593 struct smbXsrv_session **session);
594 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
595 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
596 uint64_t session_id, NTTIME now,
597 struct smbXsrv_session **session);
598 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
599 uint64_t session_id, NTTIME now,
600 struct smbXsrv_session **session);
601 struct smbXsrv_session_global0;
602 NTSTATUS smbXsrv_session_global_traverse(
603 int (*fn)(struct smbXsrv_session_global0 *, void *),
604 void *private_data);
605 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
606 struct tevent_context *ev,
607 struct smbXsrv_connection *conn,
608 struct auth_session_info *session_info,
609 uint64_t previous_session_id,
610 uint64_t current_session_id);
611 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
613 NTSTATUS smbXsrv_tcon_global_init(void);
614 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
615 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
616 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
617 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
618 NTTIME now,
619 struct smbXsrv_tcon **_tcon);
620 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
621 uint16_t tree_id, NTTIME now,
622 struct smbXsrv_tcon **tcon);
623 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
624 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
625 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
626 NTTIME now,
627 struct smbXsrv_tcon **_tcon);
628 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
629 uint32_t tree_id, NTTIME now,
630 struct smbXsrv_tcon **tcon);
631 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
632 struct smbXsrv_tcon_global0;
633 NTSTATUS smbXsrv_tcon_global_traverse(
634 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
635 void *private_data);
637 NTSTATUS smbXsrv_open_global_init(void);
638 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
639 struct auth_session_info *session_info,
640 NTTIME now,
641 struct smbXsrv_open **_open);
642 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
643 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
644 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
645 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
646 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
647 uint16_t fnum, NTTIME now,
648 struct smbXsrv_open **_open);
649 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
650 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
651 uint64_t persistent_id,
652 uint64_t volatile_id,
653 NTTIME now,
654 struct smbXsrv_open **_open);
655 NTSTATUS smb2srv_open_lookup_replay_cache(struct smbXsrv_connection *conn,
656 const struct GUID *create_guid,
657 NTTIME now,
658 struct smbXsrv_open **_open);
659 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
660 struct auth_session_info *session_info,
661 uint64_t persistent_id,
662 const struct GUID *create_guid,
663 NTTIME now,
664 struct smbXsrv_open **_open);
665 struct smbXsrv_open_global0;
666 NTSTATUS smbXsrv_open_global_traverse(
667 int (*fn)(struct smbXsrv_open_global0 *, void *),
668 void *private_data);
670 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
671 bool smbXsrv_is_encrypted(uint8_t encryption_flags);
672 bool smbXsrv_is_partially_encrypted(uint8_t encryption_flags);
673 bool smbXsrv_set_crypto_flag(uint8_t *flags, uint8_t flag);
674 bool smbXsrv_is_signed(uint8_t signing_flags);
675 bool smbXsrv_is_partially_signed(uint8_t signing_flags);
677 struct smbd_smb2_send_queue {
678 struct smbd_smb2_send_queue *prev, *next;
680 DATA_BLOB *sendfile_header;
681 NTSTATUS *sendfile_status;
682 struct iovec *vector;
683 int count;
685 TALLOC_CTX *mem_ctx;
688 struct smbd_smb2_request {
689 struct smbd_smb2_request *prev, *next;
691 struct smbd_server_connection *sconn;
692 struct smbXsrv_connection *xconn;
694 struct smbd_smb2_send_queue queue_entry;
696 /* the session the request operates on, maybe NULL */
697 struct smbXsrv_session *session;
698 uint64_t last_session_id;
700 /* the tcon the request operates on, maybe NULL */
701 struct smbXsrv_tcon *tcon;
702 uint32_t last_tid;
704 int current_idx;
705 bool do_signing;
706 /* Was the request encrypted? */
707 bool was_encrypted;
708 /* Should we encrypt? */
709 bool do_encryption;
710 struct tevent_timer *async_te;
711 bool compound_related;
714 * Give the implementation of an SMB2 req a way to tell the SMB2 request
715 * processing engine that the internal request is going async, while
716 * preserving synchronous SMB2 behaviour.
718 bool async_internal;
721 * the encryption key for the whole
722 * compound chain
724 DATA_BLOB first_key;
726 * the signing key for the last
727 * request/response of a compound chain
729 DATA_BLOB last_key;
730 struct smbXsrv_preauth *preauth;
732 struct timeval request_time;
734 SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
736 /* fake smb1 request. */
737 struct smb_request *smb1req;
738 struct files_struct *compat_chain_fsp;
741 * Keep track of whether the outstanding request counters
742 * had been updated in dispatch, so that they need to be
743 * adapted again in reply.
745 bool request_counters_updated;
748 * The sub request for async backend calls.
749 * This is used for SMB2 Cancel.
751 struct tevent_req *subreq;
753 #define SMBD_SMB2_TF_IOV_OFS 0
754 #define SMBD_SMB2_HDR_IOV_OFS 1
755 #define SMBD_SMB2_BODY_IOV_OFS 2
756 #define SMBD_SMB2_DYN_IOV_OFS 3
758 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
760 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
761 (&req->dir.vector[(idx)+(ofs)])
763 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
764 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
765 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
766 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
767 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
768 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
769 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
770 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
772 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
773 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
774 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
775 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
776 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
777 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
778 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
779 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
780 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
781 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
783 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
784 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
785 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
786 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
787 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
788 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
789 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
790 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
791 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
792 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
794 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
796 struct {
798 * vector[0] TRANSPORT HEADER (empty)
800 * vector[1] SMB2_TRANSFORM (optional)
801 * vector[2] SMB2
802 * vector[3] fixed body
803 * vector[4] dynamic body
807 * vector[5] SMB2_TRANSFORM (optional)
808 * vector[6] SMB2
809 * vector[7] fixed body
810 * vector[8] dynamic body
815 struct iovec *vector;
816 int vector_count;
817 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
818 } in;
819 struct {
820 /* the NBT header is not allocated */
821 uint8_t nbt_hdr[4];
823 * vector[0] TRANSPORT HEADER
825 * vector[1] SMB2_TRANSFORM (optional)
826 * vector[2] SMB2
827 * vector[3] fixed body
828 * vector[4] dynamic body
832 * vector[5] SMB2_TRANSFORM (empty)
833 * vector[6] SMB2
834 * vector[7] fixed body
835 * vector[8] dynamic body
840 struct iovec *vector;
841 int vector_count;
842 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
843 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
844 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
845 uint8_t _body[0x58];
846 } out;
849 struct smbd_server_connection;
850 struct user_struct;
852 struct pending_message_list;
853 struct pending_auth_data;
855 struct user_struct {
856 struct user_struct *next, *prev;
857 uint64_t vuid; /* Tag for this entry. */
859 char *session_keystr; /* used by utmp and pam session code.
860 TDB key string */
861 int homes_snum;
863 struct auth_session_info *session_info;
865 struct smbXsrv_session *session;
868 struct pthreadpool_tevent;
870 struct smbd_server_connection {
871 const struct tsocket_address *local_address;
872 const struct tsocket_address *remote_address;
873 const char *remote_hostname;
874 struct tevent_context *ev_ctx;
875 struct messaging_context *msg_ctx;
876 struct notify_context *notify_ctx;
877 bool using_smb2;
878 bool aapl_zero_file_id; /* Apple-specific */
879 int trans_num;
881 size_t num_users;
882 struct user_struct *users;
884 size_t num_connections;
885 struct connection_struct *connections;
887 size_t num_files;
888 struct files_struct *files;
890 int real_max_open_files;
891 struct fsp_singleton_cache fsp_fi_cache;
893 struct pending_message_list *deferred_open_queue;
896 /* open directory handles. */
897 struct {
898 struct bitmap *dptr_bmap;
899 struct dptr_struct *dirptrs;
900 int dirhandles_open;
901 } searches;
903 uint64_t num_requests;
905 /* Current number of oplocks we have outstanding. */
906 struct {
907 int32_t exclusive_open;
908 int32_t level_II_open;
909 struct kernel_oplocks *kernel_ops;
910 } oplocks;
912 struct {
913 struct notify_mid_map *notify_mid_maps;
915 struct {
916 /* dlink list we store pending lock records on. */
917 struct blocking_lock_record *blocking_lock_queue;
918 /* dlink list we move cancelled lock records onto. */
919 struct blocking_lock_record *blocking_lock_cancelled_queue;
921 /* The event that makes us process our blocking lock queue */
922 struct tevent_timer *brl_timeout;
924 bool blocking_lock_unlock_state;
925 bool blocking_lock_cancel_state;
926 } locks;
927 } smb1;
928 struct {
929 struct {
930 /* The event that makes us process our blocking lock queue */
931 struct tevent_timer *brl_timeout;
932 bool blocking_lock_unlock_state;
933 } locks;
934 } smb2;
936 struct pthreadpool_tevent *pool;
938 struct smbXsrv_client *client;
941 extern struct smbXsrv_client *global_smbXsrv_client;
943 void smbd_init_globals(void);