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