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,
192 struct dptr_struct **dptr_ret);
193 void dptr_CloseDir(files_struct *fsp);
194 void dptr_SeekDir(struct dptr_struct *dptr, long offset);
195 void dptr_RewindDir(struct dptr_struct *dptr);
196 long dptr_TellDir(struct dptr_struct *dptr);
197 unsigned int dptr_FileNumber(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);
205 struct files_struct *dir_hnd_fetch_fsp(struct smb_Dir *dir_hnd);
206 files_struct *dptr_fetch_lanman2_fsp(struct smbd_server_connection *sconn,
209 bool is_visible_fsp(files_struct *fsp);
210 NTSTATUS OpenDir(TALLOC_CTX *mem_ctx,
211 connection_struct *conn,
212 const struct smb_filename *smb_dname,
215 struct smb_Dir **_dir_hnd);
216 NTSTATUS OpenDir_from_pathref(TALLOC_CTX *mem_ctx,
217 struct files_struct *dirfsp,
220 struct smb_Dir **_dir_hnd);
221 const char *ReadDirName(struct smb_Dir *dir_hnd, long *poffset,
222 SMB_STRUCT_STAT *sbuf, char **talloced);
223 void RewindDir(struct smb_Dir *dir_hnd, long *poffset);
224 NTSTATUS can_delete_directory(struct connection_struct *conn,
225 const char *dirname);
226 bool have_file_open_below(connection_struct *conn,
227 const struct smb_filename *name);
229 /* The following definitions come from smbd/dmapi.c */
231 const void *dmapi_get_current_session(void);
232 bool dmapi_have_session(void);
233 bool dmapi_new_session(void);
234 bool dmapi_destroy_session(void);
235 uint32_t dmapi_file_flags(const char * const path);
237 /* The following definitions come from smbd/dnsregister.c */
239 bool smbd_setup_mdns_registration(struct tevent_context *ev,
243 /* The following definitions come from smbd/dosmode.c */
245 mode_t unix_mode(connection_struct *conn, int dosmode,
246 const struct smb_filename *smb_fname,
247 struct files_struct *parent_dirfsp);
248 uint32_t dos_mode_msdfs(connection_struct *conn,
249 const struct smb_filename *smb_fname);
250 uint32_t fdos_mode(struct files_struct *fsp);
251 struct tevent_req *dos_mode_at_send(TALLOC_CTX *mem_ctx,
252 struct tevent_context *ev,
253 files_struct *dir_fsp,
254 struct smb_filename *smb_fname);
255 NTSTATUS dos_mode_at_recv(struct tevent_req *req, uint32_t *dosmode);
256 int file_set_dosmode(connection_struct *conn,
257 struct smb_filename *smb_fname,
259 struct smb_filename *parent_dir,
261 NTSTATUS file_set_sparse(connection_struct *conn,
262 struct files_struct *fsp,
264 int file_ntimes(connection_struct *conn,
266 struct smb_file_time *ft);
267 bool set_sticky_write_time_path(struct file_id fileid, struct timespec mtime);
268 bool set_sticky_write_time_fsp(struct files_struct *fsp,
269 struct timespec mtime);
271 NTSTATUS fget_ea_dos_attribute(struct files_struct *fsp,
273 NTSTATUS set_ea_dos_attribute(connection_struct *conn,
274 struct smb_filename *smb_fname,
277 NTSTATUS set_create_timespec_ea(struct files_struct *fsp,
278 struct timespec create_time);
280 struct timespec get_create_timespec(connection_struct *conn,
281 struct files_struct *fsp,
282 const struct smb_filename *smb_fname);
284 struct timespec get_change_timespec(connection_struct *conn,
285 struct files_struct *fsp,
286 const struct smb_filename *smb_fname);
288 NTSTATUS parse_dos_attribute_blob(struct smb_filename *smb_fname,
292 /* The following definitions come from smbd/error.c */
294 bool use_nt_status(void);
295 void error_packet_set(char *outbuf, uint8_t eclass, uint32_t ecode, NTSTATUS ntstatus, int line, const char *file);
296 size_t error_packet(char *outbuf,
302 void reply_nt_error(struct smb_request *req, NTSTATUS ntstatus,
303 int line, const char *file);
304 void reply_force_dos_error(struct smb_request *req, uint8_t eclass, uint32_t ecode,
305 int line, const char *file);
306 void reply_both_error(struct smb_request *req, uint8_t eclass, uint32_t ecode,
307 NTSTATUS status, int line, const char *file);
308 void reply_openerror(struct smb_request *req, NTSTATUS status);
310 /* The following definitions come from smbd/file_access.c */
312 bool can_delete_file_in_directory(connection_struct *conn,
313 struct files_struct *dirfsp,
314 const struct smb_filename *smb_fname);
315 bool can_write_to_fsp(struct files_struct *fsp);
316 bool directory_has_default_acl_fsp(struct files_struct *fsp);
317 NTSTATUS can_set_delete_on_close(files_struct *fsp, uint32_t dosmode);
319 /* The following definitions come from smbd/fileio.c */
321 ssize_t read_file(files_struct *fsp,char *data,off_t pos,size_t n);
322 void fsp_flush_write_time_update(struct files_struct *fsp);
323 void trigger_write_time_update(struct files_struct *fsp);
324 void trigger_write_time_update_immediate(struct files_struct *fsp);
325 void mark_file_modified(files_struct *fsp);
326 ssize_t write_file(struct smb_request *req,
331 NTSTATUS sync_file(connection_struct *conn, files_struct *fsp, bool write_through);
333 /* The following definitions come from smbd/filename.c */
335 uint32_t ucf_flags_from_smb_request(struct smb_request *req);
336 uint32_t filename_create_ucf_flags(struct smb_request *req, uint32_t create_disposition);
337 NTSTATUS canonicalize_snapshot_path(struct smb_filename *smb_fname,
340 NTSTATUS get_real_filename_full_scan_at(struct files_struct *dirfsp,
345 char *get_original_lcomp(TALLOC_CTX *ctx,
346 connection_struct *conn,
347 const char *filename_in,
349 NTSTATUS filename_convert_smb1_search_path(TALLOC_CTX *ctx,
350 connection_struct *conn,
353 struct files_struct **_dirfsp,
354 struct smb_filename **_smb_fname_out,
356 NTSTATUS get_real_filename_at(struct files_struct *dirfsp,
361 /* The following definitions come from smbd/files.c */
363 NTSTATUS fsp_new(struct connection_struct *conn, TALLOC_CTX *mem_ctx,
364 files_struct **result);
365 void fsp_set_gen_id(files_struct *fsp);
366 NTSTATUS file_new(struct smb_request *req, connection_struct *conn,
367 files_struct **result);
368 NTSTATUS fsp_bind_smb(struct files_struct *fsp, struct smb_request *req);
369 void file_close_conn(connection_struct *conn, enum file_close_type close_type);
370 bool file_init_global(void);
371 bool file_init(struct smbd_server_connection *sconn);
372 void file_close_user(struct smbd_server_connection *sconn, uint64_t vuid);
373 struct files_struct *files_forall(
374 struct smbd_server_connection *sconn,
375 struct files_struct *(*fn)(struct files_struct *fsp,
378 files_struct *file_find_fd(struct smbd_server_connection *sconn, int fd);
379 files_struct *file_find_dif(struct smbd_server_connection *sconn,
380 struct file_id id, unsigned long gen_id);
381 files_struct *file_find_di_first(struct smbd_server_connection *sconn,
384 files_struct *file_find_di_next(files_struct *start_fsp,
386 struct files_struct *file_find_one_fsp_from_lease_key(
387 struct smbd_server_connection *sconn,
388 const struct smb2_lease_key *lease_key);
389 bool file_find_subpath(files_struct *dir_fsp);
390 void fsp_unbind_smb(struct smb_request *req, files_struct *fsp);
391 void file_free(struct smb_request *req, files_struct *fsp);
392 files_struct *file_fsp(struct smb_request *req, uint16_t fid);
393 struct files_struct *file_fsp_get(struct smbd_smb2_request *smb2req,
394 uint64_t persistent_id,
395 uint64_t volatile_id);
396 struct files_struct *file_fsp_smb2(struct smbd_smb2_request *smb2req,
397 uint64_t persistent_id,
398 uint64_t volatile_id);
399 NTSTATUS dup_file_fsp(
401 uint32_t access_mask,
403 NTSTATUS file_name_hash(connection_struct *conn,
404 const char *name, uint32_t *p_name_hash);
405 NTSTATUS fsp_set_smb_fname(struct files_struct *fsp,
406 const struct smb_filename *smb_fname_in);
407 size_t fsp_fullbasepath(struct files_struct *fsp, char *buf, size_t buflen);
408 void fsp_set_base_fsp(struct files_struct *fsp, struct files_struct *base_fsp);
409 bool fsp_is_alternate_stream(const struct files_struct *fsp);
410 struct files_struct *metadata_fsp(struct files_struct *fsp);
411 bool fsp_search_ask_sharemode(struct files_struct *fsp);
412 bool fsp_getinfo_ask_sharemode(struct files_struct *fsp);
414 NTSTATUS create_internal_fsp(connection_struct *conn,
415 const struct smb_filename *smb_fname,
416 struct files_struct **_fsp);
417 NTSTATUS create_internal_dirfsp(connection_struct *conn,
418 const struct smb_filename *smb_dname,
419 struct files_struct **_fsp);
421 NTSTATUS open_internal_dirfsp(connection_struct *conn,
422 const struct smb_filename *smb_dname,
424 struct files_struct **_fsp);
425 NTSTATUS openat_internal_dir_from_pathref(
426 struct files_struct *dirfsp,
428 struct files_struct **_fsp);
430 NTSTATUS openat_pathref_fsp(const struct files_struct *dirfsp,
431 struct smb_filename *smb_fname);
432 NTSTATUS open_stream_pathref_fsp(
433 struct files_struct **_base_fsp,
434 struct smb_filename *smb_fname);
435 NTSTATUS openat_pathref_dirfsp_nosymlink(
437 struct connection_struct *conn,
441 struct smb_filename **_smb_fname,
444 NTSTATUS readlink_talloc(
446 struct files_struct *dirfsp,
447 struct smb_filename *smb_relname,
450 void smb_fname_fsp_unlink(struct smb_filename *smb_fname);
452 NTSTATUS move_smb_fname_fsp_link(struct smb_filename *smb_fname_dst,
453 struct smb_filename *smb_fname_src);
455 NTSTATUS reference_smb_fname_fsp_link(struct smb_filename *smb_fname_dst,
456 const struct smb_filename *smb_fname_src);
458 NTSTATUS synthetic_pathref(TALLOC_CTX *mem_ctx,
459 struct files_struct *dirfsp,
460 const char *base_name,
461 const char *stream_name,
462 const SMB_STRUCT_STAT *psbuf,
465 struct smb_filename **_smb_fname);
467 NTSTATUS parent_pathref(TALLOC_CTX *mem_ctx,
468 struct files_struct *dirfsp,
469 const struct smb_filename *smb_fname,
470 struct smb_filename **_parent,
471 struct smb_filename **_atname);
473 /* The following definitions come from smbd/smb2_ipc.c */
475 NTSTATUS nt_status_np_pipe(NTSTATUS status);
477 /* The following definitions come from smbd/mangle.c */
479 void mangle_reset_cache(void);
480 void mangle_change_to_posix(void);
481 bool mangle_is_mangled(const char *s, const struct share_params *p);
482 bool mangle_is_8_3(const char *fname, bool check_case,
483 const struct share_params *p);
484 bool mangle_is_8_3_wildcards(const char *fname, bool check_case,
485 const struct share_params *p);
486 bool mangle_must_mangle(const char *fname,
487 const struct share_params *p);
488 bool mangle_lookup_name_from_8_3(TALLOC_CTX *ctx,
490 char **out, /* talloced on the given context. */
491 const struct share_params *p);
492 bool name_to_8_3(const char *in,
495 const struct share_params *p);
497 /* The following definitions come from smbd/mangle_hash.c */
499 const struct mangle_fns *mangle_hash_init(void);
501 /* The following definitions come from smbd/mangle_hash2.c */
503 const struct mangle_fns *mangle_hash2_init(void);
504 const struct mangle_fns *posix_mangle_init(void);
506 /* The following definitions come from smbd/msdfs.c */
508 bool parse_msdfs_symlink(TALLOC_CTX *ctx,
509 bool shuffle_referrals,
511 struct referral **preflist,
513 bool is_msdfs_link(struct files_struct *dirfsp,
514 struct smb_filename *smb_fname);
516 NTSTATUS get_referred_path(TALLOC_CTX *ctx,
517 struct auth_session_info *session_info,
518 const char *dfs_path,
519 const struct tsocket_address *remote_address,
520 const struct tsocket_address *local_address,
521 struct junction_map *jucn,
522 size_t *consumedcntp,
523 bool *self_referralp);
524 int setup_dfs_referral(connection_struct *orig_conn,
525 const char *dfs_path,
526 int max_referral_level,
527 char **ppdata, NTSTATUS *pstatus);
528 bool create_junction(TALLOC_CTX *ctx,
529 const char *dfs_path,
530 struct junction_map *jucn);
532 char *msdfs_link_string(TALLOC_CTX *ctx,
533 const struct referral *reflist,
534 size_t referral_count);
535 bool create_msdfs_link(const struct junction_map *jucn,
536 struct auth_session_info *session_info);
537 bool remove_msdfs_link(const struct junction_map *jucn,
538 struct auth_session_info *session_info);
540 struct junction_map *enum_msdfs_links(TALLOC_CTX *ctx,
541 struct auth_session_info *session_info,
543 struct connection_struct;
546 NTSTATUS create_conn_struct_cwd(TALLOC_CTX *mem_ctx,
547 struct tevent_context *ev,
548 struct messaging_context *msg,
549 const struct auth_session_info *session_info,
552 struct connection_struct **c);
553 struct conn_struct_tos {
554 struct connection_struct *conn;
555 struct smb_filename *oldcwd_fname;
557 NTSTATUS create_conn_struct_tos(struct messaging_context *msg,
560 const struct auth_session_info *session_info,
561 struct conn_struct_tos **_c);
562 NTSTATUS create_conn_struct_tos_cwd(struct messaging_context *msg,
565 const struct auth_session_info *session_info,
566 struct conn_struct_tos **_c);
568 /* The following definitions come from smbd/notify.c */
570 bool change_notify_fsp_has_changes(struct files_struct *fsp);
571 void change_notify_reply(struct smb_request *req,
574 struct notify_change_buf *notify_buf,
575 void (*reply_fn)(struct smb_request *req,
577 uint8_t *buf, size_t len));
578 void notify_callback(struct smbd_server_connection *sconn,
579 void *private_data, struct timespec when,
580 const struct notify_event *e);
581 NTSTATUS change_notify_create(struct files_struct *fsp,
582 uint32_t max_buffer_size,
585 NTSTATUS change_notify_add_request(struct smb_request *req,
587 uint32_t filter, bool recursive,
588 struct files_struct *fsp,
589 void (*reply_fn)(struct smb_request *req,
591 uint8_t *buf, size_t len));
592 void smbd_notify_cancel_deleted(struct messaging_context *msg,
593 void *private_data, uint32_t msg_type,
594 struct server_id server_id, DATA_BLOB *data);
595 void smbd_notifyd_restarted(struct messaging_context *msg,
596 void *private_data, uint32_t msg_type,
597 struct server_id server_id, DATA_BLOB *data);
598 bool remove_pending_change_notify_requests_by_mid(
599 struct smbd_server_connection *sconn, uint64_t mid);
600 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
602 void notify_fname(connection_struct *conn, uint32_t action, uint32_t filter,
604 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32_t filter);
605 struct sys_notify_context *sys_notify_context_create(TALLOC_CTX *mem_ctx,
606 struct tevent_context *ev);
608 /* The following definitions come from smbd/notify_inotify.c */
610 int inotify_watch(TALLOC_CTX *mem_ctx,
611 struct sys_notify_context *ctx,
614 uint32_t *subdir_filter,
615 void (*callback)(struct sys_notify_context *ctx,
617 struct notify_event *ev,
622 int fam_watch(TALLOC_CTX *mem_ctx,
623 struct sys_notify_context *ctx,
626 uint32_t *subdir_filter,
627 void (*callback)(struct sys_notify_context *ctx,
629 struct notify_event *ev,
635 /* The following definitions come from smbd/notify_internal.c */
637 struct notify_context *notify_init(
638 TALLOC_CTX *mem_ctx, struct messaging_context *msg,
639 struct smbd_server_connection *sconn,
640 void (*callback)(struct smbd_server_connection *sconn,
641 void *, struct timespec,
642 const struct notify_event *));
643 NTSTATUS notify_add(struct notify_context *ctx,
644 const char *path, uint32_t filter, uint32_t subdir_filter,
646 NTSTATUS notify_remove(struct notify_context *ctx, void *private_data,
648 void notify_trigger(struct notify_context *notify,
649 uint32_t action, uint32_t filter,
650 const char *dir, const char *path);
652 /* The following definitions come from smbd/ntquotas.c */
654 NTSTATUS vfs_get_ntquota(files_struct *fsp, enum SMB_QUOTA_TYPE qtype,
655 struct dom_sid *psid, SMB_NTQUOTA_STRUCT *qt);
656 int vfs_set_ntquota(files_struct *fsp, enum SMB_QUOTA_TYPE qtype, struct dom_sid *psid, SMB_NTQUOTA_STRUCT *qt);
657 int vfs_get_user_ntquota_list(files_struct *fsp, SMB_NTQUOTA_LIST **qt_list);
658 void *init_quota_handle(TALLOC_CTX *mem_ctx);
660 /* The following definitions come from smbd/smb2_nttrans.c */
662 NTSTATUS set_sd(files_struct *fsp, struct security_descriptor *psd,
663 uint32_t security_info_sent);
664 NTSTATUS set_sd_blob(files_struct *fsp, uint8_t *data, uint32_t sd_len,
665 uint32_t security_info_sent);
666 NTSTATUS copy_internals(TALLOC_CTX *ctx,
667 connection_struct *conn,
668 struct smb_request *req,
669 struct files_struct *src_dirfsp,
670 struct smb_filename *smb_fname_src,
671 struct files_struct *dst_dirfsp,
672 struct smb_filename *smb_fname_dst,
674 NTSTATUS smbd_do_query_security_desc(connection_struct *conn,
677 uint32_t security_info_wanted,
678 uint32_t max_data_count,
679 uint8_t **ppmarshalled_sd,
681 #ifdef HAVE_SYS_QUOTAS
683 struct smb2_query_quota_info;
685 NTSTATUS smbd_do_query_getinfo_quota(TALLOC_CTX *mem_ctx,
689 uint32_t sid_list_length,
690 DATA_BLOB *sidbuffer,
691 uint32_t max_data_count,
693 uint32_t *p_data_size);
696 /* The following definitions come from smbd/open.c */
698 NTSTATUS smbd_check_access_rights_fsp(struct files_struct *dirfsp,
699 struct files_struct *fsp,
701 uint32_t access_mask);
702 NTSTATUS check_parent_access_fsp(struct files_struct *fsp,
703 uint32_t access_mask);
704 NTSTATUS fd_openat(const struct files_struct *dirfsp,
705 struct smb_filename *smb_fname,
707 const struct vfs_open_how *how);
708 NTSTATUS fd_close(files_struct *fsp);
709 bool is_oplock_stat_open(uint32_t access_mask);
710 bool is_lease_stat_open(uint32_t access_mask);
711 NTSTATUS send_break_message(struct messaging_context *msg_ctx,
712 const struct file_id *id,
713 const struct share_mode_entry *exclusive,
715 struct deferred_open_record;
716 bool is_deferred_open_async(const struct deferred_open_record *rec);
717 bool defer_smb1_sharing_violation(struct smb_request *req);
718 NTSTATUS create_directory(connection_struct *conn,
719 struct smb_request *req,
720 struct files_struct *dirfsp,
721 struct smb_filename *smb_dname);
722 void msg_file_was_renamed(struct messaging_context *msg,
725 struct server_id server_id,
727 struct fsp_lease *find_fsp_lease(struct files_struct *new_fsp,
728 const struct smb2_lease_key *key,
729 uint32_t current_state,
730 uint16_t lease_version,
731 uint16_t lease_epoch);
732 NTSTATUS create_file_default(connection_struct *conn,
733 struct smb_request *req,
734 struct files_struct *dirfsp,
735 struct smb_filename * smb_fname,
736 uint32_t access_mask,
737 uint32_t share_access,
738 uint32_t create_disposition,
739 uint32_t create_options,
740 uint32_t file_attributes,
741 uint32_t oplock_request,
742 const struct smb2_lease *lease,
743 uint64_t allocation_size,
744 uint32_t private_flags,
745 struct security_descriptor *sd,
746 struct ea_list *ea_list,
747 files_struct **result,
749 const struct smb2_create_blobs *in_context_blobs,
750 struct smb2_create_blobs *out_context_blobs);
752 /* The following definitions come from smbd/oplock.c */
754 uint32_t get_lease_type(struct share_mode_entry *e, struct file_id id);
756 void break_kernel_oplock(struct messaging_context *msg_ctx, files_struct *fsp);
757 NTSTATUS set_file_oplock(files_struct *fsp);
758 void release_file_oplock(files_struct *fsp);
759 bool remove_oplock(files_struct *fsp);
760 bool downgrade_oplock(files_struct *fsp);
761 bool fsp_lease_update(struct files_struct *fsp);
762 NTSTATUS downgrade_lease(struct smbXsrv_client *client,
763 uint32_t num_file_ids,
764 const struct file_id *ids,
765 const struct smb2_lease_key *key,
766 uint32_t lease_state);
767 void contend_level2_oplocks_begin(files_struct *fsp,
768 enum level2_contention_type type);
769 void contend_level2_oplocks_end(files_struct *fsp,
770 enum level2_contention_type type);
771 void smbd_contend_level2_oplocks_begin(files_struct *fsp,
772 enum level2_contention_type type);
773 void smbd_contend_level2_oplocks_end(files_struct *fsp,
774 enum level2_contention_type type);
775 void share_mode_entry_to_message(char *msg, const struct file_id *id,
776 const struct share_mode_entry *e);
777 void message_to_share_mode_entry(struct file_id *id,
778 struct share_mode_entry *e,
780 bool init_oplocks(struct smbd_server_connection *sconn);
781 void init_kernel_oplocks(struct smbd_server_connection *sconn);
783 /* The following definitions come from smbd/oplock_linux.c */
785 int linux_set_lease_sighandler(int fd);
786 int linux_setlease(int fd, int leasetype);
787 struct kernel_oplocks *linux_init_kernel_oplocks(struct smbd_server_connection *sconn);
789 /* The following definitions come from smbd/password.c */
791 void invalidate_vuid(struct smbd_server_connection *sconn, uint64_t vuid);
792 int register_homes_share(const char *username);
794 /* The following definitions come from smbd/pipes.c */
796 NTSTATUS open_np_file(struct smb_request *smb_req, const char *name,
797 struct files_struct **pfsp);
799 /* The following definitions come from smbd/posix_acls.c */
801 mode_t unix_perms_to_acl_perms(mode_t mode, int r_mask, int w_mask, int x_mask);
802 int map_acl_perms_to_permset(mode_t mode, SMB_ACL_PERMSET_T *p_permset);
803 uint32_t map_canon_ace_perms(int snum,
804 enum security_ace_type *pacl_type,
807 bool current_user_in_group(connection_struct *conn, gid_t gid);
808 SMB_ACL_T free_empty_sys_acl(connection_struct *conn, SMB_ACL_T the_acl);
809 NTSTATUS posix_fget_nt_acl(struct files_struct *fsp, uint32_t security_info,
811 struct security_descriptor **ppdesc);
812 NTSTATUS chown_if_needed(files_struct *fsp, uint32_t security_info_sent,
813 const struct security_descriptor *psd,
815 NTSTATUS set_nt_acl(files_struct *fsp, uint32_t security_info_sent, const struct security_descriptor *psd);
816 int get_acl_group_bits(connection_struct *conn,
817 struct files_struct *fsp,
819 int inherit_access_posix_acl(connection_struct *conn,
820 struct files_struct *inherit_from_dirfsp,
821 const struct smb_filename *smb_fname,
823 NTSTATUS set_unix_posix_default_acl(connection_struct *conn,
825 uint16_t num_def_acls, const char *pdata);
826 NTSTATUS set_unix_posix_acl(connection_struct *conn, files_struct *fsp,
829 int posix_sys_acl_blob_get_file(vfs_handle_struct *handle,
830 const struct smb_filename *smb_fname,
832 char **blob_description,
834 int posix_sys_acl_blob_get_fd(vfs_handle_struct *handle,
837 char **blob_description,
840 enum default_acl_style {DEFAULT_ACL_POSIX, DEFAULT_ACL_WINDOWS, DEFAULT_ACL_EVERYONE};
842 const struct enum_list *get_default_acl_style_list(void);
844 NTSTATUS make_default_filesystem_acl(
846 enum default_acl_style acl_style,
848 const SMB_STRUCT_STAT *psbuf,
849 struct security_descriptor **ppdesc);
851 /* The following definitions come from smbd/smb2_process.c */
853 #if !defined(WITH_SMB1SERVER)
854 bool smb1_srv_send(struct smbXsrv_connection *xconn,
860 size_t srv_smb1_set_message(char *buf,
864 NTSTATUS read_packet_remainder(int fd, char *buffer,
865 unsigned int timeout, ssize_t len);
866 NTSTATUS receive_smb_talloc(TALLOC_CTX *mem_ctx,
867 struct smbXsrv_connection *xconn,
869 char **buffer, unsigned int timeout,
870 size_t *p_unread, bool *p_encrypted,
873 bool trusted_channel);
874 void remove_deferred_open_message_smb(struct smbXsrv_connection *xconn,
876 bool schedule_deferred_open_message_smb(struct smbXsrv_connection *xconn,
878 bool open_was_deferred(struct smbXsrv_connection *xconn, uint64_t mid);
879 bool get_deferred_open_message_state(struct smb_request *smbreq,
880 struct timeval *p_request_time,
881 struct deferred_open_record **open_rec);
882 bool push_deferred_open_message_smb(struct smb_request *req,
883 struct timeval timeout,
885 struct deferred_open_record *open_rec);
886 bool create_smb1_outbuf(TALLOC_CTX *mem_ctx, struct smb_request *req,
887 const uint8_t *inbuf, char **outbuf,
888 uint8_t num_words, uint32_t num_bytes);
889 void construct_smb1_reply_common_req(struct smb_request *req, char *outbuf);
890 void reply_smb1_outbuf(struct smb_request *req, uint8_t num_words, uint32_t num_bytes);
891 void process_smb(struct smbXsrv_connection *xconn,
897 void smbd_process(struct tevent_context *ev_ctx,
898 struct messaging_context *msg_ctx,
901 bool valid_smb1_header(const uint8_t *inbuf);
902 bool init_smb1_request(struct smb_request *req,
903 struct smbd_server_connection *sconn,
904 struct smbXsrv_connection *xconn,
905 const uint8_t *inbuf,
906 size_t unread_bytes, bool encrypted,
909 /* The following definitions come from smbd/quotas.c */
911 bool disk_quotas(connection_struct *conn, struct smb_filename *fname,
912 uint64_t *bsize, uint64_t *dfree, uint64_t *dsize);
914 /* The following definitions come from smbd/smb2_reply.c */
916 NTSTATUS check_path_syntax(char *path, bool posix);
917 NTSTATUS smb1_strip_dfs_path(TALLOC_CTX *mem_ctx,
920 NTSTATUS smb2_strip_dfs_path(const char *in_path, const char **out_path);
921 size_t srvstr_get_path(TALLOC_CTX *ctx,
929 size_t srvstr_get_path_posix(TALLOC_CTX *ctx,
937 size_t srvstr_get_path_req(TALLOC_CTX *mem_ctx, struct smb_request *req,
938 char **pp_dest, const char *src, int flags,
940 size_t srvstr_pull_req_talloc(TALLOC_CTX *ctx, struct smb_request *req,
941 char **dest, const uint8_t *src, int flags);
942 bool check_fsp_open(connection_struct *conn, struct smb_request *req,
944 bool check_fsp(connection_struct *conn, struct smb_request *req,
946 bool check_fsp_ntquota_handle(connection_struct *conn, struct smb_request *req,
948 void reply_special(struct smbXsrv_connection *xconn, char *inbuf, size_t inbuf_size);
949 NTSTATUS unlink_internals(connection_struct *conn,
950 struct smb_request *req,
952 struct files_struct *dirfsp,
953 struct smb_filename *smb_fname);
954 ssize_t fake_sendfile(struct smbXsrv_connection *xconn, files_struct *fsp,
955 off_t startpos, size_t nread);
956 ssize_t sendfile_short_send(struct smbXsrv_connection *xconn,
961 NTSTATUS rename_internals_fsp(connection_struct *conn,
963 struct files_struct *dst_dirfsp,
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 files_struct *src_dirfsp,
972 struct smb_filename *smb_fname_src,
973 struct files_struct *dst_dirfsp,
974 struct smb_filename *smb_fname_dst,
975 const char *dst_original_lcomp,
977 bool replace_if_exists,
978 uint32_t access_mask);
979 NTSTATUS copy_file(TALLOC_CTX *ctx,
980 connection_struct *conn,
981 struct smb_filename *smb_fname_src,
982 struct smb_filename *smb_fname_dst,
983 uint32_t new_create_disposition);
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 bool chdir_current_service(connection_struct *conn);
1032 void load_registry_shares(void);
1033 int add_home_service(const char *service, const char *username, const char *homedir);
1034 int find_service(TALLOC_CTX *ctx, const char *service, char **p_service_out);
1035 connection_struct *make_connection_smb2(struct smbd_smb2_request *req,
1036 struct smbXsrv_tcon *tcon,
1040 NTSTATUS make_connection_snum(struct smbXsrv_connection *xconn,
1041 connection_struct *conn,
1043 struct smbXsrv_session *session,
1045 void close_cnum(connection_struct *conn,
1047 enum file_close_type close_type);
1049 /* The following definitions come from smbd/session.c */
1051 struct smbXsrv_session;
1052 bool session_init(void);
1053 bool session_claim(struct smbXsrv_session *session);
1054 void session_yield(struct smbXsrv_session *session);
1055 int list_sessions(TALLOC_CTX *mem_ctx, struct sessionid **session_list);
1056 int find_sessions(TALLOC_CTX *mem_ctx, const char *username,
1057 const char *machine, struct sessionid **session_list);
1059 /* The following definitions come from smbd/share_access.c */
1061 bool token_contains_name_in_list(const char *username,
1063 const char *sharename,
1064 const struct security_token *token,
1066 bool user_ok_token(const char *username, const char *domain,
1067 const struct security_token *token, int snum);
1068 bool is_share_read_only_for_token(const char *username,
1070 const struct security_token *token,
1071 connection_struct *conn);
1073 /* The following definitions come from smbd/srvstr.c */
1075 NTSTATUS srvstr_push_fn(const char *base_ptr, uint16_t smb_flags2, void *dest,
1076 const char *src, int dest_len, int flags, size_t *ret_len);
1078 /* The following definitions come from smbd/statvfs.c */
1080 int sys_statvfs(const char *path, struct vfs_statvfs_struct *statbuf);
1082 /* The following definitions come from smbd/trans2.c */
1084 char *store_file_unix_basic(connection_struct *conn,
1087 const SMB_STRUCT_STAT *psbuf);
1088 char *store_file_unix_basic_info2(connection_struct *conn,
1091 const SMB_STRUCT_STAT *psbuf);
1092 NTSTATUS smb_set_file_disposition_info(connection_struct *conn,
1096 struct smb_filename *smb_fname);
1097 NTSTATUS refuse_symlink_fsp(const struct files_struct *fsp);
1098 NTSTATUS check_access_fsp(struct files_struct *fsp,
1099 uint32_t access_mask);
1100 uint64_t smb_roundup(connection_struct *conn, uint64_t val);
1101 bool samba_private_attr_name(const char *unix_ea_name);
1102 NTSTATUS get_ea_value_fsp(TALLOC_CTX *mem_ctx,
1104 const char *ea_name,
1105 struct ea_struct *pea);
1106 NTSTATUS get_ea_names_from_fsp(TALLOC_CTX *mem_ctx,
1109 size_t *pnum_names);
1110 NTSTATUS set_ea(connection_struct *conn, files_struct *fsp,
1111 struct ea_list *ea_list);
1112 unsigned char *create_volume_objectid(connection_struct *conn, unsigned char objid[16]);
1113 NTSTATUS hardlink_internals(TALLOC_CTX *ctx,
1114 connection_struct *conn,
1115 struct smb_request *req,
1116 bool overwrite_if_exists,
1117 struct files_struct *old_dirfsp,
1118 const struct smb_filename *smb_fname_old,
1119 struct files_struct *new_dirfsp,
1120 struct smb_filename *smb_fname_new);
1121 NTSTATUS smb_set_file_time(connection_struct *conn,
1123 struct smb_filename *smb_fname,
1124 struct smb_file_time *ft,
1125 bool setting_write_time);
1126 NTSTATUS smb_set_file_size(connection_struct *conn,
1127 struct smb_request *req,
1129 struct smb_filename *smb_fname,
1130 const SMB_STRUCT_STAT *psbuf,
1132 bool fail_after_createfile);
1134 bool map_info2_flags_to_sbuf(const SMB_STRUCT_STAT *psbuf,
1135 const uint32_t smb_fflags,
1136 const uint32_t smb_fmask,
1146 NTSTATUS unix_perms_from_wire(connection_struct *conn,
1147 const SMB_STRUCT_STAT *psbuf,
1149 enum perm_type ptype,
1151 struct ea_list *read_ea_list(TALLOC_CTX *ctx, const char *pdata,
1153 unsigned int estimate_ea_size(files_struct *fsp);
1154 NTSTATUS smb_set_fsquota(connection_struct *conn,
1155 struct smb_request *req,
1157 const DATA_BLOB *qdata);
1159 /* The following definitions come from smbd/uid.c */
1161 bool change_to_guest(void);
1162 NTSTATUS check_user_share_access(connection_struct *conn,
1163 const struct auth_session_info *session_info,
1164 uint32_t *p_share_access,
1165 bool *p_readonly_share);
1166 bool change_to_user_and_service(connection_struct *conn, uint64_t vuid);
1167 bool change_to_user_and_service_by_fsp(struct files_struct *fsp);
1168 bool smbd_change_to_root_user(void);
1169 bool smbd_become_authenticated_pipe_user(struct auth_session_info *session_info);
1170 bool smbd_unbecome_authenticated_pipe_user(void);
1171 void become_root(void);
1172 void unbecome_root(void);
1173 void smbd_become_root(void);
1174 void smbd_unbecome_root(void);
1175 bool become_user_without_service(connection_struct *conn, uint64_t vuid);
1176 bool become_user_without_service_by_fsp(struct files_struct *fsp);
1177 bool become_user_without_service_by_session(connection_struct *conn,
1178 const struct auth_session_info *session_info);
1179 bool unbecome_user_without_service(void);
1180 uid_t get_current_uid(connection_struct *conn);
1181 gid_t get_current_gid(connection_struct *conn);
1182 const struct security_unix_token *get_current_utok(connection_struct *conn);
1183 const struct security_token *get_current_nttok(connection_struct *conn);
1185 /* The following definitions come from smbd/utmp.c */
1187 void sys_utmp_claim(const char *username, const char *hostname,
1188 const char *id_str, int id_num);
1189 void sys_utmp_yield(const char *username, const char *hostname,
1190 const char *id_str, int id_num);
1192 /* The following definitions come from smbd/vfs.c */
1194 bool vfs_init_custom(connection_struct *conn, const char *vfs_object);
1195 bool smbd_vfs_init(connection_struct *conn);
1196 NTSTATUS vfs_file_exist(connection_struct *conn, struct smb_filename *smb_fname);
1197 bool vfs_valid_pread_range(off_t offset, size_t length);
1198 bool vfs_valid_pwrite_range(off_t offset, size_t length);
1199 ssize_t vfs_pwrite_data(struct smb_request *req,
1204 int vfs_allocate_file_space(files_struct *fsp, uint64_t len);
1205 int vfs_set_filelen(files_struct *fsp, off_t len);
1206 int vfs_slow_fallocate(files_struct *fsp, off_t offset, off_t len);
1207 int vfs_fill_sparse(files_struct *fsp, off_t len);
1208 int vfs_set_blocking(files_struct *fsp, bool set);
1209 off_t vfs_transfer_file(files_struct *in, files_struct *out, off_t n);
1210 const char *vfs_readdirname(connection_struct *conn,
1211 struct files_struct *dirfsp,
1213 SMB_STRUCT_STAT *sbuf,
1215 int vfs_ChDir(connection_struct *conn,
1216 const struct smb_filename *smb_fname);
1217 struct smb_filename *vfs_GetWd(TALLOC_CTX *ctx, connection_struct *conn);
1218 int vfs_stat(struct connection_struct *conn,
1219 struct smb_filename *smb_fname);
1220 int vfs_stat_smb_basename(struct connection_struct *conn,
1221 const struct smb_filename *smb_fname_in,
1222 SMB_STRUCT_STAT *psbuf);
1223 NTSTATUS vfs_stat_fsp(files_struct *fsp);
1224 NTSTATUS vfs_fstreaminfo(struct files_struct *fsp,
1225 TALLOC_CTX *mem_ctx,
1226 unsigned int *num_streams,
1227 struct stream_struct **streams);
1228 void init_smb_file_time(struct smb_file_time *ft);
1229 int vfs_fake_fd(void);
1230 int vfs_fake_fd_close(int fd);
1232 /* The following definitions come from smbd/avahi_register.c */
1234 void *avahi_start_register(TALLOC_CTX *mem_ctx, struct tevent_context *ev,
1237 /* The following definitions come from smbd/smb2_create.c */
1239 NTSTATUS vfs_default_durable_cookie(struct files_struct *fsp,
1240 TALLOC_CTX *mem_ctx,
1241 DATA_BLOB *cookie_blob);
1242 NTSTATUS vfs_default_durable_disconnect(struct files_struct *fsp,
1243 const DATA_BLOB old_cookie,
1244 TALLOC_CTX *mem_ctx,
1245 DATA_BLOB *new_cookie);
1246 NTSTATUS vfs_default_durable_reconnect(struct connection_struct *conn,
1247 struct smb_request *smb1req,
1248 struct smbXsrv_open *op,
1249 const DATA_BLOB old_cookie,
1250 TALLOC_CTX *mem_ctx,
1251 files_struct **result,
1252 DATA_BLOB *new_cookie);
1254 /* The following definitions come from smbd/smb2_posix.c */
1255 ssize_t smb2_posix_cc_info(
1256 connection_struct *conn,
1257 uint32_t reparse_tag,
1258 const SMB_STRUCT_STAT *psbuf,
1259 const struct dom_sid *owner,
1260 const struct dom_sid *group,
1263 ssize_t store_smb2_posix_info(
1264 connection_struct *conn,
1265 const SMB_STRUCT_STAT *psbuf,
1266 uint32_t reparse_tag,
1267 uint32_t dos_attributes,
1271 #endif /* _SMBD_PROTO_H_ */