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