2 Unix SMB/Netbios implementation.
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"
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;
32 struct smbd_dmapi_context;
33 extern struct smbd_dmapi_context *dmapi_ctx;
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 {
47 extern const struct mangle_fns *mangle_fns;
49 extern unsigned char *chartest;
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;
62 extern bool logged_ioctl_message;
66 extern time_t last_smb_conf_reload_time;
67 extern time_t last_printer_reload_time;
68 extern pid_t background_lpq_updater_pid;
70 /****************************************************************************
71 structure to hold a linked list of queued messages.
73 ****************************************************************************/
74 extern uint32_t common_flags2;
76 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
77 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
80 struct security_unix_token ut;
81 struct security_token *token;
83 /* A stack of security contexts. We include the current context as being
84 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
85 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
86 extern int sec_ctx_stack_ndx;
87 extern bool become_uid_done;
88 extern bool become_gid_done;
90 extern connection_struct *last_conn;
91 extern uint16_t last_flags;
93 extern uint32_t global_client_caps;
95 extern uint16_t fnf_handle;
98 connection_struct *conn;
101 /* A stack of current_user connection contexts. */
102 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
103 extern int conn_ctx_stack_ndx;
105 struct vfs_init_function_entry;
106 extern struct vfs_init_function_entry *backends;
107 extern char *sparse_buf;
108 extern char *LastDir;
110 struct smbd_parent_context;
111 extern struct smbd_parent_context *am_parent;
112 extern struct memcache *smbd_memcache_ctx;
113 extern bool exit_firsttime;
115 struct tstream_context;
116 struct smbd_smb2_request;
117 struct smbd_smb2_session;
118 struct smbd_smb2_tcon;
120 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
122 void smbd_lock_socket(struct smbd_server_connection *sconn);
123 void smbd_unlock_socket(struct smbd_server_connection *sconn);
125 NTSTATUS smbd_do_locking(struct smb_request *req,
130 struct smbd_lock_element *ulocks,
132 struct smbd_lock_element *locks,
135 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
139 struct smb_filename *smb_fname,
141 struct timespec write_time_ts,
142 struct ea_list *ea_list,
146 unsigned int max_data_bytes,
148 unsigned int *pdata_size);
150 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
151 struct smb_request *req,
155 struct smb_filename *smb_fname,
156 char **ppdata, int total_data,
159 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
163 unsigned int max_data_bytes,
167 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
168 struct dptr_struct *dirptr,
173 bool (*match_fn)(TALLOC_CTX *ctx,
178 bool (*mode_fn)(TALLOC_CTX *ctx,
180 struct smb_filename *smb_fname,
184 struct smb_filename **_smb_fname,
188 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
189 connection_struct *conn,
190 struct dptr_struct *dirptr,
192 const char *path_mask,
195 int requires_resume_key,
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 uint32_t access_mask,
212 uint32_t *access_mask_out);
214 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
216 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
218 const char *location);
219 #define smbd_server_connection_terminate(sconn, reason) \
220 smbd_server_connection_terminate_ex(sconn, reason, __location__)
222 const char *smb2_opcode_name(uint16_t opcode);
223 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
225 void reply_smb2002(struct smb_request *req, uint16_t choice);
226 void reply_smb20ff(struct smb_request *req, uint16_t choice);
227 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
228 const uint8_t *inbuf, size_t size);
230 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
233 const char *location);
234 #define smbd_smb2_request_error(req, status) \
235 smbd_smb2_request_error_ex(req, status, NULL, __location__)
236 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
238 DATA_BLOB body, DATA_BLOB *dyn,
239 const char *location);
240 #define smbd_smb2_request_done(req, body, dyn) \
241 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
243 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
244 uint64_t file_id_persistent,
245 uint64_t file_id_volatile,
246 uint8_t oplock_level);
248 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
249 struct tevent_req *subreq,
250 uint32_t defer_time);
252 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
253 void remove_smb2_chained_fsp(files_struct *fsp);
255 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
256 uint32_t data_length);
258 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
259 size_t expected_body_size);
261 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
262 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
264 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
266 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
267 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
268 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
269 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
270 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
271 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
272 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
273 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
274 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
281 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
282 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
283 struct tevent_immediate *im,
286 /* SMB1 -> SMB2 glue. */
287 void send_break_message_smb2(files_struct *fsp, int level);
288 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
289 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
290 struct smb_request *req,
295 enum brl_type lock_type,
296 enum brl_flavour lock_flav,
299 uint64_t blocking_smblctx);
300 void process_blocking_lock_queue_smb2(
301 struct smbd_server_connection *sconn, struct timeval tv_curr);
302 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
303 struct byte_range_lock *br_lck,
304 enum file_close_type close_type);
305 /* From smbd/smb2_create.c */
306 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
307 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
308 struct timeval *p_request_time,
310 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
312 void remove_deferred_open_message_smb2(
313 struct smbd_server_connection *sconn, uint64_t mid);
314 void schedule_deferred_open_message_smb2(
315 struct smbd_server_connection *sconn, uint64_t mid);
316 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
317 struct timeval request_time,
318 struct timeval timeout,
323 struct smbXsrv_connection {
324 struct smbd_server_connection *sconn;
326 const struct tsocket_address *local_address;
327 const struct tsocket_address *remote_address;
328 const char *remote_hostname;
330 struct tevent_context *ev_ctx;
331 struct messaging_context *msg_ctx;
333 enum protocol_types protocol;
337 uint32_t capabilities;
339 uint16_t security_mode;
340 uint16_t num_dialects;
344 uint32_t capabilities;
346 uint16_t security_mode;
354 struct msg_state *msg_state;
357 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
358 enum protocol_types protocol);
360 struct smbd_smb2_request {
361 struct smbd_smb2_request *prev, *next;
363 TALLOC_CTX *mem_pool;
364 struct smbd_smb2_request **parent;
366 struct smbd_server_connection *sconn;
368 /* the session the request operates on, maybe NULL */
369 struct smbd_smb2_session *session;
370 uint64_t last_session_id;
372 /* the tcon the request operates on, maybe NULL */
373 struct smbd_smb2_tcon *tcon;
378 struct tevent_timer *async_te;
380 bool compound_related;
382 struct timeval request_time;
384 /* fake smb1 request. */
385 struct smb_request *smb1req;
386 struct files_struct *compat_chain_fsp;
388 NTSTATUS next_status;
391 * The sub request for async backend calls.
392 * This is used for SMB2 Cancel.
394 struct tevent_req *subreq;
397 /* the NBT header is not allocated */
403 * vector[2] fixed body
404 * vector[3] dynamic body
409 * vector[5] fixed body
410 * vector[6] dynamic body
415 struct iovec *vector;
419 /* the NBT header is not allocated */
425 * vector[2] fixed body
426 * vector[3] dynamic body
431 * vector[5] fixed body
432 * vector[6] dynamic body
437 struct iovec *vector;
442 struct smbd_server_connection;
445 struct smbd_smb2_session {
446 struct smbd_smb2_session *prev, *next;
447 struct smbd_server_connection *sconn;
450 struct gensec_security *gensec_security;
451 struct auth_session_info *session_info;
452 DATA_BLOB session_key;
455 struct user_struct *compat_vuser;
458 /* an id tree used to allocate tids */
459 struct idr_context *idtree;
461 /* this is the limit of tid values for this connection */
464 struct smbd_smb2_tcon *list;
468 struct smbd_smb2_tcon {
469 struct smbd_smb2_tcon *prev, *next;
470 struct smbd_smb2_session *session;
473 connection_struct *compat_conn;
476 struct pending_message_list;
477 struct pending_auth_data;
480 struct user_struct *next, *prev;
481 uint64_t vuid; /* Tag for this entry. */
483 char *session_keystr; /* used by utmp and pam session code.
487 struct auth_session_info *session_info;
489 struct gensec_security *gensec_security;
492 struct smbd_server_connection {
494 const struct tsocket_address *local_address;
495 const struct tsocket_address *remote_address;
496 const char *remote_hostname;
497 struct tevent_context *ev_ctx;
498 struct messaging_context *msg_ctx;
499 struct sys_notify_context *sys_notify_ctx;
500 struct notify_context *notify_ctx;
508 struct user_struct *users;
510 size_t num_connections;
511 struct connection_struct *connections;
514 struct files_struct *files;
516 struct bitmap *file_bmap;
517 int real_max_open_files;
518 struct fsp_singleton_cache fsp_fi_cache;
519 unsigned long file_gen_counter;
522 struct pending_message_list *deferred_open_queue;
525 /* open directory handles. */
527 struct bitmap *dptr_bmap;
528 struct dptr_struct *dirptrs;
532 uint64_t num_requests;
534 /* Current number of oplocks we have outstanding. */
536 int32_t exclusive_open;
537 int32_t level_II_open;
538 struct kernel_oplocks *kernel_ops;
542 struct fd_event *fde;
546 * fd for the fcntl lock mutexing access to our sock
551 * fd for the trusted pipe from
557 * fde for the trusted_fd
559 struct fd_event *trusted_fde;
562 * Reference count for the fcntl lock to
563 * allow recursive locks.
569 bool encrypted_passwords;
571 struct auth4_context *auth_context;
574 * Size of the data we can receive. Set by us.
575 * Can be modified by the max xmit parameter.
581 uint16_t client_major;
582 uint16_t client_minor;
583 uint32_t client_cap_low;
584 uint32_t client_cap_high;
590 * Size of data we can send to client. Set
591 * by the client for all protocols above CORE.
592 * Set by us for CORE protocol.
595 uint64_t last_session_tag;
598 * this holds info on user ids that are already
599 * validated for this VC
604 /* number of open connections */
607 struct smb_signing_state *signing_state;
609 struct notify_mid_map *notify_mid_maps;
612 /* dlink list we store pending lock records on. */
613 struct blocking_lock_record *blocking_lock_queue;
614 /* dlink list we move cancelled lock records onto. */
615 struct blocking_lock_record *blocking_lock_cancelled_queue;
617 /* The event that makes us process our blocking lock queue */
618 struct timed_event *brl_timeout;
620 bool blocking_lock_unlock_state;
621 bool blocking_lock_cancel_state;
625 struct tevent_queue *recv_queue;
626 struct tevent_queue *send_queue;
627 struct tstream_context *stream;
630 /* an id tree used to allocate vuids */
631 /* this holds info on session vuids that are already
632 * validated for this VC */
633 struct idr_context *idtree;
635 /* this is the limit of vuid values for this connection */
638 struct smbd_smb2_session *list;
641 /* The event that makes us process our blocking lock queue */
642 struct timed_event *brl_timeout;
643 bool blocking_lock_unlock_state;
645 struct smbd_smb2_request *requests;
647 uint32_t credits_granted;
648 uint32_t max_credits;
652 bool supports_multicredit;
653 struct bitmap *credits_bitmap;
654 bool compound_related_in_progress;
657 struct smbXsrv_connection *conn;
660 extern struct smbXsrv_connection *global_smbXsrv_connection;
662 void smbd_init_globals(void);