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