r10656: BIG merge from trunk. Features not copied over
[samba.git] / source / tdb / tdbutil.c
index 2fd734f5d4cc49c9f69fa2c8925bffe6081b5ce6..e27880e5ea051ab71090e425466bfa3d3dce66c9 100644 (file)
@@ -1,7 +1,8 @@
 /* 
    Unix SMB/CIFS implementation.
    tdb utility functions
-   Copyright (C) Andrew Tridgell 1992-1998
+   Copyright (C) Andrew Tridgell   1992-1998
+   Copyright (C) Rafal Szczesniak  2002
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -39,24 +40,29 @@ static void gotalarm_sig(void)
  Make a TDB_DATA and keep the const warning in one place
 ****************************************************************/
 
-static TDB_DATA make_tdb_data(const char *dptr, size_t dsize)
+TDB_DATA make_tdb_data(const char *dptr, size_t dsize)
 {
        TDB_DATA ret;
-       ret.dptr = dptr;
+       ret.dptr = CONST_DISCARD(char *, dptr);
        ret.dsize = dsize;
        return ret;
 }
 
+TDB_DATA string_tdb_data(const char *string)
+{
+       return make_tdb_data(string, strlen(string));
+}
+
 /****************************************************************************
  Lock a chain with timeout (in seconds).
 ****************************************************************************/
 
-static int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout, int rw_type)
+static int tdb_chainlock_with_timeout_internal( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout, int rw_type)
 {
        /* Allow tdb_chainlock to be interrupted by an alarm. */
        int ret;
        gotalarm = 0;
-       tdb_set_lock_alarm(&gotalarm);
+       tdb_set_lock_alarm(CONST_DISCARD(sig_atomic_t *, &gotalarm));
 
        if (timeout) {
                CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
@@ -72,8 +78,12 @@ static int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned
                alarm(0);
                CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
                if (gotalarm) {
-                       DEBUG(0,("tdb_chainlock_with_timeout: alarm (%u) timed out for key %s in tdb %s\n",
+                       DEBUG(0,("tdb_chainlock_with_timeout_internal: alarm (%u) timed out for key %s in tdb %s\n",
                                timeout, key.dptr, tdb->name ));
+                       /* TODO: If we time out waiting for a lock, it might
+                        * be nice to use F_GETLK to get the pid of the
+                        * process currently holding the lock and print that
+                        * as part of the debugging message. -- mbp */
                        return -1;
                }
        }
@@ -81,6 +91,15 @@ static int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned
        return ret;
 }
 
+/****************************************************************************
+ Write lock a chain. Return -1 if timeout or lock failed.
+****************************************************************************/
+
+int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout)
+{
+       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
+}
+
 /****************************************************************************
  Lock a chain by string. Return -1 if timeout or lock failed.
 ****************************************************************************/
@@ -89,7 +108,7 @@ int tdb_lock_bystring(TDB_CONTEXT *tdb, const char *keyval, unsigned int timeout
 {
        TDB_DATA key = make_tdb_data(keyval, strlen(keyval)+1);
        
-       return tdb_chainlock_with_timeout(tdb, key, timeout, F_WRLCK);
+       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
 }
 
 /****************************************************************************
@@ -99,7 +118,7 @@ int tdb_lock_bystring(TDB_CONTEXT *tdb, const char *keyval, unsigned int timeout
 void tdb_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
 {
        TDB_DATA key = make_tdb_data(keyval, strlen(keyval)+1);
-       
+
        tdb_chainunlock(tdb, key);
 }
 
@@ -111,7 +130,7 @@ int tdb_read_lock_bystring(TDB_CONTEXT *tdb, const char *keyval, unsigned int ti
 {
        TDB_DATA key = make_tdb_data(keyval, strlen(keyval)+1);
        
-       return tdb_chainlock_with_timeout(tdb, key, timeout, F_RDLCK);
+       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_RDLCK);
 }
 
 /****************************************************************************
@@ -253,11 +272,11 @@ BOOL tdb_store_uint32(TDB_CONTEXT *tdb, const char *keystr, uint32 value)
  on failure.
 ****************************************************************************/
 
-int tdb_store_by_string(TDB_CONTEXT *tdb, const char *keystr, TDB_DATA data, int flags)
+int tdb_store_bystring(TDB_CONTEXT *tdb, const char *keystr, TDB_DATA data, int flags)
 {
        TDB_DATA key = make_tdb_data(keystr, strlen(keystr)+1);
-
-    return tdb_store(tdb, key, data, flags);
+       
+       return tdb_store(tdb, key, data, flags);
 }
 
 /****************************************************************************
@@ -265,22 +284,22 @@ int tdb_store_by_string(TDB_CONTEXT *tdb, const char *keystr, TDB_DATA data, int
  free() on the result dptr.
 ****************************************************************************/
 
-TDB_DATA tdb_fetch_by_string(TDB_CONTEXT *tdb, const char *keystr)
+TDB_DATA tdb_fetch_bystring(TDB_CONTEXT *tdb, const char *keystr)
 {
        TDB_DATA key = make_tdb_data(keystr, strlen(keystr)+1);
 
-    return tdb_fetch(tdb, key);
+       return tdb_fetch(tdb, key);
 }
 
 /****************************************************************************
  Delete an entry using a null terminated string key. 
 ****************************************************************************/
 
-int tdb_delete_by_string(TDB_CONTEXT *tdb, const char *keystr)
+int tdb_delete_bystring(TDB_CONTEXT *tdb, const char *keystr)
 {
        TDB_DATA key = make_tdb_data(keystr, strlen(keystr)+1);
 
-    return tdb_delete(tdb, key);
+       return tdb_delete(tdb, key);
 }
 
 /****************************************************************************
@@ -298,7 +317,7 @@ int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, const char *keystr, int32 *oldva
        if ((val = tdb_fetch_int32(tdb, keystr)) == -1) {
                /* The lookup failed */
                if (tdb_error(tdb) != TDB_ERR_NOEXIST) {
-                       /* but not becouse it didn't exist */
+                       /* but not because it didn't exist */
                        goto err_out;
                }
                
@@ -339,7 +358,7 @@ BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, const char *keystr, uint32 *oldv
        if (!tdb_fetch_uint32(tdb, keystr, &val)) {
                /* It failed */
                if (tdb_error(tdb) != TDB_ERR_NOEXIST) { 
-                       /* and not becouse it didn't exist */
+                       /* and not because it didn't exist */
                        goto err_out;
                }
 
@@ -371,9 +390,9 @@ BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, const char *keystr, uint32 *oldv
  integers and strings.
 ****************************************************************************/
 
-size_t tdb_pack(char *buf, int bufsize, const char *fmt, ...)
+size_t tdb_pack_va(char *buf, int bufsize, const char *fmt, va_list ap)
 {
-       va_list ap;
+       uint8 bt;
        uint16 w;
        uint32 d;
        int i;
@@ -385,48 +404,52 @@ size_t tdb_pack(char *buf, int bufsize, const char *fmt, ...)
        const char *fmt0 = fmt;
        int bufsize0 = bufsize;
 
-       va_start(ap, fmt);
-
        while (*fmt) {
                switch ((c = *fmt++)) {
-               case 'w':
+               case 'b': /* unsigned 8-bit integer */
+                       len = 1;
+                       bt = (uint8)va_arg(ap, int);
+                       if (bufsize && bufsize >= len)
+                               SSVAL(buf, 0, bt);
+                       break;
+               case 'w': /* unsigned 16-bit integer */
                        len = 2;
                        w = (uint16)va_arg(ap, int);
-                       if (bufsize >= len)
+                       if (bufsize && bufsize >= len)
                                SSVAL(buf, 0, w);
                        break;
-               case 'd':
+               case 'd': /* signed 32-bit integer (standard int in most systems) */
                        len = 4;
                        d = va_arg(ap, uint32);
-                       if (bufsize >= len)
+                       if (bufsize && bufsize >= len)
                                SIVAL(buf, 0, d);
                        break;
-               case 'p':
+               case 'p': /* pointer */
                        len = 4;
                        p = va_arg(ap, void *);
                        d = p?1:0;
-                       if (bufsize >= len)
+                       if (bufsize && bufsize >= len)
                                SIVAL(buf, 0, d);
                        break;
-               case 'P':
+               case 'P': /* null-terminated string */
                        s = va_arg(ap,char *);
                        w = strlen(s);
                        len = w + 1;
-                       if (bufsize >= len)
+                       if (bufsize && bufsize >= len)
                                memcpy(buf, s, len);
                        break;
-               case 'f':
+               case 'f': /* null-terminated string */
                        s = va_arg(ap,char *);
                        w = strlen(s);
                        len = w + 1;
-                       if (bufsize >= len)
+                       if (bufsize && bufsize >= len)
                                memcpy(buf, s, len);
                        break;
-               case 'B':
+               case 'B': /* fixed-length string */
                        i = va_arg(ap, int);
                        s = va_arg(ap, char *);
                        len = 4+i;
-                       if (bufsize >= len) {
+                       if (bufsize && bufsize >= len) {
                                SIVAL(buf, 0, i);
                                memcpy(buf+4, s, i);
                        }
@@ -439,17 +462,60 @@ size_t tdb_pack(char *buf, int bufsize, const char *fmt, ...)
                }
 
                buf += len;
-               bufsize -= len;
+               if (bufsize)
+                       bufsize -= len;
+               if (bufsize < 0)
+                       bufsize = 0;
        }
 
-       va_end(ap);
-
-       DEBUG(18,("tdb_pack(%s, %d) -> %d\n", 
+       DEBUG(18,("tdb_pack_va(%s, %d) -> %d\n", 
                 fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
        
        return PTR_DIFF(buf, buf0);
 }
 
+size_t tdb_pack(char *buf, int bufsize, const char *fmt, ...)
+{
+       va_list ap;
+       size_t result;
+
+       va_start(ap, fmt);
+       result = tdb_pack_va(buf, bufsize, fmt, ap);
+       va_end(ap);
+       return result;
+}
+
+BOOL tdb_pack_append(TALLOC_CTX *mem_ctx, uint8_t **buf, size_t *len,
+                    const char *fmt, ...)
+{
+       va_list ap;
+       size_t len1, len2;
+
+       va_start(ap, fmt);
+       len1 = tdb_pack_va(NULL, 0, fmt, ap);
+       va_end(ap);
+
+       if (mem_ctx != NULL)
+               *buf = TALLOC_REALLOC_ARRAY(mem_ctx, *buf, uint8_t,
+                                           (*len) + len1);
+       else
+               *buf = SMB_REALLOC_ARRAY(*buf, uint8_t, (*len) + len1);
+
+       if (*buf == NULL)
+               return False;
+
+       va_start(ap, fmt);
+       len2 = tdb_pack_va((*buf)+(*len), len1, fmt, ap);
+       va_end(ap);
+
+       if (len1 != len2)
+               return False;
+
+       *len += len2;
+
+       return True;
+}
+
 /****************************************************************************
  Useful pair of routines for packing/unpacking data consisting of
  integers and strings.
@@ -458,6 +524,7 @@ size_t tdb_pack(char *buf, int bufsize, const char *fmt, ...)
 int tdb_unpack(char *buf, int bufsize, const char *fmt, ...)
 {
        va_list ap;
+       uint8 *bt;
        uint16 *w;
        uint32 *d;
        int len;
@@ -473,6 +540,13 @@ int tdb_unpack(char *buf, int bufsize, const char *fmt, ...)
        
        while (*fmt) {
                switch ((c=*fmt++)) {
+               case 'b':
+                       len = 1;
+                       bt = va_arg(ap, uint8 *);
+                       if (bufsize < len)
+                               goto no_space;
+                       *bt = SVAL(buf, 0);
+                       break;
                case 'w':
                        len = 2;
                        w = va_arg(ap, uint16 *);
@@ -492,7 +566,12 @@ int tdb_unpack(char *buf, int bufsize, const char *fmt, ...)
                        p = va_arg(ap, void **);
                        if (bufsize < len)
                                goto no_space;
-                       *p = (void *)IVAL(buf, 0);
+                       /* 
+                        * This isn't a real pointer - only a token (1 or 0)
+                        * to mark the fact a pointer is present.
+                        */
+
+                       *p = (void *)(IVAL(buf, 0) ? (void *)1 : NULL);
                        break;
                case 'P':
                        s = va_arg(ap,char *);
@@ -522,7 +601,7 @@ int tdb_unpack(char *buf, int bufsize, const char *fmt, ...)
                        len += *i;
                        if (bufsize < len)
                                goto no_space;
-                       *b = (char *)malloc(*i);
+                       *b = (char *)SMB_MALLOC(*i);
                        if (! *b)
                                goto no_space;
                        memcpy(*b, buf+4, *i);
@@ -550,6 +629,130 @@ int tdb_unpack(char *buf, int bufsize, const char *fmt, ...)
        return -1;
 }
 
+
+/**
+ * Pack SID passed by pointer
+ *
+ * @param pack_buf pointer to buffer which is to be filled with packed data
+ * @param bufsize size of packing buffer
+ * @param sid pointer to sid to be packed
+ *
+ * @return length of the packed representation of the whole structure
+ **/
+size_t tdb_sid_pack(char* pack_buf, int bufsize, DOM_SID* sid)
+{
+       int idx;
+       size_t len = 0;
+       
+       if (!sid || !pack_buf) return -1;
+       
+       len += tdb_pack(pack_buf + len, bufsize - len, "bb", sid->sid_rev_num,
+                       sid->num_auths);
+       
+       for (idx = 0; idx < 6; idx++) {
+               len += tdb_pack(pack_buf + len, bufsize - len, "b", sid->id_auth[idx]);
+       }
+       
+       for (idx = 0; idx < MAXSUBAUTHS; idx++) {
+               len += tdb_pack(pack_buf + len, bufsize - len, "d", sid->sub_auths[idx]);
+       }
+       
+       return len;
+}
+
+
+/**
+ * Unpack SID into a pointer
+ *
+ * @param pack_buf pointer to buffer with packed representation
+ * @param bufsize size of the buffer
+ * @param sid pointer to sid structure to be filled with unpacked data
+ *
+ * @return size of structure unpacked from buffer
+ **/
+size_t tdb_sid_unpack(char* pack_buf, int bufsize, DOM_SID* sid)
+{
+       int idx, len = 0;
+       
+       if (!sid || !pack_buf) return -1;
+
+       len += tdb_unpack(pack_buf + len, bufsize - len, "bb",
+                         &sid->sid_rev_num, &sid->num_auths);
+                         
+       for (idx = 0; idx < 6; idx++) {
+               len += tdb_unpack(pack_buf + len, bufsize - len, "b", &sid->id_auth[idx]);
+       }
+       
+       for (idx = 0; idx < MAXSUBAUTHS; idx++) {
+               len += tdb_unpack(pack_buf + len, bufsize - len, "d", &sid->sub_auths[idx]);
+       }
+       
+       return len;
+}
+
+
+/**
+ * Pack TRUSTED_DOM_PASS passed by pointer
+ *
+ * @param pack_buf pointer to buffer which is to be filled with packed data
+ * @param bufsize size of the buffer
+ * @param pass pointer to trusted domain password to be packed
+ *
+ * @return length of the packed representation of the whole structure
+ **/
+size_t tdb_trusted_dom_pass_pack(char* pack_buf, int bufsize, TRUSTED_DOM_PASS* pass)
+{
+       int idx, len = 0;
+       
+       if (!pack_buf || !pass) return -1;
+       
+       /* packing unicode domain name and password */
+       len += tdb_pack(pack_buf + len, bufsize - len, "d", pass->uni_name_len);
+       
+       for (idx = 0; idx < 32; idx++)
+               len +=  tdb_pack(pack_buf + len, bufsize - len, "w", pass->uni_name[idx]);
+       
+       len += tdb_pack(pack_buf + len, bufsize - len, "dPd", pass->pass_len,
+                            pass->pass, pass->mod_time);
+
+       /* packing SID structure */
+       len += tdb_sid_pack(pack_buf + len, bufsize - len, &pass->domain_sid);
+
+       return len;
+}
+
+
+/**
+ * Unpack TRUSTED_DOM_PASS passed by pointer
+ *
+ * @param pack_buf pointer to buffer with packed representation
+ * @param bufsize size of the buffer
+ * @param pass pointer to trusted domain password to be filled with unpacked data
+ *
+ * @return size of structure unpacked from buffer
+ **/
+size_t tdb_trusted_dom_pass_unpack(char* pack_buf, int bufsize, TRUSTED_DOM_PASS* pass)
+{
+       int idx, len = 0;
+       
+       if (!pack_buf || !pass) return -1;
+
+       /* unpack unicode domain name and plaintext password */
+       len += tdb_unpack(pack_buf, bufsize - len, "d", &pass->uni_name_len);
+       
+       for (idx = 0; idx < 32; idx++)
+               len +=  tdb_unpack(pack_buf + len, bufsize - len, "w", &pass->uni_name[idx]);
+
+       len += tdb_unpack(pack_buf + len, bufsize - len, "dPd", &pass->pass_len, &pass->pass,
+                         &pass->mod_time);
+       
+       /* unpack domain sid */
+       len += tdb_sid_unpack(pack_buf + len, bufsize - len, &pass->domain_sid);
+       
+       return len;     
+}
+
+
 /****************************************************************************
  Log tdb messages via DEBUG().
 ****************************************************************************/
@@ -584,7 +787,7 @@ TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
                tdb_flags |= TDB_NOMMAP;
 
        tdb = tdb_open_ex(name, hash_size, tdb_flags, 
-                                   open_flags, mode, tdb_log);
+                                   open_flags, mode, tdb_log, NULL);
        if (!tdb)
                return NULL;
 
@@ -622,7 +825,7 @@ TDB_LIST_NODE *tdb_search_keys(TDB_CONTEXT *tdb, const char* pattern)
        
        for (key = tdb_firstkey(tdb); key.dptr; key = next) {
                /* duplicate key string to ensure null-termination */
-               char *key_str = (char*) strndup(key.dptr, key.dsize);
+               char *key_str = (char*) SMB_STRNDUP(key.dptr, key.dsize);
                if (!key_str) {
                        DEBUG(0, ("tdb_search_keys: strndup() failed!\n"));
                        smb_panic("strndup failed!\n");
@@ -634,7 +837,7 @@ TDB_LIST_NODE *tdb_search_keys(TDB_CONTEXT *tdb, const char* pattern)
 
                /* do the pattern checking */
                if (fnmatch(pattern, key_str, 0) == 0) {
-                       rec = (TDB_LIST_NODE*) malloc(sizeof(*rec));
+                       rec = SMB_MALLOC_P(TDB_LIST_NODE);
                        ZERO_STRUCTP(rec);
 
                        rec->node_key = key;
@@ -652,7 +855,7 @@ TDB_LIST_NODE *tdb_search_keys(TDB_CONTEXT *tdb, const char* pattern)
        
        return list;
 
-};
+}
 
 
 /**
@@ -666,9 +869,8 @@ void tdb_search_list_free(TDB_LIST_NODE* node)
        
        while (node) {
                next_node = node->next;
+               SAFE_FREE(node->node_key.dptr);
                SAFE_FREE(node);
                node = next_node;
        };
-};
-
-
+}