util: Add become_daemon.h
[Samba.git] / lib / util / samba_util.h
blob3daf3dfdfd09c2bfed9428f2bcc4e0d889117a80
1 /*
2 Unix SMB/CIFS implementation.
3 Utility functions for Samba
4 Copyright (C) Andrew Tridgell 1992-1999
5 Copyright (C) Jelmer Vernooij 2005
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef _SAMBA_UTIL_H_
22 #define _SAMBA_UTIL_H_
24 #ifndef SAMBA_UTIL_CORE_ONLY
25 #include "lib/util/charset/charset.h"
26 #else
27 #include "charset_compat.h"
28 #endif
30 #include "lib/util/attr.h"
32 /* for TALLOC_CTX */
33 #include <talloc.h>
35 /* for struct stat */
36 #include <sys/stat.h>
38 /**
39 * @file
40 * @brief Helpful macros
43 struct smbsrv_tcon;
45 extern const char *panic_action;
47 #include "lib/util/time.h"
48 #include "lib/util/data_blob.h"
49 #include "lib/util/byteorder.h"
50 #include "lib/util/talloc_stack.h"
52 #ifndef ABS
53 #define ABS(a) ((a)>0?(a):(-(a)))
54 #endif
56 #include "lib/util/memory.h"
58 #include "fault.h"
60 #include "lib/util/util.h"
62 /**
63 * Write backtrace to debug log
65 _PUBLIC_ void dump_core_setup(const char *progname, const char *logfile);
67 /**
68 register a fault handler.
69 Should only be called once in the execution of smbd.
71 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
73 #include "lib/util/signal.h" /* Avoid /usr/include/signal.h */
75 struct sockaddr;
77 _PUBLIC_ int sys_getnameinfo(const struct sockaddr *psa,
78 int salen,
79 char *host,
80 size_t hostlen,
81 char *service,
82 size_t servlen,
83 int flags);
85 /* The following definitions come from lib/util/genrand.c */
87 #include "lib/util/genrand.h"
89 /**
90 generate a single random uint32_t
91 **/
92 _PUBLIC_ uint32_t generate_random(void);
94 /**
95 very basic password quality checker
96 **/
97 _PUBLIC_ bool check_password_quality(const char *s);
99 /**
100 * Generate a random text password (based on printable ascii characters).
101 * This function is designed to provide a password that
102 * meats the complexity requirements of UF_NORMAL_ACCOUNT objects
103 * and they should be human readable and writeable on any keyboard layout.
105 * Characters used are:
106 * ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,@$%&!?:;<=>()[]~
108 _PUBLIC_ char *generate_random_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
111 * Generate a random machine password
113 * min and max are the number of utf16 characters used
114 * to generate on utf8 compatible password.
116 * Note: if 'unix charset' is not 'utf8' (the default)
117 * then each utf16 character is only filled with
118 * values from 0x01 to 0x7f (ascii values without 0x00).
119 * This is important as the password neets to be
120 * a valid value as utf8 string and at the same time
121 * a valid value in the 'unix charset'.
123 * If 'unix charset' is 'utf8' (the default) then
124 * each utf16 character is a random value from 0x0000
125 * 0xFFFF (exluding the surrogate ranges from 0xD800-0xDFFF)
126 * while the translation from CH_UTF16MUNGED
127 * to CH_UTF8 replaces invalid values (see utf16_munged_pull()).
129 * Note: these passwords may not pass the complexity requirements
130 * for UF_NORMAL_ACCOUNT objects (except krbtgt accounts).
132 _PUBLIC_ char *generate_random_machine_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
135 Use the random number generator to generate a random string.
137 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
140 * Generate a random text string consisting of the specified length.
141 * The returned string will be allocated.
143 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
145 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
148 * Generate an array of unique text strings all of the same length.
149 * The returned strings will be allocated.
150 * Returns NULL if the number of unique combinations cannot be created.
152 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
154 _PUBLIC_ char** generate_unique_strs(TALLOC_CTX *mem_ctx, size_t len,
155 uint32_t num);
157 /* The following definitions come from lib/util/dprintf.c */
159 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
160 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
161 _PUBLIC_ void display_set_stderr(void);
163 /* The following definitions come from lib/util/util_str.c */
165 bool next_token_talloc(TALLOC_CTX *ctx,
166 const char **ptr,
167 char **pp_buff,
168 const char *sep);
171 * Get the next token from a string, return false if none found. Handles
172 * double-quotes. This version does not trim leading separator characters
173 * before looking for a token.
175 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
176 const char **ptr,
177 char **pp_buff,
178 const char *sep);
182 Trim the specified elements off the front and back of a string.
184 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
187 Find the number of 'c' chars in a string
189 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
192 Routine to get hex characters and turn them into a 16 byte array.
193 the array can be variable length, and any non-hex-numeric
194 characters are skipped. "0xnn" or "0Xnn" is specially catered
195 for.
197 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
201 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
203 /**
204 * Parse a hex string and return a data blob.
206 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
209 * Parse a hex dump and return a data blob
211 _PUBLIC_ _PURE_ DATA_BLOB hexdump_to_data_blob(TALLOC_CTX *mem_ctx, const char *hexdump, size_t len);
214 * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
216 _PUBLIC_ void hex_encode_buf(char *dst, const uint8_t *src, size_t srclen);
219 * talloc version of hex_encode_buf()
221 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
223 #include "substitute.h"
226 Unescape a URL encoded string, in place.
228 _PUBLIC_ void rfc1738_unescape(char *buf);
232 * rfc1738_escape
233 * Returns a static buffer that contains the RFC
234 * 1738 compliant, escaped version of the given url. (escapes unsafe and % characters)
236 _PUBLIC_ char *rfc1738_escape(TALLOC_CTX *mem_ctx, const char *url);
239 * rfc1738_escape_unescaped
241 * Returns a static buffer that contains
242 * the RFC 1738 compliant, escaped version of the given url (escapes unsafe chars only)
244 _PUBLIC_ char *rfc1738_escape_unescaped(TALLOC_CTX *mem_ctx, const char *url);
247 * rfc1738_escape_part
248 * Returns a static buffer that contains the RFC
249 * 1738 compliant, escaped version of the given url segment. (escapes
250 * unsafe, reserved and % chars) It would mangle the :// in http://,
251 * and mangle paths (because of /).
253 _PUBLIC_ char *rfc1738_escape_part(TALLOC_CTX *mem_ctx, const char *url);
256 varient of strcmp() that handles NULL ptrs
258 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
261 return the number of bytes occupied by a buffer in ASCII format
262 the result includes the null termination
263 limited by 'n' bytes
265 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
268 Set a boolean variable from the text value stored in the passed string.
269 Returns true in success, false if the passed string does not correctly
270 represent a boolean.
272 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
275 * Parse a string containing a boolean value.
277 * val will be set to the read value.
279 * @retval true if a boolean value was parsed, false otherwise.
281 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
284 * Convert a size specification like 16K into an integral number of bytes.
286 _PUBLIC_ bool conv_str_size_error(const char * str, uint64_t * val);
289 * Parse a uint64_t value from a string
291 * val will be set to the value read.
293 * @retval true if parsing was successful, false otherwise
295 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
298 return the number of bytes occupied by a buffer in CH_UTF16 format
299 the result includes the null termination
301 _PUBLIC_ size_t utf16_len(const void *buf);
304 return the number of bytes occupied by a buffer in CH_UTF16 format
305 the result includes the null termination
306 limited by 'n' bytes
308 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
309 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
312 * @brief Constant time compare to memory regions.
314 * @param[in] s1 The first memory region to compare.
316 * @param[in] s2 The second memory region to compare.
318 * @param[in] n The length of the memory to comapre.
320 * @return 0 when the memory regions are equal, 0 if not.
322 _PUBLIC_ int memcmp_const_time(const void *s1, const void *s2, size_t n);
325 Do a case-insensitive, whitespace-ignoring string compare.
327 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
330 String replace.
332 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
335 * Compare 2 strings.
337 * @note The comparison is case-insensitive.
339 _PUBLIC_ bool strequal(const char *s1, const char *s2);
341 #include "util_strlist.h"
343 /* The following definitions come from lib/util/util_strlist_v3.c */
346 * Needed for making an "unconst" list "const"
348 _PUBLIC_ const char **const_str_list(char **list);
351 * str_list_make, v3 version. The v4 version does not
352 * look at quoted strings with embedded blanks, so
353 * do NOT merge this function please!
355 char **str_list_make_v3(TALLOC_CTX *mem_ctx, const char *string,
356 const char *sep);
359 const char **str_list_make_v3_const(TALLOC_CTX *mem_ctx,
360 const char *string,
361 const char *sep);
363 /* The following definitions come from lib/util/util_file.c */
367 * Read one line (data until next newline or eof) and allocate it
369 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
371 char *fgets_slash(TALLOC_CTX *mem_ctx, char *s2, int maxlen, FILE *f);
374 load a file into memory from a fd.
376 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
379 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
382 load a file into memory
384 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
387 load a file into memory and return an array of pointers to lines in the file
388 must be freed with talloc_free().
390 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
393 load a fd into memory and return an array of pointers to lines in the file
394 must be freed with talloc_free(). If convert is true calls unix_to_dos on
395 the list.
397 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
399 _PUBLIC_ bool file_save_mode(const char *fname, const void *packet,
400 size_t length, mode_t mode);
402 save a lump of data into a file. Mostly used for debugging
404 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
405 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
406 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
409 compare two files, return true if the two files have the same content
411 bool file_compare(const char *path1, const char *path2);
413 /* The following definitions come from lib/util/util.c */
417 Find a suitable temporary directory. The result should be copied immediately
418 as it may be overwritten by a subsequent call.
420 _PUBLIC_ const char *tmpdir(void);
423 * Creates and immediately unlinks a file. Returns open file descriptor.
425 _PUBLIC_ int create_unlink_tmp(const char *dir);
428 Check if a file exists - call vfs_file_exist for samba files.
430 _PUBLIC_ bool file_exist(const char *fname);
433 Check a files mod time.
435 _PUBLIC_ time_t file_modtime(const char *fname);
438 Check if a directory exists.
440 _PUBLIC_ bool directory_exist(const char *dname);
443 Check file permissions.
445 _PUBLIC_ bool file_check_permissions(const char *fname,
446 uid_t uid,
447 mode_t file_perms,
448 struct stat *pst);
451 * Try to create the specified directory if it didn't exist.
453 * @retval true if the directory already existed and has the right permissions
454 * or was successfully created.
456 _PUBLIC_ bool directory_create_or_exist(const char *dname, mode_t dir_perms);
458 _PUBLIC_ bool directory_create_or_exist_strict(const char *dname,
459 uid_t uid,
460 mode_t dir_perms);
462 #include "blocking.h"
465 Sleep for a specified number of milliseconds.
467 _PUBLIC_ void smb_msleep(unsigned int t);
470 Get my own name, return in talloc'ed storage.
472 _PUBLIC_ char* get_myname(TALLOC_CTX *mem_ctx);
475 Check if a process exists. Does this work on all unixes?
477 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
480 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
481 is dealt with in posix.c
483 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
486 * Write dump of binary data to the log file.
488 * The data is only written if the log level is at least level.
489 * 16 zero bytes in a row are omitted
491 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
494 malloc that aborts with smb_panic on fail or zero size.
496 _PUBLIC_ void *smb_xmalloc(size_t size);
499 Memdup with smb_panic on fail.
501 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
504 strdup that aborts on malloc fail.
506 _PUBLIC_ char *smb_xstrdup(const char *s);
508 char *smb_xstrndup(const char *s, size_t n);
511 Like strdup but for memory.
513 _PUBLIC_ void *smb_memdup(const void *p, size_t size);
516 * Write a password to the log file.
518 * @note Only actually does something if DEBUG_PASSWORD was defined during
519 * compile-time.
521 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
524 * see if a range of memory is all zero. A NULL pointer is considered
525 * to be all zero
527 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
530 realloc an array, checking for integer overflow in the array size
532 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
534 void *malloc_array(size_t el_size, unsigned int count);
536 void *memalign_array(size_t el_size, size_t align, unsigned int count);
538 void *calloc_array(size_t size, size_t nmemb);
540 /* The following definitions come from lib/util/fsusage.c */
544 * Retrieve amount of free disk space.
545 * this does all of the system specific guff to get the free disk space.
546 * It is derived from code in the GNU fileutils package, but has been
547 * considerably mangled for use here
549 * results are returned in *dfree and *dsize, in 512 byte units
551 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
553 /* The following definitions come from lib/util/ms_fnmatch.c */
557 * @file
558 * @brief MS-style Filename matching
561 int ms_fnmatch_protocol(const char *pattern, const char *string, int protocol,
562 bool is_case_sensitive);
564 /** a generic fnmatch function - uses for non-CIFS pattern matching */
565 int gen_fnmatch(const char *pattern, const char *string);
567 #include "idtree.h"
568 #include "idtree_random.h"
570 #include "become_daemon.h"
573 * @brief Get a password from the console.
575 * You should make sure that the buffer is an empty string!
577 * You can also use this function to ask for a username. Then you can fill the
578 * buffer with the username and it is shows to the users. If the users just
579 * presses enter the buffer will be untouched.
581 * @code
582 * char username[128];
584 * snprintf(username, sizeof(username), "john");
586 * smb_getpass("Username:", username, sizeof(username), 1, 0);
587 * @endcode
589 * The prompt will look like this:
591 * Username: [john]
593 * If you press enter then john is used as the username, or you can type it in
594 * to change it.
596 * @param[in] prompt The prompt to show to ask for the password.
598 * @param[out] buf The buffer the password should be stored. It NEEDS to be
599 * empty or filled out.
601 * @param[in] len The length of the buffer.
603 * @param[in] echo Should we echo what you type.
605 * @param[in] verify Should we ask for the password twice.
607 * @return 0 on success, -1 on error.
609 _PUBLIC_ int samba_getpass(const char *prompt, char *buf, size_t len,
610 bool echo, bool verify);
613 * Load a ini-style file.
615 bool pm_process( const char *fileName,
616 bool (*sfunc)(const char *, void *),
617 bool (*pfunc)(const char *, const char *, void *),
618 void *userdata);
619 bool pm_process_with_flags(const char *filename,
620 bool allow_empty_values,
621 bool (*sfunc)(const char *section, void *private_data),
622 bool (*pfunc)(const char *name, const char *value,
623 void *private_data),
624 void *private_data);
626 void print_asc(int level, const uint8_t *buf,int len);
627 void print_asc_cb(const uint8_t *buf, int len,
628 void (*cb)(const char *buf, void *private_data),
629 void *private_data);
632 * Add an id to an array of ids.
634 * num should be a pointer to an integer that holds the current
635 * number of elements in ids. It will be updated by this function.
638 bool add_uid_to_array_unique(TALLOC_CTX *mem_ctx, uid_t uid,
639 uid_t **uids, uint32_t *num_uids);
640 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
641 gid_t **gids, uint32_t *num_gids);
644 * Allocate anonymous shared memory of the given size
646 void *anonymous_shared_allocate(size_t bufsz);
647 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove);
648 void anonymous_shared_free(void *ptr);
651 run a command as a child process, with a timeout.
653 any stdout/stderr from the child will appear in the Samba logs with
654 the specified log levels
656 If callback is set then the callback is called on completion
657 with the return code from the command
659 struct tevent_context;
660 struct tevent_req;
661 struct tevent_req *samba_runcmd_send(TALLOC_CTX *mem_ctx,
662 struct tevent_context *ev,
663 struct timeval endtime,
664 int stdout_log_level,
665 int stderr_log_level,
666 const char * const *argv0, ...);
667 int samba_runcmd_recv(struct tevent_req *req, int *perrno);
669 #ifdef DEVELOPER
670 void samba_start_debugger(void);
671 #endif
674 * Samba code should use samba_tevent_context_init() instead of
675 * tevent_context_init() in order to get the debug output.
677 struct tevent_context *samba_tevent_context_init(TALLOC_CTX *mem_ctx);
680 * if same samba code needs to use a specific tevent backend
681 * it can use something like this:
683 * samba_tevent_set_debug(ev, "pysmb_tevent");
685 void samba_tevent_set_debug(struct tevent_context *ev, const char *name);
687 #endif /* _SAMBA_UTIL_H_ */