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_util_internal.h"
70 #include "reg_backend_db.h"
71 #include "reg_dispatcher.h"
72 #include "reg_objects.h"
73 #include "../librpc/gen_ndr/ndr_security.h"
76 #define DBGC_CLASS DBGC_REGISTRY
79 /**********************************************************************
81 **********************************************************************/
83 static WERROR fill_value_cache(struct registry_key *key)
87 if (key->values != NULL) {
88 if (!reg_values_need_update(key->key, 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 werr = regsubkey_ctr_init(key, &(key->subkeys));
115 W_ERROR_NOT_OK_RETURN(werr);
117 if (fetch_reg_keys(key->key, key->subkeys) == -1) {
118 TALLOC_FREE(key->subkeys);
119 return WERR_NO_MORE_ITEMS;
125 static int regkey_destructor(struct registry_key_handle *key)
127 return regdb_close();
130 static WERROR regkey_open_onelevel(TALLOC_CTX *mem_ctx,
131 struct registry_key *parent,
133 const struct security_token *token,
134 uint32 access_desired,
135 struct registry_key **pregkey)
137 WERROR result = WERR_OK;
138 struct registry_key *regkey;
139 struct registry_key_handle *key;
140 struct regsubkey_ctr *subkeys = NULL;
142 DEBUG(7,("regkey_open_onelevel: name = [%s]\n", name));
144 SMB_ASSERT(strchr(name, '\\') == NULL);
146 if (!(regkey = TALLOC_ZERO_P(mem_ctx, struct registry_key)) ||
147 !(regkey->token = dup_nt_token(regkey, token)) ||
148 !(regkey->key = TALLOC_ZERO_P(regkey, struct registry_key_handle)))
154 if ( !(W_ERROR_IS_OK(result = regdb_open())) ) {
159 talloc_set_destructor(key, regkey_destructor);
163 key->type = REG_KEY_GENERIC;
165 if (name[0] == '\0') {
167 * Open a copy of the parent key
170 result = WERR_BADFILE;
173 key->name = talloc_strdup(key, parent->key->name);
179 key->name = talloc_asprintf(key, "%s%s%s",
180 parent ? parent->key->name : "",
185 if (key->name == NULL) {
190 /* Tag this as a Performance Counter Key */
192 if( StrnCaseCmp(key->name, KEY_HKPD, strlen(KEY_HKPD)) == 0 )
193 key->type = REG_KEY_HKPD;
195 /* Look up the table of registry I/O operations */
197 if ( !(key->ops = reghook_cache_find( key->name )) ) {
198 DEBUG(0,("reg_open_onelevel: Failed to assign "
199 "registry_ops to [%s]\n", key->name ));
200 result = WERR_BADFILE;
204 /* check if the path really exists; failed is indicated by -1 */
205 /* if the subkey count failed, bail out */
207 result = regsubkey_ctr_init(key, &subkeys);
208 if (!W_ERROR_IS_OK(result)) {
212 if ( fetch_reg_keys( key, subkeys ) == -1 ) {
213 result = WERR_BADFILE;
217 TALLOC_FREE( subkeys );
219 if ( !regkey_access_check( key, access_desired, &key->access_granted,
221 result = WERR_ACCESS_DENIED;
229 if ( !W_ERROR_IS_OK(result) ) {
236 WERROR reg_openhive(TALLOC_CTX *mem_ctx, const char *hive,
237 uint32 desired_access,
238 const struct security_token *token,
239 struct registry_key **pkey)
241 SMB_ASSERT(hive != NULL);
242 SMB_ASSERT(hive[0] != '\0');
243 SMB_ASSERT(strchr(hive, '\\') == NULL);
245 return regkey_open_onelevel(mem_ctx, NULL, hive, token, desired_access,
250 /**********************************************************************
252 **********************************************************************/
254 WERROR reg_openkey(TALLOC_CTX *mem_ctx, struct registry_key *parent,
255 const char *name, uint32 desired_access,
256 struct registry_key **pkey)
258 struct registry_key *direct_parent = parent;
260 char *p, *path, *to_free;
263 if (!(path = SMB_STRDUP(name))) {
270 if ((len > 0) && (path[len-1] == '\\')) {
274 while ((p = strchr(path, '\\')) != NULL) {
275 char *name_component;
276 struct registry_key *tmp;
278 if (!(name_component = SMB_STRNDUP(path, (p - path)))) {
283 err = regkey_open_onelevel(mem_ctx, direct_parent,
284 name_component, parent->token,
285 KEY_ENUMERATE_SUB_KEYS, &tmp);
286 SAFE_FREE(name_component);
288 if (!W_ERROR_IS_OK(err)) {
291 if (direct_parent != parent) {
292 TALLOC_FREE(direct_parent);
299 err = regkey_open_onelevel(mem_ctx, direct_parent, path, parent->token,
300 desired_access, pkey);
302 if (direct_parent != parent) {
303 TALLOC_FREE(direct_parent);
309 WERROR reg_enumkey(TALLOC_CTX *mem_ctx, struct registry_key *key,
310 uint32 idx, char **name, NTTIME *last_write_time)
314 if (!(key->key->access_granted & KEY_ENUMERATE_SUB_KEYS)) {
315 return WERR_ACCESS_DENIED;
318 if (!W_ERROR_IS_OK(err = fill_subkey_cache(key))) {
322 if (idx >= regsubkey_ctr_numkeys(key->subkeys)) {
323 return WERR_NO_MORE_ITEMS;
326 if (!(*name = talloc_strdup(mem_ctx,
327 regsubkey_ctr_specific_key(key->subkeys, idx))))
332 if (last_write_time) {
333 *last_write_time = 0;
339 WERROR reg_enumvalue(TALLOC_CTX *mem_ctx, struct registry_key *key,
340 uint32 idx, char **pname, struct registry_value **pval)
342 struct registry_value *val;
343 struct regval_blob *blob;
346 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
347 return WERR_ACCESS_DENIED;
350 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
354 if (idx >= regval_ctr_numvals(key->values)) {
355 return WERR_NO_MORE_ITEMS;
358 blob = regval_ctr_specific_value(key->values, idx);
360 val = talloc_zero(mem_ctx, struct registry_value);
365 val->type = regval_type(blob);
366 val->data = data_blob_talloc(mem_ctx, regval_data_p(blob), regval_size(blob));
369 && !(*pname = talloc_strdup(
370 mem_ctx, regval_name(blob)))) {
379 WERROR reg_queryvalue(TALLOC_CTX *mem_ctx, struct registry_key *key,
380 const char *name, struct registry_value **pval)
385 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
386 return WERR_ACCESS_DENIED;
389 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
393 for (i=0; i < regval_ctr_numvals(key->values); i++) {
394 struct regval_blob *blob;
395 blob = regval_ctr_specific_value(key->values, i);
396 if (strequal(regval_name(blob), name)) {
397 return reg_enumvalue(mem_ctx, key, i, NULL, pval);
404 WERROR reg_querymultiplevalues(TALLOC_CTX *mem_ctx,
405 struct registry_key *key,
409 struct registry_value **pvals)
412 uint32_t i, n, found = 0;
413 struct registry_value *vals;
415 if (num_names == 0) {
419 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
420 return WERR_ACCESS_DENIED;
423 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
427 vals = talloc_zero_array(mem_ctx, struct registry_value, num_names);
432 for (n=0; n < num_names; n++) {
433 for (i=0; i < regval_ctr_numvals(key->values); i++) {
434 struct regval_blob *blob;
435 blob = regval_ctr_specific_value(key->values, i);
436 if (strequal(regval_name(blob), names[n])) {
437 struct registry_value *v;
438 err = reg_enumvalue(mem_ctx, key, i, NULL, &v);
439 if (!W_ERROR_IS_OK(err)) {
454 WERROR reg_queryinfokey(struct registry_key *key, uint32_t *num_subkeys,
455 uint32_t *max_subkeylen, uint32_t *max_subkeysize,
456 uint32_t *num_values, uint32_t *max_valnamelen,
457 uint32_t *max_valbufsize, uint32_t *secdescsize,
458 NTTIME *last_changed_time)
464 struct security_descriptor *secdesc;
466 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
467 return WERR_ACCESS_DENIED;
470 if (!W_ERROR_IS_OK(fill_subkey_cache(key)) ||
471 !W_ERROR_IS_OK(fill_value_cache(key))) {
476 for (i=0; i< regsubkey_ctr_numkeys(key->subkeys); i++) {
477 max_len = MAX(max_len,
478 strlen(regsubkey_ctr_specific_key(key->subkeys, i)));
481 *num_subkeys = regsubkey_ctr_numkeys(key->subkeys);
482 *max_subkeylen = max_len;
483 *max_subkeysize = 0; /* Class length? */
487 for (i=0; i < regval_ctr_numvals(key->values); i++) {
488 struct regval_blob *blob;
489 blob = regval_ctr_specific_value(key->values, i);
490 max_len = MAX(max_len, strlen(regval_name(blob)));
491 max_size = MAX(max_size, regval_size(blob));
494 *num_values = regval_ctr_numvals(key->values);
495 *max_valnamelen = max_len;
496 *max_valbufsize = max_size;
498 if (!(mem_ctx = talloc_new(key))) {
502 err = regkey_get_secdesc(mem_ctx, key->key, &secdesc);
503 if (!W_ERROR_IS_OK(err)) {
504 TALLOC_FREE(mem_ctx);
508 *secdescsize = ndr_size_security_descriptor(secdesc, 0);
509 TALLOC_FREE(mem_ctx);
511 *last_changed_time = 0;
516 WERROR reg_createkey(TALLOC_CTX *ctx, struct registry_key *parent,
517 const char *subkeypath, uint32 desired_access,
518 struct registry_key **pkey,
519 enum winreg_CreateAction *paction)
521 struct registry_key *key = parent;
522 struct registry_key *create_parent;
527 if (!(mem_ctx = talloc_new(ctx))) return WERR_NOMEM;
529 if (!(path = talloc_strdup(mem_ctx, subkeypath))) {
534 while ((end = strchr(path, '\\')) != NULL) {
535 struct registry_key *tmp;
536 enum winreg_CreateAction action;
540 err = reg_createkey(mem_ctx, key, path,
541 KEY_ENUMERATE_SUB_KEYS, &tmp, &action);
542 if (!W_ERROR_IS_OK(err)) {
555 * At this point, "path" contains the one-element subkey of "key". We
556 * can try to open it.
559 err = reg_openkey(ctx, key, path, desired_access, pkey);
560 if (W_ERROR_IS_OK(err)) {
561 if (paction != NULL) {
562 *paction = REG_OPENED_EXISTING_KEY;
567 if (!W_ERROR_EQUAL(err, WERR_BADFILE)) {
569 * Something but "notfound" has happened, so bail out
575 * We have to make a copy of the current key, as we opened it only
576 * with ENUM_SUBKEY access.
579 err = reg_openkey(mem_ctx, key, "", KEY_CREATE_SUB_KEY,
581 if (!W_ERROR_IS_OK(err)) {
586 * Actually create the subkey
589 err = fill_subkey_cache(create_parent);
590 if (!W_ERROR_IS_OK(err)) goto done;
592 err = create_reg_subkey(key->key, path);
593 W_ERROR_NOT_OK_GOTO_DONE(err);
596 * Now open the newly created key
599 err = reg_openkey(ctx, create_parent, path, desired_access, pkey);
600 if (W_ERROR_IS_OK(err) && (paction != NULL)) {
601 *paction = REG_CREATED_NEW_KEY;
605 TALLOC_FREE(mem_ctx);
609 WERROR reg_deletekey(struct registry_key *parent, const char *path)
613 struct registry_key *tmp_key, *key;
614 TALLOC_CTX *mem_ctx = talloc_stackframe();
616 name = talloc_strdup(mem_ctx, path);
622 /* check if the key has subkeys */
623 err = reg_openkey(mem_ctx, parent, name, REG_KEY_READ, &key);
624 W_ERROR_NOT_OK_GOTO_DONE(err);
626 err = fill_subkey_cache(key);
627 W_ERROR_NOT_OK_GOTO_DONE(err);
629 if (regsubkey_ctr_numkeys(key->subkeys) > 0) {
630 err = WERR_ACCESS_DENIED;
634 /* no subkeys - proceed with delete */
635 end = strrchr(name, '\\');
639 err = reg_openkey(mem_ctx, parent, name,
640 KEY_CREATE_SUB_KEY, &tmp_key);
641 W_ERROR_NOT_OK_GOTO_DONE(err);
647 if (name[0] == '\0') {
648 err = WERR_INVALID_PARAM;
652 err = delete_reg_subkey(parent->key, name);
655 TALLOC_FREE(mem_ctx);
659 WERROR reg_setvalue(struct registry_key *key, const char *name,
660 const struct registry_value *val)
665 if (!(key->key->access_granted & KEY_SET_VALUE)) {
666 return WERR_ACCESS_DENIED;
669 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
673 res = regval_ctr_addvalue(key->values, name, val->type,
674 val->data.data, val->data.length);
677 TALLOC_FREE(key->values);
681 if (!store_reg_values(key->key, key->values)) {
682 TALLOC_FREE(key->values);
683 return WERR_REG_IO_FAILURE;
689 static WERROR reg_value_exists(struct registry_key *key, const char *name)
691 struct regval_blob *blob;
693 blob = regval_ctr_getvalue(key->values, name);
702 WERROR reg_deletevalue(struct registry_key *key, const char *name)
706 if (!(key->key->access_granted & KEY_SET_VALUE)) {
707 return WERR_ACCESS_DENIED;
710 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
714 err = reg_value_exists(key, name);
715 if (!W_ERROR_IS_OK(err)) {
719 regval_ctr_delvalue(key->values, name);
721 if (!store_reg_values(key->key, key->values)) {
722 TALLOC_FREE(key->values);
723 return WERR_REG_IO_FAILURE;
729 WERROR reg_getkeysecurity(TALLOC_CTX *mem_ctx, struct registry_key *key,
730 struct security_descriptor **psecdesc)
732 return regkey_get_secdesc(mem_ctx, key->key, psecdesc);
735 WERROR reg_setkeysecurity(struct registry_key *key,
736 struct security_descriptor *psecdesc)
738 return regkey_set_secdesc(key->key, psecdesc);
741 WERROR reg_getversion(uint32_t *version)
743 if (version == NULL) {
744 return WERR_INVALID_PARAM;
747 *version = 0x00000005; /* Windows 2000 registry API version */
751 /**********************************************************************
752 * Higher level utility functions
753 **********************************************************************/
755 WERROR reg_deleteallvalues(struct registry_key *key)
760 if (!(key->key->access_granted & KEY_SET_VALUE)) {
761 return WERR_ACCESS_DENIED;
764 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
768 for (i=0; i < regval_ctr_numvals(key->values); i++) {
769 struct regval_blob *blob;
770 blob = regval_ctr_specific_value(key->values, i);
771 regval_ctr_delvalue(key->values, regval_name(blob));
774 if (!store_reg_values(key->key, key->values)) {
775 TALLOC_FREE(key->values);
776 return WERR_REG_IO_FAILURE;
783 * Utility function to delete a registry key with all its subkeys.
784 * Note that reg_deletekey returns ACCESS_DENIED when called on a
785 * key that has subkeys.
787 static WERROR reg_deletekey_recursive_internal(struct registry_key *parent,
791 WERROR werr = WERR_OK;
792 struct registry_key *key;
793 char *subkey_name = NULL;
795 TALLOC_CTX *mem_ctx = talloc_stackframe();
797 /* recurse through subkeys first */
798 werr = reg_openkey(mem_ctx, parent, path, REG_KEY_ALL, &key);
799 if (!W_ERROR_IS_OK(werr)) {
803 werr = fill_subkey_cache(key);
804 W_ERROR_NOT_OK_GOTO_DONE(werr);
807 * loop from top to bottom for perfomance:
808 * this way, we need to rehash the regsubkey containers less
810 for (i = regsubkey_ctr_numkeys(key->subkeys) ; i > 0; i--) {
811 subkey_name = regsubkey_ctr_specific_key(key->subkeys, i-1);
812 werr = reg_deletekey_recursive_internal(key, subkey_name, true);
813 W_ERROR_NOT_OK_GOTO_DONE(werr);
817 /* now delete the actual key */
818 werr = reg_deletekey(parent, path);
822 TALLOC_FREE(mem_ctx);
826 static WERROR reg_deletekey_recursive_trans(struct registry_key *parent,
832 werr = regdb_transaction_start();
833 if (!W_ERROR_IS_OK(werr)) {
834 DEBUG(0, ("reg_deletekey_recursive_trans: "
835 "error starting transaction: %s\n",
840 werr = reg_deletekey_recursive_internal(parent, path, del_key);
842 if (!W_ERROR_IS_OK(werr)) {
845 DEBUG(1, (__location__ " failed to delete key '%s' from key "
846 "'%s': %s\n", path, parent->key->name,
849 werr2 = regdb_transaction_cancel();
850 if (!W_ERROR_IS_OK(werr2)) {
851 DEBUG(0, ("reg_deletekey_recursive_trans: "
852 "error cancelling transaction: %s\n",
855 * return the original werr or the
856 * error from cancelling the transaction?
860 werr = regdb_transaction_commit();
861 if (!W_ERROR_IS_OK(werr)) {
862 DEBUG(0, ("reg_deletekey_recursive_trans: "
863 "error committing transaction: %s\n",
871 WERROR reg_deletekey_recursive(struct registry_key *parent,
874 return reg_deletekey_recursive_trans(parent, path, true);
877 WERROR reg_deletesubkeys_recursive(struct registry_key *parent,
880 return reg_deletekey_recursive_trans(parent, path, false);