lib/util/samba_util.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Utility functions for Samba
   4    Copyright (C) Andrew Tridgell 1992-1999
   5    Copyright (C) Jelmer Vernooij 2005
   6
   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.
  11
  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.
  16
  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/>.
  19 */
  20
  21 #ifndef _SAMBA_UTIL_H_
  22 #define _SAMBA_UTIL_H_
  23
  24 #include "lib/util/charset/charset.h"
  25 #include "lib/util/attr.h"
  26
  27 /* for TALLOC_CTX */
  28 #include <talloc.h>
  29
  30 /* for struct stat */
  31 #include <sys/stat.h>
  32
  33 /**
  34  * @file
  35  * @brief Helpful macros
  36  */
  37
  38 struct smbsrv_tcon;
  39
  40 extern const char *panic_action;
  41
  42 #include "lib/util/time.h"
  43 #include "lib/util/data_blob.h"
  44 #include "lib/util/xfile.h"
  45 #include "lib/util/byteorder.h"
  46 #include "lib/util/talloc_stack.h"
  47
  48 /**
  49  * assert macros
  50  */
  51 #define SMB_ASSERT(b) \
  52 do { \
  53         if (!(b)) { \
  54                 DEBUG(0,("PANIC: assert failed at %s(%d): %s\n", \
  55                          __FILE__, __LINE__, #b)); \
  56                 smb_panic("assert failed: " #b); \
  57         } \
  58 } while(0)
  59
  60 #ifndef ABS
  61 #define ABS(a) ((a)>0?(a):(-(a)))
  62 #endif
  63
  64 #include "lib/util/memory.h"
  65
  66 #include "../libcli/util/ntstatus.h"
  67 #include "lib/util/string_wrappers.h"
  68
  69 /**
  70  * Write backtrace to debug log
  71  */
  72 _PUBLIC_ void call_backtrace(void);
  73
  74 /**
  75  Something really nasty happened - panic !
  76 **/
  77 typedef void (*smb_panic_handler_t)(const char *why);
  78
  79 _PUBLIC_ void fault_configure(smb_panic_handler_t panic_handler);
  80 _PUBLIC_ void fault_setup(void);
  81 _PUBLIC_ void fault_setup_disable(void);
  82 _PUBLIC_ void dump_core_setup(const char *progname, const char *logfile);
  83 _PUBLIC_ _NORETURN_ void smb_panic(const char *reason);
  84
  85
  86 /**
  87   register a fault handler.
  88   Should only be called once in the execution of smbd.
  89 */
  90 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
  91
  92 #include "lib/util/signal.h" /* Avoid /usr/include/signal.h */
  93
  94 struct sockaddr;
  95
  96 _PUBLIC_ int sys_getnameinfo(const struct sockaddr *psa,
  97                              int salen,
  98                              char *host,
  99                              size_t hostlen,
 100                              char *service,
 101                              size_t servlen,
 102                              int flags);
 103
 104 /* The following definitions come from lib/util/genrand.c  */
 105 /**
 106  Copy any user given reseed data.
 107 **/
 108 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(void *, int *), void *);
 109
 110 /**
 111  * Tell the random number generator it needs to reseed.
 112  */
 113 _PUBLIC_ void set_need_random_reseed(void);
 114
 115 /**
 116  Interface to the (hopefully) good crypto random number generator.
 117  Will use our internal PRNG if more than 40 bytes of random generation
 118  has been requested, otherwise tries to read from /dev/random
 119 **/
 120 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
 121
 122 /**
 123  Interface to the (hopefully) good crypto random number generator.
 124  Will always use /dev/urandom if available.
 125 **/
 126 _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len);
 127
 128 /**
 129   generate a single random uint32_t
 130 **/
 131 _PUBLIC_ uint32_t generate_random(void);
 132
 133 /**
 134   very basic password quality checker
 135 **/
 136 _PUBLIC_ bool check_password_quality(const char *s);
 137
 138 /**
 139  * Generate a random text password.
 140  */
 141 _PUBLIC_ char *generate_random_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
 142
 143 /**
 144  Use the random number generator to generate a random string.
 145 **/
 146 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
 147
 148 /**
 149  * Generate a random text string consisting of the specified length.
 150  * The returned string will be allocated.
 151  *
 152  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
 153  */
 154 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
 155
 156 /**
 157  * Generate an array of unique text strings all of the same length.
 158  * The returned strings will be allocated.
 159  * Returns NULL if the number of unique combinations cannot be created.
 160  *
 161  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
 162  */
 163 _PUBLIC_ char** generate_unique_strs(TALLOC_CTX *mem_ctx, size_t len,
 164                                          uint32_t num);
 165
 166 /* The following definitions come from lib/util/dprintf.c  */
 167
 168 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 169 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
 170 _PUBLIC_ void display_set_stderr(void);
 171
 172 /* The following definitions come from lib/util/util_str.c  */
 173
 174 bool next_token_talloc(TALLOC_CTX *ctx,
 175                         const char **ptr,
 176                         char **pp_buff,
 177                         const char *sep);
 178
 179 /**
 180  * Get the next token from a string, return false if none found.  Handles
 181  * double-quotes.  This version does not trim leading separator characters
 182  * before looking for a token.
 183  */
 184 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
 185                         const char **ptr,
 186                         char **pp_buff,
 187                         const char *sep);
 188
 189
 190 /**
 191  Trim the specified elements off the front and back of a string.
 192 **/
 193 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
 194
 195 /**
 196  Find the number of 'c' chars in a string
 197 **/
 198 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
 199
 200 /**
 201  Routine to get hex characters and turn them into a 16 byte array.
 202  the array can be variable length, and any non-hex-numeric
 203  characters are skipped.  "0xnn" or "0Xnn" is specially catered
 204  for.
 205
 206  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
 207
 208
 209 **/
 210 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
 211
 212 /**
 213  * Parse a hex string and return a data blob.
 214  */
 215 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
 216
 217 /**
 218  * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
 219  */
 220 _PUBLIC_ void hex_encode_buf(char *dst, const uint8_t *src, size_t srclen);
 221
 222 /**
 223  * Routine to print a buffer as HEX digits, into an allocated string.
 224  */
 225 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
 226
 227 /**
 228  * talloc version of hex_encode()
 229  */
 230 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
 231
 232 #include "substitute.h"
 233
 234 /**
 235  Unescape a URL encoded string, in place.
 236 **/
 237 _PUBLIC_ void rfc1738_unescape(char *buf);
 238
 239
 240 /**
 241  * rfc1738_escape
 242  * Returns a static buffer that contains the RFC
 243  * 1738 compliant, escaped version of the given url. (escapes unsafe and % characters)
 244  **/
 245 _PUBLIC_ char *rfc1738_escape(TALLOC_CTX *mem_ctx, const char *url);
 246
 247 /**
 248  * rfc1738_escape_unescaped
 249  *
 250  * Returns a static buffer that contains
 251  * the RFC 1738 compliant, escaped version of the given url (escapes unsafe chars only)
 252  **/
 253 _PUBLIC_ char *rfc1738_escape_unescaped(TALLOC_CTX *mem_ctx, const char *url);
 254
 255 /**
 256  * rfc1738_escape_part
 257  * Returns a static buffer that contains the RFC
 258  * 1738 compliant, escaped version of the given url segment. (escapes
 259  * unsafe, reserved and % chars) It would mangle the :// in http://,
 260  * and mangle paths (because of /).
 261  **/
 262 _PUBLIC_ char *rfc1738_escape_part(TALLOC_CTX *mem_ctx, const char *url);
 263
 264 /**
 265  * Add a string to an array of strings.
 266  *
 267  * num should be a pointer to an integer that holds the current
 268  * number of elements in strings. It will be updated by this function.
 269  */
 270 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
 271                          const char *str, const char ***strings, int *num);
 272
 273 /**
 274   varient of strcmp() that handles NULL ptrs
 275 **/
 276 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
 277
 278 /**
 279 return the number of bytes occupied by a buffer in ASCII format
 280 the result includes the null termination
 281 limited by 'n' bytes
 282 **/
 283 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
 284
 285 /**
 286  Set a boolean variable from the text value stored in the passed string.
 287  Returns true in success, false if the passed string does not correctly
 288  represent a boolean.
 289 **/
 290 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
 291
 292 /**
 293  * Parse a string containing a boolean value.
 294  *
 295  * val will be set to the read value.
 296  *
 297  * @retval true if a boolean value was parsed, false otherwise.
 298  */
 299 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
 300
 301 /**
 302  * Convert a size specification like 16K into an integral number of bytes.
 303  **/
 304 _PUBLIC_ bool conv_str_size_error(const char * str, uint64_t * val);
 305
 306 /**
 307  * Parse a uint64_t value from a string
 308  *
 309  * val will be set to the value read.
 310  *
 311  * @retval true if parsing was successful, false otherwise
 312  */
 313 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
 314
 315 /**
 316 return the number of bytes occupied by a buffer in CH_UTF16 format
 317 the result includes the null termination
 318 **/
 319 _PUBLIC_ size_t utf16_len(const void *buf);
 320
 321 /**
 322 return the number of bytes occupied by a buffer in CH_UTF16 format
 323 the result includes the null termination
 324 limited by 'n' bytes
 325 **/
 326 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
 327 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
 328
 329 /**
 330 Do a case-insensitive, whitespace-ignoring string compare.
 331 **/
 332 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
 333
 334 /**
 335  String replace.
 336 **/
 337 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
 338
 339 /**
 340  Base64 decode a string, place into a data blob.  Caller to data_blob_free() the result.
 341 **/
 342 _PUBLIC_ DATA_BLOB base64_decode_data_blob_talloc(TALLOC_CTX *mem_ctx, const char *s);
 343
 344 /**
 345  Base64 decode a string, place into a data blob on NULL context.
 346  Caller to data_blob_free() the result.
 347 **/
 348 _PUBLIC_ DATA_BLOB base64_decode_data_blob(const char *s);
 349
 350
 351 /**
 352  Base64 decode a string, inplace
 353 **/
 354 _PUBLIC_ void base64_decode_inplace(char *s);
 355 /**
 356  Base64 encode a binary data blob into a string
 357 **/
 358 _PUBLIC_ char *base64_encode_data_blob(TALLOC_CTX *mem_ctx, DATA_BLOB data);
 359
 360 /**
 361  * Compare 2 strings.
 362  *
 363  * @note The comparison is case-insensitive.
 364  **/
 365 _PUBLIC_ bool strequal(const char *s1, const char *s2);
 366
 367 /* The following definitions come from lib/util/util_strlist.c  */
 368
 369 /* separators for lists */
 370 #ifndef LIST_SEP
 371 #define LIST_SEP " \t,\n\r"
 372 #endif
 373
 374 /**
 375   build an empty (only NULL terminated) list of strings (for expansion with str_list_add() etc)
 376 */
 377 _PUBLIC_ char **str_list_make_empty(TALLOC_CTX *mem_ctx);
 378
 379 /**
 380   place the only element 'entry' into a new, NULL terminated string list
 381 */
 382 _PUBLIC_ char **str_list_make_single(TALLOC_CTX *mem_ctx,
 383         const char *entry);
 384
 385 /**
 386   build a null terminated list of strings from a input string and a
 387   separator list. The separator list must contain characters less than
 388   or equal to 0x2f for this to work correctly on multi-byte strings
 389 */
 390 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string,
 391         const char *sep);
 392
 393 /**
 394  * build a null terminated list of strings from an argv-like input string
 395  * Entries are separated by spaces and can be enclosed by quotes.
 396  * Does NOT support escaping
 397  */
 398 _PUBLIC_ char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
 399
 400 /**
 401  * join a list back to one string
 402  */
 403 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char separator);
 404
 405 /** join a list back to one (shell-like) string; entries
 406  * separated by spaces, using quotes where necessary */
 407 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
 408
 409 /**
 410   return the number of elements in a string list
 411 */
 412 _PUBLIC_ size_t str_list_length(const char * const *list);
 413
 414 /**
 415   copy a string list
 416 */
 417 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
 418
 419 /**
 420    Return true if all the elements of the list match exactly.
 421  */
 422 _PUBLIC_ bool str_list_equal(const char * const *list1, const char * const *list2);
 423
 424 /**
 425   add an entry to a string list
 426 */
 427 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
 428
 429 /**
 430   remove an entry from a string list
 431 */
 432 _PUBLIC_ void str_list_remove(const char **list, const char *s);
 433
 434 /**
 435   return true if a string is in a list
 436 */
 437 _PUBLIC_ bool str_list_check(const char **list, const char *s);
 438
 439 /**
 440   return true if a string is in a list, case insensitively
 441 */
 442 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
 443 /**
 444   append one list to another - expanding list1
 445 */
 446 _PUBLIC_ const char **str_list_append(const char **list1,
 447         const char * const *list2);
 448
 449 /**
 450  remove duplicate elements from a list
 451 */
 452 _PUBLIC_ const char **str_list_unique(const char **list);
 453
 454 /*
 455   very useful when debugging complex list related code
 456  */
 457 _PUBLIC_ void str_list_show(const char **list);
 458
 459
 460 /**
 461   append one list to another - expanding list1
 462   this assumes the elements of list2 are const pointers, so we can re-use them
 463 */
 464 _PUBLIC_ const char **str_list_append_const(const char **list1,
 465                                             const char **list2);
 466
 467 /**
 468   add an entry to a string list
 469   this assumes s will not change
 470 */
 471 _PUBLIC_ const char **str_list_add_const(const char **list, const char *s);
 472
 473 /**
 474   copy a string list
 475   this assumes list will not change
 476 */
 477 _PUBLIC_ const char **str_list_copy_const(TALLOC_CTX *mem_ctx,
 478                                           const char **list);
 479
 480 /**
 481  * Needed for making an "unconst" list "const"
 482  */
 483 _PUBLIC_ const char **const_str_list(char **list);
 484
 485 /**
 486  * str_list_make, v3 version. The v4 version does not
 487  * look at quoted strings with embedded blanks, so
 488  * do NOT merge this function please!
 489  */
 490 char **str_list_make_v3(TALLOC_CTX *mem_ctx, const char *string,
 491         const char *sep);
 492
 493
 494 /* The following definitions come from lib/util/util_file.c  */
 495
 496
 497 /**
 498 read a line from a file with possible \ continuation chars.
 499 Blanks at the start or end of a line are stripped.
 500 The string will be allocated if s2 is NULL
 501 **/
 502 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
 503
 504 /**
 505  * Read one line (data until next newline or eof) and allocate it
 506  */
 507 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
 508
 509 /**
 510 load a file into memory from a fd.
 511 **/
 512 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 513
 514
 515 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
 516
 517 /**
 518 load a file into memory
 519 **/
 520 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 521
 522 /**
 523 mmap (if possible) or read a file
 524 **/
 525 _PUBLIC_ void *map_file(const char *fname, size_t size);
 526
 527 /**
 528 load a file into memory and return an array of pointers to lines in the file
 529 must be freed with talloc_free().
 530 **/
 531 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 532
 533 /**
 534 load a fd into memory and return an array of pointers to lines in the file
 535 must be freed with talloc_free(). If convert is true calls unix_to_dos on
 536 the list.
 537 **/
 538 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 539
 540 _PUBLIC_ bool file_save_mode(const char *fname, const void *packet,
 541                              size_t length, mode_t mode);
 542 /**
 543   save a lump of data into a file. Mostly used for debugging
 544 */
 545 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
 546 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 547 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 548
 549 /*
 550   compare two files, return true if the two files have the same content
 551  */
 552 bool file_compare(const char *path1, const char *path2);
 553
 554 /* The following definitions come from lib/util/util.c  */
 555
 556
 557 /**
 558  Find a suitable temporary directory. The result should be copied immediately
 559  as it may be overwritten by a subsequent call.
 560 **/
 561 _PUBLIC_ const char *tmpdir(void);
 562
 563 /**
 564  * Creates and immediately unlinks a file. Returns open file descriptor.
 565  **/
 566 _PUBLIC_ int create_unlink_tmp(const char *dir);
 567
 568 /**
 569  Check if a file exists - call vfs_file_exist for samba files.
 570 **/
 571 _PUBLIC_ bool file_exist(const char *fname);
 572
 573 /**
 574  Check a files mod time.
 575 **/
 576 _PUBLIC_ time_t file_modtime(const char *fname);
 577
 578 /**
 579  Check if a directory exists.
 580 **/
 581 _PUBLIC_ bool directory_exist(const char *dname);
 582
 583 /**
 584  Check file permissions.
 585 **/
 586 _PUBLIC_ bool file_check_permissions(const char *fname,
 587                                      uid_t uid,
 588                                      mode_t file_perms,
 589                                      struct stat *pst);
 590
 591 /**
 592  * Try to create the specified directory if it didn't exist.
 593  *
 594  * @retval true if the directory already existed and has the right permissions
 595  * or was successfully created.
 596  */
 597 _PUBLIC_ bool directory_create_or_exist(const char *dname, mode_t dir_perms);
 598
 599 _PUBLIC_ bool directory_create_or_exist_strict(const char *dname,
 600                                                uid_t uid,
 601                                                mode_t dir_perms);
 602
 603 #include "blocking.h"
 604
 605 /**
 606  Sleep for a specified number of milliseconds.
 607 **/
 608 _PUBLIC_ void smb_msleep(unsigned int t);
 609
 610 /**
 611  Get my own name, return in talloc'ed storage.
 612 **/
 613 _PUBLIC_ char* get_myname(TALLOC_CTX *mem_ctx);
 614
 615 /**
 616  Check if a process exists. Does this work on all unixes?
 617 **/
 618 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
 619
 620 /**
 621  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
 622  is dealt with in posix.c
 623 **/
 624 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
 625
 626 /**
 627  * Write dump of binary data to a callback
 628  */
 629 void dump_data_cb(const uint8_t *buf, int len,
 630                   bool omit_zero_bytes,
 631                   void (*cb)(const char *buf, void *private_data),
 632                   void *private_data);
 633
 634 /**
 635  * Write dump of binary data to a FILE
 636  */
 637 void dump_data_file(const uint8_t *buf, int len, bool omit_zero_bytes,
 638                     FILE *f);
 639
 640 /**
 641  * Write dump of binary data to the log file.
 642  *
 643  * The data is only written if the log level is at least level.
 644  */
 645 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
 646
 647 /**
 648  * Write dump of binary data to the log file.
 649  *
 650  * The data is only written if the log level is at least level for
 651  * debug class dbgc_class.
 652  */
 653 _PUBLIC_ void dump_data_dbgc(int dbgc_class, int level, const uint8_t *buf, int len);
 654
 655 /**
 656  * Write dump of binary data to the log file.
 657  *
 658  * The data is only written if the log level is at least level.
 659  * 16 zero bytes in a row are omitted
 660  */
 661 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
 662
 663 /**
 664  malloc that aborts with smb_panic on fail or zero size.
 665 **/
 666 _PUBLIC_ void *smb_xmalloc(size_t size);
 667
 668 /**
 669  Memdup with smb_panic on fail.
 670 **/
 671 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
 672
 673 /**
 674  strdup that aborts on malloc fail.
 675 **/
 676 _PUBLIC_ char *smb_xstrdup(const char *s);
 677
 678 char *smb_xstrndup(const char *s, size_t n);
 679
 680 /**
 681  Like strdup but for memory.
 682 **/
 683 _PUBLIC_ void *smb_memdup(const void *p, size_t size);
 684
 685 /**
 686  * Write a password to the log file.
 687  *
 688  * @note Only actually does something if DEBUG_PASSWORD was defined during
 689  * compile-time.
 690  */
 691 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
 692
 693 /**
 694  * see if a range of memory is all zero. A NULL pointer is considered
 695  * to be all zero
 696  */
 697 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
 698
 699 /**
 700   realloc an array, checking for integer overflow in the array size
 701 */
 702 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
 703
 704 void *malloc_array(size_t el_size, unsigned int count);
 705
 706 void *memalign_array(size_t el_size, size_t align, unsigned int count);
 707
 708 void *calloc_array(size_t size, size_t nmemb);
 709
 710 /* The following definitions come from lib/util/fsusage.c  */
 711
 712
 713 /**
 714  * Retrieve amount of free disk space.
 715  * this does all of the system specific guff to get the free disk space.
 716  * It is derived from code in the GNU fileutils package, but has been
 717  * considerably mangled for use here
 718  *
 719  * results are returned in *dfree and *dsize, in 512 byte units
 720 */
 721 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
 722
 723 /* The following definitions come from lib/util/ms_fnmatch.c  */
 724
 725
 726 /**
 727  * @file
 728  * @brief MS-style Filename matching
 729  */
 730
 731 int ms_fnmatch_protocol(const char *pattern, const char *string, int protocol);
 732
 733 /** a generic fnmatch function - uses for non-CIFS pattern matching */
 734 int gen_fnmatch(const char *pattern, const char *string);
 735
 736 #include "idtree.h"
 737 #include "idtree_random.h"
 738
 739 /**
 740  Close the low 3 fd's and open dev/null in their place
 741 **/
 742 _PUBLIC_ void close_low_fds(bool stdin_too, bool stdout_too, bool stderr_too);
 743
 744 /**
 745  Become a daemon, discarding the controlling terminal.
 746 **/
 747 _PUBLIC_ void become_daemon(bool do_fork, bool no_process_group, bool log_stdout);
 748
 749 /**
 750  Exit daemon and print error message to the log at level 0
 751  Optionally report failure to systemd if systemd integration is enabled
 752 **/
 753 _PUBLIC_ void exit_daemon(const char *msg, int error);
 754
 755 /**
 756  Report that the daemon is ready to serve connections to the log at level 0
 757  Optionally report status to systemd if systemd integration is enabled
 758 **/
 759 _PUBLIC_ void daemon_ready(const char *daemon);
 760
 761 /*
 762  * Report the daemon status. For example if it is not ready to serve connections
 763  * and is waiting for some event to happen.
 764  */
 765 _PUBLIC_ void daemon_status(const char *name, const char *msg);
 766
 767 /**
 768  * @brief Get a password from the console.
 769  *
 770  * You should make sure that the buffer is an empty string!
 771  *
 772  * You can also use this function to ask for a username. Then you can fill the
 773  * buffer with the username and it is shows to the users. If the users just
 774  * presses enter the buffer will be untouched.
 775  *
 776  * @code
 777  *   char username[128];
 778  *
 779  *   snprintf(username, sizeof(username), "john");
 780  *
 781  *   smb_getpass("Username:", username, sizeof(username), 1, 0);
 782  * @endcode
 783  *
 784  * The prompt will look like this:
 785  *
 786  *   Username: [john]
 787  *
 788  * If you press enter then john is used as the username, or you can type it in
 789  * to change it.
 790  *
 791  * @param[in]  prompt   The prompt to show to ask for the password.
 792  *
 793  * @param[out] buf    The buffer the password should be stored. It NEEDS to be
 794  *                      empty or filled out.
 795  *
 796  * @param[in]  len      The length of the buffer.
 797  *
 798  * @param[in]  echo     Should we echo what you type.
 799  *
 800  * @param[in]  verify   Should we ask for the password twice.
 801  *
 802  * @return              0 on success, -1 on error.
 803  */
 804 _PUBLIC_ int samba_getpass(const char *prompt, char *buf, size_t len,
 805                            bool echo, bool verify);
 806
 807 /**
 808  * Load a ini-style file.
 809  */
 810 bool pm_process( const char *fileName,
 811                  bool (*sfunc)(const char *, void *),
 812                  bool (*pfunc)(const char *, const char *, void *),
 813                                  void *userdata);
 814
 815 bool unmap_file(void *start, size_t size);
 816
 817 void print_asc(int level, const uint8_t *buf,int len);
 818 void print_asc_cb(const uint8_t *buf, int len,
 819                   void (*cb)(const char *buf, void *private_data),
 820                   void *private_data);
 821
 822 /**
 823  * Add an id to an array of ids.
 824  *
 825  * num should be a pointer to an integer that holds the current
 826  * number of elements in ids. It will be updated by this function.
 827  */
 828
 829 bool add_uid_to_array_unique(TALLOC_CTX *mem_ctx, uid_t uid,
 830                              uid_t **uids, uint32_t *num_uids);
 831 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
 832                              gid_t **gids, uint32_t *num_gids);
 833
 834 /**
 835  * Allocate anonymous shared memory of the given size
 836  */
 837 void *anonymous_shared_allocate(size_t bufsz);
 838 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove);
 839 void anonymous_shared_free(void *ptr);
 840
 841 /*
 842   run a command as a child process, with a timeout.
 843
 844   any stdout/stderr from the child will appear in the Samba logs with
 845   the specified log levels
 846
 847   If callback is set then the callback is called on completion
 848   with the return code from the command
 849  */
 850 struct tevent_context;
 851 struct tevent_req;
 852 struct tevent_req *samba_runcmd_send(TALLOC_CTX *mem_ctx,
 853                                      struct tevent_context *ev,
 854                                      struct timeval endtime,
 855                                      int stdout_log_level,
 856                                      int stderr_log_level,
 857                                      const char * const *argv0, ...);
 858 int samba_runcmd_recv(struct tevent_req *req, int *perrno);
 859
 860 #ifdef DEVELOPER
 861 void samba_start_debugger(void);
 862 #endif
 863
 864 /**
 865  * @brief Returns an absolute path to a file in the Samba modules directory.
 866  *
 867  * @param name File to find, relative to MODULESDIR.
 868  *
 869  * @retval Pointer to a string containing the full path.
 870  **/
 871 char *modules_path(TALLOC_CTX *mem_ctx, const char *name);
 872
 873 /**
 874  * @brief Returns an absolute path to a file in the Samba data directory.
 875  *
 876  * @param name File to find, relative to CODEPAGEDIR.
 877  *
 878  * @retval Pointer to a talloc'ed string containing the full path.
 879  **/
 880 char *data_path(TALLOC_CTX *mem_ctx, const char *name);
 881
 882 /**
 883  * @brief Returns the platform specific shared library extension.
 884  *
 885  * @retval Pointer to a const char * containing the extension.
 886  **/
 887 const char *shlib_ext(void);
 888
 889 struct server_id;
 890
 891 struct server_id_buf { char buf[48]; }; /* probably a bit too large ... */
 892 char *server_id_str_buf(struct server_id id, struct server_id_buf *dst);
 893
 894 bool server_id_same_process(const struct server_id *p1,
 895                             const struct server_id *p2);
 896 bool server_id_equal(const struct server_id *p1, const struct server_id *p2);
 897 char *server_id_str(TALLOC_CTX *mem_ctx, const struct server_id *id);
 898 struct server_id server_id_from_string(uint32_t local_vnn,
 899                                        const char *pid_string);
 900
 901 /**
 902  * Set the serverid to the special value that represents a disconnected
 903  * client for (e.g.) durable handles.
 904  */
 905 void server_id_set_disconnected(struct server_id *id);
 906
 907 /**
 908  * check whether a serverid is the special placeholder for
 909  * a disconnected client
 910  */
 911 bool server_id_is_disconnected(const struct server_id *id);
 912
 913 /*
 914  * Samba code should use samba_tevent_context_init() instead of
 915  * tevent_context_init() in order to get the debug output.
 916  */
 917 struct tevent_context *samba_tevent_context_init(TALLOC_CTX *mem_ctx);
 918
 919 /*
 920  * if same samba code needs to use a specific tevent backend
 921  * it can use something like this:
 922  *
 923  * samba_tevent_set_debug(ev, "pysmb_tevent");
 924  */
 925 void samba_tevent_set_debug(struct tevent_context *ev, const char *name);
 926
 927 #endif /* _SAMBA_UTIL_H_ */