2 * Unix SMB/CIFS implementation.
3 * Virtual Windows Registry Layer
4 * Copyright (C) Volker Lendecke 2006
5 * Copyright (C) Michael Adam 2007-2010
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
27 * 0x00 winreg_OpenHKCR
28 * 0x01 winreg_OpenHKCU
29 * 0x02 winreg_OpenHKLM
30 * 0x03 winreg_OpenHKPD
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
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 reg_querymultiplevalues
57 * 0x1e winreg_InitiateSystemShutdownEx
58 * 0x1f winreg_SaveKeyEx
59 * 0x20 winreg_OpenHKPT
60 * 0x21 winreg_OpenHKPN
61 * 0x22 winreg_QueryMultipleValues2 reg_querymultiplevalues
68 #include "reg_cachehook.h"
69 #include "reg_backend_db.h"
70 #include "reg_dispatcher.h"
71 #include "reg_objects.h"
72 #include "../librpc/gen_ndr/ndr_security.h"
75 #define DBGC_CLASS DBGC_REGISTRY
78 /**********************************************************************
80 **********************************************************************/
82 static WERROR fill_value_cache(struct registry_key *key)
86 if (key->values != NULL) {
87 if (!reg_values_need_update(key->key, key->values)) {
92 TALLOC_FREE(key->values);
93 werr = regval_ctr_init(key, &(key->values));
94 W_ERROR_NOT_OK_RETURN(werr);
96 if (fetch_reg_values(key->key, key->values) == -1) {
97 TALLOC_FREE(key->values);
104 static WERROR fill_subkey_cache(struct registry_key *key)
108 if (key->subkeys != NULL) {
109 if (!reg_subkeys_need_update(key->key, key->subkeys)) {
114 TALLOC_FREE(key->subkeys);
115 werr = regsubkey_ctr_init(key, &(key->subkeys));
116 W_ERROR_NOT_OK_RETURN(werr);
118 if (fetch_reg_keys(key->key, key->subkeys) == -1) {
119 TALLOC_FREE(key->subkeys);
120 return WERR_NO_MORE_ITEMS;
126 static int regkey_destructor(struct registry_key_handle *key)
128 return regdb_close();
131 static WERROR regkey_open_onelevel(TALLOC_CTX *mem_ctx,
132 struct registry_key *parent,
134 const struct security_token *token,
135 uint32 access_desired,
136 struct registry_key **pregkey)
138 WERROR result = WERR_OK;
139 struct registry_key *regkey;
140 struct registry_key_handle *key;
141 struct regsubkey_ctr *subkeys = NULL;
143 DEBUG(7,("regkey_open_onelevel: name = [%s]\n", name));
145 SMB_ASSERT(strchr(name, '\\') == NULL);
147 if (!(regkey = talloc_zero(mem_ctx, struct registry_key)) ||
148 !(regkey->token = dup_nt_token(regkey, token)) ||
149 !(regkey->key = talloc_zero(regkey, struct registry_key_handle)))
155 if ( !(W_ERROR_IS_OK(result = regdb_open())) ) {
160 talloc_set_destructor(key, regkey_destructor);
164 key->type = REG_KEY_GENERIC;
166 if (name[0] == '\0') {
168 * Open a copy of the parent key
171 result = WERR_BADFILE;
174 key->name = talloc_strdup(key, parent->key->name);
180 key->name = talloc_asprintf(key, "%s%s%s",
181 parent ? parent->key->name : "",
186 if (key->name == NULL) {
191 /* Tag this as a Performance Counter Key */
193 if( strncasecmp_m(key->name, KEY_HKPD, strlen(KEY_HKPD)) == 0 )
194 key->type = REG_KEY_HKPD;
196 /* Look up the table of registry I/O operations */
198 if ( !(key->ops = reghook_cache_find( key->name )) ) {
199 DEBUG(0,("reg_open_onelevel: Failed to assign "
200 "registry_ops to [%s]\n", key->name ));
201 result = WERR_BADFILE;
205 /* check if the path really exists; failed is indicated by -1 */
206 /* if the subkey count failed, bail out */
208 result = regsubkey_ctr_init(key, &subkeys);
209 if (!W_ERROR_IS_OK(result)) {
213 if ( fetch_reg_keys( key, subkeys ) == -1 ) {
214 result = WERR_BADFILE;
218 TALLOC_FREE( subkeys );
220 if ( !regkey_access_check( key, access_desired, &key->access_granted,
222 result = WERR_ACCESS_DENIED;
230 if ( !W_ERROR_IS_OK(result) ) {
237 WERROR reg_openhive(TALLOC_CTX *mem_ctx, const char *hive,
238 uint32 desired_access,
239 const struct security_token *token,
240 struct registry_key **pkey)
242 SMB_ASSERT(hive != NULL);
243 SMB_ASSERT(hive[0] != '\0');
244 SMB_ASSERT(strchr(hive, '\\') == NULL);
246 return regkey_open_onelevel(mem_ctx, NULL, hive, token, desired_access,
251 /**********************************************************************
253 **********************************************************************/
255 WERROR reg_openkey(TALLOC_CTX *mem_ctx, struct registry_key *parent,
256 const char *name, uint32 desired_access,
257 struct registry_key **pkey)
259 struct registry_key *direct_parent = parent;
261 char *p, *path, *to_free;
264 if (!(path = SMB_STRDUP(name))) {
271 if ((len > 0) && (path[len-1] == '\\')) {
275 while ((p = strchr(path, '\\')) != NULL) {
276 char *name_component;
277 struct registry_key *tmp;
279 if (!(name_component = SMB_STRNDUP(path, (p - path)))) {
284 err = regkey_open_onelevel(mem_ctx, direct_parent,
285 name_component, parent->token,
286 KEY_ENUMERATE_SUB_KEYS, &tmp);
287 SAFE_FREE(name_component);
289 if (!W_ERROR_IS_OK(err)) {
292 if (direct_parent != parent) {
293 TALLOC_FREE(direct_parent);
300 err = regkey_open_onelevel(mem_ctx, direct_parent, path, parent->token,
301 desired_access, pkey);
303 if (direct_parent != parent) {
304 TALLOC_FREE(direct_parent);
310 WERROR reg_enumkey(TALLOC_CTX *mem_ctx, struct registry_key *key,
311 uint32 idx, char **name, NTTIME *last_write_time)
315 if (!(key->key->access_granted & KEY_ENUMERATE_SUB_KEYS)) {
316 return WERR_ACCESS_DENIED;
319 if (!W_ERROR_IS_OK(err = fill_subkey_cache(key))) {
323 if (idx >= regsubkey_ctr_numkeys(key->subkeys)) {
324 return WERR_NO_MORE_ITEMS;
327 if (!(*name = talloc_strdup(mem_ctx,
328 regsubkey_ctr_specific_key(key->subkeys, idx))))
333 if (last_write_time) {
334 *last_write_time = 0;
340 WERROR reg_enumvalue(TALLOC_CTX *mem_ctx, struct registry_key *key,
341 uint32 idx, char **pname, struct registry_value **pval)
343 struct registry_value *val;
344 struct regval_blob *blob;
347 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
348 return WERR_ACCESS_DENIED;
351 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
355 if (idx >= regval_ctr_numvals(key->values)) {
356 return WERR_NO_MORE_ITEMS;
359 blob = regval_ctr_specific_value(key->values, idx);
361 val = talloc_zero(mem_ctx, struct registry_value);
366 val->type = regval_type(blob);
367 val->data = data_blob_talloc(mem_ctx, regval_data_p(blob), regval_size(blob));
370 && !(*pname = talloc_strdup(
371 mem_ctx, regval_name(blob)))) {
380 static WERROR reg_enumvalue_nocachefill(TALLOC_CTX *mem_ctx,
381 struct registry_key *key,
382 uint32 idx, char **pname,
383 struct registry_value **pval)
385 struct registry_value *val;
386 struct regval_blob *blob;
388 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
389 return WERR_ACCESS_DENIED;
392 if (idx >= regval_ctr_numvals(key->values)) {
393 return WERR_NO_MORE_ITEMS;
396 blob = regval_ctr_specific_value(key->values, idx);
398 val = talloc_zero(mem_ctx, struct registry_value);
403 val->type = regval_type(blob);
404 val->data = data_blob_talloc(mem_ctx, regval_data_p(blob), regval_size(blob));
407 && !(*pname = talloc_strdup(
408 mem_ctx, regval_name(blob)))) {
417 WERROR reg_queryvalue(TALLOC_CTX *mem_ctx, struct registry_key *key,
418 const char *name, struct registry_value **pval)
423 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
424 return WERR_ACCESS_DENIED;
427 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
431 for (i=0; i < regval_ctr_numvals(key->values); i++) {
432 struct regval_blob *blob;
433 blob = regval_ctr_specific_value(key->values, i);
434 if (strequal(regval_name(blob), name)) {
436 * don't use reg_enumvalue here:
437 * re-reading the values from the disk
438 * would change the indexing and break
441 return reg_enumvalue_nocachefill(mem_ctx, key, i,
449 WERROR reg_querymultiplevalues(TALLOC_CTX *mem_ctx,
450 struct registry_key *key,
454 struct registry_value **pvals)
457 uint32_t i, n, found = 0;
458 struct registry_value *vals;
460 if (num_names == 0) {
464 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
465 return WERR_ACCESS_DENIED;
468 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
472 vals = talloc_zero_array(mem_ctx, struct registry_value, num_names);
477 for (n=0; n < num_names; n++) {
478 for (i=0; i < regval_ctr_numvals(key->values); i++) {
479 struct regval_blob *blob;
480 blob = regval_ctr_specific_value(key->values, i);
481 if (strequal(regval_name(blob), names[n])) {
482 struct registry_value *v;
483 err = reg_enumvalue(mem_ctx, key, i, NULL, &v);
484 if (!W_ERROR_IS_OK(err)) {
499 WERROR reg_queryinfokey(struct registry_key *key, uint32_t *num_subkeys,
500 uint32_t *max_subkeylen, uint32_t *max_subkeysize,
501 uint32_t *num_values, uint32_t *max_valnamelen,
502 uint32_t *max_valbufsize, uint32_t *secdescsize,
503 NTTIME *last_changed_time)
509 struct security_descriptor *secdesc;
511 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
512 return WERR_ACCESS_DENIED;
515 if (!W_ERROR_IS_OK(fill_subkey_cache(key)) ||
516 !W_ERROR_IS_OK(fill_value_cache(key))) {
521 for (i=0; i< regsubkey_ctr_numkeys(key->subkeys); i++) {
522 max_len = MAX(max_len,
523 strlen(regsubkey_ctr_specific_key(key->subkeys, i)));
526 *num_subkeys = regsubkey_ctr_numkeys(key->subkeys);
527 *max_subkeylen = max_len;
528 *max_subkeysize = 0; /* Class length? */
532 for (i=0; i < regval_ctr_numvals(key->values); i++) {
533 struct regval_blob *blob;
534 blob = regval_ctr_specific_value(key->values, i);
535 max_len = MAX(max_len, strlen(regval_name(blob)));
536 max_size = MAX(max_size, regval_size(blob));
539 *num_values = regval_ctr_numvals(key->values);
540 *max_valnamelen = max_len;
541 *max_valbufsize = max_size;
543 if (!(mem_ctx = talloc_new(key))) {
547 err = regkey_get_secdesc(mem_ctx, key->key, &secdesc);
548 if (!W_ERROR_IS_OK(err)) {
549 TALLOC_FREE(mem_ctx);
553 *secdescsize = ndr_size_security_descriptor(secdesc, 0);
554 TALLOC_FREE(mem_ctx);
556 *last_changed_time = 0;
561 WERROR reg_createkey(TALLOC_CTX *ctx, struct registry_key *parent,
562 const char *subkeypath, uint32 desired_access,
563 struct registry_key **pkey,
564 enum winreg_CreateAction *paction)
566 struct registry_key *key = parent;
567 struct registry_key *create_parent;
572 if (!(mem_ctx = talloc_new(ctx))) return WERR_NOMEM;
574 if (!(path = talloc_strdup(mem_ctx, subkeypath))) {
579 while ((end = strchr(path, '\\')) != NULL) {
580 struct registry_key *tmp;
581 enum winreg_CreateAction action;
585 err = reg_createkey(mem_ctx, key, path,
586 KEY_ENUMERATE_SUB_KEYS, &tmp, &action);
587 if (!W_ERROR_IS_OK(err)) {
600 * At this point, "path" contains the one-element subkey of "key". We
601 * can try to open it.
604 err = reg_openkey(ctx, key, path, desired_access, pkey);
605 if (W_ERROR_IS_OK(err)) {
606 if (paction != NULL) {
607 *paction = REG_OPENED_EXISTING_KEY;
612 if (!W_ERROR_EQUAL(err, WERR_BADFILE)) {
614 * Something but "notfound" has happened, so bail out
620 * We have to make a copy of the current key, as we opened it only
621 * with ENUM_SUBKEY access.
624 err = reg_openkey(mem_ctx, key, "", KEY_CREATE_SUB_KEY,
626 if (!W_ERROR_IS_OK(err)) {
631 * Actually create the subkey
634 err = fill_subkey_cache(create_parent);
635 if (!W_ERROR_IS_OK(err)) goto done;
637 err = create_reg_subkey(key->key, path);
638 W_ERROR_NOT_OK_GOTO_DONE(err);
641 * Now open the newly created key
644 err = reg_openkey(ctx, create_parent, path, desired_access, pkey);
645 if (W_ERROR_IS_OK(err) && (paction != NULL)) {
646 *paction = REG_CREATED_NEW_KEY;
650 TALLOC_FREE(mem_ctx);
654 static WERROR reg_deletekey_internal(TALLOC_CTX *mem_ctx,
655 struct registry_key *parent,
656 const char *path, bool lazy)
660 struct registry_key *key;
661 name = talloc_strdup(mem_ctx, path);
667 /* no subkeys - proceed with delete */
668 end = strrchr(name, '\\');
672 err = reg_openkey(mem_ctx, parent, name,
673 KEY_CREATE_SUB_KEY, &key);
674 W_ERROR_NOT_OK_GOTO_DONE(err);
680 if (name[0] == '\0') {
681 err = WERR_INVALID_PARAM;
685 err = delete_reg_subkey(parent->key, name, lazy);
691 WERROR reg_deletekey(struct registry_key *parent, const char *path)
694 struct registry_key *key;
695 TALLOC_CTX *mem_ctx = talloc_stackframe();
697 /* check if the key has subkeys */
698 err = reg_openkey(mem_ctx, parent, path, REG_KEY_READ, &key);
699 W_ERROR_NOT_OK_GOTO_DONE(err);
701 err = fill_subkey_cache(key);
702 W_ERROR_NOT_OK_GOTO_DONE(err);
704 if (regsubkey_ctr_numkeys(key->subkeys) > 0) {
705 err = WERR_ACCESS_DENIED;
708 err = reg_deletekey_internal(mem_ctx, parent, path, false);
710 TALLOC_FREE(mem_ctx);
715 WERROR reg_setvalue(struct registry_key *key, const char *name,
716 const struct registry_value *val)
718 struct regval_blob *existing;
722 if (!(key->key->access_granted & KEY_SET_VALUE)) {
723 return WERR_ACCESS_DENIED;
726 err = regdb_transaction_start();
727 if (!W_ERROR_IS_OK(err)) {
728 DEBUG(0, ("reg_setvalue: Failed to start transaction: %s\n",
733 err = fill_value_cache(key);
734 if (!W_ERROR_IS_OK(err)) {
735 DEBUG(0, ("reg_setvalue: Error filling value cache: %s\n", win_errstr(err)));
739 existing = regval_ctr_getvalue(key->values, name);
741 if ((existing != NULL) &&
742 (regval_size(existing) == val->data.length) &&
743 (memcmp(regval_data_p(existing), val->data.data,
744 val->data.length) == 0))
750 res = regval_ctr_addvalue(key->values, name, val->type,
751 val->data.data, val->data.length);
754 TALLOC_FREE(key->values);
759 if (!store_reg_values(key->key, key->values)) {
760 TALLOC_FREE(key->values);
761 DEBUG(0, ("reg_setvalue: store_reg_values failed\n"));
762 err = WERR_REG_IO_FAILURE;
769 if (W_ERROR_IS_OK(err)) {
770 err = regdb_transaction_commit();
771 if (!W_ERROR_IS_OK(err)) {
772 DEBUG(0, ("reg_setvalue: Error committing transaction: %s\n", win_errstr(err)));
775 WERROR err1 = regdb_transaction_cancel();
776 if (!W_ERROR_IS_OK(err1)) {
777 DEBUG(0, ("reg_setvalue: Error cancelling transaction: %s\n", win_errstr(err1)));
784 static WERROR reg_value_exists(struct registry_key *key, const char *name)
786 struct regval_blob *blob;
788 blob = regval_ctr_getvalue(key->values, name);
797 WERROR reg_deletevalue(struct registry_key *key, const char *name)
801 if (!(key->key->access_granted & KEY_SET_VALUE)) {
802 return WERR_ACCESS_DENIED;
805 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
809 err = reg_value_exists(key, name);
810 if (!W_ERROR_IS_OK(err)) {
814 regval_ctr_delvalue(key->values, name);
816 if (!store_reg_values(key->key, key->values)) {
817 TALLOC_FREE(key->values);
818 return WERR_REG_IO_FAILURE;
824 WERROR reg_getkeysecurity(TALLOC_CTX *mem_ctx, struct registry_key *key,
825 struct security_descriptor **psecdesc)
827 return regkey_get_secdesc(mem_ctx, key->key, psecdesc);
830 WERROR reg_setkeysecurity(struct registry_key *key,
831 struct security_descriptor *psecdesc)
833 return regkey_set_secdesc(key->key, psecdesc);
836 WERROR reg_getversion(uint32_t *version)
838 if (version == NULL) {
839 return WERR_INVALID_PARAM;
842 *version = 0x00000005; /* Windows 2000 registry API version */
846 /**********************************************************************
847 * Higher level utility functions
848 **********************************************************************/
850 WERROR reg_deleteallvalues(struct registry_key *key)
855 if (!(key->key->access_granted & KEY_SET_VALUE)) {
856 return WERR_ACCESS_DENIED;
859 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
863 for (i=0; i < regval_ctr_numvals(key->values); i++) {
864 struct regval_blob *blob;
865 blob = regval_ctr_specific_value(key->values, i);
866 regval_ctr_delvalue(key->values, regval_name(blob));
869 if (!store_reg_values(key->key, key->values)) {
870 TALLOC_FREE(key->values);
871 return WERR_REG_IO_FAILURE;
878 * Utility function to delete a registry key with all its subkeys.
879 * Note that reg_deletekey returns ACCESS_DENIED when called on a
880 * key that has subkeys.
882 static WERROR reg_deletekey_recursive_internal(struct registry_key *parent,
884 bool del_key, bool lazy)
886 WERROR werr = WERR_OK;
887 struct registry_key *key;
888 char *subkey_name = NULL;
890 TALLOC_CTX *mem_ctx = talloc_stackframe();
892 DEBUG(5, ("reg_deletekey_recursive_internal: deleting '%s' from '%s'\n",
893 path, parent->key->name));
895 /* recurse through subkeys first */
896 werr = reg_openkey(mem_ctx, parent, path, REG_KEY_ALL, &key);
897 if (!W_ERROR_IS_OK(werr)) {
898 DEBUG(3, ("reg_deletekey_recursive_internal: error opening "
899 "subkey '%s' of '%s': '%s'\n",
900 path, parent->key->name, win_errstr(werr)));
904 werr = fill_subkey_cache(key);
905 W_ERROR_NOT_OK_GOTO_DONE(werr);
908 * loop from top to bottom for perfomance:
909 * this way, we need to rehash the regsubkey containers less
911 for (i = regsubkey_ctr_numkeys(key->subkeys) ; i > 0; i--) {
912 subkey_name = regsubkey_ctr_specific_key(key->subkeys, i-1);
913 werr = reg_deletekey_recursive_internal(key, subkey_name, true, del_key);
914 W_ERROR_NOT_OK_GOTO_DONE(werr);
918 /* now delete the actual key */
919 werr = reg_deletekey_internal(mem_ctx, parent, path, lazy);
924 DEBUG(5, ("reg_deletekey_recursive_internal: done deleting '%s' from "
926 path, parent->key->name, win_errstr(werr)));
927 TALLOC_FREE(mem_ctx);
931 static WERROR reg_deletekey_recursive_trans(struct registry_key *parent,
937 werr = regdb_transaction_start();
938 if (!W_ERROR_IS_OK(werr)) {
939 DEBUG(0, ("reg_deletekey_recursive_trans: "
940 "error starting transaction: %s\n",
945 werr = reg_deletekey_recursive_internal(parent, path, del_key, false);
947 if (!W_ERROR_IS_OK(werr)) {
950 DEBUG(1, (__location__ " failed to delete key '%s' from key "
951 "'%s': %s\n", path, parent->key->name,
954 werr2 = regdb_transaction_cancel();
955 if (!W_ERROR_IS_OK(werr2)) {
956 DEBUG(0, ("reg_deletekey_recursive_trans: "
957 "error cancelling transaction: %s\n",
960 * return the original werr or the
961 * error from cancelling the transaction?
965 werr = regdb_transaction_commit();
966 if (!W_ERROR_IS_OK(werr)) {
967 DEBUG(0, ("reg_deletekey_recursive_trans: "
968 "error committing transaction: %s\n",
971 DEBUG(5, ("reg_reletekey_recursive_trans: deleted key '%s' from '%s'\n",
972 path, parent->key->name));
980 WERROR reg_deletekey_recursive(struct registry_key *parent,
983 return reg_deletekey_recursive_trans(parent, path, true);
986 WERROR reg_deletesubkeys_recursive(struct registry_key *parent,
989 return reg_deletekey_recursive_trans(parent, path, false);