source: trunk/include/regfio.h @ 60

Last change on this file since 60 was 54, checked in by tim, 19 years ago

Added some verbose output

code cleanup and minor bug fixes
  • Property svn:keywords set to Id
File size: 8.0 KB
RevLine 
[30]1/*
2 * Branched from Samba project, Subversion repository version #6903:
3 *   http://websvn.samba.org/cgi-bin/viewcvs.cgi/trunk/source/include/regfio.h
4 *
5 * Unix SMB/CIFS implementation.
6 * Windows NT registry I/O library
7 *
8 * Copyright (C) 2005 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: regfio.h 54 2005-09-05 01:19:05Z 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 _REGFIO_H
34#define _REGFIO_H
35
[31]36#include <stdlib.h>
37#include <stdio.h>
[30]38#include <stdbool.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>
47
48#include "smb_deps.h"
49
50/******************************************************************************/
51/* Macros */
52 
[32]53/* Registry data types */
54#define REG_NONE                       0
55#define REG_SZ                         1
56#define REG_EXPAND_SZ                  2
57#define REG_BINARY                     3
58#define REG_DWORD                      4
[54]59#define REG_DWORD_LE                   4  /* DWORD, little endian */
60#define REG_DWORD_BE                   5  /* DWORD, big endian */
[32]61#define REG_LINK                       6
62#define REG_MULTI_SZ                   7
63#define REG_RESOURCE_LIST              8
64#define REG_FULL_RESOURCE_DESCRIPTOR   9
65#define REG_RESOURCE_REQUIREMENTS_LIST 10
66/* Not a real type in the registry */
67#define REG_KEY                        255
68
69typedef struct _val_str { 
70  unsigned int val;
71  const char * str;
72} VAL_STR;
73
[30]74#define REGF_BLOCKSIZE          0x1000
75#define REGF_ALLOC_BLOCK        0x1000
76
77/* header sizes for various records */
78
79#define REGF_HDR_SIZE           4
80#define HBIN_HDR_SIZE           4
81#define HBIN_HEADER_REC_SIZE    0x24
82#define REC_HDR_SIZE            2
83
84#define REGF_OFFSET_NONE        0xffffffff
85
86/* Flags for the vk records */
87
88#define VK_FLAG_NAME_PRESENT    0x0001
89#define VK_DATA_IN_OFFSET       0x80000000
90
91/* NK record macros */
92
93#define NK_TYPE_LINKKEY         0x0010
94#define NK_TYPE_NORMALKEY       0x0020
95#define NK_TYPE_ROOTKEY         0x002c
96
[54]97#define HBIN_STORE_REF(x, y) { x->hbin = y; y->ref_count++ };
98/* if the count == 0; we can clean up */
99#define HBIN_REMOVE_REF(x, y){ x->hbin = NULL; y->ref_count-- };
[30]100
101
102/* HBIN block */
103struct regf_hbin;
104typedef struct regf_hbin {
[53]105  struct regf_hbin* prev;
106  struct regf_hbin* next;
107  uint32 file_off;       /* my offset in the registry file */
108  uint32 free_off;       /* offset to free space within the hbin record */
109  uint32 free_size;      /* amount of data left in the block */
[54]110  int    ref_count;      /* how many active records are pointing to this
111                          * block (not used currently)
112                          */
[30]113       
[53]114  uint8  header[HBIN_HDR_SIZE]; /* "hbin" */
115  uint32 first_hbin_off; /* offset from first hbin block */
[54]116  uint32 block_size;     /* block size of this block is
117                          * usually a multiple of 4096Kb
118                          */
119  prs_struct ps;         /* data */
[53]120  bool dirty;            /* has this hbin block been modified? */
[30]121} REGF_HBIN;
122
123/* ??? List -- list of key offsets and hashed names for consistency */
124typedef struct {
[53]125  uint32 nk_off;
126  uint8 keycheck[sizeof(uint32)];
[30]127} REGF_HASH_REC;
128
129typedef struct {
[54]130  REGF_HBIN *hbin;       /* pointer to HBIN record (in memory) containing
131                          * this nk record
132                          */
133  uint32 hbin_off;       /* offset from beginning of this hbin block */
134  uint32 rec_size;       /* ((start_offset - end_offset) & 0xfffffff8) */
[53]135 
136  uint8 header[REC_HDR_SIZE];
137  uint16 num_keys;
138  REGF_HASH_REC *hashes;
[30]139} REGF_LF_REC;
140
141/* Key Value */
142
143typedef struct {
[54]144  REGF_HBIN *hbin;      /* pointer to HBIN record (in memory) containing
145                         * this nk record
146                         */
[53]147  uint32 hbin_off;      /* offset from beginning of this hbin block */
148  uint32 rec_size;      /* ((start_offset - end_offset) & 0xfffffff8) */
[54]149  uint32 rec_off;       /* offset stored in the value list */
[53]150 
151  uint8  header[REC_HDR_SIZE];
152  char*  valuename;
153  uint32 data_size;
154  uint32 data_off;
155  uint8* data;
156  uint32 type;
157  uint16 flag;
[30]158} REGF_VK_REC;
159
160
161/* Key Security */
162struct _regf_sk_rec;
163
164typedef struct _regf_sk_rec {
[53]165  struct _regf_sk_rec *next, *prev;
[54]166  REGF_HBIN *hbin;      /* pointer to HBIN record (in memory) containing
167                         * this nk record
168                         */
[53]169  uint32 hbin_off;      /* offset from beginning of this hbin block */
170  uint32 rec_size;      /* ((start_offset - end_offset) & 0xfffffff8) */
171 
[54]172  uint32 sk_off;        /* offset parsed from NK record used as a key
173                         * to lookup reference to this SK record
174                         */
[53]175 
176  uint8  header[REC_HDR_SIZE];
177  uint32 prev_sk_off;
178  uint32 next_sk_off;
179  uint32 ref_count;
180  uint32 size;
181  SEC_DESC *sec_desc;
[30]182} REGF_SK_REC;
183
184/* Key Name */ 
185
186typedef struct {
[54]187  REGF_HBIN *hbin;      /* pointer to HBIN record (in memory) containing
188                         * this nk record
189                         */
[53]190  uint32 hbin_off;      /* offset from beginning of this hbin block */
191  uint32 subkey_index;  /* index to next subkey record to return */
192  uint32 rec_size;      /* ((start_offset - end_offset) & 0xfffffff8) */
193 
194  /* header information */
195  uint8  header[REC_HDR_SIZE];
196  uint16 key_type;
197  NTTIME mtime;
198  uint32 parent_off;    /* back pointer in registry hive */
199  uint32 classname_off; 
200  char *classname;
201  char *keyname;
202 
203  /* max lengths */
[54]204  uint32 max_bytes_subkeyname;      /* max subkey name * 2 */
205  uint32 max_bytes_subkeyclassname; /* max subkey classname length (as if) */
206  uint32 max_bytes_valuename;       /* max valuename * 2 */
207  uint32 max_bytes_value;           /* max value data size */
[53]208 
209  /* unknowns */
[54]210  uint32 unk_index;                 /* nigel says run time index ? */
[53]211 
212  /* children */
213  uint32 num_subkeys;
214  uint32 subkeys_off;   /* hash records that point to NK records */     
215  uint32 num_values;
216  uint32 values_off;    /* value lists which point to VK records */
[54]217  uint32 sk_off;        /* offset to SK record */
[53]218 
219  /* link in the other records here */
220  REGF_LF_REC subkeys;
221  REGF_VK_REC *values;
222  REGF_SK_REC *sec_desc;
[30]223       
224} REGF_NK_REC;
225
226/* REGF block */
227 
228typedef struct {
[53]229  /* run time information */
[54]230  int fd;         /* file descriptor */
231  int open_flags; /* flags passed to the open() call */
232  void *mem_ctx;  /* memory context for run-time file access information */
233  REGF_HBIN *block_list; /* list of open hbin blocks */
[53]234 
235  /* file format information */
236 
237  uint8  header[REGF_HDR_SIZE]; /* "regf" */
[54]238  uint32 data_offset;           /* offset to record in the first (or any?)
239                                 * hbin block
240                                 */
[53]241  uint32 last_block;            /* offset to last hbin block in file */
242  uint32 checksum;              /* XOR of bytes 0x0000 - 0x01FB */
243  NTTIME mtime;
244 
[54]245  REGF_SK_REC *sec_desc_list;   /* list of security descriptors referenced
246                                 * by NK records
247                                 */
[53]248 
249  /* unknowns used to simply writing */
250  uint32 unknown1;
251  uint32 unknown2;
252  uint32 unknown3;
253  uint32 unknown4;
254  uint32 unknown5;
255  uint32 unknown6;
256} REGF_FILE;
[30]257
258
[54]259/******************************************************************************/
[30]260/* Function Declarations */
[54]261
[41]262const char*   regfio_type_val2str(unsigned int val);
263int           regfio_type_str2val(const char* str);
[32]264
[53]265char*         regfio_get_sacl(SEC_DESC *sec_desc);
266char*         regfio_get_dacl(SEC_DESC *sec_desc);
267char*         regfio_get_owner(SEC_DESC *sec_desc);
268char*         regfio_get_group(SEC_DESC *sec_desc);
269
[30]270REGF_FILE*    regfio_open( const char *filename );
271int           regfio_close( REGF_FILE *r );
272
273REGF_NK_REC*  regfio_rootkey( REGF_FILE *file );
274REGF_NK_REC*  regfio_fetch_subkey( REGF_FILE *file, REGF_NK_REC *nk );
275
276#endif  /* _REGFIO_H */
Note: See TracBrowser for help on using the repository browser.