Context Navigation

source: trunk/include/regfi.h @ 106

Last change on this file since 106 was 106, checked in by tim, 16 years ago
replaced linked list hbin lookup with range_list based binary search
Property svn:keywords set to `Id`
File size: 11.7 KB

Line
1	/*
2	* Branched from Samba project, Subversion repository version #6903:
3	* http://viewcvs.samba.org/cgi-bin/viewcvs.cgi/trunk/source/include/regfio.h?rev=6903&view=auto
4	*
5	* Unix SMB/CIFS implementation.
6	* Windows NT registry I/O library
7	*
8	* Copyright (C) 2005-2008 Timothy D. Morgan
9	* Copyright (C) 2005 Gerald (Jerry) Carter
10	*
11	* This program is free software; you can redistribute it and/or modify
12	* it under the terms of the GNU General Public License as published by
13	* the Free Software Foundation; version 2 of the License.
14	*
15	* This program is distributed in the hope that it will be useful,
16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18	* GNU General Public License for more details.
19	*
20	* You should have received a copy of the GNU General Public License
21	* along with this program; if not, write to the Free Software
22	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23	*
24	* $Id: regfi.h 106 2008-04-18 04:16:51Z tim $
25	*/
26
27	/************************************************************
28	* Most of this information was obtained from
29	* http://www.wednesday.demon.co.uk/dosreg.html
30	* Thanks Nigel!
31	***********************************************************/
32
33	#ifndef _REGFI_H
34	#define _REGFI_H
35
36	#include <stdlib.h>
37	#include <stdio.h>
38	#include <stdbool.h>
39	#include <string.h>
40	#include <errno.h>
41	#include <time.h>
42	#include <fcntl.h>
43	#include <sys/stat.h>
44	#include <sys/types.h>
45	#include <unistd.h>
46	#include <assert.h>
47
48	#include "smb_deps.h"
49	#include "void_stack.h"
50	#include "range_list.h"
51
52	/******************************************************************************/
53	/* Macros */
54
55	/* Registry data types */
56	#define REG_NONE 0
57	#define REG_SZ 1
58	#define REG_EXPAND_SZ 2
59	#define REG_BINARY 3
60	#define REG_DWORD 4
61	#define REG_DWORD_LE 4 /* DWORD, little endian */
62	#define REG_DWORD_BE 5 /* DWORD, big endian */
63	#define REG_LINK 6
64	#define REG_MULTI_SZ 7
65	#define REG_RESOURCE_LIST 8
66	#define REG_FULL_RESOURCE_DESCRIPTOR 9
67	#define REG_RESOURCE_REQUIREMENTS_LIST 10
68	#define REG_QWORD 11 /* 64-bit little endian */
69	/* XXX: Has MS defined a REG_QWORD_BE? */
70	/* Not a real type in the registry */
71	#define REG_KEY 0x7FFFFFFF
72
73
74	#define REGF_BLOCKSIZE 0x1000
75	#define REGF_ALLOC_BLOCK 0x1000 /* Minimum allocation unit for hbins */
76	#define REGF_MAX_DEPTH 512
77
78	/* header sizes for various records */
79
80	#define REGF_MAGIC_SIZE 4
81	#define HBIN_MAGIC_SIZE 4
82	#define HBIN_HEADER_REC_SIZE 0x20
83	#define REC_HDR_SIZE 2
84
85	#define REGF_OFFSET_NONE 0xffffffff
86	#define REGFI_NK_MIN_LENGTH 0x4C
87	#define REGFI_VK_MIN_LENGTH 0x14
88	#define REGFI_SK_MIN_LENGTH 0x14
89	#define REGFI_HASH_LIST_MIN_LENGTH 0x4
90
91	/* Flags for the vk records */
92
93	#define VK_FLAG_NAME_PRESENT 0x0001
94	#define VK_DATA_IN_OFFSET 0x80000000
95	#define VK_MAX_DATA_LENGTH 1024*1024
96
97	/* NK record macros */
98
99	#define NK_TYPE_LINKKEY 0x0010
100	#define NK_TYPE_NORMALKEY 0x0020
101	#define NK_TYPE_ROOTKEY 0x002c
102	/* TODO: Unknown type that shows up in Vista registries */
103	#define NK_TYPE_UNKNOWN1 0x1020
104
105	#define HBIN_STORE_REF(x, y) { x->hbin = y; y->ref_count++ };
106	/* if the count == 0; we can clean up */
107	#define HBIN_REMOVE_REF(x, y){ x->hbin = NULL; y->ref_count-- };
108
109
110	/* HBIN block */
111	typedef struct regf_hbin
112	{
113	uint32 file_off; /* my offset in the registry file */
114	uint32 ref_count; /* how many active records are pointing to this
115	* block (not used currently)
116	*/
117
118	uint32 first_hbin_off; /* offset from first hbin block */
119	uint32 block_size; /* block size of this block
120	* Should be a multiple of 4096 (0x1000)
121	*/
122	uint32 next_block; /* relative offset to next block.
123	* NOTE: This value may be unreliable!
124	*/
125
126	uint8 magic[HBIN_MAGIC_SIZE]; /* "hbin" */
127	} REGF_HBIN;
128
129
130	/* Hash List -- list of key offsets and hashed names for consistency */
131	typedef struct
132	{
133	uint32 nk_off;
134	uint32 hash;
135	} REGF_HASH_LIST_ELEM;
136
137
138	typedef struct
139	{
140	uint32 offset; /* Real offset of this record's cell in the file */
141	uint32 cell_size; /* ((start_offset - end_offset) & 0xfffffff8) */
142	REGF_HBIN* hbin; /* pointer to HBIN record (in memory) containing
143	* this nk record
144	*/
145	uint32 hbin_off; /* offset from beginning of this hbin block */
146	REGF_HASH_LIST_ELEM* hashes;
147
148	uint8 magic[REC_HDR_SIZE];
149	uint16 num_keys;
150	} REGF_HASH_LIST;
151
152
153	/* Key Value */
154	typedef struct
155	{
156	uint32 offset; /* Real offset of this record's cell in the file */
157	uint32 cell_size; /* ((start_offset - end_offset) & 0xfffffff8) */
158
159	REGF_HBIN* hbin; /* pointer to HBIN record (in memory) containing
160	* this nk record
161	*/
162	uint8* data;
163	uint16 name_length;
164	char* valuename;
165	uint32 hbin_off; /* offset from beginning of this hbin block */
166
167	uint32 data_size;
168	uint32 data_off; /* offset of data cell (virtual) */
169	uint32 type;
170	uint8 magic[REC_HDR_SIZE];
171	uint16 flag;
172	uint16 unknown1;
173	} REGF_VK_REC;
174
175
176	/* Key Security */
177	struct _regf_sk_rec;
178
179	typedef struct _regf_sk_rec
180	{
181	struct _regf_sk_rec* next;
182	struct _regf_sk_rec* prev;
183	REGF_HBIN* hbin; /* pointer to HBIN record (in memory) containing
184	* this nk record
185	*/
186	SEC_DESC* sec_desc;
187	uint32 hbin_off; /* offset from beginning of this hbin block */
188	uint32 cell_size; /* ((start_offset - end_offset) & 0xfffffff8) */
189	uint32 offset; /* Real file offset of this record */
190
191	uint32 sk_off; /* offset parsed from NK record used as a key
192	* to lookup reference to this SK record
193	*/
194
195	uint32 prev_sk_off;
196	uint32 next_sk_off;
197	uint32 ref_count;
198	uint32 desc_size; /* size of security descriptor */
199	uint16 unknown_tag;
200	uint8 magic[REC_HDR_SIZE];
201	} REGF_SK_REC;
202
203
204	/* Key Name */
205	typedef struct
206	{
207	uint32 offset; /* Real offset of this record's cell in the file */
208	uint32 cell_size; /* Actual or estimated length of the cell.
209	* Always in multiples of 8.
210	*/
211
212	/* link in the other records here */
213	REGF_VK_REC** values;
214	REGF_SK_REC* sec_desc;
215	REGF_HASH_LIST* subkeys;
216
217	/* header information */
218	/* XXX: should we be looking for types other than the root key type? */
219	uint16 key_type;
220	uint8 magic[REC_HDR_SIZE];
221	NTTIME mtime;
222	uint16 name_length;
223	uint16 classname_length;
224	char* classname;
225	char* keyname;
226	uint32 parent_off; /* back pointer in registry hive */
227	uint32 classname_off;
228
229	/* max lengths */
230	uint32 max_bytes_subkeyname; /* max subkey name * 2 */
231	uint32 max_bytes_subkeyclassname; /* max subkey classname length (as if) */
232	uint32 max_bytes_valuename; /* max valuename * 2 */
233	uint32 max_bytes_value; /* max value data size */
234
235	/* unknowns */
236	uint32 unknown1;
237	uint32 unknown2;
238	uint32 unknown3;
239	uint32 unk_index; /* nigel says run time index ? */
240
241	/* children */
242	uint32 num_subkeys;
243	uint32 subkeys_off; /* hash records that point to NK records */
244	uint32 num_values;
245	uint32 values_off; /* value lists which point to VK records */
246	uint32 sk_off; /* offset to SK record */
247	} REGF_NK_REC;
248
249
250
251	/* REGF block */
252	typedef struct
253	{
254	/* run time information */
255	int fd; /* file descriptor */
256	/* For sanity checking (not part of the registry header) */
257	uint32 file_length;
258	void* mem_ctx; /* memory context for run-time file access information */
259
260	/* Experimental hbin lists */
261	range_list* hbins;
262	range_list* unalloc_cells;
263
264	/* file format information */
265	REGF_SK_REC* sec_desc_list; /* list of security descriptors referenced
266	* by NK records
267	*/
268
269	uint8 magic[REGF_MAGIC_SIZE];/* "regf" */
270	NTTIME mtime;
271	uint32 data_offset; /* offset to record in the first (or any?)
272	* hbin block
273	*/
274	uint32 last_block; /* offset to last hbin block in file */
275
276	uint32 checksum; /* Stored checksum. */
277	uint32 computed_checksum; /* Our own calculation of the checksum.
278	* (XOR of bytes 0x0000 - 0x01FB)
279	*/
280
281	/* unknown data structure values */
282	uint32 unknown1;
283	uint32 unknown2;
284	uint32 unknown3;
285	uint32 unknown4;
286	uint32 unknown5;
287	uint32 unknown6;
288	uint32 unknown7;
289	} REGF_FILE;
290
291
292
293	typedef struct
294	{
295	REGF_FILE* f;
296	void_stack* key_positions;
297	REGF_NK_REC* cur_key;
298	uint32 cur_subkey;
299	uint32 cur_value;
300	} REGFI_ITERATOR;
301
302
303	typedef struct
304	{
305	REGF_NK_REC* nk;
306	uint32 cur_subkey;
307	/* We could store a cur_value here as well, but didn't see
308	* the use in it right now.
309	*/
310	} REGFI_ITER_POSITION;
311
312
313	/******************************************************************************/
314	/* Function Declarations */
315	/* Main API */
316	const char* regfi_type_val2str(unsigned int val);
317	int regfi_type_str2val(const char* str);
318
319	char* regfi_get_sacl(SEC_DESC* sec_desc);
320	char* regfi_get_dacl(SEC_DESC* sec_desc);
321	char* regfi_get_owner(SEC_DESC* sec_desc);
322	char* regfi_get_group(SEC_DESC* sec_desc);
323
324	REGF_FILE* regfi_open(const char* filename);
325	int regfi_close(REGF_FILE* r);
326
327	REGFI_ITERATOR* regfi_iterator_new(REGF_FILE* fh);
328	void regfi_iterator_free(REGFI_ITERATOR* i);
329	bool regfi_iterator_down(REGFI_ITERATOR* i);
330	bool regfi_iterator_up(REGFI_ITERATOR* i);
331	bool regfi_iterator_to_root(REGFI_ITERATOR* i);
332
333	bool regfi_iterator_find_subkey(REGFI_ITERATOR* i,
334	const char* subkey_name);
335	bool regfi_iterator_walk_path(REGFI_ITERATOR* i,
336	const char** path);
337	const REGF_NK_REC* regfi_iterator_cur_key(REGFI_ITERATOR* i);
338	const REGF_NK_REC* regfi_iterator_first_subkey(REGFI_ITERATOR* i);
339	const REGF_NK_REC* regfi_iterator_cur_subkey(REGFI_ITERATOR* i);
340	const REGF_NK_REC* regfi_iterator_next_subkey(REGFI_ITERATOR* i);
341
342	bool regfi_iterator_find_value(REGFI_ITERATOR* i,
343	const char* value_name);
344	const REGF_VK_REC* regfi_iterator_first_value(REGFI_ITERATOR* i);
345	const REGF_VK_REC* regfi_iterator_cur_value(REGFI_ITERATOR* i);
346	const REGF_VK_REC* regfi_iterator_next_value(REGFI_ITERATOR* i);
347
348	/************************************/
349	/* Low-layer data structure access */
350	/************************************/
351	REGF_FILE* regfi_parse_regf(int fd, bool strict);
352	REGF_HBIN* regfi_parse_hbin(REGF_FILE* file, uint32 offset,
353	bool strict, bool save_unalloc);
354
355
356	/* regfi_parse_nk: Parses an NK record.
357	*
358	* Arguments:
359	* f -- the registry file structure
360	* offset -- the offset of the cell (not the record) to be parsed.
361	* max_size -- the maximum size the NK cell could be. (for validation)
362	* strict -- if true, rejects any malformed records. Otherwise,
363	* tries to minimally validate integrity.
364	* Returns:
365	* A newly allocated NK record structure, or NULL on failure.
366	*/
367	REGF_NK_REC* regfi_parse_nk(REGF_FILE* file, uint32 offset,
368	uint32 max_size, bool strict);
369
370
371	/* Private Functions */
372	REGF_NK_REC* regfi_rootkey(REGF_FILE* file);
373	void regfi_key_free(REGF_NK_REC* nk);
374	uint32 regfi_read(int fd, uint8* buf, uint32* length);
375
376
377
378	/****************/
379	/* Experimental */
380	/****************/
381	REGF_NK_REC* regfi_load_key(REGF_FILE* file, uint32 offset, bool strict);
382
383	REGF_HASH_LIST* regfi_load_hashlist(REGF_FILE* file, uint32 offset,
384	uint32 num_keys, uint32 max_size,
385	bool strict);
386
387	REGF_VK_REC** regfi_load_valuelist(REGF_FILE* file, uint32 offset,
388	uint32 num_values, uint32 max_size,
389	bool strict);
390
391	REGF_VK_REC* regfi_parse_vk(REGF_FILE* file, uint32 offset,
392	uint32 max_size, bool strict);
393
394	uint8* regfi_parse_data(REGF_FILE* file, uint32 offset,
395	uint32 length, bool strict);
396
397
398	#endif /* _REGFI_H */

Note: See TracBrowser for help on using the repository browser.

Download in other formats: