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