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_jfs2_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
207 int sys_set_jfs2_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
209 int sys_get_nfs_quota(const char *path, const char *bdev,
210 enum SMB_QUOTA_TYPE qtype,
211 unid_t id, SMB_DISK_QUOTA *dp);
212 int sys_set_nfs_quota(const char *path, const char *bdev,
213 enum SMB_QUOTA_TYPE qtype,
214 unid_t id, SMB_DISK_QUOTA *dp);
216 /* The following definitions come from lib/system.c */
218 ssize_t sys_send(int s, const void *msg, size_t len, int flags);
219 ssize_t sys_recvfrom(int s, void *buf, size_t len, int flags, struct sockaddr *from, socklen_t *fromlen);
220 int sys_fcntl_ptr(int fd, int cmd, void *arg);
221 int sys_fcntl_long(int fd, int cmd, long arg);
222 void update_stat_ex_mtime(struct stat_ex *dst, struct timespec write_ts);
223 void update_stat_ex_itime(struct stat_ex *dst, struct timespec itime);
224 void update_stat_ex_create_time(struct stat_ex *dst, struct timespec create_time);
225 void update_stat_ex_file_id(struct stat_ex *dst, uint64_t file_id);
226 int sys_stat(const char *fname, SMB_STRUCT_STAT *sbuf,
227 bool fake_dir_create_times);
228 int sys_fstat(int fd, SMB_STRUCT_STAT *sbuf,
229 bool fake_dir_create_times);
230 int sys_lstat(const char *fname,SMB_STRUCT_STAT *sbuf,
231 bool fake_dir_create_times);
232 int sys_posix_fallocate(int fd, off_t offset, off_t len);
233 int sys_fallocate(int fd, uint32_t mode, off_t offset, off_t len);
234 void kernel_flock(int fd, uint32_t share_mode, uint32_t access_mask);
235 DIR *sys_fdopendir(int fd);
236 int sys_mknod(const char *path, mode_t mode, SMB_DEV_T dev);
237 char *sys_getwd(void);
238 void set_effective_capability(enum smbd_capability capability);
239 void drop_effective_capability(enum smbd_capability capability);
240 long sys_random(void);
241 void sys_srandom(unsigned int seed);
242 int groups_max(void);
243 int sys_getgroups(int setlen, gid_t *gidset);
244 int sys_setgroups(gid_t UNUSED(primary_gid), int setlen, gid_t *gidset);
245 uint32_t unix_dev_major(SMB_DEV_T dev);
246 uint32_t unix_dev_minor(SMB_DEV_T dev);
247 char *sys_realpath(const char *path);
249 int sys_get_number_of_cores(void);
253 void init_stat_ex_from_stat (struct stat_ex *dst,
254 const struct stat *src,
255 bool fake_dir_create_times);
257 /* The following definitions come from lib/system_smbd.c */
259 bool getgroups_unix_user(TALLOC_CTX *mem_ctx, const char *user,
261 gid_t **ret_groups, uint32_t *p_ngroups);
263 /* The following definitions come from lib/tallocmsg.c */
265 void register_msg_pool_usage(struct messaging_context *msg_ctx);
267 /* The following definitions come from lib/time.c */
269 void push_dos_date(uint8_t *buf, int offset, time_t unixdate, int zone_offset);
270 void push_dos_date2(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
271 void push_dos_date3(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
272 uint32_t convert_time_t_to_uint32_t(time_t t);
273 time_t convert_uint32_t_to_time_t(uint32_t u);
274 bool nt_time_is_zero(const NTTIME *nt);
275 time_t generalized_to_unix_time(const char *str);
276 int get_server_zone_offset(void);
277 int set_server_zone_offset(time_t t);
278 char *timeval_string(TALLOC_CTX *ctx, const struct timeval *tp, bool hires);
279 char *current_timestring(TALLOC_CTX *ctx, bool hires);
280 void srv_put_dos_date(char *buf,int offset,time_t unixdate);
281 void srv_put_dos_date2(char *buf,int offset, time_t unixdate);
282 void srv_put_dos_date3(char *buf,int offset,time_t unixdate);
283 void round_timespec(enum timestamp_set_resolution res, struct timespec *ts);
284 void put_long_date_timespec(enum timestamp_set_resolution res, char *p, struct timespec ts);
285 void put_long_date(char *p, time_t t);
286 void dos_filetime_timespec(struct timespec *tsp);
287 time_t make_unix_date(const void *date_ptr, int zone_offset);
288 time_t make_unix_date2(const void *date_ptr, int zone_offset);
289 time_t make_unix_date3(const void *date_ptr, int zone_offset);
290 time_t srv_make_unix_date(const void *date_ptr);
291 time_t srv_make_unix_date2(const void *date_ptr);
292 time_t srv_make_unix_date3(const void *date_ptr);
293 struct timespec interpret_long_date(const char *p);
295 void get_process_uptime(struct timeval *ret_time);
296 void get_startup_time(struct timeval *ret_time);
297 time_t nt_time_to_unix_abs(const NTTIME *nt);
298 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src);
299 void unix_to_nt_time_abs(NTTIME *nt, time_t t);
300 const char *time_to_asc(const time_t t);
301 const char *display_time(NTTIME nttime);
302 bool nt_time_is_set(const NTTIME *nt);
304 /* The following definitions come from lib/username.c */
306 void flush_pwnam_cache(void);
307 char *get_user_home_dir(TALLOC_CTX *mem_ctx, const char *user);
308 struct passwd *Get_Pwnam_alloc(TALLOC_CTX *mem_ctx, const char *user);
310 /* The following definitions come from lib/util_names.c */
311 const char *get_global_sam_name(void);
312 const char *my_sam_name(void);
314 /* The following definitions come from lib/util.c */
316 enum protocol_types get_Protocol(void);
317 void set_Protocol(enum protocol_types p);
318 void gfree_names(void);
319 void gfree_all( void );
320 const char *my_netbios_names(int i);
321 bool set_netbios_aliases(const char **str_array);
322 bool init_names(void);
323 bool file_exist_stat(const char *fname,SMB_STRUCT_STAT *sbuf,
324 bool fake_dir_create_times);
325 bool socket_exist(const char *fname);
326 uint64_t get_file_size_stat(const SMB_STRUCT_STAT *sbuf);
327 bool check_same_dev_ino(const SMB_STRUCT_STAT *sbuf1,
328 const SMB_STRUCT_STAT *sbuf2);
329 bool check_same_stat(const SMB_STRUCT_STAT *sbuf1,
330 const SMB_STRUCT_STAT *sbuf2);
331 void show_msg(const char *buf);
332 int set_message_bcc(char *buf,int num_bytes);
333 ssize_t message_push_blob(uint8_t **outbuf, DATA_BLOB blob);
334 char *unix_clean_name(TALLOC_CTX *ctx, const char *s);
335 char *clean_name(TALLOC_CTX *ctx, const char *s);
336 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, off_t pos);
337 NTSTATUS init_before_fork(void);
338 NTSTATUS reinit_after_fork(struct messaging_context *msg_ctx,
339 struct tevent_context *ev_ctx,
340 bool parent_longlived,
341 const char *comment);
342 NTSTATUS smbd_reinit_after_fork(struct messaging_context *msg_ctx,
343 struct tevent_context *ev_ctx,
344 bool parent_longlived,
345 const char *comment);
346 void *malloc_(size_t size);
347 void *Realloc(void *p, size_t size, bool free_old_on_error);
348 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
349 void *element, void *_array, uint32_t *num_elements,
350 ssize_t *array_size);
351 char *get_myname(TALLOC_CTX *ctx);
352 char *get_mydnsdomname(TALLOC_CTX *ctx);
353 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name);
354 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name);
355 bool process_exists(const struct server_id pid);
356 const char *uidtoname(uid_t uid);
357 char *gidtoname(gid_t gid);
358 uid_t nametouid(const char *name);
359 gid_t nametogid(const char *name);
360 void smb_panic_s3(const char *why);
361 const char *readdirname(DIR *p);
362 bool is_in_path(const char *name, name_compare_entry *namelist, bool case_sensitive);
363 void set_namearray(name_compare_entry **ppname_array, const char *namelist);
364 void free_namearray(name_compare_entry *name_array);
365 bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
366 bool fcntl_getlock(int fd, int op, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
367 int map_process_lock_to_ofd_lock(int op);
368 bool is_myname(const char *s);
369 void ra_lanman_string( const char *native_lanman );
370 const char *get_remote_arch_str(void);
371 enum remote_arch_types get_remote_arch_from_str(const char *remote_arch_string);
372 void set_remote_arch(enum remote_arch_types type);
373 enum remote_arch_types get_remote_arch(void);
374 bool remote_arch_cache_update(const struct GUID *client_guid);
375 bool remote_arch_cache_delete(const struct GUID *client_guid);
376 const char *tab_depth(int level, int depth);
377 int str_checksum(const char *s);
378 void zero_free(void *p, size_t size);
379 int set_maxfiles(int requested_max);
380 int smb_mkstemp(char *name_template);
381 void *smb_xmalloc_array(size_t size, unsigned int count);
382 char *myhostname(void);
383 char *myhostname_upper(void);
384 #include "lib/util_path.h"
385 bool parent_dirname(TALLOC_CTX *mem_ctx, const char *dir, char **parent,
387 bool ms_has_wild(const char *s);
388 bool ms_has_wild_w(const smb_ucs2_t *s);
389 bool mask_match(const char *string, const char *pattern, bool is_case_sensitive);
390 bool mask_match_search(const char *string, const char *pattern, bool is_case_sensitive);
391 bool mask_match_list(const char *string, char **list, int listLen, bool is_case_sensitive);
392 #include "lib/util/unix_match.h"
393 bool name_to_fqdn(fstring fqdn, const char *name);
394 uint32_t map_share_mode_to_deny_mode(uint32_t share_access, uint32_t private_options);
396 #include "lib/util_procid.h"
398 #define serverid_equal(p1, p2) server_id_equal(p1,p2)
399 struct server_id interpret_pid(const char *pid_string);
400 bool is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off);
401 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off);
402 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off);
403 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval);
404 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval);
405 bool split_domain_user(TALLOC_CTX *mem_ctx,
406 const char *full_name,
409 const char *strip_hostname(const char *s);
410 bool any_nt_status_not_ok(NTSTATUS err1, NTSTATUS err2, NTSTATUS *result);
411 int timeval_to_msec(struct timeval t);
412 char *valid_share_pathname(TALLOC_CTX *ctx, const char *dos_pathname);
413 bool is_executable(const char *fname);
414 bool map_open_params_to_ntcreate(const char *smb_base_fname,
415 int deny_mode, int open_func,
416 uint32_t *paccess_mask,
417 uint32_t *pshare_mode,
418 uint32_t *pcreate_disposition,
419 uint32_t *pcreate_options,
420 uint32_t *pprivate_flags);
421 struct security_unix_token *copy_unix_token(TALLOC_CTX *ctx, const struct security_unix_token *tok);
422 struct security_unix_token *root_unix_token(TALLOC_CTX *mem_ctx);
423 bool dir_check_ftype(uint32_t mode, uint32_t dirtype);
425 /* The following definitions come from lib/util_builtin.c */
427 bool lookup_builtin_rid(TALLOC_CTX *mem_ctx, uint32_t rid, const char **name);
428 bool lookup_builtin_name(const char *name, uint32_t *rid);
429 const char *builtin_domain_name(void);
430 bool sid_check_is_builtin(const struct dom_sid *sid);
431 bool sid_check_is_in_builtin(const struct dom_sid *sid);
432 bool sid_check_is_wellknown_builtin(const struct dom_sid *sid);
434 /* The following definitions come from lib/util_nscd.c */
436 void smb_nscd_flush_user_cache(void);
437 void smb_nscd_flush_group_cache(void);
439 /* The following definitions come from lib/util_nttoken.c */
441 struct security_token *dup_nt_token(TALLOC_CTX *mem_ctx, const struct security_token *ptoken);
442 NTSTATUS merge_nt_token(TALLOC_CTX *mem_ctx,
443 const struct security_token *token_1,
444 const struct security_token *token_2,
445 struct security_token **token_out);
446 bool token_sid_in_ace(const struct security_token *token, const struct security_ace *ace);
448 /* The following definitions come from lib/util_sec.c */
451 uid_t sec_initial_uid(void);
452 gid_t sec_initial_gid(void);
453 bool root_mode(void);
454 bool non_root_mode(void);
455 void gain_root_privilege(void);
456 void gain_root_group_privilege(void);
457 void set_effective_uid(uid_t uid);
458 void set_effective_gid(gid_t gid);
459 void save_re_uid(void);
460 void restore_re_uid_fromroot(void);
461 void restore_re_uid(void);
462 void save_re_gid(void);
463 void restore_re_gid(void);
464 int set_re_uid(void);
465 void become_user_permanently(uid_t uid, gid_t gid);
466 int set_thread_credentials(uid_t uid,
469 const gid_t *gidset);
470 bool is_setuid_root(void) ;
472 /* The following definitions come from lib/util_sid.c */
474 char *sid_to_fstring(fstring sidstr_out, const struct dom_sid *sid);
475 bool sid_linearize(uint8_t *outbuf, size_t len, const struct dom_sid *sid);
476 bool non_mappable_sid(struct dom_sid *sid);
477 char *sid_binstring_hex_talloc(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
478 struct netr_SamInfo3;
479 NTSTATUS sid_array_from_info3(TALLOC_CTX *mem_ctx,
480 const struct netr_SamInfo3 *info3,
481 struct dom_sid **user_sids,
482 uint32_t *num_user_sids,
483 bool include_user_group_rid);
485 /* The following definitions come from lib/util_sock.c */
487 bool is_broadcast_addr(const struct sockaddr *pss);
488 bool is_loopback_ip_v4(struct in_addr ip);
489 bool is_loopback_addr(const struct sockaddr *pss);
490 bool is_zero_addr(const struct sockaddr_storage *pss);
491 void zero_ip_v4(struct in_addr *ip);
492 void in_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
494 bool same_net(const struct sockaddr *ip1,
495 const struct sockaddr *ip2,
496 const struct sockaddr *mask);
497 bool sockaddr_equal(const struct sockaddr *ip1,
498 const struct sockaddr *ip2);
499 bool is_address_any(const struct sockaddr *psa);
500 uint16_t get_sockaddr_port(const struct sockaddr_storage *pss);
501 char *print_sockaddr(char *dest,
503 const struct sockaddr_storage *psa);
504 char *print_canonical_sockaddr(TALLOC_CTX *ctx,
505 const struct sockaddr_storage *pss);
506 int get_socket_port(int fd);
507 const char *client_addr(int fd, char *addr, size_t addrlen);
508 const char *client_socket_addr(int fd, char *addr, size_t addr_len);
509 int client_socket_port(int fd);
510 bool is_a_socket(int fd);
511 void set_socket_options(int fd, const char *options);
512 ssize_t read_udp_v4_socket(int fd,
515 struct sockaddr_storage *psa);
516 NTSTATUS read_fd_with_timeout(int fd, char *buf,
517 size_t mincnt, size_t maxcnt,
518 unsigned int time_out,
520 NTSTATUS read_data_ntstatus(int fd, char *buffer, size_t N);
522 bool send_keepalive(int client);
523 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
524 unsigned int timeout,
526 NTSTATUS receive_smb_raw(int fd,
529 unsigned int timeout,
532 int open_socket_in(int type,
535 const struct sockaddr_storage *psock,
537 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
538 int timeout, int *pfd);
539 struct tevent_req *open_socket_out_send(TALLOC_CTX *mem_ctx,
540 struct tevent_context *ev,
541 const struct sockaddr_storage *pss,
544 NTSTATUS open_socket_out_recv(struct tevent_req *req, int *pfd);
545 struct tevent_req *open_socket_out_defer_send(TALLOC_CTX *mem_ctx,
546 struct tevent_context *ev,
547 struct timeval wait_time,
548 const struct sockaddr_storage *pss,
551 NTSTATUS open_socket_out_defer_recv(struct tevent_req *req, int *pfd);
552 int open_udp_socket(const char *host, int port);
553 const char *get_peer_addr(int fd, char *addr, size_t addr_len);
555 struct tsocket_address;
557 int get_remote_hostname(const struct tsocket_address *remote_address,
559 TALLOC_CTX *mem_ctx);
561 int create_pipe_sock(const char *socket_dir,
562 const char *socket_name,
564 const char *get_mydnsfullname(void);
565 bool is_myname_or_ipaddr(const char *s);
566 int poll_one_fd(int fd, int events, int timeout, int *revents);
567 int poll_intr_one_fd(int fd, int events, int timeout, int *revents);
569 /* The following definitions come from lib/util_str.c */
571 bool next_token(const char **ptr, char *buff, const char *sep, size_t bufsize);
572 bool strnequal(const char *s1,const char *s2,size_t n);
573 bool strcsequal(const char *s1,const char *s2);
574 bool strnorm(char *s, int case_default);
575 char *push_skip_string(char *buf);
576 char *skip_string(const char *base, size_t len, char *buf);
577 size_t str_charnum(const char *s);
578 bool trim_char(char *s,char cfront,char cback);
579 bool strhasupper(const char *s);
580 bool strhaslower(const char *s);
581 bool in_list(const char *s, const char *list, bool casesensitive);
582 void fstring_sub(char *s,const char *pattern,const char *insert);
583 char *realloc_string_sub2(char *string,
586 bool remove_unsafe_characters,
587 bool allow_trailing_dollar);
588 char *realloc_string_sub(char *string,
591 char *talloc_string_sub2(TALLOC_CTX *mem_ctx, const char *src,
594 bool remove_unsafe_characters,
596 bool allow_trailing_dollar);
597 char *talloc_string_sub(TALLOC_CTX *mem_ctx,
601 void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
602 char *talloc_all_string_sub(TALLOC_CTX *ctx,
606 char *octal_string(int i);
607 char *string_truncate(char *s, unsigned int length);
608 char *strchr_m(const char *src, char c);
609 char *strrchr_m(const char *s, char c);
610 char *strnrchr_m(const char *s, char c, unsigned int n);
611 char *strstr_m(const char *src, const char *findstr);
612 bool strlower_m(char *s);
613 bool strupper_m(char *s);
614 size_t strlen_m(const char *s);
615 size_t strlen_m_term(const char *s);
616 size_t strlen_m_term_null(const char *s);
617 int fstr_sprintf(fstring s, const char *fmt, ...);
618 bool str_list_sub_basic( char **list, const char *smb_name,
619 const char *domain_name );
620 bool str_list_substitute(char **list, const char *pattern, const char *insert);
622 char *ipstr_list_make(char **ipstr_list,
623 const struct ip_service *ip_list,
625 int ipstr_list_parse(const char *ipstr_list, struct ip_service **ip_list);
626 void ipstr_list_free(char* ipstr_list);
627 uint64_t STR_TO_SMB_BIG_UINT(const char *nptr, const char **entptr);
628 uint64_t conv_str_size(const char * str);
629 int asprintf_strupper_m(char **strp, const char *fmt, ...)
630 PRINTF_ATTRIBUTE(2,3);
631 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...)
632 PRINTF_ATTRIBUTE(2,3);
633 char *talloc_asprintf_strlower_m(TALLOC_CTX *t, const char *fmt, ...)
634 PRINTF_ATTRIBUTE(2,3);
635 bool validate_net_name( const char *name,
636 const char *invalid_chars,
638 char *escape_shell_string(const char *src);
639 ssize_t full_path_tos(const char *dir, const char *name,
640 char *tmpbuf, size_t tmpbuf_len,
641 char **pdst, char **to_free);
643 /* The following definitions come from lib/version.c */
645 const char *samba_version_string(void);
647 /* The following definitions come from lib/wins_srv.c */
649 bool wins_srv_is_dead(struct in_addr wins_ip, struct in_addr src_ip);
650 void wins_srv_alive(struct in_addr wins_ip, struct in_addr src_ip);
651 void wins_srv_died(struct in_addr wins_ip, struct in_addr src_ip);
652 unsigned wins_srv_count(void);
653 char **wins_srv_tags(void);
654 void wins_srv_tags_free(char **list);
655 struct in_addr wins_srv_ip_tag(const char *tag, struct in_addr src_ip);
656 bool wins_server_tag_ips(const char *tag, TALLOC_CTX *mem_ctx,
657 struct in_addr **pservers, int *pnum_servers);
658 unsigned wins_srv_count_tag(const char *tag);
660 #ifndef ASN1_MAX_OIDS
661 #define ASN1_MAX_OIDS 20
663 bool spnego_parse_negTokenInit(TALLOC_CTX *ctx,
665 char *OIDs[ASN1_MAX_OIDS],
668 DATA_BLOB spnego_gen_krb5_wrap(TALLOC_CTX *ctx, const DATA_BLOB ticket, const uint8_t tok_id[2]);
670 /* The following definitions come from libsmb/conncache.c */
672 NTSTATUS check_negative_conn_cache( const char *domain, const char *server);
673 void add_failed_connection_entry(const char *domain, const char *server, NTSTATUS result) ;
674 void flush_negative_conn_cache_for_domain(const char *domain);
676 /* The following definitions come from libsmb/errormap.c */
678 NTSTATUS dos_to_ntstatus(uint8_t eclass, uint32_t ecode);
680 /* The following definitions come from libsmb/namecache.c */
682 bool namecache_store(const char *name,
685 struct ip_service *ip_list);
686 bool namecache_fetch(const char *name,
688 struct ip_service **ip_list,
690 bool namecache_delete(const char *name, int name_type);
691 void namecache_flush(void);
692 bool namecache_status_store(const char *keyname, int keyname_type,
693 int name_type, const struct sockaddr_storage *keyip,
694 const char *srvname);
695 bool namecache_status_fetch(const char *keyname,
698 const struct sockaddr_storage *keyip,
701 /* The following definitions come from libsmb/namequery_dc.c */
703 bool get_dc_name(const char *domain,
706 struct sockaddr_storage *ss_out);
708 /* The following definitions come from libsmb/smberr.c */
710 const char *smb_dos_err_name(uint8_t e_class, uint16_t num);
711 const char *get_dos_error_msg(WERROR result);
712 const char *smb_dos_err_class(uint8_t e_class);
713 WERROR map_werror_from_unix(int error);
715 /* The following definitions come from libsmb/trusts_util.c */
717 struct netlogon_creds_cli_context;
718 struct messaging_context;
719 struct dcerpc_binding_handle;
720 char *trust_pw_new_value(TALLOC_CTX *mem_ctx,
721 enum netr_SchannelType sec_channel_type,
723 NTSTATUS trust_pw_change(struct netlogon_creds_cli_context *context,
724 struct messaging_context *msg_ctx,
725 struct dcerpc_binding_handle *b,
730 /* The following definitions come from param/loadparm.c */
732 #include "source3/param/param_proto.h"
734 char *lp_servicename(TALLOC_CTX *ctx, int);
735 const char *lp_const_servicename(int);
736 bool lp_autoloaded(int);
737 const char *lp_dnsdomain(void);
738 int lp_winbind_max_domain_connections(void);
739 bool lp_idmap_range(const char *domain_name, uint32_t *low, uint32_t *high);
740 bool lp_idmap_default_range(uint32_t *low, uint32_t *high);
741 const char *lp_idmap_backend(const char *domain_name);
742 const char *lp_idmap_default_backend (void);
743 int lp_security(void);
744 int lp_client_max_protocol(void);
745 int lp_client_ipc_min_protocol(void);
746 int lp_client_ipc_max_protocol(void);
747 int lp_client_ipc_signing(void);
748 int lp_smb2_max_credits(void);
749 int lp_cups_encrypt(void);
750 bool lp_widelinks(int );
751 int lp_rpc_low_port(void);
752 int lp_rpc_high_port(void);
753 bool lp_lanman_auth(void);
755 int lp_wi_scan_global_parametrics(
756 const char *regex, size_t max_matches,
757 bool (*cb)(const char *string, regmatch_t matches[],
761 char *lp_parm_talloc_string(TALLOC_CTX *ctx, int snum, const char *type, const char *option, const char *def);
762 const char *lp_parm_const_string(int snum, const char *type, const char *option, const char *def);
763 struct loadparm_service;
764 const char *lp_parm_const_string_service(struct loadparm_service *service, const char *type,
765 const char *option, const char *def);
766 const char **lp_parm_string_list(int snum, const char *type, const char *option, const char **def);
767 int lp_parm_int(int snum, const char *type, const char *option, int def);
768 unsigned long lp_parm_ulong(int snum, const char *type, const char *option, unsigned long def);
769 unsigned long long lp_parm_ulonglong(int snum, const char *type,
771 unsigned long long def);
772 bool lp_parm_bool(int snum, const char *type, const char *option, bool def);
774 int lp_parm_enum(int snum, const char *type, const char *option,
775 const struct enum_list *_enum, int def);
776 char *canonicalize_servicename(TALLOC_CTX *ctx, const char *src);
777 bool lp_add_home(const char *pszHomename, int iDefaultService,
778 const char *user, const char *pszHomedir);
779 int lp_add_service(const char *pszService, int iDefaultService);
780 bool lp_add_printer(const char *pszPrintername, int iDefaultService);
781 bool lp_parameter_is_valid(const char *pszParmName);
782 bool lp_parameter_is_global(const char *pszParmName);
783 bool lp_canonicalize_parameter(const char *parm_name, const char **canon_parm,
785 bool lp_canonicalize_parameter_with_value(const char *parm_name,
787 const char **canon_parm,
788 const char **canon_val);
789 void show_parameter_list(void);
790 bool lp_invert_boolean(const char *str, const char **inverse_str);
791 bool lp_canonicalize_boolean(const char *str, const char**canon_str);
792 bool process_registry_service(const char *service_name);
793 bool process_registry_shares(void);
794 bool lp_config_backend_is_registry(void);
795 bool lp_config_backend_is_file(void);
796 bool lp_file_list_changed(void);
797 const char *lp_ldap_machine_suffix(TALLOC_CTX *ctx);
798 const char *lp_ldap_user_suffix(TALLOC_CTX *ctx);
799 const char *lp_ldap_group_suffix(TALLOC_CTX *ctx);
800 const char *lp_ldap_idmap_suffix(TALLOC_CTX *ctx);
802 /* Return a pointer to a service by name. */
803 struct loadparm_service *lp_service(const char *pszServiceName);
804 struct loadparm_service *lp_servicebynum(int snum);
805 struct loadparm_service *lp_default_loadparm_service(void);
806 void *lp_parm_ptr(struct loadparm_service *service, struct parm_struct *parm);
807 void *lp_local_ptr_by_snum(int snum, struct parm_struct *parm);
808 bool lp_do_parameter(int snum, const char *pszParmName, const char *pszParmValue);
809 bool lp_set_cmdline(const char *pszParmName, const char *pszParmValue);
810 bool dump_a_parameter(int snum, char *parm_name, FILE * f, bool isGlobal);
811 bool lp_snum_ok(int iService);
812 void lp_add_one_printer(const char *name, const char *comment,
813 const char *location, void *pdata);
814 bool lp_loaded(void);
815 void lp_killunused(struct smbd_server_connection *sconn,
816 bool (*snumused) (struct smbd_server_connection *, int));
817 void lp_kill_all_services(void);
818 void lp_killservice(int iServiceIn);
819 const char* server_role_str(uint32_t role);
820 enum usershare_err parse_usershare_file(TALLOC_CTX *ctx,
821 SMB_STRUCT_STAT *psbuf,
822 const char *servicename,
828 char **pp_cp_share_name,
829 struct security_descriptor **ppsd,
831 int load_usershare_service(const char *servicename);
832 int load_usershare_shares(struct smbd_server_connection *sconn,
833 bool (*snumused) (struct smbd_server_connection *, int));
834 void gfree_loadparm(void);
835 bool lp_load_initial_only(const char *pszFname);
836 bool lp_load_global(const char *file_name);
837 bool lp_load_with_shares(const char *file_name);
838 bool lp_load_client(const char *file_name);
839 bool lp_load_global_no_reinit(const char *file_name);
840 bool lp_load_no_reinit(const char *file_name);
841 bool lp_load_client_no_reinit(const char *file_name);
842 bool lp_load_with_registry_shares(const char *pszFname);
843 int lp_numservices(void);
844 void lp_dump(FILE *f, bool show_defaults, int maxtoprint);
845 void lp_dump_one(FILE * f, bool show_defaults, int snum);
846 int lp_servicenumber(const char *pszServiceName);
847 const char *volume_label(TALLOC_CTX *ctx, int snum);
848 bool lp_domain_master(void);
849 bool lp_preferred_master(void);
850 void lp_remove_service(int snum);
851 void lp_copy_service(int snum, const char *new_name);
852 int lp_default_server_announce(void);
853 const char *lp_printername(TALLOC_CTX *ctx, int snum);
854 void lp_set_logfile(const char *name);
855 int lp_maxprintjobs(int snum);
856 const char *lp_printcapname(void);
857 bool lp_disable_spoolss( void );
858 void lp_set_spoolss_state( uint32_t state );
859 uint32_t lp_get_spoolss_state( void );
860 struct smb_signing_state;
861 bool lp_use_sendfile(int snum, struct smb_signing_state *signing_state);
862 void set_use_sendfile(int snum, bool val);
863 void lp_set_mangling_method(const char *new_method);
864 bool lp_posix_pathnames(void);
865 void lp_set_posix_pathnames(void);
866 enum brl_flavour lp_posix_cifsu_locktype(files_struct *fsp);
867 void lp_set_posix_default_cifsx_readwrite_locktype(enum brl_flavour val);
868 int lp_min_receive_file_size(void);
869 char* lp_perfcount_module(TALLOC_CTX *ctx);
870 void widelinks_warning(int snum);
871 const char *lp_ncalrpc_dir(void);
872 void _lp_set_server_role(int server_role);
874 /* The following definitions come from param/loadparm_ctx.c */
876 const struct loadparm_s3_helpers *loadparm_s3_helpers(void);
878 /* The following definitions come from param/loadparm_server_role.c */
880 int lp_server_role(void);
881 void set_server_role(void);
883 /* The following definitions come from param/util.c */
885 uint32_t get_int_param( const char* param );
886 char* get_string_param( const char* param );
888 /* The following definitions come from lib/server_contexts.c */
889 struct tevent_context *global_event_context(void);
890 void global_event_context_free(void);
891 struct messaging_context *global_messaging_context(void);
892 void global_messaging_context_free(void);
894 /* The following definitions come from lib/sessionid_tdb.c */
896 NTSTATUS sessionid_traverse_read(int (*fn)(const char *key,
897 struct sessionid *session,
901 /* The following definitions come from utils/passwd_util.c */
903 char *stdin_new_passwd( void);
904 char *get_pass( const char *prompt, bool stdin_get);
906 /* The following definitions come from lib/avahi.c */
908 struct AvahiPoll *tevent_avahi_poll(TALLOC_CTX *mem_ctx,
909 struct tevent_context *ev);
911 /* The following definitions come from libsmb/smbsock_connect.c */
913 struct tevent_req *smbsock_connect_send(TALLOC_CTX *mem_ctx,
914 struct tevent_context *ev,
915 const struct sockaddr_storage *addr,
917 const char *called_name,
919 const char *calling_name,
921 NTSTATUS smbsock_connect_recv(struct tevent_req *req, int *sock,
923 NTSTATUS smbsock_connect(const struct sockaddr_storage *addr, uint16_t port,
924 const char *called_name, int called_type,
925 const char *calling_name, int calling_type,
926 int *pfd, uint16_t *ret_port, int sec_timeout);
928 struct tevent_req *smbsock_any_connect_send(TALLOC_CTX *mem_ctx,
929 struct tevent_context *ev,
930 const struct sockaddr_storage *addrs,
931 const char **called_names,
933 const char **calling_names,
935 size_t num_addrs, uint16_t port);
936 NTSTATUS smbsock_any_connect_recv(struct tevent_req *req, int *pfd,
937 size_t *chosen_index, uint16_t *chosen_port);
938 NTSTATUS smbsock_any_connect(const struct sockaddr_storage *addrs,
939 const char **called_names,
941 const char **calling_names,
946 int *pfd, size_t *chosen_index,
947 uint16_t *chosen_port);
949 /* The following definitions come from lib/util_wellknown.c */
951 bool sid_check_is_wellknown_domain(const struct dom_sid *sid, const char **name);
952 bool sid_check_is_in_wellknown_domain(const struct dom_sid *sid);
953 bool lookup_wellknown_sid(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
954 const char **domain, const char **name);
955 bool lookup_wellknown_name(TALLOC_CTX *mem_ctx, const char *name,
956 struct dom_sid *sid, const char **domain);
958 /* The following definitions come from lib/util_specialsids.c */
959 bool sid_check_is_asserted_identity(const struct dom_sid *sid);
960 bool sid_check_is_in_asserted_identity(const struct dom_sid *sid);
961 const char *asserted_identity_domain_name(void);
963 /* The following definitions come from lib/filename_util.c */
965 NTSTATUS get_full_smb_filename(TALLOC_CTX *ctx, const struct smb_filename *smb_fname,
967 struct smb_filename *synthetic_smb_fname(TALLOC_CTX *mem_ctx,
968 const char *base_name,
969 const char *stream_name,
970 const SMB_STRUCT_STAT *psbuf,
972 struct smb_filename *synthetic_smb_fname_split(TALLOC_CTX *ctx,
975 const char *smb_fname_str_dbg(const struct smb_filename *smb_fname);
976 const char *fsp_str_dbg(const struct files_struct *fsp);
977 const char *fsp_fnum_dbg(const struct files_struct *fsp);
978 struct smb_filename *cp_smb_filename(TALLOC_CTX *mem_ctx,
979 const struct smb_filename *in);
980 struct smb_filename *cp_smb_filename_nostream(TALLOC_CTX *mem_ctx,
981 const struct smb_filename *in);
982 bool is_ntfs_stream_smb_fname(const struct smb_filename *smb_fname);
983 bool is_ntfs_default_stream_smb_fname(const struct smb_filename *smb_fname);
984 bool is_invalid_windows_ea_name(const char *name);
985 bool ea_list_has_invalid_name(struct ea_list *ea_list);
986 bool split_stream_filename(TALLOC_CTX *ctx,
987 const char *filename_in,
989 char **streamname_out);
991 /* The following definitions come from lib/dummyroot.c */
993 void become_root(void);
994 void unbecome_root(void);
996 /* The following definitions come from lib/smbd_shim.c */
998 int find_service(TALLOC_CTX *ctx, const char *service_in, char **p_service_out);
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_ */