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