2 * Unix SMB/CIFS implementation.
3 * collected prototypes header
5 * frozen from "make proto" in May 2008
7 * Copyright (C) Michael Adam 2008
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, see <http://www.gnu.org/licenses/>.
26 #include <sys/types.h>
29 #include "lib/util/access.h"
31 /* The following definitions come from lib/adt_tree.c */
33 /* The following definitions come from lib/audit.c */
35 const char *audit_category_str(uint32_t category
);
36 const char *audit_param_str(uint32_t category
);
37 const char *audit_description_str(uint32_t category
);
38 bool get_audit_category_from_param(const char *param
, uint32_t *audit_category
);
39 const char *audit_policy_str(TALLOC_CTX
*mem_ctx
, uint32_t policy
);
41 /* The following definitions come from lib/charcnv.c */
43 void gfree_charcnv(void);
44 size_t ucs2_align(const void *base_ptr
, const void *p
, int flags
);
45 size_t push_ascii(void *dest
, const char *src
, size_t dest_len
, int flags
);
46 size_t push_ascii_fstring(void *dest
, const char *src
);
47 size_t push_ascii_nstring(void *dest
, const char *src
);
48 size_t pull_ascii(char *dest
, const void *src
, size_t dest_len
, size_t src_len
, int flags
);
49 size_t pull_ascii_fstring(char *dest
, const void *src
);
50 size_t pull_ascii_nstring(char *dest
, size_t dest_len
, const void *src
);
51 size_t push_string_check_fn(void *dest
, const char *src
,
52 size_t dest_len
, int flags
);
53 size_t push_string_base(const char *base
, uint16_t flags2
,
54 void *dest
, const char *src
,
55 size_t dest_len
, int flags
);
56 size_t pull_string_talloc(TALLOC_CTX
*ctx
,
63 size_t dos_PutUniCode(char *dst
,const char *src
, size_t len
, bool null_terminate
);
64 int rpcstr_push_talloc(TALLOC_CTX
*ctx
, smb_ucs2_t
**dest
, const char *src
);
66 /* The following definitions come from lib/dmallocmsg.c */
68 void register_dmalloc_msgs(struct messaging_context
*msg_ctx
);
70 /* The following definitions come from lib/dprintf.c */
72 void display_set_stderr(void);
74 /* The following definitions come from lib/errmap_unix.c */
76 NTSTATUS
map_nt_error_from_unix(int unix_error
);
77 int map_errno_from_nt_status(NTSTATUS status
);
79 /* The following definitions come from lib/file_id.c */
81 struct file_id
vfs_file_id_from_sbuf(connection_struct
*conn
, const SMB_STRUCT_STAT
*sbuf
);
83 /* The following definitions come from lib/interface.c */
85 bool ismyaddr(const struct sockaddr
*ip
);
86 bool ismyip_v4(struct in_addr ip
);
87 bool is_local_net(const struct sockaddr
*from
);
88 void setup_linklocal_scope_id(struct sockaddr
*pss
);
89 bool is_local_net_v4(struct in_addr from
);
90 int iface_count(void);
91 int iface_count_v4_nl(void);
92 const struct in_addr
*first_ipv4_iface(void);
93 struct interface
*get_interface(int n
);
94 const struct sockaddr_storage
*iface_n_sockaddr_storage(int n
);
95 const struct in_addr
*iface_n_ip_v4(int n
);
96 const struct in_addr
*iface_n_bcast_v4(int n
);
97 const struct sockaddr_storage
*iface_n_bcast(int n
);
98 const struct sockaddr_storage
*iface_ip(const struct sockaddr
*ip
);
99 bool iface_local(const struct sockaddr
*ip
);
100 void load_interfaces(void);
101 void gfree_interfaces(void);
102 bool interfaces_changed(void);
104 /* The following definitions come from lib/ldap_debug_handler.c */
106 void init_ldap_debugging(void);
108 /* The following definitions come from lib/ldap_escape.c */
110 char *escape_ldap_string(TALLOC_CTX
*mem_ctx
, const char *s
);
111 char *escape_rdn_val_string_alloc(const char *s
);
113 /* The following definitions come from lib/ms_fnmatch.c */
115 int ms_fnmatch(const char *pattern
, const char *string
, bool translate_pattern
,
116 bool is_case_sensitive
);
118 /* The following definitions come from lib/recvfile.c */
120 ssize_t
sys_recvfile(int fromfd
,
124 ssize_t
sys_recvfile(int fromfd
,
128 ssize_t
drain_socket(int sockfd
, size_t count
);
130 /* The following definitions come from lib/sendfile.c */
132 ssize_t
sys_sendfile(int tofd
, int fromfd
, const DATA_BLOB
*header
, off_t offset
, size_t count
);
134 /* The following definitions come from lib/server_mutex.c */
136 struct named_mutex
*grab_named_mutex(TALLOC_CTX
*mem_ctx
, const char *name
,
139 /* The following definitions come from lib/sharesec.c */
141 bool share_info_db_init(void);
142 struct security_descriptor
*get_share_security_default( TALLOC_CTX
*ctx
, size_t *psize
, uint32_t def_access
);
143 struct security_descriptor
*get_share_security( TALLOC_CTX
*ctx
, const char *servicename
,
145 bool set_share_security(const char *share_name
, struct security_descriptor
*psd
);
146 bool delete_share_security(const char *servicename
);
147 bool share_access_check(const struct security_token
*token
,
148 const char *sharename
,
149 uint32_t desired_access
,
151 bool parse_usershare_acl(TALLOC_CTX
*ctx
, const char *acl_str
, struct security_descriptor
**ppsd
);
153 /* The following definitions come from lib/smbrun.c */
155 int smbrun_no_sanitize(const char *cmd
, int *outfd
, char * const *env
);
156 int smbrun(const char *cmd
, int *outfd
, char * const *env
);
157 int smbrunsecret(const char *cmd
, const char *secret
);
159 /* The following definitions come from lib/substitute.c */
161 void free_local_machine_name(void);
162 bool set_local_machine_name(const char *local_name
, bool perm
);
163 const char *get_local_machine_name(void);
164 bool set_remote_machine_name(const char *remote_name
, bool perm
);
165 const char *get_remote_machine_name(void);
166 void sub_set_smb_name(const char *name
);
167 void set_current_user_info(const char *smb_name
, const char *unix_name
,
169 void sub_set_socket_ids(const char *peeraddr
, const char *peername
,
170 const char *sockaddr
);
171 const char *get_current_username(void);
172 void standard_sub_basic(const char *smb_name
, const char *domain_name
,
173 char *str
, size_t len
);
174 char *talloc_sub_basic(TALLOC_CTX
*mem_ctx
, const char *smb_name
,
175 const char *domain_name
, const char *str
);
176 char *talloc_sub_specified(TALLOC_CTX
*mem_ctx
,
177 const char *input_string
,
178 const char *username
,
183 char *talloc_sub_advanced(TALLOC_CTX
*mem_ctx
,
184 const char *servicename
, const char *user
,
185 const char *connectpath
, gid_t gid
,
186 const char *smb_name
, const char *domain_name
,
188 void standard_sub_advanced(const char *servicename
, const char *user
,
189 const char *connectpath
, gid_t gid
,
190 const char *smb_name
, const char *domain_name
,
191 char *str
, size_t len
);
193 /* The following definitions come from lib/sysquotas.c */
195 int sys_get_quota(const char *path
, enum SMB_QUOTA_TYPE qtype
, unid_t id
, SMB_DISK_QUOTA
*dp
);
196 int sys_set_quota(const char *path
, enum SMB_QUOTA_TYPE qtype
, unid_t id
, SMB_DISK_QUOTA
*dp
);
198 /* The following definitions come from lib/sysquotas_*.c */
200 int sys_get_vfs_quota(const char *path
, const char *bdev
, enum SMB_QUOTA_TYPE qtype
, unid_t id
, SMB_DISK_QUOTA
*dp
);
201 int sys_set_vfs_quota(const char *path
, const char *bdev
, enum SMB_QUOTA_TYPE qtype
, unid_t id
, SMB_DISK_QUOTA
*dp
);
203 int sys_get_xfs_quota(const char *path
, const char *bdev
, enum SMB_QUOTA_TYPE qtype
, unid_t id
, SMB_DISK_QUOTA
*dp
);
204 int sys_set_xfs_quota(const char *path
, const char *bdev
, enum SMB_QUOTA_TYPE qtype
, unid_t id
, SMB_DISK_QUOTA
*dp
);
206 int sys_get_nfs_quota(const char *path
, const char *bdev
,
207 enum SMB_QUOTA_TYPE qtype
,
208 unid_t id
, SMB_DISK_QUOTA
*dp
);
209 int sys_set_nfs_quota(const char *path
, const char *bdev
,
210 enum SMB_QUOTA_TYPE qtype
,
211 unid_t id
, SMB_DISK_QUOTA
*dp
);
213 /* The following definitions come from lib/system.c */
215 ssize_t
sys_send(int s
, const void *msg
, size_t len
, int flags
);
216 ssize_t
sys_recvfrom(int s
, void *buf
, size_t len
, int flags
, struct sockaddr
*from
, socklen_t
*fromlen
);
217 int sys_fcntl_ptr(int fd
, int cmd
, void *arg
);
218 int sys_fcntl_long(int fd
, int cmd
, long arg
);
219 void update_stat_ex_mtime(struct stat_ex
*dst
, struct timespec write_ts
);
220 void update_stat_ex_create_time(struct stat_ex
*dst
, struct timespec create_time
);
221 int sys_stat(const char *fname
, SMB_STRUCT_STAT
*sbuf
,
222 bool fake_dir_create_times
);
223 int sys_fstat(int fd
, SMB_STRUCT_STAT
*sbuf
,
224 bool fake_dir_create_times
);
225 int sys_lstat(const char *fname
,SMB_STRUCT_STAT
*sbuf
,
226 bool fake_dir_create_times
);
227 int sys_posix_fallocate(int fd
, off_t offset
, off_t len
);
228 int sys_fallocate(int fd
, uint32_t mode
, off_t offset
, off_t len
);
229 void kernel_flock(int fd
, uint32_t share_mode
, uint32_t access_mask
);
230 DIR *sys_fdopendir(int fd
);
231 int sys_mknod(const char *path
, mode_t mode
, SMB_DEV_T dev
);
232 char *sys_getwd(void);
233 void set_effective_capability(enum smbd_capability capability
);
234 void drop_effective_capability(enum smbd_capability capability
);
235 long sys_random(void);
236 void sys_srandom(unsigned int seed
);
237 int groups_max(void);
238 int sys_getgroups(int setlen
, gid_t
*gidset
);
239 int sys_setgroups(gid_t
UNUSED(primary_gid
), int setlen
, gid_t
*gidset
);
240 uint32_t unix_dev_major(SMB_DEV_T dev
);
241 uint32_t unix_dev_minor(SMB_DEV_T dev
);
242 char *sys_realpath(const char *path
);
244 int sys_get_number_of_cores(void);
248 void init_stat_ex_from_stat (struct stat_ex
*dst
,
249 const struct stat
*src
,
250 bool fake_dir_create_times
);
252 /* The following definitions come from lib/system_smbd.c */
254 bool getgroups_unix_user(TALLOC_CTX
*mem_ctx
, const char *user
,
256 gid_t
**ret_groups
, uint32_t *p_ngroups
);
258 /* The following definitions come from lib/tallocmsg.c */
260 void register_msg_pool_usage(struct messaging_context
*msg_ctx
);
262 /* The following definitions come from lib/time.c */
264 void push_dos_date(uint8_t *buf
, int offset
, time_t unixdate
, int zone_offset
);
265 void push_dos_date2(uint8_t *buf
,int offset
,time_t unixdate
, int zone_offset
);
266 void push_dos_date3(uint8_t *buf
,int offset
,time_t unixdate
, int zone_offset
);
267 uint32_t convert_time_t_to_uint32_t(time_t t
);
268 time_t convert_uint32_t_to_time_t(uint32_t u
);
269 bool nt_time_is_zero(const NTTIME
*nt
);
270 time_t generalized_to_unix_time(const char *str
);
271 int get_server_zone_offset(void);
272 int set_server_zone_offset(time_t t
);
273 char *timeval_string(TALLOC_CTX
*ctx
, const struct timeval
*tp
, bool hires
);
274 char *current_timestring(TALLOC_CTX
*ctx
, bool hires
);
275 void srv_put_dos_date(char *buf
,int offset
,time_t unixdate
);
276 void srv_put_dos_date2(char *buf
,int offset
, time_t unixdate
);
277 void srv_put_dos_date3(char *buf
,int offset
,time_t unixdate
);
278 void round_timespec(enum timestamp_set_resolution res
, struct timespec
*ts
);
279 void put_long_date_timespec(enum timestamp_set_resolution res
, char *p
, struct timespec ts
);
280 void put_long_date(char *p
, time_t t
);
281 void dos_filetime_timespec(struct timespec
*tsp
);
282 time_t make_unix_date(const void *date_ptr
, int zone_offset
);
283 time_t make_unix_date2(const void *date_ptr
, int zone_offset
);
284 time_t make_unix_date3(const void *date_ptr
, int zone_offset
);
285 time_t srv_make_unix_date(const void *date_ptr
);
286 time_t srv_make_unix_date2(const void *date_ptr
);
287 time_t srv_make_unix_date3(const void *date_ptr
);
288 struct timespec
interpret_long_date(const char *p
);
290 void get_process_uptime(struct timeval
*ret_time
);
291 void get_startup_time(struct timeval
*ret_time
);
292 time_t nt_time_to_unix_abs(const NTTIME
*nt
);
293 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src
);
294 void unix_to_nt_time_abs(NTTIME
*nt
, time_t t
);
295 const char *time_to_asc(const time_t t
);
296 const char *display_time(NTTIME nttime
);
297 bool nt_time_is_set(const NTTIME
*nt
);
299 /* The following definitions come from lib/username.c */
301 void flush_pwnam_cache(void);
302 char *get_user_home_dir(TALLOC_CTX
*mem_ctx
, const char *user
);
303 struct passwd
*Get_Pwnam_alloc(TALLOC_CTX
*mem_ctx
, const char *user
);
305 /* The following definitions come from lib/util_names.c */
306 const char *get_global_sam_name(void);
307 const char *my_sam_name(void);
309 /* The following definitions come from lib/util.c */
311 enum protocol_types
get_Protocol(void);
312 void set_Protocol(enum protocol_types p
);
313 void gfree_names(void);
314 void gfree_all( void );
315 const char *my_netbios_names(int i
);
316 bool set_netbios_aliases(const char **str_array
);
317 bool init_names(void);
318 bool file_exist_stat(const char *fname
,SMB_STRUCT_STAT
*sbuf
,
319 bool fake_dir_create_times
);
320 bool socket_exist(const char *fname
);
321 uint64_t get_file_size_stat(const SMB_STRUCT_STAT
*sbuf
);
322 bool check_same_dev_ino(const SMB_STRUCT_STAT
*sbuf1
,
323 const SMB_STRUCT_STAT
*sbuf2
);
324 bool check_same_stat(const SMB_STRUCT_STAT
*sbuf1
,
325 const SMB_STRUCT_STAT
*sbuf2
);
326 void show_msg(const char *buf
);
327 int set_message_bcc(char *buf
,int num_bytes
);
328 ssize_t
message_push_blob(uint8_t **outbuf
, DATA_BLOB blob
);
329 char *unix_clean_name(TALLOC_CTX
*ctx
, const char *s
);
330 char *clean_name(TALLOC_CTX
*ctx
, const char *s
);
331 ssize_t
write_data_at_offset(int fd
, const char *buffer
, size_t N
, off_t pos
);
332 int set_blocking(int fd
, bool set
);
333 NTSTATUS
init_before_fork(void);
334 NTSTATUS
reinit_after_fork(struct messaging_context
*msg_ctx
,
335 struct tevent_context
*ev_ctx
,
336 bool parent_longlived
,
337 const char *comment
);
338 NTSTATUS
smbd_reinit_after_fork(struct messaging_context
*msg_ctx
,
339 struct tevent_context
*ev_ctx
,
340 bool parent_longlived
,
341 const char *comment
);
342 void *malloc_(size_t size
);
343 void *Realloc(void *p
, size_t size
, bool free_old_on_error
);
344 void add_to_large_array(TALLOC_CTX
*mem_ctx
, size_t element_size
,
345 void *element
, void *_array
, uint32_t *num_elements
,
346 ssize_t
*array_size
);
347 char *get_myname(TALLOC_CTX
*ctx
);
348 char *get_mydnsdomname(TALLOC_CTX
*ctx
);
349 char *automount_lookup(TALLOC_CTX
*ctx
, const char *user_name
);
350 char *automount_lookup(TALLOC_CTX
*ctx
, const char *user_name
);
351 bool process_exists(const struct server_id pid
);
352 const char *uidtoname(uid_t uid
);
353 char *gidtoname(gid_t gid
);
354 uid_t
nametouid(const char *name
);
355 gid_t
nametogid(const char *name
);
356 void smb_panic_s3(const char *why
);
357 const char *readdirname(DIR *p
);
358 bool is_in_path(const char *name
, name_compare_entry
*namelist
, bool case_sensitive
);
359 void set_namearray(name_compare_entry
**ppname_array
, const char *namelist
);
360 void free_namearray(name_compare_entry
*name_array
);
361 bool fcntl_lock(int fd
, int op
, off_t offset
, off_t count
, int type
);
362 bool fcntl_getlock(int fd
, int op
, off_t
*poffset
, off_t
*pcount
, int *ptype
, pid_t
*ppid
);
363 int map_process_lock_to_ofd_lock(int op
);
364 bool is_myname(const char *s
);
365 void ra_lanman_string( const char *native_lanman
);
366 const char *get_remote_arch_str(void);
367 enum remote_arch_types
get_remote_arch_from_str(const char *remote_arch_string
);
368 void set_remote_arch(enum remote_arch_types type
);
369 enum remote_arch_types
get_remote_arch(void);
370 bool remote_arch_cache_update(const struct GUID
*client_guid
);
371 bool remote_arch_cache_delete(const struct GUID
*client_guid
);
372 const char *tab_depth(int level
, int depth
);
373 int str_checksum(const char *s
);
374 void zero_free(void *p
, size_t size
);
375 int set_maxfiles(int requested_max
);
376 int smb_mkstemp(char *name_template
);
377 void *smb_xmalloc_array(size_t size
, unsigned int count
);
378 char *myhostname(void);
379 char *myhostname_upper(void);
380 #include "lib/util_path.h"
381 bool parent_dirname(TALLOC_CTX
*mem_ctx
, const char *dir
, char **parent
,
383 bool ms_has_wild(const char *s
);
384 bool ms_has_wild_w(const smb_ucs2_t
*s
);
385 bool mask_match(const char *string
, const char *pattern
, bool is_case_sensitive
);
386 bool mask_match_search(const char *string
, const char *pattern
, bool is_case_sensitive
);
387 bool mask_match_list(const char *string
, char **list
, int listLen
, bool is_case_sensitive
);
388 #include "lib/util/unix_match.h"
389 bool name_to_fqdn(fstring fqdn
, const char *name
);
390 uint32_t map_share_mode_to_deny_mode(uint32_t share_access
, uint32_t private_options
);
392 #include "lib/util_procid.h"
394 #define serverid_equal(p1, p2) server_id_equal(p1,p2)
395 struct server_id
interpret_pid(const char *pid_string
);
396 bool is_offset_safe(const char *buf_base
, size_t buf_len
, char *ptr
, size_t off
);
397 char *get_safe_ptr(const char *buf_base
, size_t buf_len
, char *ptr
, size_t off
);
398 char *get_safe_str_ptr(const char *buf_base
, size_t buf_len
, char *ptr
, size_t off
);
399 int get_safe_SVAL(const char *buf_base
, size_t buf_len
, char *ptr
, size_t off
, int failval
);
400 int get_safe_IVAL(const char *buf_base
, size_t buf_len
, char *ptr
, size_t off
, int failval
);
401 bool split_domain_user(TALLOC_CTX
*mem_ctx
,
402 const char *full_name
,
405 const char *strip_hostname(const char *s
);
406 bool any_nt_status_not_ok(NTSTATUS err1
, NTSTATUS err2
, NTSTATUS
*result
);
407 int timeval_to_msec(struct timeval t
);
408 char *valid_share_pathname(TALLOC_CTX
*ctx
, const char *dos_pathname
);
409 bool is_executable(const char *fname
);
410 bool map_open_params_to_ntcreate(const char *smb_base_fname
,
411 int deny_mode
, int open_func
,
412 uint32_t *paccess_mask
,
413 uint32_t *pshare_mode
,
414 uint32_t *pcreate_disposition
,
415 uint32_t *pcreate_options
,
416 uint32_t *pprivate_flags
);
417 struct security_unix_token
*copy_unix_token(TALLOC_CTX
*ctx
, const struct security_unix_token
*tok
);
418 struct security_unix_token
*root_unix_token(TALLOC_CTX
*mem_ctx
);
419 bool dir_check_ftype(uint32_t mode
, uint32_t dirtype
);
421 /* The following definitions come from lib/util_builtin.c */
423 bool lookup_builtin_rid(TALLOC_CTX
*mem_ctx
, uint32_t rid
, const char **name
);
424 bool lookup_builtin_name(const char *name
, uint32_t *rid
);
425 const char *builtin_domain_name(void);
426 bool sid_check_is_builtin(const struct dom_sid
*sid
);
427 bool sid_check_is_in_builtin(const struct dom_sid
*sid
);
428 bool sid_check_is_wellknown_builtin(const struct dom_sid
*sid
);
430 /* The following definitions come from lib/util_nscd.c */
432 void smb_nscd_flush_user_cache(void);
433 void smb_nscd_flush_group_cache(void);
435 /* The following definitions come from lib/util_nttoken.c */
437 struct security_token
*dup_nt_token(TALLOC_CTX
*mem_ctx
, const struct security_token
*ptoken
);
438 NTSTATUS
merge_nt_token(TALLOC_CTX
*mem_ctx
,
439 const struct security_token
*token_1
,
440 const struct security_token
*token_2
,
441 struct security_token
**token_out
);
442 bool token_sid_in_ace(const struct security_token
*token
, const struct security_ace
*ace
);
444 /* The following definitions come from lib/util_sec.c */
447 uid_t
sec_initial_uid(void);
448 gid_t
sec_initial_gid(void);
449 bool root_mode(void);
450 bool non_root_mode(void);
451 void gain_root_privilege(void);
452 void gain_root_group_privilege(void);
453 void set_effective_uid(uid_t uid
);
454 void set_effective_gid(gid_t gid
);
455 void save_re_uid(void);
456 void restore_re_uid_fromroot(void);
457 void restore_re_uid(void);
458 void save_re_gid(void);
459 void restore_re_gid(void);
460 int set_re_uid(void);
461 void become_user_permanently(uid_t uid
, gid_t gid
);
462 int set_thread_credentials(uid_t uid
,
465 const gid_t
*gidset
);
466 bool is_setuid_root(void) ;
468 /* The following definitions come from lib/util_sid.c */
470 char *sid_to_fstring(fstring sidstr_out
, const struct dom_sid
*sid
);
471 bool sid_linearize(uint8_t *outbuf
, size_t len
, const struct dom_sid
*sid
);
472 bool non_mappable_sid(struct dom_sid
*sid
);
473 char *sid_binstring_hex_talloc(TALLOC_CTX
*mem_ctx
, const struct dom_sid
*sid
);
474 struct netr_SamInfo3
;
475 NTSTATUS
sid_array_from_info3(TALLOC_CTX
*mem_ctx
,
476 const struct netr_SamInfo3
*info3
,
477 struct dom_sid
**user_sids
,
478 uint32_t *num_user_sids
,
479 bool include_user_group_rid
);
481 /* The following definitions come from lib/util_sock.c */
483 bool is_broadcast_addr(const struct sockaddr
*pss
);
484 bool is_loopback_ip_v4(struct in_addr ip
);
485 bool is_loopback_addr(const struct sockaddr
*pss
);
486 bool is_zero_addr(const struct sockaddr_storage
*pss
);
487 void zero_ip_v4(struct in_addr
*ip
);
488 void in_addr_to_sockaddr_storage(struct sockaddr_storage
*ss
,
490 bool same_net(const struct sockaddr
*ip1
,
491 const struct sockaddr
*ip2
,
492 const struct sockaddr
*mask
);
493 bool sockaddr_equal(const struct sockaddr
*ip1
,
494 const struct sockaddr
*ip2
);
495 bool is_address_any(const struct sockaddr
*psa
);
496 uint16_t get_sockaddr_port(const struct sockaddr_storage
*pss
);
497 char *print_sockaddr(char *dest
,
499 const struct sockaddr_storage
*psa
);
500 char *print_canonical_sockaddr(TALLOC_CTX
*ctx
,
501 const struct sockaddr_storage
*pss
);
502 int get_socket_port(int fd
);
503 const char *client_addr(int fd
, char *addr
, size_t addrlen
);
504 const char *client_socket_addr(int fd
, char *addr
, size_t addr_len
);
505 int client_socket_port(int fd
);
506 bool is_a_socket(int fd
);
507 void set_socket_options(int fd
, const char *options
);
508 ssize_t
read_udp_v4_socket(int fd
,
511 struct sockaddr_storage
*psa
);
512 NTSTATUS
read_fd_with_timeout(int fd
, char *buf
,
513 size_t mincnt
, size_t maxcnt
,
514 unsigned int time_out
,
516 NTSTATUS
read_data_ntstatus(int fd
, char *buffer
, size_t N
);
518 bool send_keepalive(int client
);
519 NTSTATUS
read_smb_length_return_keepalive(int fd
, char *inbuf
,
520 unsigned int timeout
,
522 NTSTATUS
receive_smb_raw(int fd
,
525 unsigned int timeout
,
528 int open_socket_in(int type
,
531 const struct sockaddr_storage
*psock
,
533 NTSTATUS
open_socket_out(const struct sockaddr_storage
*pss
, uint16_t port
,
534 int timeout
, int *pfd
);
535 struct tevent_req
*open_socket_out_send(TALLOC_CTX
*mem_ctx
,
536 struct tevent_context
*ev
,
537 const struct sockaddr_storage
*pss
,
540 NTSTATUS
open_socket_out_recv(struct tevent_req
*req
, int *pfd
);
541 struct tevent_req
*open_socket_out_defer_send(TALLOC_CTX
*mem_ctx
,
542 struct tevent_context
*ev
,
543 struct timeval wait_time
,
544 const struct sockaddr_storage
*pss
,
547 NTSTATUS
open_socket_out_defer_recv(struct tevent_req
*req
, int *pfd
);
548 int open_udp_socket(const char *host
, int port
);
549 const char *get_peer_addr(int fd
, char *addr
, size_t addr_len
);
551 struct tsocket_address
;
553 int get_remote_hostname(const struct tsocket_address
*remote_address
,
555 TALLOC_CTX
*mem_ctx
);
557 int create_pipe_sock(const char *socket_dir
,
558 const char *socket_name
,
560 int create_tcpip_socket(const struct sockaddr_storage
*ifss
, uint16_t *port
);
561 const char *get_mydnsfullname(void);
562 bool is_myname_or_ipaddr(const char *s
);
563 int poll_one_fd(int fd
, int events
, int timeout
, int *revents
);
564 int poll_intr_one_fd(int fd
, int events
, int timeout
, int *revents
);
566 /* The following definitions come from lib/util_str.c */
568 bool next_token(const char **ptr
, char *buff
, const char *sep
, size_t bufsize
);
569 bool strnequal(const char *s1
,const char *s2
,size_t n
);
570 bool strcsequal(const char *s1
,const char *s2
);
571 bool strnorm(char *s
, int case_default
);
572 char *push_skip_string(char *buf
);
573 char *skip_string(const char *base
, size_t len
, char *buf
);
574 size_t str_charnum(const char *s
);
575 bool trim_char(char *s
,char cfront
,char cback
);
576 bool strhasupper(const char *s
);
577 bool strhaslower(const char *s
);
578 bool in_list(const char *s
, const char *list
, bool casesensitive
);
579 void fstring_sub(char *s
,const char *pattern
,const char *insert
);
580 char *realloc_string_sub2(char *string
,
583 bool remove_unsafe_characters
,
584 bool allow_trailing_dollar
);
585 char *realloc_string_sub(char *string
,
588 char *talloc_string_sub2(TALLOC_CTX
*mem_ctx
, const char *src
,
591 bool remove_unsafe_characters
,
593 bool allow_trailing_dollar
);
594 char *talloc_string_sub(TALLOC_CTX
*mem_ctx
,
598 void all_string_sub(char *s
,const char *pattern
,const char *insert
, size_t len
);
599 char *talloc_all_string_sub(TALLOC_CTX
*ctx
,
603 char *octal_string(int i
);
604 char *string_truncate(char *s
, unsigned int length
);
605 char *strchr_m(const char *src
, char c
);
606 char *strrchr_m(const char *s
, char c
);
607 char *strnrchr_m(const char *s
, char c
, unsigned int n
);
608 char *strstr_m(const char *src
, const char *findstr
);
609 bool strlower_m(char *s
);
610 bool strupper_m(char *s
);
611 size_t strlen_m(const char *s
);
612 size_t strlen_m_term(const char *s
);
613 size_t strlen_m_term_null(const char *s
);
614 int fstr_sprintf(fstring s
, const char *fmt
, ...);
615 bool str_list_sub_basic( char **list
, const char *smb_name
,
616 const char *domain_name
);
617 bool str_list_substitute(char **list
, const char *pattern
, const char *insert
);
619 char *ipstr_list_make(char **ipstr_list
,
620 const struct ip_service
*ip_list
,
622 int ipstr_list_parse(const char *ipstr_list
, struct ip_service
**ip_list
);
623 void ipstr_list_free(char* ipstr_list
);
624 uint64_t STR_TO_SMB_BIG_UINT(const char *nptr
, const char **entptr
);
625 uint64_t conv_str_size(const char * str
);
626 int asprintf_strupper_m(char **strp
, const char *fmt
, ...)
627 PRINTF_ATTRIBUTE(2,3);
628 char *talloc_asprintf_strupper_m(TALLOC_CTX
*t
, const char *fmt
, ...)
629 PRINTF_ATTRIBUTE(2,3);
630 char *talloc_asprintf_strlower_m(TALLOC_CTX
*t
, const char *fmt
, ...)
631 PRINTF_ATTRIBUTE(2,3);
632 bool validate_net_name( const char *name
,
633 const char *invalid_chars
,
635 char *escape_shell_string(const char *src
);
636 ssize_t
full_path_tos(const char *dir
, const char *name
,
637 char *tmpbuf
, size_t tmpbuf_len
,
638 char **pdst
, char **to_free
);
640 /* The following definitions come from lib/version.c */
642 const char *samba_version_string(void);
644 /* The following definitions come from lib/wins_srv.c */
646 bool wins_srv_is_dead(struct in_addr wins_ip
, struct in_addr src_ip
);
647 void wins_srv_alive(struct in_addr wins_ip
, struct in_addr src_ip
);
648 void wins_srv_died(struct in_addr wins_ip
, struct in_addr src_ip
);
649 unsigned wins_srv_count(void);
650 char **wins_srv_tags(void);
651 void wins_srv_tags_free(char **list
);
652 struct in_addr
wins_srv_ip_tag(const char *tag
, struct in_addr src_ip
);
653 bool wins_server_tag_ips(const char *tag
, TALLOC_CTX
*mem_ctx
,
654 struct in_addr
**pservers
, int *pnum_servers
);
655 unsigned wins_srv_count_tag(const char *tag
);
657 #ifndef ASN1_MAX_OIDS
658 #define ASN1_MAX_OIDS 20
660 bool spnego_parse_negTokenInit(TALLOC_CTX
*ctx
,
662 char *OIDs
[ASN1_MAX_OIDS
],
665 DATA_BLOB
spnego_gen_krb5_wrap(TALLOC_CTX
*ctx
, const DATA_BLOB ticket
, const uint8_t tok_id
[2]);
667 /* The following definitions come from libsmb/conncache.c */
669 NTSTATUS
check_negative_conn_cache( const char *domain
, const char *server
);
670 void add_failed_connection_entry(const char *domain
, const char *server
, NTSTATUS result
) ;
671 void flush_negative_conn_cache_for_domain(const char *domain
);
673 /* The following definitions come from libsmb/errormap.c */
675 NTSTATUS
dos_to_ntstatus(uint8_t eclass
, uint32_t ecode
);
677 /* The following definitions come from libsmb/namecache.c */
679 bool namecache_store(const char *name
,
682 struct ip_service
*ip_list
);
683 bool namecache_fetch(const char *name
,
685 struct ip_service
**ip_list
,
687 bool namecache_delete(const char *name
, int name_type
);
688 void namecache_flush(void);
689 bool namecache_status_store(const char *keyname
, int keyname_type
,
690 int name_type
, const struct sockaddr_storage
*keyip
,
691 const char *srvname
);
692 bool namecache_status_fetch(const char *keyname
,
695 const struct sockaddr_storage
*keyip
,
698 /* The following definitions come from libsmb/namequery_dc.c */
700 bool get_dc_name(const char *domain
,
703 struct sockaddr_storage
*ss_out
);
705 /* The following definitions come from libsmb/smberr.c */
707 const char *smb_dos_err_name(uint8_t e_class
, uint16_t num
);
708 const char *get_dos_error_msg(WERROR result
);
709 const char *smb_dos_err_class(uint8_t e_class
);
710 WERROR
map_werror_from_unix(int error
);
712 /* The following definitions come from libsmb/trusts_util.c */
714 struct netlogon_creds_cli_context
;
715 struct messaging_context
;
716 struct dcerpc_binding_handle
;
717 char *trust_pw_new_value(TALLOC_CTX
*mem_ctx
,
718 enum netr_SchannelType sec_channel_type
,
720 NTSTATUS
trust_pw_change(struct netlogon_creds_cli_context
*context
,
721 struct messaging_context
*msg_ctx
,
722 struct dcerpc_binding_handle
*b
,
727 /* The following definitions come from param/loadparm.c */
729 #include "source3/param/param_proto.h"
731 char *lp_servicename(TALLOC_CTX
*ctx
, int);
732 const char *lp_const_servicename(int);
733 bool lp_autoloaded(int);
734 const char *lp_dnsdomain(void);
735 int lp_winbind_max_domain_connections(void);
736 bool lp_idmap_range(const char *domain_name
, uint32_t *low
, uint32_t *high
);
737 bool lp_idmap_default_range(uint32_t *low
, uint32_t *high
);
738 const char *lp_idmap_backend(const char *domain_name
);
739 const char *lp_idmap_default_backend (void);
740 int lp_security(void);
741 int lp_client_max_protocol(void);
742 int lp_client_ipc_min_protocol(void);
743 int lp_client_ipc_max_protocol(void);
744 int lp_client_ipc_signing(void);
745 int lp_smb2_max_credits(void);
746 int lp_cups_encrypt(void);
747 bool lp_widelinks(int );
748 int lp_rpc_low_port(void);
749 int lp_rpc_high_port(void);
750 bool lp_lanman_auth(void);
752 int lp_wi_scan_global_parametrics(
753 const char *regex
, size_t max_matches
,
754 bool (*cb
)(const char *string
, regmatch_t matches
[],
758 char *lp_parm_talloc_string(TALLOC_CTX
*ctx
, int snum
, const char *type
, const char *option
, const char *def
);
759 const char *lp_parm_const_string(int snum
, const char *type
, const char *option
, const char *def
);
760 struct loadparm_service
;
761 const char *lp_parm_const_string_service(struct loadparm_service
*service
, const char *type
,
762 const char *option
, const char *def
);
763 const char **lp_parm_string_list(int snum
, const char *type
, const char *option
, const char **def
);
764 int lp_parm_int(int snum
, const char *type
, const char *option
, int def
);
765 unsigned long lp_parm_ulong(int snum
, const char *type
, const char *option
, unsigned long def
);
766 unsigned long long lp_parm_ulonglong(int snum
, const char *type
,
768 unsigned long long def
);
769 bool lp_parm_bool(int snum
, const char *type
, const char *option
, bool def
);
771 int lp_parm_enum(int snum
, const char *type
, const char *option
,
772 const struct enum_list
*_enum
, int def
);
773 char *canonicalize_servicename(TALLOC_CTX
*ctx
, const char *src
);
774 bool lp_add_home(const char *pszHomename
, int iDefaultService
,
775 const char *user
, const char *pszHomedir
);
776 int lp_add_service(const char *pszService
, int iDefaultService
);
777 bool lp_add_printer(const char *pszPrintername
, int iDefaultService
);
778 bool lp_parameter_is_valid(const char *pszParmName
);
779 bool lp_parameter_is_global(const char *pszParmName
);
780 bool lp_canonicalize_parameter(const char *parm_name
, const char **canon_parm
,
782 bool lp_canonicalize_parameter_with_value(const char *parm_name
,
784 const char **canon_parm
,
785 const char **canon_val
);
786 void show_parameter_list(void);
787 bool lp_invert_boolean(const char *str
, const char **inverse_str
);
788 bool lp_canonicalize_boolean(const char *str
, const char**canon_str
);
789 bool process_registry_service(const char *service_name
);
790 bool process_registry_shares(void);
791 bool lp_config_backend_is_registry(void);
792 bool lp_config_backend_is_file(void);
793 bool lp_file_list_changed(void);
794 const char *lp_ldap_machine_suffix(TALLOC_CTX
*ctx
);
795 const char *lp_ldap_user_suffix(TALLOC_CTX
*ctx
);
796 const char *lp_ldap_group_suffix(TALLOC_CTX
*ctx
);
797 const char *lp_ldap_idmap_suffix(TALLOC_CTX
*ctx
);
799 /* Return a pointer to a service by name. */
800 struct loadparm_service
*lp_service(const char *pszServiceName
);
801 struct loadparm_service
*lp_servicebynum(int snum
);
802 struct loadparm_service
*lp_default_loadparm_service(void);
803 void *lp_parm_ptr(struct loadparm_service
*service
, struct parm_struct
*parm
);
804 void *lp_local_ptr_by_snum(int snum
, struct parm_struct
*parm
);
805 bool lp_do_parameter(int snum
, const char *pszParmName
, const char *pszParmValue
);
806 bool lp_set_cmdline(const char *pszParmName
, const char *pszParmValue
);
807 bool dump_a_parameter(int snum
, char *parm_name
, FILE * f
, bool isGlobal
);
808 bool lp_snum_ok(int iService
);
809 void lp_add_one_printer(const char *name
, const char *comment
,
810 const char *location
, void *pdata
);
811 bool lp_loaded(void);
812 void lp_killunused(struct smbd_server_connection
*sconn
,
813 bool (*snumused
) (struct smbd_server_connection
*, int));
814 void lp_kill_all_services(void);
815 void lp_killservice(int iServiceIn
);
816 const char* server_role_str(uint32_t role
);
817 enum usershare_err
parse_usershare_file(TALLOC_CTX
*ctx
,
818 SMB_STRUCT_STAT
*psbuf
,
819 const char *servicename
,
825 char **pp_cp_share_name
,
826 struct security_descriptor
**ppsd
,
828 int load_usershare_service(const char *servicename
);
829 int load_usershare_shares(struct smbd_server_connection
*sconn
,
830 bool (*snumused
) (struct smbd_server_connection
*, int));
831 void gfree_loadparm(void);
832 bool lp_load_initial_only(const char *pszFname
);
833 bool lp_load_global(const char *file_name
);
834 bool lp_load_with_shares(const char *file_name
);
835 bool lp_load_client(const char *file_name
);
836 bool lp_load_global_no_reinit(const char *file_name
);
837 bool lp_load_no_reinit(const char *file_name
);
838 bool lp_load_client_no_reinit(const char *file_name
);
839 bool lp_load_with_registry_shares(const char *pszFname
);
840 int lp_numservices(void);
841 void lp_dump(FILE *f
, bool show_defaults
, int maxtoprint
);
842 void lp_dump_one(FILE * f
, bool show_defaults
, int snum
);
843 int lp_servicenumber(const char *pszServiceName
);
844 const char *volume_label(TALLOC_CTX
*ctx
, int snum
);
845 bool lp_domain_master(void);
846 bool lp_preferred_master(void);
847 void lp_remove_service(int snum
);
848 void lp_copy_service(int snum
, const char *new_name
);
849 int lp_default_server_announce(void);
850 const char *lp_printername(TALLOC_CTX
*ctx
, int snum
);
851 void lp_set_logfile(const char *name
);
852 int lp_maxprintjobs(int snum
);
853 const char *lp_printcapname(void);
854 bool lp_disable_spoolss( void );
855 void lp_set_spoolss_state( uint32_t state
);
856 uint32_t lp_get_spoolss_state( void );
857 struct smb_signing_state
;
858 bool lp_use_sendfile(int snum
, struct smb_signing_state
*signing_state
);
859 void set_use_sendfile(int snum
, bool val
);
860 void lp_set_mangling_method(const char *new_method
);
861 bool lp_posix_pathnames(void);
862 void lp_set_posix_pathnames(void);
863 enum brl_flavour
lp_posix_cifsu_locktype(files_struct
*fsp
);
864 void lp_set_posix_default_cifsx_readwrite_locktype(enum brl_flavour val
);
865 int lp_min_receive_file_size(void);
866 char* lp_perfcount_module(TALLOC_CTX
*ctx
);
867 void widelinks_warning(int snum
);
868 const char *lp_ncalrpc_dir(void);
869 void _lp_set_server_role(int server_role
);
871 /* The following definitions come from param/loadparm_ctx.c */
873 const struct loadparm_s3_helpers
*loadparm_s3_helpers(void);
875 /* The following definitions come from param/loadparm_server_role.c */
877 int lp_server_role(void);
878 void set_server_role(void);
880 /* The following definitions come from param/util.c */
882 uint32_t get_int_param( const char* param
);
883 char* get_string_param( const char* param
);
885 /* The following definitions come from lib/server_contexts.c */
886 struct tevent_context
*global_event_context(void);
887 void global_event_context_free(void);
888 struct messaging_context
*global_messaging_context(void);
889 void global_messaging_context_free(void);
891 /* The following definitions come from lib/sessionid_tdb.c */
893 NTSTATUS
sessionid_traverse_read(int (*fn
)(const char *key
,
894 struct sessionid
*session
,
898 /* The following definitions come from utils/passwd_util.c */
900 char *stdin_new_passwd( void);
901 char *get_pass( const char *prompt
, bool stdin_get
);
903 /* The following definitions come from lib/avahi.c */
905 struct AvahiPoll
*tevent_avahi_poll(TALLOC_CTX
*mem_ctx
,
906 struct tevent_context
*ev
);
908 /* The following definitions come from libsmb/smbsock_connect.c */
910 struct tevent_req
*smbsock_connect_send(TALLOC_CTX
*mem_ctx
,
911 struct tevent_context
*ev
,
912 const struct sockaddr_storage
*addr
,
914 const char *called_name
,
916 const char *calling_name
,
918 NTSTATUS
smbsock_connect_recv(struct tevent_req
*req
, int *sock
,
920 NTSTATUS
smbsock_connect(const struct sockaddr_storage
*addr
, uint16_t port
,
921 const char *called_name
, int called_type
,
922 const char *calling_name
, int calling_type
,
923 int *pfd
, uint16_t *ret_port
, int sec_timeout
);
925 struct tevent_req
*smbsock_any_connect_send(TALLOC_CTX
*mem_ctx
,
926 struct tevent_context
*ev
,
927 const struct sockaddr_storage
*addrs
,
928 const char **called_names
,
930 const char **calling_names
,
932 size_t num_addrs
, uint16_t port
);
933 NTSTATUS
smbsock_any_connect_recv(struct tevent_req
*req
, int *pfd
,
934 size_t *chosen_index
, uint16_t *chosen_port
);
935 NTSTATUS
smbsock_any_connect(const struct sockaddr_storage
*addrs
,
936 const char **called_names
,
938 const char **calling_names
,
943 int *pfd
, size_t *chosen_index
,
944 uint16_t *chosen_port
);
946 /* The following definitions come from lib/util_wellknown.c */
948 bool sid_check_is_wellknown_domain(const struct dom_sid
*sid
, const char **name
);
949 bool sid_check_is_in_wellknown_domain(const struct dom_sid
*sid
);
950 bool lookup_wellknown_sid(TALLOC_CTX
*mem_ctx
, const struct dom_sid
*sid
,
951 const char **domain
, const char **name
);
952 bool lookup_wellknown_name(TALLOC_CTX
*mem_ctx
, const char *name
,
953 struct dom_sid
*sid
, const char **domain
);
955 /* The following definitions come from lib/util_specialsids.c */
956 bool sid_check_is_asserted_identity(const struct dom_sid
*sid
);
957 bool sid_check_is_in_asserted_identity(const struct dom_sid
*sid
);
958 const char *asserted_identity_domain_name(void);
960 /* The following definitions come from lib/filename_util.c */
962 NTSTATUS
get_full_smb_filename(TALLOC_CTX
*ctx
, const struct smb_filename
*smb_fname
,
964 struct smb_filename
*synthetic_smb_fname(TALLOC_CTX
*mem_ctx
,
965 const char *base_name
,
966 const char *stream_name
,
967 const SMB_STRUCT_STAT
*psbuf
,
969 struct smb_filename
*synthetic_smb_fname_split(TALLOC_CTX
*ctx
,
972 const char *smb_fname_str_dbg(const struct smb_filename
*smb_fname
);
973 const char *fsp_str_dbg(const struct files_struct
*fsp
);
974 const char *fsp_fnum_dbg(const struct files_struct
*fsp
);
975 struct smb_filename
*cp_smb_filename(TALLOC_CTX
*mem_ctx
,
976 const struct smb_filename
*in
);
977 struct smb_filename
*cp_smb_filename_nostream(TALLOC_CTX
*mem_ctx
,
978 const struct smb_filename
*in
);
979 bool is_ntfs_stream_smb_fname(const struct smb_filename
*smb_fname
);
980 bool is_ntfs_default_stream_smb_fname(const struct smb_filename
*smb_fname
);
981 bool is_invalid_windows_ea_name(const char *name
);
982 bool ea_list_has_invalid_name(struct ea_list
*ea_list
);
983 bool split_stream_filename(TALLOC_CTX
*ctx
,
984 const char *filename_in
,
986 char **streamname_out
);
988 /* The following definitions come from lib/dummyroot.c */
990 void become_root(void);
991 void unbecome_root(void);
993 /* The following definitions come from lib/smbd_shim.c */
995 int find_service(TALLOC_CTX
*ctx
, const char *service_in
, char **p_service_out
);
996 void cancel_pending_lock_requests_by_fid(files_struct
*fsp
,
997 struct byte_range_lock
*br_lck
,
998 enum file_close_type close_type
);
999 void send_stat_cache_delete_message(struct messaging_context
*msg_ctx
,
1001 NTSTATUS
can_delete_directory_fsp(files_struct
*fsp
);
1002 bool change_to_root_user(void);
1003 bool become_authenticated_pipe_user(struct auth_session_info
*session_info
);
1004 bool unbecome_authenticated_pipe_user(void);
1006 void contend_level2_oplocks_begin(files_struct
*fsp
,
1007 enum level2_contention_type type
);
1008 void contend_level2_oplocks_end(files_struct
*fsp
,
1009 enum level2_contention_type type
);
1011 /* The following definitions come from lib/per_thread_cwd.c */
1013 void per_thread_cwd_check(void);
1014 bool per_thread_cwd_supported(void);
1015 void per_thread_cwd_disable(void);
1016 void per_thread_cwd_activate(void);
1018 #endif /* _PROTO_H_ */