summaryrefslogtreecommitdiff
path: root/source4/lib/registry/hive.h
blob: 821420887087777ca4d8489b3039276c66993f2c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/* 
   Unix SMB/CIFS implementation.
   Registry hive interface
   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
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   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.
*/

#ifndef __REGISTRY_HIVE_H__
#define __REGISTRY_HIVE_H__

#include <talloc.h>
#include "librpc/gen_ndr/security.h"
#include "libcli/util/nt_status.h"

/**
 * This file contains the hive API. This API is generally used for 
 * reading a specific file that contains just one hive. 
 *
 * Good examples are .DAT (NTUSER.DAT) files.
 *
 * This API does not have any notification support (that 
 * should be provided by the registry implementation), nor 
 * does it understand what predefined keys are.
 */

struct hive_key {
	const struct hive_operations *ops;
};

struct hive_operations {
	const char *name;	

	/**
	 * Open a specific subkey
	 */
	WERROR (*enum_key) (TALLOC_CTX *mem_ctx,
						const struct hive_key *key, uint32_t idx, 
						const char **name,
						const char **classname,
						NTTIME *last_mod_time);

	/**
	 * Open a subkey by name
	 */
	WERROR (*get_key_by_name) (TALLOC_CTX *mem_ctx,
							   const struct hive_key *key, const char *name, 
							   struct hive_key **subkey);
	
	/**
	 * Add a new key.
	 */
	WERROR (*add_key) (TALLOC_CTX *ctx,
					   const struct hive_key *parent_key, const char *name, 
					   const char *classname, struct security_descriptor *desc, 
					   struct hive_key **key);
	/**
	 * Remove an existing key.
	 */
	WERROR (*del_key) (const struct hive_key *key, const char *name);

	/**
	 * Force write of a key to disk.
	 */
	WERROR (*flush_key) (struct hive_key *key);

	/**
	 * Retrieve a registry value with a specific index.
	 */
	WERROR (*enum_value) (TALLOC_CTX *mem_ctx,
						  const struct hive_key *key, int idx, 
						  const char **name, uint32_t *type, 
						  DATA_BLOB *data);

	/**
	 * Retrieve a registry value with the specified name
	 */
	WERROR (*get_value_by_name) (TALLOC_CTX *mem_ctx, 
								 struct hive_key *key, const char *name, 
								 uint32_t *type, DATA_BLOB *data);
	
	/**
	 * Set a value on the specified registry key.
	 */
	WERROR (*set_value) (struct hive_key *key, const char *name, 
						 uint32_t type, const DATA_BLOB data);

	/**
	 * Remove a value.
	 */
	WERROR (*delete_value) (struct hive_key *key, const char *name);

	/* Security Descriptors */

	/**
	 * Change the security descriptor on a registry key.
	 *
	 * This should return WERR_NOT_SUPPORTED if the underlying 
	 * format does not have a mechanism for storing 
	 * security descriptors.
	 */
	WERROR (*set_sec_desc) (struct hive_key *key, 
							const struct security_descriptor *desc);

	/**
	 * Retrieve the security descriptor on a registry key.
	 *
	 * This should return WERR_NOT_SUPPORTED if the underlying 
	 * format does not have a mechanism for storing 
	 * security descriptors.
	 */
	WERROR (*get_sec_desc) (TALLOC_CTX *ctx,
							const struct hive_key *key, 
							struct security_descriptor **desc);
	
	/**
	 * Retrieve general information about a key.
	 */
	WERROR (*get_key_info) (TALLOC_CTX *mem_ctx,
							const struct hive_key *key,
							const char **classname,
							uint32_t *num_subkeys,
							uint32_t *num_values,
							NTTIME *last_change_time);
};

struct cli_credentials;
struct auth_session_info;

WERROR reg_open_hive(TALLOC_CTX *parent_ctx, const char *location, 
							  struct auth_session_info *session_info, 
							  struct cli_credentials *credentials, 
							  struct hive_key **root);
WERROR hive_key_get_info(TALLOC_CTX *mem_ctx, const struct hive_key *key,
						 const char **classname, uint32_t *num_subkeys, 
						 uint32_t *num_values,
						 NTTIME *last_change_time);
WERROR hive_key_add_name(TALLOC_CTX *ctx, const struct hive_key *parent_key,
						 const char *name, const char *classname, struct security_descriptor *desc,
						 struct hive_key **key);
WERROR hive_key_del(const struct hive_key *key, const char *name);
WERROR hive_get_key_by_name(TALLOC_CTX *mem_ctx,
							   const struct hive_key *key, const char *name, 
							   struct hive_key **subkey);
WERROR hive_enum_key(TALLOC_CTX *mem_ctx,
					const struct hive_key *key, uint32_t idx, 
					const char **name,
					const char **classname,
					NTTIME *last_mod_time);

WERROR hive_set_value (struct hive_key *key, const char *name, 
					   uint32_t type, const DATA_BLOB data);

WERROR hive_get_value (TALLOC_CTX *mem_ctx, 
					   struct hive_key *key, const char *name, 
					   uint32_t *type, DATA_BLOB *data);
WERROR hive_get_value_by_index (TALLOC_CTX *mem_ctx, 
					   struct hive_key *key, uint32_t idx, const char **name, 
					   uint32_t *type, DATA_BLOB *data);

WERROR hive_del_value (struct hive_key *key, const char *name);

WERROR hive_key_flush(struct hive_key *key);


/* Individual backends */
WERROR reg_open_directory(TALLOC_CTX *parent_ctx, 
			const char *location, struct hive_key **key);
WERROR reg_open_regf_file(TALLOC_CTX *parent_ctx, 
						  const char *location, struct hive_key **key);
WERROR reg_open_ldb_file(TALLOC_CTX *parent_ctx, const char *location, 
								struct auth_session_info *session_info,
								struct cli_credentials *credentials,
								struct hive_key **k);


WERROR reg_create_directory(TALLOC_CTX *parent_ctx, 
			const char *location, struct hive_key **key);
WERROR reg_create_regf_file(TALLOC_CTX *parent_ctx, 
							 const char *location, 
							 int major_version, 
							 struct hive_key **key);


#endif /* __REGISTRY_HIVE_H__ */