lib/util/samba_util.h

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