source: trunk/include/regfi.h @ 165

Last change on this file since 165 was 165, checked in by tim, 14 years ago

added misc comments

  • Property svn:keywords set to Id
File size: 22.9 KB
RevLine 
[30]1/*
[134]2 * Branched from Samba project Subversion repository, version #6903:
[84]3 *   http://viewcvs.samba.org/cgi-bin/viewcvs.cgi/trunk/source/include/regfio.h?rev=6903&view=auto
[30]4 *
[134]5 * Windows NT (and later) registry parsing library
[30]6 *
[132]7 * Copyright (C) 2005-2009 Timothy D. Morgan
[30]8 * Copyright (C) 2005 Gerald (Jerry) Carter
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
[134]12 * the Free Software Foundation; version 3 of the License.
[30]13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 *
23 * $Id: regfi.h 165 2009-12-12 03:13:27Z tim $
24 */
25
26/************************************************************
27 * Most of this information was obtained from
28 * http://www.wednesday.demon.co.uk/dosreg.html
29 * Thanks Nigel!
30 ***********************************************************/
31
[78]32#ifndef _REGFI_H
33#define _REGFI_H
[30]34
[31]35#include <stdlib.h>
36#include <stdio.h>
[30]37#include <stdbool.h>
[136]38#include <stdarg.h>
[31]39#include <string.h>
[30]40#include <errno.h>
[31]41#include <time.h>
[30]42#include <fcntl.h>
43#include <sys/stat.h>
44#include <sys/types.h>
45#include <unistd.h>
46#include <assert.h>
[159]47#include <iconv.h>
[30]48
[147]49#include "talloc.h"
[30]50#include "smb_deps.h"
[132]51#include "winsec.h"
[78]52#include "void_stack.h"
[99]53#include "range_list.h"
[108]54#include "lru_cache.h"
[30]55
56/******************************************************************************/
[138]57
58/* regfi library error message types */
59#define REGFI_MSG_INFO  0x0001
60#define REGFI_MSG_WARN  0x0004
61#define REGFI_MSG_ERROR 0x0010
62
[161]63typedef uint8 REGFI_ENCODING;
64/* regfi library supported character encodings */
65#define REGFI_ENCODING_ASCII   0
66#define REGFI_ENCODING_UTF8    1
67#define REGFI_ENCODING_DEFAULT REGFI_ENCODING_ASCII
68/* UTF16LE is not supported for output */
69#define REGFI_ENCODING_UTF16LE 2
70
71#define REGFI_NUM_ENCODINGS    3
72
[143]73/* Windows is lame */
74#ifdef O_BINARY
75#define REGFI_OPEN_FLAGS O_RDONLY|O_BINARY
76#else
77#define REGFI_OPEN_FLAGS O_RDONLY
78#endif
79
[32]80/* Registry data types */
81#define REG_NONE                       0
82#define REG_SZ                         1
83#define REG_EXPAND_SZ                  2
84#define REG_BINARY                     3
85#define REG_DWORD                      4
[54]86#define REG_DWORD_LE                   4  /* DWORD, little endian */
87#define REG_DWORD_BE                   5  /* DWORD, big endian */
[32]88#define REG_LINK                       6
89#define REG_MULTI_SZ                   7
90#define REG_RESOURCE_LIST              8
91#define REG_FULL_RESOURCE_DESCRIPTOR   9
92#define REG_RESOURCE_REQUIREMENTS_LIST 10
[72]93#define REG_QWORD                      11 /* 64-bit little endian */
94/* XXX: Has MS defined a REG_QWORD_BE? */
[32]95/* Not a real type in the registry */
[136]96#define REG_KEY                    0x7FFFFFFF
[32]97
[135]98#define REGFI_OFFSET_NONE          0xffffffff
[30]99
[165]100
101/* This maximum depth is described here:
102 * http://msdn.microsoft.com/en-us/library/ms724872%28VS.85%29.aspx
103 */
104#define REGFI_MAX_DEPTH            512
105
106/* This limit defines the maximum number of levels deep that ri subkey list
107 * trees can go.
108 */
109/* XXX: This is totally arbitrary right now.
110 *      The actual limit may need to be discovered by experimentation.
111 */
[149]112#define REGFI_MAX_SUBKEY_DEPTH     255
[139]113
[165]114
[135]115/* Header sizes and magic number lengths for various records */
[147]116#define REGFI_HBIN_ALLOC           0x1000 /* Minimum allocation unit for HBINs */
117#define REGFI_REGF_SIZE            0x1000 /* "regf" header block size */
[135]118#define REGFI_REGF_MAGIC_SIZE      4
[151]119#define REGFI_REGF_NAME_SIZE       64
120#define REGFI_REGF_RESERVED1_SIZE  340
121#define REGFI_REGF_RESERVED2_SIZE  3528
[135]122#define REGFI_HBIN_MAGIC_SIZE      4
123#define REGFI_CELL_MAGIC_SIZE      2
124#define REGFI_HBIN_HEADER_SIZE     0x20
[116]125#define REGFI_NK_MIN_LENGTH        0x4C
126#define REGFI_VK_MIN_LENGTH        0x14
127#define REGFI_SK_MIN_LENGTH        0x14
[127]128#define REGFI_SUBKEY_LIST_MIN_LEN  0x4
[157]129#define REGFI_BIG_DATA_MIN_LENGTH  0xC
[30]130
[135]131
[116]132/* Constants used for validation */
[125]133/* XXX: Can we add clock resolution validation as well as range?  It has
134 *      been reported that Windows timestamps are never more than a
135 *      certain granularity (250ms?), which could be used to help
[147]136 *      eliminate false positives.  Would need to verify this and
[125]137 *      perhaps conservatively implement a check.
138 */
[116]139 /* Minimum time is Jan 1, 1990 00:00:00 */
140#define REGFI_MTIME_MIN_HIGH       0x01B41E6D
141#define REGFI_MTIME_MIN_LOW        0x26F98000
142 /* Maximum time is Jan 1, 2290 00:00:00
143  * (We hope no one is using Windows by then...)
144  */
145#define REGFI_MTIME_MAX_HIGH       0x03047543
146#define REGFI_MTIME_MAX_LOW        0xC80A4000
[30]147
[116]148
[30]149/* Flags for the vk records */
[162]150#define REGFI_VK_FLAG_ASCIINAME    0x0001
[135]151#define REGFI_VK_DATA_IN_OFFSET    0x80000000
[152]152#define REGFI_VK_MAX_DATA_LENGTH   1024*1024  /* XXX: This is arbitrary */
[30]153
[137]154
[152]155/* Known key flags */
156/*******************/
[137]157/* These next two show up on normal-seeming keys in Vista and W2K3 registries */
158#define REGFI_NK_FLAG_UNKNOWN1     0x4000
159#define REGFI_NK_FLAG_UNKNOWN2     0x1000
[152]160
[137]161/* This next one shows up on root keys in some Vista "software" registries */
162#define REGFI_NK_FLAG_UNKNOWN3     0x0080
[30]163
[152]164/* Predefined handle.  Rumor has it that the valuelist count for this key is
165 * where the handle is stored.
166 * http://msdn.microsoft.com/en-us/library/ms724836(VS.85).aspx
167 */
168#define REGFI_NK_FLAG_PREDEF_KEY   0x0040
[137]169
[152]170/* The name will be in ASCII if this next bit is set, otherwise UTF-16LE */
171#define REGFI_NK_FLAG_ASCIINAME    0x0020
172
173/* Symlink key. 
174 * See: http://www.codeproject.com/KB/system/regsymlink.aspx
175 */
176#define REGFI_NK_FLAG_LINK         0x0010
177
178/* This key cannot be deleted */
179#define REGFI_NK_FLAG_NO_RM        0x0008
180
181/* Root of a hive */
182#define REGFI_NK_FLAG_ROOT         0x0004
183
184/* Mount point of another hive.  NULL/(default) value indicates which hive
185 * and where in the hive it points to.
186 */
187#define REGFI_NK_FLAG_HIVE_LINK    0x0002
188
189/* These keys shouldn't be stored on disk, according to:
190 * http://geekswithblogs.net/sdorman/archive/2007/12/24/volatile-registry-keys.aspx
191 */
192#define REGFI_NK_FLAG_VOLATILE     0x0001
193
194/* Useful for identifying unknown flag types */
195#define REGFI_NK_KNOWN_FLAGS       (REGFI_NK_FLAG_PREDEF_KEY\
196                                    | REGFI_NK_FLAG_ASCIINAME\
197                                    | REGFI_NK_FLAG_LINK\
198                                    | REGFI_NK_FLAG_NO_RM\
199                                    | REGFI_NK_FLAG_ROOT\
200                                    | REGFI_NK_FLAG_HIVE_LINK\
201                                    | REGFI_NK_FLAG_VOLATILE\
202                                    | REGFI_NK_FLAG_UNKNOWN1\
203                                    | REGFI_NK_FLAG_UNKNOWN2)
204
[30]205/* HBIN block */
[135]206typedef struct _regfi_hbin
[97]207{
[53]208  uint32 file_off;       /* my offset in the registry file */
[84]209  uint32 ref_count;      /* how many active records are pointing to this
[54]210                          * block (not used currently)
211                          */
[84]212 
[53]213  uint32 first_hbin_off; /* offset from first hbin block */
[97]214  uint32 block_size;     /* block size of this block
215                          * Should be a multiple of 4096 (0x1000)
[54]216                          */
[99]217  uint32 next_block;     /* relative offset to next block. 
218                          * NOTE: This value may be unreliable!
[97]219                          */
220
[135]221  uint8 magic[REGFI_HBIN_MAGIC_SIZE]; /* "hbin" */
222} REGFI_HBIN;
[30]223
[97]224
[127]225/* Subkey List -- list of key offsets and hashed names for consistency */
[97]226typedef struct 
227{
[139]228  /* Virtual offset of NK record or additional subkey list,
229   * depending on this list's type.
230   */
231  uint32 offset;
232
[104]233  uint32 hash;
[135]234} REGFI_SUBKEY_LIST_ELEM;
[30]235
[97]236
[145]237typedef struct _regfi_subkey_list
[97]238{
[139]239  /* Real offset of this record's cell in the file */
240  uint32 offset;
241
242  uint32 cell_size;
243 
244  /* Number of immediate children */
245  uint32 num_children; 
246
247  /* Total number of keys referenced by this list and it's children */
248  uint32 num_keys;     
249
[135]250  REGFI_SUBKEY_LIST_ELEM* elements;
251  uint8 magic[REGFI_CELL_MAGIC_SIZE];
[139]252
253  /* Set if the magic indicates this subkey list points to child subkey lists */
254  bool recursive_type; 
[135]255} REGFI_SUBKEY_LIST;
[30]256
[97]257
[145]258typedef uint32 REGFI_VALUE_LIST_ELEM;
259typedef struct _regfi_value_list
260{
261  /* Actual number of values referenced by this list. 
262   * May differ from parent key's num_values if there were parsing errors.
263   */
264  uint32 num_values;
265
266  REGFI_VALUE_LIST_ELEM* elements;
267} REGFI_VALUE_LIST;
268
269
[160]270typedef struct _regfi_classname
271{
272  /* As converted to requested character encoding. */
273  char* interpreted;
274
275  /* Represents raw buffer read from classname cell. */
276  uint8* raw;
277
278  /* Length of the raw data. May be shorter than that indicated by parent key.*/
279  uint16 size;
280} REGFI_CLASSNAME;
281
282
[159]283typedef struct _regfi_data
284{
285  uint32 type;
286
287  /* Length of the raw data. */
288  uint32 size;
289
290  /* This is always present, representing the raw data cell contents. */
291  uint8* raw;
292
293  /* Represents the length of the interpreted value. Meaning is type-specific.*/
294  uint32 interpreted_size;
295
296  /* These items represent interpreted versions of the raw attribute above.
297   * Only use the appropriate member according to the type field. 
298   * In the event of an unknown type, use only the raw field.
299   */
300  union _regfi_data_interpreted
301  {
302    uint8* none; /* */
303    uint8* string;
304    uint8* expand_string;
305    uint8* binary; /* */
306    uint32 dword;
307    uint32 dword_be;
308    uint8* link;
309    uint8** multiple_string;
310    uint64 qword;
311
312    /* The following are treated as binary currently, but this may change in
313     * the future as the formats become better understood.
314     */
315    uint8* resource_list;
316    uint8* full_resource_descriptor;
317    uint8* resource_requirements_list;
318  } interpreted;
319} REGFI_DATA;
320
321
[150]322/* Value record */
[97]323typedef struct 
324{
[101]325  uint32 offset;        /* Real offset of this record's cell in the file */
326  uint32 cell_size;     /* ((start_offset - end_offset) & 0xfffffff8) */
327
[159]328  REGFI_DATA* data;     /* XXX: deprecated */
329
[150]330  char*  valuename;
[160]331  uint8* valuename_raw;
[101]332  uint16 name_length;
[53]333  uint32 hbin_off;      /* offset from beginning of this hbin block */
334 
[159]335  uint32 data_size;     /* As reported in the VK record.  May be different than
336                         * That obtained while parsing the data cell itself. */
337  uint32 data_off;      /* Offset of data cell (virtual) */
[53]338  uint32 type;
[135]339  uint8  magic[REGFI_CELL_MAGIC_SIZE];
[162]340  uint16 flags;
[101]341  uint16 unknown1;
[111]342  bool data_in_offset;
[135]343} REGFI_VK_REC;
[30]344
345
346/* Key Security */
[135]347struct _regfi_sk_rec;
[30]348
[135]349typedef struct _regfi_sk_rec
[97]350{
[111]351  uint32 offset;        /* Real file offset of this record */
352  uint32 cell_size;     /* ((start_offset - end_offset) & 0xfffffff8) */
353
[134]354  WINSEC_DESC* sec_desc;
[53]355  uint32 hbin_off;      /* offset from beginning of this hbin block */
356 
357  uint32 prev_sk_off;
358  uint32 next_sk_off;
359  uint32 ref_count;
[102]360  uint32 desc_size;     /* size of security descriptor */
361  uint16 unknown_tag;
[135]362  uint8  magic[REGFI_CELL_MAGIC_SIZE];
363} REGFI_SK_REC;
[30]364
[81]365
[104]366/* Key Name */
367typedef struct
[97]368{
[99]369  uint32 offset;        /* Real offset of this record's cell in the file */
370  uint32 cell_size;     /* Actual or estimated length of the cell. 
371                         * Always in multiples of 8.
372                         */
[84]373
374  /* link in the other records here */
[145]375  REGFI_VALUE_LIST* values;
[135]376  REGFI_SUBKEY_LIST* subkeys;
[53]377 
378  /* header information */
[161]379  uint16 flags;
[135]380  uint8  magic[REGFI_CELL_MAGIC_SIZE];
[53]381  NTTIME mtime;
[99]382  uint16 name_length;
383  uint16 classname_length;
[84]384  char* keyname;
[160]385  uint8* keyname_raw;
[125]386  uint32 parent_off;                /* pointer to parent key */
387  uint32 classname_off;
[53]388 
389  /* max lengths */
[54]390  uint32 max_bytes_subkeyname;      /* max subkey name * 2 */
391  uint32 max_bytes_subkeyclassname; /* max subkey classname length (as if) */
392  uint32 max_bytes_valuename;       /* max valuename * 2 */
393  uint32 max_bytes_value;           /* max value data size */
[53]394 
395  /* unknowns */
[99]396  uint32 unknown1;
397  uint32 unknown2;
398  uint32 unknown3;
[54]399  uint32 unk_index;                 /* nigel says run time index ? */
[53]400 
401  /* children */
402  uint32 num_subkeys;
[127]403  uint32 subkeys_off;   /* offset of subkey list that points to NK records */
[53]404  uint32 num_values;
405  uint32 values_off;    /* value lists which point to VK records */
[127]406  uint32 sk_off;        /* offset to SK record */
[135]407} REGFI_NK_REC;
[30]408
[81]409
[97]410
[30]411/* REGF block */
[97]412typedef struct 
413{
[135]414  /* Run-time information */
415  /************************/
[138]416  /* file descriptor */
417  int fd;
[99]418
[138]419  /* For sanity checking (not part of the registry header) */
420  uint32 file_length;
421
422  /* Metadata about hbins */
[99]423  range_list* hbins;
424
[146]425  /* SK record cached since they're repeatedly reused */
426  lru_cache* sk_cache;
427
[135]428  /* Error/warning/info messages returned by lower layer functions */
429  char* last_message;
430
[138]431  /* Mask for error message types that will be stored. */
432  uint16 msg_mask;
[135]433
434
435  /* Data parsed from file header */
436  /********************************/
437  uint8  magic[REGFI_REGF_MAGIC_SIZE];/* "regf" */
[151]438
439 /* These sequence numbers should match if
440  * the hive was properly synced to disk.
441  */
442  uint32 sequence1;           
443  uint32 sequence2;
444
[84]445  NTTIME mtime;
[152]446  uint32 major_version;  /* Set to 1 in all known hives */
447  uint32 minor_version;  /* Set to 3 or 5 in all known hives */
[151]448  uint32 type;           /* XXX: Unverified.  Set to 0 in all known hives */
449  uint32 format;         /* XXX: Unverified.  Set to 1 in all known hives */
[97]450
[151]451  uint32 root_cell;  /* Offset to root cell in the first (or any?) hbin block */
[152]452  uint32 last_block; /* Offset to last hbin block in file */
[151]453
454  uint32 cluster;    /* XXX: Unverified. Set to 1 in all known hives */
455
456  /* Matches hive's base file name. Stored in UTF-16LE */
457  uint8 file_name[REGFI_REGF_NAME_SIZE];
458
459  WINSEC_UUID* rm_id;       /* XXX: Unverified. */
460  WINSEC_UUID* log_id;      /* XXX: Unverified. */
461  WINSEC_UUID* tm_id;       /* XXX: Unverified. */
462  uint32 flags;             /* XXX: Unverified. */
463  uint32 guid_signature;    /* XXX: Unverified. */
464
465  uint32 checksum;          /* Stored checksum from file */
466  uint32 computed_checksum; /* Our own calculation of the checksum.
467                             * (XOR of bytes 0x0000 - 0x01FB) */
468
469  WINSEC_UUID* thaw_tm_id;  /* XXX: Unverified. */
470  WINSEC_UUID* thaw_rm_id;  /* XXX: Unverified. */
471  WINSEC_UUID* thaw_log_id; /* XXX: Unverified. */
472  uint32 boot_type;         /* XXX: Unverified. */
473  uint32 boot_recover;      /* XXX: Unverified. */
474
475  /* This seems to include random junk.  Possibly unsanitized memory left over
476   * from when header block was written.  For instance, chunks of nk records
477   * can be found, though often it's all 0s. */
478  uint8 reserved1[REGFI_REGF_RESERVED1_SIZE];
479
480  /* This is likely reserved and unusued currently.  (Should be all 0s.)
481   * Included here for easier access in looking for hidden data
482   * or doing research. */
483  uint8 reserved2[REGFI_REGF_RESERVED2_SIZE];
484
[135]485} REGFI_FILE;
[30]486
487
[151]488typedef struct _regfi_iterator
[97]489{
[135]490  REGFI_FILE* f;
[80]491  void_stack* key_positions;
[135]492  REGFI_NK_REC* cur_key;
[161]493  REGFI_ENCODING string_encoding;
[78]494  uint32 cur_subkey;
495  uint32 cur_value;
496} REGFI_ITERATOR;
497
[80]498
[151]499typedef struct _regfi_iter_position
[97]500{
[135]501  REGFI_NK_REC* nk;
[80]502  uint32 cur_subkey;
503  /* We could store a cur_value here as well, but didn't see
504   * the use in it right now.
505   */
506} REGFI_ITER_POSITION;
507
508
[151]509typedef struct _regfi_buffer
510{
511  uint8* buf;
512  uint32_t len;
513} REGFI_BUFFER;
514
515
[157]516
[159]517
[54]518/******************************************************************************/
[135]519/*                         Main iterator API                                  */
520/******************************************************************************/
521REGFI_FILE*           regfi_open(const char* filename);
522int                   regfi_close(REGFI_FILE* r);
[32]523
[136]524/* regfi_get_messages: Get errors, warnings, and/or verbose information
525 *                     relating to processing of the given registry file.
[135]526 *
527 * Arguments:
528 *   file     -- the structure for the registry file
529 *
530 * Returns:
531 *   A newly allocated char* which must be free()d by the caller.
532 */
[136]533char*                 regfi_get_messages(REGFI_FILE* file);
[159]534
[138]535void                  regfi_set_message_mask(REGFI_FILE* file, uint16 mask);
[53]536
[159]537
538/* regfi_iterator_new: Creates a new iterator for the provided registry file.
539 *
540 * Arguments:
541 *   file            -- The opened registry file the iterator should be
542 *                      created for.
[161]543 *   output_encoding -- Character encoding that strings should be returned in.
544 *                      Only supply the REGFI_ENCODING_* constants, as others
545 *                      will be rejected.
[159]546 *                      The following values are currently accepted:
[161]547 *                      REGFI_ENCODING_DEFAULT (currently REGFI_ENCODING_ASCII)
548 *                      REGFI_ENCODING_ASCII
549 *                      REGFI_ENCODING_UTF8
[159]550 *
551 *                      XXX: This encoding only applies to specific data
552 *                           strings currently, but should apply to key
553 *                           names and value names in the future.
554 *
555 * Returns:
556 *   A newly allocated REGFI_ITERATOR. Must be free()d with regfi_iterator_free.
557 */
558REGFI_ITERATOR*       regfi_iterator_new(REGFI_FILE* file,
[161]559                                         REGFI_ENCODING output_encoding);
[84]560void                  regfi_iterator_free(REGFI_ITERATOR* i);
561bool                  regfi_iterator_down(REGFI_ITERATOR* i);
562bool                  regfi_iterator_up(REGFI_ITERATOR* i);
563bool                  regfi_iterator_to_root(REGFI_ITERATOR* i);
[30]564
[84]565bool                  regfi_iterator_walk_path(REGFI_ITERATOR* i, 
566                                               const char** path);
[135]567const REGFI_NK_REC*   regfi_iterator_cur_key(REGFI_ITERATOR* i);
568const REGFI_SK_REC*   regfi_iterator_cur_sk(REGFI_ITERATOR* i);
[80]569
[150]570REGFI_NK_REC*         regfi_iterator_first_subkey(REGFI_ITERATOR* i);
571REGFI_NK_REC*         regfi_iterator_cur_subkey(REGFI_ITERATOR* i);
572REGFI_NK_REC*         regfi_iterator_next_subkey(REGFI_ITERATOR* i);
[157]573bool                  regfi_iterator_find_subkey(REGFI_ITERATOR* i, 
574                                                 const char* subkey_name);
[150]575
576REGFI_VK_REC*         regfi_iterator_first_value(REGFI_ITERATOR* i);
577REGFI_VK_REC*         regfi_iterator_cur_value(REGFI_ITERATOR* i);
578REGFI_VK_REC*         regfi_iterator_next_value(REGFI_ITERATOR* i);
[157]579bool                  regfi_iterator_find_value(REGFI_ITERATOR* i, 
580                                                const char* value_name);
[80]581
[160]582REGFI_CLASSNAME*      regfi_iterator_fetch_classname(REGFI_ITERATOR* i, 
583                                                     const REGFI_NK_REC* key);
[159]584REGFI_DATA*           regfi_iterator_fetch_data(REGFI_ITERATOR* i, 
585                                                const REGFI_VK_REC* value);
[127]586
[157]587
[127]588/********************************************************/
[146]589/* Middle-layer structure loading, linking, and caching */
[127]590/********************************************************/
[135]591REGFI_NK_REC*         regfi_load_key(REGFI_FILE* file, uint32 offset, 
[161]592                                     REGFI_ENCODING output_encoding, 
[135]593                                     bool strict);
[145]594REGFI_VK_REC*         regfi_load_value(REGFI_FILE* file, uint32 offset, 
[162]595                                       REGFI_ENCODING output_encoding, 
[145]596                                       bool strict);
[146]597REGFI_SUBKEY_LIST*    regfi_load_subkeylist(REGFI_FILE* file, uint32 offset,
598                                            uint32 num_keys, uint32 max_size,
599                                            bool strict);
[145]600REGFI_VALUE_LIST*     regfi_load_valuelist(REGFI_FILE* file, uint32 offset, 
[146]601                                           uint32 num_values, uint32 max_size,
[135]602                                           bool strict);
[127]603
[157]604REGFI_BUFFER          regfi_load_data(REGFI_FILE* file, uint32 voffset,
605                                      uint32 length, bool data_in_offset,
606                                      bool strict);
607
608REGFI_BUFFER          regfi_load_big_data(REGFI_FILE* file, uint32 offset, 
609                                          uint32 data_length,uint32 cell_length,
610                                          range_list* used_ranges,
611                                          bool strict);
[159]612bool                  regfi_interpret_data(REGFI_FILE* file, 
[161]613                                           REGFI_ENCODING string_encoding,
[159]614                                           uint32 type, REGFI_DATA* data);
[160]615void                  regfi_free_classname(REGFI_CLASSNAME* classname);
[159]616void                  regfi_free_data(REGFI_DATA* data);
[157]617
[160]618
[146]619/* These are cached so return values don't need to be freed. */
620const REGFI_SK_REC*   regfi_load_sk(REGFI_FILE* file, uint32 offset,
621                                    bool strict);
[157]622const REGFI_HBIN*     regfi_lookup_hbin(REGFI_FILE* file, uint32 offset);
[146]623
624
[99]625/************************************/
626/*  Low-layer data structure access */
627/************************************/
[135]628REGFI_FILE*           regfi_parse_regf(int fd, bool strict);
629REGFI_HBIN*           regfi_parse_hbin(REGFI_FILE* file, uint32 offset, 
[110]630                                       bool strict);
[80]631
[99]632
633/* regfi_parse_nk: Parses an NK record.
634 *
635 * Arguments:
636 *   f        -- the registry file structure
637 *   offset   -- the offset of the cell (not the record) to be parsed.
638 *   max_size -- the maximum size the NK cell could be. (for validation)
639 *   strict   -- if true, rejects any malformed records.  Otherwise,
640 *               tries to minimally validate integrity.
641 * Returns:
642 *   A newly allocated NK record structure, or NULL on failure.
643 */
[150]644REGFI_NK_REC*         regfi_parse_nk(REGFI_FILE* file, uint32 offset,
[99]645                                     uint32 max_size, bool strict);
646
[139]647REGFI_SUBKEY_LIST*    regfi_parse_subkeylist(REGFI_FILE* file, uint32 offset,
648                                             uint32 max_size, bool strict);
649
[135]650REGFI_VK_REC*         regfi_parse_vk(REGFI_FILE* file, uint32 offset, 
651                                     uint32 max_size, bool strict);
[103]652
[135]653REGFI_SK_REC*         regfi_parse_sk(REGFI_FILE* file, uint32 offset, 
654                                     uint32 max_size, bool strict);
[111]655
[135]656range_list*           regfi_parse_unalloc_cells(REGFI_FILE* file);
[101]657
[135]658bool                  regfi_parse_cell(int fd, uint32 offset, 
659                                       uint8* hdr, uint32 hdr_len,
660                                       uint32* cell_length, bool* unalloc);
[111]661
[160]662uint8*                regfi_parse_classname(REGFI_FILE* file, uint32 offset,
[135]663                                            uint16* name_length, 
664                                            uint32 max_size, bool strict);
[126]665
[157]666REGFI_BUFFER          regfi_parse_data(REGFI_FILE* file, uint32 offset,
667                                       uint32 length, bool strict);
668
669REGFI_BUFFER          regfi_parse_little_data(REGFI_FILE* file, uint32 voffset, 
670                                              uint32 length, bool strict);
671
672
[150]673/* Dispose of previously parsed records */
674void                  regfi_free_key(REGFI_NK_REC* nk);
675void                  regfi_free_value(REGFI_VK_REC* vk);
[127]676
[150]677
678
[135]679/************************************/
680/*    Private Functions             */
681/************************************/
[161]682REGFI_NK_REC*         regfi_rootkey(REGFI_FILE* file, 
683                                    REGFI_ENCODING output_encoding);
[135]684void                  regfi_subkeylist_free(REGFI_SUBKEY_LIST* list);
[127]685uint32                regfi_read(int fd, uint8* buf, uint32* length);
686
[135]687const char*           regfi_type_val2str(unsigned int val);
688int                   regfi_type_str2val(const char* str);
[127]689
[135]690char*                 regfi_get_sacl(WINSEC_DESC* sec_desc);
691char*                 regfi_get_dacl(WINSEC_DESC* sec_desc);
692char*                 regfi_get_owner(WINSEC_DESC* sec_desc);
693char*                 regfi_get_group(WINSEC_DESC* sec_desc);
694
695REGFI_SUBKEY_LIST*    regfi_merge_subkeylists(uint16 num_lists, 
696                                              REGFI_SUBKEY_LIST** lists,
697                                              bool strict);
[139]698REGFI_SUBKEY_LIST*    regfi_load_subkeylist_aux(REGFI_FILE* file, uint32 offset,
699                                                uint32 max_size, bool strict,
700                                                uint8 depth_left);
[138]701void                  regfi_add_message(REGFI_FILE* file, uint16 msg_type, 
702                                        const char* fmt, ...);
[146]703REGFI_NK_REC*         regfi_copy_nk(const REGFI_NK_REC* nk);
704REGFI_VK_REC*         regfi_copy_vk(const REGFI_VK_REC* vk);
[157]705int32                 regfi_calc_maxsize(REGFI_FILE* file, uint32 offset);
[161]706int32                 regfi_conv_charset(const char* input_charset, 
707                                         const char* output_charset,
[159]708                                         uint8* input, char* output, 
709                                         uint32 input_len, uint32 output_max);
710REGFI_DATA*           regfi_buffer_to_data(REGFI_BUFFER raw_data);
[146]711
[78]712#endif  /* _REGFI_H */
Note: See TracBrowser for help on using the repository browser.