s3-talloc Change TALLOC_ZERO_P() to talloc_zero()
[nivanova/samba-autobuild/.git] / source3 / registry / reg_objects.c
index 5b294abb9041d683a0cf963c7792abf27188f58a..54b6fe344131338cd99d255c134388fd8266fdf7 100644 (file)
@@ -2,6 +2,7 @@
  *  Unix SMB/CIFS implementation.
  *  Virtual Windows Registry Layer
  *  Copyright (C) Gerald Carter                     2002-2005
+ *  Copyright (C) Michael Adam                      2007-2010
  *
  *  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
 /* Implementation of registry frontend view functions. */
 
 #include "includes.h"
+#include "registry.h"
+#include "reg_objects.h"
+#include "util_tdb.h"
+#include "dbwrap.h"
+#include "../libcli/registry/util_reg.h"
 
 #undef DBGC_CLASS
-#define DBGC_CLASS DBGC_RPC_SRV
+#define DBGC_CLASS DBGC_REGISTRY
+
+/* low level structure to contain registry values */
+
+struct regval_blob {
+       fstring         valuename;
+       uint32_t        type;
+       /* this should be encapsulated in an RPC_DATA_BLOB */
+       uint32_t        size;   /* in bytes */
+       uint8_t         *data_p;
+};
+
+/* container for registry values */
+
+struct regval_ctr {
+       uint32_t num_values;
+       struct regval_blob **values;
+       int seqnum;
+};
+
+struct regsubkey_ctr {
+       uint32_t        num_subkeys;
+       char            **subkeys;
+       struct db_context *subkeys_hash;
+       int seqnum;
+};
 
 /**********************************************************************
 
- Note that the REGSUB_CTR and REGVAL_CTR objects *must* be talloc()'d
- since the methods use the object pointer as the talloc context for
- internal private data.
+ Note that the struct regsubkey_ctr and struct regval_ctr objects *must* be
+ talloc()'d since the methods use the object pointer as the talloc
context for internal private data.
 
- There is no longer a regXXX_ctr_intit() and regXXX_ctr_destroy()
- pair of functions.  Simply TALLOC_ZERO_P() and TALLOC_FREE() the
+ There is no longer a regval_ctr_intit() and regval_ctr_destroy()
+ pair of functions.  Simply talloc_zero() and TALLOC_FREE() the
  object.
 
  **********************************************************************/
 
+WERROR regsubkey_ctr_init(TALLOC_CTX *mem_ctx, struct regsubkey_ctr **ctr)
+{
+       if (ctr == NULL) {
+               return WERR_INVALID_PARAM;
+       }
+
+       *ctr = talloc_zero(mem_ctx, struct regsubkey_ctr);
+       if (*ctr == NULL) {
+               return WERR_NOMEM;
+       }
+
+       (*ctr)->subkeys_hash = db_open_rbt(*ctr);
+       if ((*ctr)->subkeys_hash == NULL) {
+               talloc_free(*ctr);
+               return WERR_NOMEM;
+       }
+
+       return WERR_OK;
+}
+
+/**
+ * re-initialize the list of subkeys (to the emtpy list)
+ * in an already allocated regsubkey_ctr
+ */
+
+WERROR regsubkey_ctr_reinit(struct regsubkey_ctr *ctr)
+{
+       if (ctr == NULL) {
+               return WERR_INVALID_PARAM;
+       }
+
+       talloc_free(ctr->subkeys_hash);
+       ctr->subkeys_hash = db_open_rbt(ctr);
+       W_ERROR_HAVE_NO_MEMORY(ctr->subkeys_hash);
+
+       TALLOC_FREE(ctr->subkeys);
+
+       ctr->num_subkeys = 0;
+       ctr->seqnum = 0;
+
+       return WERR_OK;
+}
+
+WERROR regsubkey_ctr_set_seqnum(struct regsubkey_ctr *ctr, int seqnum)
+{
+       if (ctr == NULL) {
+               return WERR_INVALID_PARAM;
+       }
+
+       ctr->seqnum = seqnum;
+
+       return WERR_OK;
+}
+
+int regsubkey_ctr_get_seqnum(struct regsubkey_ctr *ctr)
+{
+       if (ctr == NULL) {
+               return -1;
+       }
+
+       return ctr->seqnum;
+}
+
+static WERROR regsubkey_ctr_hash_keyname(struct regsubkey_ctr *ctr,
+                                        const char *keyname,
+                                        uint32_t idx)
+{
+       WERROR werr;
+
+       werr = ntstatus_to_werror(dbwrap_store_bystring_upper(ctr->subkeys_hash,
+                                               keyname,
+                                               make_tdb_data((uint8_t *)&idx,
+                                                             sizeof(idx)),
+                                               TDB_REPLACE));
+       if (!W_ERROR_IS_OK(werr)) {
+               DEBUG(1, ("error hashing new key '%s' in container: %s\n",
+                         keyname, win_errstr(werr)));
+       }
+
+       return werr;
+}
+
+static WERROR regsubkey_ctr_unhash_keyname(struct regsubkey_ctr *ctr,
+                                          const char *keyname)
+{
+       WERROR werr;
+
+       werr = ntstatus_to_werror(dbwrap_delete_bystring_upper(ctr->subkeys_hash,
+                                 keyname));
+       if (!W_ERROR_IS_OK(werr)) {
+               DEBUG(1, ("error unhashing key '%s' in container: %s\n",
+                         keyname, win_errstr(werr)));
+       }
+
+       return werr;
+}
+
+static WERROR regsubkey_ctr_index_for_keyname(struct regsubkey_ctr *ctr,
+                                             const char *keyname,
+                                             uint32_t *idx)
+{
+       TDB_DATA data;
+
+       if ((ctr == NULL) || (keyname == NULL)) {
+               return WERR_INVALID_PARAM;
+       }
+
+       data = dbwrap_fetch_bystring_upper(ctr->subkeys_hash, ctr, keyname);
+       if (data.dptr == NULL) {
+               return WERR_NOT_FOUND;
+       }
+
+       if (data.dsize != sizeof(*idx)) {
+               talloc_free(data.dptr);
+               return WERR_INVALID_DATATYPE;
+       }
+
+       if (idx != NULL) {
+               *idx = *(uint32_t *)data.dptr;
+       }
+
+       talloc_free(data.dptr);
+       return WERR_OK;
+}
+
 /***********************************************************************
  Add a new key to the array
  **********************************************************************/
 
-WERROR regsubkey_ctr_addkey( REGSUBKEY_CTR *ctr, const char *keyname )
+WERROR regsubkey_ctr_addkey( struct regsubkey_ctr *ctr, const char *keyname )
 {
        char **newkeys;
+       WERROR werr;
 
        if ( !keyname ) {
                return WERR_OK;
@@ -54,7 +211,7 @@ WERROR regsubkey_ctr_addkey( REGSUBKEY_CTR *ctr, const char *keyname )
                return WERR_OK;
        }
 
-       if (!(newkeys = TALLOC_REALLOC_ARRAY(ctr, ctr->subkeys, char *,
+       if (!(newkeys = talloc_realloc(ctr, ctr->subkeys, char *,
                                             ctr->num_subkeys+1))) {
                return WERR_NOMEM;
        }
@@ -68,6 +225,10 @@ WERROR regsubkey_ctr_addkey( REGSUBKEY_CTR *ctr, const char *keyname )
                 */
                return WERR_NOMEM;
        }
+
+       werr = regsubkey_ctr_hash_keyname(ctr, keyname, ctr->num_subkeys);
+       W_ERROR_NOT_OK_RETURN(werr);
+
        ctr->num_subkeys++;
 
        return WERR_OK;
@@ -77,57 +238,64 @@ WERROR regsubkey_ctr_addkey( REGSUBKEY_CTR *ctr, const char *keyname )
  Delete a key from the array
  **********************************************************************/
 
-int regsubkey_ctr_delkey( REGSUBKEY_CTR *ctr, const char *keyname )
+WERROR regsubkey_ctr_delkey( struct regsubkey_ctr *ctr, const char *keyname )
 {
-       int i;
+       WERROR werr;
+       uint32_t idx, j;
 
-       if ( !keyname )
-               return ctr->num_subkeys;
+       if (keyname == NULL) {
+               return WERR_INVALID_PARAM;
+       }
 
        /* make sure the keyname is actually already there */
 
-       for ( i=0; i<ctr->num_subkeys; i++ ) {
-               if ( strequal( ctr->subkeys[i], keyname ) )
-                       break;
-       }
+       werr = regsubkey_ctr_index_for_keyname(ctr, keyname, &idx);
+       W_ERROR_NOT_OK_RETURN(werr);
 
-       if ( i == ctr->num_subkeys )
-               return ctr->num_subkeys;
+       werr = regsubkey_ctr_unhash_keyname(ctr, keyname);
+       W_ERROR_NOT_OK_RETURN(werr);
 
        /* update if we have any keys left */
        ctr->num_subkeys--;
-       if ( i < ctr->num_subkeys )
-               memmove(&ctr->subkeys[i], &ctr->subkeys[i+1],
-                       sizeof(char*) * (ctr->num_subkeys-i));
+       if (idx < ctr->num_subkeys) {
+               memmove(&ctr->subkeys[idx], &ctr->subkeys[idx+1],
+                       sizeof(char *) * (ctr->num_subkeys - idx));
+
+               /* we have to re-hash rest of the array...  :-( */
+               for (j = idx; j < ctr->num_subkeys; j++) {
+                       werr = regsubkey_ctr_hash_keyname(ctr, ctr->subkeys[j], j);
+                       W_ERROR_NOT_OK_RETURN(werr);
+               }
+       }
 
-       return ctr->num_subkeys;
+       return WERR_OK;
 }
 
 /***********************************************************************
  Check for the existance of a key
  **********************************************************************/
 
-BOOL regsubkey_ctr_key_exists( REGSUBKEY_CTR *ctr, const char *keyname )
+bool regsubkey_ctr_key_exists( struct regsubkey_ctr *ctr, const char *keyname )
 {
-       int     i;
+       WERROR werr;
 
        if (!ctr->subkeys) {
                return False;
        }
 
-       for ( i=0; i<ctr->num_subkeys; i++ ) {
-               if ( strequal( ctr->subkeys[i],keyname ) )
-                       return True;
+       werr = regsubkey_ctr_index_for_keyname(ctr, keyname, NULL);
+       if (!W_ERROR_IS_OK(werr)) {
+               return false;
        }
 
-       return False;
+       return true;
 }
 
 /***********************************************************************
  How many keys does the container hold ?
  **********************************************************************/
 
-int regsubkey_ctr_numkeys( REGSUBKEY_CTR *ctr )
+int regsubkey_ctr_numkeys( struct regsubkey_ctr *ctr )
 {
        return ctr->num_subkeys;
 }
@@ -136,7 +304,7 @@ int regsubkey_ctr_numkeys( REGSUBKEY_CTR *ctr )
  Retreive a specific key string
  **********************************************************************/
 
-char* regsubkey_ctr_specific_key( REGSUBKEY_CTR *ctr, uint32 key_index )
+char* regsubkey_ctr_specific_key( struct regsubkey_ctr *ctr, uint32_t key_index )
 {
        if ( ! (key_index < ctr->num_subkeys) )
                return NULL;
@@ -145,45 +313,62 @@ char* regsubkey_ctr_specific_key( REGSUBKEY_CTR *ctr, uint32 key_index )
 }
 
 /*
- * Utility functions for REGVAL_CTR
+ * Utility functions for struct regval_ctr
+ */
+
+/**
+ * allocate a regval_ctr structure.
  */
+WERROR regval_ctr_init(TALLOC_CTX *mem_ctx, struct regval_ctr **ctr)
+{
+       if (ctr == NULL) {
+               return WERR_INVALID_PARAM;
+       }
+
+       *ctr = talloc_zero(mem_ctx, struct regval_ctr);
+       if (*ctr == NULL) {
+               return WERR_NOMEM;
+       }
+
+       return WERR_OK;
+}
 
 /***********************************************************************
  How many keys does the container hold ?
  **********************************************************************/
 
-int regval_ctr_numvals( REGVAL_CTR *ctr )
+int regval_ctr_numvals(struct regval_ctr *ctr)
 {
        return ctr->num_values;
 }
 
 /***********************************************************************
- allocate memory for and duplicate a REGISTRY_VALUE.
+ allocate memory for and duplicate a struct regval_blob.
  This is malloc'd memory so the caller should free it when done
  **********************************************************************/
 
-REGISTRY_VALUE* dup_registry_value( REGISTRY_VALUE *val )
+struct regval_blob* dup_registry_value(struct regval_blob *val)
 {
-       REGISTRY_VALUE  *copy = NULL;
+       struct regval_blob *copy = NULL;
 
        if ( !val )
                return NULL;
 
-       if ( !(copy = SMB_MALLOC_P( REGISTRY_VALUE)) ) {
+       if ( !(copy = SMB_MALLOC_P( struct regval_blob)) ) {
                DEBUG(0,("dup_registry_value: malloc() failed!\n"));
                return NULL;
        }
 
        /* copy all the non-pointer initial data */
 
-       memcpy( copy, val, sizeof(REGISTRY_VALUE) );
+       memcpy( copy, val, sizeof(struct regval_blob) );
 
        copy->size = 0;
        copy->data_p = NULL;
 
        if ( val->data_p && val->size )
        {
-               if ( !(copy->data_p = (uint8 *)memdup( val->data_p,
+               if ( !(copy->data_p = (uint8_t *)memdup( val->data_p,
                                                       val->size )) ) {
                        DEBUG(0,("dup_registry_value: memdup() failed for [%d] "
                                 "bytes!\n", val->size));
@@ -197,10 +382,10 @@ REGISTRY_VALUE* dup_registry_value( REGISTRY_VALUE *val )
 }
 
 /**********************************************************************
- free the memory allocated to a REGISTRY_VALUE
+ free the memory allocated to a struct regval_blob
  *********************************************************************/
 
-void free_registry_value( REGISTRY_VALUE *val )
+void free_registry_value(struct regval_blob *val)
 {
        if ( !val )
                return;
@@ -214,7 +399,7 @@ void free_registry_value( REGISTRY_VALUE *val )
 /**********************************************************************
  *********************************************************************/
 
-uint8* regval_data_p( REGISTRY_VALUE *val )
+uint8_t* regval_data_p(struct regval_blob *val)
 {
        return val->data_p;
 }
@@ -222,7 +407,7 @@ uint8* regval_data_p( REGISTRY_VALUE *val )
 /**********************************************************************
  *********************************************************************/
 
-uint32 regval_size( REGISTRY_VALUE *val )
+uint32_t regval_size(struct regval_blob *val)
 {
        return val->size;
 }
@@ -230,7 +415,7 @@ uint32 regval_size( REGISTRY_VALUE *val )
 /**********************************************************************
  *********************************************************************/
 
-char* regval_name( REGISTRY_VALUE *val )
+char* regval_name(struct regval_blob *val)
 {
        return val->valuename;
 }
@@ -238,7 +423,7 @@ char* regval_name( REGISTRY_VALUE *val )
 /**********************************************************************
  *********************************************************************/
 
-uint32 regval_type( REGISTRY_VALUE *val )
+uint32_t regval_type(struct regval_blob *val)
 {
        return val->type;
 }
@@ -248,7 +433,8 @@ uint32 regval_type( REGISTRY_VALUE *val )
  since this memory will go away when the ctr is free()'d
  **********************************************************************/
 
-REGISTRY_VALUE* regval_ctr_specific_value( REGVAL_CTR *ctr, uint32 idx )
+struct regval_blob *regval_ctr_specific_value(struct regval_ctr *ctr,
+                                             uint32_t idx)
 {
        if ( !(idx < ctr->num_values) )
                return NULL;
@@ -260,7 +446,7 @@ REGISTRY_VALUE* regval_ctr_specific_value( REGVAL_CTR *ctr, uint32 idx )
  Check for the existance of a value
  **********************************************************************/
 
-BOOL regval_ctr_key_exists( REGVAL_CTR *ctr, const char *value )
+bool regval_ctr_key_exists(struct regval_ctr *ctr, const char *value)
 {
        int     i;
 
@@ -273,13 +459,14 @@ BOOL regval_ctr_key_exists( REGVAL_CTR *ctr, const char *value )
 }
 
 /***********************************************************************
- * compose a REGISTRY_VALUE from input data
+ * compose a struct regval_blob from input data
  **********************************************************************/
 
-REGISTRY_VALUE *regval_compose(TALLOC_CTX *ctx, const char *name, uint16 type,
-                              const char *data_p, size_t size)
+struct regval_blob *regval_compose(TALLOC_CTX *ctx, const char *name,
+                                  uint32_t type,
+                                  const uint8_t *data_p, size_t size)
 {
-       REGISTRY_VALUE *regval = TALLOC_P(ctx, REGISTRY_VALUE);
+       struct regval_blob *regval = talloc(ctx, struct regval_blob);
 
        if (regval == NULL) {
                return NULL;
@@ -288,7 +475,7 @@ REGISTRY_VALUE *regval_compose(TALLOC_CTX *ctx, const char *name, uint16 type,
        fstrcpy(regval->valuename, name);
        regval->type = type;
        if (size) {
-               regval->data_p = (uint8 *)TALLOC_MEMDUP(regval, data_p, size);
+               regval->data_p = (uint8_t *)TALLOC_MEMDUP(regval, data_p, size);
                if (!regval->data_p) {
                        TALLOC_FREE(regval);
                        return NULL;
@@ -305,8 +492,8 @@ REGISTRY_VALUE *regval_compose(TALLOC_CTX *ctx, const char *name, uint16 type,
  Add a new registry value to the array
  **********************************************************************/
 
-int regval_ctr_addvalue( REGVAL_CTR *ctr, const char *name, uint16 type,
-                         const char *data_p, size_t size )
+int regval_ctr_addvalue(struct regval_ctr *ctr, const char *name, uint32_t type,
+                        const uint8_t *data_p, size_t size)
 {
        if ( !name )
                return ctr->num_values;
@@ -318,10 +505,10 @@ int regval_ctr_addvalue( REGVAL_CTR *ctr, const char *name, uint16 type,
        /* allocate a slot in the array of pointers */
 
        if (  ctr->num_values == 0 ) {
-               ctr->values = TALLOC_P( ctr, REGISTRY_VALUE *);
+               ctr->values = talloc( ctr, struct regval_blob *);
        } else {
-               ctr->values = TALLOC_REALLOC_ARRAY(ctr, ctr->values,
-                                                  REGISTRY_VALUE *,
+               ctr->values = talloc_realloc(ctr, ctr->values,
+                                                  struct regval_blob *,
                                                   ctr->num_values+1);
        }
 
@@ -343,15 +530,49 @@ int regval_ctr_addvalue( REGVAL_CTR *ctr, const char *name, uint16 type,
        return ctr->num_values;
 }
 
+/***********************************************************************
+ Add a new registry SZ value to the array
+ **********************************************************************/
+
+int regval_ctr_addvalue_sz(struct regval_ctr *ctr, const char *name, const char *data)
+{
+       DATA_BLOB blob;
+
+       if (!push_reg_sz(ctr, &blob, data)) {
+               return -1;
+       }
+
+       return regval_ctr_addvalue(ctr, name, REG_SZ,
+                                  (const uint8_t *)blob.data,
+                                  blob.length);
+}
+
+/***********************************************************************
+ Add a new registry MULTI_SZ value to the array
+ **********************************************************************/
+
+int regval_ctr_addvalue_multi_sz(struct regval_ctr *ctr, const char *name, const char **data)
+{
+       DATA_BLOB blob;
+
+       if (!push_reg_multi_sz(ctr, &blob, data)) {
+               return -1;
+       }
+
+       return regval_ctr_addvalue(ctr, name, REG_MULTI_SZ,
+                                  (const uint8_t *)blob.data,
+                                  blob.length);
+}
+
 /***********************************************************************
  Add a new registry value to the array
  **********************************************************************/
 
-int regval_ctr_copyvalue( REGVAL_CTR *ctr, REGISTRY_VALUE *val )
+int regval_ctr_copyvalue(struct regval_ctr *ctr, struct regval_blob *val)
 {
        if ( val ) {
                regval_ctr_addvalue(ctr, val->valuename, val->type,
-                                   (char *)val->data_p, val->size);
+                                   (uint8_t *)val->data_p, val->size);
        }
 
        return ctr->num_values;
@@ -362,7 +583,7 @@ int regval_ctr_copyvalue( REGVAL_CTR *ctr, REGISTRY_VALUE *val )
  No need to free memory since it is talloc'd.
  **********************************************************************/
 
-int regval_ctr_delvalue( REGVAL_CTR *ctr, const char *name )
+int regval_ctr_delvalue(struct regval_ctr *ctr, const char *name)
 {
        int     i;
 
@@ -380,7 +601,7 @@ int regval_ctr_delvalue( REGVAL_CTR *ctr, const char *name )
        ctr->num_values--;
        if ( i < ctr->num_values )
                memmove(&ctr->values[i], &ctr->values[i+1],
-                       sizeof(REGISTRY_VALUE*)*(ctr->num_values-i));
+                       sizeof(struct regval_blob*)*(ctr->num_values-i));
 
        return ctr->num_values;
 }
@@ -390,7 +611,8 @@ int regval_ctr_delvalue( REGVAL_CTR *ctr, const char *name )
  No need to free memory since it is talloc'd.
  **********************************************************************/
 
-REGISTRY_VALUE* regval_ctr_getvalue( REGVAL_CTR *ctr, const char *name )
+struct regval_blob* regval_ctr_getvalue(struct regval_ctr *ctr,
+                                       const char *name)
 {
        int     i;
 
@@ -404,13 +626,33 @@ REGISTRY_VALUE* regval_ctr_getvalue( REGVAL_CTR *ctr, const char *name )
        return NULL;
 }
 
+int regval_ctr_get_seqnum(struct regval_ctr *ctr)
+{
+       if (ctr == NULL) {
+               return -1;
+       }
+
+       return ctr->seqnum;
+}
+
+WERROR regval_ctr_set_seqnum(struct regval_ctr *ctr, int seqnum)
+{
+       if (ctr == NULL) {
+               return WERR_INVALID_PARAM;
+       }
+
+       ctr->seqnum = seqnum;
+
+       return WERR_OK;
+}
+
 /***********************************************************************
- return the data_p as a uint32
+ return the data_p as a uint32_t
  **********************************************************************/
 
-uint32 regval_dword( REGISTRY_VALUE *val )
+uint32_t regval_dword(struct regval_blob *val)
 {
-       uint32 data;
+       uint32_t data;
 
        data = IVAL( regval_data_p(val), 0 );
 
@@ -421,11 +663,12 @@ uint32 regval_dword( REGISTRY_VALUE *val )
  return the data_p as a character string
  **********************************************************************/
 
-char* regval_sz( REGISTRY_VALUE *val )
+const char *regval_sz(struct regval_blob *val)
 {
-       pstring data;
+       const char *data = NULL;
+       DATA_BLOB blob = data_blob_const(regval_data_p(val), regval_size(val));
 
-       rpcstr_pull(data, regval_data_p(val), sizeof(data), regval_size(val),0);
+       pull_reg_sz(talloc_tos(), &blob, &data);
 
-       return talloc_strdup(talloc_tos(), data);
+       return data;
 }