kdc: use ticket client name when signing PAC
[Samba.git] / source3 / include / proto.h
blobde5d1be520815ddc3e9f79e4acc466aa4cabf60a
1 /*
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/>.
23 #ifndef _PROTO_H_
24 #define _PROTO_H_
26 #include <sys/types.h>
27 #include <regex.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,
57 const void *base_ptr,
58 uint16_t smb_flags2,
59 char **ppdest,
60 const void *src,
61 size_t src_len,
62 int flags);
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 NTSTATUS vfs_at_fspcwd(TALLOC_CTX *mem_ctx,
84 struct connection_struct *conn,
85 struct files_struct **_fsp);
87 /* The following definitions come from lib/interface.c */
89 bool ismyaddr(const struct sockaddr *ip);
90 bool ismyip_v4(struct in_addr ip);
91 bool is_local_net(const struct sockaddr *from);
92 void setup_linklocal_scope_id(struct sockaddr *pss);
93 bool is_local_net_v4(struct in_addr from);
94 int iface_count(void);
95 int iface_count_v4_nl(void);
96 const struct in_addr *first_ipv4_iface(void);
97 struct interface *get_interface(int n);
98 const struct sockaddr_storage *iface_n_sockaddr_storage(int n);
99 const struct in_addr *iface_n_ip_v4(int n);
100 const struct in_addr *iface_n_bcast_v4(int n);
101 const struct sockaddr_storage *iface_n_bcast(int n);
102 const struct sockaddr_storage *iface_ip(const struct sockaddr *ip);
103 bool iface_local(const struct sockaddr *ip);
104 void load_interfaces(void);
105 void gfree_interfaces(void);
106 bool interfaces_changed(void);
108 /* The following definitions come from lib/ldap_debug_handler.c */
110 void init_ldap_debugging(void);
112 /* The following definitions come from lib/ldap_escape.c */
114 char *escape_ldap_string(TALLOC_CTX *mem_ctx, const char *s);
115 char *escape_rdn_val_string_alloc(const char *s);
117 /* The following definitions come from lib/ms_fnmatch.c */
119 int ms_fnmatch(const char *pattern, const char *string, bool translate_pattern,
120 bool is_case_sensitive);
122 /* The following definitions come from lib/recvfile.c */
124 ssize_t sys_recvfile(int fromfd,
125 int tofd,
126 off_t offset,
127 size_t count);
128 ssize_t sys_recvfile(int fromfd,
129 int tofd,
130 off_t offset,
131 size_t count);
132 ssize_t drain_socket(int sockfd, size_t count);
134 /* The following definitions come from lib/sendfile.c */
136 ssize_t sys_sendfile(int tofd, int fromfd, const DATA_BLOB *header, off_t offset, size_t count);
138 /* The following definitions come from lib/server_mutex.c */
140 struct named_mutex *grab_named_mutex(TALLOC_CTX *mem_ctx, const char *name,
141 int timeout);
143 /* The following definitions come from lib/sharesec.c */
145 NTSTATUS share_info_db_init(void);
146 struct security_descriptor *get_share_security_default( TALLOC_CTX *ctx, size_t *psize, uint32_t def_access);
147 struct security_descriptor *get_share_security( TALLOC_CTX *ctx, const char *servicename,
148 size_t *psize);
149 NTSTATUS set_share_security(const char *share_name,
150 struct security_descriptor *psd);
151 NTSTATUS delete_share_security(const char *servicename);
152 bool share_access_check(const struct security_token *token,
153 const char *sharename,
154 uint32_t desired_access,
155 uint32_t *pgranted);
156 bool parse_usershare_acl(TALLOC_CTX *ctx, const char *acl_str, struct security_descriptor **ppsd);
158 /* The following definitions come from lib/smbrun.c */
160 int smbrun_no_sanitize(const char *cmd, int *outfd, char * const *env);
161 int smbrun(const char *cmd, int *outfd, char * const *env);
162 int smbrunsecret(const char *cmd, const char *secret);
164 /* The following definitions come from lib/substitute.c */
166 bool set_local_machine_name(const char *local_name, bool perm);
167 const char *get_local_machine_name(void);
168 bool set_remote_machine_name(const char *remote_name, bool perm);
169 const char *get_remote_machine_name(void);
170 void sub_set_smb_name(const char *name);
171 void set_current_user_info(const char *smb_name, const char *unix_name,
172 const char *domain);
173 void sub_set_socket_ids(const char *peeraddr, const char *peername,
174 const char *sockaddr);
175 const char *get_current_username(void);
176 void standard_sub_basic(const char *smb_name, const char *domain_name,
177 char *str, size_t len);
178 char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name,
179 const char *domain_name, const char *str);
180 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
181 const char *input_string,
182 const char *username,
183 const char *grpname,
184 const char *domain,
185 uid_t uid,
186 gid_t gid);
187 char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
188 const char *servicename, const char *user,
189 const char *connectpath, gid_t gid,
190 const char *str);
191 char *talloc_sub_full(TALLOC_CTX *mem_ctx,
192 const char *servicename, const char *user,
193 const char *connectpath, gid_t gid,
194 const char *smb_name, const char *domain_name,
195 const char *str);
197 /* The following definitions come from lib/sysquotas.c */
199 int sys_get_quota(const char *path, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
200 int sys_set_quota(const char *path, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
202 /* The following definitions come from lib/sysquotas_*.c */
204 int sys_get_vfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
205 int sys_set_vfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
207 int sys_get_xfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
208 int sys_set_xfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
210 int sys_get_jfs2_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
211 int sys_set_jfs2_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
213 int sys_get_nfs_quota(const char *path, const char *bdev,
214 enum SMB_QUOTA_TYPE qtype,
215 unid_t id, SMB_DISK_QUOTA *dp);
216 int sys_set_nfs_quota(const char *path, const char *bdev,
217 enum SMB_QUOTA_TYPE qtype,
218 unid_t id, SMB_DISK_QUOTA *dp);
220 /* The following definitions come from lib/system.c */
222 ssize_t sys_send(int s, const void *msg, size_t len, int flags);
223 ssize_t sys_recvfrom(int s, void *buf, size_t len, int flags, struct sockaddr *from, socklen_t *fromlen);
224 int sys_fcntl_ptr(int fd, int cmd, void *arg);
225 int sys_fcntl_long(int fd, int cmd, long arg);
226 int sys_fcntl_int(int fd, int cmd, int arg);
227 void update_stat_ex_mtime(struct stat_ex *dst, struct timespec write_ts);
228 void update_stat_ex_itime(struct stat_ex *dst, struct timespec itime);
229 void update_stat_ex_create_time(struct stat_ex *dst, struct timespec create_time);
230 void update_stat_ex_file_id(struct stat_ex *dst, uint64_t file_id);
231 void update_stat_ex_from_saved_stat(struct stat_ex *dst,
232 const struct stat_ex *src);
233 int sys_stat(const char *fname, SMB_STRUCT_STAT *sbuf,
234 bool fake_dir_create_times);
235 int sys_fstat(int fd, SMB_STRUCT_STAT *sbuf,
236 bool fake_dir_create_times);
237 int sys_lstat(const char *fname,SMB_STRUCT_STAT *sbuf,
238 bool fake_dir_create_times);
239 int sys_posix_fallocate(int fd, off_t offset, off_t len);
240 int sys_fallocate(int fd, uint32_t mode, off_t offset, off_t len);
241 void kernel_flock(int fd, uint32_t share_access, uint32_t access_mask);
242 DIR *sys_fdopendir(int fd);
243 int sys_mknod(const char *path, mode_t mode, SMB_DEV_T dev);
244 int sys_mknodat(int dirfd, const char *path, mode_t mode, SMB_DEV_T dev);
245 char *sys_getwd(void);
246 void set_effective_capability(enum smbd_capability capability);
247 void drop_effective_capability(enum smbd_capability capability);
248 long sys_random(void);
249 void sys_srandom(unsigned int seed);
250 int groups_max(void);
251 int sys_getgroups(int setlen, gid_t *gidset);
252 int sys_setgroups(gid_t UNUSED(primary_gid), int setlen, gid_t *gidset);
253 uint32_t unix_dev_major(SMB_DEV_T dev);
254 uint32_t unix_dev_minor(SMB_DEV_T dev);
255 char *sys_realpath(const char *path);
256 #if 0
257 int sys_get_number_of_cores(void);
258 #endif
260 struct stat;
261 void init_stat_ex_from_stat (struct stat_ex *dst,
262 const struct stat *src,
263 bool fake_dir_create_times);
265 /* The following definitions come from lib/system_smbd.c */
267 bool getgroups_unix_user(TALLOC_CTX *mem_ctx, const char *user,
268 gid_t primary_gid,
269 gid_t **ret_groups, uint32_t *p_ngroups);
271 /* The following definitions come from lib/tallocmsg.c */
273 void register_msg_pool_usage(TALLOC_CTX *mem_ctx,
274 struct messaging_context *msg_ctx);
276 /* The following definitions come from lib/time.c */
278 void push_dos_date(uint8_t *buf, int offset, time_t unixdate, int zone_offset);
279 void push_dos_date2(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
280 void push_dos_date3(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
281 uint32_t convert_time_t_to_uint32_t(time_t t);
282 time_t convert_uint32_t_to_time_t(uint32_t u);
283 bool nt_time_is_zero(const NTTIME *nt);
284 time_t generalized_to_unix_time(const char *str);
285 int get_server_zone_offset(void);
286 int set_server_zone_offset(time_t t);
287 char *timeval_string(TALLOC_CTX *ctx, const struct timeval *tp, bool hires);
288 char *current_timestring(TALLOC_CTX *ctx, bool hires);
289 void srv_put_dos_date(char *buf,int offset,time_t unixdate);
290 void srv_put_dos_date2(char *buf,int offset, time_t unixdate);
291 void srv_put_dos_date3(char *buf,int offset,time_t unixdate);
292 void round_timespec(enum timestamp_set_resolution res, struct timespec *ts);
293 void put_long_date_timespec(enum timestamp_set_resolution res, char *p, struct timespec ts);
294 void put_long_date_full_timespec(enum timestamp_set_resolution res,
295 char *p,
296 const struct timespec *ts);
297 struct timespec pull_long_date_full_timespec(const char *p);
298 void put_long_date(char *p, time_t t);
299 void dos_filetime_timespec(struct timespec *tsp);
300 time_t make_unix_date(const void *date_ptr, int zone_offset);
301 time_t make_unix_date2(const void *date_ptr, int zone_offset);
302 time_t make_unix_date3(const void *date_ptr, int zone_offset);
303 time_t srv_make_unix_date(const void *date_ptr);
304 time_t srv_make_unix_date2(const void *date_ptr);
305 time_t srv_make_unix_date3(const void *date_ptr);
306 struct timespec interpret_long_date(const char *p);
307 void TimeInit(void);
308 void get_process_uptime(struct timeval *ret_time);
309 void get_startup_time(struct timeval *ret_time);
310 time_t nt_time_to_unix_abs(const NTTIME *nt);
311 void unix_to_nt_time_abs(NTTIME *nt, time_t t);
312 const char *time_to_asc(const time_t t);
313 const char *display_time(NTTIME nttime);
314 bool nt_time_is_set(const NTTIME *nt);
316 /* The following definitions come from lib/username.c */
318 void flush_pwnam_cache(void);
319 char *get_user_home_dir(TALLOC_CTX *mem_ctx, const char *user);
320 struct passwd *Get_Pwnam_alloc(TALLOC_CTX *mem_ctx, const char *user);
322 /* The following definitions come from lib/util_names.c */
323 const char *get_global_sam_name(void);
324 const char *my_sam_name(void);
325 bool is_allowed_domain(const char *domain_name);
327 /* The following definitions come from lib/util.c */
329 enum protocol_types get_Protocol(void);
330 void set_Protocol(enum protocol_types p);
331 void gfree_names(void);
332 void gfree_all( void );
333 const char *my_netbios_names(int i);
334 bool set_netbios_aliases(const char **str_array);
335 bool init_names(void);
336 bool file_exist_stat(const char *fname,SMB_STRUCT_STAT *sbuf,
337 bool fake_dir_create_times);
338 bool socket_exist(const char *fname);
339 uint64_t get_file_size_stat(const SMB_STRUCT_STAT *sbuf);
340 bool check_same_dev_ino(const SMB_STRUCT_STAT *sbuf1,
341 const SMB_STRUCT_STAT *sbuf2);
342 bool check_same_stat(const SMB_STRUCT_STAT *sbuf1,
343 const SMB_STRUCT_STAT *sbuf2);
344 void show_msg(const char *buf);
345 int set_message_bcc(char *buf,int num_bytes);
346 ssize_t message_push_blob(uint8_t **outbuf, DATA_BLOB blob);
347 char *unix_clean_name(TALLOC_CTX *ctx, const char *s);
348 char *clean_name(TALLOC_CTX *ctx, const char *s);
349 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, off_t pos);
350 NTSTATUS init_before_fork(void);
351 NTSTATUS reinit_after_fork(struct messaging_context *msg_ctx,
352 struct tevent_context *ev_ctx,
353 bool parent_longlived,
354 const char *comment);
355 NTSTATUS smbd_reinit_after_fork(struct messaging_context *msg_ctx,
356 struct tevent_context *ev_ctx,
357 bool parent_longlived,
358 const char *comment);
359 void *malloc_(size_t size);
360 void *Realloc(void *p, size_t size, bool free_old_on_error);
361 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
362 void *element, void *_array, uint32_t *num_elements,
363 ssize_t *array_size);
364 char *get_myname(TALLOC_CTX *ctx);
365 char *get_mydnsdomname(TALLOC_CTX *ctx);
366 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name);
367 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name);
368 bool process_exists(const struct server_id pid);
369 const char *uidtoname(uid_t uid);
370 char *gidtoname(gid_t gid);
371 uid_t nametouid(const char *name);
372 gid_t nametogid(const char *name);
373 void smb_panic_s3(const char *why);
374 const char *readdirname(DIR *p);
375 bool is_in_path(const char *name, name_compare_entry *namelist, bool case_sensitive);
376 void set_namearray(name_compare_entry **ppname_array, const char *namelist);
377 void free_namearray(name_compare_entry *name_array);
378 bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
379 bool fcntl_getlock(int fd, int op, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
380 int map_process_lock_to_ofd_lock(int op);
381 bool is_myname(const char *s);
382 void ra_lanman_string( const char *native_lanman );
383 const char *get_remote_arch_str(void);
384 enum remote_arch_types get_remote_arch_from_str(const char *remote_arch_string);
385 void set_remote_arch(enum remote_arch_types type);
386 enum remote_arch_types get_remote_arch(void);
387 bool remote_arch_cache_update(const struct GUID *client_guid);
388 bool remote_arch_cache_delete(const struct GUID *client_guid);
389 const char *tab_depth(int level, int depth);
390 int str_checksum(const char *s);
391 void zero_free(void *p, size_t size);
392 int set_maxfiles(int requested_max);
393 int smb_mkstemp(char *name_template);
394 void *smb_xmalloc_array(size_t size, unsigned int count);
395 char *myhostname(void);
396 char *myhostname_upper(void);
397 #include "lib/util_path.h"
398 bool parent_dirname(TALLOC_CTX *mem_ctx, const char *dir, char **parent,
399 const char **name);
400 bool parent_smb_fname(TALLOC_CTX *mem_ctx,
401 const struct smb_filename *path,
402 struct smb_filename **_parent,
403 struct smb_filename **_name);
404 bool ms_has_wild(const char *s);
405 bool ms_has_wild_w(const smb_ucs2_t *s);
406 bool mask_match(const char *string, const char *pattern, bool is_case_sensitive);
407 bool mask_match_search(const char *string, const char *pattern, bool is_case_sensitive);
408 bool mask_match_list(const char *string, char **list, int listLen, bool is_case_sensitive);
409 #include "lib/util/unix_match.h"
410 bool name_to_fqdn(fstring fqdn, const char *name);
411 uint32_t map_share_mode_to_deny_mode(uint32_t share_access, uint32_t private_options);
413 #include "lib/util_procid.h"
415 struct server_id interpret_pid(const char *pid_string);
416 bool is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off);
417 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off);
418 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off);
419 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval);
420 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval);
421 bool split_domain_user(TALLOC_CTX *mem_ctx,
422 const char *full_name,
423 char **domain,
424 char **user);
425 const char *strip_hostname(const char *s);
426 bool any_nt_status_not_ok(NTSTATUS err1, NTSTATUS err2, NTSTATUS *result);
427 int timeval_to_msec(struct timeval t);
428 char *valid_share_pathname(TALLOC_CTX *ctx, const char *dos_pathname);
429 bool is_executable(const char *fname);
430 bool map_open_params_to_ntcreate(const char *smb_base_fname,
431 int deny_mode, int open_func,
432 uint32_t *paccess_mask,
433 uint32_t *pshare_mode,
434 uint32_t *pcreate_disposition,
435 uint32_t *pcreate_options,
436 uint32_t *pprivate_flags);
437 struct security_unix_token *copy_unix_token(TALLOC_CTX *ctx, const struct security_unix_token *tok);
438 struct security_unix_token *root_unix_token(TALLOC_CTX *mem_ctx);
439 char *utok_string(TALLOC_CTX *mem_ctx, const struct security_unix_token *tok);
440 bool dir_check_ftype(uint32_t mode, uint32_t dirtype);
442 /* The following definitions come from lib/util_builtin.c */
444 bool lookup_builtin_rid(TALLOC_CTX *mem_ctx, uint32_t rid, const char **name);
445 bool lookup_builtin_name(const char *name, uint32_t *rid);
446 const char *builtin_domain_name(void);
447 bool sid_check_is_builtin(const struct dom_sid *sid);
448 bool sid_check_is_in_builtin(const struct dom_sid *sid);
449 bool sid_check_is_wellknown_builtin(const struct dom_sid *sid);
451 /* The following definitions come from lib/util_nscd.c */
453 void smb_nscd_flush_user_cache(void);
454 void smb_nscd_flush_group_cache(void);
456 /* The following definitions come from lib/util_nttoken.c */
458 struct security_token *dup_nt_token(TALLOC_CTX *mem_ctx, const struct security_token *ptoken);
459 NTSTATUS merge_nt_token(TALLOC_CTX *mem_ctx,
460 const struct security_token *token_1,
461 const struct security_token *token_2,
462 struct security_token **token_out);
463 bool token_sid_in_ace(const struct security_token *token, const struct security_ace *ace);
465 /* The following definitions come from lib/util_sec.c */
467 void sec_init(void);
468 uid_t sec_initial_uid(void);
469 gid_t sec_initial_gid(void);
470 bool root_mode(void);
471 bool non_root_mode(void);
472 void gain_root_privilege(void);
473 void gain_root_group_privilege(void);
474 void set_effective_uid(uid_t uid);
475 void set_effective_gid(gid_t gid);
476 void save_re_uid(void);
477 void restore_re_uid_fromroot(void);
478 void restore_re_uid(void);
479 void save_re_gid(void);
480 void restore_re_gid(void);
481 int set_re_uid(void);
482 void become_user_permanently(uid_t uid, gid_t gid);
483 int set_thread_credentials(uid_t uid,
484 gid_t gid,
485 size_t setlen,
486 const gid_t *gidset);
487 bool is_setuid_root(void) ;
489 /* The following definitions come from lib/util_sid.c */
491 char *sid_to_fstring(fstring sidstr_out, const struct dom_sid *sid);
492 bool sid_linearize(uint8_t *outbuf, size_t len, const struct dom_sid *sid);
493 bool non_mappable_sid(struct dom_sid *sid);
494 char *sid_binstring_hex_talloc(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
495 struct netr_SamInfo3;
496 NTSTATUS sid_array_from_info3(TALLOC_CTX *mem_ctx,
497 const struct netr_SamInfo3 *info3,
498 struct dom_sid **user_sids,
499 uint32_t *num_user_sids,
500 bool include_user_group_rid);
502 /* The following definitions come from lib/util_sock.c */
504 bool is_broadcast_addr(const struct sockaddr *pss);
505 bool is_loopback_ip_v4(struct in_addr ip);
506 bool is_loopback_addr(const struct sockaddr *pss);
507 bool is_zero_addr(const struct sockaddr_storage *pss);
508 void zero_ip_v4(struct in_addr *ip);
509 void in_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
510 struct in_addr ip);
511 bool same_net(const struct sockaddr *ip1,
512 const struct sockaddr *ip2,
513 const struct sockaddr *mask);
514 bool sockaddr_equal(const struct sockaddr *ip1,
515 const struct sockaddr *ip2);
516 bool is_address_any(const struct sockaddr *psa);
517 uint16_t get_sockaddr_port(const struct sockaddr_storage *pss);
518 char *print_sockaddr(char *dest,
519 size_t destlen,
520 const struct sockaddr_storage *psa);
521 char *print_canonical_sockaddr(TALLOC_CTX *ctx,
522 const struct sockaddr_storage *pss);
523 int get_socket_port(int fd);
524 const char *client_addr(int fd, char *addr, size_t addrlen);
525 const char *client_socket_addr(int fd, char *addr, size_t addr_len);
526 int client_socket_port(int fd);
527 bool is_a_socket(int fd);
528 void set_socket_options(int fd, const char *options);
529 ssize_t read_udp_v4_socket(int fd,
530 char *buf,
531 size_t len,
532 struct sockaddr_storage *psa);
533 NTSTATUS read_fd_with_timeout(int fd, char *buf,
534 size_t mincnt, size_t maxcnt,
535 unsigned int time_out,
536 size_t *size_ret);
537 NTSTATUS read_data_ntstatus(int fd, char *buffer, size_t N);
539 bool send_keepalive(int client);
540 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
541 unsigned int timeout,
542 size_t *len);
543 NTSTATUS receive_smb_raw(int fd,
544 char *buffer,
545 size_t buflen,
546 unsigned int timeout,
547 size_t maxlen,
548 size_t *p_len);
549 int open_socket_in(int type,
550 uint16_t port,
551 int dlevel,
552 const struct sockaddr_storage *psock,
553 bool rebind);
554 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
555 int timeout, int *pfd);
556 struct tevent_req *open_socket_out_send(TALLOC_CTX *mem_ctx,
557 struct tevent_context *ev,
558 const struct sockaddr_storage *pss,
559 uint16_t port,
560 int timeout);
561 NTSTATUS open_socket_out_recv(struct tevent_req *req, int *pfd);
562 struct tevent_req *open_socket_out_defer_send(TALLOC_CTX *mem_ctx,
563 struct tevent_context *ev,
564 struct timeval wait_time,
565 const struct sockaddr_storage *pss,
566 uint16_t port,
567 int timeout);
568 NTSTATUS open_socket_out_defer_recv(struct tevent_req *req, int *pfd);
569 int open_udp_socket(const char *host, int port);
570 const char *get_peer_addr(int fd, char *addr, size_t addr_len);
572 struct tsocket_address;
574 int get_remote_hostname(const struct tsocket_address *remote_address,
575 char **name,
576 TALLOC_CTX *mem_ctx);
578 int create_pipe_sock(const char *socket_dir,
579 const char *socket_name,
580 mode_t dir_perms);
581 const char *get_mydnsfullname(void);
582 bool is_myname_or_ipaddr(const char *s);
583 int poll_one_fd(int fd, int events, int timeout, int *revents);
584 int poll_intr_one_fd(int fd, int events, int timeout, int *revents);
586 /* The following definitions come from lib/util_str.c */
588 bool next_token(const char **ptr, char *buff, const char *sep, size_t bufsize);
589 bool strnequal(const char *s1,const char *s2,size_t n);
590 bool strcsequal(const char *s1,const char *s2);
591 bool strnorm(char *s, int case_default);
592 char *skip_string(const char *base, size_t len, char *buf);
593 size_t str_charnum(const char *s);
594 bool trim_char(char *s,char cfront,char cback);
595 bool strhasupper(const char *s);
596 bool strhaslower(const char *s);
597 bool in_list(const char *s, const char *list, bool casesensitive);
598 void fstring_sub(char *s,const char *pattern,const char *insert);
599 char *realloc_string_sub2(char *string,
600 const char *pattern,
601 const char *insert,
602 bool remove_unsafe_characters,
603 bool allow_trailing_dollar);
604 char *realloc_string_sub(char *string,
605 const char *pattern,
606 const char *insert);
607 char *talloc_string_sub2(TALLOC_CTX *mem_ctx, const char *src,
608 const char *pattern,
609 const char *insert,
610 bool remove_unsafe_characters,
611 bool replace_once,
612 bool allow_trailing_dollar);
613 char *talloc_string_sub(TALLOC_CTX *mem_ctx,
614 const char *src,
615 const char *pattern,
616 const char *insert);
617 void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
618 char *talloc_all_string_sub(TALLOC_CTX *ctx,
619 const char *src,
620 const char *pattern,
621 const char *insert);
622 char *octal_string(int i);
623 char *string_truncate(char *s, unsigned int length);
624 char *strchr_m(const char *src, char c);
625 char *strrchr_m(const char *s, char c);
626 char *strnrchr_m(const char *s, char c, unsigned int n);
627 char *strstr_m(const char *src, const char *findstr);
628 bool strlower_m(char *s);
629 bool strupper_m(char *s);
630 size_t strlen_m(const char *s);
631 size_t strlen_m_term(const char *s);
632 size_t strlen_m_term_null(const char *s);
633 int fstr_sprintf(fstring s, const char *fmt, ...);
635 char *ipstr_list_make(char **ipstr_list,
636 const struct ip_service *ip_list,
637 int ip_count);
638 int ipstr_list_parse(const char *ipstr_list, struct ip_service **ip_list);
639 void ipstr_list_free(char* ipstr_list);
640 uint64_t STR_TO_SMB_BIG_UINT(const char *nptr, const char **entptr);
641 uint64_t conv_str_size(const char * str);
642 int asprintf_strupper_m(char **strp, const char *fmt, ...)
643 PRINTF_ATTRIBUTE(2,3);
644 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...)
645 PRINTF_ATTRIBUTE(2,3);
646 char *talloc_asprintf_strlower_m(TALLOC_CTX *t, const char *fmt, ...)
647 PRINTF_ATTRIBUTE(2,3);
648 bool validate_net_name( const char *name,
649 const char *invalid_chars,
650 int max_len);
651 char *escape_shell_string(const char *src);
652 ssize_t full_path_tos(const char *dir, const char *name,
653 char *tmpbuf, size_t tmpbuf_len,
654 char **pdst, char **to_free);
656 /* The following definitions come from lib/version.c */
658 const char *samba_version_string(void);
660 /* The following definitions come from lib/wins_srv.c */
662 bool wins_srv_is_dead(struct in_addr wins_ip, struct in_addr src_ip);
663 void wins_srv_alive(struct in_addr wins_ip, struct in_addr src_ip);
664 void wins_srv_died(struct in_addr wins_ip, struct in_addr src_ip);
665 unsigned wins_srv_count(void);
666 char **wins_srv_tags(void);
667 void wins_srv_tags_free(char **list);
668 struct in_addr wins_srv_ip_tag(const char *tag, struct in_addr src_ip);
669 bool wins_server_tag_ips(const char *tag, TALLOC_CTX *mem_ctx,
670 struct in_addr **pservers, int *pnum_servers);
671 unsigned wins_srv_count_tag(const char *tag);
673 #ifndef ASN1_MAX_OIDS
674 #define ASN1_MAX_OIDS 20
675 #endif
676 bool spnego_parse_negTokenInit(TALLOC_CTX *ctx,
677 DATA_BLOB blob,
678 char *OIDs[ASN1_MAX_OIDS],
679 char **principal,
680 DATA_BLOB *secblob);
681 DATA_BLOB spnego_gen_krb5_wrap(TALLOC_CTX *ctx, const DATA_BLOB ticket, const uint8_t tok_id[2]);
683 /* The following definitions come from libsmb/conncache.c */
685 NTSTATUS check_negative_conn_cache( const char *domain, const char *server);
686 void add_failed_connection_entry(const char *domain, const char *server, NTSTATUS result) ;
687 void flush_negative_conn_cache_for_domain(const char *domain);
689 /* The following definitions come from libsmb/errormap.c */
691 NTSTATUS dos_to_ntstatus(uint8_t eclass, uint32_t ecode);
693 /* The following definitions come from libsmb/namecache.c */
695 bool namecache_store(const char *name,
696 int name_type,
697 int num_names,
698 struct ip_service *ip_list);
699 bool namecache_fetch(const char *name,
700 int name_type,
701 struct ip_service **ip_list,
702 int *num_names);
703 bool namecache_delete(const char *name, int name_type);
704 void namecache_flush(void);
705 bool namecache_status_store(const char *keyname, int keyname_type,
706 int name_type, const struct sockaddr_storage *keyip,
707 const char *srvname);
708 bool namecache_status_fetch(const char *keyname,
709 int keyname_type,
710 int name_type,
711 const struct sockaddr_storage *keyip,
712 char *srvname_out);
714 /* The following definitions come from libsmb/namequery_dc.c */
716 bool get_dc_name(const char *domain,
717 const char *realm,
718 fstring srv_name,
719 struct sockaddr_storage *ss_out);
721 /* The following definitions come from libsmb/smberr.c */
723 const char *smb_dos_err_name(uint8_t e_class, uint16_t num);
724 const char *get_dos_error_msg(WERROR result);
725 const char *smb_dos_err_class(uint8_t e_class);
726 WERROR map_werror_from_unix(int error);
728 /* The following definitions come from libsmb/trusts_util.c */
730 struct netlogon_creds_cli_context;
731 struct messaging_context;
732 struct dcerpc_binding_handle;
733 char *trust_pw_new_value(TALLOC_CTX *mem_ctx,
734 enum netr_SchannelType sec_channel_type,
735 int security);
736 NTSTATUS trust_pw_change(struct netlogon_creds_cli_context *context,
737 struct messaging_context *msg_ctx,
738 struct dcerpc_binding_handle *b,
739 const char *domain,
740 const char *dcname,
741 bool force);
743 /* The following definitions come from param/loadparm.c */
745 const struct loadparm_substitution *loadparm_s3_global_substitution(void);
747 char *lp_parm_substituted_string(TALLOC_CTX *mem_ctx,
748 const struct loadparm_substitution *lp_sub,
749 int snum,
750 const char *type,
751 const char *option,
752 const char *def);
754 #include "source3/param/param_proto.h"
756 char *lp_servicename(TALLOC_CTX *ctx, const struct loadparm_substitution *, int);
757 const char *lp_const_servicename(int);
758 bool lp_autoloaded(int);
759 const char *lp_dnsdomain(void);
760 int lp_winbind_max_domain_connections(void);
761 bool lp_idmap_range(const char *domain_name, uint32_t *low, uint32_t *high);
762 bool lp_idmap_default_range(uint32_t *low, uint32_t *high);
763 const char *lp_idmap_backend(const char *domain_name);
764 const char *lp_idmap_default_backend (void);
765 int lp_security(void);
766 int lp_client_max_protocol(void);
767 int lp_client_ipc_min_protocol(void);
768 int lp_client_ipc_max_protocol(void);
769 int lp_client_ipc_signing(void);
770 int lp_smb2_max_credits(void);
771 int lp_cups_encrypt(void);
772 bool lp_widelinks(int );
773 int lp_rpc_low_port(void);
774 int lp_rpc_high_port(void);
775 bool lp_lanman_auth(void);
776 enum samba_weak_crypto lp_weak_crypto(void);
778 int lp_wi_scan_global_parametrics(
779 const char *regex, size_t max_matches,
780 bool (*cb)(const char *string, regmatch_t matches[],
781 void *private_data),
782 void *private_data);
784 const char *lp_parm_const_string(int snum, const char *type, const char *option, const char *def);
785 struct loadparm_service;
786 const char *lp_parm_const_string_service(struct loadparm_service *service, const char *type,
787 const char *option, const char *def);
788 const char **lp_parm_string_list(int snum, const char *type, const char *option, const char **def);
789 int lp_parm_int(int snum, const char *type, const char *option, int def);
790 unsigned long lp_parm_ulong(int snum, const char *type, const char *option, unsigned long def);
791 unsigned long long lp_parm_ulonglong(int snum, const char *type,
792 const char *option,
793 unsigned long long def);
794 bool lp_parm_bool(int snum, const char *type, const char *option, bool def);
795 struct enum_list;
796 int lp_parm_enum(int snum, const char *type, const char *option,
797 const struct enum_list *_enum, int def);
798 char *canonicalize_servicename(TALLOC_CTX *ctx, const char *src);
799 bool lp_add_home(const char *pszHomename, int iDefaultService,
800 const char *user, const char *pszHomedir);
801 int lp_add_service(const char *pszService, int iDefaultService);
802 bool lp_add_printer(const char *pszPrintername, int iDefaultService);
803 bool lp_parameter_is_valid(const char *pszParmName);
804 bool lp_parameter_is_global(const char *pszParmName);
805 bool lp_canonicalize_parameter(const char *parm_name, const char **canon_parm,
806 bool *inverse);
807 bool lp_canonicalize_parameter_with_value(const char *parm_name,
808 const char *val,
809 const char **canon_parm,
810 const char **canon_val);
811 void show_parameter_list(void);
812 bool lp_invert_boolean(const char *str, const char **inverse_str);
813 bool lp_canonicalize_boolean(const char *str, const char**canon_str);
814 bool process_registry_service(const char *service_name);
815 bool process_registry_shares(void);
816 bool lp_config_backend_is_registry(void);
817 bool lp_config_backend_is_file(void);
818 bool lp_file_list_changed(void);
819 const char *lp_ldap_machine_suffix(TALLOC_CTX *ctx);
820 const char *lp_ldap_user_suffix(TALLOC_CTX *ctx);
821 const char *lp_ldap_group_suffix(TALLOC_CTX *ctx);
822 const char *lp_ldap_idmap_suffix(TALLOC_CTX *ctx);
823 struct parm_struct;
824 /* Return a pointer to a service by name. */
825 struct loadparm_service *lp_service(const char *pszServiceName);
826 struct loadparm_service *lp_servicebynum(int snum);
827 struct loadparm_service *lp_default_loadparm_service(void);
828 void *lp_parm_ptr(struct loadparm_service *service, struct parm_struct *parm);
829 void *lp_local_ptr_by_snum(int snum, struct parm_struct *parm);
830 bool lp_do_parameter(int snum, const char *pszParmName, const char *pszParmValue);
831 bool lp_set_cmdline(const char *pszParmName, const char *pszParmValue);
832 bool dump_a_parameter(int snum, char *parm_name, FILE * f, bool isGlobal);
833 bool lp_snum_ok(int iService);
834 void lp_add_one_printer(const char *name, const char *comment,
835 const char *location, void *pdata);
836 bool lp_loaded(void);
837 void lp_killunused(struct smbd_server_connection *sconn,
838 bool (*snumused) (struct smbd_server_connection *, int));
839 void lp_kill_all_services(void);
840 void lp_killservice(int iServiceIn);
841 const char* server_role_str(uint32_t role);
842 enum usershare_err parse_usershare_file(TALLOC_CTX *ctx,
843 SMB_STRUCT_STAT *psbuf,
844 const char *servicename,
845 int snum,
846 char **lines,
847 int numlines,
848 char **pp_sharepath,
849 char **pp_comment,
850 char **pp_cp_share_name,
851 struct security_descriptor **ppsd,
852 bool *pallow_guest);
853 int load_usershare_service(const char *servicename);
854 int load_usershare_shares(struct smbd_server_connection *sconn,
855 bool (*snumused) (struct smbd_server_connection *, int));
856 void gfree_loadparm(void);
857 bool lp_load_initial_only(const char *pszFname);
858 bool lp_load_global(const char *file_name);
859 bool lp_load_with_shares(const char *file_name);
860 bool lp_load_client(const char *file_name);
861 bool lp_load_global_no_reinit(const char *file_name);
862 bool lp_load_no_reinit(const char *file_name);
863 bool lp_load_client_no_reinit(const char *file_name);
864 bool lp_load_with_registry_shares(const char *pszFname);
865 int lp_numservices(void);
866 void lp_dump(FILE *f, bool show_defaults, int maxtoprint);
867 void lp_dump_one(FILE * f, bool show_defaults, int snum);
868 int lp_servicenumber(const char *pszServiceName);
869 const char *volume_label(TALLOC_CTX *ctx, int snum);
870 bool lp_domain_master(void);
871 bool lp_preferred_master(void);
872 void lp_remove_service(int snum);
873 void lp_copy_service(int snum, const char *new_name);
874 int lp_default_server_announce(void);
875 const char *lp_printername(TALLOC_CTX *ctx,
876 const struct loadparm_substitution *lp_sub,
877 int snum);
878 void lp_set_logfile(const char *name);
879 int lp_maxprintjobs(int snum);
880 const char *lp_printcapname(void);
881 bool lp_disable_spoolss( void );
882 void lp_set_spoolss_state( uint32_t state );
883 uint32_t lp_get_spoolss_state( void );
884 struct smb_signing_state;
885 void set_use_sendfile(int snum, bool val);
886 void lp_set_mangling_method(const char *new_method);
887 bool lp_posix_pathnames(void);
888 void lp_set_posix_pathnames(void);
889 enum brl_flavour lp_posix_cifsu_locktype(files_struct *fsp);
890 void lp_set_posix_default_cifsx_readwrite_locktype(enum brl_flavour val);
891 int lp_min_receive_file_size(void);
892 void widelinks_warning(int snum);
893 const char *lp_ncalrpc_dir(void);
894 void _lp_set_server_role(int server_role);
896 /* The following definitions come from param/loadparm_ctx.c */
898 const struct loadparm_s3_helpers *loadparm_s3_helpers(void);
900 /* The following definitions come from param/loadparm_server_role.c */
902 int lp_server_role(void);
903 void set_server_role(void);
905 /* The following definitions come from param/util.c */
907 uint32_t get_int_param( const char* param );
908 char* get_string_param( const char* param );
910 /* The following definitions come from lib/server_contexts.c */
911 struct tevent_context *global_event_context(void);
912 void global_event_context_free(void);
913 struct messaging_context *global_messaging_context(void);
914 void global_messaging_context_free(void);
916 /* The following definitions come from lib/sessionid_tdb.c */
917 struct sessionid;
918 NTSTATUS sessionid_traverse_read(int (*fn)(const char *key,
919 struct sessionid *session,
920 void *private_data),
921 void *private_data);
923 /* The following definitions come from lib/avahi.c */
925 struct AvahiPoll *tevent_avahi_poll(TALLOC_CTX *mem_ctx,
926 struct tevent_context *ev);
928 /* The following definitions come from libsmb/smbsock_connect.c */
930 struct tevent_req *smbsock_connect_send(TALLOC_CTX *mem_ctx,
931 struct tevent_context *ev,
932 const struct sockaddr_storage *addr,
933 uint16_t port,
934 const char *called_name,
935 int called_type,
936 const char *calling_name,
937 int calling_type);
938 NTSTATUS smbsock_connect_recv(struct tevent_req *req, int *sock,
939 uint16_t *ret_port);
940 NTSTATUS smbsock_connect(const struct sockaddr_storage *addr, uint16_t port,
941 const char *called_name, int called_type,
942 const char *calling_name, int calling_type,
943 int *pfd, uint16_t *ret_port, int sec_timeout);
945 struct tevent_req *smbsock_any_connect_send(TALLOC_CTX *mem_ctx,
946 struct tevent_context *ev,
947 const struct sockaddr_storage *addrs,
948 const char **called_names,
949 int *called_types,
950 const char **calling_names,
951 int *calling_types,
952 size_t num_addrs, uint16_t port);
953 NTSTATUS smbsock_any_connect_recv(struct tevent_req *req, int *pfd,
954 size_t *chosen_index, uint16_t *chosen_port);
955 NTSTATUS smbsock_any_connect(const struct sockaddr_storage *addrs,
956 const char **called_names,
957 int *called_types,
958 const char **calling_names,
959 int *calling_types,
960 size_t num_addrs,
961 uint16_t port,
962 int sec_timeout,
963 int *pfd, size_t *chosen_index,
964 uint16_t *chosen_port);
966 /* The following definitions come from lib/util_wellknown.c */
968 bool sid_check_is_wellknown_domain(const struct dom_sid *sid, const char **name);
969 bool sid_check_is_in_wellknown_domain(const struct dom_sid *sid);
970 bool lookup_wellknown_sid(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
971 const char **domain, const char **name);
972 bool lookup_wellknown_name(TALLOC_CTX *mem_ctx, const char *name,
973 struct dom_sid *sid, const char **domain);
975 /* The following definitions come from lib/util_specialsids.c */
976 bool sid_check_is_asserted_identity(const struct dom_sid *sid);
977 bool sid_check_is_in_asserted_identity(const struct dom_sid *sid);
978 const char *asserted_identity_domain_name(void);
980 /* The following definitions come from lib/filename_util.c */
982 NTSTATUS get_full_smb_filename(TALLOC_CTX *ctx, const struct smb_filename *smb_fname,
983 char **full_name);
984 struct smb_filename *synthetic_smb_fname(TALLOC_CTX *mem_ctx,
985 const char *base_name,
986 const char *stream_name,
987 const SMB_STRUCT_STAT *psbuf,
988 NTTIME twrp,
989 uint32_t flags);
990 struct smb_filename *synthetic_smb_fname_split(TALLOC_CTX *ctx,
991 const char *fname,
992 bool posix_path);
993 const char *smb_fname_str_dbg(const struct smb_filename *smb_fname);
994 const char *fsp_str_dbg(const struct files_struct *fsp);
995 const char *fsp_fnum_dbg(const struct files_struct *fsp);
996 struct smb_filename *cp_smb_filename(TALLOC_CTX *mem_ctx,
997 const struct smb_filename *in);
998 struct smb_filename *cp_smb_filename_nostream(TALLOC_CTX *mem_ctx,
999 const struct smb_filename *in);
1000 bool is_ntfs_stream_smb_fname(const struct smb_filename *smb_fname);
1001 bool is_ntfs_default_stream_smb_fname(const struct smb_filename *smb_fname);
1002 bool is_named_stream(const struct smb_filename *smb_fname);
1003 bool is_invalid_windows_ea_name(const char *name);
1004 bool ea_list_has_invalid_name(struct ea_list *ea_list);
1005 bool split_stream_filename(TALLOC_CTX *ctx,
1006 const char *filename_in,
1007 char **filename_out,
1008 char **streamname_out);
1010 /* The following definitions come from lib/dummyroot.c */
1012 void become_root(void);
1013 void unbecome_root(void);
1015 /* The following definitions come from lib/smbd_shim.c */
1017 int find_service(TALLOC_CTX *ctx, const char *service_in, char **p_service_out);
1018 void send_stat_cache_delete_message(struct messaging_context *msg_ctx,
1019 const char *name);
1020 NTSTATUS can_delete_directory_fsp(files_struct *fsp);
1021 bool change_to_root_user(void);
1022 bool become_authenticated_pipe_user(struct auth_session_info *session_info);
1023 bool unbecome_authenticated_pipe_user(void);
1025 void contend_level2_oplocks_begin(files_struct *fsp,
1026 enum level2_contention_type type);
1027 void contend_level2_oplocks_end(files_struct *fsp,
1028 enum level2_contention_type type);
1030 /* The following definitions come from lib/per_thread_cwd.c */
1032 void per_thread_cwd_check(void);
1033 bool per_thread_cwd_supported(void);
1034 void per_thread_cwd_disable(void);
1035 void per_thread_cwd_activate(void);
1037 #endif /* _PROTO_H_ */