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"
22 #include "librpc/gen_ndr/smbXsrv.h"
26 extern struct aio_extra *aio_list_head;
27 extern struct tevent_signal *aio_signal_event;
28 extern int aio_pending_size;
29 extern int outstanding_aio_calls;
33 struct smbd_dmapi_context;
34 extern struct smbd_dmapi_context *dmapi_ctx;
37 extern bool dfree_broken;
39 /* how many write cache buffers have been allocated */
40 extern unsigned int allocated_write_caches;
42 /* A singleton cache to speed up searching by dev/inode. */
43 struct fsp_singleton_cache {
48 extern const struct mangle_fns *mangle_fns;
50 extern unsigned char *chartest;
52 extern struct tdb_context *tdb_mangled_cache;
55 this determines how many characters are used from the original filename
56 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
57 The largest possible value is 6.
59 extern unsigned mangle_prefix;
63 extern bool logged_ioctl_message;
67 extern time_t last_smb_conf_reload_time;
68 extern time_t last_printer_reload_time;
69 extern pid_t background_lpq_updater_pid;
71 /****************************************************************************
72 structure to hold a linked list of queued messages.
74 ****************************************************************************/
75 extern uint32_t common_flags2;
77 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
78 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
81 struct security_unix_token ut;
82 struct security_token *token;
84 /* A stack of security contexts. We include the current context as being
85 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
86 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
87 extern int sec_ctx_stack_ndx;
88 extern bool become_uid_done;
89 extern bool become_gid_done;
91 extern connection_struct *last_conn;
92 extern uint16_t last_flags;
94 extern uint32_t global_client_caps;
96 extern uint16_t fnf_handle;
99 connection_struct *conn;
102 /* A stack of current_user connection contexts. */
103 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
104 extern int conn_ctx_stack_ndx;
106 struct vfs_init_function_entry;
107 extern struct vfs_init_function_entry *backends;
108 extern char *sparse_buf;
109 extern char *LastDir;
111 struct smbd_parent_context;
112 extern struct smbd_parent_context *am_parent;
113 extern struct memcache *smbd_memcache_ctx;
114 extern bool exit_firsttime;
116 struct tstream_context;
117 struct smbd_smb2_request;
118 struct smbd_smb2_session;
119 struct smbd_smb2_tcon;
121 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
123 void smbd_lock_socket(struct smbd_server_connection *sconn);
124 void smbd_unlock_socket(struct smbd_server_connection *sconn);
126 NTSTATUS smbd_do_locking(struct smb_request *req,
131 struct smbd_lock_element *ulocks,
133 struct smbd_lock_element *locks,
136 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
140 struct smb_filename *smb_fname,
142 struct timespec write_time_ts,
143 struct ea_list *ea_list,
147 unsigned int max_data_bytes,
149 unsigned int *pdata_size);
151 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
152 struct smb_request *req,
156 struct smb_filename *smb_fname,
157 char **ppdata, int total_data,
160 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
164 unsigned int max_data_bytes,
168 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
169 struct dptr_struct *dirptr,
174 bool (*match_fn)(TALLOC_CTX *ctx,
179 bool (*mode_fn)(TALLOC_CTX *ctx,
181 struct smb_filename *smb_fname,
185 struct smb_filename **_smb_fname,
189 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
190 connection_struct *conn,
191 struct dptr_struct *dirptr,
193 const char *path_mask,
196 int requires_resume_key,
206 bool *got_exact_match,
207 int *_last_entry_off,
208 struct ea_list *name_list);
210 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
211 const struct smb_filename *smb_fname,
212 uint32_t access_mask,
213 uint32_t *access_mask_out);
215 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
217 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
219 const char *location);
220 #define smbd_server_connection_terminate(sconn, reason) \
221 smbd_server_connection_terminate_ex(sconn, reason, __location__)
223 const char *smb2_opcode_name(uint16_t opcode);
224 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
226 void reply_smb2002(struct smb_request *req, uint16_t choice);
227 void reply_smb20ff(struct smb_request *req, uint16_t choice);
228 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
229 const uint8_t *inbuf, size_t size);
231 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
234 const char *location);
235 #define smbd_smb2_request_error(req, status) \
236 smbd_smb2_request_error_ex(req, status, NULL, __location__)
237 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
239 DATA_BLOB body, DATA_BLOB *dyn,
240 const char *location);
241 #define smbd_smb2_request_done(req, body, dyn) \
242 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
244 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
245 uint64_t file_id_persistent,
246 uint64_t file_id_volatile,
247 uint8_t oplock_level);
249 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
250 struct tevent_req *subreq,
251 uint32_t defer_time);
253 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
254 void remove_smb2_chained_fsp(files_struct *fsp);
256 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
257 uint32_t data_length);
259 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
260 size_t expected_body_size);
262 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
264 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
266 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
267 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
268 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
269 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
270 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
271 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
272 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
273 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
274 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
281 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
282 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
283 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
284 struct tevent_immediate *im,
287 /* SMB1 -> SMB2 glue. */
288 void send_break_message_smb2(files_struct *fsp, int level);
289 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
290 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
291 struct smb_request *req,
296 enum brl_type lock_type,
297 enum brl_flavour lock_flav,
300 uint64_t blocking_smblctx);
301 void process_blocking_lock_queue_smb2(
302 struct smbd_server_connection *sconn, struct timeval tv_curr);
303 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
304 struct byte_range_lock *br_lck,
305 enum file_close_type close_type);
306 /* From smbd/smb2_create.c */
307 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
308 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
309 struct timeval *p_request_time,
311 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
313 void remove_deferred_open_message_smb2(
314 struct smbd_server_connection *sconn, uint64_t mid);
315 void schedule_deferred_open_message_smb2(
316 struct smbd_server_connection *sconn, uint64_t mid);
317 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
318 struct timeval request_time,
319 struct timeval timeout,
324 struct smbXsrv_connection {
325 struct smbd_server_connection *sconn;
327 const struct tsocket_address *local_address;
328 const struct tsocket_address *remote_address;
329 const char *remote_hostname;
331 struct tevent_context *ev_ctx;
332 struct messaging_context *msg_ctx;
334 enum protocol_types protocol;
338 uint32_t capabilities;
340 uint16_t security_mode;
341 uint16_t num_dialects;
345 uint32_t capabilities;
347 uint16_t security_mode;
355 struct msg_state *msg_state;
357 struct smbXsrv_session_table *session_table;
358 struct smbXsrv_tcon_table *tcon_table;
361 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
362 uint32_t smbXsrv_version_global_current(void);
364 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
365 enum protocol_types protocol);
367 NTSTATUS smbXsrv_session_global_init(void);
368 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
370 struct smbXsrv_session **_session);
371 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
372 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
373 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
374 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
375 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
376 uint16_t vuid, NTTIME now,
377 struct smbXsrv_session **session);
378 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
379 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
380 uint64_t session_id, NTTIME now,
381 struct smbXsrv_session **session);
383 NTSTATUS smbXsrv_tcon_global_init(void);
384 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
385 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
386 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
387 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
389 struct smbXsrv_tcon **_tcon);
390 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
391 uint16_t tree_id, NTTIME now,
392 struct smbXsrv_tcon **tcon);
393 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
394 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
395 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
397 struct smbXsrv_tcon **_tcon);
398 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
399 uint32_t tree_id, NTTIME now,
400 struct smbXsrv_tcon **tcon);
401 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
403 struct smbd_smb2_request {
404 struct smbd_smb2_request *prev, *next;
406 TALLOC_CTX *mem_pool;
407 struct smbd_smb2_request **parent;
409 struct smbd_server_connection *sconn;
411 /* the session the request operates on, maybe NULL */
412 struct smbd_smb2_session *session;
413 uint64_t last_session_id;
415 /* the tcon the request operates on, maybe NULL */
416 struct smbd_smb2_tcon *tcon;
421 struct tevent_timer *async_te;
423 bool compound_related;
425 struct timeval request_time;
427 /* fake smb1 request. */
428 struct smb_request *smb1req;
429 struct files_struct *compat_chain_fsp;
431 NTSTATUS next_status;
434 * The sub request for async backend calls.
435 * This is used for SMB2 Cancel.
437 struct tevent_req *subreq;
440 /* the NBT header is not allocated */
446 * vector[2] fixed body
447 * vector[3] dynamic body
452 * vector[5] fixed body
453 * vector[6] dynamic body
458 struct iovec *vector;
462 /* the NBT header is not allocated */
468 * vector[2] fixed body
469 * vector[3] dynamic body
474 * vector[5] fixed body
475 * vector[6] dynamic body
480 struct iovec *vector;
485 struct smbd_server_connection;
487 struct smbd_smb2_session {
488 struct smbd_smb2_session *prev, *next;
489 struct smbd_server_connection *sconn;
492 struct gensec_security *gensec_security;
493 struct auth_session_info *session_info;
495 struct smbXsrv_session *smbXsrv;
497 user_struct *compat_vuser;
500 /* an id tree used to allocate tids */
501 struct idr_context *idtree;
503 /* this is the limit of tid values for this connection */
506 struct smbd_smb2_tcon *list;
510 struct smbd_smb2_tcon {
511 struct smbd_smb2_tcon *prev, *next;
512 struct smbd_smb2_session *session;
515 connection_struct *compat_conn;
518 struct pending_message_list;
519 struct pending_auth_data;
521 struct smbd_server_connection {
523 const struct tsocket_address *local_address;
524 const struct tsocket_address *remote_address;
525 const char *remote_hostname;
526 struct tevent_context *ev_ctx;
527 struct messaging_context *msg_ctx;
528 struct sys_notify_context *sys_notify_ctx;
529 struct notify_context *notify_ctx;
537 struct user_struct *users;
539 size_t num_connections;
540 struct connection_struct *connections;
543 struct files_struct *files;
545 struct bitmap *file_bmap;
546 int real_max_open_files;
547 struct fsp_singleton_cache fsp_fi_cache;
548 unsigned long file_gen_counter;
551 struct pending_message_list *deferred_open_queue;
554 /* open directory handles. */
556 struct bitmap *dptr_bmap;
557 struct dptr_struct *dirptrs;
561 uint64_t num_requests;
563 /* Current number of oplocks we have outstanding. */
565 int32_t exclusive_open;
566 int32_t level_II_open;
567 struct kernel_oplocks *kernel_ops;
571 struct fd_event *fde;
575 * fd for the fcntl lock mutexing access to our sock
580 * fd for the trusted pipe from
586 * fde for the trusted_fd
588 struct fd_event *trusted_fde;
591 * Reference count for the fcntl lock to
592 * allow recursive locks.
598 bool encrypted_passwords;
600 struct auth4_context *auth_context;
603 * Size of the data we can receive. Set by us.
604 * Can be modified by the max xmit parameter.
610 uint16_t client_major;
611 uint16_t client_minor;
612 uint32_t client_cap_low;
613 uint32_t client_cap_high;
619 * Size of data we can send to client. Set
620 * by the client for all protocols above CORE.
621 * Set by us for CORE protocol.
624 uint16_t last_session_tag;
627 * this holds info on user ids that are already
628 * validated for this VC
633 /* number of open connections */
636 struct smb_signing_state *signing_state;
638 struct notify_mid_map *notify_mid_maps;
641 /* dlink list we store pending lock records on. */
642 struct blocking_lock_record *blocking_lock_queue;
643 /* dlink list we move cancelled lock records onto. */
644 struct blocking_lock_record *blocking_lock_cancelled_queue;
646 /* The event that makes us process our blocking lock queue */
647 struct timed_event *brl_timeout;
649 bool blocking_lock_unlock_state;
650 bool blocking_lock_cancel_state;
654 struct tevent_queue *recv_queue;
655 struct tevent_queue *send_queue;
656 struct tstream_context *stream;
659 struct smbd_smb2_session *list;
662 /* The event that makes us process our blocking lock queue */
663 struct timed_event *brl_timeout;
664 bool blocking_lock_unlock_state;
666 struct smbd_smb2_request *requests;
668 uint32_t credits_granted;
669 uint32_t max_credits;
673 bool supports_multicredit;
674 struct bitmap *credits_bitmap;
675 bool compound_related_in_progress;
678 struct smbXsrv_connection *conn;
681 extern struct smbXsrv_connection *global_smbXsrv_connection;
683 void smbd_init_globals(void);