Unix SMB/CIFS implementation.
Registry interface
Copyright (C) Gerald Carter 2002.
- Copyright (C) Jelmer Vernooij 2003-2004.
+ Copyright (C) Jelmer Vernooij 2003-2007.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _REGISTRY_H /* _REGISTRY_H */
#define _REGISTRY_H
+struct registry_context;
+
+#include "core.h"
+#include "talloc/talloc.h"
#include "librpc/gen_ndr/security.h"
-#include "auth/credentials/credentials.h"
+#include "lib/registry/hive.h"
/* Handles for the predefined keys */
#define HKEY_CLASSES_ROOT 0x80000000
#define HKEY_PERFORMANCE_TEXT 0x80000050
#define HKEY_PERFORMANCE_NLSTEXT 0x80000060
-#define REG_DELETE -1
+#define HKEY_FIRST HKEY_CLASSES_ROOT
+#define HKEY_LAST HKEY_PERFORMANCE_NLSTEXT
+
+struct reg_predefined_key {
+ uint32_t handle;
+ const char *name;
+};
+
+extern const struct reg_predefined_key reg_predefined_keys[];
+
+#define REG_DELETE -1
/*
* The general idea here is that every backend provides a 'hive'. Combining
#define REGISTRY_INTERFACE_VERSION 1
+struct reg_key_operations;
+
/* structure to store the registry handles */
struct registry_key
{
- char *name;
- const char *path;
- char *class_name;
- NTTIME last_mod;
- struct registry_hive *hive;
- void *backend_data;
+ struct registry_context *context;
};
+#include "lib/registry/patchfile.h"
+
struct registry_value
{
- char *name;
+ const char *name;
unsigned int data_type;
DATA_BLOB data;
};
typedef void (*reg_key_notification_function) (void);
typedef void (*reg_value_notification_function) (void);
-/*
- * Container for function pointers to enumeration routines
- * for virtual registry view
- *
- * Backends can provide :
- * - just one hive (example: nt4, w95)
- * - several hives (example: rpc).
- *
- * Backends should always do case-insensitive compares
- * (everything is case-insensitive but case-preserving,
- * just like the FS)
- *
- * There is no save function as all operations are expected to
- * be atomic.
- */
-
-struct hive_operations {
+struct cli_credentials;
+struct registry_context;
+
+struct registry_operations {
const char *name;
- /* Implement this one */
- WERROR (*open_hive) (struct registry_hive *, struct registry_key **);
+ WERROR (*get_key_info) (TALLOC_CTX *mem_ctx,
+ const struct registry_key *key,
+ const char **classname,
+ uint32_t *numsubkeys,
+ uint32_t *numvalues,
+ NTTIME *last_change_time);
- /* Or this one */
- WERROR (*open_key) (TALLOC_CTX *, const struct registry_key *, const char *name, struct registry_key **);
+ WERROR (*flush_key) (struct registry_key *key);
- WERROR (*num_subkeys) (const struct registry_key *, uint32_t *count);
- WERROR (*num_values) (const struct registry_key *, uint32_t *count);
- WERROR (*get_subkey_by_index) (TALLOC_CTX *, const struct registry_key *, int idx, struct registry_key **);
+ WERROR (*get_predefined_key) (const struct registry_context *ctx,
+ uint32_t key_id,
+ struct registry_key **key);
- /* Can not contain more then one level */
- WERROR (*get_subkey_by_name) (TALLOC_CTX *, const struct registry_key *, const char *name, struct registry_key **);
- WERROR (*get_value_by_index) (TALLOC_CTX *, const struct registry_key *, int idx, struct registry_value **);
+ WERROR (*open_key) (TALLOC_CTX *mem_ctx,
+ struct registry_key *parent,
+ const char *path,
+ struct registry_key **key);
- /* Can not contain more then one level */
- WERROR (*get_value_by_name) (TALLOC_CTX *, const struct registry_key *, const char *name, struct registry_value **);
+ WERROR (*create_key) (TALLOC_CTX *mem_ctx,
+ struct registry_key *parent,
+ const char *name,
+ const char *key_class,
+ struct security_descriptor *security,
+ struct registry_key **key);
- /* Security control */
- WERROR (*key_get_sec_desc) (TALLOC_CTX *, const struct registry_key *, struct security_descriptor **);
- WERROR (*key_set_sec_desc) (const struct registry_key *, const struct security_descriptor *);
+ WERROR (*delete_key) (struct registry_key *key, const char *name);
- /* Notification */
- WERROR (*request_key_change_notify) (const struct registry_key *, reg_key_notification_function);
- WERROR (*request_value_change_notify) (const struct registry_value *, reg_value_notification_function);
+ WERROR (*delete_value) (struct registry_key *key, const char *name);
- /* Key management */
- WERROR (*add_key)(TALLOC_CTX *, const struct registry_key *, const char *name, uint32_t access_mask, struct security_descriptor *, struct registry_key **);
- WERROR (*del_key)(const struct registry_key *, const char *name);
- WERROR (*flush_key) (const struct registry_key *);
+ WERROR (*enum_key) (TALLOC_CTX *mem_ctx,
+ const struct registry_key *key, uint32_t idx,
+ const char **name,
+ const char **keyclass,
+ NTTIME *last_changed_time);
- /* Value management */
- WERROR (*set_value)(const struct registry_key *, const char *name, uint32_t type, const DATA_BLOB data);
- WERROR (*del_value)(const struct registry_key *, const char *valname);
-};
+ WERROR (*enum_value) (TALLOC_CTX *mem_ctx,
+ const struct registry_key *key, uint32_t idx,
+ const char **name,
+ uint32_t *type,
+ DATA_BLOB *data);
-struct registry_hive
-{
- const struct hive_operations *functions;
- struct registry_key *root;
- void *backend_data;
- const char *location;
-};
+ WERROR (*get_security) (TALLOC_CTX *mem_ctx,
+ const struct registry_key *key,
+ struct security_descriptor **security);
+
+ WERROR (*set_security) (struct registry_key *key,
+ const struct security_descriptor *security);
+
+ WERROR (*load_key) (struct registry_key *key,
+ const char *key_name,
+ const char *path);
+
+ WERROR (*unload_key) (struct registry_key *key, const char *name);
-/* Handle to a full registry
- * contains zero or more hives */
+ WERROR (*notify_value_change) (struct registry_key *key,
+ reg_value_notification_function fn);
+
+ WERROR (*get_value) (TALLOC_CTX *mem_ctx,
+ const struct registry_key *key,
+ const char *name,
+ uint32_t *type,
+ DATA_BLOB *data);
+
+ WERROR (*set_value) (struct registry_key *key,
+ const char *name,
+ uint32_t type,
+ const DATA_BLOB data);
+};
+
+/**
+ * Handle to a full registry
+ * contains zero or more hives
+ */
struct registry_context {
- void *backend_data;
- WERROR (*get_predefined_key) (struct registry_context *, uint32_t hkey, struct registry_key **);
+ const struct registry_operations *ops;
};
-struct reg_init_function_entry {
- const struct hive_operations *hive_functions;
- struct reg_init_function_entry *prev, *next;
-};
+struct auth_session_info;
+struct event_context;
-struct reg_diff_value
-{
- char *name;
- enum { REG_DIFF_DEL_VAL, REG_DIFF_SET_VAL } changetype;
- uint32_t type;
- DATA_BLOB data;
-};
+#ifndef _PUBLIC_
+#define _PUBLIC_
+#endif
-struct reg_diff_key
-{
- char *name;
- enum { REG_DIFF_CHANGE_KEY, REG_DIFF_DEL_KEY } changetype;
- uint32_t numvalues;
- struct reg_diff_value *values;
-};
+/**
+ * Open the locally defined registry.
+ */
+_PUBLIC_ WERROR reg_open_local (TALLOC_CTX *mem_ctx,
+ struct registry_context **ctx,
+ struct auth_session_info *session_info,
+ struct cli_credentials *credentials);
-struct reg_diff
-{
- char *format;
- uint32_t numkeys;
- struct reg_diff_key *keys;
-};
+_PUBLIC_ WERROR reg_open_samba (TALLOC_CTX *mem_ctx,
+ struct registry_context **ctx,
+ struct auth_session_info *session_info,
+ struct cli_credentials *credentials);
+
+/**
+ * Open the registry on a remote machine.
+ */
+_PUBLIC_ WERROR reg_open_remote(struct registry_context **ctx,
+ struct auth_session_info *session_info,
+ struct cli_credentials *credentials,
+ const char *location, struct event_context *ev);
+
+_PUBLIC_ WERROR reg_open_wine(struct registry_context **ctx, const char *path);
+
+_PUBLIC_ const char *reg_get_predef_name(uint32_t hkey);
+_PUBLIC_ WERROR reg_get_predefined_key_by_name(struct registry_context *ctx,
+ const char *name,
+ struct registry_key **key);
+_PUBLIC_ WERROR reg_get_predefined_key(const struct registry_context *ctx,
+ uint32_t hkey,
+ struct registry_key **key);
+
+_PUBLIC_ WERROR reg_open_key(TALLOC_CTX *mem_ctx, struct registry_key *parent,
+ const char *name, struct registry_key **result);
+
+_PUBLIC_ WERROR reg_key_get_value_by_index(TALLOC_CTX *mem_ctx,
+ const struct registry_key *key, uint32_t idx,
+ const char **name,
+ uint32_t *type,
+ DATA_BLOB *data);
+_PUBLIC_ WERROR reg_key_get_info(TALLOC_CTX *mem_ctx,
+ const struct registry_key *key,
+ const char **class_name,
+ uint32_t *num_subkeys,
+ uint32_t *num_values,
+ NTTIME *last_change_time);
+_PUBLIC_ WERROR reg_key_get_subkey_by_index(TALLOC_CTX *mem_ctx,
+ const struct registry_key *key,
+ int idx,
+ const char **name,
+ const char **classname,
+ NTTIME *last_mod_time);
+WERROR reg_key_get_subkey_by_name(TALLOC_CTX *mem_ctx,
+ const struct registry_key *key,
+ const char *name,
+ struct registry_key **subkey);
+_PUBLIC_ WERROR reg_key_get_value_by_name(TALLOC_CTX *mem_ctx,
+ const struct registry_key *key,
+ const char *name,
+ uint32_t *type,
+ DATA_BLOB *data);
+_PUBLIC_ WERROR reg_key_del(struct registry_key *parent, const char *name);
+_PUBLIC_ WERROR reg_key_add_name(TALLOC_CTX *mem_ctx,
+ struct registry_key *parent, const char *name,
+ const char *classname,
+ struct security_descriptor *desc,
+ struct registry_key **newkey);
+_PUBLIC_ WERROR reg_val_set(struct registry_key *key, const char *value,
+ uint32_t type, DATA_BLOB data);
+_PUBLIC_ WERROR reg_get_sec_desc(TALLOC_CTX *ctx, const struct registry_key *key, struct security_descriptor **secdesc);
+_PUBLIC_ WERROR reg_del_value(struct registry_key *key, const char *valname);
+_PUBLIC_ WERROR reg_key_flush(struct registry_key *key);
+WERROR reg_create_key (TALLOC_CTX *mem_ctx,
+ struct registry_key *parent,
+
+ const char *name,
+ const char *key_class,
+ struct security_descriptor *security,
+ struct registry_key **key);
+
+
+
+
+/* Utility functions */
+_PUBLIC_ const char *str_regtype(int type);
+_PUBLIC_ char *reg_val_data_string(TALLOC_CTX *mem_ctx, uint32_t type,
+ const DATA_BLOB data);
+_PUBLIC_ char *reg_val_description(TALLOC_CTX *mem_ctx, const char *name,
+ uint32_t type, const DATA_BLOB data);
+_PUBLIC_ bool reg_string_to_val(TALLOC_CTX *mem_ctx, const char *type_str, const char *data_str, uint32_t *type, DATA_BLOB *data);
+WERROR reg_open_key_abs(TALLOC_CTX *mem_ctx, struct registry_context *handle, const char *name, struct registry_key **result);
+WERROR reg_key_del_abs(struct registry_context *ctx, const char *path);
+WERROR reg_key_add_abs(TALLOC_CTX *mem_ctx, struct registry_context *ctx, const char *path, uint32_t access_mask, struct security_descriptor *sec_desc, struct registry_key **result);
+WERROR reg_load_key(struct registry_context *ctx, struct registry_key *key,
+ const char *name, const char *filename);
+
+WERROR reg_mount_hive(struct registry_context *rctx,
+ struct hive_key *hive_key,
+ uint32_t key_id,
+ const char **elements);
+
+struct registry_key *reg_import_hive_key(struct registry_context *ctx,
+ struct hive_key *hive,
+ uint32_t predef_key,
+ const char **elements);
-#include "registry_proto.h"
#endif /* _REGISTRY_H */
git.samba.org / jra / samba / .git / blobdiff