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 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;
118 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
120 void smbd_lock_socket(struct smbd_server_connection *sconn);
121 void smbd_unlock_socket(struct smbd_server_connection *sconn);
123 NTSTATUS smbd_do_locking(struct smb_request *req,
128 struct smbd_lock_element *ulocks,
130 struct smbd_lock_element *locks,
133 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
137 struct smb_filename *smb_fname,
139 struct timespec write_time_ts,
140 struct ea_list *ea_list,
144 unsigned int max_data_bytes,
146 unsigned int *pdata_size);
148 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
149 struct smb_request *req,
153 struct smb_filename *smb_fname,
154 char **ppdata, int total_data,
157 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
161 unsigned int max_data_bytes,
165 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
166 struct dptr_struct *dirptr,
171 bool (*match_fn)(TALLOC_CTX *ctx,
176 bool (*mode_fn)(TALLOC_CTX *ctx,
178 struct smb_filename *smb_fname,
182 struct smb_filename **_smb_fname,
186 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
187 connection_struct *conn,
188 struct dptr_struct *dirptr,
190 const char *path_mask,
193 int requires_resume_key,
203 bool *got_exact_match,
204 int *_last_entry_off,
205 struct ea_list *name_list);
207 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
208 const struct smb_filename *smb_fname,
209 uint32_t access_mask,
210 uint32_t *access_mask_out);
212 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
214 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
216 const char *location);
217 #define smbd_server_connection_terminate(sconn, reason) \
218 smbd_server_connection_terminate_ex(sconn, reason, __location__)
220 const char *smb2_opcode_name(uint16_t opcode);
221 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
223 void reply_smb2002(struct smb_request *req, uint16_t choice);
224 void reply_smb20ff(struct smb_request *req, uint16_t choice);
225 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
226 const uint8_t *inbuf, size_t size);
228 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
231 const char *location);
232 #define smbd_smb2_request_error(req, status) \
233 smbd_smb2_request_error_ex(req, status, NULL, __location__)
234 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
236 DATA_BLOB body, DATA_BLOB *dyn,
237 const char *location);
238 #define smbd_smb2_request_done(req, body, dyn) \
239 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
241 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
242 uint64_t file_id_persistent,
243 uint64_t file_id_volatile,
244 uint8_t oplock_level);
246 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
247 struct tevent_req *subreq,
248 uint32_t defer_time);
250 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
251 void remove_smb2_chained_fsp(files_struct *fsp);
253 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
254 uint32_t data_length);
256 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
257 size_t expected_body_size);
259 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
260 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
261 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
262 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
264 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
266 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
267 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
268 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
269 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
270 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
271 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
272 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
273 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
274 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
280 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
281 struct tevent_immediate *im,
284 /* SMB1 -> SMB2 glue. */
285 void send_break_message_smb2(files_struct *fsp, int level);
286 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
287 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
288 struct smb_request *req,
293 enum brl_type lock_type,
294 enum brl_flavour lock_flav,
297 uint64_t blocking_smblctx);
298 void process_blocking_lock_queue_smb2(
299 struct smbd_server_connection *sconn, struct timeval tv_curr);
300 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
301 struct byte_range_lock *br_lck,
302 enum file_close_type close_type);
303 /* From smbd/smb2_create.c */
304 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
305 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
306 struct timeval *p_request_time,
308 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
310 void remove_deferred_open_message_smb2(
311 struct smbd_server_connection *sconn, uint64_t mid);
312 bool schedule_deferred_open_message_smb2(
313 struct smbd_server_connection *sconn, uint64_t mid);
314 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
315 struct timeval request_time,
316 struct timeval timeout,
321 struct smbXsrv_connection {
322 struct smbd_server_connection *sconn;
324 const struct tsocket_address *local_address;
325 const struct tsocket_address *remote_address;
326 const char *remote_hostname;
328 struct tevent_context *ev_ctx;
329 struct messaging_context *msg_ctx;
331 enum protocol_types protocol;
335 uint32_t capabilities;
337 uint16_t security_mode;
338 uint16_t num_dialects;
342 uint32_t capabilities;
344 uint16_t security_mode;
352 struct msg_state *msg_state;
354 uint64_t smbd_idle_profstamp;
357 * this session_table is used for SMB1 and SMB2,
359 struct smbXsrv_session_table *session_table;
361 * this tcon_table is only used for SMB1.
363 struct smbXsrv_tcon_table *tcon_table;
365 * this open_table is used for SMB1 and SMB2,
366 * because we have a global sconn->real_max_open_files
369 struct smbXsrv_open_table *open_table;
372 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
373 uint32_t smbXsrv_version_global_current(void);
375 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
376 enum protocol_types protocol);
378 NTSTATUS smbXsrv_session_global_init(void);
379 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
381 struct smbXsrv_session **_session);
382 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
383 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
384 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
385 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
386 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
387 uint16_t vuid, NTTIME now,
388 struct smbXsrv_session **session);
389 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
390 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
391 uint64_t session_id, NTTIME now,
392 struct smbXsrv_session **session);
393 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
394 struct tevent_context *ev,
395 struct smbXsrv_connection *conn,
396 struct auth_session_info *session_info,
397 uint64_t previous_session_id,
398 uint64_t current_session_id);
399 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
401 NTSTATUS smbXsrv_tcon_global_init(void);
402 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
403 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
404 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
405 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
407 struct smbXsrv_tcon **_tcon);
408 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
409 uint16_t tree_id, NTTIME now,
410 struct smbXsrv_tcon **tcon);
411 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
412 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
413 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
415 struct smbXsrv_tcon **_tcon);
416 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
417 uint32_t tree_id, NTTIME now,
418 struct smbXsrv_tcon **tcon);
419 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
421 NTSTATUS smbXsrv_open_global_init(void);
422 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
423 struct auth_session_info *session_info,
425 struct smbXsrv_open **_open);
426 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
427 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
428 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
429 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
430 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
431 uint16_t fnum, NTTIME now,
432 struct smbXsrv_open **_open);
433 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
434 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
435 uint64_t persistent_id,
436 uint64_t volatile_id,
438 struct smbXsrv_open **_open);
440 struct smbd_smb2_request {
441 struct smbd_smb2_request *prev, *next;
443 TALLOC_CTX *mem_pool;
444 struct smbd_smb2_request **parent;
446 struct smbd_server_connection *sconn;
448 /* the session the request operates on, maybe NULL */
449 struct smbXsrv_session *session;
450 uint64_t last_session_id;
452 /* the tcon the request operates on, maybe NULL */
453 struct smbXsrv_tcon *tcon;
458 struct tevent_timer *async_te;
460 bool compound_related;
462 struct timeval request_time;
464 /* fake smb1 request. */
465 struct smb_request *smb1req;
466 struct files_struct *compat_chain_fsp;
468 NTSTATUS next_status;
471 * The sub request for async backend calls.
472 * This is used for SMB2 Cancel.
474 struct tevent_req *subreq;
477 /* the NBT header is not allocated */
483 * vector[2] fixed body
484 * vector[3] dynamic body
489 * vector[5] fixed body
490 * vector[6] dynamic body
495 struct iovec *vector;
499 /* the NBT header is not allocated */
505 * vector[2] fixed body
506 * vector[3] dynamic body
511 * vector[5] fixed body
512 * vector[6] dynamic body
517 struct iovec *vector;
522 struct smbd_server_connection;
525 struct pending_message_list;
526 struct pending_auth_data;
529 struct user_struct *next, *prev;
530 uint64_t vuid; /* Tag for this entry. */
532 char *session_keystr; /* used by utmp and pam session code.
536 struct auth_session_info *session_info;
538 struct smbXsrv_session *session;
541 struct smbd_server_connection {
543 const struct tsocket_address *local_address;
544 const struct tsocket_address *remote_address;
545 const char *remote_hostname;
546 struct tevent_context *ev_ctx;
547 struct messaging_context *msg_ctx;
548 struct sys_notify_context *sys_notify_ctx;
549 struct notify_context *notify_ctx;
557 struct user_struct *users;
559 size_t num_connections;
560 struct connection_struct *connections;
563 struct files_struct *files;
565 int real_max_open_files;
566 struct fsp_singleton_cache fsp_fi_cache;
568 struct pending_message_list *deferred_open_queue;
571 /* open directory handles. */
573 struct bitmap *dptr_bmap;
574 struct dptr_struct *dirptrs;
578 uint64_t num_requests;
580 /* Current number of oplocks we have outstanding. */
582 int32_t exclusive_open;
583 int32_t level_II_open;
584 struct kernel_oplocks *kernel_ops;
588 struct fd_event *fde;
592 * fd for the fcntl lock mutexing access to our sock
597 * fd for the trusted pipe from
603 * fde for the trusted_fd
605 struct fd_event *trusted_fde;
608 * Reference count for the fcntl lock to
609 * allow recursive locks.
615 bool encrypted_passwords;
617 struct auth4_context *auth_context;
620 * Size of the data we can receive. Set by us.
621 * Can be modified by the max xmit parameter.
627 uint16_t client_major;
628 uint16_t client_minor;
629 uint32_t client_cap_low;
630 uint32_t client_cap_high;
636 * Size of data we can send to client. Set
637 * by the client for all protocols above CORE.
638 * Set by us for CORE protocol.
641 uint64_t last_session_tag;
643 struct smb_signing_state *signing_state;
645 struct notify_mid_map *notify_mid_maps;
648 /* dlink list we store pending lock records on. */
649 struct blocking_lock_record *blocking_lock_queue;
650 /* dlink list we move cancelled lock records onto. */
651 struct blocking_lock_record *blocking_lock_cancelled_queue;
653 /* The event that makes us process our blocking lock queue */
654 struct timed_event *brl_timeout;
656 bool blocking_lock_unlock_state;
657 bool blocking_lock_cancel_state;
661 struct tevent_queue *recv_queue;
662 struct tevent_queue *send_queue;
663 struct tstream_context *stream;
666 /* The event that makes us process our blocking lock queue */
667 struct timed_event *brl_timeout;
668 bool blocking_lock_unlock_state;
670 struct smbd_smb2_request *requests;
672 * seqnum_low is the lowest sequence number
677 * seqnum_range is the range of credits we have
678 * granted from the sequence windows starting
681 * This gets incremented when new credits are
682 * granted and gets decremented when the
683 * lowest sequence number is consumed
684 * (when seqnum_low gets incremented).
686 uint16_t seqnum_range;
688 * credits_grantedThe number of credits we have currently granted
691 * This gets incremented when new credits are
692 * granted and gets decremented when any credit
695 * Note: the decrementing is different compared
698 uint16_t credits_granted;
700 * The maximum number of credits we will ever
701 * grant to the client.
703 * Typically we will only grant 1/16th of
706 * This is the "server max credits" parameter.
708 uint16_t max_credits;
710 * a bitmap of size max_credits
712 struct bitmap *credits_bitmap;
713 bool supports_multicredit;
717 bool compound_related_in_progress;
720 struct smbXsrv_connection *conn;
723 extern struct smbXsrv_connection *global_smbXsrv_connection;
725 void smbd_init_globals(void);