i guess i'm the only one this ever annyoed...
[ira/wip.git] / source3 / tdb / tdbutil.c
index e7650033b87b9559e143c7273d11ff54b2f8e5d8..b01dacd0f5378105022371fd3df9f0622a15273f 100644 (file)
@@ -35,11 +35,23 @@ static void gotalarm_sig(void)
        gotalarm = 1;
 }
 
+/***************************************************************
+ 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 ret;
+       ret.dptr = dptr;
+       ret.dsize = dsize;
+       return ret;
+}
+
 /****************************************************************************
  Lock a chain with timeout (in seconds).
 ****************************************************************************/
 
-int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout)
+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;
@@ -51,62 +63,99 @@ int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int tim
                alarm(timeout);
        }
 
-       ret = tdb_chainlock(tdb, key);
+       if (rw_type == F_RDLCK)
+               ret = tdb_chainlock_read(tdb, key);
+       else
+               ret = tdb_chainlock(tdb, key);
 
        if (timeout) {
                alarm(0);
                CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
-               if (gotalarm)
+               if (gotalarm) {
+                       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;
+               }
        }
 
        return ret;
 }
 
 /****************************************************************************
Lock a chain by string. Return -1 if timeout or lock failed.
Write lock a chain. Return -1 if timeout or lock failed.
 ****************************************************************************/
 
-int tdb_lock_bystring(TDB_CONTEXT *tdb, char *keyval, unsigned int timeout)
+int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout)
 {
-       TDB_DATA key;
+       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
+}
 
-       key.dptr = keyval;
-       key.dsize = strlen(keyval)+1;
+/****************************************************************************
+ Lock a chain by string. Return -1 if timeout or lock failed.
+****************************************************************************/
+
+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);
+       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
 }
 
 /****************************************************************************
  Unlock a chain by string.
 ****************************************************************************/
 
-void tdb_unlock_bystring(TDB_CONTEXT *tdb, char *keyval)
+void tdb_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
 {
-       TDB_DATA key;
+       TDB_DATA key = make_tdb_data(keyval, strlen(keyval)+1);
 
-       key.dptr = keyval;
-       key.dsize = strlen(keyval)+1;
-       
        tdb_chainunlock(tdb, key);
 }
 
+/****************************************************************************
+ Read lock a chain by string. Return -1 if timeout or lock failed.
+****************************************************************************/
+
+int tdb_read_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_internal(tdb, key, timeout, F_RDLCK);
+}
+
+/****************************************************************************
+ Read unlock a chain by string.
+****************************************************************************/
+
+void tdb_read_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
+{
+       TDB_DATA key = make_tdb_data(keyval, strlen(keyval)+1);
+       
+       tdb_chainunlock_read(tdb, key);
+}
+
+
 /****************************************************************************
  Fetch a int32 value by a arbitrary blob key, return -1 if not found.
  Output is int32 in native byte order.
 ****************************************************************************/
 
-int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len)
+int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, const char *keyval, size_t len)
 {
-       TDB_DATA key, data;
+       TDB_DATA key = make_tdb_data(keyval, len);
+       TDB_DATA data;
        int32 ret;
 
-       key.dptr = keyval;
-       key.dsize = len;
        data = tdb_fetch(tdb, key);
-       if (!data.dptr || data.dsize != sizeof(int32))
+       if (!data.dptr || data.dsize != sizeof(int32)) {
+               SAFE_FREE(data.dptr);
                return -1;
-       
+       }
+
        ret = IVAL(data.dptr,0);
        SAFE_FREE(data.dptr);
        return ret;
@@ -117,7 +166,7 @@ int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len)
  Output is int32 in native byte order.
 ****************************************************************************/
 
-int32 tdb_fetch_int32(TDB_CONTEXT *tdb, char *keystr)
+int32 tdb_fetch_int32(TDB_CONTEXT *tdb, const char *keystr)
 {
        return tdb_fetch_int32_byblob(tdb, keystr, strlen(keystr) + 1);
 }
@@ -127,13 +176,12 @@ int32 tdb_fetch_int32(TDB_CONTEXT *tdb, char *keystr)
  Input is int32 in native byte order. Output in tdb is in little-endian.
 ****************************************************************************/
 
-int tdb_store_int32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, int32 v)
+int tdb_store_int32_byblob(TDB_CONTEXT *tdb, const char *keystr, size_t len, int32 v)
 {
-       TDB_DATA key, data;
+       TDB_DATA key = make_tdb_data(keystr, len);
+       TDB_DATA data;
        int32 v_store;
 
-       key.dptr = keystr;
-       key.dsize = len;
        SIVAL(&v_store,0,v);
        data.dptr = (void *)&v_store;
        data.dsize = sizeof(int32);
@@ -146,7 +194,7 @@ int tdb_store_int32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, int32 v)
  Input is int32 in native byte order. Output in tdb is in little-endian.
 ****************************************************************************/
 
-int tdb_store_int32(TDB_CONTEXT *tdb, char *keystr, int32 v)
+int tdb_store_int32(TDB_CONTEXT *tdb, const char *keystr, int32 v)
 {
        return tdb_store_int32_byblob(tdb, keystr, strlen(keystr) + 1, v);
 }
@@ -156,16 +204,17 @@ int tdb_store_int32(TDB_CONTEXT *tdb, char *keystr, int32 v)
  Output is uint32 in native byte order.
 ****************************************************************************/
 
-BOOL tdb_fetch_uint32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len, uint32 *value)
+BOOL tdb_fetch_uint32_byblob(TDB_CONTEXT *tdb, const char *keyval, size_t len, uint32 *value)
 {
-       TDB_DATA key, data;
+       TDB_DATA key = make_tdb_data(keyval, len);
+       TDB_DATA data;
 
-       key.dptr = keyval;
-       key.dsize = len;
        data = tdb_fetch(tdb, key);
-       if (!data.dptr || data.dsize != sizeof(uint32))
+       if (!data.dptr || data.dsize != sizeof(uint32)) {
+               SAFE_FREE(data.dptr);
                return False;
-       
+       }
+
        *value = IVAL(data.dptr,0);
        SAFE_FREE(data.dptr);
        return True;
@@ -176,7 +225,7 @@ BOOL tdb_fetch_uint32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len, uint32
  Output is uint32 in native byte order.
 ****************************************************************************/
 
-BOOL tdb_fetch_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 *value)
+BOOL tdb_fetch_uint32(TDB_CONTEXT *tdb, const char *keystr, uint32 *value)
 {
        return tdb_fetch_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
 }
@@ -186,14 +235,13 @@ BOOL tdb_fetch_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 *value)
  Input is uint32 in native byte order. Output in tdb is in little-endian.
 ****************************************************************************/
 
-BOOL tdb_store_uint32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, uint32 value)
+BOOL tdb_store_uint32_byblob(TDB_CONTEXT *tdb, const char *keystr, size_t len, uint32 value)
 {
-       TDB_DATA key, data;
+       TDB_DATA key = make_tdb_data(keystr, len);
+       TDB_DATA data;
        uint32 v_store;
        BOOL ret = True;
 
-       key.dptr = keystr;
-       key.dsize = len;
        SIVAL(&v_store, 0, value);
        data.dptr = (void *)&v_store;
        data.dsize = sizeof(uint32);
@@ -209,7 +257,7 @@ BOOL tdb_store_uint32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, uint32
  Input is uint32 in native byte order. Output in tdb is in little-endian.
 ****************************************************************************/
 
-BOOL tdb_store_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 value)
+BOOL tdb_store_uint32(TDB_CONTEXT *tdb, const char *keystr, uint32 value)
 {
        return tdb_store_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
 }
@@ -218,17 +266,11 @@ BOOL tdb_store_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 value)
  on failure.
 ****************************************************************************/
 
-int tdb_store_by_string(TDB_CONTEXT *tdb, char *keystr, void *buffer, int len)
+int tdb_store_bystring(TDB_CONTEXT *tdb, const char *keystr, TDB_DATA data, int flags)
 {
-    TDB_DATA key, data;
-
-    key.dptr = keystr;
-    key.dsize = strlen(keystr) + 1;
-
-    data.dptr = buffer;
-    data.dsize = len;
-
-    return tdb_store(tdb, key, data, TDB_REPLACE);
+       TDB_DATA key = make_tdb_data(keystr, strlen(keystr)+1);
+       
+       return tdb_store(tdb, key, data, flags);
 }
 
 /****************************************************************************
@@ -236,26 +278,20 @@ int tdb_store_by_string(TDB_CONTEXT *tdb, char *keystr, void *buffer, int len)
  free() on the result dptr.
 ****************************************************************************/
 
-TDB_DATA tdb_fetch_by_string(TDB_CONTEXT *tdb, char *keystr)
+TDB_DATA tdb_fetch_bystring(TDB_CONTEXT *tdb, const char *keystr)
 {
-    TDB_DATA key;
+       TDB_DATA key = make_tdb_data(keystr, strlen(keystr)+1);
 
-    key.dptr = keystr;
-    key.dsize = strlen(keystr) + 1;
-
-    return tdb_fetch(tdb, key);
+       return tdb_fetch(tdb, key);
 }
 
 /****************************************************************************
- Delete a buffer using a null terminated string key.
+ Delete an entry using a null terminated string key. 
 ****************************************************************************/
 
-int tdb_delete_by_string(TDB_CONTEXT *tdb, char *keystr)
+int tdb_delete_bystring(TDB_CONTEXT *tdb, const char *keystr)
 {
-       TDB_DATA key;
-
-       key.dptr = keystr;
-       key.dsize = strlen(keystr) + 1;
+       TDB_DATA key = make_tdb_data(keystr, strlen(keystr)+1);
 
        return tdb_delete(tdb, key);
 }
@@ -264,7 +300,7 @@ int tdb_delete_by_string(TDB_CONTEXT *tdb, char *keystr)
  Atomic integer change. Returns old value. To create, set initial value in *oldval. 
 ****************************************************************************/
 
-int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, char *keystr, int32 *oldval, int32 change_val)
+int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, const char *keystr, int32 *oldval, int32 change_val)
 {
        int32 val;
        int32 ret = -1;
@@ -275,7 +311,7 @@ int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, char *keystr, int32 *oldval, int
        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;
                }
                
@@ -305,7 +341,7 @@ int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, char *keystr, int32 *oldval, int
  Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval. 
 ****************************************************************************/
 
-BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, char *keystr, uint32 *oldval, uint32 change_val)
+BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, const char *keystr, uint32 *oldval, uint32 change_val)
 {
        uint32 val;
        BOOL ret = False;
@@ -316,7 +352,7 @@ BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, char *keystr, uint32 *oldval, ui
        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;
                }
 
@@ -348,9 +384,10 @@ BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, char *keystr, uint32 *oldval, ui
  integers and strings.
 ****************************************************************************/
 
-size_t tdb_pack(char *buf, int bufsize, char *fmt, ...)
+size_t tdb_pack(char *buf, int bufsize, const char *fmt, ...)
 {
        va_list ap;
+       uint8 bt;
        uint16 w;
        uint32 d;
        int i;
@@ -359,51 +396,57 @@ size_t tdb_pack(char *buf, int bufsize, char *fmt, ...)
        char *s;
        char c;
        char *buf0 = buf;
-       char *fmt0 = 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);
                        }
@@ -416,7 +459,10 @@ size_t tdb_pack(char *buf, int bufsize, char *fmt, ...)
                }
 
                buf += len;
-               bufsize -= len;
+               if (bufsize)
+                       bufsize -= len;
+               if (bufsize < 0)
+                       bufsize = 0;
        }
 
        va_end(ap);
@@ -432,9 +478,10 @@ size_t tdb_pack(char *buf, int bufsize, char *fmt, ...)
  integers and strings.
 ****************************************************************************/
 
-int tdb_unpack(char *buf, int bufsize, char *fmt, ...)
+int tdb_unpack(char *buf, int bufsize, const char *fmt, ...)
 {
        va_list ap;
+       uint8 *bt;
        uint16 *w;
        uint32 *d;
        int len;
@@ -443,13 +490,20 @@ int tdb_unpack(char *buf, int bufsize, char *fmt, ...)
        char *s, **b;
        char c;
        char *buf0 = buf;
-       char *fmt0 = fmt;
+       const char *fmt0 = fmt;
        int bufsize0 = bufsize;
 
        va_start(ap, 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 *);
@@ -527,6 +581,130 @@ int tdb_unpack(char *buf, int bufsize, 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().
 ****************************************************************************/
@@ -643,6 +821,7 @@ 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;
        };