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