KCC: improve documentation for KCC.export_ldif()
[Samba.git] / source3 / include / proto.h
blob0858289ad9f4ed1df5dda49d483822b44523454d
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 /* The following definitions come from lib/access.c */
28 bool client_match(const char *tok, const void *item);
29 bool list_match(const char **list,const void *item,
30 bool (*match_fn)(const char *, const void *));
31 bool allow_access(const char **deny_list,
32 const char **allow_list,
33 const char *cname,
34 const char *caddr);
36 /* The following definitions come from lib/adt_tree.c */
38 /* The following definitions come from lib/audit.c */
40 const char *audit_category_str(uint32_t category);
41 const char *audit_param_str(uint32_t category);
42 const char *audit_description_str(uint32_t category);
43 bool get_audit_category_from_param(const char *param, uint32_t *audit_category);
44 const char *audit_policy_str(TALLOC_CTX *mem_ctx, uint32_t policy);
46 /* The following definitions come from lib/charcnv.c */
48 void gfree_charcnv(void);
49 size_t ucs2_align(const void *base_ptr, const void *p, int flags);
50 size_t push_ascii(void *dest, const char *src, size_t dest_len, int flags);
51 size_t push_ascii_fstring(void *dest, const char *src);
52 size_t push_ascii_nstring(void *dest, const char *src);
53 size_t pull_ascii(char *dest, const void *src, size_t dest_len, size_t src_len, int flags);
54 size_t pull_ascii_fstring(char *dest, const void *src);
55 size_t pull_ascii_nstring(char *dest, size_t dest_len, const void *src);
56 size_t push_string_check_fn(void *dest, const char *src,
57 size_t dest_len, int flags);
58 size_t push_string_base(const char *base, uint16_t flags2,
59 void *dest, const char *src,
60 size_t dest_len, int flags);
61 size_t pull_string_talloc(TALLOC_CTX *ctx,
62 const void *base_ptr,
63 uint16_t smb_flags2,
64 char **ppdest,
65 const void *src,
66 size_t src_len,
67 int flags);
68 size_t dos_PutUniCode(char *dst,const char *src, size_t len, bool null_terminate);
69 int rpcstr_push_talloc(TALLOC_CTX *ctx, smb_ucs2_t **dest, const char *src);
71 /* The following definitions come from lib/dmallocmsg.c */
73 void register_dmalloc_msgs(struct messaging_context *msg_ctx);
75 /* The following definitions come from lib/dprintf.c */
77 void display_set_stderr(void);
79 /* The following definitions come from lib/errmap_unix.c */
81 NTSTATUS map_nt_error_from_unix(int unix_error);
82 int map_errno_from_nt_status(NTSTATUS status);
84 /* The following definitions come from lib/file_id.c */
86 struct file_id vfs_file_id_from_sbuf(connection_struct *conn, const SMB_STRUCT_STAT *sbuf);
88 /* The following definitions come from lib/gencache.c */
90 bool gencache_set(const char *keystr, const char *value, time_t timeout);
91 bool gencache_del(const char *keystr);
92 bool gencache_get(const char *keystr, TALLOC_CTX *mem_ctx, char **value,
93 time_t *ptimeout);
94 bool gencache_parse(const char *keystr,
95 void (*parser)(time_t timeout, DATA_BLOB blob,
96 void *private_data),
97 void *private_data);
98 bool gencache_get_data_blob(const char *keystr, TALLOC_CTX *mem_ctx,
99 DATA_BLOB *blob,
100 time_t *timeout, bool *was_expired);
101 bool gencache_stabilize(void);
102 bool gencache_set_data_blob(const char *keystr, const DATA_BLOB *blob, time_t timeout);
103 void gencache_iterate_blobs(void (*fn)(const char *key, DATA_BLOB value,
104 time_t timeout, void *private_data),
105 void *private_data, const char *pattern);
106 void gencache_iterate(void (*fn)(const char* key, const char *value, time_t timeout, void* dptr),
107 void* data, const char* keystr_pattern);
109 /* The following definitions come from lib/interface.c */
111 bool ismyaddr(const struct sockaddr *ip);
112 bool ismyip_v4(struct in_addr ip);
113 bool is_local_net(const struct sockaddr *from);
114 void setup_linklocal_scope_id(struct sockaddr *pss);
115 bool is_local_net_v4(struct in_addr from);
116 int iface_count(void);
117 int iface_count_v4_nl(void);
118 const struct in_addr *first_ipv4_iface(void);
119 struct interface *get_interface(int n);
120 const struct sockaddr_storage *iface_n_sockaddr_storage(int n);
121 const struct in_addr *iface_n_ip_v4(int n);
122 const struct in_addr *iface_n_bcast_v4(int n);
123 const struct sockaddr_storage *iface_n_bcast(int n);
124 const struct sockaddr_storage *iface_ip(const struct sockaddr *ip);
125 bool iface_local(const struct sockaddr *ip);
126 void load_interfaces(void);
127 void gfree_interfaces(void);
128 bool interfaces_changed(void);
130 /* The following definitions come from lib/ldap_debug_handler.c */
132 void init_ldap_debugging(void);
134 /* The following definitions come from lib/ldap_escape.c */
136 char *escape_ldap_string(TALLOC_CTX *mem_ctx, const char *s);
137 char *escape_rdn_val_string_alloc(const char *s);
139 /* The following definitions come from lib/ms_fnmatch.c */
141 int ms_fnmatch(const char *pattern, const char *string, bool translate_pattern,
142 bool is_case_sensitive);
144 /* The following definitions come from lib/recvfile.c */
146 ssize_t sys_recvfile(int fromfd,
147 int tofd,
148 off_t offset,
149 size_t count);
150 ssize_t sys_recvfile(int fromfd,
151 int tofd,
152 off_t offset,
153 size_t count);
154 ssize_t drain_socket(int sockfd, size_t count);
156 /* The following definitions come from lib/sendfile.c */
158 ssize_t sys_sendfile(int tofd, int fromfd, const DATA_BLOB *header, off_t offset, size_t count);
160 /* The following definitions come from lib/server_mutex.c */
162 struct named_mutex *grab_named_mutex(TALLOC_CTX *mem_ctx, const char *name,
163 int timeout);
165 /* The following definitions come from lib/sharesec.c */
167 bool share_info_db_init(void);
168 struct security_descriptor *get_share_security_default( TALLOC_CTX *ctx, size_t *psize, uint32_t def_access);
169 struct security_descriptor *get_share_security( TALLOC_CTX *ctx, const char *servicename,
170 size_t *psize);
171 bool set_share_security(const char *share_name, struct security_descriptor *psd);
172 bool delete_share_security(const char *servicename);
173 bool share_access_check(const struct security_token *token,
174 const char *sharename,
175 uint32_t desired_access,
176 uint32_t *pgranted);
177 bool parse_usershare_acl(TALLOC_CTX *ctx, const char *acl_str, struct security_descriptor **ppsd);
179 /* The following definitions come from lib/smbrun.c */
181 int smbrun_no_sanitize(const char *cmd, int *outfd);
182 int smbrun(const char *cmd, int *outfd);
183 int smbrunsecret(const char *cmd, const char *secret);
185 /* The following definitions come from lib/sock_exec.c */
187 int sock_exec(const char *prog);
189 /* The following definitions come from lib/substitute.c */
191 void free_local_machine_name(void);
192 bool set_local_machine_name(const char *local_name, bool perm);
193 const char *get_local_machine_name(void);
194 bool set_remote_machine_name(const char *remote_name, bool perm);
195 const char *get_remote_machine_name(void);
196 void sub_set_smb_name(const char *name);
197 void set_current_user_info(const char *smb_name, const char *unix_name,
198 const char *domain);
199 void sub_set_socket_ids(const char *peeraddr, const char *peername,
200 const char *sockaddr);
201 const char *get_current_username(void);
202 void standard_sub_basic(const char *smb_name, const char *domain_name,
203 char *str, size_t len);
204 char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name,
205 const char *domain_name, const char *str);
206 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
207 const char *input_string,
208 const char *username,
209 const char *grpname,
210 const char *domain,
211 uid_t uid,
212 gid_t gid);
213 char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
214 const char *servicename, const char *user,
215 const char *connectpath, gid_t gid,
216 const char *smb_name, const char *domain_name,
217 const char *str);
218 void standard_sub_advanced(const char *servicename, const char *user,
219 const char *connectpath, gid_t gid,
220 const char *smb_name, const char *domain_name,
221 char *str, size_t len);
223 /* The following definitions come from lib/sysquotas.c */
225 int sys_get_quota(const char *path, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
226 int sys_set_quota(const char *path, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
228 /* The following definitions come from lib/sysquotas_*.c */
230 int sys_get_vfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
231 int sys_set_vfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
233 int sys_get_xfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
234 int sys_set_xfs_quota(const char *path, const char *bdev, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dp);
236 int sys_get_nfs_quota(const char *path, const char *bdev,
237 enum SMB_QUOTA_TYPE qtype,
238 unid_t id, SMB_DISK_QUOTA *dp);
239 int sys_set_nfs_quota(const char *path, const char *bdev,
240 enum SMB_QUOTA_TYPE qtype,
241 unid_t id, SMB_DISK_QUOTA *dp);
243 /* The following definitions come from lib/system.c */
245 ssize_t sys_send(int s, const void *msg, size_t len, int flags);
246 ssize_t sys_recvfrom(int s, void *buf, size_t len, int flags, struct sockaddr *from, socklen_t *fromlen);
247 int sys_fcntl_ptr(int fd, int cmd, void *arg);
248 int sys_fcntl_long(int fd, int cmd, long arg);
249 void update_stat_ex_mtime(struct stat_ex *dst, struct timespec write_ts);
250 void update_stat_ex_create_time(struct stat_ex *dst, struct timespec create_time);
251 int sys_stat(const char *fname, SMB_STRUCT_STAT *sbuf,
252 bool fake_dir_create_times);
253 int sys_fstat(int fd, SMB_STRUCT_STAT *sbuf,
254 bool fake_dir_create_times);
255 int sys_lstat(const char *fname,SMB_STRUCT_STAT *sbuf,
256 bool fake_dir_create_times);
257 int sys_posix_fallocate(int fd, off_t offset, off_t len);
258 int sys_fallocate(int fd, uint32_t mode, off_t offset, off_t len);
259 void kernel_flock(int fd, uint32_t share_mode, uint32_t access_mask);
260 DIR *sys_fdopendir(int fd);
261 int sys_mknod(const char *path, mode_t mode, SMB_DEV_T dev);
262 int sys_waitpid(pid_t pid,int *status,int options);
263 char *sys_getwd(void);
264 void set_effective_capability(enum smbd_capability capability);
265 void drop_effective_capability(enum smbd_capability capability);
266 long sys_random(void);
267 void sys_srandom(unsigned int seed);
268 int groups_max(void);
269 int sys_getgroups(int setlen, gid_t *gidset);
270 int sys_setgroups(gid_t UNUSED(primary_gid), int setlen, gid_t *gidset);
271 int sys_popen(const char *command);
272 int sys_pclose(int fd);
273 ssize_t sys_getxattr (const char *path, const char *name, void *value, size_t size);
274 ssize_t sys_fgetxattr (int filedes, const char *name, void *value, size_t size);
275 ssize_t sys_listxattr (const char *path, char *list, size_t size);
276 ssize_t sys_flistxattr (int filedes, char *list, size_t size);
277 int sys_removexattr (const char *path, const char *name);
278 int sys_fremovexattr (int filedes, const char *name);
279 int sys_setxattr (const char *path, const char *name, const void *value, size_t size, int flags);
280 int sys_fsetxattr (int filedes, const char *name, const void *value, size_t size, int flags);
281 uint32_t unix_dev_major(SMB_DEV_T dev);
282 uint32_t unix_dev_minor(SMB_DEV_T dev);
283 #if 0
284 int sys_get_number_of_cores(void);
285 #endif
287 struct stat;
288 void init_stat_ex_from_stat (struct stat_ex *dst,
289 const struct stat *src,
290 bool fake_dir_create_times);
292 /* The following definitions come from lib/system_smbd.c */
294 bool getgroups_unix_user(TALLOC_CTX *mem_ctx, const char *user,
295 gid_t primary_gid,
296 gid_t **ret_groups, uint32_t *p_ngroups);
298 /* The following definitions come from lib/tallocmsg.c */
300 void register_msg_pool_usage(struct messaging_context *msg_ctx);
302 /* The following definitions come from lib/time.c */
304 void push_dos_date(uint8_t *buf, int offset, time_t unixdate, int zone_offset);
305 void push_dos_date2(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
306 void push_dos_date3(uint8_t *buf,int offset,time_t unixdate, int zone_offset);
307 uint32_t convert_time_t_to_uint32_t(time_t t);
308 time_t convert_uint32_t_to_time_t(uint32_t u);
309 bool nt_time_is_zero(const NTTIME *nt);
310 time_t generalized_to_unix_time(const char *str);
311 int get_server_zone_offset(void);
312 int set_server_zone_offset(time_t t);
313 char *timeval_string(TALLOC_CTX *ctx, const struct timeval *tp, bool hires);
314 char *current_timestring(TALLOC_CTX *ctx, bool hires);
315 void srv_put_dos_date(char *buf,int offset,time_t unixdate);
316 void srv_put_dos_date2(char *buf,int offset, time_t unixdate);
317 void srv_put_dos_date3(char *buf,int offset,time_t unixdate);
318 void round_timespec(enum timestamp_set_resolution res, struct timespec *ts);
319 void put_long_date_timespec(enum timestamp_set_resolution res, char *p, struct timespec ts);
320 void put_long_date(char *p, time_t t);
321 void dos_filetime_timespec(struct timespec *tsp);
322 time_t make_unix_date(const void *date_ptr, int zone_offset);
323 time_t make_unix_date2(const void *date_ptr, int zone_offset);
324 time_t make_unix_date3(const void *date_ptr, int zone_offset);
325 time_t srv_make_unix_date(const void *date_ptr);
326 time_t srv_make_unix_date2(const void *date_ptr);
327 time_t srv_make_unix_date3(const void *date_ptr);
328 struct timespec interpret_long_date(const char *p);
329 void TimeInit(void);
330 void get_process_uptime(struct timeval *ret_time);
331 void get_startup_time(struct timeval *ret_time);
332 time_t nt_time_to_unix_abs(const NTTIME *nt);
333 time_t uint64s_nt_time_to_unix_abs(const uint64_t *src);
334 void unix_to_nt_time_abs(NTTIME *nt, time_t t);
335 const char *time_to_asc(const time_t t);
336 const char *display_time(NTTIME nttime);
337 bool nt_time_is_set(const NTTIME *nt);
339 /* The following definitions come from lib/username.c */
341 void flush_pwnam_cache(void);
342 char *get_user_home_dir(TALLOC_CTX *mem_ctx, const char *user);
343 struct passwd *Get_Pwnam_alloc(TALLOC_CTX *mem_ctx, const char *user);
345 /* The following definitions come from lib/util_names.c */
346 const char *get_global_sam_name(void);
348 /* The following definitions come from lib/util.c */
350 enum protocol_types get_Protocol(void);
351 void set_Protocol(enum protocol_types p);
352 bool all_zero(const uint8_t *ptr, size_t size);
353 void gfree_names(void);
354 void gfree_all( void );
355 const char *my_netbios_names(int i);
356 bool set_netbios_aliases(const char **str_array);
357 bool init_names(void);
358 bool file_exist_stat(const char *fname,SMB_STRUCT_STAT *sbuf,
359 bool fake_dir_create_times);
360 bool socket_exist(const char *fname);
361 uint64_t get_file_size_stat(const SMB_STRUCT_STAT *sbuf);
362 bool check_same_dev_ino(const SMB_STRUCT_STAT *sbuf1,
363 const SMB_STRUCT_STAT *sbuf2);
364 bool check_same_stat(const SMB_STRUCT_STAT *sbuf1,
365 const SMB_STRUCT_STAT *sbuf2);
366 void show_msg(const char *buf);
367 int set_message_bcc(char *buf,int num_bytes);
368 ssize_t message_push_blob(uint8_t **outbuf, DATA_BLOB blob);
369 char *unix_clean_name(TALLOC_CTX *ctx, const char *s);
370 char *clean_name(TALLOC_CTX *ctx, const char *s);
371 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, off_t pos);
372 int set_blocking(int fd, bool set);
373 NTSTATUS init_before_fork(void);
374 NTSTATUS reinit_after_fork(struct messaging_context *msg_ctx,
375 struct tevent_context *ev_ctx,
376 bool parent_longlived);
377 NTSTATUS smbd_reinit_after_fork(struct messaging_context *msg_ctx,
378 struct tevent_context *ev_ctx,
379 bool parent_longlived);
380 void *malloc_(size_t size);
381 void *Realloc(void *p, size_t size, bool free_old_on_error);
382 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
383 void *element, void *_array, uint32_t *num_elements,
384 ssize_t *array_size);
385 char *get_myname(TALLOC_CTX *ctx);
386 char *get_mydnsdomname(TALLOC_CTX *ctx);
387 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name);
388 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name);
389 bool process_exists(const struct server_id pid);
390 bool processes_exist(const struct server_id *pids, int num_pids,
391 bool *results);
392 const char *uidtoname(uid_t uid);
393 char *gidtoname(gid_t gid);
394 uid_t nametouid(const char *name);
395 gid_t nametogid(const char *name);
396 void smb_panic_s3(const char *why);
397 void log_stack_trace(void);
398 const char *readdirname(DIR *p);
399 bool is_in_path(const char *name, name_compare_entry *namelist, bool case_sensitive);
400 void set_namearray(name_compare_entry **ppname_array, const char *namelist);
401 void free_namearray(name_compare_entry *name_array);
402 bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
403 bool fcntl_getlock(int fd, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
404 bool is_myname(const char *s);
405 void ra_lanman_string( const char *native_lanman );
406 const char *get_remote_arch_str(void);
407 void set_remote_arch(enum remote_arch_types type);
408 enum remote_arch_types get_remote_arch(void);
409 const char *tab_depth(int level, int depth);
410 int str_checksum(const char *s);
411 void zero_free(void *p, size_t size);
412 int set_maxfiles(int requested_max);
413 int smb_mkstemp(char *name_template);
414 void *smb_xmalloc_array(size_t size, unsigned int count);
415 char *myhostname(void);
416 char *myhostname_upper(void);
417 char *lock_path(const char *name);
418 char *state_path(const char *name);
419 char *cache_path(const char *name);
420 bool parent_dirname(TALLOC_CTX *mem_ctx, const char *dir, char **parent,
421 const char **name);
422 bool ms_has_wild(const char *s);
423 bool ms_has_wild_w(const smb_ucs2_t *s);
424 bool mask_match(const char *string, const char *pattern, bool is_case_sensitive);
425 bool mask_match_search(const char *string, const char *pattern, bool is_case_sensitive);
426 bool mask_match_list(const char *string, char **list, int listLen, bool is_case_sensitive);
427 bool unix_wild_match(const char *pattern, const char *string);
428 bool name_to_fqdn(fstring fqdn, const char *name);
429 void *talloc_append_blob(TALLOC_CTX *mem_ctx, void *buf, DATA_BLOB blob);
430 uint32_t map_share_mode_to_deny_mode(uint32_t share_access, uint32_t private_options);
431 pid_t procid_to_pid(const struct server_id *proc);
432 void set_my_vnn(uint32_t vnn);
433 uint32_t get_my_vnn(void);
434 void set_my_unique_id(uint64_t unique_id);
435 struct server_id pid_to_procid(pid_t pid);
436 struct server_id procid_self(void);
437 #define serverid_equal(p1, p2) server_id_equal(p1,p2)
438 bool procid_is_me(const struct server_id *pid);
439 struct server_id interpret_pid(const char *pid_string);
440 bool procid_valid(const struct server_id *pid);
441 bool procid_is_local(const struct server_id *pid);
442 bool is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off);
443 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off);
444 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off);
445 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval);
446 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval);
447 void split_domain_user(TALLOC_CTX *mem_ctx,
448 const char *full_name,
449 char **domain,
450 char **user);
451 const char *strip_hostname(const char *s);
452 bool any_nt_status_not_ok(NTSTATUS err1, NTSTATUS err2, NTSTATUS *result);
453 int timeval_to_msec(struct timeval t);
454 char *valid_share_pathname(TALLOC_CTX *ctx, const char *dos_pathname);
455 bool is_executable(const char *fname);
456 bool map_open_params_to_ntcreate(const char *smb_base_fname,
457 int deny_mode, int open_func,
458 uint32_t *paccess_mask,
459 uint32_t *pshare_mode,
460 uint32_t *pcreate_disposition,
461 uint32_t *pcreate_options,
462 uint32_t *pprivate_flags);
463 struct security_unix_token *copy_unix_token(TALLOC_CTX *ctx, const struct security_unix_token *tok);
464 bool dir_check_ftype(uint32_t mode, uint32_t dirtype);
465 void init_modules(void);
467 /* The following definitions come from lib/util_builtin.c */
469 bool lookup_builtin_rid(TALLOC_CTX *mem_ctx, uint32_t rid, const char **name);
470 bool lookup_builtin_name(const char *name, uint32_t *rid);
471 const char *builtin_domain_name(void);
472 bool sid_check_is_builtin(const struct dom_sid *sid);
473 bool sid_check_is_in_builtin(const struct dom_sid *sid);
474 bool sid_check_is_wellknown_builtin(const struct dom_sid *sid);
476 /* The following definitions come from lib/util_file.c */
478 char **file_lines_pload(const char *syscmd, int *numlines);
479 void file_lines_free(char **lines);
481 /* The following definitions come from lib/util_nscd.c */
483 void smb_nscd_flush_user_cache(void);
484 void smb_nscd_flush_group_cache(void);
486 /* The following definitions come from lib/util_nttoken.c */
488 struct security_token *dup_nt_token(TALLOC_CTX *mem_ctx, const struct security_token *ptoken);
489 NTSTATUS merge_nt_token(TALLOC_CTX *mem_ctx,
490 const struct security_token *token_1,
491 const struct security_token *token_2,
492 struct security_token **token_out);
493 bool token_sid_in_ace(const struct security_token *token, const struct security_ace *ace);
495 /* The following definitions come from lib/util_sec.c */
497 void sec_init(void);
498 uid_t sec_initial_uid(void);
499 gid_t sec_initial_gid(void);
500 bool root_mode(void);
501 bool non_root_mode(void);
502 void gain_root_privilege(void);
503 void gain_root_group_privilege(void);
504 void set_effective_uid(uid_t uid);
505 void set_effective_gid(gid_t gid);
506 void save_re_uid(void);
507 void restore_re_uid_fromroot(void);
508 void restore_re_uid(void);
509 void save_re_gid(void);
510 void restore_re_gid(void);
511 int set_re_uid(void);
512 void become_user_permanently(uid_t uid, gid_t gid);
513 int set_thread_credentials(uid_t uid,
514 gid_t gid,
515 size_t setlen,
516 const gid_t *gidset);
517 bool is_setuid_root(void) ;
519 /* The following definitions come from lib/util_sid.c */
521 char *sid_to_fstring(fstring sidstr_out, const struct dom_sid *sid);
522 char *sid_string_talloc(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
523 char *sid_string_dbg(const struct dom_sid *sid);
524 char *sid_string_tos(const struct dom_sid *sid);
525 bool sid_linearize(char *outbuf, size_t len, const struct dom_sid *sid);
526 bool non_mappable_sid(struct dom_sid *sid);
527 char *sid_binstring_hex_talloc(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
528 struct netr_SamInfo3;
529 NTSTATUS sid_array_from_info3(TALLOC_CTX *mem_ctx,
530 const struct netr_SamInfo3 *info3,
531 struct dom_sid **user_sids,
532 uint32_t *num_user_sids,
533 bool include_user_group_rid);
535 /* The following definitions come from lib/util_sock.c */
537 bool is_broadcast_addr(const struct sockaddr *pss);
538 bool is_loopback_ip_v4(struct in_addr ip);
539 bool is_loopback_addr(const struct sockaddr *pss);
540 bool is_zero_addr(const struct sockaddr_storage *pss);
541 void zero_ip_v4(struct in_addr *ip);
542 void in_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
543 struct in_addr ip);
544 bool same_net(const struct sockaddr *ip1,
545 const struct sockaddr *ip2,
546 const struct sockaddr *mask);
547 bool sockaddr_equal(const struct sockaddr *ip1,
548 const struct sockaddr *ip2);
549 bool is_address_any(const struct sockaddr *psa);
550 uint16_t get_sockaddr_port(const struct sockaddr_storage *pss);
551 char *print_sockaddr(char *dest,
552 size_t destlen,
553 const struct sockaddr_storage *psa);
554 char *print_canonical_sockaddr(TALLOC_CTX *ctx,
555 const struct sockaddr_storage *pss);
556 int get_socket_port(int fd);
557 const char *client_addr(int fd, char *addr, size_t addrlen);
558 const char *client_socket_addr(int fd, char *addr, size_t addr_len);
559 int client_socket_port(int fd);
560 bool is_a_socket(int fd);
561 void set_socket_options(int fd, const char *options);
562 ssize_t read_udp_v4_socket(int fd,
563 char *buf,
564 size_t len,
565 struct sockaddr_storage *psa);
566 NTSTATUS read_fd_with_timeout(int fd, char *buf,
567 size_t mincnt, size_t maxcnt,
568 unsigned int time_out,
569 size_t *size_ret);
570 NTSTATUS read_data_ntstatus(int fd, char *buffer, size_t N);
572 bool send_keepalive(int client);
573 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
574 unsigned int timeout,
575 size_t *len);
576 NTSTATUS receive_smb_raw(int fd,
577 char *buffer,
578 size_t buflen,
579 unsigned int timeout,
580 size_t maxlen,
581 size_t *p_len);
582 int open_socket_in(int type,
583 uint16_t port,
584 int dlevel,
585 const struct sockaddr_storage *psock,
586 bool rebind);
587 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
588 int timeout, int *pfd);
589 struct tevent_req *open_socket_out_send(TALLOC_CTX *mem_ctx,
590 struct tevent_context *ev,
591 const struct sockaddr_storage *pss,
592 uint16_t port,
593 int timeout);
594 NTSTATUS open_socket_out_recv(struct tevent_req *req, int *pfd);
595 struct tevent_req *open_socket_out_defer_send(TALLOC_CTX *mem_ctx,
596 struct tevent_context *ev,
597 struct timeval wait_time,
598 const struct sockaddr_storage *pss,
599 uint16_t port,
600 int timeout);
601 NTSTATUS open_socket_out_defer_recv(struct tevent_req *req, int *pfd);
602 int open_udp_socket(const char *host, int port);
603 const char *get_peer_addr(int fd, char *addr, size_t addr_len);
605 struct tsocket_address;
607 int get_remote_hostname(const struct tsocket_address *remote_address,
608 char **name,
609 TALLOC_CTX *mem_ctx);
611 int create_pipe_sock(const char *socket_dir,
612 const char *socket_name,
613 mode_t dir_perms);
614 int create_tcpip_socket(const struct sockaddr_storage *ifss, uint16_t *port);
615 const char *get_mydnsfullname(void);
616 bool is_myname_or_ipaddr(const char *s);
617 struct tevent_req *getaddrinfo_send(TALLOC_CTX *mem_ctx,
618 struct tevent_context *ev,
619 struct fncall_context *ctx,
620 const char *node,
621 const char *service,
622 const struct addrinfo *hints);
623 int getaddrinfo_recv(struct tevent_req *req, struct addrinfo **res);
624 int poll_one_fd(int fd, int events, int timeout, int *revents);
625 int poll_intr_one_fd(int fd, int events, int timeout, int *revents);
626 struct tstream_context;
627 struct tevent_req *tstream_read_packet_send(TALLOC_CTX *mem_ctx,
628 struct tevent_context *ev,
629 struct tstream_context *stream,
630 size_t initial,
631 ssize_t (*more)(uint8_t *buf,
632 size_t buflen,
633 void *private_data),
634 void *private_data);
635 ssize_t tstream_read_packet_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
636 uint8_t **pbuf, int *perrno);
638 /* The following definitions come from lib/util_str.c */
640 bool next_token(const char **ptr, char *buff, const char *sep, size_t bufsize);
641 bool strnequal(const char *s1,const char *s2,size_t n);
642 bool strcsequal(const char *s1,const char *s2);
643 bool strnorm(char *s, int case_default);
644 char *push_skip_string(char *buf);
645 char *skip_string(const char *base, size_t len, char *buf);
646 size_t str_charnum(const char *s);
647 bool trim_char(char *s,char cfront,char cback);
648 bool strhasupper(const char *s);
649 bool strhaslower(const char *s);
650 char *StrnCpy(char *dest,const char *src,size_t n);
651 bool in_list(const char *s, const char *list, bool casesensitive);
652 void fstring_sub(char *s,const char *pattern,const char *insert);
653 char *realloc_string_sub2(char *string,
654 const char *pattern,
655 const char *insert,
656 bool remove_unsafe_characters,
657 bool allow_trailing_dollar);
658 char *realloc_string_sub(char *string,
659 const char *pattern,
660 const char *insert);
661 char *talloc_string_sub2(TALLOC_CTX *mem_ctx, const char *src,
662 const char *pattern,
663 const char *insert,
664 bool remove_unsafe_characters,
665 bool replace_once,
666 bool allow_trailing_dollar);
667 char *talloc_string_sub(TALLOC_CTX *mem_ctx,
668 const char *src,
669 const char *pattern,
670 const char *insert);
671 void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
672 char *talloc_all_string_sub(TALLOC_CTX *ctx,
673 const char *src,
674 const char *pattern,
675 const char *insert);
676 char *octal_string(int i);
677 char *string_truncate(char *s, unsigned int length);
678 char *strchr_m(const char *src, char c);
679 char *strrchr_m(const char *s, char c);
680 char *strnrchr_m(const char *s, char c, unsigned int n);
681 char *strstr_m(const char *src, const char *findstr);
682 bool strlower_m(char *s);
683 bool strupper_m(char *s);
684 size_t strlen_m(const char *s);
685 size_t strlen_m_term(const char *s);
686 size_t strlen_m_term_null(const char *s);
687 int fstr_sprintf(fstring s, const char *fmt, ...);
688 bool str_list_sub_basic( char **list, const char *smb_name,
689 const char *domain_name );
690 bool str_list_substitute(char **list, const char *pattern, const char *insert);
692 char *ipstr_list_make(char **ipstr_list,
693 const struct ip_service *ip_list,
694 int ip_count);
695 int ipstr_list_parse(const char *ipstr_list, struct ip_service **ip_list);
696 void ipstr_list_free(char* ipstr_list);
697 uint64_t STR_TO_SMB_BIG_UINT(const char *nptr, const char **entptr);
698 uint64_t conv_str_size(const char * str);
699 void sprintf_append(TALLOC_CTX *mem_ctx, char **string, ssize_t *len,
700 size_t *bufsize, const char *fmt, ...);
701 int asprintf_strupper_m(char **strp, const char *fmt, ...);
702 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...);
703 char *talloc_asprintf_strlower_m(TALLOC_CTX *t, const char *fmt, ...);
704 bool validate_net_name( const char *name,
705 const char *invalid_chars,
706 int max_len);
707 char *escape_shell_string(const char *src);
708 ssize_t full_path_tos(const char *dir, const char *name,
709 char *tmpbuf, size_t tmpbuf_len,
710 char **pdst, char **to_free);
712 /* The following definitions come from lib/version.c */
714 const char *samba_version_string(void);
716 /* The following definitions come from lib/wins_srv.c */
718 bool wins_srv_is_dead(struct in_addr wins_ip, struct in_addr src_ip);
719 void wins_srv_alive(struct in_addr wins_ip, struct in_addr src_ip);
720 void wins_srv_died(struct in_addr wins_ip, struct in_addr src_ip);
721 unsigned wins_srv_count(void);
722 char **wins_srv_tags(void);
723 void wins_srv_tags_free(char **list);
724 struct in_addr wins_srv_ip_tag(const char *tag, struct in_addr src_ip);
725 bool wins_server_tag_ips(const char *tag, TALLOC_CTX *mem_ctx,
726 struct in_addr **pservers, int *pnum_servers);
727 unsigned wins_srv_count_tag(const char *tag);
729 /* The following definitions come from libsmb/clispnego.c */
731 DATA_BLOB spnego_gen_negTokenInit(TALLOC_CTX *ctx,
732 const char *OIDs[],
733 DATA_BLOB *psecblob,
734 const char *principal);
736 #ifndef ASN1_MAX_OIDS
737 #define ASN1_MAX_OIDS 20
738 #endif
739 bool spnego_parse_negTokenInit(TALLOC_CTX *ctx,
740 DATA_BLOB blob,
741 char *OIDs[ASN1_MAX_OIDS],
742 char **principal,
743 DATA_BLOB *secblob);
744 DATA_BLOB spnego_gen_krb5_wrap(TALLOC_CTX *ctx, const DATA_BLOB ticket, const uint8_t tok_id[2]);
745 int spnego_gen_krb5_negTokenInit(TALLOC_CTX *ctx,
746 const char *principal, int time_offset,
747 DATA_BLOB *targ,
748 DATA_BLOB *session_key_krb5, uint32_t extra_ap_opts,
749 const char *ccname, time_t *expire_time);
750 bool spnego_parse_challenge(TALLOC_CTX *ctx, const DATA_BLOB blob,
751 DATA_BLOB *chal1, DATA_BLOB *chal2);
752 DATA_BLOB spnego_gen_auth(TALLOC_CTX *ctx, DATA_BLOB blob);
753 bool spnego_parse_auth_response(TALLOC_CTX *ctx,
754 DATA_BLOB blob, NTSTATUS nt_status,
755 const char *mechOID,
756 DATA_BLOB *auth);
758 /* The following definitions come from libsmb/conncache.c */
760 NTSTATUS check_negative_conn_cache( const char *domain, const char *server);
761 void add_failed_connection_entry(const char *domain, const char *server, NTSTATUS result) ;
762 void flush_negative_conn_cache_for_domain(const char *domain);
764 /* The following definitions come from libsmb/dsgetdcname.c */
766 struct netr_DsRGetDCNameInfo;
768 void debug_dsdcinfo_flags(int lvl, uint32_t flags);
769 NTSTATUS dsgetdcname(TALLOC_CTX *mem_ctx,
770 struct messaging_context *msg_ctx,
771 const char *domain_name,
772 const struct GUID *domain_guid,
773 const char *site_name,
774 uint32_t flags,
775 struct netr_DsRGetDCNameInfo **info);
777 /* The following definitions come from libsmb/errormap.c */
779 NTSTATUS dos_to_ntstatus(uint8_t eclass, uint32_t ecode);
781 /* The following definitions come from libsmb/namecache.c */
783 bool namecache_store(const char *name,
784 int name_type,
785 int num_names,
786 struct ip_service *ip_list);
787 bool namecache_fetch(const char *name,
788 int name_type,
789 struct ip_service **ip_list,
790 int *num_names);
791 bool namecache_delete(const char *name, int name_type);
792 void namecache_flush(void);
793 bool namecache_status_store(const char *keyname, int keyname_type,
794 int name_type, const struct sockaddr_storage *keyip,
795 const char *srvname);
796 bool namecache_status_fetch(const char *keyname,
797 int keyname_type,
798 int name_type,
799 const struct sockaddr_storage *keyip,
800 char *srvname_out);
802 /* The following definitions come from libsmb/namequery.c */
804 bool saf_store( const char *domain, const char *servername );
805 bool saf_join_store( const char *domain, const char *servername );
806 bool saf_delete( const char *domain );
807 char *saf_fetch(TALLOC_CTX *mem_ctx, const char *domain );
808 struct tevent_req *node_status_query_send(TALLOC_CTX *mem_ctx,
809 struct tevent_context *ev,
810 struct nmb_name *name,
811 const struct sockaddr_storage *addr);
812 NTSTATUS node_status_query_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
813 struct node_status **pnode_status,
814 int *pnum_names,
815 struct node_status_extra *extra);
816 NTSTATUS node_status_query(TALLOC_CTX *mem_ctx, struct nmb_name *name,
817 const struct sockaddr_storage *addr,
818 struct node_status **pnode_status,
819 int *pnum_names,
820 struct node_status_extra *extra);
821 bool name_status_find(const char *q_name,
822 int q_type,
823 int type,
824 const struct sockaddr_storage *to_ss,
825 fstring name);
826 int remove_duplicate_addrs2(struct ip_service *iplist, int count );
827 struct tevent_req *name_query_send(TALLOC_CTX *mem_ctx,
828 struct tevent_context *ev,
829 const char *name, int name_type,
830 bool bcast, bool recurse,
831 const struct sockaddr_storage *addr);
832 NTSTATUS name_query_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
833 struct sockaddr_storage **addrs, int *num_addrs,
834 uint8_t *flags);
835 NTSTATUS name_query(const char *name, int name_type,
836 bool bcast, bool recurse,
837 const struct sockaddr_storage *to_ss,
838 TALLOC_CTX *mem_ctx,
839 struct sockaddr_storage **addrs,
840 int *num_addrs, uint8_t *flags);
841 struct tevent_req *name_resolve_bcast_send(TALLOC_CTX *mem_ctx,
842 struct tevent_context *ev,
843 const char *name,
844 int name_type);
845 NTSTATUS name_resolve_bcast_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
846 struct sockaddr_storage **addrs,
847 int *num_addrs);
848 NTSTATUS name_resolve_bcast(const char *name,
849 int name_type,
850 TALLOC_CTX *mem_ctx,
851 struct sockaddr_storage **return_iplist,
852 int *return_count);
853 struct tevent_req *resolve_wins_send(TALLOC_CTX *mem_ctx,
854 struct tevent_context *ev,
855 const char *name,
856 int name_type);
857 NTSTATUS resolve_wins_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
858 struct sockaddr_storage **addrs,
859 int *num_addrs, uint8_t *flags);
860 NTSTATUS resolve_wins(const char *name,
861 int name_type,
862 TALLOC_CTX *mem_ctx,
863 struct sockaddr_storage **return_iplist,
864 int *return_count);
865 NTSTATUS internal_resolve_name(const char *name,
866 int name_type,
867 const char *sitename,
868 struct ip_service **return_iplist,
869 int *return_count,
870 const char **resolve_order);
871 bool resolve_name(const char *name,
872 struct sockaddr_storage *return_ss,
873 int name_type,
874 bool prefer_ipv4);
875 NTSTATUS resolve_name_list(TALLOC_CTX *ctx,
876 const char *name,
877 int name_type,
878 struct sockaddr_storage **return_ss_arr,
879 unsigned int *p_num_entries);
880 bool find_master_ip(const char *group, struct sockaddr_storage *master_ss);
881 bool get_pdc_ip(const char *domain, struct sockaddr_storage *pss);
882 NTSTATUS get_sorted_dc_list( const char *domain,
883 const char *sitename,
884 struct ip_service **ip_list,
885 int *count,
886 bool ads_only );
887 NTSTATUS get_kdc_list( const char *realm,
888 const char *sitename,
889 struct ip_service **ip_list,
890 int *count);
892 /* The following definitions come from libsmb/namequery_dc.c */
894 bool get_dc_name(const char *domain,
895 const char *realm,
896 fstring srv_name,
897 struct sockaddr_storage *ss_out);
899 /* The following definitions come from libsmb/ntlmssp.c */
900 struct ntlmssp_state;
901 NTSTATUS ntlmssp_set_username(struct ntlmssp_state *ntlmssp_state, const char *user) ;
902 NTSTATUS ntlmssp_set_password(struct ntlmssp_state *ntlmssp_state, const char *password) ;
903 NTSTATUS ntlmssp_set_password_hash(struct ntlmssp_state *ntlmssp_state,
904 const char *hash);
905 NTSTATUS ntlmssp_set_domain(struct ntlmssp_state *ntlmssp_state, const char *domain) ;
906 void ntlmssp_want_feature_list(struct ntlmssp_state *ntlmssp_state, char *feature_list);
907 void ntlmssp_want_feature(struct ntlmssp_state *ntlmssp_state, uint32_t feature);
908 NTSTATUS ntlmssp_update(struct ntlmssp_state *ntlmssp_state,
909 const DATA_BLOB in, DATA_BLOB *out) ;
910 bool ntlmssp_is_anonymous(struct ntlmssp_state *ntlmssp_state);
911 NTSTATUS ntlmssp_server_start(TALLOC_CTX *mem_ctx,
912 bool is_standalone,
913 const char *netbios_name,
914 const char *netbios_domain,
915 const char *dns_name,
916 const char *dns_domain,
917 struct ntlmssp_state **ntlmssp_state);
918 NTSTATUS ntlmssp_client_start(TALLOC_CTX *mem_ctx,
919 const char *netbios_name,
920 const char *netbios_domain,
921 bool use_ntlmv2,
922 struct ntlmssp_state **_ntlmssp_state);
924 /* The following definitions come from libsmb/passchange.c */
926 NTSTATUS remote_password_change(const char *remote_machine, const char *user_name,
927 const char *old_passwd, const char *new_passwd,
928 char **err_str);
930 /* The following definitions come from libsmb/samlogon_cache.c */
932 bool netsamlogon_cache_init(void);
933 bool netsamlogon_cache_shutdown(void);
934 void netsamlogon_clear_cached_user(const struct dom_sid *user_sid);
935 bool netsamlogon_cache_store(const char *username, struct netr_SamInfo3 *info3);
936 struct netr_SamInfo3 *netsamlogon_cache_get(TALLOC_CTX *mem_ctx, const struct dom_sid *user_sid);
937 bool netsamlogon_cache_have(const struct dom_sid *user_sid);
939 /* The following definitions come from libsmb/smberr.c */
941 const char *smb_dos_err_name(uint8_t e_class, uint16_t num);
942 const char *get_dos_error_msg(WERROR result);
943 const char *smb_dos_err_class(uint8_t e_class);
944 WERROR map_werror_from_unix(int error);
946 /* The following definitions come from libsmb/trustdom_cache.c */
948 bool trustdom_cache_enable(void);
949 bool trustdom_cache_shutdown(void);
950 bool trustdom_cache_store(const char *name, const char *alt_name,
951 const struct dom_sid *sid, time_t timeout);
952 bool trustdom_cache_fetch(const char* name, struct dom_sid* sid);
953 uint32_t trustdom_cache_fetch_timestamp( void );
954 bool trustdom_cache_store_timestamp( uint32_t t, time_t timeout );
955 void trustdom_cache_flush(void);
956 void update_trustdom_cache( void );
958 /* The following definitions come from libsmb/trusts_util.c */
960 struct netlogon_creds_cli_context;
961 struct messaging_context;
962 struct dcerpc_binding_handle;
963 NTSTATUS trust_pw_change(struct netlogon_creds_cli_context *context,
964 struct messaging_context *msg_ctx,
965 struct dcerpc_binding_handle *b,
966 const char *domain,
967 bool force);
969 /* The following definitions come from param/loadparm.c */
971 #include "source3/param/param_proto.h"
973 char *lp_servicename(TALLOC_CTX *ctx, int);
974 const char *lp_const_servicename(int);
975 bool lp_autoloaded(int);
976 const char *lp_dnsdomain(void);
977 int lp_winbind_max_domain_connections(void);
978 bool lp_idmap_range(const char *domain_name, uint32_t *low, uint32_t *high);
979 bool lp_idmap_default_range(uint32_t *low, uint32_t *high);
980 const char *lp_idmap_backend(const char *domain_name);
981 const char *lp_idmap_default_backend (void);
982 int lp_security(void);
983 int lp_client_max_protocol(void);
984 int lp_winbindd_max_protocol(void);
985 int lp_smb2_max_credits(void);
986 int lp_cups_encrypt(void);
987 bool lp_widelinks(int );
989 char *lp_parm_talloc_string(TALLOC_CTX *ctx, int snum, const char *type, const char *option, const char *def);
990 const char *lp_parm_const_string(int snum, const char *type, const char *option, const char *def);
991 struct loadparm_service;
992 const char *lp_parm_const_string_service(struct loadparm_service *service, const char *type,
993 const char *option, const char *def);
994 const char **lp_parm_string_list(int snum, const char *type, const char *option, const char **def);
995 int lp_parm_int(int snum, const char *type, const char *option, int def);
996 unsigned long lp_parm_ulong(int snum, const char *type, const char *option, unsigned long def);
997 bool lp_parm_bool(int snum, const char *type, const char *option, bool def);
998 struct enum_list;
999 int lp_parm_enum(int snum, const char *type, const char *option,
1000 const struct enum_list *_enum, int def);
1001 char *canonicalize_servicename(TALLOC_CTX *ctx, const char *src);
1002 bool lp_add_home(const char *pszHomename, int iDefaultService,
1003 const char *user, const char *pszHomedir);
1004 int lp_add_service(const char *pszService, int iDefaultService);
1005 bool lp_add_printer(const char *pszPrintername, int iDefaultService);
1006 bool lp_parameter_is_valid(const char *pszParmName);
1007 bool lp_parameter_is_global(const char *pszParmName);
1008 bool lp_canonicalize_parameter(const char *parm_name, const char **canon_parm,
1009 bool *inverse);
1010 bool lp_canonicalize_parameter_with_value(const char *parm_name,
1011 const char *val,
1012 const char **canon_parm,
1013 const char **canon_val);
1014 void show_parameter_list(void);
1015 bool lp_invert_boolean(const char *str, const char **inverse_str);
1016 bool lp_canonicalize_boolean(const char *str, const char**canon_str);
1017 bool process_registry_service(const char *service_name);
1018 bool process_registry_shares(void);
1019 bool lp_config_backend_is_registry(void);
1020 bool lp_config_backend_is_file(void);
1021 bool lp_file_list_changed(void);
1022 const char *lp_ldap_machine_suffix(TALLOC_CTX *ctx);
1023 const char *lp_ldap_user_suffix(TALLOC_CTX *ctx);
1024 const char *lp_ldap_group_suffix(TALLOC_CTX *ctx);
1025 const char *lp_ldap_idmap_suffix(TALLOC_CTX *ctx);
1026 struct parm_struct;
1027 /* Return a pointer to a service by name. */
1028 struct loadparm_service *lp_service(const char *pszServiceName);
1029 struct loadparm_service *lp_servicebynum(int snum);
1030 struct loadparm_service *lp_default_loadparm_service(void);
1031 void *lp_parm_ptr(struct loadparm_service *service, struct parm_struct *parm);
1032 void *lp_local_ptr_by_snum(int snum, struct parm_struct *parm);
1033 bool lp_do_parameter(int snum, const char *pszParmName, const char *pszParmValue);
1034 bool lp_set_cmdline(const char *pszParmName, const char *pszParmValue);
1035 bool dump_a_parameter(int snum, char *parm_name, FILE * f, bool isGlobal);
1036 bool lp_snum_ok(int iService);
1037 void lp_add_one_printer(const char *name, const char *comment,
1038 const char *location, void *pdata);
1039 bool lp_loaded(void);
1040 void lp_killunused(struct smbd_server_connection *sconn,
1041 bool (*snumused) (struct smbd_server_connection *, int));
1042 void lp_kill_all_services(void);
1043 void lp_killservice(int iServiceIn);
1044 const char* server_role_str(uint32_t role);
1045 enum usershare_err parse_usershare_file(TALLOC_CTX *ctx,
1046 SMB_STRUCT_STAT *psbuf,
1047 const char *servicename,
1048 int snum,
1049 char **lines,
1050 int numlines,
1051 char **pp_sharepath,
1052 char **pp_comment,
1053 char **pp_cp_share_name,
1054 struct security_descriptor **ppsd,
1055 bool *pallow_guest);
1056 int load_usershare_service(const char *servicename);
1057 int load_usershare_shares(struct smbd_server_connection *sconn,
1058 bool (*snumused) (struct smbd_server_connection *, int));
1059 void gfree_loadparm(void);
1060 bool lp_load_initial_only(const char *pszFname);
1061 bool lp_load_global(const char *file_name);
1062 bool lp_load_with_shares(const char *file_name);
1063 bool lp_load_client(const char *file_name);
1064 bool lp_load_global_no_reinit(const char *file_name);
1065 bool lp_load_no_reinit(const char *file_name);
1066 bool lp_load_client_no_reinit(const char *file_name);
1067 bool lp_load_with_registry_shares(const char *pszFname);
1068 int lp_numservices(void);
1069 void lp_dump(FILE *f, bool show_defaults, int maxtoprint);
1070 void lp_dump_one(FILE * f, bool show_defaults, int snum);
1071 int lp_servicenumber(const char *pszServiceName);
1072 const char *volume_label(TALLOC_CTX *ctx, int snum);
1073 bool lp_domain_master(void);
1074 bool lp_preferred_master(void);
1075 void lp_remove_service(int snum);
1076 void lp_copy_service(int snum, const char *new_name);
1077 int lp_default_server_announce(void);
1078 const char *lp_printername(TALLOC_CTX *ctx, int snum);
1079 void lp_set_logfile(const char *name);
1080 int lp_maxprintjobs(int snum);
1081 const char *lp_printcapname(void);
1082 bool lp_disable_spoolss( void );
1083 void lp_set_spoolss_state( uint32_t state );
1084 uint32_t lp_get_spoolss_state( void );
1085 struct smb_signing_state;
1086 bool lp_use_sendfile(int snum, struct smb_signing_state *signing_state);
1087 void set_use_sendfile(int snum, bool val);
1088 void set_store_dos_attributes(int snum, bool val);
1089 void lp_set_mangling_method(const char *new_method);
1090 bool lp_posix_pathnames(void);
1091 void lp_set_posix_pathnames(void);
1092 enum brl_flavour lp_posix_cifsu_locktype(files_struct *fsp);
1093 void lp_set_posix_default_cifsx_readwrite_locktype(enum brl_flavour val);
1094 int lp_min_receive_file_size(void);
1095 char* lp_perfcount_module(TALLOC_CTX *ctx);
1096 void widelinks_warning(int snum);
1097 const char *lp_ncalrpc_dir(void);
1098 void _lp_set_server_role(int server_role);
1100 /* The following definitions come from param/loadparm_ctx.c */
1102 const struct loadparm_s3_helpers *loadparm_s3_helpers(void);
1104 /* The following definitions come from param/loadparm_server_role.c */
1106 int lp_server_role(void);
1107 void set_server_role(void);
1109 /* The following definitions come from param/util.c */
1111 uint32_t get_int_param( const char* param );
1112 char* get_string_param( const char* param );
1114 /* The following definitions come from lib/server_contexts.c */
1115 struct tevent_context *server_event_context(void);
1116 void server_event_context_free(void);
1117 struct messaging_context *server_messaging_context(void);
1118 void server_messaging_context_free(void);
1120 /* The following definitions come from lib/sessionid_tdb.c */
1121 struct sessionid;
1122 NTSTATUS sessionid_traverse_read(int (*fn)(const char *key,
1123 struct sessionid *session,
1124 void *private_data),
1125 void *private_data);
1127 /* The following definitions come from utils/passwd_util.c */
1129 char *stdin_new_passwd( void);
1130 char *get_pass( const char *prompt, bool stdin_get);
1132 /* The following definitions come from lib/avahi.c */
1134 struct AvahiPoll *tevent_avahi_poll(TALLOC_CTX *mem_ctx,
1135 struct tevent_context *ev);
1137 /* The following definitions come from lib/fncall.c */
1139 struct fncall_context *fncall_context_init(TALLOC_CTX *mem_ctx,
1140 int max_threads);
1141 struct tevent_req *fncall_send(TALLOC_CTX *mem_ctx, struct tevent_context *ev,
1142 struct fncall_context *ctx,
1143 void (*fn)(void *private_data),
1144 void *private_data);
1145 int fncall_recv(struct tevent_req *req, int *perr);
1147 /* The following definitions come from libsmb/smbsock_connect.c */
1149 struct tevent_req *smbsock_connect_send(TALLOC_CTX *mem_ctx,
1150 struct tevent_context *ev,
1151 const struct sockaddr_storage *addr,
1152 uint16_t port,
1153 const char *called_name,
1154 int called_type,
1155 const char *calling_name,
1156 int calling_type);
1157 NTSTATUS smbsock_connect_recv(struct tevent_req *req, int *sock,
1158 uint16_t *ret_port);
1159 NTSTATUS smbsock_connect(const struct sockaddr_storage *addr, uint16_t port,
1160 const char *called_name, int called_type,
1161 const char *calling_name, int calling_type,
1162 int *pfd, uint16_t *ret_port, int sec_timeout);
1164 struct tevent_req *smbsock_any_connect_send(TALLOC_CTX *mem_ctx,
1165 struct tevent_context *ev,
1166 const struct sockaddr_storage *addrs,
1167 const char **called_names,
1168 int *called_types,
1169 const char **calling_names,
1170 int *calling_types,
1171 size_t num_addrs, uint16_t port);
1172 NTSTATUS smbsock_any_connect_recv(struct tevent_req *req, int *pfd,
1173 size_t *chosen_index, uint16_t *chosen_port);
1174 NTSTATUS smbsock_any_connect(const struct sockaddr_storage *addrs,
1175 const char **called_names,
1176 int *called_types,
1177 const char **calling_names,
1178 int *calling_types,
1179 size_t num_addrs,
1180 uint16_t port,
1181 int sec_timeout,
1182 int *pfd, size_t *chosen_index,
1183 uint16_t *chosen_port);
1185 /* The following definitions come from lib/util_wellknown.c */
1187 bool sid_check_is_wellknown_domain(const struct dom_sid *sid, const char **name);
1188 bool sid_check_is_in_wellknown_domain(const struct dom_sid *sid);
1189 bool lookup_wellknown_sid(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
1190 const char **domain, const char **name);
1191 bool lookup_wellknown_name(TALLOC_CTX *mem_ctx, const char *name,
1192 struct dom_sid *sid, const char **domain);
1194 /* The following definitions come from lib/util_unixsids.c */
1196 bool sid_check_is_unix_users(const struct dom_sid *sid);
1197 bool sid_check_is_in_unix_users(const struct dom_sid *sid);
1198 void uid_to_unix_users_sid(uid_t uid, struct dom_sid *sid);
1199 void gid_to_unix_groups_sid(gid_t gid, struct dom_sid *sid);
1200 const char *unix_users_domain_name(void);
1201 bool lookup_unix_user_name(const char *name, struct dom_sid *sid);
1202 bool sid_check_is_unix_groups(const struct dom_sid *sid);
1203 bool sid_check_is_in_unix_groups(const struct dom_sid *sid);
1204 const char *unix_groups_domain_name(void);
1205 bool lookup_unix_group_name(const char *name, struct dom_sid *sid);
1207 /* The following definitions come from lib/filename_util.c */
1209 NTSTATUS get_full_smb_filename(TALLOC_CTX *ctx, const struct smb_filename *smb_fname,
1210 char **full_name);
1211 struct smb_filename *synthetic_smb_fname(TALLOC_CTX *mem_ctx,
1212 const char *base_name,
1213 const char *stream_name,
1214 const SMB_STRUCT_STAT *psbuf);
1215 struct smb_filename *synthetic_smb_fname_split(TALLOC_CTX *ctx,
1216 const char *fname,
1217 const SMB_STRUCT_STAT *psbuf);
1218 const char *smb_fname_str_dbg(const struct smb_filename *smb_fname);
1219 const char *fsp_str_dbg(const struct files_struct *fsp);
1220 const char *fsp_fnum_dbg(const struct files_struct *fsp);
1221 struct smb_filename *cp_smb_filename(TALLOC_CTX *mem_ctx,
1222 const struct smb_filename *in);
1223 bool is_ntfs_stream_smb_fname(const struct smb_filename *smb_fname);
1224 bool is_ntfs_default_stream_smb_fname(const struct smb_filename *smb_fname);
1225 bool is_invalid_windows_ea_name(const char *name);
1226 bool ea_list_has_invalid_name(struct ea_list *ea_list);
1228 /* The following definitions come from lib/dummyroot.c */
1230 void become_root(void);
1231 void unbecome_root(void);
1233 /* The following definitions come from lib/smbd_shim.c */
1235 int find_service(TALLOC_CTX *ctx, const char *service_in, char **p_service_out);
1236 void cancel_pending_lock_requests_by_fid(files_struct *fsp,
1237 struct byte_range_lock *br_lck,
1238 enum file_close_type close_type);
1239 void send_stat_cache_delete_message(struct messaging_context *msg_ctx,
1240 const char *name);
1241 NTSTATUS can_delete_directory_fsp(files_struct *fsp);
1242 bool change_to_root_user(void);
1243 bool become_authenticated_pipe_user(struct auth_session_info *session_info);
1244 bool unbecome_authenticated_pipe_user(void);
1246 void contend_level2_oplocks_begin(files_struct *fsp,
1247 enum level2_contention_type type);
1248 void contend_level2_oplocks_end(files_struct *fsp,
1249 enum level2_contention_type type);
1251 #endif /* _PROTO_H_ */