2 * Unix SMB/CIFS implementation.
3 * Main SMB server routines
5 * Copyright (C) Andrew Tridgell 1992-2002,2006
6 * Copyright (C) Jeremy Allison 1992-2010
7 * Copyright (C) Volker Lendecke 1993-2009
8 * Copyright (C) John H Terpstra 1995-1998
9 * Copyright (C) Luke Kenneth Casson Leighton 1996-1998
10 * Copyright (C) Paul Ashton 1997-1998
11 * Copyright (C) Tim Potter 1999-2000
12 * Copyright (C) T.D.Lee@durham.ac.uk 1999
13 * Copyright (C) Ying Chen 2000
14 * Copyright (C) Shirish Kalele 2000
15 * Copyright (C) Andrew Bartlett 2001-2003
16 * Copyright (C) Alexander Bokovoy 2002,2005
17 * Copyright (C) Simo Sorce 2001-2002,2009
18 * Copyright (C) Andreas Gruenbacher 2002
19 * Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2002
20 * Copyright (C) Martin Pool 2002
21 * Copyright (C) Luke Howard 2003
22 * Copyright (C) Stefan (metze) Metzmacher 2003,2009
23 * Copyright (C) Steve French 2005
24 * Copyright (C) Gerald (Jerry) Carter 2006
25 * Copyright (C) James Peach 2006-2007
26 * Copyright (C) Jelmer Vernooij 2002-2003
27 * Copyright (C) Michael Adam 2007
28 * Copyright (C) Rishi Srivatsavai 2007
29 * Copyright (C) Tim Prouty 2009
30 * Copyright (C) Gregor Beck 2011
32 * This program is free software; you can redistribute it and/or modify
33 * it under the terms of the GNU General Public License as published by
34 * the Free Software Foundation; either version 3 of the License, or
35 * (at your option) any later version.
37 * This program is distributed in the hope that it will be useful,
38 * but WITHOUT ANY WARRANTY; without even the implied warranty of
39 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
40 * GNU General Public License for more details.
42 * You should have received a copy of the GNU General Public License
43 * along with this program. If not, see <http://www.gnu.org/licenses/>.
46 #ifndef _SMBD_PROTO_H_
47 #define _SMBD_PROTO_H_
49 struct smbXsrv_client;
50 struct smbXsrv_connection;
51 struct dcesrv_context;
53 /* The following definitions come from smbd/smb2_signing.c */
55 bool smb2_srv_init_signing(struct smbXsrv_connection *conn);
56 bool srv_init_signing(struct smbXsrv_connection *conn);
58 /* The following definitions come from smbd/aio.c */
61 bool aio_write_through_requested(struct aio_extra *aio_ex);
62 NTSTATUS schedule_smb2_aio_read(connection_struct *conn,
63 struct smb_request *smbreq,
69 NTSTATUS schedule_aio_smb2_write(connection_struct *conn,
70 struct smb_request *smbreq,
75 bool cancel_smb2_aio(struct smb_request *smbreq);
76 bool aio_add_req_to_fsp(files_struct *fsp, struct tevent_req *req);
77 struct aio_extra *create_aio_extra(TALLOC_CTX *mem_ctx,
80 struct tevent_req *pwrite_fsync_send(TALLOC_CTX *mem_ctx,
81 struct tevent_context *ev,
82 struct files_struct *fsp,
84 size_t n, off_t offset,
86 ssize_t pwrite_fsync_recv(struct tevent_req *req, int *perr);
88 /* The following definitions come from smbd/blocking.c */
90 NTSTATUS smbd_do_locks_try(
91 struct files_struct *fsp,
93 struct smbd_lock_element *locks,
94 uint16_t *blocker_idx,
95 struct server_id *blocking_pid,
96 uint64_t *blocking_smblctx);
97 struct tevent_req *smbd_smb1_do_locks_send(
99 struct tevent_context *ev,
100 struct smb_request **smbreq, /* talloc_move()d into our state */
101 struct files_struct *fsp,
102 uint32_t lock_timeout,
105 struct smbd_lock_element *locks);
106 NTSTATUS smbd_smb1_do_locks_recv(struct tevent_req *req);
107 bool smbd_smb1_do_locks_extract_smbreq(
108 struct tevent_req *req,
110 struct smb_request **psmbreq);
111 void smbd_smb1_brl_finish_by_req(struct tevent_req *req, NTSTATUS status);
112 bool smbd_smb1_brl_finish_by_lock(
113 struct files_struct *fsp,
115 struct smbd_lock_element lock,
116 NTSTATUS finish_status);
117 bool smbd_smb1_brl_finish_by_mid(
118 struct smbd_server_connection *sconn, uint64_t mid);
120 /* The following definitions come from smbd/close.c */
122 void set_close_write_time(struct files_struct *fsp, struct timespec ts);
123 NTSTATUS close_file_smb(struct smb_request *req,
124 struct files_struct *fsp,
125 enum file_close_type close_type);
126 NTSTATUS close_file_free(struct smb_request *req,
127 struct files_struct **_fsp,
128 enum file_close_type close_type);
129 void msg_close_file(struct messaging_context *msg_ctx,
132 struct server_id server_id,
134 NTSTATUS delete_all_streams(connection_struct *conn,
135 const struct smb_filename *smb_fname);
136 NTSTATUS recursive_rmdir(TALLOC_CTX *ctx,
137 connection_struct *conn,
138 struct smb_filename *smb_dname);
139 bool has_other_nonposix_opens(struct share_mode_lock *lck,
140 struct files_struct *fsp);
142 /* The following definitions come from smbd/conn.c */
144 int conn_num_open(struct smbd_server_connection *sconn);
145 bool conn_snum_used(struct smbd_server_connection *sconn, int snum);
146 connection_struct *conn_new(struct smbd_server_connection *sconn);
147 bool conn_idle_all(struct smbd_server_connection *sconn, time_t t);
148 void conn_clear_vuid_caches(struct smbd_server_connection *sconn, uint64_t vuid);
149 void conn_free(connection_struct *conn);
150 void conn_setup_case_options(connection_struct *conn);
151 void conn_force_tdis(
152 struct smbd_server_connection *sconn,
153 bool (*check_fn)(struct connection_struct *conn,
156 void msg_force_tdis(struct messaging_context *msg,
159 struct server_id server_id,
161 void msg_force_tdis_denied(
162 struct messaging_context *msg,
165 struct server_id server_id,
168 /* The following definitions come from smbd/connection.c */
170 int count_current_connections(const char *sharename, bool verify);
171 bool connections_snum_used(struct smbd_server_connection *unused, int snum);
173 /* The following definitions come from smbd/dfree.c */
175 uint64_t get_dfree_info(connection_struct *conn, struct smb_filename *fname,
176 uint64_t *bsize, uint64_t *dfree, uint64_t *dsize);
177 void flush_dfree_cache(void);
179 /* The following definitions come from smbd/dir.c */
181 bool init_dptrs(struct smbd_server_connection *sconn);
182 const char *dptr_path(struct smbd_server_connection *sconn, int key);
183 const char *dptr_wcard(struct smbd_server_connection *sconn, int key);
184 uint16_t dptr_attr(struct smbd_server_connection *sconn, int key);
185 void dptr_closecnum(connection_struct *conn);
186 NTSTATUS dptr_create(connection_struct *conn,
187 struct smb_request *req,
194 struct dptr_struct **dptr_ret);
195 void dptr_CloseDir(files_struct *fsp);
196 void dptr_SeekDir(struct dptr_struct *dptr, long offset);
197 long dptr_TellDir(struct dptr_struct *dptr);
198 bool dptr_has_wild(struct dptr_struct *dptr);
199 int dptr_dnum(struct dptr_struct *dptr);
200 bool dptr_get_priv(struct dptr_struct *dptr);
201 void dptr_set_priv(struct dptr_struct *dptr);
202 bool dptr_case_sensitive(struct dptr_struct *dptr);
203 bool dptr_SearchDir(struct dptr_struct *dptr, const char *name, long *poffset, SMB_STRUCT_STAT *pst);
204 bool dptr_fill(struct smbd_server_connection *sconn,
205 char *buf1,unsigned int key);
206 files_struct *dptr_fetch_fsp(struct smbd_server_connection *sconn,
209 struct files_struct *dir_hnd_fetch_fsp(struct smb_Dir *dir_hnd);
210 files_struct *dptr_fetch_lanman2_fsp(struct smbd_server_connection *sconn,
212 bool get_dir_entry(TALLOC_CTX *ctx,
213 struct dptr_struct *dirptr,
219 struct timespec *date,
223 bool is_visible_fsp(files_struct *fsp);
224 NTSTATUS OpenDir(TALLOC_CTX *mem_ctx,
225 connection_struct *conn,
226 const struct smb_filename *smb_dname,
229 struct smb_Dir **_dir_hnd);
230 NTSTATUS OpenDir_from_pathref(TALLOC_CTX *mem_ctx,
231 struct files_struct *dirfsp,
234 struct smb_Dir **_dir_hnd);
235 const char *ReadDirName(struct smb_Dir *dir_hnd, long *poffset,
236 SMB_STRUCT_STAT *sbuf, char **talloced);
237 void RewindDir(struct smb_Dir *dir_hnd, long *poffset);
238 void SeekDir(struct smb_Dir *dirp, long offset);
239 long TellDir(struct smb_Dir *dirp);
240 NTSTATUS can_delete_directory(struct connection_struct *conn,
241 const char *dirname);
242 bool have_file_open_below(connection_struct *conn,
243 const struct smb_filename *name);
245 /* The following definitions come from smbd/dmapi.c */
247 const void *dmapi_get_current_session(void);
248 bool dmapi_have_session(void);
249 bool dmapi_new_session(void);
250 bool dmapi_destroy_session(void);
251 uint32_t dmapi_file_flags(const char * const path);
253 /* The following definitions come from smbd/dnsregister.c */
255 bool smbd_setup_mdns_registration(struct tevent_context *ev,
259 /* The following definitions come from smbd/dosmode.c */
261 mode_t unix_mode(connection_struct *conn, int dosmode,
262 const struct smb_filename *smb_fname,
263 struct files_struct *parent_dirfsp);
264 uint32_t dos_mode_msdfs(connection_struct *conn,
265 const struct smb_filename *smb_fname);
266 uint32_t fdos_mode(struct files_struct *fsp);
267 struct tevent_req *dos_mode_at_send(TALLOC_CTX *mem_ctx,
268 struct tevent_context *ev,
269 files_struct *dir_fsp,
270 struct smb_filename *smb_fname);
271 NTSTATUS dos_mode_at_recv(struct tevent_req *req, uint32_t *dosmode);
272 int file_set_dosmode(connection_struct *conn,
273 struct smb_filename *smb_fname,
275 struct smb_filename *parent_dir,
277 NTSTATUS file_set_sparse(connection_struct *conn,
278 struct files_struct *fsp,
280 int file_ntimes(connection_struct *conn,
282 struct smb_file_time *ft);
283 bool set_sticky_write_time_path(struct file_id fileid, struct timespec mtime);
284 bool set_sticky_write_time_fsp(struct files_struct *fsp,
285 struct timespec mtime);
287 NTSTATUS fget_ea_dos_attribute(struct files_struct *fsp,
289 NTSTATUS set_ea_dos_attribute(connection_struct *conn,
290 const struct smb_filename *smb_fname,
293 NTSTATUS set_create_timespec_ea(struct files_struct *fsp,
294 struct timespec create_time);
296 struct timespec get_create_timespec(connection_struct *conn,
297 struct files_struct *fsp,
298 const struct smb_filename *smb_fname);
300 struct timespec get_change_timespec(connection_struct *conn,
301 struct files_struct *fsp,
302 const struct smb_filename *smb_fname);
304 NTSTATUS parse_dos_attribute_blob(struct smb_filename *smb_fname,
308 /* The following definitions come from smbd/error.c */
310 bool use_nt_status(void);
311 void error_packet_set(char *outbuf, uint8_t eclass, uint32_t ecode, NTSTATUS ntstatus, int line, const char *file);
312 size_t error_packet(char *outbuf,
318 void reply_nt_error(struct smb_request *req, NTSTATUS ntstatus,
319 int line, const char *file);
320 void reply_force_dos_error(struct smb_request *req, uint8_t eclass, uint32_t ecode,
321 int line, const char *file);
322 void reply_both_error(struct smb_request *req, uint8_t eclass, uint32_t ecode,
323 NTSTATUS status, int line, const char *file);
324 void reply_openerror(struct smb_request *req, NTSTATUS status);
326 /* The following definitions come from smbd/file_access.c */
328 bool can_delete_file_in_directory(connection_struct *conn,
329 struct files_struct *dirfsp,
330 const struct smb_filename *smb_fname);
331 bool can_write_to_fsp(struct files_struct *fsp);
332 bool directory_has_default_acl_fsp(struct files_struct *fsp);
333 NTSTATUS can_set_delete_on_close(files_struct *fsp, uint32_t dosmode);
335 /* The following definitions come from smbd/fileio.c */
337 ssize_t read_file(files_struct *fsp,char *data,off_t pos,size_t n);
338 void fsp_flush_write_time_update(struct files_struct *fsp);
339 void trigger_write_time_update(struct files_struct *fsp);
340 void trigger_write_time_update_immediate(struct files_struct *fsp);
341 void mark_file_modified(files_struct *fsp);
342 ssize_t write_file(struct smb_request *req,
347 NTSTATUS sync_file(connection_struct *conn, files_struct *fsp, bool write_through);
349 /* The following definitions come from smbd/filename.c */
351 uint32_t ucf_flags_from_smb_request(struct smb_request *req);
352 uint32_t filename_create_ucf_flags(struct smb_request *req, uint32_t create_disposition);
353 NTSTATUS unix_convert(TALLOC_CTX *ctx,
354 connection_struct *conn,
355 const char *orig_path,
357 struct smb_filename **smb_fname,
359 NTSTATUS canonicalize_snapshot_path(struct smb_filename *smb_fname,
362 NTSTATUS get_real_filename_full_scan(connection_struct *conn,
368 char *get_original_lcomp(TALLOC_CTX *ctx,
369 connection_struct *conn,
370 const char *filename_in,
372 NTSTATUS filename_convert(TALLOC_CTX *mem_ctx,
373 connection_struct *conn,
377 struct smb_filename **pp_smb_fname);
378 NTSTATUS filename_convert_smb1_search_path(TALLOC_CTX *ctx,
379 connection_struct *conn,
382 struct smb_filename **_smb_fname_out,
385 /* The following definitions come from smbd/files.c */
387 NTSTATUS fsp_new(struct connection_struct *conn, TALLOC_CTX *mem_ctx,
388 files_struct **result);
389 void fsp_set_gen_id(files_struct *fsp);
390 NTSTATUS file_new(struct smb_request *req, connection_struct *conn,
391 files_struct **result);
392 NTSTATUS fsp_bind_smb(struct files_struct *fsp, struct smb_request *req);
393 void file_close_conn(connection_struct *conn);
394 bool file_init_global(void);
395 bool file_init(struct smbd_server_connection *sconn);
396 void file_close_user(struct smbd_server_connection *sconn, uint64_t vuid);
397 struct files_struct *files_forall(
398 struct smbd_server_connection *sconn,
399 struct files_struct *(*fn)(struct files_struct *fsp,
402 files_struct *file_find_fd(struct smbd_server_connection *sconn, int fd);
403 files_struct *file_find_dif(struct smbd_server_connection *sconn,
404 struct file_id id, unsigned long gen_id);
405 files_struct *file_find_di_first(struct smbd_server_connection *sconn,
408 files_struct *file_find_di_next(files_struct *start_fsp,
410 struct files_struct *file_find_one_fsp_from_lease_key(
411 struct smbd_server_connection *sconn,
412 const struct smb2_lease_key *lease_key);
413 bool file_find_subpath(files_struct *dir_fsp);
414 void fsp_unbind_smb(struct smb_request *req, files_struct *fsp);
415 void file_free(struct smb_request *req, files_struct *fsp);
416 files_struct *file_fsp(struct smb_request *req, uint16_t fid);
417 struct files_struct *file_fsp_get(struct smbd_smb2_request *smb2req,
418 uint64_t persistent_id,
419 uint64_t volatile_id);
420 struct files_struct *file_fsp_smb2(struct smbd_smb2_request *smb2req,
421 uint64_t persistent_id,
422 uint64_t volatile_id);
423 NTSTATUS dup_file_fsp(
425 uint32_t access_mask,
427 NTSTATUS file_name_hash(connection_struct *conn,
428 const char *name, uint32_t *p_name_hash);
429 NTSTATUS fsp_set_smb_fname(struct files_struct *fsp,
430 const struct smb_filename *smb_fname_in);
431 size_t fsp_fullbasepath(struct files_struct *fsp, char *buf, size_t buflen);
432 void fsp_set_base_fsp(struct files_struct *fsp, struct files_struct *base_fsp);
433 bool fsp_is_alternate_stream(const struct files_struct *fsp);
434 struct files_struct *metadata_fsp(struct files_struct *fsp);
436 NTSTATUS create_internal_fsp(connection_struct *conn,
437 const struct smb_filename *smb_fname,
438 struct files_struct **_fsp);
439 NTSTATUS create_internal_dirfsp(connection_struct *conn,
440 const struct smb_filename *smb_dname,
441 struct files_struct **_fsp);
443 NTSTATUS open_internal_dirfsp(connection_struct *conn,
444 const struct smb_filename *smb_dname,
446 struct files_struct **_fsp);
447 NTSTATUS openat_internal_dir_from_pathref(
448 struct files_struct *dirfsp,
450 struct files_struct **_fsp);
452 NTSTATUS openat_pathref_fsp(const struct files_struct *dirfsp,
453 struct smb_filename *smb_fname);
455 void smb_fname_fsp_unlink(struct smb_filename *smb_fname);
457 NTSTATUS move_smb_fname_fsp_link(struct smb_filename *smb_fname_dst,
458 struct smb_filename *smb_fname_src);
460 NTSTATUS synthetic_pathref(TALLOC_CTX *mem_ctx,
461 struct files_struct *dirfsp,
462 const char *base_name,
463 const char *stream_name,
464 const SMB_STRUCT_STAT *psbuf,
467 struct smb_filename **_smb_fname);
469 NTSTATUS parent_pathref(TALLOC_CTX *mem_ctx,
470 struct files_struct *dirfsp,
471 const struct smb_filename *smb_fname,
472 struct smb_filename **_parent,
473 struct smb_filename **_atname);
475 /* The following definitions come from smbd/smb2_ipc.c */
477 NTSTATUS nt_status_np_pipe(NTSTATUS status);
479 /* The following definitions come from smbd/mangle.c */
481 void mangle_reset_cache(void);
482 void mangle_change_to_posix(void);
483 bool mangle_is_mangled(const char *s, const struct share_params *p);
484 bool mangle_is_8_3(const char *fname, bool check_case,
485 const struct share_params *p);
486 bool mangle_is_8_3_wildcards(const char *fname, bool check_case,
487 const struct share_params *p);
488 bool mangle_must_mangle(const char *fname,
489 const struct share_params *p);
490 bool mangle_lookup_name_from_8_3(TALLOC_CTX *ctx,
492 char **out, /* talloced on the given context. */
493 const struct share_params *p);
494 bool name_to_8_3(const char *in,
497 const struct share_params *p);
499 /* The following definitions come from smbd/mangle_hash.c */
501 const struct mangle_fns *mangle_hash_init(void);
503 /* The following definitions come from smbd/mangle_hash2.c */
505 const struct mangle_fns *mangle_hash2_init(void);
506 const struct mangle_fns *posix_mangle_init(void);
508 /* The following definitions come from smbd/msdfs.c */
510 bool parse_msdfs_symlink(TALLOC_CTX *ctx,
511 bool shuffle_referrals,
513 struct referral **preflist,
515 bool is_msdfs_link(struct files_struct *dirfsp,
516 struct smb_filename *smb_fname);
518 NTSTATUS get_referred_path(TALLOC_CTX *ctx,
519 struct auth_session_info *session_info,
520 const char *dfs_path,
521 const struct tsocket_address *remote_address,
522 const struct tsocket_address *local_address,
523 bool allow_broken_path,
524 struct junction_map *jucn,
526 bool *self_referralp);
527 int setup_dfs_referral(connection_struct *orig_conn,
528 const char *dfs_path,
529 int max_referral_level,
530 char **ppdata, NTSTATUS *pstatus);
531 bool create_junction(TALLOC_CTX *ctx,
532 const char *dfs_path,
533 bool allow_broken_path,
534 struct junction_map *jucn);
536 char *msdfs_link_string(TALLOC_CTX *ctx,
537 const struct referral *reflist,
538 size_t referral_count);
539 bool create_msdfs_link(const struct junction_map *jucn,
540 struct auth_session_info *session_info);
541 bool remove_msdfs_link(const struct junction_map *jucn,
542 struct auth_session_info *session_info);
544 struct junction_map *enum_msdfs_links(TALLOC_CTX *ctx,
545 struct auth_session_info *session_info,
547 NTSTATUS dfs_redirect(TALLOC_CTX *ctx,
548 connection_struct *conn,
551 bool allow_broken_path,
554 struct connection_struct;
557 NTSTATUS create_conn_struct_cwd(TALLOC_CTX *mem_ctx,
558 struct tevent_context *ev,
559 struct messaging_context *msg,
560 const struct auth_session_info *session_info,
563 struct connection_struct **c);
564 struct conn_struct_tos {
565 struct connection_struct *conn;
566 struct smb_filename *oldcwd_fname;
568 NTSTATUS create_conn_struct_tos(struct messaging_context *msg,
571 const struct auth_session_info *session_info,
572 struct conn_struct_tos **_c);
573 NTSTATUS create_conn_struct_tos_cwd(struct messaging_context *msg,
576 const struct auth_session_info *session_info,
577 struct conn_struct_tos **_c);
579 /* The following definitions come from smbd/notify.c */
581 bool change_notify_fsp_has_changes(struct files_struct *fsp);
582 void change_notify_reply(struct smb_request *req,
585 struct notify_change_buf *notify_buf,
586 void (*reply_fn)(struct smb_request *req,
588 uint8_t *buf, size_t len));
589 void notify_callback(struct smbd_server_connection *sconn,
590 void *private_data, struct timespec when,
591 const struct notify_event *e);
592 NTSTATUS change_notify_create(struct files_struct *fsp,
593 uint32_t max_buffer_size,
596 NTSTATUS change_notify_add_request(struct smb_request *req,
598 uint32_t filter, bool recursive,
599 struct files_struct *fsp,
600 void (*reply_fn)(struct smb_request *req,
602 uint8_t *buf, size_t len));
603 void smbd_notify_cancel_deleted(struct messaging_context *msg,
604 void *private_data, uint32_t msg_type,
605 struct server_id server_id, DATA_BLOB *data);
606 void smbd_notifyd_restarted(struct messaging_context *msg,
607 void *private_data, uint32_t msg_type,
608 struct server_id server_id, DATA_BLOB *data);
609 bool remove_pending_change_notify_requests_by_mid(
610 struct smbd_server_connection *sconn, uint64_t mid);
611 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
613 void notify_fname(connection_struct *conn, uint32_t action, uint32_t filter,
615 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32_t filter);
616 struct sys_notify_context *sys_notify_context_create(TALLOC_CTX *mem_ctx,
617 struct tevent_context *ev);
619 /* The following definitions come from smbd/notify_inotify.c */
621 int inotify_watch(TALLOC_CTX *mem_ctx,
622 struct sys_notify_context *ctx,
625 uint32_t *subdir_filter,
626 void (*callback)(struct sys_notify_context *ctx,
628 struct notify_event *ev,
633 int fam_watch(TALLOC_CTX *mem_ctx,
634 struct sys_notify_context *ctx,
637 uint32_t *subdir_filter,
638 void (*callback)(struct sys_notify_context *ctx,
640 struct notify_event *ev,
646 /* The following definitions come from smbd/notify_internal.c */
648 struct notify_context *notify_init(
649 TALLOC_CTX *mem_ctx, struct messaging_context *msg,
650 struct smbd_server_connection *sconn,
651 void (*callback)(struct smbd_server_connection *sconn,
652 void *, struct timespec,
653 const struct notify_event *));
654 NTSTATUS notify_add(struct notify_context *ctx,
655 const char *path, uint32_t filter, uint32_t subdir_filter,
657 NTSTATUS notify_remove(struct notify_context *ctx, void *private_data,
659 void notify_trigger(struct notify_context *notify,
660 uint32_t action, uint32_t filter,
661 const char *dir, const char *path);
663 /* The following definitions come from smbd/ntquotas.c */
665 NTSTATUS vfs_get_ntquota(files_struct *fsp, enum SMB_QUOTA_TYPE qtype,
666 struct dom_sid *psid, SMB_NTQUOTA_STRUCT *qt);
667 int vfs_set_ntquota(files_struct *fsp, enum SMB_QUOTA_TYPE qtype, struct dom_sid *psid, SMB_NTQUOTA_STRUCT *qt);
668 int vfs_get_user_ntquota_list(files_struct *fsp, SMB_NTQUOTA_LIST **qt_list);
669 void *init_quota_handle(TALLOC_CTX *mem_ctx);
671 /* The following definitions come from smbd/smb2_nttrans.c */
673 NTSTATUS set_sd(files_struct *fsp, struct security_descriptor *psd,
674 uint32_t security_info_sent);
675 NTSTATUS set_sd_blob(files_struct *fsp, uint8_t *data, uint32_t sd_len,
676 uint32_t security_info_sent);
677 NTSTATUS copy_internals(TALLOC_CTX *ctx,
678 connection_struct *conn,
679 struct smb_request *req,
680 struct smb_filename *smb_fname_src,
681 struct smb_filename *smb_fname_dst,
683 NTSTATUS smbd_do_query_security_desc(connection_struct *conn,
686 uint32_t security_info_wanted,
687 uint32_t max_data_count,
688 uint8_t **ppmarshalled_sd,
690 #ifdef HAVE_SYS_QUOTAS
692 struct smb2_query_quota_info;
694 NTSTATUS smbd_do_query_getinfo_quota(TALLOC_CTX *mem_ctx,
698 uint32_t sid_list_length,
699 DATA_BLOB *sidbuffer,
700 uint32_t max_data_count,
702 uint32_t *p_data_size);
705 /* The following definitions come from smbd/open.c */
707 NTSTATUS smbd_check_access_rights_fsp(struct files_struct *dirfsp,
708 struct files_struct *fsp,
710 uint32_t access_mask);
711 NTSTATUS check_parent_access_fsp(struct files_struct *fsp,
712 uint32_t access_mask);
713 NTSTATUS fd_openat(const struct files_struct *dirfsp,
714 struct smb_filename *smb_fname,
716 int flags, mode_t mode);
717 NTSTATUS fd_close(files_struct *fsp);
718 bool is_oplock_stat_open(uint32_t access_mask);
719 bool is_lease_stat_open(uint32_t access_mask);
720 NTSTATUS send_break_message(struct messaging_context *msg_ctx,
721 const struct file_id *id,
722 const struct share_mode_entry *exclusive,
724 struct deferred_open_record;
725 bool is_deferred_open_async(const struct deferred_open_record *rec);
726 bool defer_smb1_sharing_violation(struct smb_request *req);
727 NTSTATUS create_directory(connection_struct *conn, struct smb_request *req,
728 struct smb_filename *smb_dname);
729 void msg_file_was_renamed(struct messaging_context *msg,
732 struct server_id server_id,
734 struct fsp_lease *find_fsp_lease(struct files_struct *new_fsp,
735 const struct smb2_lease_key *key,
736 uint32_t current_state,
737 uint16_t lease_version,
738 uint16_t lease_epoch);
739 NTSTATUS create_file_default(connection_struct *conn,
740 struct smb_request *req,
741 struct smb_filename * smb_fname,
742 uint32_t access_mask,
743 uint32_t share_access,
744 uint32_t create_disposition,
745 uint32_t create_options,
746 uint32_t file_attributes,
747 uint32_t oplock_request,
748 const struct smb2_lease *lease,
749 uint64_t allocation_size,
750 uint32_t private_flags,
751 struct security_descriptor *sd,
752 struct ea_list *ea_list,
753 files_struct **result,
755 const struct smb2_create_blobs *in_context_blobs,
756 struct smb2_create_blobs *out_context_blobs);
758 /* The following definitions come from smbd/oplock.c */
760 uint32_t get_lease_type(struct share_mode_entry *e, struct file_id id);
762 void break_kernel_oplock(struct messaging_context *msg_ctx, files_struct *fsp);
763 NTSTATUS set_file_oplock(files_struct *fsp);
764 bool remove_oplock(files_struct *fsp);
765 bool downgrade_oplock(files_struct *fsp);
766 bool fsp_lease_update(struct files_struct *fsp);
767 NTSTATUS downgrade_lease(struct smbXsrv_client *client,
768 uint32_t num_file_ids,
769 const struct file_id *ids,
770 const struct smb2_lease_key *key,
771 uint32_t lease_state);
772 void contend_level2_oplocks_begin(files_struct *fsp,
773 enum level2_contention_type type);
774 void contend_level2_oplocks_end(files_struct *fsp,
775 enum level2_contention_type type);
776 void smbd_contend_level2_oplocks_begin(files_struct *fsp,
777 enum level2_contention_type type);
778 void smbd_contend_level2_oplocks_end(files_struct *fsp,
779 enum level2_contention_type type);
780 void share_mode_entry_to_message(char *msg, const struct file_id *id,
781 const struct share_mode_entry *e);
782 void message_to_share_mode_entry(struct file_id *id,
783 struct share_mode_entry *e,
785 bool init_oplocks(struct smbd_server_connection *sconn);
786 void init_kernel_oplocks(struct smbd_server_connection *sconn);
788 /* The following definitions come from smbd/oplock_linux.c */
790 int linux_set_lease_sighandler(int fd);
791 int linux_setlease(int fd, int leasetype);
792 struct kernel_oplocks *linux_init_kernel_oplocks(struct smbd_server_connection *sconn);
794 /* The following definitions come from smbd/password.c */
796 void invalidate_vuid(struct smbd_server_connection *sconn, uint64_t vuid);
797 int register_homes_share(const char *username);
799 /* The following definitions come from smbd/pipes.c */
801 NTSTATUS open_np_file(struct smb_request *smb_req, const char *name,
802 struct files_struct **pfsp);
804 /* The following definitions come from smbd/posix_acls.c */
806 mode_t unix_perms_to_acl_perms(mode_t mode, int r_mask, int w_mask, int x_mask);
807 int map_acl_perms_to_permset(mode_t mode, SMB_ACL_PERMSET_T *p_permset);
808 uint32_t map_canon_ace_perms(int snum,
809 enum security_ace_type *pacl_type,
812 NTSTATUS unpack_nt_owners(connection_struct *conn, uid_t *puser, gid_t *pgrp, uint32_t security_info_sent, const struct security_descriptor *psd);
813 bool current_user_in_group(connection_struct *conn, gid_t gid);
814 SMB_ACL_T free_empty_sys_acl(connection_struct *conn, SMB_ACL_T the_acl);
815 NTSTATUS posix_fget_nt_acl(struct files_struct *fsp, uint32_t security_info,
817 struct security_descriptor **ppdesc);
818 NTSTATUS try_chown(files_struct *fsp, uid_t uid, gid_t gid);
819 NTSTATUS set_nt_acl(files_struct *fsp, uint32_t security_info_sent, const struct security_descriptor *psd);
820 int get_acl_group_bits(connection_struct *conn,
821 struct files_struct *fsp,
823 int inherit_access_posix_acl(connection_struct *conn,
824 struct files_struct *inherit_from_dirfsp,
825 const struct smb_filename *smb_fname,
827 NTSTATUS set_unix_posix_default_acl(connection_struct *conn,
829 uint16_t num_def_acls, const char *pdata);
830 NTSTATUS set_unix_posix_acl(connection_struct *conn, files_struct *fsp,
833 int posix_sys_acl_blob_get_file(vfs_handle_struct *handle,
834 const struct smb_filename *smb_fname,
836 char **blob_description,
838 int posix_sys_acl_blob_get_fd(vfs_handle_struct *handle,
841 char **blob_description,
844 enum default_acl_style {DEFAULT_ACL_POSIX, DEFAULT_ACL_WINDOWS, DEFAULT_ACL_EVERYONE};
846 const struct enum_list *get_default_acl_style_list(void);
848 NTSTATUS make_default_filesystem_acl(
850 enum default_acl_style acl_style,
852 const SMB_STRUCT_STAT *psbuf,
853 struct security_descriptor **ppdesc);
855 /* The following definitions come from smbd/smb2_process.c */
857 bool smb2_srv_send(struct smbXsrv_connection *xconn, char *buffer,
858 bool no_signing, uint32_t seqnum,
860 struct smb_perfcount_data *pcd);
861 #if !defined(WITH_SMB1SERVER)
862 bool smb1_srv_send(struct smbXsrv_connection *xconn, char *buffer,
863 bool do_signing, uint32_t seqnum,
865 struct smb_perfcount_data *pcd);
867 size_t srv_smb1_set_message(char *buf,
871 NTSTATUS read_packet_remainder(int fd, char *buffer,
872 unsigned int timeout, ssize_t len);
873 NTSTATUS receive_smb_talloc(TALLOC_CTX *mem_ctx,
874 struct smbXsrv_connection *xconn,
876 char **buffer, unsigned int timeout,
877 size_t *p_unread, bool *p_encrypted,
880 bool trusted_channel);
881 void remove_deferred_open_message_smb(struct smbXsrv_connection *xconn,
883 bool schedule_deferred_open_message_smb(struct smbXsrv_connection *xconn,
885 bool open_was_deferred(struct smbXsrv_connection *xconn, uint64_t mid);
886 bool get_deferred_open_message_state(struct smb_request *smbreq,
887 struct timeval *p_request_time,
888 struct deferred_open_record **open_rec);
889 bool push_deferred_open_message_smb(struct smb_request *req,
890 struct timeval timeout,
892 struct deferred_open_record *open_rec);
893 bool create_smb1_outbuf(TALLOC_CTX *mem_ctx, struct smb_request *req,
894 const uint8_t *inbuf, char **outbuf,
895 uint8_t num_words, uint32_t num_bytes);
896 void construct_smb1_reply_common_req(struct smb_request *req, char *outbuf);
897 void reply_smb1_outbuf(struct smb_request *req, uint8_t num_words, uint32_t num_bytes);
898 void process_smb(struct smbXsrv_connection *xconn,
899 uint8_t *inbuf, size_t nread, size_t unread_bytes,
900 uint32_t seqnum, bool encrypted,
901 struct smb_perfcount_data *deferred_pcd);
902 void smbd_process(struct tevent_context *ev_ctx,
903 struct messaging_context *msg_ctx,
906 bool valid_smb1_header(const uint8_t *inbuf);
907 bool init_smb1_request(struct smb_request *req,
908 struct smbd_server_connection *sconn,
909 struct smbXsrv_connection *xconn,
910 const uint8_t *inbuf,
911 size_t unread_bytes, bool encrypted,
914 /* The following definitions come from smbd/quotas.c */
916 bool disk_quotas(connection_struct *conn, struct smb_filename *fname,
917 uint64_t *bsize, uint64_t *dfree, uint64_t *dsize);
919 /* The following definitions come from smbd/smb2_reply.c */
921 NTSTATUS check_path_syntax(char *path);
922 NTSTATUS check_path_syntax_posix(char *path);
923 size_t srvstr_get_path(TALLOC_CTX *ctx,
931 size_t srvstr_get_path_posix(TALLOC_CTX *ctx,
939 size_t srvstr_get_path_req(TALLOC_CTX *mem_ctx, struct smb_request *req,
940 char **pp_dest, const char *src, int flags,
942 size_t srvstr_pull_req_talloc(TALLOC_CTX *ctx, struct smb_request *req,
943 char **dest, const uint8_t *src, int flags);
944 bool check_fsp_open(connection_struct *conn, struct smb_request *req,
946 bool check_fsp(connection_struct *conn, struct smb_request *req,
948 bool check_fsp_ntquota_handle(connection_struct *conn, struct smb_request *req,
950 void reply_special(struct smbXsrv_connection *xconn, char *inbuf, size_t inbuf_size);
951 NTSTATUS unlink_internals(connection_struct *conn,
952 struct smb_request *req,
954 struct smb_filename *smb_fname);
955 ssize_t fake_sendfile(struct smbXsrv_connection *xconn, files_struct *fsp,
956 off_t startpos, size_t nread);
957 ssize_t sendfile_short_send(struct smbXsrv_connection *xconn,
962 NTSTATUS rename_internals_fsp(connection_struct *conn,
964 struct smb_filename *smb_fname_dst_in,
965 const char *dst_original_lcomp,
967 bool replace_if_exists);
968 NTSTATUS rename_internals(TALLOC_CTX *ctx,
969 connection_struct *conn,
970 struct smb_request *req,
971 struct smb_filename *smb_fname_src,
972 struct smb_filename *smb_fname_dst,
973 const char *dst_original_lcomp,
975 bool replace_if_exists,
976 uint32_t access_mask);
977 NTSTATUS copy_file(TALLOC_CTX *ctx,
978 connection_struct *conn,
979 struct smb_filename *smb_fname_src,
980 struct smb_filename *smb_fname_dst,
983 bool target_is_directory);
984 uint64_t get_lock_offset(const uint8_t *data, int data_offset,
985 bool large_file_format);
987 /* The following definitions come from smbd/seal.c */
989 bool is_encrypted_packet(const uint8_t *inbuf);
990 void srv_free_enc_buffer(struct smbXsrv_connection *xconn, char *buf);
991 NTSTATUS srv_decrypt_buffer(struct smbXsrv_connection *xconn, char *buf);
992 NTSTATUS srv_encrypt_buffer(struct smbXsrv_connection *xconn, char *buf,
994 NTSTATUS srv_request_encryption_setup(connection_struct *conn,
995 unsigned char **ppdata,
997 unsigned char **pparam,
998 size_t *p_param_size);
999 NTSTATUS srv_encryption_start(connection_struct *conn);
1000 void server_encryption_shutdown(struct smbXsrv_connection *xconn);
1002 /* The following definitions come from smbd/sec_ctx.c */
1004 bool unix_token_equal(const struct security_unix_token *t1, const struct security_unix_token *t2);
1005 bool push_sec_ctx(void);
1006 void set_sec_ctx(uid_t uid, gid_t gid, int ngroups, gid_t *groups, const struct security_token *token);
1007 void set_root_sec_ctx(void);
1008 bool pop_sec_ctx(void);
1009 void init_sec_ctx(void);
1010 const struct security_token *sec_ctx_active_token(void);
1012 /* The following definitions come from smbd/server.c */
1014 struct memcache *smbd_memcache(void);
1015 bool snum_is_shared_printer(int snum);
1016 void delete_and_reload_printers(void);
1017 bool reload_services(struct smbd_server_connection *sconn,
1018 bool (*snumused) (struct smbd_server_connection *, int),
1021 /* The following definitions come from smbd/server_exit.c */
1023 void smbd_exit_server(const char *reason) _NORETURN_;
1024 void smbd_exit_server_cleanly(const char *const reason) _NORETURN_;
1026 /* The following definitions come from smbd/smb2_service.c */
1028 bool set_conn_connectpath(connection_struct *conn, const char *connectpath);
1029 bool canonicalize_connect_path(connection_struct *conn);
1030 NTSTATUS set_conn_force_user_group(connection_struct *conn, int snum);
1031 void set_current_case_sensitive(connection_struct *conn, uint16_t flags);
1032 bool chdir_current_service(connection_struct *conn);
1033 void load_registry_shares(void);
1034 int add_home_service(const char *service, const char *username, const char *homedir);
1035 int find_service(TALLOC_CTX *ctx, const char *service, char **p_service_out);
1036 connection_struct *make_connection_smb2(struct smbd_smb2_request *req,
1037 struct smbXsrv_tcon *tcon,
1041 NTSTATUS make_connection_snum(struct smbXsrv_connection *xconn,
1042 connection_struct *conn,
1044 struct smbXsrv_session *session,
1046 void close_cnum(connection_struct *conn, uint64_t vuid);
1048 /* The following definitions come from smbd/session.c */
1050 struct smbXsrv_session;
1051 bool session_init(void);
1052 bool session_claim(struct smbXsrv_session *session);
1053 void session_yield(struct smbXsrv_session *session);
1054 int list_sessions(TALLOC_CTX *mem_ctx, struct sessionid **session_list);
1055 int find_sessions(TALLOC_CTX *mem_ctx, const char *username,
1056 const char *machine, struct sessionid **session_list);
1058 /* The following definitions come from smbd/share_access.c */
1060 bool token_contains_name_in_list(const char *username,
1062 const char *sharename,
1063 const struct security_token *token,
1065 bool user_ok_token(const char *username, const char *domain,
1066 const struct security_token *token, int snum);
1067 bool is_share_read_only_for_token(const char *username,
1069 const struct security_token *token,
1070 connection_struct *conn);
1072 /* The following definitions come from smbd/srvstr.c */
1074 NTSTATUS srvstr_push_fn(const char *base_ptr, uint16_t smb_flags2, void *dest,
1075 const char *src, int dest_len, int flags, size_t *ret_len);
1076 ssize_t message_push_string(uint8_t **outbuf, const char *str, int flags);
1078 /* The following definitions come from smbd/statcache.c */
1080 void stat_cache_add( const char *full_orig_name,
1081 const char *translated_path,
1083 bool case_sensitive);
1084 bool stat_cache_lookup(connection_struct *conn,
1089 SMB_STRUCT_STAT *pst);
1090 void smbd_send_stat_cache_delete_message(struct messaging_context *msg_ctx,
1092 void send_stat_cache_delete_message(struct messaging_context *msg_ctx,
1094 void stat_cache_delete(const char *name);
1095 bool reset_stat_cache( void );
1097 /* The following definitions come from smbd/statvfs.c */
1099 int sys_statvfs(const char *path, vfs_statvfs_struct *statbuf);
1101 /* The following definitions come from smbd/trans2.c */
1103 NTSTATUS refuse_symlink_fsp(const struct files_struct *fsp);
1104 NTSTATUS check_access_fsp(struct files_struct *fsp,
1105 uint32_t access_mask);
1106 uint64_t smb_roundup(connection_struct *conn, uint64_t val);
1107 bool samba_private_attr_name(const char *unix_ea_name);
1108 NTSTATUS get_ea_value_fsp(TALLOC_CTX *mem_ctx,
1110 const char *ea_name,
1111 struct ea_struct *pea);
1112 NTSTATUS get_ea_names_from_fsp(TALLOC_CTX *mem_ctx,
1115 size_t *pnum_names);
1116 NTSTATUS set_ea(connection_struct *conn, files_struct *fsp,
1117 struct ea_list *ea_list);
1118 unsigned char *create_volume_objectid(connection_struct *conn, unsigned char objid[16]);
1119 NTSTATUS hardlink_internals(TALLOC_CTX *ctx,
1120 connection_struct *conn,
1121 struct smb_request *req,
1122 bool overwrite_if_exists,
1123 const struct smb_filename *smb_fname_old,
1124 struct smb_filename *smb_fname_new);
1125 NTSTATUS smb_set_file_time(connection_struct *conn,
1127 struct smb_filename *smb_fname,
1128 struct smb_file_time *ft,
1129 bool setting_write_time);
1138 NTSTATUS unix_perms_from_wire(connection_struct *conn,
1139 const SMB_STRUCT_STAT *psbuf,
1141 enum perm_type ptype,
1143 struct ea_list *read_ea_list(TALLOC_CTX *ctx, const char *pdata,
1145 unsigned int estimate_ea_size(files_struct *fsp);
1146 NTSTATUS smb_set_fsquota(connection_struct *conn,
1147 struct smb_request *req,
1149 const DATA_BLOB *qdata);
1151 /* The following definitions come from smbd/uid.c */
1153 bool change_to_guest(void);
1154 NTSTATUS check_user_share_access(connection_struct *conn,
1155 const struct auth_session_info *session_info,
1156 uint32_t *p_share_access,
1157 bool *p_readonly_share);
1158 bool change_to_user_and_service(connection_struct *conn, uint64_t vuid);
1159 bool change_to_user_and_service_by_fsp(struct files_struct *fsp);
1160 bool smbd_change_to_root_user(void);
1161 bool smbd_become_authenticated_pipe_user(struct auth_session_info *session_info);
1162 bool smbd_unbecome_authenticated_pipe_user(void);
1163 void become_root(void);
1164 void unbecome_root(void);
1165 void smbd_become_root(void);
1166 void smbd_unbecome_root(void);
1167 bool become_user_without_service(connection_struct *conn, uint64_t vuid);
1168 bool become_user_without_service_by_fsp(struct files_struct *fsp);
1169 bool become_user_without_service_by_session(connection_struct *conn,
1170 const struct auth_session_info *session_info);
1171 bool unbecome_user_without_service(void);
1172 uid_t get_current_uid(connection_struct *conn);
1173 gid_t get_current_gid(connection_struct *conn);
1174 const struct security_unix_token *get_current_utok(connection_struct *conn);
1175 const struct security_token *get_current_nttok(connection_struct *conn);
1177 /* The following definitions come from smbd/utmp.c */
1179 void sys_utmp_claim(const char *username, const char *hostname,
1180 const char *id_str, int id_num);
1181 void sys_utmp_yield(const char *username, const char *hostname,
1182 const char *id_str, int id_num);
1184 /* The following definitions come from smbd/vfs.c */
1186 bool vfs_init_custom(connection_struct *conn, const char *vfs_object);
1187 bool smbd_vfs_init(connection_struct *conn);
1188 NTSTATUS vfs_file_exist(connection_struct *conn, struct smb_filename *smb_fname);
1189 bool vfs_valid_pread_range(off_t offset, size_t length);
1190 bool vfs_valid_pwrite_range(off_t offset, size_t length);
1191 ssize_t vfs_pwrite_data(struct smb_request *req,
1196 int vfs_allocate_file_space(files_struct *fsp, uint64_t len);
1197 int vfs_set_filelen(files_struct *fsp, off_t len);
1198 int vfs_slow_fallocate(files_struct *fsp, off_t offset, off_t len);
1199 int vfs_fill_sparse(files_struct *fsp, off_t len);
1200 int vfs_set_blocking(files_struct *fsp, bool set);
1201 off_t vfs_transfer_file(files_struct *in, files_struct *out, off_t n);
1202 const char *vfs_readdirname(connection_struct *conn,
1203 struct files_struct *dirfsp,
1205 SMB_STRUCT_STAT *sbuf,
1207 int vfs_ChDir(connection_struct *conn,
1208 const struct smb_filename *smb_fname);
1209 struct smb_filename *vfs_GetWd(TALLOC_CTX *ctx, connection_struct *conn);
1210 NTSTATUS check_reduced_name(connection_struct *conn,
1211 const struct smb_filename *cwd_fname,
1212 const struct smb_filename *smb_fname);
1213 int vfs_stat(struct connection_struct *conn,
1214 struct smb_filename *smb_fname);
1215 int vfs_stat_smb_basename(struct connection_struct *conn,
1216 const struct smb_filename *smb_fname_in,
1217 SMB_STRUCT_STAT *psbuf);
1218 NTSTATUS vfs_stat_fsp(files_struct *fsp);
1219 NTSTATUS vfs_fstreaminfo(struct files_struct *fsp,
1220 TALLOC_CTX *mem_ctx,
1221 unsigned int *num_streams,
1222 struct stream_struct **streams);
1223 void init_smb_file_time(struct smb_file_time *ft);
1224 int vfs_fake_fd(void);
1225 int vfs_fake_fd_close(int fd);
1227 /* The following definitions come from smbd/avahi_register.c */
1229 void *avahi_start_register(TALLOC_CTX *mem_ctx, struct tevent_context *ev,
1232 /* The following definitions come from smbd/smb2_create.c */
1234 NTSTATUS vfs_default_durable_cookie(struct files_struct *fsp,
1235 TALLOC_CTX *mem_ctx,
1236 DATA_BLOB *cookie_blob);
1237 NTSTATUS vfs_default_durable_disconnect(struct files_struct *fsp,
1238 const DATA_BLOB old_cookie,
1239 TALLOC_CTX *mem_ctx,
1240 DATA_BLOB *new_cookie);
1241 NTSTATUS vfs_default_durable_reconnect(struct connection_struct *conn,
1242 struct smb_request *smb1req,
1243 struct smbXsrv_open *op,
1244 const DATA_BLOB old_cookie,
1245 TALLOC_CTX *mem_ctx,
1246 files_struct **result,
1247 DATA_BLOB *new_cookie);
1249 /* The following definitions come from smbd/smb2_posix.c */
1250 DATA_BLOB smb2_posix_cc_info(TALLOC_CTX *mem_ctx,
1251 connection_struct *conn,
1252 uint32_t reparse_tag,
1253 const SMB_STRUCT_STAT *psbuf);
1254 DATA_BLOB store_smb2_posix_info(TALLOC_CTX *mem_ctx,
1255 connection_struct *conn,
1256 const SMB_STRUCT_STAT *psbuf,
1257 uint32_t reparse_tag,
1258 uint32_t dos_attributes);
1260 #endif /* _SMBD_PROTO_H_ */