source3/tdb/tdbutil.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    tdb utility functions
   4    Copyright (C) Andrew Tridgell   1992-1998
   5    Copyright (C) Rafal Szczesniak  2002
   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 2 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, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #include "includes.h"
  23 #include <fnmatch.h>
  24
  25 /* these are little tdb utility functions that are meant to make
  26    dealing with a tdb database a little less cumbersome in Samba */
  27
  28 static SIG_ATOMIC_T gotalarm;
  29
  30 /***************************************************************
  31  Signal function to tell us we timed out.
  32 ****************************************************************/
  33
  34 static void gotalarm_sig(void)
  35 {
  36         gotalarm = 1;
  37 }
  38
  39 /***************************************************************
  40  Make a TDB_DATA and keep the const warning in one place
  41 ****************************************************************/
  42
  43 TDB_DATA make_tdb_data(const char *dptr, size_t dsize)
  44 {
  45         TDB_DATA ret;
  46         ret.dptr = CONST_DISCARD(char *, dptr);
  47         ret.dsize = dsize;
  48         return ret;
  49 }
  50
  51 TDB_DATA string_tdb_data(const char *string)
  52 {
  53         return make_tdb_data(string, strlen(string));
  54 }
  55
  56 /****************************************************************************
  57  Lock a chain with timeout (in seconds).
  58 ****************************************************************************/
  59
  60 static int tdb_chainlock_with_timeout_internal( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout, int rw_type)
  61 {
  62         /* Allow tdb_chainlock to be interrupted by an alarm. */
  63         int ret;
  64         gotalarm = 0;
  65         tdb_set_lock_alarm(CONST_DISCARD(sig_atomic_t *, &gotalarm));
  66
  67         if (timeout) {
  68                 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
  69                 alarm(timeout);
  70         }
  71
  72         if (rw_type == F_RDLCK)
  73                 ret = tdb_chainlock_read(tdb, key);
  74         else
  75                 ret = tdb_chainlock(tdb, key);
  76
  77         if (timeout) {
  78                 alarm(0);
  79                 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
  80                 if (gotalarm) {
  81                         DEBUG(0,("tdb_chainlock_with_timeout_internal: alarm (%u) timed out for key %s in tdb %s\n",
  82                                 timeout, key.dptr, tdb->name ));
  83                         /* TODO: If we time out waiting for a lock, it might
  84                          * be nice to use F_GETLK to get the pid of the
  85                          * process currently holding the lock and print that
  86                          * as part of the debugging message. -- mbp */
  87                         return -1;
  88                 }
  89         }
  90
  91         return ret;
  92 }
  93
  94 /****************************************************************************
  95  Write lock a chain. Return -1 if timeout or lock failed.
  96 ****************************************************************************/
  97
  98 int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout)
  99 {
 100         return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
 101 }
 102
 103 /****************************************************************************
 104  Lock a chain by string. Return -1 if timeout or lock failed.
 105 ****************************************************************************/
 106
 107 int tdb_lock_bystring(TDB_CONTEXT *tdb, const char *keyval, unsigned int timeout)
 108 {
 109         TDB_DATA key = make_tdb_data(keyval, strlen(keyval)+1);
 110
 111         return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
 112 }
 113
 114 /****************************************************************************
 115  Unlock a chain by string.
 116 ****************************************************************************/
 117
 118 void tdb_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
 119 {
 120         TDB_DATA key = make_tdb_data(keyval, strlen(keyval)+1);
 121
 122         tdb_chainunlock(tdb, key);
 123 }
 124
 125 /****************************************************************************
 126  Read lock a chain by string. Return -1 if timeout or lock failed.
 127 ****************************************************************************/
 128
 129 int tdb_read_lock_bystring(TDB_CONTEXT *tdb, const char *keyval, unsigned int timeout)
 130 {
 131         TDB_DATA key = make_tdb_data(keyval, strlen(keyval)+1);
 132
 133         return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_RDLCK);
 134 }
 135
 136 /****************************************************************************
 137  Read unlock a chain by string.
 138 ****************************************************************************/
 139
 140 void tdb_read_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
 141 {
 142         TDB_DATA key = make_tdb_data(keyval, strlen(keyval)+1);
 143
 144         tdb_chainunlock_read(tdb, key);
 145 }
 146
 147
 148 /****************************************************************************
 149  Fetch a int32 value by a arbitrary blob key, return -1 if not found.
 150  Output is int32 in native byte order.
 151 ****************************************************************************/
 152
 153 int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, const char *keyval, size_t len)
 154 {
 155         TDB_DATA key = make_tdb_data(keyval, len);
 156         TDB_DATA data;
 157         int32 ret;
 158
 159         data = tdb_fetch(tdb, key);
 160         if (!data.dptr || data.dsize != sizeof(int32)) {
 161                 SAFE_FREE(data.dptr);
 162                 return -1;
 163         }
 164
 165         ret = IVAL(data.dptr,0);
 166         SAFE_FREE(data.dptr);
 167         return ret;
 168 }
 169
 170 /****************************************************************************
 171  Fetch a int32 value by string key, return -1 if not found.
 172  Output is int32 in native byte order.
 173 ****************************************************************************/
 174
 175 int32 tdb_fetch_int32(TDB_CONTEXT *tdb, const char *keystr)
 176 {
 177         return tdb_fetch_int32_byblob(tdb, keystr, strlen(keystr) + 1);
 178 }
 179
 180 /****************************************************************************
 181  Store a int32 value by an arbitary blob key, return 0 on success, -1 on failure.
 182  Input is int32 in native byte order. Output in tdb is in little-endian.
 183 ****************************************************************************/
 184
 185 int tdb_store_int32_byblob(TDB_CONTEXT *tdb, const char *keystr, size_t len, int32 v)
 186 {
 187         TDB_DATA key = make_tdb_data(keystr, len);
 188         TDB_DATA data;
 189         int32 v_store;
 190
 191         SIVAL(&v_store,0,v);
 192         data.dptr = (void *)&v_store;
 193         data.dsize = sizeof(int32);
 194
 195         return tdb_store(tdb, key, data, TDB_REPLACE);
 196 }
 197
 198 /****************************************************************************
 199  Store a int32 value by string key, return 0 on success, -1 on failure.
 200  Input is int32 in native byte order. Output in tdb is in little-endian.
 201 ****************************************************************************/
 202
 203 int tdb_store_int32(TDB_CONTEXT *tdb, const char *keystr, int32 v)
 204 {
 205         return tdb_store_int32_byblob(tdb, keystr, strlen(keystr) + 1, v);
 206 }
 207
 208 /****************************************************************************
 209  Fetch a uint32 value by a arbitrary blob key, return -1 if not found.
 210  Output is uint32 in native byte order.
 211 ****************************************************************************/
 212
 213 BOOL tdb_fetch_uint32_byblob(TDB_CONTEXT *tdb, const char *keyval, size_t len, uint32 *value)
 214 {
 215         TDB_DATA key = make_tdb_data(keyval, len);
 216         TDB_DATA data;
 217
 218         data = tdb_fetch(tdb, key);
 219         if (!data.dptr || data.dsize != sizeof(uint32)) {
 220                 SAFE_FREE(data.dptr);
 221                 return False;
 222         }
 223
 224         *value = IVAL(data.dptr,0);
 225         SAFE_FREE(data.dptr);
 226         return True;
 227 }
 228
 229 /****************************************************************************
 230  Fetch a uint32 value by string key, return -1 if not found.
 231  Output is uint32 in native byte order.
 232 ****************************************************************************/
 233
 234 BOOL tdb_fetch_uint32(TDB_CONTEXT *tdb, const char *keystr, uint32 *value)
 235 {
 236         return tdb_fetch_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
 237 }
 238
 239 /****************************************************************************
 240  Store a uint32 value by an arbitary blob key, return 0 on success, -1 on failure.
 241  Input is uint32 in native byte order. Output in tdb is in little-endian.
 242 ****************************************************************************/
 243
 244 BOOL tdb_store_uint32_byblob(TDB_CONTEXT *tdb, const char *keystr, size_t len, uint32 value)
 245 {
 246         TDB_DATA key = make_tdb_data(keystr, len);
 247         TDB_DATA data;
 248         uint32 v_store;
 249         BOOL ret = True;
 250
 251         SIVAL(&v_store, 0, value);
 252         data.dptr = (void *)&v_store;
 253         data.dsize = sizeof(uint32);
 254
 255         if (tdb_store(tdb, key, data, TDB_REPLACE) == -1)
 256                 ret = False;
 257
 258         return ret;
 259 }
 260
 261 /****************************************************************************
 262  Store a uint32 value by string key, return 0 on success, -1 on failure.
 263  Input is uint32 in native byte order. Output in tdb is in little-endian.
 264 ****************************************************************************/
 265
 266 BOOL tdb_store_uint32(TDB_CONTEXT *tdb, const char *keystr, uint32 value)
 267 {
 268         return tdb_store_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
 269 }
 270 /****************************************************************************
 271  Store a buffer by a null terminated string key.  Return 0 on success, -1
 272  on failure.
 273 ****************************************************************************/
 274
 275 int tdb_store_bystring(TDB_CONTEXT *tdb, const char *keystr, TDB_DATA data, int flags)
 276 {
 277         TDB_DATA key = make_tdb_data(keystr, strlen(keystr)+1);
 278
 279         return tdb_store(tdb, key, data, flags);
 280 }
 281
 282 /****************************************************************************
 283  Fetch a buffer using a null terminated string key.  Don't forget to call
 284  free() on the result dptr.
 285 ****************************************************************************/
 286
 287 TDB_DATA tdb_fetch_bystring(TDB_CONTEXT *tdb, const char *keystr)
 288 {
 289         TDB_DATA key = make_tdb_data(keystr, strlen(keystr)+1);
 290
 291         return tdb_fetch(tdb, key);
 292 }
 293
 294 /****************************************************************************
 295  Delete an entry using a null terminated string key.
 296 ****************************************************************************/
 297
 298 int tdb_delete_bystring(TDB_CONTEXT *tdb, const char *keystr)
 299 {
 300         TDB_DATA key = make_tdb_data(keystr, strlen(keystr)+1);
 301
 302         return tdb_delete(tdb, key);
 303 }
 304
 305 /****************************************************************************
 306  Atomic integer change. Returns old value. To create, set initial value in *oldval.
 307 ****************************************************************************/
 308
 309 int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, const char *keystr, int32 *oldval, int32 change_val)
 310 {
 311         int32 val;
 312         int32 ret = -1;
 313
 314         if (tdb_lock_bystring(tdb, keystr,0) == -1)
 315                 return -1;
 316
 317         if ((val = tdb_fetch_int32(tdb, keystr)) == -1) {
 318                 /* The lookup failed */
 319                 if (tdb_error(tdb) != TDB_ERR_NOEXIST) {
 320                         /* but not because it didn't exist */
 321                         goto err_out;
 322                 }
 323
 324                 /* Start with 'old' value */
 325                 val = *oldval;
 326
 327         } else {
 328                 /* It worked, set return value (oldval) to tdb data */
 329                 *oldval = val;
 330         }
 331
 332         /* Increment value for storage and return next time */
 333         val += change_val;
 334
 335         if (tdb_store_int32(tdb, keystr, val) == -1)
 336                 goto err_out;
 337
 338         ret = 0;
 339
 340   err_out:
 341
 342         tdb_unlock_bystring(tdb, keystr);
 343         return ret;
 344 }
 345
 346 /****************************************************************************
 347  Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval.
 348 ****************************************************************************/
 349
 350 BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, const char *keystr, uint32 *oldval, uint32 change_val)
 351 {
 352         uint32 val;
 353         BOOL ret = False;
 354
 355         if (tdb_lock_bystring(tdb, keystr,0) == -1)
 356                 return False;
 357
 358         if (!tdb_fetch_uint32(tdb, keystr, &val)) {
 359                 /* It failed */
 360                 if (tdb_error(tdb) != TDB_ERR_NOEXIST) {
 361                         /* and not because it didn't exist */
 362                         goto err_out;
 363                 }
 364
 365                 /* Start with 'old' value */
 366                 val = *oldval;
 367
 368         } else {
 369                 /* it worked, set return value (oldval) to tdb data */
 370                 *oldval = val;
 371
 372         }
 373
 374         /* get a new value to store */
 375         val += change_val;
 376
 377         if (!tdb_store_uint32(tdb, keystr, val))
 378                 goto err_out;
 379
 380         ret = True;
 381
 382   err_out:
 383
 384         tdb_unlock_bystring(tdb, keystr);
 385         return ret;
 386 }
 387
 388 /****************************************************************************
 389  Useful pair of routines for packing/unpacking data consisting of
 390  integers and strings.
 391 ****************************************************************************/
 392
 393 size_t tdb_pack_va(char *buf, int bufsize, const char *fmt, va_list ap)
 394 {
 395         uint8 bt;
 396         uint16 w;
 397         uint32 d;
 398         int i;
 399         void *p;
 400         int len;
 401         char *s;
 402         char c;
 403         char *buf0 = buf;
 404         const char *fmt0 = fmt;
 405         int bufsize0 = bufsize;
 406
 407         while (*fmt) {
 408                 switch ((c = *fmt++)) {
 409                 case 'b': /* unsigned 8-bit integer */
 410                         len = 1;
 411                         bt = (uint8)va_arg(ap, int);
 412                         if (bufsize && bufsize >= len)
 413                                 SSVAL(buf, 0, bt);
 414                         break;
 415                 case 'w': /* unsigned 16-bit integer */
 416                         len = 2;
 417                         w = (uint16)va_arg(ap, int);
 418                         if (bufsize && bufsize >= len)
 419                                 SSVAL(buf, 0, w);
 420                         break;
 421                 case 'd': /* signed 32-bit integer (standard int in most systems) */
 422                         len = 4;
 423                         d = va_arg(ap, uint32);
 424                         if (bufsize && bufsize >= len)
 425                                 SIVAL(buf, 0, d);
 426                         break;
 427                 case 'p': /* pointer */
 428                         len = 4;
 429                         p = va_arg(ap, void *);
 430                         d = p?1:0;
 431                         if (bufsize && bufsize >= len)
 432                                 SIVAL(buf, 0, d);
 433                         break;
 434                 case 'P': /* null-terminated string */
 435                         s = va_arg(ap,char *);
 436                         w = strlen(s);
 437                         len = w + 1;
 438                         if (bufsize && bufsize >= len)
 439                                 memcpy(buf, s, len);
 440                         break;
 441                 case 'f': /* null-terminated string */
 442                         s = va_arg(ap,char *);
 443                         w = strlen(s);
 444                         len = w + 1;
 445                         if (bufsize && bufsize >= len)
 446                                 memcpy(buf, s, len);
 447                         break;
 448                 case 'B': /* fixed-length string */
 449                         i = va_arg(ap, int);
 450                         s = va_arg(ap, char *);
 451                         len = 4+i;
 452                         if (bufsize && bufsize >= len) {
 453                                 SIVAL(buf, 0, i);
 454                                 memcpy(buf+4, s, i);
 455                         }
 456                         break;
 457                 default:
 458                         DEBUG(0,("Unknown tdb_pack format %c in %s\n",
 459                                  c, fmt));
 460                         len = 0;
 461                         break;
 462                 }
 463
 464                 buf += len;
 465                 if (bufsize)
 466                         bufsize -= len;
 467                 if (bufsize < 0)
 468                         bufsize = 0;
 469         }
 470
 471         DEBUG(18,("tdb_pack_va(%s, %d) -> %d\n",
 472                  fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
 473
 474         return PTR_DIFF(buf, buf0);
 475 }
 476
 477 size_t tdb_pack(char *buf, int bufsize, const char *fmt, ...)
 478 {
 479         va_list ap;
 480         size_t result;
 481
 482         va_start(ap, fmt);
 483         result = tdb_pack_va(buf, bufsize, fmt, ap);
 484         va_end(ap);
 485         return result;
 486 }
 487
 488 BOOL tdb_pack_append(TALLOC_CTX *mem_ctx, uint8_t **buf, size_t *len,
 489                      const char *fmt, ...)
 490 {
 491         va_list ap;
 492         size_t len1, len2;
 493
 494         va_start(ap, fmt);
 495         len1 = tdb_pack_va(NULL, 0, fmt, ap);
 496         va_end(ap);
 497
 498         if (mem_ctx != NULL)
 499                 *buf = TALLOC_REALLOC_ARRAY(mem_ctx, *buf, uint8_t,
 500                                             (*len) + len1);
 501         else
 502                 *buf = SMB_REALLOC_ARRAY(*buf, uint8_t, (*len) + len1);
 503
 504         if (*buf == NULL)
 505                 return False;
 506
 507         va_start(ap, fmt);
 508         len2 = tdb_pack_va((*buf)+(*len), len1, fmt, ap);
 509         va_end(ap);
 510
 511         if (len1 != len2)
 512                 return False;
 513
 514         *len += len2;
 515
 516         return True;
 517 }
 518
 519 /****************************************************************************
 520  Useful pair of routines for packing/unpacking data consisting of
 521  integers and strings.
 522 ****************************************************************************/
 523
 524 int tdb_unpack(char *buf, int bufsize, const char *fmt, ...)
 525 {
 526         va_list ap;
 527         uint8 *bt;
 528         uint16 *w;
 529         uint32 *d;
 530         int len;
 531         int *i;
 532         void **p;
 533         char *s, **b;
 534         char c;
 535         char *buf0 = buf;
 536         const char *fmt0 = fmt;
 537         int bufsize0 = bufsize;
 538
 539         va_start(ap, fmt);
 540
 541         while (*fmt) {
 542                 switch ((c=*fmt++)) {
 543                 case 'b':
 544                         len = 1;
 545                         bt = va_arg(ap, uint8 *);
 546                         if (bufsize < len)
 547                                 goto no_space;
 548                         *bt = SVAL(buf, 0);
 549                         break;
 550                 case 'w':
 551                         len = 2;
 552                         w = va_arg(ap, uint16 *);
 553                         if (bufsize < len)
 554                                 goto no_space;
 555                         *w = SVAL(buf, 0);
 556                         break;
 557                 case 'd':
 558                         len = 4;
 559                         d = va_arg(ap, uint32 *);
 560                         if (bufsize < len)
 561                                 goto no_space;
 562                         *d = IVAL(buf, 0);
 563                         break;
 564                 case 'p':
 565                         len = 4;
 566                         p = va_arg(ap, void **);
 567                         if (bufsize < len)
 568                                 goto no_space;
 569                         /*
 570                          * This isn't a real pointer - only a token (1 or 0)
 571                          * to mark the fact a pointer is present.
 572                          */
 573
 574                         *p = (void *)(IVAL(buf, 0) ? (void *)1 : NULL);
 575                         break;
 576                 case 'P':
 577                         s = va_arg(ap,char *);
 578                         len = strlen(buf) + 1;
 579                         if (bufsize < len || len > sizeof(pstring))
 580                                 goto no_space;
 581                         memcpy(s, buf, len);
 582                         break;
 583                 case 'f':
 584                         s = va_arg(ap,char *);
 585                         len = strlen(buf) + 1;
 586                         if (bufsize < len || len > sizeof(fstring))
 587                                 goto no_space;
 588                         memcpy(s, buf, len);
 589                         break;
 590                 case 'B':
 591                         i = va_arg(ap, int *);
 592                         b = va_arg(ap, char **);
 593                         len = 4;
 594                         if (bufsize < len)
 595                                 goto no_space;
 596                         *i = IVAL(buf, 0);
 597                         if (! *i) {
 598                                 *b = NULL;
 599                                 break;
 600                         }
 601                         len += *i;
 602                         if (bufsize < len)
 603                                 goto no_space;
 604                         *b = (char *)SMB_MALLOC(*i);
 605                         if (! *b)
 606                                 goto no_space;
 607                         memcpy(*b, buf+4, *i);
 608                         break;
 609                 default:
 610                         DEBUG(0,("Unknown tdb_unpack format %c in %s\n",
 611                                  c, fmt));
 612
 613                         len = 0;
 614                         break;
 615                 }
 616
 617                 buf += len;
 618                 bufsize -= len;
 619         }
 620
 621         va_end(ap);
 622
 623         DEBUG(18,("tdb_unpack(%s, %d) -> %d\n",
 624                  fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
 625
 626         return PTR_DIFF(buf, buf0);
 627
 628  no_space:
 629         return -1;
 630 }
 631
 632
 633 /**
 634  * Pack SID passed by pointer
 635  *
 636  * @param pack_buf pointer to buffer which is to be filled with packed data
 637  * @param bufsize size of packing buffer
 638  * @param sid pointer to sid to be packed
 639  *
 640  * @return length of the packed representation of the whole structure
 641  **/
 642 size_t tdb_sid_pack(char* pack_buf, int bufsize, DOM_SID* sid)
 643 {
 644         int idx;
 645         size_t len = 0;
 646
 647         if (!sid || !pack_buf) return -1;
 648
 649         len += tdb_pack(pack_buf + len, bufsize - len, "bb", sid->sid_rev_num,
 650                         sid->num_auths);
 651
 652         for (idx = 0; idx < 6; idx++) {
 653                 len += tdb_pack(pack_buf + len, bufsize - len, "b", sid->id_auth[idx]);
 654         }
 655
 656         for (idx = 0; idx < MAXSUBAUTHS; idx++) {
 657                 len += tdb_pack(pack_buf + len, bufsize - len, "d", sid->sub_auths[idx]);
 658         }
 659
 660         return len;
 661 }
 662
 663
 664 /**
 665  * Unpack SID into a pointer
 666  *
 667  * @param pack_buf pointer to buffer with packed representation
 668  * @param bufsize size of the buffer
 669  * @param sid pointer to sid structure to be filled with unpacked data
 670  *
 671  * @return size of structure unpacked from buffer
 672  **/
 673 size_t tdb_sid_unpack(char* pack_buf, int bufsize, DOM_SID* sid)
 674 {
 675         int idx, len = 0;
 676
 677         if (!sid || !pack_buf) return -1;
 678
 679         len += tdb_unpack(pack_buf + len, bufsize - len, "bb",
 680                           &sid->sid_rev_num, &sid->num_auths);
 681
 682         for (idx = 0; idx < 6; idx++) {
 683                 len += tdb_unpack(pack_buf + len, bufsize - len, "b", &sid->id_auth[idx]);
 684         }
 685
 686         for (idx = 0; idx < MAXSUBAUTHS; idx++) {
 687                 len += tdb_unpack(pack_buf + len, bufsize - len, "d", &sid->sub_auths[idx]);
 688         }
 689
 690         return len;
 691 }
 692
 693
 694 /**
 695  * Pack TRUSTED_DOM_PASS passed by pointer
 696  *
 697  * @param pack_buf pointer to buffer which is to be filled with packed data
 698  * @param bufsize size of the buffer
 699  * @param pass pointer to trusted domain password to be packed
 700  *
 701  * @return length of the packed representation of the whole structure
 702  **/
 703 size_t tdb_trusted_dom_pass_pack(char* pack_buf, int bufsize, TRUSTED_DOM_PASS* pass)
 704 {
 705         int idx, len = 0;
 706
 707         if (!pack_buf || !pass) return -1;
 708
 709         /* packing unicode domain name and password */
 710         len += tdb_pack(pack_buf + len, bufsize - len, "d", pass->uni_name_len);
 711
 712         for (idx = 0; idx < 32; idx++)
 713                 len +=  tdb_pack(pack_buf + len, bufsize - len, "w", pass->uni_name[idx]);
 714
 715         len += tdb_pack(pack_buf + len, bufsize - len, "dPd", pass->pass_len,
 716                              pass->pass, pass->mod_time);
 717
 718         /* packing SID structure */
 719         len += tdb_sid_pack(pack_buf + len, bufsize - len, &pass->domain_sid);
 720
 721         return len;
 722 }
 723
 724
 725 /**
 726  * Unpack TRUSTED_DOM_PASS passed by pointer
 727  *
 728  * @param pack_buf pointer to buffer with packed representation
 729  * @param bufsize size of the buffer
 730  * @param pass pointer to trusted domain password to be filled with unpacked data
 731  *
 732  * @return size of structure unpacked from buffer
 733  **/
 734 size_t tdb_trusted_dom_pass_unpack(char* pack_buf, int bufsize, TRUSTED_DOM_PASS* pass)
 735 {
 736         int idx, len = 0;
 737
 738         if (!pack_buf || !pass) return -1;
 739
 740         /* unpack unicode domain name and plaintext password */
 741         len += tdb_unpack(pack_buf, bufsize - len, "d", &pass->uni_name_len);
 742
 743         for (idx = 0; idx < 32; idx++)
 744                 len +=  tdb_unpack(pack_buf + len, bufsize - len, "w", &pass->uni_name[idx]);
 745
 746         len += tdb_unpack(pack_buf + len, bufsize - len, "dPd", &pass->pass_len, &pass->pass,
 747                           &pass->mod_time);
 748
 749         /* unpack domain sid */
 750         len += tdb_sid_unpack(pack_buf + len, bufsize - len, &pass->domain_sid);
 751
 752         return len;
 753 }
 754
 755
 756 /****************************************************************************
 757  Log tdb messages via DEBUG().
 758 ****************************************************************************/
 759
 760 static void tdb_log(TDB_CONTEXT *tdb, int level, const char *format, ...)
 761 {
 762         va_list ap;
 763         char *ptr = NULL;
 764
 765         va_start(ap, format);
 766         vasprintf(&ptr, format, ap);
 767         va_end(ap);
 768
 769         if (!ptr || !*ptr)
 770                 return;
 771
 772         DEBUG(level, ("tdb(%s): %s", tdb->name ? tdb->name : "unnamed", ptr));
 773         SAFE_FREE(ptr);
 774 }
 775
 776 /****************************************************************************
 777  Like tdb_open() but also setup a logging function that redirects to
 778  the samba DEBUG() system.
 779 ****************************************************************************/
 780
 781 TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
 782                           int open_flags, mode_t mode)
 783 {
 784         TDB_CONTEXT *tdb;
 785
 786         if (!lp_use_mmap())
 787                 tdb_flags |= TDB_NOMMAP;
 788
 789         tdb = tdb_open_ex(name, hash_size, tdb_flags,
 790                                     open_flags, mode, tdb_log, NULL);
 791         if (!tdb)
 792                 return NULL;
 793
 794         return tdb;
 795 }
 796
 797
 798 /****************************************************************************
 799  Allow tdb_delete to be used as a tdb_traversal_fn.
 800 ****************************************************************************/
 801
 802 int tdb_traverse_delete_fn(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf,
 803                      void *state)
 804 {
 805     return tdb_delete(the_tdb, key);
 806 }
 807
 808
 809
 810 /**
 811  * Search across the whole tdb for keys that match the given pattern
 812  * return the result as a list of keys
 813  *
 814  * @param tdb pointer to opened tdb file context
 815  * @param pattern searching pattern used by fnmatch(3) functions
 816  *
 817  * @return list of keys found by looking up with given pattern
 818  **/
 819 TDB_LIST_NODE *tdb_search_keys(TDB_CONTEXT *tdb, const char* pattern)
 820 {
 821         TDB_DATA key, next;
 822         TDB_LIST_NODE *list = NULL;
 823         TDB_LIST_NODE *rec = NULL;
 824         TDB_LIST_NODE *tmp = NULL;
 825
 826         for (key = tdb_firstkey(tdb); key.dptr; key = next) {
 827                 /* duplicate key string to ensure null-termination */
 828                 char *key_str = (char*) SMB_STRNDUP(key.dptr, key.dsize);
 829                 if (!key_str) {
 830                         DEBUG(0, ("tdb_search_keys: strndup() failed!\n"));
 831                         smb_panic("strndup failed!\n");
 832                 }
 833
 834                 DEBUG(18, ("checking %s for match to pattern %s\n", key_str, pattern));
 835
 836                 next = tdb_nextkey(tdb, key);
 837
 838                 /* do the pattern checking */
 839                 if (fnmatch(pattern, key_str, 0) == 0) {
 840                         rec = SMB_MALLOC_P(TDB_LIST_NODE);
 841                         ZERO_STRUCTP(rec);
 842
 843                         rec->node_key = key;
 844
 845                         DLIST_ADD_END(list, rec, tmp);
 846
 847                         DEBUG(18, ("checking %s matched pattern %s\n", key_str, pattern));
 848                 } else {
 849                         free(key.dptr);
 850                 }
 851
 852                 /* free duplicated key string */
 853                 free(key_str);
 854         }
 855
 856         return list;
 857
 858 }
 859
 860
 861 /**
 862  * Free the list returned by tdb_search_keys
 863  *
 864  * @param node list of results found by tdb_search_keys
 865  **/
 866 void tdb_search_list_free(TDB_LIST_NODE* node)
 867 {
 868         TDB_LIST_NODE *next_node;
 869
 870         while (node) {
 871                 next_node = node->next;
 872                 SAFE_FREE(node->node_key.dptr);
 873                 SAFE_FREE(node);
 874                 node = next_node;
 875         };
 876 }