smbd: qfilepathinfo has fixed/variable buffers
[Samba.git] / source3 / smbd / globals.h
blob7fbe608744076e6f87aed6e9eed59baa3935117d
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"
23 #if defined(WITH_AIO)
24 struct aio_extra;
25 extern struct aio_extra *aio_list_head;
26 extern struct tevent_signal *aio_signal_event;
27 extern int aio_pending_size;
28 extern int outstanding_aio_calls;
29 #endif
31 #ifdef USE_DMAPI
32 struct smbd_dmapi_context;
33 extern struct smbd_dmapi_context *dmapi_ctx;
34 #endif
36 extern bool dfree_broken;
38 /* how many write cache buffers have been allocated */
39 extern unsigned int allocated_write_caches;
41 /* A singleton cache to speed up searching by dev/inode. */
42 struct fsp_singleton_cache {
43 files_struct *fsp;
44 struct file_id id;
47 extern const struct mangle_fns *mangle_fns;
49 extern unsigned char *chartest;
50 struct tdb_context;
51 extern struct tdb_context *tdb_mangled_cache;
54 this determines how many characters are used from the original filename
55 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
56 The largest possible value is 6.
58 extern unsigned mangle_prefix;
60 struct msg_state;
61 extern struct msg_state *smbd_msg_state;
63 extern bool logged_ioctl_message;
65 extern int trans_num;
67 extern time_t last_smb_conf_reload_time;
68 extern time_t last_printer_reload_time;
69 /****************************************************************************
70 structure to hold a linked list of queued messages.
71 for processing.
72 ****************************************************************************/
73 struct pending_message_list;
74 extern struct pending_message_list *deferred_open_queue;
75 extern uint32_t common_flags2;
77 struct smb_srv_trans_enc_ctx;
78 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
79 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
81 struct sec_ctx {
82 struct security_unix_token ut;
83 struct security_token *token;
85 /* A stack of security contexts. We include the current context as being
86 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
87 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
88 extern int sec_ctx_stack_ndx;
89 extern bool become_uid_done;
90 extern bool become_gid_done;
92 extern connection_struct *last_conn;
93 extern uint16_t last_flags;
95 extern uint32_t global_client_caps;
97 extern uint16_t fnf_handle;
99 struct conn_ctx {
100 connection_struct *conn;
101 uint16 vuid;
103 /* A stack of current_user connection contexts. */
104 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
105 extern int conn_ctx_stack_ndx;
107 struct vfs_init_function_entry;
108 extern struct vfs_init_function_entry *backends;
109 extern char *sparse_buf;
110 extern char *LastDir;
112 /* Current number of oplocks we have outstanding. */
113 extern int32_t exclusive_oplocks_open;
114 extern int32_t level_II_oplocks_open;
115 extern struct kernel_oplocks *koplocks;
117 extern int am_parent;
118 extern struct event_context *smbd_event_ctx;
119 extern struct messaging_context *smbd_msg_ctx;
120 extern struct memcache *smbd_memcache_ctx;
121 extern bool exit_firsttime;
122 struct child_pid;
123 extern struct child_pid *children;
124 extern int num_children;
126 struct tstream_context;
127 struct smbd_smb2_request;
128 struct smbd_smb2_session;
129 struct smbd_smb2_tcon;
131 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
133 void smbd_lock_socket(struct smbd_server_connection *sconn);
134 void smbd_unlock_socket(struct smbd_server_connection *sconn);
136 NTSTATUS smb2_signing_sign_pdu(DATA_BLOB session_key,
137 struct iovec *vector,
138 int count);
139 NTSTATUS smb2_signing_check_pdu(DATA_BLOB session_key,
140 const struct iovec *vector,
141 int count);
143 NTSTATUS smbd_do_locking(struct smb_request *req,
144 files_struct *fsp,
145 uint8_t type,
146 int32_t timeout,
147 uint16_t num_ulocks,
148 struct smbd_lock_element *ulocks,
149 uint16_t num_locks,
150 struct smbd_lock_element *locks,
151 bool *async);
153 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
154 TALLOC_CTX *mem_ctx,
155 uint16_t info_level,
156 files_struct *fsp,
157 struct smb_filename *smb_fname,
158 bool delete_pending,
159 struct timespec write_time_ts,
160 struct ea_list *ea_list,
161 int lock_data_count,
162 char *lock_data,
163 uint16_t flags2,
164 unsigned int max_data_bytes,
165 size_t *fixed_portion,
166 char **ppdata,
167 unsigned int *pdata_size);
169 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
170 struct smb_request *req,
171 TALLOC_CTX *mem_ctx,
172 uint16_t info_level,
173 files_struct *fsp,
174 struct smb_filename *smb_fname,
175 char **ppdata, int total_data,
176 int *ret_data_size);
178 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
179 TALLOC_CTX *mem_ctx,
180 uint16_t info_level,
181 uint16_t flags2,
182 unsigned int max_data_bytes,
183 struct smb_filename *smb_fname,
184 char **ppdata,
185 int *ret_data_len);
187 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
188 struct dptr_struct *dirptr,
189 const char *mask,
190 uint32_t dirtype,
191 bool dont_descend,
192 bool ask_sharemode,
193 bool (*match_fn)(TALLOC_CTX *ctx,
194 void *private_data,
195 const char *dname,
196 const char *mask,
197 char **_fname),
198 bool (*mode_fn)(TALLOC_CTX *ctx,
199 void *private_data,
200 struct smb_filename *smb_fname,
201 uint32_t *_mode),
202 void *private_data,
203 char **_fname,
204 struct smb_filename **_smb_fname,
205 uint32_t *_mode,
206 long *_prev_offset);
208 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
209 connection_struct *conn,
210 struct dptr_struct *dirptr,
211 uint16 flags2,
212 const char *path_mask,
213 uint32 dirtype,
214 int info_level,
215 int requires_resume_key,
216 bool dont_descend,
217 bool ask_sharemode,
218 uint8_t align,
219 bool do_pad,
220 char **ppdata,
221 char *base_data,
222 char *end_data,
223 int space_remaining,
224 bool *out_of_space,
225 bool *got_exact_match,
226 int *_last_entry_off,
227 struct ea_list *name_list);
229 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
230 const struct smb_filename *smb_fname,
231 bool file_existed,
232 uint32_t access_mask,
233 uint32_t *access_mask_out);
234 NTSTATUS smbd_check_open_rights(struct connection_struct *conn,
235 const struct smb_filename *smb_fname,
236 uint32_t access_mask,
237 uint32_t *access_granted);
239 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
241 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
242 const char *reason,
243 const char *location);
244 #define smbd_server_connection_terminate(sconn, reason) \
245 smbd_server_connection_terminate_ex(sconn, reason, __location__)
247 struct server_id sconn_server_id(const struct smbd_server_connection *sconn);
249 const char *smb2_opcode_name(uint16_t opcode);
250 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
252 void reply_smb2002(struct smb_request *req, uint16_t choice);
253 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
254 const uint8_t *inbuf, size_t size);
256 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
257 NTSTATUS status,
258 DATA_BLOB *info,
259 const char *location);
260 #define smbd_smb2_request_error(req, status) \
261 smbd_smb2_request_error_ex(req, status, NULL, __location__)
262 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
263 NTSTATUS status,
264 DATA_BLOB body, DATA_BLOB *dyn,
265 const char *location);
266 #define smbd_smb2_request_done(req, body, dyn) \
267 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
269 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
270 uint64_t file_id_persistent,
271 uint64_t file_id_volatile,
272 uint8_t oplock_level);
274 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
275 struct tevent_req *subreq);
277 NTSTATUS smbd_smb2_request_check_session(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_check_tcon(struct smbd_smb2_request *req);
280 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
281 void remove_smb2_chained_fsp(files_struct *fsp);
283 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
284 size_t expected_body_size);
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 smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
306 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
307 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
308 struct tevent_immediate *im,
309 void *private_data);
311 /* SMB1 -> SMB2 glue. */
312 void send_break_message_smb2(files_struct *fsp, int level);
313 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
314 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
315 struct smb_request *req,
316 files_struct *fsp,
317 int lock_timeout,
318 int lock_num,
319 uint64_t smblctx,
320 enum brl_type lock_type,
321 enum brl_flavour lock_flav,
322 uint64_t offset,
323 uint64_t count,
324 uint64_t blocking_smblctx);
325 void process_blocking_lock_queue_smb2(
326 struct smbd_server_connection *sconn, struct timeval tv_curr);
327 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
328 struct byte_range_lock *br_lck,
329 enum file_close_type close_type);
330 /* From smbd/smb2_create.c */
331 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
332 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
333 struct timeval *p_request_time,
334 void **pp_state);
335 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
336 uint64_t mid);
337 void remove_deferred_open_message_smb2(
338 struct smbd_server_connection *sconn, uint64_t mid);
339 void schedule_deferred_open_message_smb2(
340 struct smbd_server_connection *sconn, uint64_t mid);
341 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
342 struct timeval request_time,
343 struct timeval timeout,
344 struct file_id id,
345 char *private_data,
346 size_t priv_len);
348 struct smbd_smb2_request {
349 struct smbd_smb2_request *prev, *next;
351 TALLOC_CTX *mem_pool;
352 struct smbd_smb2_request **parent;
354 struct smbd_server_connection *sconn;
356 /* the session the request operates on, maybe NULL */
357 struct smbd_smb2_session *session;
358 uint64_t last_session_id;
360 /* the tcon the request operates on, maybe NULL */
361 struct smbd_smb2_tcon *tcon;
362 uint32_t last_tid;
364 int current_idx;
365 bool do_signing;
366 bool async;
367 bool cancelled;
368 bool compound_related;
370 /* fake smb1 request. */
371 struct smb_request *smb1req;
372 struct files_struct *compat_chain_fsp;
375 * The sub request for async backend calls.
376 * This is used for SMB2 Cancel.
378 struct tevent_req *subreq;
380 struct {
381 /* the NBT header is not allocated */
382 uint8_t nbt_hdr[4];
384 * vector[0] NBT
386 * vector[1] SMB2
387 * vector[2] fixed body
388 * vector[3] dynamic body
392 * vector[4] SMB2
393 * vector[5] fixed body
394 * vector[6] dynamic body
399 struct iovec *vector;
400 int vector_count;
401 } in;
402 struct {
403 /* the NBT header is not allocated */
404 uint8_t nbt_hdr[4];
406 * vector[0] NBT
408 * vector[1] SMB2
409 * vector[2] fixed body
410 * vector[3] dynamic body
414 * vector[4] SMB2
415 * vector[5] fixed body
416 * vector[6] dynamic body
421 struct iovec *vector;
422 int vector_count;
423 } out;
426 struct smbd_server_connection;
428 struct smbd_smb2_session {
429 struct smbd_smb2_session *prev, *next;
430 struct smbd_server_connection *sconn;
431 NTSTATUS status;
432 uint64_t vuid;
433 struct auth_ntlmssp_state *auth_ntlmssp_state;
434 struct auth_serversupplied_info *session_info;
435 DATA_BLOB session_key;
436 bool do_signing;
438 user_struct *compat_vuser;
440 struct {
441 /* an id tree used to allocate tids */
442 struct idr_context *idtree;
444 /* this is the limit of tid values for this connection */
445 uint32_t limit;
447 struct smbd_smb2_tcon *list;
448 } tcons;
451 struct smbd_smb2_tcon {
452 struct smbd_smb2_tcon *prev, *next;
453 struct smbd_smb2_session *session;
454 uint32_t tid;
455 int snum;
456 connection_struct *compat_conn;
459 struct pending_auth_data;
461 struct smbd_server_connection {
462 int sock;
463 struct client_address client_id;
464 const struct tsocket_address *local_address;
465 const struct tsocket_address *remote_address;
466 struct messaging_context *msg_ctx;
467 struct {
468 bool got_session;
469 } nbt;
470 bool using_smb2;
471 int trans_num;
474 * Cache for calling poll(2) to avoid allocations in our
475 * central event loop
477 struct pollfd *pfds;
479 struct files_struct *files;
480 struct bitmap *file_bmap;
481 int real_max_open_files;
482 int files_used;
483 struct fsp_singleton_cache fsp_fi_cache;
484 unsigned long file_gen_counter;
485 int first_file;
487 /* number of open connections (tcons) */
488 int num_tcons_open;
490 /* open directory handles. */
491 struct {
492 struct bitmap *dptr_bmap;
493 struct dptr_struct *dirptrs;
494 int dirhandles_open;
495 } searches;
497 uint64_t num_requests;
499 struct {
500 struct fd_event *fde;
502 struct {
504 * fd for the fcntl lock mutexing access to our sock
506 int socket_lock_fd;
509 * fd for the trusted pipe from
510 * echo handler child
512 int trusted_fd;
515 * fde for the trusted_fd
517 struct fd_event *trusted_fde;
520 * Reference count for the fcntl lock to
521 * allow recursive locks.
523 int ref_count;
524 } echo_handler;
526 struct {
527 bool encrypted_passwords;
528 bool spnego;
529 struct auth_context *auth_context;
530 bool done;
532 * Size of the data we can receive. Set by us.
533 * Can be modified by the max xmit parameter.
535 int max_recv;
536 } negprot;
538 struct {
539 bool done_sesssetup;
541 * Size of data we can send to client. Set
542 * by the client for all protocols above CORE.
543 * Set by us for CORE protocol.
545 int max_send;
546 uint16_t last_session_tag;
548 /* users from session setup */
549 char *session_userlist;
550 /* workgroup from session setup. */
551 char *session_workgroup;
553 * this holds info on user ids that are already
554 * validated for this VC
556 user_struct *validated_users;
557 uint16_t next_vuid;
558 int num_validated_vuids;
559 } sessions;
560 struct {
561 connection_struct *Connections;
562 /* number of open connections */
563 struct bitmap *bmap;
564 } tcons;
565 struct smb_signing_state *signing_state;
566 /* List to store partial SPNEGO auth fragments. */
567 struct pending_auth_data *pd_list;
569 struct notify_mid_map *notify_mid_maps;
571 struct {
572 /* dlink list we store pending lock records on. */
573 struct blocking_lock_record *blocking_lock_queue;
574 /* dlink list we move cancelled lock records onto. */
575 struct blocking_lock_record *blocking_lock_cancelled_queue;
577 /* The event that makes us process our blocking lock queue */
578 struct timed_event *brl_timeout;
580 bool blocking_lock_unlock_state;
581 bool blocking_lock_cancel_state;
582 } locks;
583 } smb1;
584 struct {
585 struct tevent_context *event_ctx;
586 struct tevent_queue *recv_queue;
587 struct tevent_queue *send_queue;
588 struct tstream_context *stream;
589 struct {
590 /* an id tree used to allocate vuids */
591 /* this holds info on session vuids that are already
592 * validated for this VC */
593 struct idr_context *idtree;
595 /* this is the limit of vuid values for this connection */
596 uint64_t limit;
598 struct smbd_smb2_session *list;
599 } sessions;
600 struct {
601 /* The event that makes us process our blocking lock queue */
602 struct timed_event *brl_timeout;
603 bool blocking_lock_unlock_state;
604 } locks;
605 struct smbd_smb2_request *requests;
607 * seqnum_low is the lowest sequence number
608 * we will accept.
610 uint64_t seqnum_low;
612 * seqnum_range is the range of credits we have
613 * granted from the sequence windows starting
614 * at seqnum_low.
616 * This gets incremented when new credits are
617 * granted and gets decremented when the
618 * lowest sequence number is consumed
619 * (when seqnum_low gets incremented).
621 uint16_t seqnum_range;
623 * credits_grantedThe number of credits we have currently granted
624 * to the client.
626 * This gets incremented when new credits are
627 * granted and gets decremented when any credit
628 * is comsumed.
630 * Note: the decrementing is different compared
631 * to seqnum_range.
633 uint16_t credits_granted;
635 * The maximum number of credits we will ever
636 * grant to the client.
638 * Typically we will only grant 1/16th of
639 * max_credits.
641 * This is the "server max credits" parameter.
643 uint16_t max_credits;
645 * a bitmap of size max_credits
647 struct bitmap *credits_bitmap;
648 uint32_t max_trans;
649 uint32_t max_read;
650 uint32_t max_write;
651 } smb2;
654 extern struct smbd_server_connection *smbd_server_conn;
656 struct smbd_server_connection *msg_ctx_to_sconn(struct messaging_context *msg_ctx);
658 void smbd_init_globals(void);