source/registry/reg_objects.c

   1 /*
   2  *  Unix SMB/CIFS implementation.
   3  *  Virtual Windows Registry Layer
   4  *  Copyright (C) Gerald Carter                     2002-2005
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* Implementation of registry frontend view functions. */
  21
  22 #include "includes.h"
  23
  24 #undef DBGC_CLASS
  25 #define DBGC_CLASS DBGC_REGISTRY
  26
  27 /**********************************************************************
  28
  29  Note that the struct regsubkey_ctr and REGVAL_CTR objects *must* be
  30  talloc()'d since the methods use the object pointer as the talloc
  31  context for internal private data.
  32
  33  There is no longer a regval_ctr_intit() and regval_ctr_destroy()
  34  pair of functions.  Simply TALLOC_ZERO_P() and TALLOC_FREE() the
  35  object.
  36
  37  **********************************************************************/
  38
  39 WERROR regsubkey_ctr_init(TALLOC_CTX *mem_ctx, struct regsubkey_ctr **ctr)
  40 {
  41         if (ctr == NULL) {
  42                 return WERR_INVALID_PARAM;
  43         }
  44
  45         *ctr = talloc_zero(mem_ctx, struct regsubkey_ctr);
  46         if (*ctr == NULL) {
  47                 return WERR_NOMEM;
  48         }
  49
  50         return WERR_OK;
  51 }
  52
  53 WERROR regsubkey_ctr_set_seqnum(struct regsubkey_ctr *ctr, int seqnum)
  54 {
  55         if (ctr == NULL) {
  56                 return WERR_INVALID_PARAM;
  57         }
  58
  59         ctr->seqnum = seqnum;
  60
  61         return WERR_OK;
  62 }
  63
  64 int regsubkey_ctr_get_seqnum(struct regsubkey_ctr *ctr)
  65 {
  66         if (ctr == NULL) {
  67                 return -1;
  68         }
  69
  70         return ctr->seqnum;
  71 }
  72
  73 /***********************************************************************
  74  Add a new key to the array
  75  **********************************************************************/
  76
  77 WERROR regsubkey_ctr_addkey( struct regsubkey_ctr *ctr, const char *keyname )
  78 {
  79         char **newkeys;
  80
  81         if ( !keyname ) {
  82                 return WERR_OK;
  83         }
  84
  85         /* make sure the keyname is not already there */
  86
  87         if ( regsubkey_ctr_key_exists( ctr, keyname ) ) {
  88                 return WERR_OK;
  89         }
  90
  91         if (!(newkeys = TALLOC_REALLOC_ARRAY(ctr, ctr->subkeys, char *,
  92                                              ctr->num_subkeys+1))) {
  93                 return WERR_NOMEM;
  94         }
  95
  96         ctr->subkeys = newkeys;
  97
  98         if (!(ctr->subkeys[ctr->num_subkeys] = talloc_strdup(ctr->subkeys,
  99                                                              keyname ))) {
 100                 /*
 101                  * Don't shrink the new array again, this wastes a pointer
 102                  */
 103                 return WERR_NOMEM;
 104         }
 105         ctr->num_subkeys++;
 106
 107         return WERR_OK;
 108 }
 109
 110  /***********************************************************************
 111  Delete a key from the array
 112  **********************************************************************/
 113
 114 int regsubkey_ctr_delkey( struct regsubkey_ctr *ctr, const char *keyname )
 115 {
 116         int i;
 117
 118         if ( !keyname )
 119                 return ctr->num_subkeys;
 120
 121         /* make sure the keyname is actually already there */
 122
 123         for ( i=0; i<ctr->num_subkeys; i++ ) {
 124                 if ( strequal( ctr->subkeys[i], keyname ) )
 125                         break;
 126         }
 127
 128         if ( i == ctr->num_subkeys )
 129                 return ctr->num_subkeys;
 130
 131         /* update if we have any keys left */
 132         ctr->num_subkeys--;
 133         if ( i < ctr->num_subkeys )
 134                 memmove(&ctr->subkeys[i], &ctr->subkeys[i+1],
 135                         sizeof(char*) * (ctr->num_subkeys-i));
 136
 137         return ctr->num_subkeys;
 138 }
 139
 140 /***********************************************************************
 141  Check for the existance of a key
 142  **********************************************************************/
 143
 144 bool regsubkey_ctr_key_exists( struct regsubkey_ctr *ctr, const char *keyname )
 145 {
 146         int     i;
 147
 148         if (!ctr->subkeys) {
 149                 return False;
 150         }
 151
 152         for ( i=0; i<ctr->num_subkeys; i++ ) {
 153                 if ( strequal( ctr->subkeys[i],keyname ) )
 154                         return True;
 155         }
 156
 157         return False;
 158 }
 159
 160 /***********************************************************************
 161  How many keys does the container hold ?
 162  **********************************************************************/
 163
 164 int regsubkey_ctr_numkeys( struct regsubkey_ctr *ctr )
 165 {
 166         return ctr->num_subkeys;
 167 }
 168
 169 /***********************************************************************
 170  Retreive a specific key string
 171  **********************************************************************/
 172
 173 char* regsubkey_ctr_specific_key( struct regsubkey_ctr *ctr, uint32 key_index )
 174 {
 175         if ( ! (key_index < ctr->num_subkeys) )
 176                 return NULL;
 177
 178         return ctr->subkeys[key_index];
 179 }
 180
 181 /*
 182  * Utility functions for REGVAL_CTR
 183  */
 184
 185 /***********************************************************************
 186  How many keys does the container hold ?
 187  **********************************************************************/
 188
 189 int regval_ctr_numvals( REGVAL_CTR *ctr )
 190 {
 191         return ctr->num_values;
 192 }
 193
 194 /***********************************************************************
 195  allocate memory for and duplicate a REGISTRY_VALUE.
 196  This is malloc'd memory so the caller should free it when done
 197  **********************************************************************/
 198
 199 REGISTRY_VALUE* dup_registry_value( REGISTRY_VALUE *val )
 200 {
 201         REGISTRY_VALUE  *copy = NULL;
 202
 203         if ( !val )
 204                 return NULL;
 205
 206         if ( !(copy = SMB_MALLOC_P( REGISTRY_VALUE)) ) {
 207                 DEBUG(0,("dup_registry_value: malloc() failed!\n"));
 208                 return NULL;
 209         }
 210
 211         /* copy all the non-pointer initial data */
 212
 213         memcpy( copy, val, sizeof(REGISTRY_VALUE) );
 214
 215         copy->size = 0;
 216         copy->data_p = NULL;
 217
 218         if ( val->data_p && val->size )
 219         {
 220                 if ( !(copy->data_p = (uint8 *)memdup( val->data_p,
 221                                                        val->size )) ) {
 222                         DEBUG(0,("dup_registry_value: memdup() failed for [%d] "
 223                                  "bytes!\n", val->size));
 224                         SAFE_FREE( copy );
 225                         return NULL;
 226                 }
 227                 copy->size = val->size;
 228         }
 229
 230         return copy;
 231 }
 232
 233 /**********************************************************************
 234  free the memory allocated to a REGISTRY_VALUE
 235  *********************************************************************/
 236
 237 void free_registry_value( REGISTRY_VALUE *val )
 238 {
 239         if ( !val )
 240                 return;
 241
 242         SAFE_FREE( val->data_p );
 243         SAFE_FREE( val );
 244
 245         return;
 246 }
 247
 248 /**********************************************************************
 249  *********************************************************************/
 250
 251 uint8* regval_data_p( REGISTRY_VALUE *val )
 252 {
 253         return val->data_p;
 254 }
 255
 256 /**********************************************************************
 257  *********************************************************************/
 258
 259 uint32 regval_size( REGISTRY_VALUE *val )
 260 {
 261         return val->size;
 262 }
 263
 264 /**********************************************************************
 265  *********************************************************************/
 266
 267 char* regval_name( REGISTRY_VALUE *val )
 268 {
 269         return val->valuename;
 270 }
 271
 272 /**********************************************************************
 273  *********************************************************************/
 274
 275 uint32 regval_type( REGISTRY_VALUE *val )
 276 {
 277         return val->type;
 278 }
 279
 280 /***********************************************************************
 281  Retreive a pointer to a specific value.  Caller shoud dup the structure
 282  since this memory will go away when the ctr is free()'d
 283  **********************************************************************/
 284
 285 REGISTRY_VALUE* regval_ctr_specific_value( REGVAL_CTR *ctr, uint32 idx )
 286 {
 287         if ( !(idx < ctr->num_values) )
 288                 return NULL;
 289
 290         return ctr->values[idx];
 291 }
 292
 293 /***********************************************************************
 294  Check for the existance of a value
 295  **********************************************************************/
 296
 297 bool regval_ctr_key_exists( REGVAL_CTR *ctr, const char *value )
 298 {
 299         int     i;
 300
 301         for ( i=0; i<ctr->num_values; i++ ) {
 302                 if ( strequal( ctr->values[i]->valuename, value) )
 303                         return True;
 304         }
 305
 306         return False;
 307 }
 308
 309 /***********************************************************************
 310  * compose a REGISTRY_VALUE from input data
 311  **********************************************************************/
 312
 313 REGISTRY_VALUE *regval_compose(TALLOC_CTX *ctx, const char *name, uint16 type,
 314                                const char *data_p, size_t size)
 315 {
 316         REGISTRY_VALUE *regval = TALLOC_P(ctx, REGISTRY_VALUE);
 317
 318         if (regval == NULL) {
 319                 return NULL;
 320         }
 321
 322         fstrcpy(regval->valuename, name);
 323         regval->type = type;
 324         if (size) {
 325                 regval->data_p = (uint8 *)TALLOC_MEMDUP(regval, data_p, size);
 326                 if (!regval->data_p) {
 327                         TALLOC_FREE(regval);
 328                         return NULL;
 329                 }
 330         } else {
 331                 regval->data_p = NULL;
 332         }
 333         regval->size = size;
 334
 335         return regval;
 336 }
 337
 338 /***********************************************************************
 339  Add a new registry value to the array
 340  **********************************************************************/
 341
 342 int regval_ctr_addvalue( REGVAL_CTR *ctr, const char *name, uint16 type,
 343                          const char *data_p, size_t size )
 344 {
 345         if ( !name )
 346                 return ctr->num_values;
 347
 348         /* Delete the current value (if it exists) and add the new one */
 349
 350         regval_ctr_delvalue( ctr, name );
 351
 352         /* allocate a slot in the array of pointers */
 353
 354         if (  ctr->num_values == 0 ) {
 355                 ctr->values = TALLOC_P( ctr, REGISTRY_VALUE *);
 356         } else {
 357                 ctr->values = TALLOC_REALLOC_ARRAY(ctr, ctr->values,
 358                                                    REGISTRY_VALUE *,
 359                                                    ctr->num_values+1);
 360         }
 361
 362         if (!ctr->values) {
 363                 ctr->num_values = 0;
 364                 return 0;
 365         }
 366
 367         /* allocate a new value and store the pointer in the arrya */
 368
 369         ctr->values[ctr->num_values] = regval_compose(ctr, name, type, data_p,
 370                                                       size);
 371         if (ctr->values[ctr->num_values] == NULL) {
 372                 ctr->num_values = 0;
 373                 return 0;
 374         }
 375         ctr->num_values++;
 376
 377         return ctr->num_values;
 378 }
 379
 380 /***********************************************************************
 381  Add a new registry value to the array
 382  **********************************************************************/
 383
 384 int regval_ctr_copyvalue( REGVAL_CTR *ctr, REGISTRY_VALUE *val )
 385 {
 386         if ( val ) {
 387                 regval_ctr_addvalue(ctr, val->valuename, val->type,
 388                                     (char *)val->data_p, val->size);
 389         }
 390
 391         return ctr->num_values;
 392 }
 393
 394 /***********************************************************************
 395  Delete a single value from the registry container.
 396  No need to free memory since it is talloc'd.
 397  **********************************************************************/
 398
 399 int regval_ctr_delvalue( REGVAL_CTR *ctr, const char *name )
 400 {
 401         int     i;
 402
 403         for ( i=0; i<ctr->num_values; i++ ) {
 404                 if ( strequal( ctr->values[i]->valuename, name ) )
 405                         break;
 406         }
 407
 408         /* just return if we don't find it */
 409
 410         if ( i == ctr->num_values )
 411                 return ctr->num_values;
 412
 413         /* If 'i' was not the last element, just shift everything down one */
 414         ctr->num_values--;
 415         if ( i < ctr->num_values )
 416                 memmove(&ctr->values[i], &ctr->values[i+1],
 417                         sizeof(REGISTRY_VALUE*)*(ctr->num_values-i));
 418
 419         return ctr->num_values;
 420 }
 421
 422 /***********************************************************************
 423  Retrieve single value from the registry container.
 424  No need to free memory since it is talloc'd.
 425  **********************************************************************/
 426
 427 REGISTRY_VALUE* regval_ctr_getvalue( REGVAL_CTR *ctr, const char *name )
 428 {
 429         int     i;
 430
 431         /* search for the value */
 432
 433         for ( i=0; i<ctr->num_values; i++ ) {
 434                 if ( strequal( ctr->values[i]->valuename, name ) )
 435                         return ctr->values[i];
 436         }
 437
 438         return NULL;
 439 }
 440
 441 /***********************************************************************
 442  return the data_p as a uint32
 443  **********************************************************************/
 444
 445 uint32 regval_dword( REGISTRY_VALUE *val )
 446 {
 447         uint32 data;
 448
 449         data = IVAL( regval_data_p(val), 0 );
 450
 451         return data;
 452 }
 453
 454 /***********************************************************************
 455  return the data_p as a character string
 456  **********************************************************************/
 457
 458 char *regval_sz(REGISTRY_VALUE *val)
 459 {
 460         char *data = NULL;
 461
 462         rpcstr_pull_talloc(talloc_tos(), &data,
 463                         regval_data_p(val), regval_size(val),0);
 464         return data;
 465 }