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/xfile.h"
50 #include "lib/util/byteorder.h"
51 #include "lib/util/talloc_stack.h"
54 #define ABS(a) ((a)>0?(a):(-(a)))
57 #include "lib/util/memory.h"
59 #include "../libcli/util/ntstatus.h"
60 #include "lib/util/string_wrappers.h"
64 #include "lib/util/util.h"
67 * Write backtrace to debug log
69 _PUBLIC_ void dump_core_setup(const char *progname, const char *logfile);
72 register a fault handler.
73 Should only be called once in the execution of smbd.
75 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
77 #include "lib/util/signal.h" /* Avoid /usr/include/signal.h */
81 _PUBLIC_ int sys_getnameinfo(const struct sockaddr *psa,
89 /* The following definitions come from lib/util/genrand.c */
91 #include "lib/util/genrand.h"
94 generate a single random uint32_t
96 _PUBLIC_ uint32_t generate_random(void);
99 very basic password quality checker
101 _PUBLIC_ bool check_password_quality(const char *s);
104 * Generate a random text password.
106 _PUBLIC_ char *generate_random_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
109 Use the random number generator to generate a random string.
111 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
114 * Generate a random text string consisting of the specified length.
115 * The returned string will be allocated.
117 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
119 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
122 * Generate an array of unique text strings all of the same length.
123 * The returned strings will be allocated.
124 * Returns NULL if the number of unique combinations cannot be created.
126 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
128 _PUBLIC_ char** generate_unique_strs(TALLOC_CTX *mem_ctx, size_t len,
131 /* The following definitions come from lib/util/dprintf.c */
133 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
134 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
135 _PUBLIC_ void display_set_stderr(void);
137 /* The following definitions come from lib/util/util_str.c */
139 bool next_token_talloc(TALLOC_CTX *ctx,
145 * Get the next token from a string, return false if none found. Handles
146 * double-quotes. This version does not trim leading separator characters
147 * before looking for a token.
149 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
156 Trim the specified elements off the front and back of a string.
158 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
161 Find the number of 'c' chars in a string
163 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
166 Routine to get hex characters and turn them into a 16 byte array.
167 the array can be variable length, and any non-hex-numeric
168 characters are skipped. "0xnn" or "0Xnn" is specially catered
171 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
175 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
178 * Parse a hex string and return a data blob.
180 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
183 * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
185 _PUBLIC_ void hex_encode_buf(char *dst, const uint8_t *src, size_t srclen);
188 * talloc version of hex_encode_buf()
190 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
192 #include "substitute.h"
195 Unescape a URL encoded string, in place.
197 _PUBLIC_ void rfc1738_unescape(char *buf);
202 * Returns a static buffer that contains the RFC
203 * 1738 compliant, escaped version of the given url. (escapes unsafe and % characters)
205 _PUBLIC_ char *rfc1738_escape(TALLOC_CTX *mem_ctx, const char *url);
208 * rfc1738_escape_unescaped
210 * Returns a static buffer that contains
211 * the RFC 1738 compliant, escaped version of the given url (escapes unsafe chars only)
213 _PUBLIC_ char *rfc1738_escape_unescaped(TALLOC_CTX *mem_ctx, const char *url);
216 * rfc1738_escape_part
217 * Returns a static buffer that contains the RFC
218 * 1738 compliant, escaped version of the given url segment. (escapes
219 * unsafe, reserved and % chars) It would mangle the :// in http://,
220 * and mangle paths (because of /).
222 _PUBLIC_ char *rfc1738_escape_part(TALLOC_CTX *mem_ctx, const char *url);
225 varient of strcmp() that handles NULL ptrs
227 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
230 return the number of bytes occupied by a buffer in ASCII format
231 the result includes the null termination
234 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
237 Set a boolean variable from the text value stored in the passed string.
238 Returns true in success, false if the passed string does not correctly
241 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
244 * Parse a string containing a boolean value.
246 * val will be set to the read value.
248 * @retval true if a boolean value was parsed, false otherwise.
250 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
253 * Convert a size specification like 16K into an integral number of bytes.
255 _PUBLIC_ bool conv_str_size_error(const char * str, uint64_t * val);
258 * Parse a uint64_t value from a string
260 * val will be set to the value read.
262 * @retval true if parsing was successful, false otherwise
264 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
267 return the number of bytes occupied by a buffer in CH_UTF16 format
268 the result includes the null termination
270 _PUBLIC_ size_t utf16_len(const void *buf);
273 return the number of bytes occupied by a buffer in CH_UTF16 format
274 the result includes the null termination
277 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
278 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
281 * @brief Constant time compare to memory regions.
283 * @param[in] s1 The first memory region to compare.
285 * @param[in] s2 The second memory region to compare.
287 * @param[in] n The length of the memory to comapre.
289 * @return 0 when the memory regions are equal, 0 if not.
291 _PUBLIC_ int memcmp_const_time(const void *s1, const void *s2, size_t n);
294 Do a case-insensitive, whitespace-ignoring string compare.
296 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
301 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
306 * @note The comparison is case-insensitive.
308 _PUBLIC_ bool strequal(const char *s1, const char *s2);
310 #include "util_strlist.h"
312 /* The following definitions come from lib/util/util_strlist_v3.c */
315 * Needed for making an "unconst" list "const"
317 _PUBLIC_ const char **const_str_list(char **list);
320 * str_list_make, v3 version. The v4 version does not
321 * look at quoted strings with embedded blanks, so
322 * do NOT merge this function please!
324 char **str_list_make_v3(TALLOC_CTX *mem_ctx, const char *string,
328 const char **str_list_make_v3_const(TALLOC_CTX *mem_ctx,
332 /* The following definitions come from lib/util/util_file.c */
336 * Read one line (data until next newline or eof) and allocate it
338 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
341 load a file into memory from a fd.
343 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
346 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
349 load a file into memory
351 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
354 load a file into memory and return an array of pointers to lines in the file
355 must be freed with talloc_free().
357 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
360 load a fd into memory and return an array of pointers to lines in the file
361 must be freed with talloc_free(). If convert is true calls unix_to_dos on
364 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
366 _PUBLIC_ bool file_save_mode(const char *fname, const void *packet,
367 size_t length, mode_t mode);
369 save a lump of data into a file. Mostly used for debugging
371 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
372 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
373 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
376 compare two files, return true if the two files have the same content
378 bool file_compare(const char *path1, const char *path2);
380 /* The following definitions come from lib/util/util.c */
384 Find a suitable temporary directory. The result should be copied immediately
385 as it may be overwritten by a subsequent call.
387 _PUBLIC_ const char *tmpdir(void);
390 * Creates and immediately unlinks a file. Returns open file descriptor.
392 _PUBLIC_ int create_unlink_tmp(const char *dir);
395 Check if a file exists - call vfs_file_exist for samba files.
397 _PUBLIC_ bool file_exist(const char *fname);
400 Check a files mod time.
402 _PUBLIC_ time_t file_modtime(const char *fname);
405 Check if a directory exists.
407 _PUBLIC_ bool directory_exist(const char *dname);
410 Check file permissions.
412 _PUBLIC_ bool file_check_permissions(const char *fname,
418 * Try to create the specified directory if it didn't exist.
420 * @retval true if the directory already existed and has the right permissions
421 * or was successfully created.
423 _PUBLIC_ bool directory_create_or_exist(const char *dname, mode_t dir_perms);
425 _PUBLIC_ bool directory_create_or_exist_strict(const char *dname,
429 #include "blocking.h"
432 Sleep for a specified number of milliseconds.
434 _PUBLIC_ void smb_msleep(unsigned int t);
437 Get my own name, return in talloc'ed storage.
439 _PUBLIC_ char* get_myname(TALLOC_CTX *mem_ctx);
442 Check if a process exists. Does this work on all unixes?
444 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
447 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
448 is dealt with in posix.c
450 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
453 * Write dump of binary data to the log file.
455 * The data is only written if the log level is at least level.
456 * 16 zero bytes in a row are omitted
458 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
461 malloc that aborts with smb_panic on fail or zero size.
463 _PUBLIC_ void *smb_xmalloc(size_t size);
466 Memdup with smb_panic on fail.
468 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
471 strdup that aborts on malloc fail.
473 _PUBLIC_ char *smb_xstrdup(const char *s);
475 char *smb_xstrndup(const char *s, size_t n);
478 Like strdup but for memory.
480 _PUBLIC_ void *smb_memdup(const void *p, size_t size);
483 * Write a password to the log file.
485 * @note Only actually does something if DEBUG_PASSWORD was defined during
488 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
491 * see if a range of memory is all zero. A NULL pointer is considered
494 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
497 realloc an array, checking for integer overflow in the array size
499 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
501 void *malloc_array(size_t el_size, unsigned int count);
503 void *memalign_array(size_t el_size, size_t align, unsigned int count);
505 void *calloc_array(size_t size, size_t nmemb);
507 /* The following definitions come from lib/util/fsusage.c */
511 * Retrieve amount of free disk space.
512 * this does all of the system specific guff to get the free disk space.
513 * It is derived from code in the GNU fileutils package, but has been
514 * considerably mangled for use here
516 * results are returned in *dfree and *dsize, in 512 byte units
518 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
520 /* The following definitions come from lib/util/ms_fnmatch.c */
525 * @brief MS-style Filename matching
528 int ms_fnmatch_protocol(const char *pattern, const char *string, int protocol);
530 /** a generic fnmatch function - uses for non-CIFS pattern matching */
531 int gen_fnmatch(const char *pattern, const char *string);
534 #include "idtree_random.h"
537 Close the low 3 fd's and open dev/null in their place
539 _PUBLIC_ void close_low_fds(bool stdin_too, bool stdout_too, bool stderr_too);
542 Become a daemon, discarding the controlling terminal.
544 _PUBLIC_ void become_daemon(bool do_fork, bool no_process_group, bool log_stdout);
547 Exit daemon and print error message to the log at level 0
548 Optionally report failure to systemd if systemd integration is enabled
550 _PUBLIC_ void exit_daemon(const char *msg, int error);
553 Report that the daemon is ready to serve connections to the log at level 0
554 Optionally report status to systemd if systemd integration is enabled
556 _PUBLIC_ void daemon_ready(const char *daemon);
559 * Report the daemon status. For example if it is not ready to serve connections
560 * and is waiting for some event to happen.
562 _PUBLIC_ void daemon_status(const char *name, const char *msg);
565 * @brief Get a password from the console.
567 * You should make sure that the buffer is an empty string!
569 * You can also use this function to ask for a username. Then you can fill the
570 * buffer with the username and it is shows to the users. If the users just
571 * presses enter the buffer will be untouched.
574 * char username[128];
576 * snprintf(username, sizeof(username), "john");
578 * smb_getpass("Username:", username, sizeof(username), 1, 0);
581 * The prompt will look like this:
585 * If you press enter then john is used as the username, or you can type it in
588 * @param[in] prompt The prompt to show to ask for the password.
590 * @param[out] buf The buffer the password should be stored. It NEEDS to be
591 * empty or filled out.
593 * @param[in] len The length of the buffer.
595 * @param[in] echo Should we echo what you type.
597 * @param[in] verify Should we ask for the password twice.
599 * @return 0 on success, -1 on error.
601 _PUBLIC_ int samba_getpass(const char *prompt, char *buf, size_t len,
602 bool echo, bool verify);
605 * Load a ini-style file.
607 bool pm_process( const char *fileName,
608 bool (*sfunc)(const char *, void *),
609 bool (*pfunc)(const char *, const char *, void *),
612 void print_asc(int level, const uint8_t *buf,int len);
613 void print_asc_cb(const uint8_t *buf, int len,
614 void (*cb)(const char *buf, void *private_data),
618 * Add an id to an array of ids.
620 * num should be a pointer to an integer that holds the current
621 * number of elements in ids. It will be updated by this function.
624 bool add_uid_to_array_unique(TALLOC_CTX *mem_ctx, uid_t uid,
625 uid_t **uids, uint32_t *num_uids);
626 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
627 gid_t **gids, uint32_t *num_gids);
630 * Allocate anonymous shared memory of the given size
632 void *anonymous_shared_allocate(size_t bufsz);
633 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove);
634 void anonymous_shared_free(void *ptr);
637 run a command as a child process, with a timeout.
639 any stdout/stderr from the child will appear in the Samba logs with
640 the specified log levels
642 If callback is set then the callback is called on completion
643 with the return code from the command
645 struct tevent_context;
647 struct tevent_req *samba_runcmd_send(TALLOC_CTX *mem_ctx,
648 struct tevent_context *ev,
649 struct timeval endtime,
650 int stdout_log_level,
651 int stderr_log_level,
652 const char * const *argv0, ...);
653 int samba_runcmd_recv(struct tevent_req *req, int *perrno);
656 void samba_start_debugger(void);
660 * @brief Returns an absolute path to a file in the Samba modules directory.
662 * @param name File to find, relative to MODULESDIR.
664 * @retval Pointer to a string containing the full path.
666 char *modules_path(TALLOC_CTX *mem_ctx, const char *name);
669 * @brief Returns an absolute path to a file in the Samba data directory.
671 * @param name File to find, relative to CODEPAGEDIR.
673 * @retval Pointer to a talloc'ed string containing the full path.
675 char *data_path(TALLOC_CTX *mem_ctx, const char *name);
678 * @brief Returns the platform specific shared library extension.
680 * @retval Pointer to a const char * containing the extension.
682 const char *shlib_ext(void);
686 struct server_id_buf { char buf[48]; }; /* probably a bit too large ... */
687 char *server_id_str_buf(struct server_id id, struct server_id_buf *dst);
688 size_t server_id_str_buf_unique(struct server_id id, char *buf, size_t buflen);
690 bool server_id_same_process(const struct server_id *p1,
691 const struct server_id *p2);
692 bool server_id_equal(const struct server_id *p1, const struct server_id *p2);
693 struct server_id server_id_from_string(uint32_t local_vnn,
694 const char *pid_string);
697 * Set the serverid to the special value that represents a disconnected
698 * client for (e.g.) durable handles.
700 void server_id_set_disconnected(struct server_id *id);
703 * check whether a serverid is the special placeholder for
704 * a disconnected client
706 bool server_id_is_disconnected(const struct server_id *id);
708 #define SERVER_ID_BUF_LENGTH 24
709 void server_id_put(uint8_t buf[SERVER_ID_BUF_LENGTH],
710 const struct server_id id);
711 void server_id_get(struct server_id *id,
712 const uint8_t buf[SERVER_ID_BUF_LENGTH]);
715 * Samba code should use samba_tevent_context_init() instead of
716 * tevent_context_init() in order to get the debug output.
718 struct tevent_context *samba_tevent_context_init(TALLOC_CTX *mem_ctx);
721 * if same samba code needs to use a specific tevent backend
722 * it can use something like this:
724 * samba_tevent_set_debug(ev, "pysmb_tevent");
726 void samba_tevent_set_debug(struct tevent_context *ev, const char *name);
728 #endif /* _SAMBA_UTIL_H_ */