source: releases/0.3.0/include/regfio.h@ 192

Last change on this file since 192 was 72, checked in by tim, 19 years ago

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