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