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