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 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 static WERROR reg_enumvalue_nocachefill(TALLOC_CTX *mem_ctx,
380 struct registry_key *key,
381 uint32 idx, char **pname,
382 struct registry_value **pval)
384 struct registry_value *val;
385 struct regval_blob *blob;
387 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
388 return WERR_ACCESS_DENIED;
391 if (idx >= regval_ctr_numvals(key->values)) {
392 return WERR_NO_MORE_ITEMS;
395 blob = regval_ctr_specific_value(key->values, idx);
397 val = talloc_zero(mem_ctx, struct registry_value);
402 val->type = regval_type(blob);
403 val->data = data_blob_talloc(mem_ctx, regval_data_p(blob), regval_size(blob));
406 && !(*pname = talloc_strdup(
407 mem_ctx, regval_name(blob)))) {
416 WERROR reg_queryvalue(TALLOC_CTX *mem_ctx, struct registry_key *key,
417 const char *name, struct registry_value **pval)
422 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
423 return WERR_ACCESS_DENIED;
426 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
430 for (i=0; i < regval_ctr_numvals(key->values); i++) {
431 struct regval_blob *blob;
432 blob = regval_ctr_specific_value(key->values, i);
433 if (strequal(regval_name(blob), name)) {
435 * don't use reg_enumvalue here:
436 * re-reading the values from the disk
437 * would change the indexing and break
440 return reg_enumvalue_nocachefill(mem_ctx, key, i,
448 WERROR reg_querymultiplevalues(TALLOC_CTX *mem_ctx,
449 struct registry_key *key,
453 struct registry_value **pvals)
456 uint32_t i, n, found = 0;
457 struct registry_value *vals;
459 if (num_names == 0) {
463 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
464 return WERR_ACCESS_DENIED;
467 if (!(W_ERROR_IS_OK(err = fill_value_cache(key)))) {
471 vals = talloc_zero_array(mem_ctx, struct registry_value, num_names);
476 for (n=0; n < num_names; n++) {
477 for (i=0; i < regval_ctr_numvals(key->values); i++) {
478 struct regval_blob *blob;
479 blob = regval_ctr_specific_value(key->values, i);
480 if (strequal(regval_name(blob), names[n])) {
481 struct registry_value *v;
482 err = reg_enumvalue(mem_ctx, key, i, NULL, &v);
483 if (!W_ERROR_IS_OK(err)) {
498 WERROR reg_queryinfokey(struct registry_key *key, uint32_t *num_subkeys,
499 uint32_t *max_subkeylen, uint32_t *max_subkeysize,
500 uint32_t *num_values, uint32_t *max_valnamelen,
501 uint32_t *max_valbufsize, uint32_t *secdescsize,
502 NTTIME *last_changed_time)
508 struct security_descriptor *secdesc;
510 if (!(key->key->access_granted & KEY_QUERY_VALUE)) {
511 return WERR_ACCESS_DENIED;
514 if (!W_ERROR_IS_OK(fill_subkey_cache(key)) ||
515 !W_ERROR_IS_OK(fill_value_cache(key))) {
520 for (i=0; i< regsubkey_ctr_numkeys(key->subkeys); i++) {
521 max_len = MAX(max_len,
522 strlen(regsubkey_ctr_specific_key(key->subkeys, i)));
525 *num_subkeys = regsubkey_ctr_numkeys(key->subkeys);
526 *max_subkeylen = max_len;
527 *max_subkeysize = 0; /* Class length? */
531 for (i=0; i < regval_ctr_numvals(key->values); i++) {
532 struct regval_blob *blob;
533 blob = regval_ctr_specific_value(key->values, i);
534 max_len = MAX(max_len, strlen(regval_name(blob)));
535 max_size = MAX(max_size, regval_size(blob));
538 *num_values = regval_ctr_numvals(key->values);
539 *max_valnamelen = max_len;
540 *max_valbufsize = max_size;
542 if (!(mem_ctx = talloc_new(key))) {
546 err = regkey_get_secdesc(mem_ctx, key->key, &secdesc);
547 if (!W_ERROR_IS_OK(err)) {
548 TALLOC_FREE(mem_ctx);
552 *secdescsize = ndr_size_security_descriptor(secdesc, 0);
553 TALLOC_FREE(mem_ctx);
555 *last_changed_time = 0;
560 WERROR reg_createkey(TALLOC_CTX *ctx, struct registry_key *parent,
561 const char *subkeypath, uint32 desired_access,
562 struct registry_key **pkey,
563 enum winreg_CreateAction *paction)
565 struct registry_key *key = parent;
566 struct registry_key *create_parent;
571 if (!(mem_ctx = talloc_new(ctx))) return WERR_NOMEM;
573 if (!(path = talloc_strdup(mem_ctx, subkeypath))) {
578 while ((end = strchr(path, '\\')) != NULL) {
579 struct registry_key *tmp;
580 enum winreg_CreateAction action;
584 err = reg_createkey(mem_ctx, key, path,
585 KEY_ENUMERATE_SUB_KEYS, &tmp, &action);
586 if (!W_ERROR_IS_OK(err)) {
599 * At this point, "path" contains the one-element subkey of "key". We
600 * can try to open it.
603 err = reg_openkey(ctx, key, path, desired_access, pkey);
604 if (W_ERROR_IS_OK(err)) {
605 if (paction != NULL) {
606 *paction = REG_OPENED_EXISTING_KEY;
611 if (!W_ERROR_EQUAL(err, WERR_BADFILE)) {
613 * Something but "notfound" has happened, so bail out
619 * We have to make a copy of the current key, as we opened it only
620 * with ENUM_SUBKEY access.
623 err = reg_openkey(mem_ctx, key, "", KEY_CREATE_SUB_KEY,
625 if (!W_ERROR_IS_OK(err)) {
630 * Actually create the subkey
633 err = fill_subkey_cache(create_parent);
634 if (!W_ERROR_IS_OK(err)) goto done;
636 err = create_reg_subkey(key->key, path);
637 W_ERROR_NOT_OK_GOTO_DONE(err);
640 * Now open the newly created key
643 err = reg_openkey(ctx, create_parent, path, desired_access, pkey);
644 if (W_ERROR_IS_OK(err) && (paction != NULL)) {
645 *paction = REG_CREATED_NEW_KEY;
649 TALLOC_FREE(mem_ctx);
653 WERROR reg_deletekey(struct registry_key *parent, const char *path)
657 struct registry_key *tmp_key, *key;
658 TALLOC_CTX *mem_ctx = talloc_stackframe();
660 name = talloc_strdup(mem_ctx, path);
666 /* check if the key has subkeys */
667 err = reg_openkey(mem_ctx, parent, name, REG_KEY_READ, &key);
668 W_ERROR_NOT_OK_GOTO_DONE(err);
670 err = fill_subkey_cache(key);
671 W_ERROR_NOT_OK_GOTO_DONE(err);
673 if (regsubkey_ctr_numkeys(key->subkeys) > 0) {
674 err = WERR_ACCESS_DENIED;
678 /* no subkeys - proceed with delete */
679 end = strrchr(name, '\\');
683 err = reg_openkey(mem_ctx, parent, name,
684 KEY_CREATE_SUB_KEY, &tmp_key);
685 W_ERROR_NOT_OK_GOTO_DONE(err);
691 if (name[0] == '\0') {
692 err = WERR_INVALID_PARAM;
696 err = delete_reg_subkey(parent->key, name);
699 TALLOC_FREE(mem_ctx);
703 WERROR reg_setvalue(struct registry_key *key, const char *name,
704 const struct registry_value *val)
706 struct regval_blob *existing;
710 if (!(key->key->access_granted & KEY_SET_VALUE)) {
711 return WERR_ACCESS_DENIED;
714 err = fill_value_cache(key);
715 if (!W_ERROR_IS_OK(err)) {
716 DEBUG(0, ("reg_setvalue: Error filling value cache: %s\n", win_errstr(err)));
720 existing = regval_ctr_getvalue(key->values, name);
722 if ((existing != NULL) &&
723 (regval_size(existing) == val->data.length) &&
724 (memcmp(regval_data_p(existing), val->data.data,
725 val->data.length) == 0)) {
729 res = regval_ctr_addvalue(key->values, name, val->type,
730 val->data.data, val->data.length);
733 TALLOC_FREE(key->values);
737 if (!store_reg_values(key->key, key->values)) {
738 TALLOC_FREE(key->values);
739 return WERR_REG_IO_FAILURE;
745 static WERROR reg_value_exists(struct registry_key *key, const char *name)
747 struct regval_blob *blob;
749 blob = regval_ctr_getvalue(key->values, name);
758 WERROR reg_deletevalue(struct registry_key *key, const char *name)
762 if (!(key->key->access_granted & KEY_SET_VALUE)) {
763 return WERR_ACCESS_DENIED;
766 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
770 err = reg_value_exists(key, name);
771 if (!W_ERROR_IS_OK(err)) {
775 regval_ctr_delvalue(key->values, name);
777 if (!store_reg_values(key->key, key->values)) {
778 TALLOC_FREE(key->values);
779 return WERR_REG_IO_FAILURE;
785 WERROR reg_getkeysecurity(TALLOC_CTX *mem_ctx, struct registry_key *key,
786 struct security_descriptor **psecdesc)
788 return regkey_get_secdesc(mem_ctx, key->key, psecdesc);
791 WERROR reg_setkeysecurity(struct registry_key *key,
792 struct security_descriptor *psecdesc)
794 return regkey_set_secdesc(key->key, psecdesc);
797 WERROR reg_getversion(uint32_t *version)
799 if (version == NULL) {
800 return WERR_INVALID_PARAM;
803 *version = 0x00000005; /* Windows 2000 registry API version */
807 /**********************************************************************
808 * Higher level utility functions
809 **********************************************************************/
811 WERROR reg_deleteallvalues(struct registry_key *key)
816 if (!(key->key->access_granted & KEY_SET_VALUE)) {
817 return WERR_ACCESS_DENIED;
820 if (!W_ERROR_IS_OK(err = fill_value_cache(key))) {
824 for (i=0; i < regval_ctr_numvals(key->values); i++) {
825 struct regval_blob *blob;
826 blob = regval_ctr_specific_value(key->values, i);
827 regval_ctr_delvalue(key->values, regval_name(blob));
830 if (!store_reg_values(key->key, key->values)) {
831 TALLOC_FREE(key->values);
832 return WERR_REG_IO_FAILURE;
839 * Utility function to delete a registry key with all its subkeys.
840 * Note that reg_deletekey returns ACCESS_DENIED when called on a
841 * key that has subkeys.
843 static WERROR reg_deletekey_recursive_internal(struct registry_key *parent,
847 WERROR werr = WERR_OK;
848 struct registry_key *key;
849 char *subkey_name = NULL;
851 TALLOC_CTX *mem_ctx = talloc_stackframe();
853 /* recurse through subkeys first */
854 werr = reg_openkey(mem_ctx, parent, path, REG_KEY_ALL, &key);
855 if (!W_ERROR_IS_OK(werr)) {
859 werr = fill_subkey_cache(key);
860 W_ERROR_NOT_OK_GOTO_DONE(werr);
863 * loop from top to bottom for perfomance:
864 * this way, we need to rehash the regsubkey containers less
866 for (i = regsubkey_ctr_numkeys(key->subkeys) ; i > 0; i--) {
867 subkey_name = regsubkey_ctr_specific_key(key->subkeys, i-1);
868 werr = reg_deletekey_recursive_internal(key, subkey_name, true);
869 W_ERROR_NOT_OK_GOTO_DONE(werr);
873 /* now delete the actual key */
874 werr = reg_deletekey(parent, path);
878 TALLOC_FREE(mem_ctx);
882 static WERROR reg_deletekey_recursive_trans(struct registry_key *parent,
888 werr = regdb_transaction_start();
889 if (!W_ERROR_IS_OK(werr)) {
890 DEBUG(0, ("reg_deletekey_recursive_trans: "
891 "error starting transaction: %s\n",
896 werr = reg_deletekey_recursive_internal(parent, path, del_key);
898 if (!W_ERROR_IS_OK(werr)) {
901 DEBUG(1, (__location__ " failed to delete key '%s' from key "
902 "'%s': %s\n", path, parent->key->name,
905 werr2 = regdb_transaction_cancel();
906 if (!W_ERROR_IS_OK(werr2)) {
907 DEBUG(0, ("reg_deletekey_recursive_trans: "
908 "error cancelling transaction: %s\n",
911 * return the original werr or the
912 * error from cancelling the transaction?
916 werr = regdb_transaction_commit();
917 if (!W_ERROR_IS_OK(werr)) {
918 DEBUG(0, ("reg_deletekey_recursive_trans: "
919 "error committing transaction: %s\n",
927 WERROR reg_deletekey_recursive(struct registry_key *parent,
930 return reg_deletekey_recursive_trans(parent, path, true);
933 WERROR reg_deletesubkeys_recursive(struct registry_key *parent,
936 return reg_deletekey_recursive_trans(parent, path, false);