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