/*
* Unix SMB/CIFS implementation.
* Virtual Windows Registry Layer
* Copyright (C) Gerald Carter 2002-2005
*
* 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
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
/* Implementation of registry frontend view functions. */
#include "includes.h"
#undef DBGC_CLASS
#define DBGC_CLASS DBGC_REGISTRY
struct regsubkey_ctr {
uint32_t num_subkeys;
char **subkeys;
struct db_context *subkeys_hash;
int seqnum;
};
/**********************************************************************
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 regval_ctr_intit() and regval_ctr_destroy()
pair of functions. Simply TALLOC_ZERO_P() 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;
}
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 idx)
{
WERROR werr;
werr = ntstatus_to_werror(dbwrap_store_bystring(ctr->subkeys_hash,
keyname,
make_tdb_data((uint8 *)&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(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 *idx)
{
TDB_DATA data;
if ((ctr == NULL) || (keyname == NULL)) {
return WERR_INVALID_PARAM;
}
data = dbwrap_fetch_bystring(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 *)data.dptr;
}
talloc_free(data.dptr);
return WERR_OK;
}
/***********************************************************************
Add a new key to the array
**********************************************************************/
WERROR regsubkey_ctr_addkey( struct regsubkey_ctr *ctr, const char *keyname )
{
char **newkeys;
WERROR werr;
if ( !keyname ) {
return WERR_OK;
}
/* make sure the keyname is not already there */
if ( regsubkey_ctr_key_exists( ctr, keyname ) ) {
return WERR_OK;
}
if (!(newkeys = TALLOC_REALLOC_ARRAY(ctr, ctr->subkeys, char *,
ctr->num_subkeys+1))) {
return WERR_NOMEM;
}
ctr->subkeys = newkeys;
if (!(ctr->subkeys[ctr->num_subkeys] = talloc_strdup(ctr->subkeys,
keyname ))) {
/*
* Don't shrink the new array again, this wastes a pointer
*/
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;
}
/***********************************************************************
Delete a key from the array
**********************************************************************/
WERROR regsubkey_ctr_delkey( struct regsubkey_ctr *ctr, const char *keyname )
{
WERROR werr;
uint32 idx, j;
if (keyname == NULL) {
return WERR_INVALID_PARAM;
}
/* make sure the keyname is actually already there */
werr = regsubkey_ctr_index_for_keyname(ctr, keyname, &idx);
W_ERROR_NOT_OK_RETURN(werr);
werr = regsubkey_ctr_unhash_keyname(ctr, keyname);
W_ERROR_NOT_OK_RETURN(werr);
/* update if we have any keys left */
ctr->num_subkeys--;
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 WERR_OK;
}
/***********************************************************************
Check for the existance of a key
**********************************************************************/
bool regsubkey_ctr_key_exists( struct regsubkey_ctr *ctr, const char *keyname )
{
WERROR werr;
if (!ctr->subkeys) {
return False;
}
werr = regsubkey_ctr_index_for_keyname(ctr, keyname, NULL);
if (!W_ERROR_IS_OK(werr)) {
return false;
}
return true;
}
/***********************************************************************
How many keys does the container hold ?
**********************************************************************/
int regsubkey_ctr_numkeys( struct regsubkey_ctr *ctr )
{
return ctr->num_subkeys;
}
/***********************************************************************
Retreive a specific key string
**********************************************************************/
char* regsubkey_ctr_specific_key( struct regsubkey_ctr *ctr, uint32_t key_index )
{
if ( ! (key_index < ctr->num_subkeys) )
return NULL;
return ctr->subkeys[key_index];
}
/*
* Utility functions for struct regval_ctr
*/
/***********************************************************************
How many keys does the container hold ?
**********************************************************************/
int regval_ctr_numvals(struct regval_ctr *ctr)
{
return ctr->num_values;
}
/***********************************************************************
allocate memory for and duplicate a REGISTRY_VALUE.
This is malloc'd memory so the caller should free it when done
**********************************************************************/
REGISTRY_VALUE* dup_registry_value( REGISTRY_VALUE *val )
{
REGISTRY_VALUE *copy = NULL;
if ( !val )
return NULL;
if ( !(copy = SMB_MALLOC_P( REGISTRY_VALUE)) ) {
DEBUG(0,("dup_registry_value: malloc() failed!\n"));
return NULL;
}
/* copy all the non-pointer initial data */
memcpy( copy, val, sizeof(REGISTRY_VALUE) );
copy->size = 0;
copy->data_p = NULL;
if ( val->data_p && val->size )
{
if ( !(copy->data_p = (uint8 *)memdup( val->data_p,
val->size )) ) {
DEBUG(0,("dup_registry_value: memdup() failed for [%d] "
"bytes!\n", val->size));
SAFE_FREE( copy );
return NULL;
}
copy->size = val->size;
}
return copy;
}
/**********************************************************************
free the memory allocated to a REGISTRY_VALUE
*********************************************************************/
void free_registry_value( REGISTRY_VALUE *val )
{
if ( !val )
return;
SAFE_FREE( val->data_p );
SAFE_FREE( val );
return;
}
/**********************************************************************
*********************************************************************/
uint8* regval_data_p( REGISTRY_VALUE *val )
{
return val->data_p;
}
/**********************************************************************
*********************************************************************/
uint32 regval_size( REGISTRY_VALUE *val )
{
return val->size;
}
/**********************************************************************
*********************************************************************/
char* regval_name( REGISTRY_VALUE *val )
{
return val->valuename;
}
/**********************************************************************
*********************************************************************/
uint32 regval_type( REGISTRY_VALUE *val )
{
return val->type;
}
/***********************************************************************
Retreive a pointer to a specific value. Caller shoud dup the structure
since this memory will go away when the ctr is free()'d
**********************************************************************/
REGISTRY_VALUE* regval_ctr_specific_value(struct regval_ctr *ctr, uint32 idx)
{
if ( !(idx < ctr->num_values) )
return NULL;
return ctr->values[idx];
}
/***********************************************************************
Check for the existance of a value
**********************************************************************/
bool regval_ctr_key_exists(struct regval_ctr *ctr, const char *value)
{
int i;
for ( i=0; inum_values; i++ ) {
if ( strequal( ctr->values[i]->valuename, value) )
return True;
}
return False;
}
/***********************************************************************
* compose a REGISTRY_VALUE from input data
**********************************************************************/
REGISTRY_VALUE *regval_compose(TALLOC_CTX *ctx, const char *name, uint16 type,
const char *data_p, size_t size)
{
REGISTRY_VALUE *regval = TALLOC_P(ctx, REGISTRY_VALUE);
if (regval == NULL) {
return NULL;
}
fstrcpy(regval->valuename, name);
regval->type = type;
if (size) {
regval->data_p = (uint8 *)TALLOC_MEMDUP(regval, data_p, size);
if (!regval->data_p) {
TALLOC_FREE(regval);
return NULL;
}
} else {
regval->data_p = NULL;
}
regval->size = size;
return regval;
}
/***********************************************************************
Add a new registry value to the array
**********************************************************************/
int regval_ctr_addvalue(struct regval_ctr *ctr, const char *name, uint16 type,
const char *data_p, size_t size)
{
if ( !name )
return ctr->num_values;
/* Delete the current value (if it exists) and add the new one */
regval_ctr_delvalue( ctr, name );
/* allocate a slot in the array of pointers */
if ( ctr->num_values == 0 ) {
ctr->values = TALLOC_P( ctr, REGISTRY_VALUE *);
} else {
ctr->values = TALLOC_REALLOC_ARRAY(ctr, ctr->values,
REGISTRY_VALUE *,
ctr->num_values+1);
}
if (!ctr->values) {
ctr->num_values = 0;
return 0;
}
/* allocate a new value and store the pointer in the arrya */
ctr->values[ctr->num_values] = regval_compose(ctr, name, type, data_p,
size);
if (ctr->values[ctr->num_values] == NULL) {
ctr->num_values = 0;
return 0;
}
ctr->num_values++;
return ctr->num_values;
}
/***********************************************************************
Add a new registry value to the array
**********************************************************************/
int regval_ctr_copyvalue(struct regval_ctr *ctr, REGISTRY_VALUE *val)
{
if ( val ) {
regval_ctr_addvalue(ctr, val->valuename, val->type,
(char *)val->data_p, val->size);
}
return ctr->num_values;
}
/***********************************************************************
Delete a single value from the registry container.
No need to free memory since it is talloc'd.
**********************************************************************/
int regval_ctr_delvalue(struct regval_ctr *ctr, const char *name)
{
int i;
for ( i=0; inum_values; i++ ) {
if ( strequal( ctr->values[i]->valuename, name ) )
break;
}
/* just return if we don't find it */
if ( i == ctr->num_values )
return ctr->num_values;
/* If 'i' was not the last element, just shift everything down one */
ctr->num_values--;
if ( i < ctr->num_values )
memmove(&ctr->values[i], &ctr->values[i+1],
sizeof(REGISTRY_VALUE*)*(ctr->num_values-i));
return ctr->num_values;
}
/***********************************************************************
Retrieve single value from the registry container.
No need to free memory since it is talloc'd.
**********************************************************************/
REGISTRY_VALUE* regval_ctr_getvalue(struct regval_ctr *ctr, const char *name)
{
int i;
/* search for the value */
for ( i=0; inum_values; i++ ) {
if ( strequal( ctr->values[i]->valuename, name ) )
return ctr->values[i];
}
return NULL;
}
/***********************************************************************
return the data_p as a uint32
**********************************************************************/
uint32 regval_dword( REGISTRY_VALUE *val )
{
uint32 data;
data = IVAL( regval_data_p(val), 0 );
return data;
}
/***********************************************************************
return the data_p as a character string
**********************************************************************/
char *regval_sz(REGISTRY_VALUE *val)
{
char *data = NULL;
rpcstr_pull_talloc(talloc_tos(), &data,
regval_data_p(val), regval_size(val),0);
return data;
}