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/byteorder.h"
  50 #include "lib/util/talloc_stack.h"
  51
  52 #ifndef ABS
  53 #define ABS(a) ((a)>0?(a):(-(a)))
  54 #endif
  55
  56 #include "lib/util/memory.h"
  57
  58 #include "fault.h"
  59
  60 #include "lib/util/util.h"
  61
  62 /**
  63  * Write backtrace to debug log
  64  */
  65 _PUBLIC_ void dump_core_setup(const char *progname, const char *logfile);
  66
  67 /**
  68   register a fault handler.
  69   Should only be called once in the execution of smbd.
  70 */
  71 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
  72
  73 #include "lib/util/signal.h" /* Avoid /usr/include/signal.h */
  74
  75 struct sockaddr;
  76
  77 _PUBLIC_ int sys_getnameinfo(const struct sockaddr *psa,
  78                              int salen,
  79                              char *host,
  80                              size_t hostlen,
  81                              char *service,
  82                              size_t servlen,
  83                              int flags);
  84
  85 /* The following definitions come from lib/util/genrand.c  */
  86
  87 #include "lib/util/genrand.h"
  88
  89 /**
  90   generate a single random uint32_t
  91 **/
  92 _PUBLIC_ uint32_t generate_random(void);
  93
  94 /**
  95   very basic password quality checker
  96 **/
  97 _PUBLIC_ bool check_password_quality(const char *s);
  98
  99 /**
 100  * Generate a random text password (based on printable ascii characters).
 101  * This function is designed to provide a password that
 102  * meats the complexity requirements of UF_NORMAL_ACCOUNT objects
 103  * and they should be human readable and writeable on any keyboard layout.
 104  *
 105  * Characters used are:
 106  * ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,@$%&!?:;<=>()[]~
 107  */
 108 _PUBLIC_ char *generate_random_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
 109
 110 /**
 111  * Generate a random machine password
 112  *
 113  * min and max are the number of utf16 characters used
 114  * to generate on utf8 compatible password.
 115  *
 116  * Note: if 'unix charset' is not 'utf8' (the default)
 117  * then each utf16 character is only filled with
 118  * values from 0x01 to 0x7f (ascii values without 0x00).
 119  * This is important as the password neets to be
 120  * a valid value as utf8 string and at the same time
 121  * a valid value in the 'unix charset'.
 122  *
 123  * If 'unix charset' is 'utf8' (the default) then
 124  * each utf16 character is a random value from 0x0000
 125  * 0xFFFF (exluding the surrogate ranges from 0xD800-0xDFFF)
 126  * while the translation from CH_UTF16MUNGED
 127  * to CH_UTF8 replaces invalid values (see utf16_munged_pull()).
 128  *
 129  * Note: these passwords may not pass the complexity requirements
 130  * for UF_NORMAL_ACCOUNT objects (except krbtgt accounts).
 131  */
 132 _PUBLIC_ char *generate_random_machine_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
 133
 134 /**
 135  Use the random number generator to generate a random string.
 136 **/
 137 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
 138
 139 /**
 140  * Generate a random text string consisting of the specified length.
 141  * The returned string will be allocated.
 142  *
 143  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
 144  */
 145 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
 146
 147 /**
 148  * Generate an array of unique text strings all of the same length.
 149  * The returned strings will be allocated.
 150  * Returns NULL if the number of unique combinations cannot be created.
 151  *
 152  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
 153  */
 154 _PUBLIC_ char** generate_unique_strs(TALLOC_CTX *mem_ctx, size_t len,
 155                                          uint32_t num);
 156
 157 /* The following definitions come from lib/util/dprintf.c  */
 158
 159 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 160 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
 161 _PUBLIC_ void display_set_stderr(void);
 162
 163 /* The following definitions come from lib/util/util_str.c  */
 164
 165 bool next_token_talloc(TALLOC_CTX *ctx,
 166                         const char **ptr,
 167                         char **pp_buff,
 168                         const char *sep);
 169
 170 /**
 171  * Get the next token from a string, return false if none found.  Handles
 172  * double-quotes.  This version does not trim leading separator characters
 173  * before looking for a token.
 174  */
 175 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
 176                         const char **ptr,
 177                         char **pp_buff,
 178                         const char *sep);
 179
 180
 181 /**
 182  Trim the specified elements off the front and back of a string.
 183 **/
 184 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
 185
 186 /**
 187  Find the number of 'c' chars in a string
 188 **/
 189 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
 190
 191 /**
 192  Routine to get hex characters and turn them into a 16 byte array.
 193  the array can be variable length, and any non-hex-numeric
 194  characters are skipped.  "0xnn" or "0Xnn" is specially catered
 195  for.
 196
 197  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
 198
 199
 200 **/
 201 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
 202
 203 /**
 204  * Parse a hex string and return a data blob.
 205  */
 206 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
 207
 208 /**
 209  * Parse a hex dump and return a data blob
 210  */
 211 _PUBLIC_ _PURE_ DATA_BLOB hexdump_to_data_blob(TALLOC_CTX *mem_ctx, const char *hexdump, size_t len);
 212
 213 /**
 214  * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
 215  */
 216 _PUBLIC_ void hex_encode_buf(char *dst, const uint8_t *src, size_t srclen);
 217
 218 /**
 219  * talloc version of hex_encode_buf()
 220  */
 221 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
 222
 223 #include "substitute.h"
 224
 225 /**
 226  Unescape a URL encoded string, in place.
 227 **/
 228 _PUBLIC_ char *rfc1738_unescape(char *buf);
 229
 230 /**
 231  * rfc1738_escape_part
 232  * Returns a static buffer that contains the RFC
 233  * 1738 compliant, escaped version of the given url segment. (escapes
 234  * unsafe, reserved and % chars) It would mangle the :// in http://,
 235  * and mangle paths (because of /).
 236  **/
 237 _PUBLIC_ char *rfc1738_escape_part(TALLOC_CTX *mem_ctx, const char *url);
 238
 239 /**
 240   varient of strcmp() that handles NULL ptrs
 241 **/
 242 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
 243
 244 /**
 245 return the number of bytes occupied by a buffer in ASCII format
 246 the result includes the null termination
 247 limited by 'n' bytes
 248 **/
 249 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
 250
 251 /**
 252  Set a boolean variable from the text value stored in the passed string.
 253  Returns true in success, false if the passed string does not correctly
 254  represent a boolean.
 255 **/
 256 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
 257
 258 /**
 259  * Parse a string containing a boolean value.
 260  *
 261  * val will be set to the read value.
 262  *
 263  * @retval true if a boolean value was parsed, false otherwise.
 264  */
 265 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
 266
 267 /**
 268  * Convert a size specification like 16K into an integral number of bytes.
 269  **/
 270 _PUBLIC_ bool conv_str_size_error(const char * str, uint64_t * val);
 271
 272 /**
 273  * Parse a uint64_t value from a string
 274  *
 275  * val will be set to the value read.
 276  *
 277  * @retval true if parsing was successful, false otherwise
 278  */
 279 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
 280
 281 /**
 282 return the number of bytes occupied by a buffer in CH_UTF16 format
 283 the result includes the null termination
 284 **/
 285 _PUBLIC_ size_t utf16_len(const void *buf);
 286
 287 /**
 288 return the number of bytes occupied by a buffer in CH_UTF16 format
 289 the result includes the null termination
 290 limited by 'n' bytes
 291 **/
 292 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
 293 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
 294
 295 /**
 296  * @brief Constant time compare to memory regions.
 297  *
 298  * @param[in]  s1  The first memory region to compare.
 299  *
 300  * @param[in]  s2  The second memory region to compare.
 301  *
 302  * @param[in]  n   The length of the memory to comapre.
 303  *
 304  * @return 0 when the memory regions are equal, 0 if not.
 305  */
 306 _PUBLIC_ int memcmp_const_time(const void *s1, const void *s2, size_t n);
 307
 308 /**
 309 Do a case-insensitive, whitespace-ignoring string compare.
 310 **/
 311 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
 312
 313 /**
 314  String replace.
 315 **/
 316 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
 317
 318 /**
 319  * Compare 2 strings.
 320  *
 321  * @note The comparison is case-insensitive.
 322  **/
 323 _PUBLIC_ bool strequal(const char *s1, const char *s2);
 324
 325 #include "util_strlist.h"
 326
 327 /* The following definitions come from lib/util/util_strlist_v3.c  */
 328
 329 /**
 330  * Needed for making an "unconst" list "const"
 331  */
 332 _PUBLIC_ const char **const_str_list(char **list);
 333
 334 /**
 335  * str_list_make, v3 version. The v4 version does not
 336  * look at quoted strings with embedded blanks, so
 337  * do NOT merge this function please!
 338  */
 339 char **str_list_make_v3(TALLOC_CTX *mem_ctx, const char *string,
 340         const char *sep);
 341
 342
 343 const char **str_list_make_v3_const(TALLOC_CTX *mem_ctx,
 344                                     const char *string,
 345                                     const char *sep);
 346
 347 /* The following definitions come from lib/util/util_file.c  */
 348
 349
 350 /**
 351  * Read one line (data until next newline or eof) and allocate it
 352  */
 353 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
 354
 355 char *fgets_slash(TALLOC_CTX *mem_ctx, char *s2, size_t maxlen, FILE *f);
 356
 357 /**
 358 load a file into memory from a fd.
 359 **/
 360 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 361
 362
 363 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
 364
 365 /**
 366 load a file into memory
 367 **/
 368 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 369
 370 /**
 371 load a file into memory and return an array of pointers to lines in the file
 372 must be freed with talloc_free().
 373 **/
 374 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 375
 376 /**
 377 load a fd into memory and return an array of pointers to lines in the file
 378 must be freed with talloc_free(). If convert is true calls unix_to_dos on
 379 the list.
 380 **/
 381 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 382
 383 _PUBLIC_ bool file_save_mode(const char *fname, const void *packet,
 384                              size_t length, mode_t mode);
 385 /**
 386   save a lump of data into a file. Mostly used for debugging
 387 */
 388 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
 389 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 390 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 391
 392 /*
 393   compare two files, return true if the two files have the same content
 394  */
 395 bool file_compare(const char *path1, const char *path2);
 396
 397 /* The following definitions come from lib/util/util.c  */
 398
 399
 400 /**
 401  Find a suitable temporary directory. The result should be copied immediately
 402  as it may be overwritten by a subsequent call.
 403 **/
 404 _PUBLIC_ const char *tmpdir(void);
 405
 406 /**
 407  * Creates and immediately unlinks a file. Returns open file descriptor.
 408  **/
 409 _PUBLIC_ int create_unlink_tmp(const char *dir);
 410
 411 /**
 412  Check if a file exists - call vfs_file_exist for samba files.
 413 **/
 414 _PUBLIC_ bool file_exist(const char *fname);
 415
 416 /**
 417  Check a files mod time.
 418 **/
 419 _PUBLIC_ time_t file_modtime(const char *fname);
 420
 421 /**
 422  Check if a directory exists.
 423 **/
 424 _PUBLIC_ bool directory_exist(const char *dname);
 425
 426 /**
 427  Check file permissions.
 428 **/
 429 _PUBLIC_ bool file_check_permissions(const char *fname,
 430                                      uid_t uid,
 431                                      mode_t file_perms,
 432                                      struct stat *pst);
 433
 434 /**
 435  * Try to create the specified directory if it didn't exist.
 436  *
 437  * @retval true if the directory already existed and has the right permissions
 438  * or was successfully created.
 439  */
 440 _PUBLIC_ bool directory_create_or_exist(const char *dname, mode_t dir_perms);
 441
 442 _PUBLIC_ bool directory_create_or_exist_strict(const char *dname,
 443                                                uid_t uid,
 444                                                mode_t dir_perms);
 445
 446 #include "blocking.h"
 447
 448 /**
 449  Sleep for a specified number of milliseconds.
 450 **/
 451 _PUBLIC_ void smb_msleep(unsigned int t);
 452
 453 /**
 454  Get my own name, return in talloc'ed storage.
 455 **/
 456 _PUBLIC_ char* get_myname(TALLOC_CTX *mem_ctx);
 457
 458 /**
 459  Check if a process exists. Does this work on all unixes?
 460 **/
 461 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
 462
 463 /**
 464  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
 465  is dealt with in posix.c
 466 **/
 467 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
 468
 469 /**
 470  * Write dump of binary data to the log file.
 471  *
 472  * The data is only written if the log level is at least level.
 473  * 16 zero bytes in a row are omitted
 474  */
 475 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
 476
 477 /**
 478  malloc that aborts with smb_panic on fail or zero size.
 479 **/
 480 _PUBLIC_ void *smb_xmalloc(size_t size);
 481
 482 /**
 483  Memdup with smb_panic on fail.
 484 **/
 485 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
 486
 487 /**
 488  strdup that aborts on malloc fail.
 489 **/
 490 _PUBLIC_ char *smb_xstrdup(const char *s);
 491
 492 char *smb_xstrndup(const char *s, size_t n);
 493
 494 /**
 495  Like strdup but for memory.
 496 **/
 497 _PUBLIC_ void *smb_memdup(const void *p, size_t size);
 498
 499 /**
 500  * Write a password to the log file.
 501  *
 502  * @note Only actually does something if DEBUG_PASSWORD was defined during
 503  * compile-time.
 504  */
 505 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
 506
 507 /**
 508  * see if a range of memory is all zero. A NULL pointer is considered
 509  * to be all zero
 510  */
 511 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
 512
 513 /**
 514   realloc an array, checking for integer overflow in the array size
 515 */
 516 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
 517
 518 void *malloc_array(size_t el_size, unsigned int count);
 519
 520 void *memalign_array(size_t el_size, size_t align, unsigned int count);
 521
 522 void *calloc_array(size_t size, size_t nmemb);
 523
 524 /* The following definitions come from lib/util/fsusage.c  */
 525
 526
 527 /**
 528  * Retrieve amount of free disk space.
 529  * this does all of the system specific guff to get the free disk space.
 530  * It is derived from code in the GNU fileutils package, but has been
 531  * considerably mangled for use here
 532  *
 533  * results are returned in *dfree and *dsize, in 512 byte units
 534 */
 535 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
 536
 537 /* The following definitions come from lib/util/ms_fnmatch.c  */
 538
 539
 540 /**
 541  * @file
 542  * @brief MS-style Filename matching
 543  */
 544
 545 int ms_fnmatch_protocol(const char *pattern, const char *string, int protocol,
 546                         bool is_case_sensitive);
 547
 548 /** a generic fnmatch function - uses for non-CIFS pattern matching */
 549 int gen_fnmatch(const char *pattern, const char *string);
 550
 551 #include "idtree.h"
 552 #include "idtree_random.h"
 553
 554 #include "become_daemon.h"
 555
 556 /**
 557  * @brief Get a password from the console.
 558  *
 559  * You should make sure that the buffer is an empty string!
 560  *
 561  * You can also use this function to ask for a username. Then you can fill the
 562  * buffer with the username and it is shows to the users. If the users just
 563  * presses enter the buffer will be untouched.
 564  *
 565  * @code
 566  *   char username[128];
 567  *
 568  *   snprintf(username, sizeof(username), "john");
 569  *
 570  *   smb_getpass("Username:", username, sizeof(username), 1, 0);
 571  * @endcode
 572  *
 573  * The prompt will look like this:
 574  *
 575  *   Username: [john]
 576  *
 577  * If you press enter then john is used as the username, or you can type it in
 578  * to change it.
 579  *
 580  * @param[in]  prompt   The prompt to show to ask for the password.
 581  *
 582  * @param[out] buf    The buffer the password should be stored. It NEEDS to be
 583  *                    empty or filled out.
 584  *
 585  * @param[in]  len      The length of the buffer.
 586  *
 587  * @param[in]  echo     Should we echo what you type.
 588  *
 589  * @param[in]  verify   Should we ask for the password twice.
 590  *
 591  * @return              0 on success, -1 on error.
 592  */
 593 _PUBLIC_ int samba_getpass(const char *prompt, char *buf, size_t len,
 594                            bool echo, bool verify);
 595
 596 /**
 597  * Load a ini-style file.
 598  */
 599 bool pm_process( const char *fileName,
 600                  bool (*sfunc)(const char *, void *),
 601                  bool (*pfunc)(const char *, const char *, void *),
 602                                  void *userdata);
 603 bool pm_process_with_flags(const char *filename,
 604                            bool allow_empty_values,
 605                            bool (*sfunc)(const char *section, void *private_data),
 606                            bool (*pfunc)(const char *name, const char *value,
 607                                          void *private_data),
 608                            void *private_data);
 609
 610 void print_asc(int level, const uint8_t *buf,int len);
 611 void print_asc_cb(const uint8_t *buf, int len,
 612                   void (*cb)(const char *buf, void *private_data),
 613                   void *private_data);
 614
 615 /**
 616  * Add an id to an array of ids.
 617  *
 618  * num should be a pointer to an integer that holds the current
 619  * number of elements in ids. It will be updated by this function.
 620  */
 621
 622 bool add_uid_to_array_unique(TALLOC_CTX *mem_ctx, uid_t uid,
 623                              uid_t **uids, uint32_t *num_uids);
 624 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
 625                              gid_t **gids, uint32_t *num_gids);
 626
 627 /**
 628  * Allocate anonymous shared memory of the given size
 629  */
 630 void *anonymous_shared_allocate(size_t bufsz);
 631 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove);
 632 void anonymous_shared_free(void *ptr);
 633
 634 /*
 635   run a command as a child process, with a timeout.
 636
 637   any stdout/stderr from the child will appear in the Samba logs with
 638   the specified log levels
 639
 640   If callback is set then the callback is called on completion
 641   with the return code from the command
 642  */
 643 struct tevent_context;
 644 struct tevent_req;
 645 struct tevent_req *samba_runcmd_send(TALLOC_CTX *mem_ctx,
 646                                      struct tevent_context *ev,
 647                                      struct timeval endtime,
 648                                      int stdout_log_level,
 649                                      int stderr_log_level,
 650                                      const char * const *argv0, ...);
 651 int samba_runcmd_recv(struct tevent_req *req, int *perrno);
 652
 653 #ifdef DEVELOPER
 654 void samba_start_debugger(void);
 655 #endif
 656
 657 /*
 658  * Samba code should use samba_tevent_context_init() instead of
 659  * tevent_context_init() in order to get the debug output.
 660  */
 661 struct tevent_context *samba_tevent_context_init(TALLOC_CTX *mem_ctx);
 662
 663 /*
 664  * if same samba code needs to use a specific tevent backend
 665  * it can use something like this:
 666  *
 667  * samba_tevent_set_debug(ev, "pysmb_tevent");
 668  */
 669 void samba_tevent_set_debug(struct tevent_context *ev, const char *name);
 670
 671 #endif /* _SAMBA_UTIL_H_ */