source: trunk/include/regfi.h @ 126

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

improved validation and output of key class names, MULTI_SZ and other unicode strings, and improved warnings and other error messages.
  • Property svn:keywords set to Id
File size: 12.4 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 126 2008-08-19 23:31:33Z 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#define REGF_MAGIC_SIZE            4
80#define HBIN_MAGIC_SIZE            4
81#define HBIN_HEADER_REC_SIZE       0x20
82#define REC_HDR_SIZE               2
83
84#define REGF_OFFSET_NONE           0xffffffff
85#define REGFI_NK_MIN_LENGTH        0x4C
86#define REGFI_VK_MIN_LENGTH        0x14
87#define REGFI_SK_MIN_LENGTH        0x14
88#define REGFI_HASH_LIST_MIN_LENGTH 0x4
89
90/* Constants used for validation */
91/* XXX: Can we add clock resolution validation as well as range?  It has
92 *      been reported that Windows timestamps are never more than a
93 *      certain granularity (250ms?), which could be used to help
94 *      eliminate false positives.  Would need to validate this and
95 *      perhaps conservatively implement a check.
96 */
97 /* Minimum time is Jan 1, 1990 00:00:00 */
98#define REGFI_MTIME_MIN_HIGH       0x01B41E6D
99#define REGFI_MTIME_MIN_LOW        0x26F98000
100 /* Maximum time is Jan 1, 2290 00:00:00
101  * (We hope no one is using Windows by then...)
102  */
103#define REGFI_MTIME_MAX_HIGH       0x03047543
104#define REGFI_MTIME_MAX_LOW        0xC80A4000
105
106
107/* Flags for the vk records */
108#define VK_FLAG_NAME_PRESENT       0x0001
109#define VK_DATA_IN_OFFSET          0x80000000
110#define VK_MAX_DATA_LENGTH         1024*1024
111
112/* NK record types */
113#define NK_TYPE_LINKKEY            0x0010
114#define NK_TYPE_NORMALKEY          0x0020
115#define NK_TYPE_ROOTKEY            0x002c
116 /* XXX: Unknown type that shows up in Vista registries */
117#define NK_TYPE_UNKNOWN1           0x1020
118
119
120/* HBIN block */
121typedef struct regf_hbin
122{
123  uint32 file_off;       /* my offset in the registry file */
124  uint32 ref_count;      /* how many active records are pointing to this
125                          * block (not used currently)
126                          */
127 
128  uint32 first_hbin_off; /* offset from first hbin block */
129  uint32 block_size;     /* block size of this block
130                          * Should be a multiple of 4096 (0x1000)
131                          */
132  uint32 next_block;     /* relative offset to next block. 
133                          * NOTE: This value may be unreliable!
134                          */
135
136  uint8 magic[HBIN_MAGIC_SIZE]; /* "hbin" */
137} REGF_HBIN;
138
139
140/* Hash List -- list of key offsets and hashed names for consistency */
141typedef struct 
142{
143  uint32 nk_off;
144  uint32 hash;
145} REGF_HASH_LIST_ELEM;
146
147
148typedef struct 
149{
150  uint32 offset;        /* Real offset of this record's cell in the file */
151  uint32 cell_size;      /* ((start_offset - end_offset) & 0xfffffff8) */
152  REGF_HBIN* hbin;       /* pointer to HBIN record (in memory) containing
153                          * this nk record
154                          */
155  uint32 hbin_off;       /* offset from beginning of this hbin block */
156  REGF_HASH_LIST_ELEM* hashes;
157 
158  uint8 magic[REC_HDR_SIZE];
159  uint16 num_keys;
160} REGF_HASH_LIST;
161
162
163/* Key Value */
164typedef struct 
165{
166  uint32 offset;        /* Real offset of this record's cell in the file */
167  uint32 cell_size;     /* ((start_offset - end_offset) & 0xfffffff8) */
168
169  REGF_HBIN* hbin;      /* pointer to HBIN record (in memory) containing
170                         * this nk record
171                         */
172  uint8* data;
173  uint16 name_length;
174  char*  valuename;
175  uint32 hbin_off;      /* offset from beginning of this hbin block */
176 
177  uint32 data_size;
178  uint32 data_off;      /* offset of data cell (virtual) */
179  uint32 type;
180  uint8  magic[REC_HDR_SIZE];
181  uint16 flag;
182  uint16 unknown1;
183  bool data_in_offset;
184} REGF_VK_REC;
185
186
187/* Key Security */
188struct _regf_sk_rec;
189
190typedef struct _regf_sk_rec
191{
192  uint32 offset;        /* Real file offset of this record */
193  uint32 cell_size;     /* ((start_offset - end_offset) & 0xfffffff8) */
194
195  SEC_DESC* sec_desc;
196  uint32 hbin_off;      /* offset from beginning of this hbin block */
197 
198  uint32 sk_off;        /* offset parsed from NK record used as a key
199                         * to lookup reference to this SK record
200                         */
201 
202  uint32 prev_sk_off;
203  uint32 next_sk_off;
204  uint32 ref_count;
205  uint32 desc_size;     /* size of security descriptor */
206  uint16 unknown_tag;
207  uint8  magic[REC_HDR_SIZE];
208} REGF_SK_REC;
209
210
211/* Key Name */
212typedef struct
213{
214  uint32 offset;        /* Real offset of this record's cell in the file */
215  uint32 cell_size;     /* Actual or estimated length of the cell. 
216                         * Always in multiples of 8.
217                         */
218
219  /* link in the other records here */
220  REGF_VK_REC** values;
221  REGF_HASH_LIST* subkeys;
222 
223  /* header information */
224  uint16 key_type;
225  uint8  magic[REC_HDR_SIZE];
226  NTTIME mtime;
227  uint16 name_length;
228  uint16 classname_length;
229  char* classname;
230  char* keyname;
231  uint32 parent_off;                /* pointer to parent key */
232  uint32 classname_off;
233 
234  /* max lengths */
235  uint32 max_bytes_subkeyname;      /* max subkey name * 2 */
236  uint32 max_bytes_subkeyclassname; /* max subkey classname length (as if) */
237  uint32 max_bytes_valuename;       /* max valuename * 2 */
238  uint32 max_bytes_value;           /* max value data size */
239 
240  /* unknowns */
241  uint32 unknown1;
242  uint32 unknown2;
243  uint32 unknown3;
244  uint32 unk_index;                 /* nigel says run time index ? */
245 
246  /* children */
247  uint32 num_subkeys;
248  uint32 subkeys_off;   /* hash records that point to NK records */     
249  uint32 num_values;
250  uint32 values_off;    /* value lists which point to VK records */
251  uint32 sk_off;        /* offset to SK record */ 
252} REGF_NK_REC;
253
254
255
256/* REGF block */
257typedef struct 
258{
259  /* run time information */
260  int fd;         /* file descriptor */
261  /* For sanity checking (not part of the registry header) */
262  uint32 file_length;
263  void* mem_ctx;  /* memory context for run-time file access information */
264
265  /* Experimental hbin lists */
266  range_list* hbins;
267
268  /* file format information */ 
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
293typedef struct 
294{
295  REGF_FILE* f;
296  void_stack* key_positions;
297  lru_cache* sk_recs;
298  REGF_NK_REC* cur_key;
299  uint32 cur_subkey;
300  uint32 cur_value;
301} REGFI_ITERATOR;
302
303
304typedef struct 
305{
306  REGF_NK_REC* nk;
307  uint32 cur_subkey;
308  /* We could store a cur_value here as well, but didn't see
309   * the use in it right now.
310   */
311} REGFI_ITER_POSITION;
312
313
314/******************************************************************************/
315/* Function Declarations */
316/*  Main API */
317const char*           regfi_type_val2str(unsigned int val);
318int                   regfi_type_str2val(const char* str);
319
320char*                 regfi_get_sacl(SEC_DESC* sec_desc);
321char*                 regfi_get_dacl(SEC_DESC* sec_desc);
322char*                 regfi_get_owner(SEC_DESC* sec_desc);
323char*                 regfi_get_group(SEC_DESC* sec_desc);
324
325REGF_FILE*            regfi_open(const char* filename);
326int                   regfi_close(REGF_FILE* r);
327
328REGFI_ITERATOR*       regfi_iterator_new(REGF_FILE* fh);
329void                  regfi_iterator_free(REGFI_ITERATOR* i);
330bool                  regfi_iterator_down(REGFI_ITERATOR* i);
331bool                  regfi_iterator_up(REGFI_ITERATOR* i);
332bool                  regfi_iterator_to_root(REGFI_ITERATOR* i);
333
334bool                  regfi_iterator_find_subkey(REGFI_ITERATOR* i, 
335                                                 const char* subkey_name);
336bool                  regfi_iterator_walk_path(REGFI_ITERATOR* i, 
337                                               const char** path);
338const REGF_NK_REC*    regfi_iterator_cur_key(REGFI_ITERATOR* i);
339const REGF_SK_REC*    regfi_iterator_cur_sk(REGFI_ITERATOR* i);
340const REGF_NK_REC*    regfi_iterator_first_subkey(REGFI_ITERATOR* i);
341const REGF_NK_REC*    regfi_iterator_cur_subkey(REGFI_ITERATOR* i);
342const REGF_NK_REC*    regfi_iterator_next_subkey(REGFI_ITERATOR* i);
343
344bool                  regfi_iterator_find_value(REGFI_ITERATOR* i, 
345                                                const char* value_name);
346const REGF_VK_REC*    regfi_iterator_first_value(REGFI_ITERATOR* i);
347const REGF_VK_REC*    regfi_iterator_cur_value(REGFI_ITERATOR* i);
348const REGF_VK_REC*    regfi_iterator_next_value(REGFI_ITERATOR* i);
349
350/************************************/
351/*  Low-layer data structure access */
352/************************************/
353REGF_FILE*            regfi_parse_regf(int fd, bool strict);
354REGF_HBIN*            regfi_parse_hbin(REGF_FILE* file, uint32 offset, 
355                                       bool strict);
356
357
358/* regfi_parse_nk: Parses an NK record.
359 *
360 * Arguments:
361 *   f        -- the registry file structure
362 *   offset   -- the offset of the cell (not the record) to be parsed.
363 *   max_size -- the maximum size the NK cell could be. (for validation)
364 *   strict   -- if true, rejects any malformed records.  Otherwise,
365 *               tries to minimally validate integrity.
366 * Returns:
367 *   A newly allocated NK record structure, or NULL on failure.
368 */
369REGF_NK_REC*          regfi_parse_nk(REGF_FILE* file, uint32 offset, 
370                                     uint32 max_size, bool strict);
371
372
373/* Private Functions */
374REGF_NK_REC*          regfi_rootkey(REGF_FILE* file);
375void                  regfi_key_free(REGF_NK_REC* nk);
376uint32                regfi_read(int fd, uint8* buf, uint32* length);
377
378
379
380/****************/
381/* Experimental */
382/****************/
383REGF_NK_REC* regfi_load_key(REGF_FILE* file, uint32 offset, bool strict);
384
385REGF_HASH_LIST* regfi_load_hashlist(REGF_FILE* file, uint32 offset, 
386                                    uint32 num_keys, uint32 max_size, 
387                                    bool strict);
388
389REGF_VK_REC** regfi_load_valuelist(REGF_FILE* file, uint32 offset, 
390                                   uint32 num_values, uint32 max_size, 
391                                   bool strict);
392
393REGF_VK_REC* regfi_parse_vk(REGF_FILE* file, uint32 offset, 
394                            uint32 max_size, bool strict);
395
396uint8* regfi_parse_data(REGF_FILE* file, uint32 offset, 
397                        uint32 length, bool strict);
398
399REGF_SK_REC* regfi_parse_sk(REGF_FILE* file, uint32 offset, uint32 max_size, bool strict);
400
401range_list* regfi_parse_unalloc_cells(REGF_FILE* file);
402
403REGF_HBIN* regfi_lookup_hbin(REGF_FILE* file, uint32 offset);
404
405bool regfi_parse_cell(int fd, uint32 offset, uint8* hdr, uint32 hdr_len,
406                      uint32* cell_length, bool* unalloc);
407
408char* regfi_parse_classname(REGF_FILE* file, uint32 offset,
409                            uint16* name_length, bool strict);
410
411#endif  /* _REGFI_H */
Note: See TracBrowser for help on using the repository browser.