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 #include "lib/gencache.h"
85 /* The following definitions come from lib/interface.c */
87 bool ismyaddr(const struct sockaddr *ip);
88 bool ismyip_v4(struct in_addr ip);
89 bool is_local_net(const struct sockaddr *from);
90 void setup_linklocal_scope_id(struct sockaddr *pss);
91 bool is_local_net_v4(struct in_addr from);
92 int iface_count(void);
93 int iface_count_v4_nl(void);
94 const struct in_addr *first_ipv4_iface(void);
95 struct interface *get_interface(int n);
96 const struct sockaddr_storage *iface_n_sockaddr_storage(int n);
97 const struct in_addr *iface_n_ip_v4(int n);
98 const struct in_addr *iface_n_bcast_v4(int n);
99 const struct sockaddr_storage *iface_n_bcast(int n);
100 const struct sockaddr_storage *iface_ip(const struct sockaddr *ip);
101 bool iface_local(const struct sockaddr *ip);
102 void load_interfaces(void);
103 void gfree_interfaces(void);
104 bool interfaces_changed(void);
106 /* The following definitions come from lib/ldap_debug_handler.c */
108 void init_ldap_debugging(void);
110 /* The following definitions come from lib/ldap_escape.c */
112 char *escape_ldap_string(TALLOC_CTX *mem_ctx, const char *s);
113 char *escape_rdn_val_string_alloc(const char *s);
115 /* The following definitions come from lib/ms_fnmatch.c */
117 int ms_fnmatch(const char *pattern, const char *string, bool translate_pattern,
118 bool is_case_sensitive);
120 /* The following definitions come from lib/recvfile.c */
122 ssize_t sys_recvfile(int fromfd,
126 ssize_t sys_recvfile(int fromfd,
130 ssize_t drain_socket(int sockfd, size_t count);
132 /* The following definitions come from lib/sendfile.c */
134 ssize_t sys_sendfile(int tofd, int fromfd, const DATA_BLOB *header, off_t offset, size_t count);
136 /* The following definitions come from lib/server_mutex.c */
138 struct named_mutex *grab_named_mutex(TALLOC_CTX *mem_ctx, const char *name,
141 /* The following definitions come from lib/sharesec.c */
143 bool share_info_db_init(void);
144 struct security_descriptor *get_share_security_default( TALLOC_CTX *ctx, size_t *psize, uint32_t def_access);
145 struct security_descriptor *get_share_security( TALLOC_CTX *ctx, const char *servicename,
147 bool set_share_security(const char *share_name, struct security_descriptor *psd);
148 bool delete_share_security(const char *servicename);
149 bool share_access_check(const struct security_token *token,
150 const char *sharename,
151 uint32_t desired_access,
153 bool parse_usershare_acl(TALLOC_CTX *ctx, const char *acl_str, struct security_descriptor **ppsd);
155 /* The following definitions come from lib/smbrun.c */
157 int smbrun_no_sanitize(const char *cmd, int *outfd, char * const *env);
158 int smbrun(const char *cmd, int *outfd, char * const *env);
159 int smbrunsecret(const char *cmd, const char *secret);
161 /* The following definitions come from lib/substitute.c */
163 void free_local_machine_name(void);
164 bool set_local_machine_name(const char *local_name, bool perm);
165 const char *get_local_machine_name(void);
166 bool set_remote_machine_name(const char *remote_name, bool perm);
167 const char *get_remote_machine_name(void);
168 void sub_set_smb_name(const char *name);
169 void set_current_user_info(const char *smb_name, const char *unix_name,
171 void sub_set_socket_ids(const char *peeraddr, const char *peername,
172 const char *sockaddr);
173 const char *get_current_username(void);
174 void standard_sub_basic(const char *smb_name, const char *domain_name,
175 char *str, size_t len);
176 char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name,
177 const char *domain_name, const char *str);
178 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
179 const char *input_string,
180 const char *username,
185 char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
186 const char *servicename, const char *user,
187 const char *connectpath, gid_t gid,
188 const char *smb_name, const char *domain_name,
190 void standard_sub_advanced(const char *servicename, const char *user,
191 const char *connectpath, gid_t gid,
192 const char *smb_name, const char *domain_name,
193 char *str, size_t len);
195 /* The following definitions come from lib/sysquotas.c */
197 int sys_get_quota(const char *path, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
198 int sys_set_quota(const char *path, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
200 /* The following definitions come from lib/sysquotas_*.c */
202 int sys_get_vfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
203 int sys_set_vfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
205 int sys_get_xfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
206 int sys_set_xfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
208 int sys_get_nfs_quota(const char *path, const char *bdev,
209 enum SMB_QUOTA_TYPE qtype,
210 unid_t id, SMB_DISK_QUOTA *dp);
211 int sys_set_nfs_quota(const char *path, const char *bdev,
212 enum SMB_QUOTA_TYPE qtype,
213 unid_t id, SMB_DISK_QUOTA *dp);
215 /* The following definitions come from lib/system.c */
217 ssize_t sys_send(int s, const void *msg, size_t len, int flags);
218 ssize_t sys_recvfrom(int s, void *buf, size_t len, int flags, struct sockaddr *from, socklen_t *fromlen);
219 int sys_fcntl_ptr(int fd, int cmd, void *arg);
220 int sys_fcntl_long(int fd, int cmd, long arg);
221 void update_stat_ex_mtime(struct stat_ex *dst, struct timespec write_ts);
222 void update_stat_ex_create_time(struct stat_ex *dst, struct timespec create_time);
223 int sys_stat(const char *fname, SMB_STRUCT_STAT *sbuf,
224 bool fake_dir_create_times);
225 int sys_fstat(int fd, SMB_STRUCT_STAT *sbuf,
226 bool fake_dir_create_times);
227 int sys_lstat(const char *fname,SMB_STRUCT_STAT *sbuf,
228 bool fake_dir_create_times);
229 int sys_posix_fallocate(int fd, off_t offset, off_t len);
230 int sys_fallocate(int fd, uint32_t mode, off_t offset, off_t len);
231 void kernel_flock(int fd, uint32_t share_mode, uint32_t access_mask);
232 DIR *sys_fdopendir(int fd);
233 int sys_mknod(const char *path, mode_t mode, SMB_DEV_T dev);
234 char *sys_getwd(void);
235 void set_effective_capability(enum smbd_capability capability);
236 void drop_effective_capability(enum smbd_capability capability);
237 long sys_random(void);
238 void sys_srandom(unsigned int seed);
239 int groups_max(void);
240 int sys_getgroups(int setlen, gid_t *gidset);
241 int sys_setgroups(gid_t UNUSED(primary_gid), int setlen, gid_t *gidset);
242 uint32_t unix_dev_major(SMB_DEV_T dev);
243 uint32_t unix_dev_minor(SMB_DEV_T dev);
244 char *sys_realpath(const char *path);
246 int sys_get_number_of_cores(void);
250 void init_stat_ex_from_stat (struct stat_ex *dst,
251 const struct stat *src,
252 bool fake_dir_create_times);
254 /* The following definitions come from lib/system_smbd.c */
256 bool getgroups_unix_user(TALLOC_CTX *mem_ctx, const char *user,
258 gid_t **ret_groups, uint32_t *p_ngroups);
260 /* The following definitions come from lib/tallocmsg.c */
262 void register_msg_pool_usage(struct messaging_context *msg_ctx);
264 /* The following definitions come from lib/time.c */
266 void push_dos_date(uint8_t *buf, int offset, time_t unixdate, int zone_offset);
267 void push_dos_date2(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
268 void push_dos_date3(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
269 uint32_t convert_time_t_to_uint32_t(time_t t);
270 time_t convert_uint32_t_to_time_t(uint32_t u);
271 bool nt_time_is_zero(const NTTIME *nt);
272 time_t generalized_to_unix_time(const char *str);
273 int get_server_zone_offset(void);
274 int set_server_zone_offset(time_t t);
275 char *timeval_string(TALLOC_CTX *ctx, const struct timeval *tp, bool hires);
276 char *current_timestring(TALLOC_CTX *ctx, bool hires);
277 void srv_put_dos_date(char *buf,int offset,time_t unixdate);
278 void srv_put_dos_date2(char *buf,int offset, time_t unixdate);
279 void srv_put_dos_date3(char *buf,int offset,time_t unixdate);
280 void round_timespec(enum timestamp_set_resolution res, struct timespec *ts);
281 void put_long_date_timespec(enum timestamp_set_resolution res, char *p, struct timespec ts);
282 void put_long_date(char *p, time_t t);
283 void dos_filetime_timespec(struct timespec *tsp);
284 time_t make_unix_date(const void *date_ptr, int zone_offset);
285 time_t make_unix_date2(const void *date_ptr, int zone_offset);
286 time_t make_unix_date3(const void *date_ptr, int zone_offset);
287 time_t srv_make_unix_date(const void *date_ptr);
288 time_t srv_make_unix_date2(const void *date_ptr);
289 time_t srv_make_unix_date3(const void *date_ptr);
290 struct timespec interpret_long_date(const char *p);
292 void get_process_uptime(struct timeval *ret_time);
293 void get_startup_time(struct timeval *ret_time);
294 time_t nt_time_to_unix_abs(const NTTIME *nt);
295 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src);
296 void unix_to_nt_time_abs(NTTIME *nt, time_t t);
297 const char *time_to_asc(const time_t t);
298 const char *display_time(NTTIME nttime);
299 bool nt_time_is_set(const NTTIME *nt);
301 /* The following definitions come from lib/username.c */
303 void flush_pwnam_cache(void);
304 char *get_user_home_dir(TALLOC_CTX *mem_ctx, const char *user);
305 struct passwd *Get_Pwnam_alloc(TALLOC_CTX *mem_ctx, const char *user);
307 /* The following definitions come from lib/util_names.c */
308 const char *get_global_sam_name(void);
309 const char *my_sam_name(void);
311 /* The following definitions come from lib/util.c */
313 enum protocol_types get_Protocol(void);
314 void set_Protocol(enum protocol_types p);
315 void gfree_names(void);
316 void gfree_all( void );
317 const char *my_netbios_names(int i);
318 bool set_netbios_aliases(const char **str_array);
319 bool init_names(void);
320 bool file_exist_stat(const char *fname,SMB_STRUCT_STAT *sbuf,
321 bool fake_dir_create_times);
322 bool socket_exist(const char *fname);
323 uint64_t get_file_size_stat(const SMB_STRUCT_STAT *sbuf);
324 bool check_same_dev_ino(const SMB_STRUCT_STAT *sbuf1,
325 const SMB_STRUCT_STAT *sbuf2);
326 bool check_same_stat(const SMB_STRUCT_STAT *sbuf1,
327 const SMB_STRUCT_STAT *sbuf2);
328 void show_msg(const char *buf);
329 int set_message_bcc(char *buf,int num_bytes);
330 ssize_t message_push_blob(uint8_t **outbuf, DATA_BLOB blob);
331 char *unix_clean_name(TALLOC_CTX *ctx, const char *s);
332 char *clean_name(TALLOC_CTX *ctx, const char *s);
333 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, off_t pos);
334 int set_blocking(int fd, bool set);
335 NTSTATUS init_before_fork(void);
336 NTSTATUS reinit_after_fork(struct messaging_context *msg_ctx,
337 struct tevent_context *ev_ctx,
338 bool parent_longlived,
339 const char *comment);
340 NTSTATUS smbd_reinit_after_fork(struct messaging_context *msg_ctx,
341 struct tevent_context *ev_ctx,
342 bool parent_longlived,
343 const char *comment);
344 void *malloc_(size_t size);
345 void *Realloc(void *p, size_t size, bool free_old_on_error);
346 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
347 void *element, void *_array, uint32_t *num_elements,
348 ssize_t *array_size);
349 char *get_myname(TALLOC_CTX *ctx);
350 char *get_mydnsdomname(TALLOC_CTX *ctx);
351 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name);
352 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name);
353 bool process_exists(const struct server_id pid);
354 const char *uidtoname(uid_t uid);
355 char *gidtoname(gid_t gid);
356 uid_t nametouid(const char *name);
357 gid_t nametogid(const char *name);
358 void smb_panic_s3(const char *why);
359 const char *readdirname(DIR *p);
360 bool is_in_path(const char *name, name_compare_entry *namelist, bool case_sensitive);
361 void set_namearray(name_compare_entry **ppname_array, const char *namelist);
362 void free_namearray(name_compare_entry *name_array);
363 bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
364 bool fcntl_getlock(int fd, int op, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
365 int map_process_lock_to_ofd_lock(int op, bool *use_ofd_locks);
366 bool is_myname(const char *s);
367 void ra_lanman_string( const char *native_lanman );
368 const char *get_remote_arch_str(void);
369 enum remote_arch_types get_remote_arch_from_str(const char *remote_arch_string);
370 void set_remote_arch(enum remote_arch_types type);
371 enum remote_arch_types get_remote_arch(void);
372 bool remote_arch_cache_update(const struct GUID *client_guid);
373 bool remote_arch_cache_delete(const struct GUID *client_guid);
374 const char *tab_depth(int level, int depth);
375 int str_checksum(const char *s);
376 void zero_free(void *p, size_t size);
377 int set_maxfiles(int requested_max);
378 int smb_mkstemp(char *name_template);
379 void *smb_xmalloc_array(size_t size, unsigned int count);
380 char *myhostname(void);
381 char *myhostname_upper(void);
382 #include "lib/util_path.h"
383 bool parent_dirname(TALLOC_CTX *mem_ctx, const char *dir, char **parent,
385 bool ms_has_wild(const char *s);
386 bool ms_has_wild_w(const smb_ucs2_t *s);
387 bool mask_match(const char *string, const char *pattern, bool is_case_sensitive);
388 bool mask_match_search(const char *string, const char *pattern, bool is_case_sensitive);
389 bool mask_match_list(const char *string, char **list, int listLen, bool is_case_sensitive);
390 #include "lib/util/unix_match.h"
391 bool name_to_fqdn(fstring fqdn, const char *name);
392 uint32_t map_share_mode_to_deny_mode(uint32_t share_access, uint32_t private_options);
394 #include "lib/util_procid.h"
396 #define serverid_equal(p1, p2) server_id_equal(p1,p2)
397 struct server_id interpret_pid(const char *pid_string);
398 bool is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off);
399 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off);
400 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off);
401 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval);
402 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval);
403 bool split_domain_user(TALLOC_CTX *mem_ctx,
404 const char *full_name,
407 const char *strip_hostname(const char *s);
408 bool any_nt_status_not_ok(NTSTATUS err1, NTSTATUS err2, NTSTATUS *result);
409 int timeval_to_msec(struct timeval t);
410 char *valid_share_pathname(TALLOC_CTX *ctx, const char *dos_pathname);
411 bool is_executable(const char *fname);
412 bool map_open_params_to_ntcreate(const char *smb_base_fname,
413 int deny_mode, int open_func,
414 uint32_t *paccess_mask,
415 uint32_t *pshare_mode,
416 uint32_t *pcreate_disposition,
417 uint32_t *pcreate_options,
418 uint32_t *pprivate_flags);
419 struct security_unix_token *copy_unix_token(TALLOC_CTX *ctx, const struct security_unix_token *tok);
420 bool dir_check_ftype(uint32_t mode, uint32_t dirtype);
422 /* The following definitions come from lib/util_builtin.c */
424 bool lookup_builtin_rid(TALLOC_CTX *mem_ctx, uint32_t rid, const char **name);
425 bool lookup_builtin_name(const char *name, uint32_t *rid);
426 const char *builtin_domain_name(void);
427 bool sid_check_is_builtin(const struct dom_sid *sid);
428 bool sid_check_is_in_builtin(const struct dom_sid *sid);
429 bool sid_check_is_wellknown_builtin(const struct dom_sid *sid);
431 /* The following definitions come from lib/util_nscd.c */
433 void smb_nscd_flush_user_cache(void);
434 void smb_nscd_flush_group_cache(void);
436 /* The following definitions come from lib/util_nttoken.c */
438 struct security_token *dup_nt_token(TALLOC_CTX *mem_ctx, const struct security_token *ptoken);
439 NTSTATUS merge_nt_token(TALLOC_CTX *mem_ctx,
440 const struct security_token *token_1,
441 const struct security_token *token_2,
442 struct security_token **token_out);
443 bool token_sid_in_ace(const struct security_token *token, const struct security_ace *ace);
445 /* The following definitions come from lib/util_sec.c */
448 uid_t sec_initial_uid(void);
449 gid_t sec_initial_gid(void);
450 bool root_mode(void);
451 bool non_root_mode(void);
452 void gain_root_privilege(void);
453 void gain_root_group_privilege(void);
454 void set_effective_uid(uid_t uid);
455 void set_effective_gid(gid_t gid);
456 void save_re_uid(void);
457 void restore_re_uid_fromroot(void);
458 void restore_re_uid(void);
459 void save_re_gid(void);
460 void restore_re_gid(void);
461 int set_re_uid(void);
462 void become_user_permanently(uid_t uid, gid_t gid);
463 int set_thread_credentials(uid_t uid,
466 const gid_t *gidset);
467 bool is_setuid_root(void) ;
469 /* The following definitions come from lib/util_sid.c */
471 char *sid_to_fstring(fstring sidstr_out, const struct dom_sid *sid);
472 char *sid_string_talloc(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
473 char *sid_string_dbg(const struct dom_sid *sid);
474 char *sid_string_tos(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 int create_tcpip_socket(const struct sockaddr_storage *ifss, uint16_t *port);
565 const char *get_mydnsfullname(void);
566 bool is_myname_or_ipaddr(const char *s);
567 int poll_one_fd(int fd, int events, int timeout, int *revents);
568 int poll_intr_one_fd(int fd, int events, int timeout, int *revents);
570 /* The following definitions come from lib/util_str.c */
572 bool next_token(const char **ptr, char *buff, const char *sep, size_t bufsize);
573 bool strnequal(const char *s1,const char *s2,size_t n);
574 bool strcsequal(const char *s1,const char *s2);
575 bool strnorm(char *s, int case_default);
576 char *push_skip_string(char *buf);
577 char *skip_string(const char *base, size_t len, char *buf);
578 size_t str_charnum(const char *s);
579 bool trim_char(char *s,char cfront,char cback);
580 bool strhasupper(const char *s);
581 bool strhaslower(const char *s);
582 char *StrnCpy(char *dest,const char *src,size_t n);
583 bool in_list(const char *s, const char *list, bool casesensitive);
584 void fstring_sub(char *s,const char *pattern,const char *insert);
585 char *realloc_string_sub2(char *string,
588 bool remove_unsafe_characters,
589 bool allow_trailing_dollar);
590 char *realloc_string_sub(char *string,
593 char *talloc_string_sub2(TALLOC_CTX *mem_ctx, const char *src,
596 bool remove_unsafe_characters,
598 bool allow_trailing_dollar);
599 char *talloc_string_sub(TALLOC_CTX *mem_ctx,
603 void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
604 char *talloc_all_string_sub(TALLOC_CTX *ctx,
608 char *octal_string(int i);
609 char *string_truncate(char *s, unsigned int length);
610 char *strchr_m(const char *src, char c);
611 char *strrchr_m(const char *s, char c);
612 char *strnrchr_m(const char *s, char c, unsigned int n);
613 char *strstr_m(const char *src, const char *findstr);
614 bool strlower_m(char *s);
615 bool strupper_m(char *s);
616 size_t strlen_m(const char *s);
617 size_t strlen_m_term(const char *s);
618 size_t strlen_m_term_null(const char *s);
619 int fstr_sprintf(fstring s, const char *fmt, ...);
620 bool str_list_sub_basic( char **list, const char *smb_name,
621 const char *domain_name );
622 bool str_list_substitute(char **list, const char *pattern, const char *insert);
624 char *ipstr_list_make(char **ipstr_list,
625 const struct ip_service *ip_list,
627 int ipstr_list_parse(const char *ipstr_list, struct ip_service **ip_list);
628 void ipstr_list_free(char* ipstr_list);
629 uint64_t STR_TO_SMB_BIG_UINT(const char *nptr, const char **entptr);
630 uint64_t conv_str_size(const char * str);
631 int asprintf_strupper_m(char **strp, const char *fmt, ...)
632 PRINTF_ATTRIBUTE(2,3);
633 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...)
634 PRINTF_ATTRIBUTE(2,3);
635 char *talloc_asprintf_strlower_m(TALLOC_CTX *t, const char *fmt, ...)
636 PRINTF_ATTRIBUTE(2,3);
637 bool validate_net_name( const char *name,
638 const char *invalid_chars,
640 char *escape_shell_string(const char *src);
641 ssize_t full_path_tos(const char *dir, const char *name,
642 char *tmpbuf, size_t tmpbuf_len,
643 char **pdst, char **to_free);
645 /* The following definitions come from lib/version.c */
647 const char *samba_version_string(void);
649 /* The following definitions come from lib/wins_srv.c */
651 bool wins_srv_is_dead(struct in_addr wins_ip, struct in_addr src_ip);
652 void wins_srv_alive(struct in_addr wins_ip, struct in_addr src_ip);
653 void wins_srv_died(struct in_addr wins_ip, struct in_addr src_ip);
654 unsigned wins_srv_count(void);
655 char **wins_srv_tags(void);
656 void wins_srv_tags_free(char **list);
657 struct in_addr wins_srv_ip_tag(const char *tag, struct in_addr src_ip);
658 bool wins_server_tag_ips(const char *tag, TALLOC_CTX *mem_ctx,
659 struct in_addr **pservers, int *pnum_servers);
660 unsigned wins_srv_count_tag(const char *tag);
662 #ifndef ASN1_MAX_OIDS
663 #define ASN1_MAX_OIDS 20
665 bool spnego_parse_negTokenInit(TALLOC_CTX *ctx,
667 char *OIDs[ASN1_MAX_OIDS],
670 DATA_BLOB spnego_gen_krb5_wrap(TALLOC_CTX *ctx, const DATA_BLOB ticket, const uint8_t tok_id[2]);
672 /* The following definitions come from libsmb/conncache.c */
674 NTSTATUS check_negative_conn_cache( const char *domain, const char *server);
675 void add_failed_connection_entry(const char *domain, const char *server, NTSTATUS result) ;
676 void flush_negative_conn_cache_for_domain(const char *domain);
678 /* The following definitions come from libsmb/errormap.c */
680 NTSTATUS dos_to_ntstatus(uint8_t eclass, uint32_t ecode);
682 /* The following definitions come from libsmb/namecache.c */
684 bool namecache_store(const char *name,
687 struct ip_service *ip_list);
688 bool namecache_fetch(const char *name,
690 struct ip_service **ip_list,
692 bool namecache_delete(const char *name, int name_type);
693 void namecache_flush(void);
694 bool namecache_status_store(const char *keyname, int keyname_type,
695 int name_type, const struct sockaddr_storage *keyip,
696 const char *srvname);
697 bool namecache_status_fetch(const char *keyname,
700 const struct sockaddr_storage *keyip,
703 /* The following definitions come from libsmb/namequery_dc.c */
705 bool get_dc_name(const char *domain,
708 struct sockaddr_storage *ss_out);
710 /* The following definitions come from libsmb/smberr.c */
712 const char *smb_dos_err_name(uint8_t e_class, uint16_t num);
713 const char *get_dos_error_msg(WERROR result);
714 const char *smb_dos_err_class(uint8_t e_class);
715 WERROR map_werror_from_unix(int error);
717 /* The following definitions come from libsmb/trusts_util.c */
719 struct netlogon_creds_cli_context;
720 struct messaging_context;
721 struct dcerpc_binding_handle;
722 char *trust_pw_new_value(TALLOC_CTX *mem_ctx,
723 enum netr_SchannelType sec_channel_type,
725 NTSTATUS trust_pw_change(struct netlogon_creds_cli_context *context,
726 struct messaging_context *msg_ctx,
727 struct dcerpc_binding_handle *b,
732 /* The following definitions come from param/loadparm.c */
734 #include "source3/param/param_proto.h"
736 char *lp_servicename(TALLOC_CTX *ctx, int);
737 const char *lp_const_servicename(int);
738 bool lp_autoloaded(int);
739 const char *lp_dnsdomain(void);
740 int lp_winbind_max_domain_connections(void);
741 bool lp_idmap_range(const char *domain_name, uint32_t *low, uint32_t *high);
742 bool lp_idmap_default_range(uint32_t *low, uint32_t *high);
743 const char *lp_idmap_backend(const char *domain_name);
744 const char *lp_idmap_default_backend (void);
745 int lp_security(void);
746 int lp_client_max_protocol(void);
747 int lp_client_ipc_min_protocol(void);
748 int lp_client_ipc_max_protocol(void);
749 int lp_client_ipc_signing(void);
750 int lp_smb2_max_credits(void);
751 int lp_cups_encrypt(void);
752 bool lp_widelinks(int );
753 int lp_rpc_low_port(void);
754 int lp_rpc_high_port(void);
755 bool lp_lanman_auth(void);
757 int lp_wi_scan_global_parametrics(
758 const char *regex, size_t max_matches,
759 bool (*cb)(const char *string, regmatch_t matches[],
763 char *lp_parm_talloc_string(TALLOC_CTX *ctx, int snum, const char *type, const char *option, const char *def);
764 const char *lp_parm_const_string(int snum, const char *type, const char *option, const char *def);
765 struct loadparm_service;
766 const char *lp_parm_const_string_service(struct loadparm_service *service, const char *type,
767 const char *option, const char *def);
768 const char **lp_parm_string_list(int snum, const char *type, const char *option, const char **def);
769 int lp_parm_int(int snum, const char *type, const char *option, int def);
770 unsigned long lp_parm_ulong(int snum, const char *type, const char *option, unsigned long def);
771 unsigned long long lp_parm_ulonglong(int snum, const char *type,
773 unsigned long long def);
774 bool lp_parm_bool(int snum, const char *type, const char *option, bool def);
776 int lp_parm_enum(int snum, const char *type, const char *option,
777 const struct enum_list *_enum, int def);
778 char *canonicalize_servicename(TALLOC_CTX *ctx, const char *src);
779 bool lp_add_home(const char *pszHomename, int iDefaultService,
780 const char *user, const char *pszHomedir);
781 int lp_add_service(const char *pszService, int iDefaultService);
782 bool lp_add_printer(const char *pszPrintername, int iDefaultService);
783 bool lp_parameter_is_valid(const char *pszParmName);
784 bool lp_parameter_is_global(const char *pszParmName);
785 bool lp_canonicalize_parameter(const char *parm_name, const char **canon_parm,
787 bool lp_canonicalize_parameter_with_value(const char *parm_name,
789 const char **canon_parm,
790 const char **canon_val);
791 void show_parameter_list(void);
792 bool lp_invert_boolean(const char *str, const char **inverse_str);
793 bool lp_canonicalize_boolean(const char *str, const char**canon_str);
794 bool process_registry_service(const char *service_name);
795 bool process_registry_shares(void);
796 bool lp_config_backend_is_registry(void);
797 bool lp_config_backend_is_file(void);
798 bool lp_file_list_changed(void);
799 const char *lp_ldap_machine_suffix(TALLOC_CTX *ctx);
800 const char *lp_ldap_user_suffix(TALLOC_CTX *ctx);
801 const char *lp_ldap_group_suffix(TALLOC_CTX *ctx);
802 const char *lp_ldap_idmap_suffix(TALLOC_CTX *ctx);
804 /* Return a pointer to a service by name. */
805 struct loadparm_service *lp_service(const char *pszServiceName);
806 struct loadparm_service *lp_servicebynum(int snum);
807 struct loadparm_service *lp_default_loadparm_service(void);
808 void *lp_parm_ptr(struct loadparm_service *service, struct parm_struct *parm);
809 void *lp_local_ptr_by_snum(int snum, struct parm_struct *parm);
810 bool lp_do_parameter(int snum, const char *pszParmName, const char *pszParmValue);
811 bool lp_set_cmdline(const char *pszParmName, const char *pszParmValue);
812 bool dump_a_parameter(int snum, char *parm_name, FILE * f, bool isGlobal);
813 bool lp_snum_ok(int iService);
814 void lp_add_one_printer(const char *name, const char *comment,
815 const char *location, void *pdata);
816 bool lp_loaded(void);
817 void lp_killunused(struct smbd_server_connection *sconn,
818 bool (*snumused) (struct smbd_server_connection *, int));
819 void lp_kill_all_services(void);
820 void lp_killservice(int iServiceIn);
821 const char* server_role_str(uint32_t role);
822 enum usershare_err parse_usershare_file(TALLOC_CTX *ctx,
823 SMB_STRUCT_STAT *psbuf,
824 const char *servicename,
830 char **pp_cp_share_name,
831 struct security_descriptor **ppsd,
833 int load_usershare_service(const char *servicename);
834 int load_usershare_shares(struct smbd_server_connection *sconn,
835 bool (*snumused) (struct smbd_server_connection *, int));
836 void gfree_loadparm(void);
837 bool lp_load_initial_only(const char *pszFname);
838 bool lp_load_global(const char *file_name);
839 bool lp_load_with_shares(const char *file_name);
840 bool lp_load_client(const char *file_name);
841 bool lp_load_global_no_reinit(const char *file_name);
842 bool lp_load_no_reinit(const char *file_name);
843 bool lp_load_client_no_reinit(const char *file_name);
844 bool lp_load_with_registry_shares(const char *pszFname);
845 int lp_numservices(void);
846 void lp_dump(FILE *f, bool show_defaults, int maxtoprint);
847 void lp_dump_one(FILE * f, bool show_defaults, int snum);
848 int lp_servicenumber(const char *pszServiceName);
849 const char *volume_label(TALLOC_CTX *ctx, int snum);
850 bool lp_domain_master(void);
851 bool lp_preferred_master(void);
852 void lp_remove_service(int snum);
853 void lp_copy_service(int snum, const char *new_name);
854 int lp_default_server_announce(void);
855 const char *lp_printername(TALLOC_CTX *ctx, int snum);
856 void lp_set_logfile(const char *name);
857 int lp_maxprintjobs(int snum);
858 const char *lp_printcapname(void);
859 bool lp_disable_spoolss( void );
860 void lp_set_spoolss_state( uint32_t state );
861 uint32_t lp_get_spoolss_state( void );
862 struct smb_signing_state;
863 bool lp_use_sendfile(int snum, struct smb_signing_state *signing_state);
864 void set_use_sendfile(int snum, bool val);
865 void lp_set_mangling_method(const char *new_method);
866 bool lp_posix_pathnames(void);
867 void lp_set_posix_pathnames(void);
868 enum brl_flavour lp_posix_cifsu_locktype(files_struct *fsp);
869 void lp_set_posix_default_cifsx_readwrite_locktype(enum brl_flavour val);
870 int lp_min_receive_file_size(void);
871 char* lp_perfcount_module(TALLOC_CTX *ctx);
872 void widelinks_warning(int snum);
873 const char *lp_ncalrpc_dir(void);
874 void _lp_set_server_role(int server_role);
876 /* The following definitions come from param/loadparm_ctx.c */
878 const struct loadparm_s3_helpers *loadparm_s3_helpers(void);
880 /* The following definitions come from param/loadparm_server_role.c */
882 int lp_server_role(void);
883 void set_server_role(void);
885 /* The following definitions come from param/util.c */
887 uint32_t get_int_param( const char* param );
888 char* get_string_param( const char* param );
890 /* The following definitions come from lib/server_contexts.c */
891 struct tevent_context *server_event_context(void);
892 void server_event_context_free(void);
893 struct messaging_context *server_messaging_context(void);
894 void server_messaging_context_free(void);
896 /* The following definitions come from lib/sessionid_tdb.c */
898 NTSTATUS sessionid_traverse_read(int (*fn)(const char *key,
899 struct sessionid *session,
903 /* The following definitions come from utils/passwd_util.c */
905 char *stdin_new_passwd( void);
906 char *get_pass( const char *prompt, bool stdin_get);
908 /* The following definitions come from lib/avahi.c */
910 struct AvahiPoll *tevent_avahi_poll(TALLOC_CTX *mem_ctx,
911 struct tevent_context *ev);
913 /* The following definitions come from libsmb/smbsock_connect.c */
915 struct tevent_req *smbsock_connect_send(TALLOC_CTX *mem_ctx,
916 struct tevent_context *ev,
917 const struct sockaddr_storage *addr,
919 const char *called_name,
921 const char *calling_name,
923 NTSTATUS smbsock_connect_recv(struct tevent_req *req, int *sock,
925 NTSTATUS smbsock_connect(const struct sockaddr_storage *addr, uint16_t port,
926 const char *called_name, int called_type,
927 const char *calling_name, int calling_type,
928 int *pfd, uint16_t *ret_port, int sec_timeout);
930 struct tevent_req *smbsock_any_connect_send(TALLOC_CTX *mem_ctx,
931 struct tevent_context *ev,
932 const struct sockaddr_storage *addrs,
933 const char **called_names,
935 const char **calling_names,
937 size_t num_addrs, uint16_t port);
938 NTSTATUS smbsock_any_connect_recv(struct tevent_req *req, int *pfd,
939 size_t *chosen_index, uint16_t *chosen_port);
940 NTSTATUS smbsock_any_connect(const struct sockaddr_storage *addrs,
941 const char **called_names,
943 const char **calling_names,
948 int *pfd, size_t *chosen_index,
949 uint16_t *chosen_port);
951 /* The following definitions come from lib/util_wellknown.c */
953 bool sid_check_is_wellknown_domain(const struct dom_sid *sid, const char **name);
954 bool sid_check_is_in_wellknown_domain(const struct dom_sid *sid);
955 bool lookup_wellknown_sid(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
956 const char **domain, const char **name);
957 bool lookup_wellknown_name(TALLOC_CTX *mem_ctx, const char *name,
958 struct dom_sid *sid, const char **domain);
960 /* The following definitions come from lib/util_specialsids.c */
961 bool sid_check_is_asserted_identity(const struct dom_sid *sid);
962 bool sid_check_is_in_asserted_identity(const struct dom_sid *sid);
963 const char *asserted_identity_domain_name(void);
965 /* The following definitions come from lib/filename_util.c */
967 NTSTATUS get_full_smb_filename(TALLOC_CTX *ctx, const struct smb_filename *smb_fname,
969 struct smb_filename *synthetic_smb_fname(TALLOC_CTX *mem_ctx,
970 const char *base_name,
971 const char *stream_name,
972 const SMB_STRUCT_STAT *psbuf,
974 struct smb_filename *synthetic_smb_fname_split(TALLOC_CTX *ctx,
977 const char *smb_fname_str_dbg(const struct smb_filename *smb_fname);
978 const char *fsp_str_dbg(const struct files_struct *fsp);
979 const char *fsp_fnum_dbg(const struct files_struct *fsp);
980 struct smb_filename *cp_smb_filename(TALLOC_CTX *mem_ctx,
981 const struct smb_filename *in);
982 struct smb_filename *cp_smb_filename_nostream(TALLOC_CTX *mem_ctx,
983 const struct smb_filename *in);
984 bool is_ntfs_stream_smb_fname(const struct smb_filename *smb_fname);
985 bool is_ntfs_default_stream_smb_fname(const struct smb_filename *smb_fname);
986 bool is_invalid_windows_ea_name(const char *name);
987 bool ea_list_has_invalid_name(struct ea_list *ea_list);
988 bool split_stream_filename(TALLOC_CTX *ctx,
989 const char *filename_in,
991 char **streamname_out);
993 /* The following definitions come from lib/dummyroot.c */
995 void become_root(void);
996 void unbecome_root(void);
998 /* The following definitions come from lib/smbd_shim.c */
1000 int find_service(TALLOC_CTX *ctx, const char *service_in, char **p_service_out);
1001 void cancel_pending_lock_requests_by_fid(files_struct *fsp,
1002 struct byte_range_lock *br_lck,
1003 enum file_close_type close_type);
1004 void send_stat_cache_delete_message(struct messaging_context *msg_ctx,
1006 NTSTATUS can_delete_directory_fsp(files_struct *fsp);
1007 bool change_to_root_user(void);
1008 bool become_authenticated_pipe_user(struct auth_session_info *session_info);
1009 bool unbecome_authenticated_pipe_user(void);
1011 void contend_level2_oplocks_begin(files_struct *fsp,
1012 enum level2_contention_type type);
1013 void contend_level2_oplocks_end(files_struct *fsp,
1014 enum level2_contention_type type);
1016 #endif /* _PROTO_H_ */