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 const char *ReadDirName(struct smb_Dir *dir_hnd, long *poffset,
231 SMB_STRUCT_STAT *sbuf, char **talloced);
232 void RewindDir(struct smb_Dir *dir_hnd, long *poffset);
233 void SeekDir(struct smb_Dir *dirp, long offset);
234 long TellDir(struct smb_Dir *dirp);
235 NTSTATUS can_delete_directory(struct connection_struct *conn,
236 const char *dirname);
237 bool have_file_open_below(connection_struct *conn,
238 const struct smb_filename *name);
240 /* The following definitions come from smbd/dmapi.c */
242 const void *dmapi_get_current_session(void);
243 bool dmapi_have_session(void);
244 bool dmapi_new_session(void);
245 bool dmapi_destroy_session(void);
246 uint32_t dmapi_file_flags(const char * const path);
248 /* The following definitions come from smbd/dnsregister.c */
250 bool smbd_setup_mdns_registration(struct tevent_context *ev,
254 /* The following definitions come from smbd/dosmode.c */
256 mode_t unix_mode(connection_struct *conn, int dosmode,
257 const struct smb_filename *smb_fname,
258 struct files_struct *parent_dirfsp);
259 uint32_t dos_mode_msdfs(connection_struct *conn,
260 const struct smb_filename *smb_fname);
261 uint32_t fdos_mode(struct files_struct *fsp);
262 struct tevent_req *dos_mode_at_send(TALLOC_CTX *mem_ctx,
263 struct tevent_context *ev,
264 files_struct *dir_fsp,
265 struct smb_filename *smb_fname);
266 NTSTATUS dos_mode_at_recv(struct tevent_req *req, uint32_t *dosmode);
267 int file_set_dosmode(connection_struct *conn,
268 struct smb_filename *smb_fname,
270 struct smb_filename *parent_dir,
272 NTSTATUS file_set_sparse(connection_struct *conn,
273 struct files_struct *fsp,
275 int file_ntimes(connection_struct *conn,
277 struct smb_file_time *ft);
278 bool set_sticky_write_time_path(struct file_id fileid, struct timespec mtime);
279 bool set_sticky_write_time_fsp(struct files_struct *fsp,
280 struct timespec mtime);
282 NTSTATUS fget_ea_dos_attribute(struct files_struct *fsp,
284 NTSTATUS set_ea_dos_attribute(connection_struct *conn,
285 const struct smb_filename *smb_fname,
288 NTSTATUS set_create_timespec_ea(struct files_struct *fsp,
289 struct timespec create_time);
291 struct timespec get_create_timespec(connection_struct *conn,
292 struct files_struct *fsp,
293 const struct smb_filename *smb_fname);
295 struct timespec get_change_timespec(connection_struct *conn,
296 struct files_struct *fsp,
297 const struct smb_filename *smb_fname);
299 NTSTATUS parse_dos_attribute_blob(struct smb_filename *smb_fname,
303 /* The following definitions come from smbd/error.c */
305 bool use_nt_status(void);
306 void error_packet_set(char *outbuf, uint8_t eclass, uint32_t ecode, NTSTATUS ntstatus, int line, const char *file);
307 size_t error_packet(char *outbuf,
313 void reply_nt_error(struct smb_request *req, NTSTATUS ntstatus,
314 int line, const char *file);
315 void reply_force_dos_error(struct smb_request *req, uint8_t eclass, uint32_t ecode,
316 int line, const char *file);
317 void reply_both_error(struct smb_request *req, uint8_t eclass, uint32_t ecode,
318 NTSTATUS status, int line, const char *file);
319 void reply_openerror(struct smb_request *req, NTSTATUS status);
321 /* The following definitions come from smbd/file_access.c */
323 bool can_delete_file_in_directory(connection_struct *conn,
324 struct files_struct *dirfsp,
325 const struct smb_filename *smb_fname);
326 bool can_write_to_fsp(struct files_struct *fsp);
327 bool directory_has_default_acl_fsp(struct files_struct *fsp);
328 NTSTATUS can_set_delete_on_close(files_struct *fsp, uint32_t dosmode);
330 /* The following definitions come from smbd/fileio.c */
332 ssize_t read_file(files_struct *fsp,char *data,off_t pos,size_t n);
333 void fsp_flush_write_time_update(struct files_struct *fsp);
334 void trigger_write_time_update(struct files_struct *fsp);
335 void trigger_write_time_update_immediate(struct files_struct *fsp);
336 void mark_file_modified(files_struct *fsp);
337 ssize_t write_file(struct smb_request *req,
342 NTSTATUS sync_file(connection_struct *conn, files_struct *fsp, bool write_through);
344 /* The following definitions come from smbd/filename.c */
346 uint32_t ucf_flags_from_smb_request(struct smb_request *req);
347 uint32_t filename_create_ucf_flags(struct smb_request *req, uint32_t create_disposition);
348 NTSTATUS unix_convert(TALLOC_CTX *ctx,
349 connection_struct *conn,
350 const char *orig_path,
352 struct smb_filename **smb_fname,
354 NTSTATUS canonicalize_snapshot_path(struct smb_filename *smb_fname,
357 NTSTATUS get_real_filename_full_scan(connection_struct *conn,
363 char *get_original_lcomp(TALLOC_CTX *ctx,
364 connection_struct *conn,
365 const char *filename_in,
367 NTSTATUS filename_convert(TALLOC_CTX *mem_ctx,
368 connection_struct *conn,
372 struct smb_filename **pp_smb_fname);
373 NTSTATUS filename_convert_smb1_search_path(TALLOC_CTX *ctx,
374 connection_struct *conn,
377 struct smb_filename **_smb_fname_out,
380 /* The following definitions come from smbd/files.c */
382 NTSTATUS fsp_new(struct connection_struct *conn, TALLOC_CTX *mem_ctx,
383 files_struct **result);
384 void fsp_set_gen_id(files_struct *fsp);
385 NTSTATUS file_new(struct smb_request *req, connection_struct *conn,
386 files_struct **result);
387 NTSTATUS fsp_bind_smb(struct files_struct *fsp, struct smb_request *req);
388 void file_close_conn(connection_struct *conn);
389 bool file_init_global(void);
390 bool file_init(struct smbd_server_connection *sconn);
391 void file_close_user(struct smbd_server_connection *sconn, uint64_t vuid);
392 struct files_struct *files_forall(
393 struct smbd_server_connection *sconn,
394 struct files_struct *(*fn)(struct files_struct *fsp,
397 files_struct *file_find_fd(struct smbd_server_connection *sconn, int fd);
398 files_struct *file_find_dif(struct smbd_server_connection *sconn,
399 struct file_id id, unsigned long gen_id);
400 files_struct *file_find_di_first(struct smbd_server_connection *sconn,
403 files_struct *file_find_di_next(files_struct *start_fsp,
405 struct files_struct *file_find_one_fsp_from_lease_key(
406 struct smbd_server_connection *sconn,
407 const struct smb2_lease_key *lease_key);
408 bool file_find_subpath(files_struct *dir_fsp);
409 void fsp_unbind_smb(struct smb_request *req, files_struct *fsp);
410 void file_free(struct smb_request *req, files_struct *fsp);
411 files_struct *file_fsp(struct smb_request *req, uint16_t fid);
412 struct files_struct *file_fsp_get(struct smbd_smb2_request *smb2req,
413 uint64_t persistent_id,
414 uint64_t volatile_id);
415 struct files_struct *file_fsp_smb2(struct smbd_smb2_request *smb2req,
416 uint64_t persistent_id,
417 uint64_t volatile_id);
418 NTSTATUS dup_file_fsp(
419 struct smb_request *req,
421 uint32_t access_mask,
422 uint32_t create_options,
424 NTSTATUS file_name_hash(connection_struct *conn,
425 const char *name, uint32_t *p_name_hash);
426 NTSTATUS fsp_set_smb_fname(struct files_struct *fsp,
427 const struct smb_filename *smb_fname_in);
428 size_t fsp_fullbasepath(struct files_struct *fsp, char *buf, size_t buflen);
429 void fsp_set_base_fsp(struct files_struct *fsp, struct files_struct *base_fsp);
430 bool fsp_is_alternate_stream(const struct files_struct *fsp);
431 struct files_struct *metadata_fsp(struct files_struct *fsp);
433 NTSTATUS create_internal_fsp(connection_struct *conn,
434 const struct smb_filename *smb_fname,
435 struct files_struct **_fsp);
436 NTSTATUS create_internal_dirfsp(connection_struct *conn,
437 const struct smb_filename *smb_dname,
438 struct files_struct **_fsp);
440 NTSTATUS open_internal_dirfsp(connection_struct *conn,
441 const struct smb_filename *smb_dname,
443 struct files_struct **_fsp);
445 NTSTATUS openat_pathref_fsp(const struct files_struct *dirfsp,
446 struct smb_filename *smb_fname);
448 void smb_fname_fsp_unlink(struct smb_filename *smb_fname);
450 NTSTATUS move_smb_fname_fsp_link(struct smb_filename *smb_fname_dst,
451 struct smb_filename *smb_fname_src);
453 NTSTATUS synthetic_pathref(TALLOC_CTX *mem_ctx,
454 struct files_struct *dirfsp,
455 const char *base_name,
456 const char *stream_name,
457 const SMB_STRUCT_STAT *psbuf,
460 struct smb_filename **_smb_fname);
462 NTSTATUS parent_pathref(TALLOC_CTX *mem_ctx,
463 struct files_struct *dirfsp,
464 const struct smb_filename *smb_fname,
465 struct smb_filename **_parent,
466 struct smb_filename **_atname);
468 /* The following definitions come from smbd/smb2_ipc.c */
470 NTSTATUS nt_status_np_pipe(NTSTATUS status);
472 /* The following definitions come from smbd/mangle.c */
474 void mangle_reset_cache(void);
475 void mangle_change_to_posix(void);
476 bool mangle_is_mangled(const char *s, const struct share_params *p);
477 bool mangle_is_8_3(const char *fname, bool check_case,
478 const struct share_params *p);
479 bool mangle_is_8_3_wildcards(const char *fname, bool check_case,
480 const struct share_params *p);
481 bool mangle_must_mangle(const char *fname,
482 const struct share_params *p);
483 bool mangle_lookup_name_from_8_3(TALLOC_CTX *ctx,
485 char **out, /* talloced on the given context. */
486 const struct share_params *p);
487 bool name_to_8_3(const char *in,
490 const struct share_params *p);
492 /* The following definitions come from smbd/mangle_hash.c */
494 const struct mangle_fns *mangle_hash_init(void);
496 /* The following definitions come from smbd/mangle_hash2.c */
498 const struct mangle_fns *mangle_hash2_init(void);
499 const struct mangle_fns *posix_mangle_init(void);
501 /* The following definitions come from smbd/msdfs.c */
503 bool parse_msdfs_symlink(TALLOC_CTX *ctx,
504 bool shuffle_referrals,
506 struct referral **preflist,
508 bool is_msdfs_link(struct files_struct *dirfsp,
509 struct smb_filename *smb_fname);
511 NTSTATUS get_referred_path(TALLOC_CTX *ctx,
512 struct auth_session_info *session_info,
513 const char *dfs_path,
514 const struct tsocket_address *remote_address,
515 const struct tsocket_address *local_address,
516 bool allow_broken_path,
517 struct junction_map *jucn,
519 bool *self_referralp);
520 int setup_dfs_referral(connection_struct *orig_conn,
521 const char *dfs_path,
522 int max_referral_level,
523 char **ppdata, NTSTATUS *pstatus);
524 bool create_junction(TALLOC_CTX *ctx,
525 const char *dfs_path,
526 bool allow_broken_path,
527 struct junction_map *jucn);
529 char *msdfs_link_string(TALLOC_CTX *ctx,
530 const struct referral *reflist,
531 size_t referral_count);
532 bool create_msdfs_link(const struct junction_map *jucn,
533 struct auth_session_info *session_info);
534 bool remove_msdfs_link(const struct junction_map *jucn,
535 struct auth_session_info *session_info);
537 struct junction_map *enum_msdfs_links(TALLOC_CTX *ctx,
538 struct auth_session_info *session_info,
540 NTSTATUS dfs_redirect(TALLOC_CTX *ctx,
541 connection_struct *conn,
544 bool allow_broken_path,
547 struct connection_struct;
550 NTSTATUS create_conn_struct_cwd(TALLOC_CTX *mem_ctx,
551 struct tevent_context *ev,
552 struct messaging_context *msg,
553 const struct auth_session_info *session_info,
556 struct connection_struct **c);
557 struct conn_struct_tos {
558 struct connection_struct *conn;
559 struct smb_filename *oldcwd_fname;
561 NTSTATUS create_conn_struct_tos(struct messaging_context *msg,
564 const struct auth_session_info *session_info,
565 struct conn_struct_tos **_c);
566 NTSTATUS create_conn_struct_tos_cwd(struct messaging_context *msg,
569 const struct auth_session_info *session_info,
570 struct conn_struct_tos **_c);
572 /* The following definitions come from smbd/notify.c */
574 bool change_notify_fsp_has_changes(struct files_struct *fsp);
575 void change_notify_reply(struct smb_request *req,
578 struct notify_change_buf *notify_buf,
579 void (*reply_fn)(struct smb_request *req,
581 uint8_t *buf, size_t len));
582 void notify_callback(struct smbd_server_connection *sconn,
583 void *private_data, struct timespec when,
584 const struct notify_event *e);
585 NTSTATUS change_notify_create(struct files_struct *fsp,
586 uint32_t max_buffer_size,
589 NTSTATUS change_notify_add_request(struct smb_request *req,
591 uint32_t filter, bool recursive,
592 struct files_struct *fsp,
593 void (*reply_fn)(struct smb_request *req,
595 uint8_t *buf, size_t len));
596 void smbd_notify_cancel_deleted(struct messaging_context *msg,
597 void *private_data, uint32_t msg_type,
598 struct server_id server_id, DATA_BLOB *data);
599 void smbd_notifyd_restarted(struct messaging_context *msg,
600 void *private_data, uint32_t msg_type,
601 struct server_id server_id, DATA_BLOB *data);
602 bool remove_pending_change_notify_requests_by_mid(
603 struct smbd_server_connection *sconn, uint64_t mid);
604 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
606 void notify_fname(connection_struct *conn, uint32_t action, uint32_t filter,
608 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32_t filter);
609 struct sys_notify_context *sys_notify_context_create(TALLOC_CTX *mem_ctx,
610 struct tevent_context *ev);
612 /* The following definitions come from smbd/notify_inotify.c */
614 int inotify_watch(TALLOC_CTX *mem_ctx,
615 struct sys_notify_context *ctx,
618 uint32_t *subdir_filter,
619 void (*callback)(struct sys_notify_context *ctx,
621 struct notify_event *ev,
626 int fam_watch(TALLOC_CTX *mem_ctx,
627 struct sys_notify_context *ctx,
630 uint32_t *subdir_filter,
631 void (*callback)(struct sys_notify_context *ctx,
633 struct notify_event *ev,
639 /* The following definitions come from smbd/notify_internal.c */
641 struct notify_context *notify_init(
642 TALLOC_CTX *mem_ctx, struct messaging_context *msg,
643 struct smbd_server_connection *sconn,
644 void (*callback)(struct smbd_server_connection *sconn,
645 void *, struct timespec,
646 const struct notify_event *));
647 NTSTATUS notify_add(struct notify_context *ctx,
648 const char *path, uint32_t filter, uint32_t subdir_filter,
650 NTSTATUS notify_remove(struct notify_context *ctx, void *private_data,
652 void notify_trigger(struct notify_context *notify,
653 uint32_t action, uint32_t filter,
654 const char *dir, const char *path);
656 /* The following definitions come from smbd/ntquotas.c */
658 NTSTATUS vfs_get_ntquota(files_struct *fsp, enum SMB_QUOTA_TYPE qtype,
659 struct dom_sid *psid, SMB_NTQUOTA_STRUCT *qt);
660 int vfs_set_ntquota(files_struct *fsp, enum SMB_QUOTA_TYPE qtype, struct dom_sid *psid, SMB_NTQUOTA_STRUCT *qt);
661 int vfs_get_user_ntquota_list(files_struct *fsp, SMB_NTQUOTA_LIST **qt_list);
662 void *init_quota_handle(TALLOC_CTX *mem_ctx);
664 /* The following definitions come from smbd/smb2_nttrans.c */
666 NTSTATUS set_sd(files_struct *fsp, struct security_descriptor *psd,
667 uint32_t security_info_sent);
668 NTSTATUS set_sd_blob(files_struct *fsp, uint8_t *data, uint32_t sd_len,
669 uint32_t security_info_sent);
670 NTSTATUS copy_internals(TALLOC_CTX *ctx,
671 connection_struct *conn,
672 struct smb_request *req,
673 struct smb_filename *smb_fname_src,
674 struct smb_filename *smb_fname_dst,
676 NTSTATUS smbd_do_query_security_desc(connection_struct *conn,
679 uint32_t security_info_wanted,
680 uint32_t max_data_count,
681 uint8_t **ppmarshalled_sd,
683 #ifdef HAVE_SYS_QUOTAS
685 struct smb2_query_quota_info;
687 NTSTATUS smbd_do_query_getinfo_quota(TALLOC_CTX *mem_ctx,
691 uint32_t sid_list_length,
692 DATA_BLOB *sidbuffer,
693 uint32_t max_data_count,
695 uint32_t *p_data_size);
698 /* The following definitions come from smbd/open.c */
700 NTSTATUS smbd_check_access_rights_fsp(struct files_struct *dirfsp,
701 struct files_struct *fsp,
703 uint32_t access_mask);
704 NTSTATUS check_parent_access_fsp(struct files_struct *fsp,
705 uint32_t access_mask);
706 NTSTATUS fd_openat(const struct files_struct *dirfsp,
707 struct smb_filename *smb_fname,
709 int flags, mode_t mode);
710 NTSTATUS fd_close(files_struct *fsp);
711 bool is_oplock_stat_open(uint32_t access_mask);
712 bool is_lease_stat_open(uint32_t access_mask);
713 NTSTATUS send_break_message(struct messaging_context *msg_ctx,
714 const struct file_id *id,
715 const struct share_mode_entry *exclusive,
717 struct deferred_open_record;
718 bool is_deferred_open_async(const struct deferred_open_record *rec);
719 bool defer_smb1_sharing_violation(struct smb_request *req);
720 NTSTATUS create_directory(connection_struct *conn, struct smb_request *req,
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 smb_filename * smb_fname,
735 uint32_t access_mask,
736 uint32_t share_access,
737 uint32_t create_disposition,
738 uint32_t create_options,
739 uint32_t file_attributes,
740 uint32_t oplock_request,
741 const struct smb2_lease *lease,
742 uint64_t allocation_size,
743 uint32_t private_flags,
744 struct security_descriptor *sd,
745 struct ea_list *ea_list,
746 files_struct **result,
748 const struct smb2_create_blobs *in_context_blobs,
749 struct smb2_create_blobs *out_context_blobs);
751 /* The following definitions come from smbd/oplock.c */
753 uint32_t get_lease_type(struct share_mode_entry *e, struct file_id id);
755 void break_kernel_oplock(struct messaging_context *msg_ctx, files_struct *fsp);
756 NTSTATUS set_file_oplock(files_struct *fsp);
757 bool remove_oplock(files_struct *fsp);
758 bool downgrade_oplock(files_struct *fsp);
759 bool fsp_lease_update(struct files_struct *fsp);
760 NTSTATUS downgrade_lease(struct smbXsrv_client *client,
761 uint32_t num_file_ids,
762 const struct file_id *ids,
763 const struct smb2_lease_key *key,
764 uint32_t lease_state);
765 void contend_level2_oplocks_begin(files_struct *fsp,
766 enum level2_contention_type type);
767 void contend_level2_oplocks_end(files_struct *fsp,
768 enum level2_contention_type type);
769 void smbd_contend_level2_oplocks_begin(files_struct *fsp,
770 enum level2_contention_type type);
771 void smbd_contend_level2_oplocks_end(files_struct *fsp,
772 enum level2_contention_type type);
773 void share_mode_entry_to_message(char *msg, const struct file_id *id,
774 const struct share_mode_entry *e);
775 void message_to_share_mode_entry(struct file_id *id,
776 struct share_mode_entry *e,
778 bool init_oplocks(struct smbd_server_connection *sconn);
779 void init_kernel_oplocks(struct smbd_server_connection *sconn);
781 /* The following definitions come from smbd/oplock_linux.c */
783 int linux_set_lease_sighandler(int fd);
784 int linux_setlease(int fd, int leasetype);
785 struct kernel_oplocks *linux_init_kernel_oplocks(struct smbd_server_connection *sconn);
787 /* The following definitions come from smbd/password.c */
789 void invalidate_vuid(struct smbd_server_connection *sconn, uint64_t vuid);
790 int register_homes_share(const char *username);
792 /* The following definitions come from smbd/pipes.c */
794 NTSTATUS open_np_file(struct smb_request *smb_req, const char *name,
795 struct files_struct **pfsp);
796 void reply_pipe_write(struct smb_request *req);
798 /* The following definitions come from smbd/posix_acls.c */
800 mode_t unix_perms_to_acl_perms(mode_t mode, int r_mask, int w_mask, int x_mask);
801 int map_acl_perms_to_permset(mode_t mode, SMB_ACL_PERMSET_T *p_permset);
802 uint32_t map_canon_ace_perms(int snum,
803 enum security_ace_type *pacl_type,
806 NTSTATUS unpack_nt_owners(connection_struct *conn, uid_t *puser, gid_t *pgrp, uint32_t security_info_sent, const struct security_descriptor *psd);
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 try_chown(files_struct *fsp, uid_t uid, gid_t gid);
813 NTSTATUS set_nt_acl(files_struct *fsp, uint32_t security_info_sent, const struct security_descriptor *psd);
814 int get_acl_group_bits(connection_struct *conn,
815 struct files_struct *fsp,
817 int inherit_access_posix_acl(connection_struct *conn,
818 struct files_struct *inherit_from_dirfsp,
819 const struct smb_filename *smb_fname,
821 NTSTATUS set_unix_posix_default_acl(connection_struct *conn,
823 uint16_t num_def_acls, const char *pdata);
824 NTSTATUS set_unix_posix_acl(connection_struct *conn, files_struct *fsp,
827 int posix_sys_acl_blob_get_file(vfs_handle_struct *handle,
828 const struct smb_filename *smb_fname,
830 char **blob_description,
832 int posix_sys_acl_blob_get_fd(vfs_handle_struct *handle,
835 char **blob_description,
838 enum default_acl_style {DEFAULT_ACL_POSIX, DEFAULT_ACL_WINDOWS, DEFAULT_ACL_EVERYONE};
840 const struct enum_list *get_default_acl_style_list(void);
842 NTSTATUS make_default_filesystem_acl(
844 enum default_acl_style acl_style,
846 const SMB_STRUCT_STAT *psbuf,
847 struct security_descriptor **ppdesc);
849 /* The following definitions come from smbd/process.c */
851 bool smb1_srv_send(struct smbXsrv_connection *xconn, char *buffer,
852 bool do_signing, uint32_t seqnum,
854 struct smb_perfcount_data *pcd);
855 void remove_deferred_open_message_smb(struct smbXsrv_connection *xconn,
857 bool schedule_deferred_open_message_smb(struct smbXsrv_connection *xconn,
859 bool open_was_deferred(struct smbXsrv_connection *xconn, uint64_t mid);
860 bool get_deferred_open_message_state(struct smb_request *smbreq,
861 struct timeval *p_request_time,
862 struct deferred_open_record **open_rec);
863 bool push_deferred_open_message_smb(struct smb_request *req,
864 struct timeval timeout,
866 struct deferred_open_record *open_rec);
867 NTSTATUS allow_new_trans(struct trans_state *list, uint64_t mid);
868 void reply_outbuf(struct smb_request *req, uint8_t num_words, uint32_t num_bytes);
869 void smb_request_done(struct smb_request *req);
870 const char *smb_fn_name(int type);
871 void add_to_common_flags2(uint32_t v);
872 void remove_from_common_flags2(uint32_t v);
873 void construct_reply_common_req(struct smb_request *req, char *outbuf);
874 bool smb1_is_chain(const uint8_t *buf);
875 bool smb1_walk_chain(const uint8_t *buf,
876 bool (*fn)(uint8_t cmd,
877 uint8_t wct, const uint16_t *vwv,
878 uint16_t num_bytes, const uint8_t *bytes,
881 unsigned smb1_chain_length(const uint8_t *buf);
882 bool smb1_parse_chain(TALLOC_CTX *mem_ctx, const uint8_t *buf,
883 struct smbXsrv_connection *xconn,
884 bool encrypted, uint32_t seqnum,
885 struct smb_request ***reqs, unsigned *num_reqs);
886 bool req_is_in_chain(const struct smb_request *req);
887 void smbd_process(struct tevent_context *ev_ctx,
888 struct messaging_context *msg_ctx,
891 bool fork_echo_handler(struct smbXsrv_connection *xconn);
893 /* The following definitions come from smbd/smb2_process.c */
895 bool srv_send_smb(struct smbXsrv_connection *xconn, char *buffer,
896 bool no_signing, uint32_t seqnum,
898 struct smb_perfcount_data *pcd);
899 size_t srv_set_message(char *buf,
903 NTSTATUS read_packet_remainder(int fd, char *buffer,
904 unsigned int timeout, ssize_t len);
906 /* The following definitions come from smbd/quotas.c */
908 bool disk_quotas(connection_struct *conn, struct smb_filename *fname,
909 uint64_t *bsize, uint64_t *dfree, uint64_t *dsize);
911 /* The following definitions come from smbd/smb2_reply.c */
913 NTSTATUS check_path_syntax(char *path);
914 NTSTATUS check_path_syntax_posix(char *path);
915 size_t srvstr_get_path(TALLOC_CTX *ctx,
923 size_t srvstr_get_path_posix(TALLOC_CTX *ctx,
931 size_t srvstr_get_path_req(TALLOC_CTX *mem_ctx, struct smb_request *req,
932 char **pp_dest, const char *src, int flags,
934 size_t srvstr_pull_req_talloc(TALLOC_CTX *ctx, struct smb_request *req,
935 char **dest, const uint8_t *src, int flags);
936 bool check_fsp_open(connection_struct *conn, struct smb_request *req,
938 bool check_fsp(connection_struct *conn, struct smb_request *req,
940 bool check_fsp_ntquota_handle(connection_struct *conn, struct smb_request *req,
942 void reply_special(struct smbXsrv_connection *xconn, char *inbuf, size_t inbuf_size);
943 NTSTATUS unlink_internals(connection_struct *conn,
944 struct smb_request *req,
946 struct smb_filename *smb_fname);
947 ssize_t fake_sendfile(struct smbXsrv_connection *xconn, files_struct *fsp,
948 off_t startpos, size_t nread);
949 ssize_t sendfile_short_send(struct smbXsrv_connection *xconn,
954 NTSTATUS rename_internals_fsp(connection_struct *conn,
956 struct smb_filename *smb_fname_dst_in,
957 const char *dst_original_lcomp,
959 bool replace_if_exists);
960 NTSTATUS rename_internals(TALLOC_CTX *ctx,
961 connection_struct *conn,
962 struct smb_request *req,
963 struct smb_filename *smb_fname_src,
964 struct smb_filename *smb_fname_dst,
965 const char *dst_original_lcomp,
967 bool replace_if_exists,
968 uint32_t access_mask);
969 NTSTATUS copy_file(TALLOC_CTX *ctx,
970 connection_struct *conn,
971 struct smb_filename *smb_fname_src,
972 struct smb_filename *smb_fname_dst,
975 bool target_is_directory);
976 uint64_t get_lock_offset(const uint8_t *data, int data_offset,
977 bool large_file_format);
979 /* The following definitions come from smbd/seal.c */
981 bool is_encrypted_packet(const uint8_t *inbuf);
982 void srv_free_enc_buffer(struct smbXsrv_connection *xconn, char *buf);
983 NTSTATUS srv_decrypt_buffer(struct smbXsrv_connection *xconn, char *buf);
984 NTSTATUS srv_encrypt_buffer(struct smbXsrv_connection *xconn, char *buf,
986 NTSTATUS srv_request_encryption_setup(connection_struct *conn,
987 unsigned char **ppdata,
989 unsigned char **pparam,
990 size_t *p_param_size);
991 NTSTATUS srv_encryption_start(connection_struct *conn);
992 void server_encryption_shutdown(struct smbXsrv_connection *xconn);
994 /* The following definitions come from smbd/sec_ctx.c */
996 bool unix_token_equal(const struct security_unix_token *t1, const struct security_unix_token *t2);
997 bool push_sec_ctx(void);
998 void set_sec_ctx(uid_t uid, gid_t gid, int ngroups, gid_t *groups, const struct security_token *token);
999 void set_root_sec_ctx(void);
1000 bool pop_sec_ctx(void);
1001 void init_sec_ctx(void);
1002 const struct security_token *sec_ctx_active_token(void);
1004 /* The following definitions come from smbd/server.c */
1006 struct memcache *smbd_memcache(void);
1007 bool snum_is_shared_printer(int snum);
1008 void delete_and_reload_printers(void);
1009 bool reload_services(struct smbd_server_connection *sconn,
1010 bool (*snumused) (struct smbd_server_connection *, int),
1013 /* The following definitions come from smbd/server_exit.c */
1015 void smbd_exit_server(const char *reason) _NORETURN_;
1016 void smbd_exit_server_cleanly(const char *const reason) _NORETURN_;
1018 /* The following definitions come from smbd/smb2_service.c */
1020 bool set_conn_connectpath(connection_struct *conn, const char *connectpath);
1021 bool canonicalize_connect_path(connection_struct *conn);
1022 NTSTATUS set_conn_force_user_group(connection_struct *conn, int snum);
1023 void set_current_case_sensitive(connection_struct *conn, uint16_t flags);
1024 bool chdir_current_service(connection_struct *conn);
1025 void load_registry_shares(void);
1026 int add_home_service(const char *service, const char *username, const char *homedir);
1027 int find_service(TALLOC_CTX *ctx, const char *service, char **p_service_out);
1028 connection_struct *make_connection_smb2(struct smbd_smb2_request *req,
1029 struct smbXsrv_tcon *tcon,
1033 NTSTATUS make_connection_snum(struct smbXsrv_connection *xconn,
1034 connection_struct *conn,
1036 struct smbXsrv_session *session,
1038 void close_cnum(connection_struct *conn, uint64_t vuid);
1040 /* The following definitions come from smbd/session.c */
1042 struct smbXsrv_session;
1043 bool session_init(void);
1044 bool session_claim(struct smbXsrv_session *session);
1045 void session_yield(struct smbXsrv_session *session);
1046 int list_sessions(TALLOC_CTX *mem_ctx, struct sessionid **session_list);
1047 int find_sessions(TALLOC_CTX *mem_ctx, const char *username,
1048 const char *machine, struct sessionid **session_list);
1050 /* The following definitions come from smbd/share_access.c */
1052 bool token_contains_name_in_list(const char *username,
1054 const char *sharename,
1055 const struct security_token *token,
1057 bool user_ok_token(const char *username, const char *domain,
1058 const struct security_token *token, int snum);
1059 bool is_share_read_only_for_token(const char *username,
1061 const struct security_token *token,
1062 connection_struct *conn);
1064 /* The following definitions come from smbd/srvstr.c */
1066 NTSTATUS srvstr_push_fn(const char *base_ptr, uint16_t smb_flags2, void *dest,
1067 const char *src, int dest_len, int flags, size_t *ret_len);
1068 ssize_t message_push_string(uint8_t **outbuf, const char *str, int flags);
1070 /* The following definitions come from smbd/statcache.c */
1072 void stat_cache_add( const char *full_orig_name,
1073 const char *translated_path,
1075 bool case_sensitive);
1076 bool stat_cache_lookup(connection_struct *conn,
1081 SMB_STRUCT_STAT *pst);
1082 void smbd_send_stat_cache_delete_message(struct messaging_context *msg_ctx,
1084 void send_stat_cache_delete_message(struct messaging_context *msg_ctx,
1086 void stat_cache_delete(const char *name);
1087 bool reset_stat_cache( void );
1089 /* The following definitions come from smbd/statvfs.c */
1091 int sys_statvfs(const char *path, vfs_statvfs_struct *statbuf);
1093 /* The following definitions come from smbd/trans2.c */
1095 NTSTATUS refuse_symlink_fsp(const struct files_struct *fsp);
1096 NTSTATUS check_access_fsp(struct files_struct *fsp,
1097 uint32_t access_mask);
1098 uint64_t smb_roundup(connection_struct *conn, uint64_t val);
1099 bool samba_private_attr_name(const char *unix_ea_name);
1100 NTSTATUS get_ea_value_fsp(TALLOC_CTX *mem_ctx,
1102 const char *ea_name,
1103 struct ea_struct *pea);
1104 NTSTATUS get_ea_names_from_fsp(TALLOC_CTX *mem_ctx,
1107 size_t *pnum_names);
1108 NTSTATUS set_ea(connection_struct *conn, files_struct *fsp,
1109 struct ea_list *ea_list);
1110 void send_trans2_replies(connection_struct *conn,
1111 struct smb_request *req,
1117 int max_data_bytes);
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);
1130 void reply_findclose(struct smb_request *req);
1131 void reply_findnclose(struct smb_request *req);
1132 void reply_trans2(struct smb_request *req);
1133 void reply_transs2(struct smb_request *req);
1142 NTSTATUS unix_perms_from_wire(connection_struct *conn,
1143 const SMB_STRUCT_STAT *psbuf,
1145 enum perm_type ptype,
1148 /* The following definitions come from smbd/uid.c */
1150 bool change_to_guest(void);
1151 NTSTATUS check_user_share_access(connection_struct *conn,
1152 const struct auth_session_info *session_info,
1153 uint32_t *p_share_access,
1154 bool *p_readonly_share);
1155 bool change_to_user_and_service(connection_struct *conn, uint64_t vuid);
1156 bool change_to_user_and_service_by_fsp(struct files_struct *fsp);
1157 bool smbd_change_to_root_user(void);
1158 bool smbd_become_authenticated_pipe_user(struct auth_session_info *session_info);
1159 bool smbd_unbecome_authenticated_pipe_user(void);
1160 void become_root(void);
1161 void unbecome_root(void);
1162 void smbd_become_root(void);
1163 void smbd_unbecome_root(void);
1164 bool become_user_without_service(connection_struct *conn, uint64_t vuid);
1165 bool become_user_without_service_by_fsp(struct files_struct *fsp);
1166 bool become_user_without_service_by_session(connection_struct *conn,
1167 const struct auth_session_info *session_info);
1168 bool unbecome_user_without_service(void);
1169 uid_t get_current_uid(connection_struct *conn);
1170 gid_t get_current_gid(connection_struct *conn);
1171 const struct security_unix_token *get_current_utok(connection_struct *conn);
1172 const struct security_token *get_current_nttok(connection_struct *conn);
1174 /* The following definitions come from smbd/utmp.c */
1176 void sys_utmp_claim(const char *username, const char *hostname,
1177 const char *id_str, int id_num);
1178 void sys_utmp_yield(const char *username, const char *hostname,
1179 const char *id_str, int id_num);
1181 /* The following definitions come from smbd/vfs.c */
1183 bool vfs_init_custom(connection_struct *conn, const char *vfs_object);
1184 bool smbd_vfs_init(connection_struct *conn);
1185 NTSTATUS vfs_file_exist(connection_struct *conn, struct smb_filename *smb_fname);
1186 bool vfs_valid_pread_range(off_t offset, size_t length);
1187 bool vfs_valid_pwrite_range(off_t offset, size_t length);
1188 ssize_t vfs_pwrite_data(struct smb_request *req,
1193 int vfs_allocate_file_space(files_struct *fsp, uint64_t len);
1194 int vfs_set_filelen(files_struct *fsp, off_t len);
1195 int vfs_slow_fallocate(files_struct *fsp, off_t offset, off_t len);
1196 int vfs_fill_sparse(files_struct *fsp, off_t len);
1197 int vfs_set_blocking(files_struct *fsp, bool set);
1198 off_t vfs_transfer_file(files_struct *in, files_struct *out, off_t n);
1199 const char *vfs_readdirname(connection_struct *conn,
1200 struct files_struct *dirfsp,
1202 SMB_STRUCT_STAT *sbuf,
1204 int vfs_ChDir(connection_struct *conn,
1205 const struct smb_filename *smb_fname);
1206 struct smb_filename *vfs_GetWd(TALLOC_CTX *ctx, connection_struct *conn);
1207 NTSTATUS check_reduced_name(connection_struct *conn,
1208 const struct smb_filename *cwd_fname,
1209 const struct smb_filename *smb_fname);
1210 int vfs_stat(struct connection_struct *conn,
1211 struct smb_filename *smb_fname);
1212 int vfs_stat_smb_basename(struct connection_struct *conn,
1213 const struct smb_filename *smb_fname_in,
1214 SMB_STRUCT_STAT *psbuf);
1215 NTSTATUS vfs_stat_fsp(files_struct *fsp);
1216 NTSTATUS vfs_fstreaminfo(struct files_struct *fsp,
1217 TALLOC_CTX *mem_ctx,
1218 unsigned int *num_streams,
1219 struct stream_struct **streams);
1220 void init_smb_file_time(struct smb_file_time *ft);
1221 int vfs_fake_fd(void);
1222 int vfs_fake_fd_close(int fd);
1224 /* The following definitions come from smbd/avahi_register.c */
1226 void *avahi_start_register(TALLOC_CTX *mem_ctx, struct tevent_context *ev,
1229 /* The following definitions come from smbd/smb2_create.c */
1231 NTSTATUS vfs_default_durable_cookie(struct files_struct *fsp,
1232 TALLOC_CTX *mem_ctx,
1233 DATA_BLOB *cookie_blob);
1234 NTSTATUS vfs_default_durable_disconnect(struct files_struct *fsp,
1235 const DATA_BLOB old_cookie,
1236 TALLOC_CTX *mem_ctx,
1237 DATA_BLOB *new_cookie);
1238 NTSTATUS vfs_default_durable_reconnect(struct connection_struct *conn,
1239 struct smb_request *smb1req,
1240 struct smbXsrv_open *op,
1241 const DATA_BLOB old_cookie,
1242 TALLOC_CTX *mem_ctx,
1243 files_struct **result,
1244 DATA_BLOB *new_cookie);
1246 /* The following definitions come from smbd/smb2_posix.c */
1247 DATA_BLOB smb2_posix_cc_info(TALLOC_CTX *mem_ctx,
1248 connection_struct *conn,
1249 uint32_t reparse_tag,
1250 const SMB_STRUCT_STAT *psbuf);
1251 DATA_BLOB store_smb2_posix_info(TALLOC_CTX *mem_ctx,
1252 connection_struct *conn,
1253 const SMB_STRUCT_STAT *psbuf,
1254 uint32_t reparse_tag,
1255 uint32_t dos_attributes);
1257 #endif /* _SMBD_PROTO_H_ */