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"
27 #include "charset_compat.h"
30 #include "lib/util/attr.h"
40 * @brief Helpful macros
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"
53 #define ABS(a) ((a)>0?(a):(-(a)))
56 #include "lib/util/memory.h"
57 #include "lib/util/discard.h"
61 #include "lib/util/util.h"
64 * Write backtrace to debug log
66 _PUBLIC_ void dump_core_setup(const char *progname, const char *logfile);
69 register a fault handler.
70 Should only be called once in the execution of smbd.
72 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
74 #include "lib/util/signal.h" /* Avoid /usr/include/signal.h */
78 _PUBLIC_ int sys_getnameinfo(const struct sockaddr *psa,
86 /* The following definitions come from lib/util/genrand.c */
88 #include "lib/util/genrand.h"
91 generate a single random uint32_t
93 _PUBLIC_ uint32_t generate_random(void);
96 very basic password quality checker
98 _PUBLIC_ bool check_password_quality(const char *s);
101 * Generate a random text password (based on printable ascii characters).
102 * This function is designed to provide a password that
103 * meats the complexity requirements of UF_NORMAL_ACCOUNT objects
104 * and they should be human readable and writeable on any keyboard layout.
106 * Characters used are:
107 * ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,@$%&!?:;<=>()[]~
109 _PUBLIC_ char *generate_random_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
112 * Generate a random machine password
114 * min and max are the number of utf16 characters used
115 * to generate on utf8 compatible password.
117 * Note: if 'unix charset' is not 'utf8' (the default)
118 * then each utf16 character is only filled with
119 * values from 0x01 to 0x7f (ascii values without 0x00).
120 * This is important as the password neets to be
121 * a valid value as utf8 string and at the same time
122 * a valid value in the 'unix charset'.
124 * If 'unix charset' is 'utf8' (the default) then
125 * each utf16 character is a random value from 0x0000
126 * 0xFFFF (exluding the surrogate ranges from 0xD800-0xDFFF)
127 * while the translation from CH_UTF16MUNGED
128 * to CH_UTF8 replaces invalid values (see utf16_munged_pull()).
130 * Note: these passwords may not pass the complexity requirements
131 * for UF_NORMAL_ACCOUNT objects (except krbtgt accounts).
133 _PUBLIC_ char *generate_random_machine_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
136 Use the random number generator to generate a random string.
138 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
141 * Generate a random text string consisting of the specified length.
142 * The returned string will be allocated.
144 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
146 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
149 * Generate an array of unique text strings all of the same length.
150 * The returned strings will be allocated.
151 * Returns NULL if the number of unique combinations cannot be created.
153 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
155 _PUBLIC_ char** generate_unique_strs(TALLOC_CTX *mem_ctx, size_t len,
158 /* The following definitions come from lib/util/dprintf.c */
160 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
161 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
162 _PUBLIC_ void display_set_stderr(void);
164 /* The following definitions come from lib/util/util_str.c */
166 bool next_token_talloc(TALLOC_CTX *ctx,
172 * Get the next token from a string, return false if none found. Handles
173 * double-quotes. This version does not trim leading separator characters
174 * before looking for a token.
176 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
183 Trim the specified elements off the front and back of a string.
185 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
188 Find the number of 'c' chars in a string
190 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
193 Routine to get hex characters and turn them into a 16 byte array.
194 the array can be variable length, and any non-hex-numeric
195 characters are skipped. "0xnn" or "0Xnn" is specially catered
198 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
202 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
205 * Parse a hex string and return a data blob.
207 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
210 * Parse a hex dump and return a data blob
212 _PUBLIC_ _PURE_ DATA_BLOB hexdump_to_data_blob(TALLOC_CTX *mem_ctx, const char *hexdump, size_t len);
215 * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
217 _PUBLIC_ void hex_encode_buf(char *dst, const uint8_t *src, size_t srclen);
220 * talloc version of hex_encode_buf()
222 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
224 #include "substitute.h"
227 Unescape a URL encoded string, in place.
229 _PUBLIC_ char *rfc1738_unescape(char *buf);
232 * rfc1738_escape_part
233 * Returns a static buffer that contains the RFC
234 * 1738 compliant, escaped version of the given url segment. (escapes
235 * unsafe, reserved and % chars) It would mangle the :// in http://,
236 * and mangle paths (because of /).
238 _PUBLIC_ char *rfc1738_escape_part(TALLOC_CTX *mem_ctx, const char *url);
241 varient of strcmp() that handles NULL ptrs
243 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
246 return the number of bytes occupied by a buffer in ASCII format
247 the result includes the null termination
250 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
253 Set a boolean variable from the text value stored in the passed string.
254 Returns true in success, false if the passed string does not correctly
257 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
260 * Parse a string containing a boolean value.
262 * val will be set to the read value.
264 * @retval true if a boolean value was parsed, false otherwise.
266 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
269 * Convert a size specification like 16K into an integral number of bytes.
271 _PUBLIC_ bool conv_str_size_error(const char * str, uint64_t * val);
274 * Parse a uint64_t value from a string
276 * val will be set to the value read.
278 * @retval true if parsing was successful, false otherwise
280 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
283 return the number of bytes occupied by a buffer in CH_UTF16 format
284 the result includes the null termination
286 _PUBLIC_ size_t utf16_len(const void *buf);
289 return the number of bytes occupied by a buffer in CH_UTF16 format
290 the result includes the null termination
293 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
294 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
297 * @brief Constant time compare to memory regions.
299 * @param[in] s1 The first memory region to compare.
301 * @param[in] s2 The second memory region to compare.
303 * @param[in] n The length of the memory to comapre.
305 * @return 0 when the memory regions are equal, 0 if not.
307 _PUBLIC_ int memcmp_const_time(const void *s1, const void *s2, size_t n);
310 Do a case-insensitive, whitespace-ignoring string compare.
312 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
317 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
322 * @note The comparison is case-insensitive.
324 _PUBLIC_ bool strequal(const char *s1, const char *s2);
326 #include "util_strlist.h"
328 /* The following definitions come from lib/util/util_strlist_v3.c */
331 * Needed for making an "unconst" list "const"
333 _PUBLIC_ const char **const_str_list(char **list);
336 * str_list_make, v3 version. The v4 version does not
337 * look at quoted strings with embedded blanks, so
338 * do NOT merge this function please!
340 char **str_list_make_v3(TALLOC_CTX *mem_ctx, const char *string,
344 const char **str_list_make_v3_const(TALLOC_CTX *mem_ctx,
348 /* The following definitions come from lib/util/util_file.c */
352 * Read one line (data until next newline or eof) and allocate it
354 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
356 char *fgets_slash(TALLOC_CTX *mem_ctx, char *s2, size_t maxlen, FILE *f);
359 load a file into memory from a fd.
361 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
364 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
367 load a file into memory
369 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
372 load a file into memory and return an array of pointers to lines in the file
373 must be freed with talloc_free().
375 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
378 load a fd into memory and return an array of pointers to lines in the file
379 must be freed with talloc_free(). If convert is true calls unix_to_dos on
382 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
384 _PUBLIC_ bool file_save_mode(const char *fname, const void *packet,
385 size_t length, mode_t mode);
387 save a lump of data into a file. Mostly used for debugging
389 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
390 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
391 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
394 compare two files, return true if the two files have the same content
396 bool file_compare(const char *path1, const char *path2);
399 load from a pipe into memory.
401 char *file_pload(const char *syscmd, size_t *size);
403 /* The following definitions come from lib/util/util.c */
407 Find a suitable temporary directory. The result should be copied immediately
408 as it may be overwritten by a subsequent call.
410 _PUBLIC_ const char *tmpdir(void);
413 * Creates and immediately unlinks a file. Returns open file descriptor.
415 _PUBLIC_ int create_unlink_tmp(const char *dir);
418 Check if a file exists - call vfs_file_exist for samba files.
420 _PUBLIC_ bool file_exist(const char *fname);
423 Check a files mod time.
425 _PUBLIC_ time_t file_modtime(const char *fname);
428 Check if a directory exists.
430 _PUBLIC_ bool directory_exist(const char *dname);
433 Check file permissions.
435 _PUBLIC_ bool file_check_permissions(const char *fname,
441 * Try to create the specified directory if it didn't exist.
443 * @retval true if the directory already existed and has the right permissions
444 * or was successfully created.
446 _PUBLIC_ bool directory_create_or_exist(const char *dname, mode_t dir_perms);
448 _PUBLIC_ bool directory_create_or_exist_strict(const char *dname,
452 #include "blocking.h"
455 Sleep for a specified number of milliseconds.
457 _PUBLIC_ void smb_msleep(unsigned int t);
460 Get my own name, return in talloc'ed storage.
462 _PUBLIC_ char* get_myname(TALLOC_CTX *mem_ctx);
465 Check if a process exists. Does this work on all unixes?
467 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
470 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
471 is dealt with in posix.c
473 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
476 * Write dump of binary data to the log file.
478 * The data is only written if the log level is at least level.
479 * 16 zero bytes in a row are omitted
481 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
484 malloc that aborts with smb_panic on fail or zero size.
486 _PUBLIC_ void *smb_xmalloc(size_t size);
489 Memdup with smb_panic on fail.
491 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
494 strdup that aborts on malloc fail.
496 _PUBLIC_ char *smb_xstrdup(const char *s);
498 char *smb_xstrndup(const char *s, size_t n);
501 Like strdup but for memory.
503 _PUBLIC_ void *smb_memdup(const void *p, size_t size);
506 * Write a password to the log file.
508 * @note Only actually does something if DEBUG_PASSWORD was defined during
511 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
514 * see if a range of memory is all zero. A NULL pointer is considered
517 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
520 realloc an array, checking for integer overflow in the array size
522 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
524 void *malloc_array(size_t el_size, unsigned int count);
526 void *memalign_array(size_t el_size, size_t align, unsigned int count);
528 void *calloc_array(size_t size, size_t nmemb);
530 /* The following definitions come from lib/util/fsusage.c */
534 * Retrieve amount of free disk space.
535 * this does all of the system specific guff to get the free disk space.
536 * It is derived from code in the GNU fileutils package, but has been
537 * considerably mangled for use here
539 * results are returned in *dfree and *dsize, in 512 byte units
541 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
543 /* The following definitions come from lib/util/ms_fnmatch.c */
548 * @brief MS-style Filename matching
551 int ms_fnmatch_protocol(const char *pattern, const char *string, int protocol,
552 bool is_case_sensitive);
554 /** a generic fnmatch function - uses for non-CIFS pattern matching */
555 int gen_fnmatch(const char *pattern, const char *string);
558 #include "idtree_random.h"
560 #include "become_daemon.h"
563 * @brief Get a password from the console.
565 * You should make sure that the buffer is an empty string!
567 * You can also use this function to ask for a username. Then you can fill the
568 * buffer with the username and it is shows to the users. If the users just
569 * presses enter the buffer will be untouched.
572 * char username[128];
574 * snprintf(username, sizeof(username), "john");
576 * smb_getpass("Username:", username, sizeof(username), 1, 0);
579 * The prompt will look like this:
583 * If you press enter then john is used as the username, or you can type it in
586 * @param[in] prompt The prompt to show to ask for the password.
588 * @param[out] buf The buffer the password should be stored. It NEEDS to be
589 * empty or filled out.
591 * @param[in] len The length of the buffer.
593 * @param[in] echo Should we echo what you type.
595 * @param[in] verify Should we ask for the password twice.
597 * @return 0 on success, -1 on error.
599 _PUBLIC_ int samba_getpass(const char *prompt, char *buf, size_t len,
600 bool echo, bool verify);
603 * Load a ini-style file.
605 bool pm_process( const char *fileName,
606 bool (*sfunc)(const char *, void *),
607 bool (*pfunc)(const char *, const char *, void *),
609 bool pm_process_with_flags(const char *filename,
610 bool allow_empty_values,
611 bool (*sfunc)(const char *section, void *private_data),
612 bool (*pfunc)(const char *name, const char *value,
616 void print_asc(int level, const uint8_t *buf,int len);
617 void print_asc_cb(const uint8_t *buf, int len,
618 void (*cb)(const char *buf, void *private_data),
622 * Add an id to an array of ids.
624 * num should be a pointer to an integer that holds the current
625 * number of elements in ids. It will be updated by this function.
628 bool add_uid_to_array_unique(TALLOC_CTX *mem_ctx, uid_t uid,
629 uid_t **uids, uint32_t *num_uids);
630 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
631 gid_t **gids, uint32_t *num_gids);
634 * Allocate anonymous shared memory of the given size
636 void *anonymous_shared_allocate(size_t bufsz);
637 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove);
638 void anonymous_shared_free(void *ptr);
641 run a command as a child process, with a timeout.
643 any stdout/stderr from the child will appear in the Samba logs with
644 the specified log levels
646 If callback is set then the callback is called on completion
647 with the return code from the command
649 struct tevent_context;
651 struct tevent_req *samba_runcmd_send(TALLOC_CTX *mem_ctx,
652 struct tevent_context *ev,
653 struct timeval endtime,
654 int stdout_log_level,
655 int stderr_log_level,
656 const char * const *argv0, ...);
657 int samba_runcmd_recv(struct tevent_req *req, int *perrno);
658 int samba_runcmd_export_stdin(struct tevent_req *req);
661 void samba_start_debugger(void);
665 * Samba code should use samba_tevent_context_init() instead of
666 * tevent_context_init() in order to get the debug output.
668 struct tevent_context *samba_tevent_context_init(TALLOC_CTX *mem_ctx);
671 * if same samba code needs to use a specific tevent backend
672 * it can use something like this:
674 * samba_tevent_set_debug(ev, "pysmb_tevent");
676 void samba_tevent_set_debug(struct tevent_context *ev, const char *name);
678 #endif /* _SAMBA_UTIL_H_ */