source: trunk/include/regfi.h @ 110

Last change on this file since 110 was 110, checked in by tim, 16 years ago

moved unallocated cell parsing back out of the main line hbin parsing
  • 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 110 2008-04-29 22:59:55Z 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#include "lru_cache.h"
52
53/******************************************************************************/
54/* Macros */
55 
56/* Registry data types */
57#define REG_NONE                       0
58#define REG_SZ                         1
59#define REG_EXPAND_SZ                  2
60#define REG_BINARY                     3
61#define REG_DWORD                      4
62#define REG_DWORD_LE                   4  /* DWORD, little endian */
63#define REG_DWORD_BE                   5  /* DWORD, big endian */
64#define REG_LINK                       6
65#define REG_MULTI_SZ                   7
66#define REG_RESOURCE_LIST              8
67#define REG_FULL_RESOURCE_DESCRIPTOR   9
68#define REG_RESOURCE_REQUIREMENTS_LIST 10
69#define REG_QWORD                      11 /* 64-bit little endian */
70/* XXX: Has MS defined a REG_QWORD_BE? */
71/* Not a real type in the registry */
72#define REG_KEY                        0x7FFFFFFF
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 */
111typedef 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 */
131typedef struct 
132{
133  uint32 nk_off;
134  uint32 hash;
135} REGF_HASH_LIST_ELEM;
136
137
138typedef 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 */
154typedef 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 */
177struct _regf_sk_rec;
178
179typedef struct _regf_sk_rec
180{
181  REGF_HBIN* hbin;      /* pointer to HBIN record (in memory) containing
182                         * this nk record
183                         */
184  SEC_DESC* sec_desc;
185  uint32 hbin_off;      /* offset from beginning of this hbin block */
186  uint32 cell_size;     /* ((start_offset - end_offset) & 0xfffffff8) */
187  uint32 offset;        /* Real file offset of this record */
188 
189  uint32 sk_off;        /* offset parsed from NK record used as a key
190                         * to lookup reference to this SK record
191                         */
192 
193  uint32 prev_sk_off;
194  uint32 next_sk_off;
195  uint32 ref_count;
196  uint32 desc_size;     /* size of security descriptor */
197  uint16 unknown_tag;
198  uint8  magic[REC_HDR_SIZE];
199} REGF_SK_REC;
200
201
202/* Key Name */
203typedef struct
204{
205  uint32 offset;        /* Real offset of this record's cell in the file */
206  uint32 cell_size;     /* Actual or estimated length of the cell. 
207                         * Always in multiples of 8.
208                         */
209
210  /* link in the other records here */
211  REGF_VK_REC** values;
212  REGF_HASH_LIST* subkeys;
213 
214  /* header information */
215  /* XXX: should we be looking for types other than the root key type? */
216  uint16 key_type;     
217  uint8  magic[REC_HDR_SIZE];
218  NTTIME mtime;
219  uint16 name_length;
220  uint16 classname_length;
221  char* classname;
222  char* keyname;
223  uint32 parent_off;    /* back pointer in registry hive */
224  uint32 classname_off; 
225 
226  /* max lengths */
227  uint32 max_bytes_subkeyname;      /* max subkey name * 2 */
228  uint32 max_bytes_subkeyclassname; /* max subkey classname length (as if) */
229  uint32 max_bytes_valuename;       /* max valuename * 2 */
230  uint32 max_bytes_value;           /* max value data size */
231 
232  /* unknowns */
233  uint32 unknown1;
234  uint32 unknown2;
235  uint32 unknown3;
236  uint32 unk_index;                 /* nigel says run time index ? */
237 
238  /* children */
239  uint32 num_subkeys;
240  uint32 subkeys_off;   /* hash records that point to NK records */     
241  uint32 num_values;
242  uint32 values_off;    /* value lists which point to VK records */
243  uint32 sk_off;        /* offset to SK record */ 
244} REGF_NK_REC;
245
246
247
248/* REGF block */
249typedef struct 
250{
251  /* run time information */
252  int fd;         /* file descriptor */
253  /* For sanity checking (not part of the registry header) */
254  uint32 file_length;
255  void* mem_ctx;  /* memory context for run-time file access information */
256
257  /* Experimental hbin lists */
258  range_list* hbins;
259
260  /* file format information */ 
261  uint8  magic[REGF_MAGIC_SIZE];/* "regf" */
262  NTTIME mtime;
263  uint32 data_offset;           /* offset to record in the first (or any?)
264                                 * hbin block
265                                 */
266  uint32 last_block;            /* offset to last hbin block in file */
267
268  uint32 checksum;              /* Stored checksum. */
269  uint32 computed_checksum;     /* Our own calculation of the checksum.
270                                 * (XOR of bytes 0x0000 - 0x01FB)
271                                 */
272 
273  /* unknown data structure values */
274  uint32 unknown1;
275  uint32 unknown2;
276  uint32 unknown3;
277  uint32 unknown4;
278  uint32 unknown5;
279  uint32 unknown6;
280  uint32 unknown7;
281} REGF_FILE;
282
283
284
285typedef struct 
286{
287  REGF_FILE* f;
288  void_stack* key_positions;
289  lru_cache* sk_recs;
290  REGF_NK_REC* cur_key;
291  uint32 cur_subkey;
292  uint32 cur_value;
293} REGFI_ITERATOR;
294
295
296typedef struct 
297{
298  REGF_NK_REC* nk;
299  uint32 cur_subkey;
300  /* We could store a cur_value here as well, but didn't see
301   * the use in it right now.
302   */
303} REGFI_ITER_POSITION;
304
305
306/******************************************************************************/
307/* Function Declarations */
308/*  Main API */
309const char*           regfi_type_val2str(unsigned int val);
310int                   regfi_type_str2val(const char* str);
311
312char*                 regfi_get_sacl(SEC_DESC* sec_desc);
313char*                 regfi_get_dacl(SEC_DESC* sec_desc);
314char*                 regfi_get_owner(SEC_DESC* sec_desc);
315char*                 regfi_get_group(SEC_DESC* sec_desc);
316
317REGF_FILE*            regfi_open(const char* filename);
318int                   regfi_close(REGF_FILE* r);
319
320REGFI_ITERATOR*       regfi_iterator_new(REGF_FILE* fh);
321void                  regfi_iterator_free(REGFI_ITERATOR* i);
322bool                  regfi_iterator_down(REGFI_ITERATOR* i);
323bool                  regfi_iterator_up(REGFI_ITERATOR* i);
324bool                  regfi_iterator_to_root(REGFI_ITERATOR* i);
325
326bool                  regfi_iterator_find_subkey(REGFI_ITERATOR* i, 
327                                                 const char* subkey_name);
328bool                  regfi_iterator_walk_path(REGFI_ITERATOR* i, 
329                                               const char** path);
330const REGF_NK_REC*    regfi_iterator_cur_key(REGFI_ITERATOR* i);
331const REGF_SK_REC*    regfi_iterator_cur_sk(REGFI_ITERATOR* i);
332const REGF_NK_REC*    regfi_iterator_first_subkey(REGFI_ITERATOR* i);
333const REGF_NK_REC*    regfi_iterator_cur_subkey(REGFI_ITERATOR* i);
334const REGF_NK_REC*    regfi_iterator_next_subkey(REGFI_ITERATOR* i);
335
336bool                  regfi_iterator_find_value(REGFI_ITERATOR* i, 
337                                                const char* value_name);
338const REGF_VK_REC*    regfi_iterator_first_value(REGFI_ITERATOR* i);
339const REGF_VK_REC*    regfi_iterator_cur_value(REGFI_ITERATOR* i);
340const REGF_VK_REC*    regfi_iterator_next_value(REGFI_ITERATOR* i);
341
342/************************************/
343/*  Low-layer data structure access */
344/************************************/
345REGF_FILE*            regfi_parse_regf(int fd, bool strict);
346REGF_HBIN*            regfi_parse_hbin(REGF_FILE* file, uint32 offset, 
347                                       bool strict);
348
349
350/* regfi_parse_nk: Parses an NK record.
351 *
352 * Arguments:
353 *   f        -- the registry file structure
354 *   offset   -- the offset of the cell (not the record) to be parsed.
355 *   max_size -- the maximum size the NK cell could be. (for validation)
356 *   strict   -- if true, rejects any malformed records.  Otherwise,
357 *               tries to minimally validate integrity.
358 * Returns:
359 *   A newly allocated NK record structure, or NULL on failure.
360 */
361REGF_NK_REC*          regfi_parse_nk(REGF_FILE* file, uint32 offset, 
362                                     uint32 max_size, bool strict);
363
364
365/* Private Functions */
366REGF_NK_REC*          regfi_rootkey(REGF_FILE* file);
367void                  regfi_key_free(REGF_NK_REC* nk);
368uint32                regfi_read(int fd, uint8* buf, uint32* length);
369
370
371
372/****************/
373/* Experimental */
374/****************/
375REGF_NK_REC* regfi_load_key(REGF_FILE* file, uint32 offset, bool strict);
376
377REGF_HASH_LIST* regfi_load_hashlist(REGF_FILE* file, uint32 offset, 
378                                    uint32 num_keys, uint32 max_size, 
379                                    bool strict);
380
381REGF_VK_REC** regfi_load_valuelist(REGF_FILE* file, uint32 offset, 
382                                   uint32 num_values, uint32 max_size, 
383                                   bool strict);
384
385REGF_VK_REC* regfi_parse_vk(REGF_FILE* file, uint32 offset, 
386                            uint32 max_size, bool strict);
387
388uint8* regfi_parse_data(REGF_FILE* file, uint32 offset, 
389                        uint32 length, bool strict);
390
391range_list* regfi_parse_unalloc_cells(REGF_FILE* file);
392
393#endif  /* _REGFI_H */
Note: See TracBrowser for help on using the repository browser.