source: trunk/include/regfi.h @ 99

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

fixed a range_list bug

replaced NK parsing routine
  • Property svn:keywords set to Id
File size: 10.9 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-2007 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 99 2008-03-04 00:38:48Z 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     0x50
87
88/* Flags for the vk records */
89
90#define VK_FLAG_NAME_PRESENT    0x0001
91#define VK_DATA_IN_OFFSET       0x80000000
92#define VK_MAX_DATA_LENGTH      1024*1024
93
94/* NK record macros */
95
96#define NK_TYPE_LINKKEY         0x0010
97#define NK_TYPE_NORMALKEY       0x0020
98#define NK_TYPE_ROOTKEY         0x002c
99
100#define HBIN_STORE_REF(x, y) { x->hbin = y; y->ref_count++ };
101/* if the count == 0; we can clean up */
102#define HBIN_REMOVE_REF(x, y){ x->hbin = NULL; y->ref_count-- };
103
104
105/* HBIN block */
106struct regf_hbin;
107typedef struct regf_hbin
108{
109  struct regf_hbin* prev;
110  struct regf_hbin* next;
111  uint32 file_off;       /* my offset in the registry file */
112  uint32 ref_count;      /* how many active records are pointing to this
113                          * block (not used currently)
114                          */
115 
116  uint32 first_hbin_off; /* offset from first hbin block */
117  uint32 block_size;     /* block size of this block
118                          * Should be a multiple of 4096 (0x1000)
119                          */
120  uint32 next_block;     /* relative offset to next block. 
121                          * NOTE: This value may be unreliable!
122                          */
123
124  uint8 magic[HBIN_MAGIC_SIZE]; /* "hbin" */
125  prs_struct ps;         /* data */
126} REGF_HBIN;
127
128
129/* Hash List -- list of key offsets and hashed names for consistency */
130typedef struct 
131{
132  uint32 nk_off;
133  uint8 keycheck[4];
134} REGF_HASH_REC;
135
136
137typedef struct 
138{
139  REGF_HBIN* hbin;       /* pointer to HBIN record (in memory) containing
140                          * this nk record
141                          */
142  REGF_HASH_REC* hashes;
143  uint32 hbin_off;       /* offset from beginning of this hbin block */
144  uint32 cell_size;      /* ((start_offset - end_offset) & 0xfffffff8) */
145 
146  uint8 header[REC_HDR_SIZE];
147  uint16 num_keys;
148} REGF_LF_REC;
149
150
151/* Key Value */
152typedef struct 
153{
154  REGF_HBIN* hbin;      /* pointer to HBIN record (in memory) containing
155                         * this nk record
156                         */
157  char*  valuename;
158  uint8* data;
159  uint32 hbin_off;      /* offset from beginning of this hbin block */
160  uint32 cell_size;     /* ((start_offset - end_offset) & 0xfffffff8) */
161  uint32 rec_off;       /* offset stored in the value list */
162 
163  uint32 data_size;
164  uint32 data_off;
165  uint32 type;
166  uint8  header[REC_HDR_SIZE];
167  uint16 flag;
168} REGF_VK_REC;
169
170
171/* Key Security */
172struct _regf_sk_rec;
173
174typedef struct _regf_sk_rec
175{
176  struct _regf_sk_rec* next;
177  struct _regf_sk_rec* prev;
178  REGF_HBIN* hbin;      /* pointer to HBIN record (in memory) containing
179                         * this nk record
180                         */
181  SEC_DESC* sec_desc;
182  uint32 hbin_off;      /* offset from beginning of this hbin block */
183  uint32 cell_size;     /* ((start_offset - end_offset) & 0xfffffff8) */
184 
185  uint32 sk_off;        /* offset parsed from NK record used as a key
186                         * to lookup reference to this SK record
187                         */
188 
189  uint32 prev_sk_off;
190  uint32 next_sk_off;
191  uint32 ref_count;
192  uint32 size;
193  uint8  header[REC_HDR_SIZE];
194} REGF_SK_REC;
195
196
197/* Key Name */ 
198typedef struct 
199{
200  uint32 offset;        /* Real offset of this record's cell in the file */
201  uint32 cell_size;     /* Actual or estimated length of the cell. 
202                         * Always in multiples of 8.
203                         */
204
205  /* link in the other records here */
206  REGF_VK_REC* values;
207  REGF_SK_REC* sec_desc;
208  REGF_LF_REC subkeys;
209 
210  /* header information */
211  /* XXX: should we be looking for types other than the root key type? */
212  uint16 key_type;     
213  uint8  header[REC_HDR_SIZE];
214  NTTIME mtime;
215  uint16 name_length;
216  uint16 classname_length;
217  char* classname;
218  char* keyname;
219  uint32 parent_off;    /* back pointer in registry hive */
220  uint32 classname_off; 
221 
222  /* max lengths */
223  uint32 max_bytes_subkeyname;      /* max subkey name * 2 */
224  uint32 max_bytes_subkeyclassname; /* max subkey classname length (as if) */
225  uint32 max_bytes_valuename;       /* max valuename * 2 */
226  uint32 max_bytes_value;           /* max value data size */
227 
228  /* unknowns */
229  uint32 unknown1;
230  uint32 unknown2;
231  uint32 unknown3;
232  uint32 unk_index;                 /* nigel says run time index ? */
233 
234  /* children */
235  uint32 num_subkeys;
236  uint32 subkeys_off;   /* hash records that point to NK records */     
237  uint32 num_values;
238  uint32 values_off;    /* value lists which point to VK records */
239  uint32 sk_off;        /* offset to SK record */ 
240} REGF_NK_REC;
241
242
243
244/* REGF block */
245typedef struct 
246{
247  /* run time information */
248  int fd;         /* file descriptor */
249  /* For sanity checking (not part of the registry header) */
250  uint32 file_length;
251  void* mem_ctx;  /* memory context for run-time file access information */
252  REGF_HBIN* block_list; /* list of open hbin blocks */
253
254  /* Experimental hbin lists */
255  range_list* hbins;
256  range_list* unalloc_cells;
257
258  /* file format information */
259  REGF_SK_REC* sec_desc_list;   /* list of security descriptors referenced
260                                 * by NK records
261                                 */
262 
263  uint8  magic[REGF_MAGIC_SIZE];/* "regf" */
264  NTTIME mtime;
265  uint32 data_offset;           /* offset to record in the first (or any?)
266                                 * hbin block
267                                 */
268  uint32 last_block;            /* offset to last hbin block in file */
269
270  uint32 checksum;              /* Stored checksum. */
271  uint32 computed_checksum;     /* Our own calculation of the checksum.
272                                 * (XOR of bytes 0x0000 - 0x01FB)
273                                 */
274 
275  /* unknown data structure values */
276  uint32 unknown1;
277  uint32 unknown2;
278  uint32 unknown3;
279  uint32 unknown4;
280  uint32 unknown5;
281  uint32 unknown6;
282  uint32 unknown7;
283} REGF_FILE;
284
285
286
287typedef struct 
288{
289  REGF_FILE* f;
290  void_stack* key_positions;
291  REGF_NK_REC* cur_key;
292  uint32 cur_subkey;
293  uint32 cur_value;
294} REGFI_ITERATOR;
295
296
297typedef struct 
298{
299  REGF_NK_REC* nk;
300  uint32 cur_subkey;
301  /* We could store a cur_value here as well, but didn't see
302   * the use in it right now.
303   */
304} REGFI_ITER_POSITION;
305
306
307/******************************************************************************/
308/* Function Declarations */
309/*  Main API */
310const char*           regfi_type_val2str(unsigned int val);
311int                   regfi_type_str2val(const char* str);
312
313char*                 regfi_get_sacl(SEC_DESC* sec_desc);
314char*                 regfi_get_dacl(SEC_DESC* sec_desc);
315char*                 regfi_get_owner(SEC_DESC* sec_desc);
316char*                 regfi_get_group(SEC_DESC* sec_desc);
317
318REGF_FILE*            regfi_open(const char* filename);
319int                   regfi_close(REGF_FILE* r);
320
321REGFI_ITERATOR*       regfi_iterator_new(REGF_FILE* fh);
322void                  regfi_iterator_free(REGFI_ITERATOR* i);
323bool                  regfi_iterator_down(REGFI_ITERATOR* i);
324bool                  regfi_iterator_up(REGFI_ITERATOR* i);
325bool                  regfi_iterator_to_root(REGFI_ITERATOR* i);
326
327bool                  regfi_iterator_find_subkey(REGFI_ITERATOR* i, 
328                                                 const char* subkey_name);
329bool                  regfi_iterator_walk_path(REGFI_ITERATOR* i, 
330                                               const char** path);
331const REGF_NK_REC*    regfi_iterator_cur_key(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, bool save_unalloc);
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/****************/
375
376
377#endif  /* _REGFI_H */
Note: See TracBrowser for help on using the repository browser.