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"
24 extern int aio_pending_size;
25 extern int outstanding_aio_calls;
28 struct smbd_dmapi_context;
29 extern struct smbd_dmapi_context *dmapi_ctx;
32 extern bool dfree_broken;
34 /* how many write cache buffers have been allocated */
35 extern unsigned int allocated_write_caches;
37 /* A singleton cache to speed up searching by dev/inode. */
38 struct fsp_singleton_cache {
43 extern const struct mangle_fns *mangle_fns;
45 extern unsigned char *chartest;
47 extern struct tdb_context *tdb_mangled_cache;
50 this determines how many characters are used from the original filename
51 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
52 The largest possible value is 6.
54 extern unsigned mangle_prefix;
58 extern bool logged_ioctl_message;
62 extern time_t last_smb_conf_reload_time;
63 extern time_t last_printer_reload_time;
64 extern pid_t background_lpq_updater_pid;
66 /****************************************************************************
67 structure to hold a linked list of queued messages.
69 ****************************************************************************/
70 extern uint32_t common_flags2;
72 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
73 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
76 struct security_unix_token ut;
77 struct security_token *token;
79 /* A stack of security contexts. We include the current context as being
80 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
81 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
82 extern int sec_ctx_stack_ndx;
83 extern bool become_uid_done;
84 extern bool become_gid_done;
86 extern connection_struct *last_conn;
87 extern uint16_t last_flags;
89 extern uint32_t global_client_caps;
91 extern uint16_t fnf_handle;
94 connection_struct *conn;
97 /* A stack of current_user connection contexts. */
98 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
99 extern int conn_ctx_stack_ndx;
101 struct vfs_init_function_entry;
102 extern struct vfs_init_function_entry *backends;
103 extern char *sparse_buf;
104 extern char *LastDir;
106 struct smbd_parent_context;
107 extern struct smbd_parent_context *am_parent;
108 extern struct memcache *smbd_memcache_ctx;
109 extern bool exit_firsttime;
111 struct tstream_context;
112 struct smbd_smb2_request;
114 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
116 void smbd_lock_socket(struct smbd_server_connection *sconn);
117 void smbd_unlock_socket(struct smbd_server_connection *sconn);
119 NTSTATUS smbd_do_locking(struct smb_request *req,
124 struct smbd_lock_element *ulocks,
126 struct smbd_lock_element *locks,
129 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
133 struct smb_filename *smb_fname,
135 struct timespec write_time_ts,
136 struct ea_list *ea_list,
140 unsigned int max_data_bytes,
142 unsigned int *pdata_size);
144 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
145 struct smb_request *req,
149 struct smb_filename *smb_fname,
150 char **ppdata, int total_data,
153 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
157 unsigned int max_data_bytes,
161 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
162 struct dptr_struct *dirptr,
167 bool (*match_fn)(TALLOC_CTX *ctx,
172 bool (*mode_fn)(TALLOC_CTX *ctx,
174 struct smb_filename *smb_fname,
178 struct smb_filename **_smb_fname,
182 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
183 connection_struct *conn,
184 struct dptr_struct *dirptr,
186 const char *path_mask,
189 int requires_resume_key,
199 bool *got_exact_match,
200 int *_last_entry_off,
201 struct ea_list *name_list);
203 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
204 const struct smb_filename *smb_fname,
205 uint32_t access_mask,
206 uint32_t *access_mask_out);
208 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
210 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
212 const char *location);
213 #define smbd_server_connection_terminate(sconn, reason) \
214 smbd_server_connection_terminate_ex(sconn, reason, __location__)
216 const char *smb2_opcode_name(uint16_t opcode);
217 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
219 void reply_smb2002(struct smb_request *req, uint16_t choice);
220 void reply_smb20ff(struct smb_request *req, uint16_t choice);
221 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
222 uint8_t *inbuf, size_t size);
224 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
227 const char *location);
228 #define smbd_smb2_request_error(req, status) \
229 smbd_smb2_request_error_ex(req, status, NULL, __location__)
230 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
232 DATA_BLOB body, DATA_BLOB *dyn,
233 const char *location);
234 #define smbd_smb2_request_done(req, body, dyn) \
235 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
237 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
238 uint64_t file_id_persistent,
239 uint64_t file_id_volatile,
240 uint8_t oplock_level);
242 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
243 struct tevent_req *subreq,
244 uint32_t defer_time);
246 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
247 void remove_smb2_chained_fsp(files_struct *fsp);
249 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
250 uint32_t data_length);
252 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
253 size_t expected_body_size);
255 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
256 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
257 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
258 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
259 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
260 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
261 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
262 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
264 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
265 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
266 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
267 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
269 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
270 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
271 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
272 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
273 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
274 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
278 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
279 struct tevent_immediate *im,
282 /* SMB1 -> SMB2 glue. */
283 void send_break_message_smb2(files_struct *fsp, int level);
284 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
285 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
286 struct smb_request *req,
291 enum brl_type lock_type,
292 enum brl_flavour lock_flav,
295 uint64_t blocking_smblctx);
296 void process_blocking_lock_queue_smb2(
297 struct smbd_server_connection *sconn, struct timeval tv_curr);
298 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
299 struct byte_range_lock *br_lck,
300 enum file_close_type close_type);
301 /* From smbd/smb2_create.c */
302 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
303 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
304 struct timeval *p_request_time,
306 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
308 void remove_deferred_open_message_smb2(
309 struct smbd_server_connection *sconn, uint64_t mid);
310 bool schedule_deferred_open_message_smb2(
311 struct smbd_server_connection *sconn, uint64_t mid);
312 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
313 struct timeval request_time,
314 struct timeval timeout,
319 struct smbXsrv_connection {
320 struct smbd_server_connection *sconn;
322 const struct tsocket_address *local_address;
323 const struct tsocket_address *remote_address;
324 const char *remote_hostname;
326 struct tevent_context *ev_ctx;
327 struct messaging_context *msg_ctx;
329 enum protocol_types protocol;
333 uint32_t capabilities;
335 uint16_t security_mode;
336 uint16_t num_dialects;
340 uint32_t capabilities;
342 uint16_t security_mode;
350 struct msg_state *msg_state;
353 * Link into libasys for asynchronous operations
355 struct asys_context *asys_ctx;
356 struct tevent_fd *asys_fde;
358 uint64_t smbd_idle_profstamp;
361 * this session_table is used for SMB1 and SMB2,
363 struct smbXsrv_session_table *session_table;
365 * this tcon_table is only used for SMB1.
367 struct smbXsrv_tcon_table *tcon_table;
369 * this open_table is used for SMB1 and SMB2,
370 * because we have a global sconn->real_max_open_files
373 struct smbXsrv_open_table *open_table;
376 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
377 uint32_t smbXsrv_version_global_current(void);
379 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
380 enum protocol_types protocol);
382 NTSTATUS smbXsrv_session_global_init(void);
383 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
385 struct smbXsrv_session **_session);
386 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
387 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
388 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
389 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
390 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
391 uint16_t vuid, NTTIME now,
392 struct smbXsrv_session **session);
393 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
394 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
395 uint64_t session_id, NTTIME now,
396 struct smbXsrv_session **session);
397 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
398 struct tevent_context *ev,
399 struct smbXsrv_connection *conn,
400 struct auth_session_info *session_info,
401 uint64_t previous_session_id,
402 uint64_t current_session_id);
403 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
405 NTSTATUS smbXsrv_tcon_global_init(void);
406 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
407 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
408 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
409 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
411 struct smbXsrv_tcon **_tcon);
412 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
413 uint16_t tree_id, NTTIME now,
414 struct smbXsrv_tcon **tcon);
415 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
416 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
417 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
419 struct smbXsrv_tcon **_tcon);
420 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
421 uint32_t tree_id, NTTIME now,
422 struct smbXsrv_tcon **tcon);
423 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
425 NTSTATUS smbXsrv_open_global_init(void);
426 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
427 struct auth_session_info *session_info,
429 struct smbXsrv_open **_open);
430 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
431 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
432 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
433 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
434 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
435 uint16_t fnum, NTTIME now,
436 struct smbXsrv_open **_open);
437 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
438 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
439 uint64_t persistent_id,
440 uint64_t volatile_id,
442 struct smbXsrv_open **_open);
444 struct smbd_smb2_request {
445 struct smbd_smb2_request *prev, *next;
447 struct smbd_server_connection *sconn;
449 /* the session the request operates on, maybe NULL */
450 struct smbXsrv_session *session;
451 uint64_t last_session_id;
453 /* the tcon the request operates on, maybe NULL */
454 struct smbXsrv_tcon *tcon;
459 struct tevent_timer *async_te;
461 bool compound_related;
464 * the signing/encryption key for the last
465 * request/response of a compound chain
469 struct timeval request_time;
471 /* fake smb1 request. */
472 struct smb_request *smb1req;
473 struct files_struct *compat_chain_fsp;
475 NTSTATUS next_status;
478 * The sub request for async backend calls.
479 * This is used for SMB2 Cancel.
481 struct tevent_req *subreq;
483 #define SMBD_SMB2_HDR_IOV_OFS 0
484 #define SMBD_SMB2_BODY_IOV_OFS 1
485 #define SMBD_SMB2_DYN_IOV_OFS 2
487 #define SMBD_SMB2_NUM_IOV_PER_REQ 3
489 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
490 (&req->dir.vector[(idx)+(ofs)])
492 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
493 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
494 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
495 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
496 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
497 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
499 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
500 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
501 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
502 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
503 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
504 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
505 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
506 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
508 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
509 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
510 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
511 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
512 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
513 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
514 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
515 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
519 * vector[0] TRANSPORT HEADER
522 * vector[2] fixed body
523 * vector[3] dynamic body
528 * vector[5] fixed body
529 * vector[6] dynamic body
534 struct iovec *vector;
538 /* the NBT header is not allocated */
541 * vector[0] TRANSPORT HEADER
544 * vector[2] fixed body
545 * vector[3] dynamic body
550 * vector[5] fixed body
551 * vector[6] dynamic body
556 struct iovec *vector;
561 struct smbd_server_connection;
564 struct pending_message_list;
565 struct pending_auth_data;
568 struct user_struct *next, *prev;
569 uint64_t vuid; /* Tag for this entry. */
571 char *session_keystr; /* used by utmp and pam session code.
575 struct auth_session_info *session_info;
577 struct smbXsrv_session *session;
580 struct smbd_server_connection {
582 const struct tsocket_address *local_address;
583 const struct tsocket_address *remote_address;
584 const char *remote_hostname;
585 struct tevent_context *ev_ctx;
586 struct messaging_context *msg_ctx;
587 struct sys_notify_context *sys_notify_ctx;
588 struct notify_context *notify_ctx;
596 struct user_struct *users;
598 size_t num_connections;
599 struct connection_struct *connections;
602 struct files_struct *files;
604 int real_max_open_files;
605 struct fsp_singleton_cache fsp_fi_cache;
607 struct pending_message_list *deferred_open_queue;
610 /* open directory handles. */
612 struct bitmap *dptr_bmap;
613 struct dptr_struct *dirptrs;
617 uint64_t num_requests;
619 /* Current number of oplocks we have outstanding. */
621 int32_t exclusive_open;
622 int32_t level_II_open;
623 struct kernel_oplocks *kernel_ops;
627 struct fd_event *fde;
631 * fd for the fcntl lock mutexing access to our sock
636 * fd for the trusted pipe from
642 * fde for the trusted_fd
644 struct fd_event *trusted_fde;
647 * Reference count for the fcntl lock to
648 * allow recursive locks.
654 bool encrypted_passwords;
656 struct auth4_context *auth_context;
659 * Size of the data we can receive. Set by us.
660 * Can be modified by the max xmit parameter.
666 uint16_t client_major;
667 uint16_t client_minor;
668 uint32_t client_cap_low;
669 uint32_t client_cap_high;
675 * Size of data we can send to client. Set
676 * by the client for all protocols above CORE.
677 * Set by us for CORE protocol.
680 uint64_t last_session_tag;
682 struct smb_signing_state *signing_state;
684 struct notify_mid_map *notify_mid_maps;
687 /* dlink list we store pending lock records on. */
688 struct blocking_lock_record *blocking_lock_queue;
689 /* dlink list we move cancelled lock records onto. */
690 struct blocking_lock_record *blocking_lock_cancelled_queue;
692 /* The event that makes us process our blocking lock queue */
693 struct timed_event *brl_timeout;
695 bool blocking_lock_unlock_state;
696 bool blocking_lock_cancel_state;
700 struct tevent_queue *recv_queue;
701 struct tevent_queue *send_queue;
702 struct tstream_context *stream;
705 /* The event that makes us process our blocking lock queue */
706 struct timed_event *brl_timeout;
707 bool blocking_lock_unlock_state;
709 struct smbd_smb2_request *requests;
711 * seqnum_low is the lowest sequence number
716 * seqnum_range is the range of credits we have
717 * granted from the sequence windows starting
720 * This gets incremented when new credits are
721 * granted and gets decremented when the
722 * lowest sequence number is consumed
723 * (when seqnum_low gets incremented).
725 uint16_t seqnum_range;
727 * credits_grantedThe number of credits we have currently granted
730 * This gets incremented when new credits are
731 * granted and gets decremented when any credit
734 * Note: the decrementing is different compared
737 uint16_t credits_granted;
739 * The maximum number of credits we will ever
740 * grant to the client.
742 * Typically we will only grant 1/16th of
745 * This is the "server max credits" parameter.
747 uint16_t max_credits;
749 * a bitmap of size max_credits
751 struct bitmap *credits_bitmap;
752 bool supports_multicredit;
756 bool compound_related_in_progress;
759 struct smbXsrv_connection *conn;
762 extern struct smbXsrv_connection *global_smbXsrv_connection;
764 void smbd_init_globals(void);