WHATSNEW: Update changes since 3.3.0.
[Samba.git] / source / registry / reg_api.c
blobe9a71452556fb198ef1b7eb7001b91481beafb34
1 /*
2 * Unix SMB/CIFS implementation.
3 * Virtual Windows Registry Layer
4 * Copyright (C) Volker Lendecke 2006
5 * Copyright (C) Michael Adam 2007-2008
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 /* Attempt to wrap the existing API in a more winreg.idl-like way */
24 * Here is a list of winreg.idl functions and corresponding implementations
25 * provided here:
27 * 0x00 winreg_OpenHKCR
28 * 0x01 winreg_OpenHKCU
29 * 0x02 winreg_OpenHKLM
30 * 0x03 winreg_OpenHKPD
31 * 0x04 winreg_OpenHKU
32 * 0x05 winreg_CloseKey
33 * 0x06 winreg_CreateKey reg_createkey
34 * 0x07 winreg_DeleteKey reg_deletekey
35 * 0x08 winreg_DeleteValue reg_deletevalue
36 * 0x09 winreg_EnumKey reg_enumkey
37 * 0x0a winreg_EnumValue reg_enumvalue
38 * 0x0b winreg_FlushKey
39 * 0x0c winreg_GetKeySecurity reg_getkeysecurity
40 * 0x0d winreg_LoadKey
41 * 0x0e winreg_NotifyChangeKeyValue
42 * 0x0f winreg_OpenKey reg_openkey
43 * 0x10 winreg_QueryInfoKey reg_queryinfokey
44 * 0x11 winreg_QueryValue reg_queryvalue
45 * 0x12 winreg_ReplaceKey
46 * 0x13 winreg_RestoreKey reg_restorekey
47 * 0x14 winreg_SaveKey reg_savekey
48 * 0x15 winreg_SetKeySecurity reg_setkeysecurity
49 * 0x16 winreg_SetValue reg_setvalue
50 * 0x17 winreg_UnLoadKey
51 * 0x18 winreg_InitiateSystemShutdown
52 * 0x19 winreg_AbortSystemShutdown
53 * 0x1a winreg_GetVersion reg_getversion
54 * 0x1b winreg_OpenHKCC
55 * 0x1c winreg_OpenHKDD
56 * 0x1d winreg_QueryMultipleValues
57 * 0x1e winreg_InitiateSystemShutdownEx
58 * 0x1f winreg_SaveKeyEx
59 * 0x20 winreg_OpenHKPT
60 * 0x21 winreg_OpenHKPN
61 * 0x22 winreg_QueryMultipleValues2
65 #include "includes.h"
66 #include "regfio.h"
68 #undef DBGC_CLASS
69 #define DBGC_CLASS DBGC_REGISTRY
72 /**********************************************************************
73 * Helper functions
74 **********************************************************************/
76 static WERROR fill_value_cache(struct registry_key *key)
78 if (key->values != NULL) {
79 if (!reg_values_need_update(key->key, key->values)) {
80 return WERR_OK;
84 if (!(key->values = TALLOC_ZERO_P(key, REGVAL_CTR))) {
85 return WERR_NOMEM;
87 if (fetch_reg_values(key->key, key->values) == -1) {
88 TALLOC_FREE(key->values);
89 return WERR_BADFILE;
92 return WERR_OK;
95 static WERROR fill_subkey_cache(struct registry_key *key)
97 if (key->subkeys != NULL) {
98 if (!reg_subkeys_need_update(key->key, key->subkeys)) {
99 return WERR_OK;
103 if (!(key->subkeys = TALLOC_ZERO_P(key, REGSUBKEY_CTR))) {
104 return WERR_NOMEM;
107 if (fetch_reg_keys(key->key, key->subkeys) == -1) {
108 TALLOC_FREE(key->subkeys);
109 return WERR_NO_MORE_ITEMS;
112 return WERR_OK;
115 static int regkey_destructor(REGISTRY_KEY *key)
117 return regdb_close();
120 static WERROR regkey_open_onelevel(TALLOC_CTX *mem_ctx,
121 struct registry_key *parent,
122 const char *name,
123 const struct nt_user_token *token,
124 uint32 access_desired,
125 struct registry_key **pregkey)
127 WERROR result = WERR_OK;
128 struct registry_key *regkey;
129 REGISTRY_KEY *key;
130 REGSUBKEY_CTR *subkeys = NULL;
132 DEBUG(7,("regkey_open_onelevel: name = [%s]\n", name));
134 SMB_ASSERT(strchr(name, '\\') == NULL);
136 if (!(regkey = TALLOC_ZERO_P(mem_ctx, struct registry_key)) ||
137 !(regkey->token = dup_nt_token(regkey, token)) ||
138 !(regkey->key = TALLOC_ZERO_P(regkey, REGISTRY_KEY))) {
139 result = WERR_NOMEM;
140 goto done;
143 if ( !(W_ERROR_IS_OK(result = regdb_open())) ) {
144 goto done;
147 key = regkey->key;
148 talloc_set_destructor(key, regkey_destructor);
150 /* initialization */
152 key->type = REG_KEY_GENERIC;
154 if (name[0] == '\0') {
156 * Open a copy of the parent key
158 if (!parent) {
159 result = WERR_BADFILE;
160 goto done;
162 key->name = talloc_strdup(key, parent->key->name);
164 else {
166 * Normal subkey open
168 key->name = talloc_asprintf(key, "%s%s%s",
169 parent ? parent->key->name : "",
170 parent ? "\\": "",
171 name);
174 if (key->name == NULL) {
175 result = WERR_NOMEM;
176 goto done;
179 /* Tag this as a Performance Counter Key */
181 if( StrnCaseCmp(key->name, KEY_HKPD, strlen(KEY_HKPD)) == 0 )
182 key->type = REG_KEY_HKPD;
184 /* Look up the table of registry I/O operations */
186 if ( !(key->ops = reghook_cache_find( key->name )) ) {
187 DEBUG(0,("reg_open_onelevel: Failed to assign "
188 "REGISTRY_OPS to [%s]\n", key->name ));
189 result = WERR_BADFILE;
190 goto done;
193 /* check if the path really exists; failed is indicated by -1 */
194 /* if the subkey count failed, bail out */
196 if ( !(subkeys = TALLOC_ZERO_P( key, REGSUBKEY_CTR )) ) {
197 result = WERR_NOMEM;
198 goto done;
201 if ( fetch_reg_keys( key, subkeys ) == -1 ) {
202 result = WERR_BADFILE;
203 goto done;
206 TALLOC_FREE( subkeys );
208 if ( !regkey_access_check( key, access_desired, &key->access_granted,
209 token ) ) {
210 result = WERR_ACCESS_DENIED;
211 goto done;
214 *pregkey = regkey;
215 result = WERR_OK;
217 done:
218 if ( !W_ERROR_IS_OK(result) ) {
219 TALLOC_FREE(regkey);
222 return result;
225 WERROR reg_openhive(TALLOC_CTX *mem_ctx, const char *hive,
226 uint32 desired_access,
227 const struct nt_user_token *token,
228 struct registry_key **pkey)
230 SMB_ASSERT(hive != NULL);
231 SMB_ASSERT(hive[0] != '\0');
232 SMB_ASSERT(strchr(hive, '\\') == NULL);
234 return regkey_open_onelevel(mem_ctx, NULL, hive, token, desired_access,
235 pkey);
239 /**********************************************************************
240 * The API functions
241 **********************************************************************/
243 WERROR reg_openkey(TALLOC_CTX *mem_ctx, struct registry_key *parent,
244 const char *name, uint32 desired_access,
245 struct registry_key **pkey)
247 struct registry_key *direct_parent = parent;
248 WERROR err;
249 char *p, *path, *to_free;
250 size_t len;
252 if (!(path = SMB_STRDUP(name))) {
253 return WERR_NOMEM;
255 to_free = path;
257 len = strlen(path);
259 if ((len > 0) && (path[len-1] == '\\')) {
260 path[len-1] = '\0';
263 while ((p = strchr(path, '\\')) != NULL) {
264 char *name_component;
265 struct registry_key *tmp;
267 if (!(name_component = SMB_STRNDUP(path, (p - path)))) {
268 err = WERR_NOMEM;
269 goto error;
272 err = regkey_open_onelevel(mem_ctx, direct_parent,
273 name_component, parent->token,
274 SEC_RIGHTS_ENUM_SUBKEYS, &tmp);
275 SAFE_FREE(name_component);
277 if (!W_ERROR_IS_OK(err)) {
278 goto error;
280 if (direct_parent != parent) {
281 TALLOC_FREE(direct_parent);
284 direct_parent = tmp;
285 path = p+1;
288 err = regkey_open_onelevel(mem_ctx, direct_parent, path, parent->token,
289 desired_access, pkey);
290 error:
291 if (direct_parent != parent) {
292 TALLOC_FREE(direct_parent);
294 SAFE_FREE(to_free);
295 return err;
298 WERROR reg_enumkey(TALLOC_CTX *mem_ctx, struct registry_key *key,
299 uint32 idx, char **name, NTTIME *last_write_time)
301 WERROR err;
303 if (!(key->key->access_granted & SEC_RIGHTS_ENUM_SUBKEYS)) {
304 return WERR_ACCESS_DENIED;
307 if (!W_ERROR_IS_OK(err = fill_subkey_cache(key))) {
308 return err;
311 if (idx >= key->subkeys->num_subkeys) {
312 return WERR_NO_MORE_ITEMS;
315 if (!(*name = talloc_strdup(mem_ctx, key->subkeys->subkeys[idx]))) {
316 return WERR_NOMEM;
319 if (last_write_time) {
320 *last_write_time = 0;
323 return WERR_OK;
326 WERROR reg_enumvalue(TALLOC_CTX *mem_ctx, struct registry_key *key,
327 uint32 idx, char **pname, struct registry_value **pval)
329 struct registry_value *val;
330 WERROR err;
332 if (!(key->key->access_granted & SEC_RIGHTS_QUERY_VALUE)) {
333 return WERR_ACCESS_DENIED;
336 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
337 return err;
340 if (idx >= key->values->num_values) {
341 return WERR_NO_MORE_ITEMS;
344 err = registry_pull_value(mem_ctx, &val,
345 key->values->values[idx]->type,
346 key->values->values[idx]->data_p,
347 key->values->values[idx]->size,
348 key->values->values[idx]->size);
349 if (!W_ERROR_IS_OK(err)) {
350 return err;
353 if (pname
354 && !(*pname = talloc_strdup(
355 mem_ctx, key->values->values[idx]->valuename))) {
356 SAFE_FREE(val);
357 return WERR_NOMEM;
360 *pval = val;
361 return WERR_OK;
364 WERROR reg_queryvalue(TALLOC_CTX *mem_ctx, struct registry_key *key,
365 const char *name, struct registry_value **pval)
367 WERROR err;
368 uint32 i;
370 if (!(key->key->access_granted & SEC_RIGHTS_QUERY_VALUE)) {
371 return WERR_ACCESS_DENIED;
374 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
375 return err;
378 for (i=0; i<key->values->num_values; i++) {
379 if (strequal(key->values->values[i]->valuename, name)) {
380 return reg_enumvalue(mem_ctx, key, i, NULL, pval);
384 return WERR_BADFILE;
387 WERROR reg_queryinfokey(struct registry_key *key, uint32_t *num_subkeys,
388 uint32_t *max_subkeylen, uint32_t *max_subkeysize,
389 uint32_t *num_values, uint32_t *max_valnamelen,
390 uint32_t *max_valbufsize, uint32_t *secdescsize,
391 NTTIME *last_changed_time)
393 uint32 i, max_size;
394 size_t max_len;
395 TALLOC_CTX *mem_ctx;
396 WERROR err;
397 struct security_descriptor *secdesc;
399 if (!(key->key->access_granted & SEC_RIGHTS_QUERY_VALUE)) {
400 return WERR_ACCESS_DENIED;
403 if (!W_ERROR_IS_OK(fill_subkey_cache(key)) ||
404 !W_ERROR_IS_OK(fill_value_cache(key))) {
405 return WERR_BADFILE;
408 max_len = 0;
409 for (i=0; i<key->subkeys->num_subkeys; i++) {
410 max_len = MAX(max_len, strlen(key->subkeys->subkeys[i]));
413 *num_subkeys = key->subkeys->num_subkeys;
414 *max_subkeylen = max_len;
415 *max_subkeysize = 0; /* Class length? */
417 max_len = 0;
418 max_size = 0;
419 for (i=0; i<key->values->num_values; i++) {
420 max_len = MAX(max_len,
421 strlen(key->values->values[i]->valuename));
422 max_size = MAX(max_size, key->values->values[i]->size);
425 *num_values = key->values->num_values;
426 *max_valnamelen = max_len;
427 *max_valbufsize = max_size;
429 if (!(mem_ctx = talloc_new(key))) {
430 return WERR_NOMEM;
433 err = regkey_get_secdesc(mem_ctx, key->key, &secdesc);
434 if (!W_ERROR_IS_OK(err)) {
435 TALLOC_FREE(mem_ctx);
436 return err;
439 *secdescsize = ndr_size_security_descriptor(secdesc, 0);
440 TALLOC_FREE(mem_ctx);
442 *last_changed_time = 0;
444 return WERR_OK;
447 WERROR reg_createkey(TALLOC_CTX *ctx, struct registry_key *parent,
448 const char *subkeypath, uint32 desired_access,
449 struct registry_key **pkey,
450 enum winreg_CreateAction *paction)
452 struct registry_key *key = parent;
453 struct registry_key *create_parent;
454 TALLOC_CTX *mem_ctx;
455 char *path, *end;
456 WERROR err;
458 if (!(mem_ctx = talloc_new(ctx))) return WERR_NOMEM;
460 if (!(path = talloc_strdup(mem_ctx, subkeypath))) {
461 err = WERR_NOMEM;
462 goto done;
465 while ((end = strchr(path, '\\')) != NULL) {
466 struct registry_key *tmp;
467 enum winreg_CreateAction action;
469 *end = '\0';
471 err = reg_createkey(mem_ctx, key, path,
472 SEC_RIGHTS_ENUM_SUBKEYS, &tmp, &action);
473 if (!W_ERROR_IS_OK(err)) {
474 goto done;
477 if (key != parent) {
478 TALLOC_FREE(key);
481 key = tmp;
482 path = end+1;
486 * At this point, "path" contains the one-element subkey of "key". We
487 * can try to open it.
490 err = reg_openkey(ctx, key, path, desired_access, pkey);
491 if (W_ERROR_IS_OK(err)) {
492 if (paction != NULL) {
493 *paction = REG_OPENED_EXISTING_KEY;
495 goto done;
498 if (!W_ERROR_EQUAL(err, WERR_BADFILE)) {
500 * Something but "notfound" has happened, so bail out
502 goto done;
506 * We have to make a copy of the current key, as we opened it only
507 * with ENUM_SUBKEY access.
510 err = reg_openkey(mem_ctx, key, "", SEC_RIGHTS_CREATE_SUBKEY,
511 &create_parent);
512 if (!W_ERROR_IS_OK(err)) {
513 goto done;
517 * Actually create the subkey
520 err = fill_subkey_cache(create_parent);
521 if (!W_ERROR_IS_OK(err)) goto done;
523 err = regsubkey_ctr_addkey(create_parent->subkeys, path);
524 if (!W_ERROR_IS_OK(err)) goto done;
526 if (!store_reg_keys(create_parent->key, create_parent->subkeys)) {
527 TALLOC_FREE(create_parent->subkeys);
528 err = WERR_REG_IO_FAILURE;
529 goto done;
533 * Now open the newly created key
536 err = reg_openkey(ctx, create_parent, path, desired_access, pkey);
537 if (W_ERROR_IS_OK(err) && (paction != NULL)) {
538 *paction = REG_CREATED_NEW_KEY;
541 done:
542 TALLOC_FREE(mem_ctx);
543 return err;
546 WERROR reg_deletekey(struct registry_key *parent, const char *path)
548 WERROR err;
549 TALLOC_CTX *mem_ctx;
550 char *name, *end;
551 int num_subkeys;
552 struct registry_key *tmp_key, *key;
554 if (!(mem_ctx = talloc_init("reg_createkey"))) return WERR_NOMEM;
556 if (!(name = talloc_strdup(mem_ctx, path))) {
557 err = WERR_NOMEM;
558 goto error;
561 /* check if the key has subkeys */
562 err = reg_openkey(mem_ctx, parent, name, REG_KEY_READ, &key);
563 if (!W_ERROR_IS_OK(err)) {
564 goto error;
566 if (!W_ERROR_IS_OK(err = fill_subkey_cache(key))) {
567 goto error;
569 if (key->subkeys->num_subkeys > 0) {
570 err = WERR_ACCESS_DENIED;
571 goto error;
574 /* no subkeys - proceed with delete */
575 if ((end = strrchr(name, '\\')) != NULL) {
576 *end = '\0';
578 err = reg_openkey(mem_ctx, parent, name,
579 SEC_RIGHTS_CREATE_SUBKEY, &tmp_key);
580 if (!W_ERROR_IS_OK(err)) {
581 goto error;
584 parent = tmp_key;
585 name = end+1;
588 if (name[0] == '\0') {
589 err = WERR_INVALID_PARAM;
590 goto error;
593 if (!W_ERROR_IS_OK(err = fill_subkey_cache(parent))) {
594 goto error;
597 num_subkeys = parent->subkeys->num_subkeys;
599 if (regsubkey_ctr_delkey(parent->subkeys, name) == num_subkeys) {
600 err = WERR_BADFILE;
601 goto error;
604 if (!store_reg_keys(parent->key, parent->subkeys)) {
605 TALLOC_FREE(parent->subkeys);
606 err = WERR_REG_IO_FAILURE;
607 goto error;
610 regkey_set_secdesc(key->key, NULL);
612 err = WERR_OK;
614 error:
615 TALLOC_FREE(mem_ctx);
616 return err;
619 WERROR reg_setvalue(struct registry_key *key, const char *name,
620 const struct registry_value *val)
622 WERROR err;
623 DATA_BLOB value_data;
624 int res;
626 if (!(key->key->access_granted & SEC_RIGHTS_SET_VALUE)) {
627 return WERR_ACCESS_DENIED;
630 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
631 return err;
634 err = registry_push_value(key, val, &value_data);
635 if (!W_ERROR_IS_OK(err)) {
636 return err;
639 res = regval_ctr_addvalue(key->values, name, val->type,
640 (char *)value_data.data, value_data.length);
641 TALLOC_FREE(value_data.data);
643 if (res == 0) {
644 TALLOC_FREE(key->values);
645 return WERR_NOMEM;
648 if (!store_reg_values(key->key, key->values)) {
649 TALLOC_FREE(key->values);
650 return WERR_REG_IO_FAILURE;
653 return WERR_OK;
656 static WERROR reg_value_exists(struct registry_key *key, const char *name)
658 int i;
660 for (i=0; i<key->values->num_values; i++) {
661 if (strequal(key->values->values[i]->valuename, name)) {
662 return WERR_OK;
666 return WERR_BADFILE;
669 WERROR reg_deletevalue(struct registry_key *key, const char *name)
671 WERROR err;
673 if (!(key->key->access_granted & SEC_RIGHTS_SET_VALUE)) {
674 return WERR_ACCESS_DENIED;
677 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
678 return err;
681 err = reg_value_exists(key, name);
682 if (!W_ERROR_IS_OK(err)) {
683 return err;
686 regval_ctr_delvalue(key->values, name);
688 if (!store_reg_values(key->key, key->values)) {
689 TALLOC_FREE(key->values);
690 return WERR_REG_IO_FAILURE;
693 return WERR_OK;
696 WERROR reg_getkeysecurity(TALLOC_CTX *mem_ctx, struct registry_key *key,
697 struct security_descriptor **psecdesc)
699 return regkey_get_secdesc(mem_ctx, key->key, psecdesc);
702 WERROR reg_setkeysecurity(struct registry_key *key,
703 struct security_descriptor *psecdesc)
705 return regkey_set_secdesc(key->key, psecdesc);
708 WERROR reg_getversion(uint32_t *version)
710 if (version == NULL) {
711 return WERR_INVALID_PARAM;
714 *version = 0x00000005; /* Windows 2000 registry API version */
715 return WERR_OK;
718 /*******************************************************************
719 Note: topkeypat is the *full* path that this *key will be
720 loaded into (including the name of the key)
721 ********************************************************************/
723 static WERROR reg_load_tree(REGF_FILE *regfile, const char *topkeypath,
724 REGF_NK_REC *key)
726 REGF_NK_REC *subkey;
727 REGISTRY_KEY registry_key;
728 REGVAL_CTR *values;
729 REGSUBKEY_CTR *subkeys;
730 int i;
731 char *path = NULL;
732 WERROR result = WERR_OK;
734 /* initialize the REGISTRY_KEY structure */
736 registry_key.ops = reghook_cache_find(topkeypath);
737 if (!registry_key.ops) {
738 DEBUG(0, ("reg_load_tree: Failed to assign REGISTRY_OPS "
739 "to [%s]\n", topkeypath));
740 return WERR_BADFILE;
743 registry_key.name = talloc_strdup(regfile->mem_ctx, topkeypath);
744 if (!registry_key.name) {
745 DEBUG(0, ("reg_load_tree: Talloc failed for reg_key.name!\n"));
746 return WERR_NOMEM;
749 /* now start parsing the values and subkeys */
751 subkeys = TALLOC_ZERO_P(regfile->mem_ctx, REGSUBKEY_CTR);
752 if (subkeys == NULL) {
753 return WERR_NOMEM;
756 values = TALLOC_ZERO_P(subkeys, REGVAL_CTR);
757 if (values == NULL) {
758 return WERR_NOMEM;
761 /* copy values into the REGVAL_CTR */
763 for (i=0; i<key->num_values; i++) {
764 regval_ctr_addvalue(values, key->values[i].valuename,
765 key->values[i].type,
766 (char*)key->values[i].data,
767 (key->values[i].data_size & ~VK_DATA_IN_OFFSET));
770 /* copy subkeys into the REGSUBKEY_CTR */
772 key->subkey_index = 0;
773 while ((subkey = regfio_fetch_subkey( regfile, key ))) {
774 result = regsubkey_ctr_addkey(subkeys, subkey->keyname);
775 if (!W_ERROR_IS_OK(result)) {
776 TALLOC_FREE(subkeys);
777 return result;
781 /* write this key and values out */
783 if (!store_reg_values(&registry_key, values)
784 || !store_reg_keys(&registry_key, subkeys))
786 DEBUG(0,("reg_load_tree: Failed to load %s!\n", topkeypath));
787 result = WERR_REG_IO_FAILURE;
790 TALLOC_FREE(subkeys);
792 if (!W_ERROR_IS_OK(result)) {
793 return result;
796 /* now continue to load each subkey registry tree */
798 key->subkey_index = 0;
799 while ((subkey = regfio_fetch_subkey(regfile, key))) {
800 path = talloc_asprintf(regfile->mem_ctx,
801 "%s\\%s",
802 topkeypath,
803 subkey->keyname);
804 if (path == NULL) {
805 return WERR_NOMEM;
807 result = reg_load_tree(regfile, path, subkey);
808 if (!W_ERROR_IS_OK(result)) {
809 break;
813 return result;
816 /*******************************************************************
817 ********************************************************************/
819 static WERROR restore_registry_key(REGISTRY_KEY *krecord, const char *fname)
821 REGF_FILE *regfile;
822 REGF_NK_REC *rootkey;
823 WERROR result;
825 /* open the registry file....fail if the file already exists */
827 regfile = regfio_open(fname, (O_RDONLY), 0);
828 if (regfile == NULL) {
829 DEBUG(0, ("restore_registry_key: failed to open \"%s\" (%s)\n",
830 fname, strerror(errno)));
831 return ntstatus_to_werror(map_nt_error_from_unix(errno));
834 /* get the rootkey from the regf file and then load the tree
835 via recursive calls */
837 if (!(rootkey = regfio_rootkey(regfile))) {
838 regfio_close(regfile);
839 return WERR_REG_FILE_INVALID;
842 result = reg_load_tree(regfile, krecord->name, rootkey);
844 /* cleanup */
846 regfio_close(regfile);
848 return result;
851 WERROR reg_restorekey(struct registry_key *key, const char *fname)
853 return restore_registry_key(key->key, fname);
856 /********************************************************************
857 ********************************************************************/
859 static WERROR reg_write_tree(REGF_FILE *regfile, const char *keypath,
860 REGF_NK_REC *parent)
862 REGF_NK_REC *key;
863 REGVAL_CTR *values;
864 REGSUBKEY_CTR *subkeys;
865 int i, num_subkeys;
866 char *key_tmp = NULL;
867 char *keyname, *parentpath;
868 char *subkeypath = NULL;
869 char *subkeyname;
870 REGISTRY_KEY registry_key;
871 WERROR result = WERR_OK;
872 SEC_DESC *sec_desc = NULL;
874 if (!regfile) {
875 return WERR_GENERAL_FAILURE;
878 if (!keypath) {
879 return WERR_OBJECT_PATH_INVALID;
882 /* split up the registry key path */
884 key_tmp = talloc_strdup(regfile->mem_ctx, keypath);
885 if (!key_tmp) {
886 return WERR_NOMEM;
888 if (!reg_split_key(key_tmp, &parentpath, &keyname)) {
889 return WERR_OBJECT_PATH_INVALID;
892 if (!keyname) {
893 keyname = parentpath;
896 /* we need a REGISTRY_KEY object here to enumerate subkeys and values */
898 ZERO_STRUCT(registry_key);
900 registry_key.name = talloc_strdup(regfile->mem_ctx, keypath);
901 if (registry_key.name == NULL) {
902 return WERR_NOMEM;
905 registry_key.ops = reghook_cache_find(registry_key.name);
906 if (registry_key.ops == NULL) {
907 return WERR_BADFILE;
910 /* lookup the values and subkeys */
912 subkeys = TALLOC_ZERO_P(regfile->mem_ctx, REGSUBKEY_CTR);
913 if (subkeys == NULL) {
914 return WERR_NOMEM;
917 values = TALLOC_ZERO_P(subkeys, REGVAL_CTR);
918 if (values == NULL) {
919 return WERR_NOMEM;
922 fetch_reg_keys(&registry_key, subkeys);
923 fetch_reg_values(&registry_key, values);
925 result = regkey_get_secdesc(regfile->mem_ctx, &registry_key, &sec_desc);
926 if (!W_ERROR_IS_OK(result)) {
927 goto done;
930 /* write out this key */
932 key = regfio_write_key(regfile, keyname, values, subkeys, sec_desc,
933 parent);
934 if (key == NULL) {
935 result = WERR_CAN_NOT_COMPLETE;
936 goto done;
939 /* write each one of the subkeys out */
941 num_subkeys = regsubkey_ctr_numkeys(subkeys);
942 for (i=0; i<num_subkeys; i++) {
943 subkeyname = regsubkey_ctr_specific_key(subkeys, i);
944 subkeypath = talloc_asprintf(regfile->mem_ctx, "%s\\%s",
945 keypath, subkeyname);
946 if (subkeypath == NULL) {
947 result = WERR_NOMEM;
948 goto done;
950 result = reg_write_tree(regfile, subkeypath, key);
951 if (!W_ERROR_IS_OK(result))
952 goto done;
955 DEBUG(6, ("reg_write_tree: wrote key [%s]\n", keypath));
957 done:
958 TALLOC_FREE(subkeys);
959 TALLOC_FREE(registry_key.name);
961 return result;
964 static WERROR backup_registry_key(REGISTRY_KEY *krecord, const char *fname)
966 REGF_FILE *regfile;
967 WERROR result;
969 /* open the registry file....fail if the file already exists */
971 regfile = regfio_open(fname, (O_RDWR|O_CREAT|O_EXCL),
972 (S_IREAD|S_IWRITE));
973 if (regfile == NULL) {
974 DEBUG(0,("backup_registry_key: failed to open \"%s\" (%s)\n",
975 fname, strerror(errno) ));
976 return ntstatus_to_werror(map_nt_error_from_unix(errno));
979 /* write the registry tree to the file */
981 result = reg_write_tree(regfile, krecord->name, NULL);
983 /* cleanup */
985 regfio_close(regfile);
987 return result;
990 WERROR reg_savekey(struct registry_key *key, const char *fname)
992 return backup_registry_key(key->key, fname);
995 /**********************************************************************
996 * Higher level utility functions
997 **********************************************************************/
999 WERROR reg_deleteallvalues(struct registry_key *key)
1001 WERROR err;
1002 int i;
1004 if (!(key->key->access_granted & SEC_RIGHTS_SET_VALUE)) {
1005 return WERR_ACCESS_DENIED;
1008 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
1009 return err;
1012 for (i=0; i<key->values->num_values; i++) {
1013 regval_ctr_delvalue(key->values, key->values->values[i]->valuename);
1016 if (!store_reg_values(key->key, key->values)) {
1017 TALLOC_FREE(key->values);
1018 return WERR_REG_IO_FAILURE;
1021 return WERR_OK;
1025 * Utility function to open a complete registry path including the hive prefix.
1028 WERROR reg_open_path(TALLOC_CTX *mem_ctx, const char *orig_path,
1029 uint32 desired_access, const struct nt_user_token *token,
1030 struct registry_key **pkey)
1032 struct registry_key *hive, *key;
1033 char *path, *p;
1034 WERROR err;
1036 if (!(path = SMB_STRDUP(orig_path))) {
1037 return WERR_NOMEM;
1040 p = strchr(path, '\\');
1042 if ((p == NULL) || (p[1] == '\0')) {
1044 * No key behind the hive, just return the hive
1047 err = reg_openhive(mem_ctx, path, desired_access, token,
1048 &hive);
1049 if (!W_ERROR_IS_OK(err)) {
1050 SAFE_FREE(path);
1051 return err;
1053 SAFE_FREE(path);
1054 *pkey = hive;
1055 return WERR_OK;
1058 *p = '\0';
1060 err = reg_openhive(mem_ctx, path, SEC_RIGHTS_ENUM_SUBKEYS, token,
1061 &hive);
1062 if (!W_ERROR_IS_OK(err)) {
1063 SAFE_FREE(path);
1064 return err;
1067 err = reg_openkey(mem_ctx, hive, p+1, desired_access, &key);
1069 TALLOC_FREE(hive);
1070 SAFE_FREE(path);
1072 if (!W_ERROR_IS_OK(err)) {
1073 return err;
1076 *pkey = key;
1077 return WERR_OK;
1081 * Utility function to delete a registry key with all its subkeys.
1082 * Note that reg_deletekey returns ACCESS_DENIED when called on a
1083 * key that has subkeys.
1085 static WERROR reg_deletekey_recursive_internal(TALLOC_CTX *ctx,
1086 struct registry_key *parent,
1087 const char *path,
1088 bool del_key)
1090 TALLOC_CTX *mem_ctx = NULL;
1091 WERROR werr = WERR_OK;
1092 struct registry_key *key;
1093 char *subkey_name = NULL;
1095 mem_ctx = talloc_new(ctx);
1096 if (mem_ctx == NULL) {
1097 werr = WERR_NOMEM;
1098 goto done;
1101 /* recurse through subkeys first */
1102 werr = reg_openkey(mem_ctx, parent, path, REG_KEY_ALL, &key);
1103 if (!W_ERROR_IS_OK(werr)) {
1104 goto done;
1107 while (W_ERROR_IS_OK(werr = reg_enumkey(mem_ctx, key, 0,
1108 &subkey_name, NULL)))
1110 werr = reg_deletekey_recursive_internal(mem_ctx, key,
1111 subkey_name,
1112 true);
1113 if (!W_ERROR_IS_OK(werr)) {
1114 goto done;
1117 if (!W_ERROR_EQUAL(WERR_NO_MORE_ITEMS, werr)) {
1118 DEBUG(1, ("reg_deletekey_recursive_internal: "
1119 "Error enumerating subkeys: %s\n",
1120 dos_errstr(werr)));
1121 goto done;
1124 werr = WERR_OK;
1126 if (del_key) {
1127 /* now delete the actual key */
1128 werr = reg_deletekey(parent, path);
1131 done:
1132 TALLOC_FREE(mem_ctx);
1133 return werr;
1136 WERROR reg_deletekey_recursive(TALLOC_CTX *ctx,
1137 struct registry_key *parent,
1138 const char *path)
1140 return reg_deletekey_recursive_internal(ctx, parent, path, true);
1143 WERROR reg_deletesubkeys_recursive(TALLOC_CTX *ctx,
1144 struct registry_key *parent,
1145 const char *path)
1147 return reg_deletekey_recursive_internal(ctx, parent, path, false);
1150 #if 0
1151 /* these two functions are unused. */
1154 * Utility function to create a registry key without opening the hive
1155 * before. Assumes the hive already exists.
1158 WERROR reg_create_path(TALLOC_CTX *mem_ctx, const char *orig_path,
1159 uint32 desired_access,
1160 const struct nt_user_token *token,
1161 enum winreg_CreateAction *paction,
1162 struct registry_key **pkey)
1164 struct registry_key *hive;
1165 char *path, *p;
1166 WERROR err;
1168 if (!(path = SMB_STRDUP(orig_path))) {
1169 return WERR_NOMEM;
1172 p = strchr(path, '\\');
1174 if ((p == NULL) || (p[1] == '\0')) {
1176 * No key behind the hive, just return the hive
1179 err = reg_openhive(mem_ctx, path, desired_access, token,
1180 &hive);
1181 if (!W_ERROR_IS_OK(err)) {
1182 SAFE_FREE(path);
1183 return err;
1185 SAFE_FREE(path);
1186 *pkey = hive;
1187 *paction = REG_OPENED_EXISTING_KEY;
1188 return WERR_OK;
1191 *p = '\0';
1193 err = reg_openhive(mem_ctx, path,
1194 (strchr(p+1, '\\') != NULL) ?
1195 SEC_RIGHTS_ENUM_SUBKEYS : SEC_RIGHTS_CREATE_SUBKEY,
1196 token, &hive);
1197 if (!W_ERROR_IS_OK(err)) {
1198 SAFE_FREE(path);
1199 return err;
1202 err = reg_createkey(mem_ctx, hive, p+1, desired_access, pkey, paction);
1203 SAFE_FREE(path);
1204 TALLOC_FREE(hive);
1205 return err;
1209 * Utility function to create a registry key without opening the hive
1210 * before. Will not delete a hive.
1213 WERROR reg_delete_path(const struct nt_user_token *token,
1214 const char *orig_path)
1216 struct registry_key *hive;
1217 char *path, *p;
1218 WERROR err;
1220 if (!(path = SMB_STRDUP(orig_path))) {
1221 return WERR_NOMEM;
1224 p = strchr(path, '\\');
1226 if ((p == NULL) || (p[1] == '\0')) {
1227 SAFE_FREE(path);
1228 return WERR_INVALID_PARAM;
1231 *p = '\0';
1233 err = reg_openhive(NULL, path,
1234 (strchr(p+1, '\\') != NULL) ?
1235 SEC_RIGHTS_ENUM_SUBKEYS : SEC_RIGHTS_CREATE_SUBKEY,
1236 token, &hive);
1237 if (!W_ERROR_IS_OK(err)) {
1238 SAFE_FREE(path);
1239 return err;
1242 err = reg_deletekey(hive, p+1);
1243 SAFE_FREE(path);
1244 TALLOC_FREE(hive);
1245 return err;
1247 #endif /* #if 0 */