1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-25 23:21:54 +03:00
samba-mirror/source3/registry/reg_objects.c
Chris Lamb 5482e5426e Correct "existence" typos.
Signed-off-by: Chris Lamb <chris@chris-lamb.co.uk>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Garming Sam <garming@catalyst.net.nz>
2017-02-22 08:26:22 +01:00

615 lines
15 KiB
C

/*
* 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
* 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 <http://www.gnu.org/licenses/>.
*/
/* Implementation of registry frontend view functions. */
#include "includes.h"
#include "registry.h"
#include "reg_objects.h"
#include "util_tdb.h"
#include "dbwrap/dbwrap.h"
#include "dbwrap/dbwrap_rbt.h"
#include "../libcli/registry/util_reg.h"
#undef DBGC_CLASS
#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 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() and TALLOC_FREE() the
object.
**********************************************************************/
WERROR regsubkey_ctr_init(TALLOC_CTX *mem_ctx, struct regsubkey_ctr **ctr)
{
if (ctr == NULL) {
return WERR_INVALID_PARAMETER;
}
*ctr = talloc_zero(mem_ctx, struct regsubkey_ctr);
if (*ctr == NULL) {
return WERR_NOT_ENOUGH_MEMORY;
}
(*ctr)->subkeys_hash = db_open_rbt(*ctr);
if ((*ctr)->subkeys_hash == NULL) {
talloc_free(*ctr);
return WERR_NOT_ENOUGH_MEMORY;
}
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_PARAMETER;
}
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_PARAMETER;
}
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;
NTSTATUS status;
if ((ctr == NULL) || (keyname == NULL)) {
return WERR_INVALID_PARAMETER;
}
status = dbwrap_fetch_bystring_upper(ctr->subkeys_hash, ctr, keyname,
&data);
if (!NT_STATUS_IS_OK(status)) {
return WERR_NOT_FOUND;
}
if (data.dsize != sizeof(*idx)) {
talloc_free(data.dptr);
return WERR_INVALID_DATATYPE;
}
if (idx != NULL) {
memcpy(idx, data.dptr, sizeof(*idx));
}
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(ctr, ctr->subkeys, char *,
ctr->num_subkeys+1))) {
return WERR_NOT_ENOUGH_MEMORY;
}
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_NOT_ENOUGH_MEMORY;
}
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_t idx, j;
if (keyname == NULL) {
return WERR_INVALID_PARAMETER;
}
/* 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 existence 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;
}
/***********************************************************************
Retrieve 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
*/
/**
* allocate a regval_ctr structure.
*/
WERROR regval_ctr_init(TALLOC_CTX *mem_ctx, struct regval_ctr **ctr)
{
if (ctr == NULL) {
return WERR_INVALID_PARAMETER;
}
*ctr = talloc_zero(mem_ctx, struct regval_ctr);
if (*ctr == NULL) {
return WERR_NOT_ENOUGH_MEMORY;
}
return WERR_OK;
}
/***********************************************************************
How many keys does the container hold ?
**********************************************************************/
int regval_ctr_numvals(struct regval_ctr *ctr)
{
return ctr->num_values;
}
/**********************************************************************
*********************************************************************/
uint8_t* regval_data_p(struct regval_blob *val)
{
return val->data_p;
}
/**********************************************************************
*********************************************************************/
uint32_t regval_size(struct regval_blob *val)
{
return val->size;
}
/**********************************************************************
*********************************************************************/
char* regval_name(struct regval_blob *val)
{
return val->valuename;
}
/**********************************************************************
*********************************************************************/
uint32_t regval_type(struct regval_blob *val)
{
return val->type;
}
/***********************************************************************
Retrieve a pointer to a specific value. Caller shoud dup the structure
since this memory will go away when the ctr is free()'d
**********************************************************************/
struct regval_blob *regval_ctr_specific_value(struct regval_ctr *ctr,
uint32_t idx)
{
if ( !(idx < ctr->num_values) )
return NULL;
return ctr->values[idx];
}
/***********************************************************************
Check for the existence of a value
**********************************************************************/
bool regval_ctr_value_exists(struct regval_ctr *ctr, const char *value)
{
int i;
for ( i=0; i<ctr->num_values; i++ ) {
if ( strequal( ctr->values[i]->valuename, value) )
return True;
}
return False;
}
/**
* Get a value by its name
*/
struct regval_blob *regval_ctr_value_byname(struct regval_ctr *ctr,
const char *value)
{
int i;
for (i = 0; i < ctr->num_values; i++) {
if (strequal(ctr->values[i]->valuename, value)) {
return ctr->values[i];
}
}
return NULL;
}
/***********************************************************************
* compose a struct regval_blob from input data
**********************************************************************/
struct regval_blob *regval_compose(TALLOC_CTX *ctx, const char *name,
uint32_t type,
const uint8_t *data_p, size_t size)
{
struct regval_blob *regval = talloc(ctx, struct regval_blob);
if (regval == NULL) {
return NULL;
}
fstrcpy(regval->valuename, name);
regval->type = type;
if (size) {
regval->data_p = (uint8_t *)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, uint32_t type,
const uint8_t *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( ctr, struct regval_blob *);
} else {
ctr->values = talloc_realloc(ctr, ctr->values,
struct regval_blob *,
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 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(struct regval_ctr *ctr, struct regval_blob *val)
{
if ( val ) {
regval_ctr_addvalue(ctr, val->valuename, val->type,
(uint8_t *)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; i<ctr->num_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(struct regval_blob*)*(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.
**********************************************************************/
struct regval_blob* regval_ctr_getvalue(struct regval_ctr *ctr,
const char *name)
{
int i;
/* search for the value */
for ( i=0; i<ctr->num_values; i++ ) {
if ( strequal( ctr->values[i]->valuename, name ) )
return ctr->values[i];
}
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_PARAMETER;
}
ctr->seqnum = seqnum;
return WERR_OK;
}