Fix typos in "valid"
[Samba.git] / source3 / registry / regfio.c
blob7e323da9dababc6d8dcdf1b7cd96d850ae5f32c9
1 /*
2 * Unix SMB/CIFS implementation.
3 * Windows NT registry I/O library
4 * Copyright (c) Gerald (Jerry) Carter 2005
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #include "includes.h"
21 #include "system/filesys.h"
22 #include "regfio.h"
23 #include "../librpc/gen_ndr/ndr_security.h"
24 #include "../libcli/security/security_descriptor.h"
25 #include "../libcli/security/secdesc.h"
27 #undef DBGC_CLASS
28 #define DBGC_CLASS DBGC_REGISTRY
30 /*******************************************************************
32 * TODO : Right now this code basically ignores classnames.
34 ******************************************************************/
36 #if defined(PARANOID_MALLOC_CHECKER)
37 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem_((ps),sizeof(type),(count))
38 #else
39 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem((ps),sizeof(type),(count))
40 #endif
42 /*******************************************************************
43 Reads or writes an NTTIME structure.
44 ********************************************************************/
46 static bool smb_io_time(const char *desc, NTTIME *nttime, prs_struct *ps, int depth)
48 uint32_t low, high;
49 if (nttime == NULL)
50 return False;
52 prs_debug(ps, depth, desc, "smb_io_time");
53 depth++;
55 if(!prs_align(ps))
56 return False;
58 if (MARSHALLING(ps)) {
59 low = *nttime & 0xFFFFFFFF;
60 high = *nttime >> 32;
63 if(!prs_uint32("low ", ps, depth, &low)) /* low part */
64 return False;
65 if(!prs_uint32("high", ps, depth, &high)) /* high part */
66 return False;
68 if (UNMARSHALLING(ps)) {
69 *nttime = (((uint64_t)high << 32) + low);
72 return True;
75 /*******************************************************************
76 *******************************************************************/
78 static int write_block( REGF_FILE *file, prs_struct *ps, uint32_t offset )
80 int bytes_written, returned;
81 char *buffer = prs_data_p( ps );
82 uint32_t buffer_size = prs_data_size( ps );
83 SMB_STRUCT_STAT sbuf;
85 if ( file->fd == -1 )
86 return -1;
88 /* check for end of file */
90 if (sys_fstat(file->fd, &sbuf, false)) {
91 DEBUG(0,("write_block: stat() failed! (%s)\n", strerror(errno)));
92 return -1;
95 if ( lseek( file->fd, offset, SEEK_SET ) == -1 ) {
96 DEBUG(0,("write_block: lseek() failed! (%s)\n", strerror(errno) ));
97 return -1;
100 bytes_written = returned = 0;
101 while ( bytes_written < buffer_size ) {
102 if ( (returned = write( file->fd, buffer+bytes_written, buffer_size-bytes_written )) == -1 ) {
103 DEBUG(0,("write_block: write() failed! (%s)\n", strerror(errno) ));
104 return False;
107 bytes_written += returned;
110 return bytes_written;
113 /*******************************************************************
114 *******************************************************************/
116 static int read_block( REGF_FILE *file, prs_struct *ps, uint32_t file_offset, uint32_t block_size )
118 int bytes_read, returned;
119 char *buffer;
120 SMB_STRUCT_STAT sbuf;
122 /* check for end of file */
124 if (sys_fstat(file->fd, &sbuf, false)) {
125 DEBUG(0,("read_block: stat() failed! (%s)\n", strerror(errno)));
126 return -1;
129 if ( (size_t)file_offset >= sbuf.st_ex_size )
130 return -1;
132 /* if block_size == 0, we are parsing HBIN records and need
133 to read some of the header to get the block_size from there */
135 if ( block_size == 0 ) {
136 char hdr[0x20];
138 if ( lseek( file->fd, file_offset, SEEK_SET ) == -1 ) {
139 DEBUG(0,("read_block: lseek() failed! (%s)\n", strerror(errno) ));
140 return -1;
143 returned = read( file->fd, hdr, 0x20 );
144 if ( (returned == -1) || (returned < 0x20) ) {
145 DEBUG(0,("read_block: failed to read in HBIN header. Is the file corrupt?\n"));
146 return -1;
149 /* make sure this is an hbin header */
151 if ( strncmp( hdr, "hbin", HBIN_HDR_SIZE ) != 0 ) {
152 DEBUG(0,("read_block: invalid block header!\n"));
153 return -1;
156 block_size = IVAL( hdr, 0x08 );
159 DEBUG(10,("read_block: block_size == 0x%x\n", block_size ));
161 /* set the offset, initialize the buffer, and read the block from disk */
163 if ( lseek( file->fd, file_offset, SEEK_SET ) == -1 ) {
164 DEBUG(0,("read_block: lseek() failed! (%s)\n", strerror(errno) ));
165 return -1;
168 if (!prs_init( ps, block_size, file->mem_ctx, UNMARSHALL )) {
169 DEBUG(0,("read_block: prs_init() failed! (%s)\n", strerror(errno) ));
170 return -1;
172 buffer = prs_data_p( ps );
173 bytes_read = returned = 0;
175 while ( bytes_read < block_size ) {
176 if ( (returned = read( file->fd, buffer+bytes_read, block_size-bytes_read )) == -1 ) {
177 DEBUG(0,("read_block: read() failed (%s)\n", strerror(errno) ));
178 return False;
180 if ( (returned == 0) && (bytes_read < block_size) ) {
181 DEBUG(0,("read_block: not a valid registry file ?\n" ));
182 return False;
185 bytes_read += returned;
188 return bytes_read;
191 /*******************************************************************
192 *******************************************************************/
194 static bool write_hbin_block( REGF_FILE *file, REGF_HBIN *hbin )
196 if ( !hbin->dirty )
197 return True;
199 /* write free space record if any is available */
201 if ( hbin->free_off != REGF_OFFSET_NONE ) {
202 uint32_t header = 0xffffffff;
204 if ( !prs_set_offset( &hbin->ps, hbin->free_off-sizeof(uint32_t) ) )
205 return False;
206 if ( !prs_uint32( "free_size", &hbin->ps, 0, &hbin->free_size ) )
207 return False;
208 if ( !prs_uint32( "free_header", &hbin->ps, 0, &header ) )
209 return False;
212 hbin->dirty = (write_block( file, &hbin->ps, hbin->file_off ) != -1);
214 return hbin->dirty;
217 /*******************************************************************
218 *******************************************************************/
220 static bool hbin_block_close( REGF_FILE *file, REGF_HBIN *hbin )
222 REGF_HBIN *p;
224 /* remove the block from the open list and flush it to disk */
226 for ( p=file->block_list; p && p!=hbin; p=p->next )
229 if ( p == hbin ) {
230 DLIST_REMOVE( file->block_list, hbin );
232 else
233 DEBUG(0,("hbin_block_close: block not in open list!\n"));
235 if ( !write_hbin_block( file, hbin ) )
236 return False;
238 return True;
241 /*******************************************************************
242 *******************************************************************/
244 static bool prs_regf_block( const char *desc, prs_struct *ps, int depth, REGF_FILE *file )
246 prs_debug(ps, depth, desc, "prs_regf_block");
247 depth++;
249 if ( !prs_uint8s( True, "header", ps, depth, (uint8_t *)file->header, sizeof( file->header )) )
250 return False;
252 /* yes, these values are always identical so store them only once */
254 if ( !prs_uint32( "unknown1", ps, depth, &file->unknown1 ))
255 return False;
256 if ( !prs_uint32( "unknown1 (again)", ps, depth, &file->unknown1 ))
257 return False;
259 /* get the modtime */
261 if ( !prs_set_offset( ps, 0x0c ) )
262 return False;
263 if ( !smb_io_time( "modtime", &file->mtime, ps, depth ) )
264 return False;
266 /* constants */
268 if ( !prs_uint32( "unknown2", ps, depth, &file->unknown2 ))
269 return False;
270 if ( !prs_uint32( "unknown3", ps, depth, &file->unknown3 ))
271 return False;
272 if ( !prs_uint32( "unknown4", ps, depth, &file->unknown4 ))
273 return False;
274 if ( !prs_uint32( "unknown5", ps, depth, &file->unknown5 ))
275 return False;
277 /* get file offsets */
279 if ( !prs_set_offset( ps, 0x24 ) )
280 return False;
281 if ( !prs_uint32( "data_offset", ps, depth, &file->data_offset ))
282 return False;
283 if ( !prs_uint32( "last_block", ps, depth, &file->last_block ))
284 return False;
286 /* one more constant */
288 if ( !prs_uint32( "unknown6", ps, depth, &file->unknown6 ))
289 return False;
291 /* get the checksum */
293 if ( !prs_set_offset( ps, 0x01fc ) )
294 return False;
295 if ( !prs_uint32( "checksum", ps, depth, &file->checksum ))
296 return False;
298 return True;
301 /*******************************************************************
302 *******************************************************************/
304 static bool prs_hbin_block( const char *desc, prs_struct *ps, int depth, REGF_HBIN *hbin )
306 uint32_t block_size2;
308 prs_debug(ps, depth, desc, "prs_regf_block");
309 depth++;
311 if ( !prs_uint8s( True, "header", ps, depth, (uint8_t*)hbin->header, sizeof( hbin->header )) )
312 return False;
314 if ( !prs_uint32( "first_hbin_off", ps, depth, &hbin->first_hbin_off ))
315 return False;
317 /* The dosreg.cpp comments say that the block size is at 0x1c.
318 According to a WINXP NTUSER.dat file, this is wrong. The block_size
319 is at 0x08 */
321 if ( !prs_uint32( "block_size", ps, depth, &hbin->block_size ))
322 return False;
324 block_size2 = hbin->block_size;
325 prs_set_offset( ps, 0x1c );
326 if ( !prs_uint32( "block_size2", ps, depth, &block_size2 ))
327 return False;
329 if ( MARSHALLING(ps) )
330 hbin->dirty = True;
333 return True;
336 /*******************************************************************
337 *******************************************************************/
339 static bool prs_nk_rec( const char *desc, prs_struct *ps, int depth, REGF_NK_REC *nk )
341 uint16_t class_length, name_length;
342 uint32_t start;
343 uint32_t data_size, start_off, end_off;
344 uint32_t unknown_off = REGF_OFFSET_NONE;
346 nk->hbin_off = prs_offset( ps );
347 start = nk->hbin_off;
349 prs_debug(ps, depth, desc, "prs_nk_rec");
350 depth++;
352 /* back up and get the data_size */
354 if ( !prs_set_offset( ps, prs_offset(ps)-sizeof(uint32_t)) )
355 return False;
356 start_off = prs_offset( ps );
357 if ( !prs_uint32( "rec_size", ps, depth, &nk->rec_size ))
358 return False;
360 if ( !prs_uint8s( True, "header", ps, depth, (uint8_t *)nk->header, sizeof( nk->header )) )
361 return False;
363 if ( !prs_uint16( "key_type", ps, depth, &nk->key_type ))
364 return False;
365 if ( !smb_io_time( "mtime", &nk->mtime, ps, depth ))
366 return False;
368 if ( !prs_set_offset( ps, start+0x0010 ) )
369 return False;
370 if ( !prs_uint32( "parent_off", ps, depth, &nk->parent_off ))
371 return False;
372 if ( !prs_uint32( "num_subkeys", ps, depth, &nk->num_subkeys ))
373 return False;
375 if ( !prs_set_offset( ps, start+0x001c ) )
376 return False;
377 if ( !prs_uint32( "subkeys_off", ps, depth, &nk->subkeys_off ))
378 return False;
379 if ( !prs_uint32( "unknown_off", ps, depth, &unknown_off) )
380 return False;
382 if ( !prs_set_offset( ps, start+0x0024 ) )
383 return False;
384 if ( !prs_uint32( "num_values", ps, depth, &nk->num_values ))
385 return False;
386 if ( !prs_uint32( "values_off", ps, depth, &nk->values_off ))
387 return False;
388 if ( !prs_uint32( "sk_off", ps, depth, &nk->sk_off ))
389 return False;
390 if ( !prs_uint32( "classname_off", ps, depth, &nk->classname_off ))
391 return False;
393 if ( !prs_uint32( "max_bytes_subkeyname", ps, depth, &nk->max_bytes_subkeyname))
394 return False;
395 if ( !prs_uint32( "max_bytes_subkeyclassname", ps, depth, &nk->max_bytes_subkeyclassname))
396 return False;
397 if ( !prs_uint32( "max_bytes_valuename", ps, depth, &nk->max_bytes_valuename))
398 return False;
399 if ( !prs_uint32( "max_bytes_value", ps, depth, &nk->max_bytes_value))
400 return False;
401 if ( !prs_uint32( "unknown index", ps, depth, &nk->unk_index))
402 return False;
404 name_length = nk->keyname ? strlen(nk->keyname) : 0 ;
405 class_length = nk->classname ? strlen(nk->classname) : 0 ;
406 if ( !prs_uint16( "name_length", ps, depth, &name_length ))
407 return False;
408 if ( !prs_uint16( "class_length", ps, depth, &class_length ))
409 return False;
411 if ( class_length ) {
415 if ( name_length ) {
416 if ( UNMARSHALLING(ps) ) {
417 if ( !(nk->keyname = PRS_ALLOC_MEM( ps, char, name_length+1 )) )
418 return False;
421 if ( !prs_uint8s( True, "name", ps, depth, (uint8_t *)nk->keyname, name_length) )
422 return False;
424 if ( UNMARSHALLING(ps) )
425 nk->keyname[name_length] = '\0';
428 end_off = prs_offset( ps );
430 /* data_size must be divisible by 8 and large enough to hold the original record */
432 data_size = ((start_off - end_off) & 0xfffffff8 );
433 if ( data_size > nk->rec_size )
434 DEBUG(10,("Encountered reused record (0x%x < 0x%x)\n", data_size, nk->rec_size));
436 if ( MARSHALLING(ps) )
437 nk->hbin->dirty = True;
439 return True;
442 /*******************************************************************
443 *******************************************************************/
445 static uint32_t regf_block_checksum( prs_struct *ps )
447 char *buffer = prs_data_p( ps );
448 uint32_t checksum, x;
449 int i;
451 /* XOR of all bytes 0x0000 - 0x01FB */
453 checksum = x = 0;
455 for ( i=0; i<0x01FB; i+=4 ) {
456 x = IVAL(buffer, i );
457 checksum ^= x;
460 return checksum;
463 /*******************************************************************
464 *******************************************************************/
466 static bool read_regf_block( REGF_FILE *file )
468 prs_struct ps;
469 uint32_t checksum;
471 /* grab the first block from the file */
473 if ( read_block( file, &ps, 0, REGF_BLOCKSIZE ) == -1 )
474 return False;
476 /* parse the block and verify the checksum */
478 if ( !prs_regf_block( "regf_header", &ps, 0, file ) )
479 return False;
481 checksum = regf_block_checksum( &ps );
483 prs_mem_free( &ps );
485 if ( file->checksum != checksum ) {
486 DEBUG(0,("read_regf_block: invalid checksum\n" ));
487 return False;
490 return True;
493 /*******************************************************************
494 *******************************************************************/
496 static REGF_HBIN* read_hbin_block( REGF_FILE *file, off_t offset )
498 REGF_HBIN *hbin;
499 uint32_t record_size, curr_off, block_size, header;
501 if ( !(hbin = talloc_zero(file->mem_ctx, REGF_HBIN)) )
502 return NULL;
503 hbin->file_off = offset;
504 hbin->free_off = -1;
506 if ( read_block( file, &hbin->ps, offset, 0 ) == -1 )
507 return NULL;
509 if ( !prs_hbin_block( "hbin", &hbin->ps, 0, hbin ) )
510 return NULL;
512 /* this should be the same thing as hbin->block_size but just in case */
514 block_size = prs_data_size( &hbin->ps );
516 /* Find the available free space offset. Always at the end,
517 so walk the record list and stop when you get to the end.
518 The end is defined by a record header of 0xffffffff. The
519 previous 4 bytes contains the amount of free space remaining
520 in the hbin block. */
522 /* remember that the record_size is in the 4 bytes preceeding the record itself */
524 if ( !prs_set_offset( &hbin->ps, file->data_offset+HBIN_HDR_SIZE-sizeof(uint32_t) ) )
525 return NULL;
527 record_size = 0;
528 header = 0;
529 curr_off = prs_offset( &hbin->ps );
530 while ( header != 0xffffffff ) {
531 /* not done yet so reset the current offset to the
532 next record_size field */
534 curr_off = curr_off+record_size;
536 /* for some reason the record_size of the last record in
537 an hbin block can extend past the end of the block
538 even though the record fits within the remaining
539 space....aaarrrgggghhhhhh */
541 if ( curr_off >= block_size ) {
542 record_size = -1;
543 curr_off = -1;
544 break;
547 if ( !prs_set_offset( &hbin->ps, curr_off) )
548 return NULL;
550 if ( !prs_uint32( "rec_size", &hbin->ps, 0, &record_size ) )
551 return NULL;
552 if ( !prs_uint32( "header", &hbin->ps, 0, &header ) )
553 return NULL;
555 SMB_ASSERT( record_size != 0 );
557 if ( record_size & 0x80000000 ) {
558 /* absolute_value(record_size) */
559 record_size = (record_size ^ 0xffffffff) + 1;
563 /* save the free space offset */
565 if ( header == 0xffffffff ) {
567 /* account for the fact that the curr_off is 4 bytes behind the actual
568 record header */
570 hbin->free_off = curr_off + sizeof(uint32_t);
571 hbin->free_size = record_size;
574 DEBUG(10,("read_hbin_block: free space offset == 0x%x\n", hbin->free_off));
576 if ( !prs_set_offset( &hbin->ps, file->data_offset+HBIN_HDR_SIZE ) )
577 return NULL;
579 return hbin;
582 /*******************************************************************
583 Input a random offset and receive the corresponding HBIN
584 block for it
585 *******************************************************************/
587 static bool hbin_contains_offset( REGF_HBIN *hbin, uint32_t offset )
589 if ( !hbin )
590 return False;
592 if ( (offset > hbin->first_hbin_off) && (offset < (hbin->first_hbin_off+hbin->block_size)) )
593 return True;
595 return False;
598 /*******************************************************************
599 Input a random offset and receive the corresponding HBIN
600 block for it
601 *******************************************************************/
603 static REGF_HBIN* lookup_hbin_block( REGF_FILE *file, uint32_t offset )
605 REGF_HBIN *hbin = NULL;
606 uint32_t block_off;
608 /* start with the open list */
610 for ( hbin=file->block_list; hbin; hbin=hbin->next ) {
611 DEBUG(10,("lookup_hbin_block: address = 0x%x [0x%lx]\n", hbin->file_off, (unsigned long)hbin ));
612 if ( hbin_contains_offset( hbin, offset ) )
613 return hbin;
616 if ( !hbin ) {
617 /* start at the beginning */
619 block_off = REGF_BLOCKSIZE;
620 do {
621 /* cleanup before the next round */
622 if ( hbin )
623 prs_mem_free( &hbin->ps );
625 hbin = read_hbin_block( file, block_off );
627 if ( hbin )
628 block_off = hbin->file_off + hbin->block_size;
630 } while ( hbin && !hbin_contains_offset( hbin, offset ) );
633 if ( hbin )
634 DLIST_ADD( file->block_list, hbin );
636 return hbin;
639 /*******************************************************************
640 *******************************************************************/
642 static bool prs_hash_rec( const char *desc, prs_struct *ps, int depth, REGF_HASH_REC *hash )
644 prs_debug(ps, depth, desc, "prs_hash_rec");
645 depth++;
647 if ( !prs_uint32( "nk_off", ps, depth, &hash->nk_off ))
648 return False;
649 if ( !prs_uint8s( True, "keycheck", ps, depth, hash->keycheck, sizeof( hash->keycheck )) )
650 return False;
652 return True;
655 /*******************************************************************
656 *******************************************************************/
658 static bool hbin_prs_lf_records( const char *desc, REGF_HBIN *hbin, int depth, REGF_NK_REC *nk )
660 int i;
661 REGF_LF_REC *lf = &nk->subkeys;
662 uint32_t data_size, start_off, end_off;
664 prs_debug(&hbin->ps, depth, desc, "prs_lf_records");
665 depth++;
667 /* check if we have anything to do first */
669 if ( nk->num_subkeys == 0 )
670 return True;
672 /* move to the LF record */
674 if ( !prs_set_offset( &hbin->ps, nk->subkeys_off + HBIN_HDR_SIZE - hbin->first_hbin_off ) )
675 return False;
677 /* backup and get the data_size */
679 if ( !prs_set_offset( &hbin->ps, prs_offset(&hbin->ps)-sizeof(uint32_t)) )
680 return False;
681 start_off = prs_offset( &hbin->ps );
682 if ( !prs_uint32( "rec_size", &hbin->ps, depth, &lf->rec_size ))
683 return False;
685 if ( !prs_uint8s( True, "header", &hbin->ps, depth, (uint8_t *)lf->header, sizeof( lf->header )) )
686 return False;
688 if ( !prs_uint16( "num_keys", &hbin->ps, depth, &lf->num_keys))
689 return False;
691 if ( UNMARSHALLING(&hbin->ps) ) {
692 if (lf->num_keys) {
693 if ( !(lf->hashes = PRS_ALLOC_MEM( &hbin->ps, REGF_HASH_REC, lf->num_keys )) )
694 return False;
695 } else {
696 lf->hashes = NULL;
700 for ( i=0; i<lf->num_keys; i++ ) {
701 if ( !prs_hash_rec( "hash_rec", &hbin->ps, depth, &lf->hashes[i] ) )
702 return False;
705 end_off = prs_offset( &hbin->ps );
707 /* data_size must be divisible by 8 and large enough to hold the original record */
709 data_size = ((start_off - end_off) & 0xfffffff8 );
710 if ( data_size > lf->rec_size )
711 DEBUG(10,("Encountered reused record (0x%x < 0x%x)\n", data_size, lf->rec_size));
713 if ( MARSHALLING(&hbin->ps) )
714 hbin->dirty = True;
716 return True;
719 /*******************************************************************
720 *******************************************************************/
722 static bool hbin_prs_sk_rec( const char *desc, REGF_HBIN *hbin, int depth, REGF_SK_REC *sk )
724 prs_struct *ps = &hbin->ps;
725 uint16_t tag = 0xFFFF;
726 uint32_t data_size, start_off, end_off;
729 prs_debug(ps, depth, desc, "hbin_prs_sk_rec");
730 depth++;
732 if ( !prs_set_offset( &hbin->ps, sk->sk_off + HBIN_HDR_SIZE - hbin->first_hbin_off ) )
733 return False;
735 /* backup and get the data_size */
737 if ( !prs_set_offset( &hbin->ps, prs_offset(&hbin->ps)-sizeof(uint32_t)) )
738 return False;
739 start_off = prs_offset( &hbin->ps );
740 if ( !prs_uint32( "rec_size", &hbin->ps, depth, &sk->rec_size ))
741 return False;
743 if ( !prs_uint8s( True, "header", ps, depth, (uint8_t *)sk->header, sizeof( sk->header )) )
744 return False;
745 if ( !prs_uint16( "tag", ps, depth, &tag))
746 return False;
748 if ( !prs_uint32( "prev_sk_off", ps, depth, &sk->prev_sk_off))
749 return False;
750 if ( !prs_uint32( "next_sk_off", ps, depth, &sk->next_sk_off))
751 return False;
752 if ( !prs_uint32( "ref_count", ps, depth, &sk->ref_count))
753 return False;
754 if ( !prs_uint32( "size", ps, depth, &sk->size))
755 return False;
758 NTSTATUS status;
759 TALLOC_CTX *mem_ctx = prs_get_mem_context(&hbin->ps);
760 DATA_BLOB blob;
762 if (MARSHALLING(&hbin->ps)) {
763 status = marshall_sec_desc(mem_ctx,
764 sk->sec_desc,
765 &blob.data, &blob.length);
766 if (!NT_STATUS_IS_OK(status))
767 return False;
768 if (!prs_copy_data_in(&hbin->ps, (const char *)blob.data, blob.length))
769 return False;
770 } else {
771 blob = data_blob_const(
772 prs_data_p(&hbin->ps) + prs_offset(&hbin->ps),
773 prs_data_size(&hbin->ps) - prs_offset(&hbin->ps)
775 status = unmarshall_sec_desc(mem_ctx,
776 blob.data, blob.length,
777 &sk->sec_desc);
778 if (!NT_STATUS_IS_OK(status))
779 return False;
780 prs_set_offset(&hbin->ps, blob.length);
784 end_off = prs_offset( &hbin->ps );
786 /* data_size must be divisible by 8 and large enough to hold the original record */
788 data_size = ((start_off - end_off) & 0xfffffff8 );
789 if ( data_size > sk->rec_size )
790 DEBUG(10,("Encountered reused record (0x%x < 0x%x)\n", data_size, sk->rec_size));
792 if ( MARSHALLING(&hbin->ps) )
793 hbin->dirty = True;
795 return True;
798 /*******************************************************************
799 *******************************************************************/
801 static bool hbin_prs_vk_rec( const char *desc, REGF_HBIN *hbin, int depth, REGF_VK_REC *vk, REGF_FILE *file )
803 uint32_t offset;
804 uint16_t name_length;
805 prs_struct *ps = &hbin->ps;
806 uint32_t data_size, start_off, end_off;
808 prs_debug(ps, depth, desc, "prs_vk_rec");
809 depth++;
811 /* backup and get the data_size */
813 if ( !prs_set_offset( &hbin->ps, prs_offset(&hbin->ps)-sizeof(uint32_t)) )
814 return False;
815 start_off = prs_offset( &hbin->ps );
816 if ( !prs_uint32( "rec_size", &hbin->ps, depth, &vk->rec_size ))
817 return False;
819 if ( !prs_uint8s( True, "header", ps, depth, (uint8_t *)vk->header, sizeof( vk->header )) )
820 return False;
822 if ( MARSHALLING(&hbin->ps) )
823 name_length = strlen(vk->valuename);
825 if ( !prs_uint16( "name_length", ps, depth, &name_length ))
826 return False;
827 if ( !prs_uint32( "data_size", ps, depth, &vk->data_size ))
828 return False;
829 if ( !prs_uint32( "data_off", ps, depth, &vk->data_off ))
830 return False;
831 if ( !prs_uint32( "type", ps, depth, &vk->type))
832 return False;
833 if ( !prs_uint16( "flag", ps, depth, &vk->flag))
834 return False;
836 offset = prs_offset( ps );
837 offset += 2; /* skip 2 bytes */
838 prs_set_offset( ps, offset );
840 /* get the name */
842 if ( vk->flag&VK_FLAG_NAME_PRESENT ) {
844 if ( UNMARSHALLING(&hbin->ps) ) {
845 if ( !(vk->valuename = PRS_ALLOC_MEM( ps, char, name_length+1 )))
846 return False;
848 if ( !prs_uint8s( True, "name", ps, depth, (uint8_t *)vk->valuename, name_length ) )
849 return False;
852 end_off = prs_offset( &hbin->ps );
854 /* get the data if necessary */
856 if ( vk->data_size != 0 ) {
857 bool charmode = False;
859 if ( (vk->type == REG_SZ) || (vk->type == REG_MULTI_SZ) )
860 charmode = True;
862 /* the data is stored in the offset if the size <= 4 */
864 if ( !(vk->data_size & VK_DATA_IN_OFFSET) ) {
865 REGF_HBIN *hblock = hbin;
866 uint32_t data_rec_size;
868 if ( UNMARSHALLING(&hbin->ps) ) {
869 if ( !(vk->data = PRS_ALLOC_MEM( ps, uint8_t, vk->data_size) ) )
870 return False;
873 /* this data can be in another hbin */
874 if ( !hbin_contains_offset( hbin, vk->data_off ) ) {
875 if ( !(hblock = lookup_hbin_block( file, vk->data_off )) )
876 return False;
878 if ( !(prs_set_offset( &hblock->ps, (vk->data_off+HBIN_HDR_SIZE-hblock->first_hbin_off)-sizeof(uint32_t) )) )
879 return False;
881 if ( MARSHALLING(&hblock->ps) ) {
882 data_rec_size = ( (vk->data_size+sizeof(uint32_t)) & 0xfffffff8 ) + 8;
883 data_rec_size = ( data_rec_size - 1 ) ^ 0xFFFFFFFF;
885 if ( !prs_uint32( "data_rec_size", &hblock->ps, depth, &data_rec_size ))
886 return False;
887 if ( !prs_uint8s( charmode, "data", &hblock->ps, depth, vk->data, vk->data_size) )
888 return False;
890 if ( MARSHALLING(&hblock->ps) )
891 hblock->dirty = True;
893 else {
894 if ( !(vk->data = PRS_ALLOC_MEM( ps, uint8_t, 4 ) ) )
895 return False;
896 SIVAL( vk->data, 0, vk->data_off );
901 /* data_size must be divisible by 8 and large enough to hold the original record */
903 data_size = ((start_off - end_off ) & 0xfffffff8 );
904 if ( data_size != vk->rec_size )
905 DEBUG(10,("prs_vk_rec: data_size check failed (0x%x < 0x%x)\n", data_size, vk->rec_size));
907 if ( MARSHALLING(&hbin->ps) )
908 hbin->dirty = True;
910 return True;
913 /*******************************************************************
914 read a VK record which is contained in the HBIN block stored
915 in the prs_struct *ps.
916 *******************************************************************/
918 static bool hbin_prs_vk_records( const char *desc, REGF_HBIN *hbin, int depth, REGF_NK_REC *nk, REGF_FILE *file )
920 int i;
921 uint32_t record_size;
923 prs_debug(&hbin->ps, depth, desc, "prs_vk_records");
924 depth++;
926 /* check if we have anything to do first */
928 if ( nk->num_values == 0 )
929 return True;
931 if ( UNMARSHALLING(&hbin->ps) ) {
932 if ( !(nk->values = PRS_ALLOC_MEM( &hbin->ps, REGF_VK_REC, nk->num_values ) ) )
933 return False;
936 /* convert the offset to something relative to this HBIN block */
938 if ( !prs_set_offset( &hbin->ps, nk->values_off+HBIN_HDR_SIZE-hbin->first_hbin_off-sizeof(uint32_t)) )
939 return False;
941 if ( MARSHALLING( &hbin->ps) ) {
942 record_size = ( ( nk->num_values * sizeof(uint32_t) ) & 0xfffffff8 ) + 8;
943 record_size = (record_size - 1) ^ 0xFFFFFFFF;
946 if ( !prs_uint32( "record_size", &hbin->ps, depth, &record_size ) )
947 return False;
949 for ( i=0; i<nk->num_values; i++ ) {
950 if ( !prs_uint32( "vk_off", &hbin->ps, depth, &nk->values[i].rec_off ) )
951 return False;
954 for ( i=0; i<nk->num_values; i++ ) {
955 REGF_HBIN *sub_hbin = hbin;
956 uint32_t new_offset;
958 if ( !hbin_contains_offset( hbin, nk->values[i].rec_off ) ) {
959 sub_hbin = lookup_hbin_block( file, nk->values[i].rec_off );
960 if ( !sub_hbin ) {
961 DEBUG(0,("hbin_prs_vk_records: Failed to find HBIN block containing offset [0x%x]\n",
962 nk->values[i].hbin_off));
963 return False;
967 new_offset = nk->values[i].rec_off + HBIN_HDR_SIZE - sub_hbin->first_hbin_off;
968 if ( !prs_set_offset( &sub_hbin->ps, new_offset ) )
969 return False;
970 if ( !hbin_prs_vk_rec( "vk_rec", sub_hbin, depth, &nk->values[i], file ) )
971 return False;
974 if ( MARSHALLING(&hbin->ps) )
975 hbin->dirty = True;
978 return True;
982 /*******************************************************************
983 *******************************************************************/
985 static REGF_SK_REC* find_sk_record_by_offset( REGF_FILE *file, uint32_t offset )
987 REGF_SK_REC *p_sk;
989 for ( p_sk=file->sec_desc_list; p_sk; p_sk=p_sk->next ) {
990 if ( p_sk->sk_off == offset )
991 return p_sk;
994 return NULL;
997 /*******************************************************************
998 *******************************************************************/
1000 static REGF_SK_REC* find_sk_record_by_sec_desc( REGF_FILE *file, struct security_descriptor *sd )
1002 REGF_SK_REC *p;
1004 for ( p=file->sec_desc_list; p; p=p->next ) {
1005 if ( security_descriptor_equal( p->sec_desc, sd ) )
1006 return p;
1009 /* failure */
1011 return NULL;
1014 /*******************************************************************
1015 *******************************************************************/
1017 static bool hbin_prs_key( REGF_FILE *file, REGF_HBIN *hbin, REGF_NK_REC *nk )
1019 int depth = 0;
1020 REGF_HBIN *sub_hbin;
1022 prs_debug(&hbin->ps, depth, "", "fetch_key");
1023 depth++;
1025 /* get the initial nk record */
1027 if ( !prs_nk_rec( "nk_rec", &hbin->ps, depth, nk ))
1028 return False;
1030 /* fill in values */
1032 if ( nk->num_values && (nk->values_off!=REGF_OFFSET_NONE) ) {
1033 sub_hbin = hbin;
1034 if ( !hbin_contains_offset( hbin, nk->values_off ) ) {
1035 sub_hbin = lookup_hbin_block( file, nk->values_off );
1036 if ( !sub_hbin ) {
1037 DEBUG(0,("hbin_prs_key: Failed to find HBIN block containing value_list_offset [0x%x]\n",
1038 nk->values_off));
1039 return False;
1043 if ( !hbin_prs_vk_records( "vk_rec", sub_hbin, depth, nk, file ))
1044 return False;
1047 /* now get subkeys */
1049 if ( nk->num_subkeys && (nk->subkeys_off!=REGF_OFFSET_NONE) ) {
1050 sub_hbin = hbin;
1051 if ( !hbin_contains_offset( hbin, nk->subkeys_off ) ) {
1052 sub_hbin = lookup_hbin_block( file, nk->subkeys_off );
1053 if ( !sub_hbin ) {
1054 DEBUG(0,("hbin_prs_key: Failed to find HBIN block containing subkey_offset [0x%x]\n",
1055 nk->subkeys_off));
1056 return False;
1060 if ( !hbin_prs_lf_records( "lf_rec", sub_hbin, depth, nk ))
1061 return False;
1064 /* get the to the security descriptor. First look if we have already parsed it */
1066 if ( (nk->sk_off!=REGF_OFFSET_NONE) && !( nk->sec_desc = find_sk_record_by_offset( file, nk->sk_off )) ) {
1068 sub_hbin = hbin;
1069 if ( !hbin_contains_offset( hbin, nk->sk_off ) ) {
1070 sub_hbin = lookup_hbin_block( file, nk->sk_off );
1071 if ( !sub_hbin ) {
1072 DEBUG(0,("hbin_prs_key: Failed to find HBIN block containing sk_off [0x%x]\n",
1073 nk->sk_off));
1074 return False;
1078 if ( !(nk->sec_desc = talloc_zero( file->mem_ctx, REGF_SK_REC )) )
1079 return False;
1080 nk->sec_desc->sk_off = nk->sk_off;
1081 if ( !hbin_prs_sk_rec( "sk_rec", sub_hbin, depth, nk->sec_desc ))
1082 return False;
1084 /* add to the list of security descriptors (ref_count has been read from the files) */
1086 nk->sec_desc->sk_off = nk->sk_off;
1087 DLIST_ADD( file->sec_desc_list, nk->sec_desc );
1090 return True;
1093 /*******************************************************************
1094 *******************************************************************/
1096 static bool next_record( REGF_HBIN *hbin, const char *hdr, bool *eob )
1098 uint8_t header[REC_HDR_SIZE];
1099 uint32_t record_size;
1100 uint32_t curr_off, block_size;
1101 bool found = False;
1102 prs_struct *ps = &hbin->ps;
1104 curr_off = prs_offset( ps );
1105 if ( curr_off == 0 )
1106 prs_set_offset( ps, HBIN_HEADER_REC_SIZE );
1108 /* assume that the current offset is at the record header
1109 and we need to backup to read the record size */
1111 curr_off -= sizeof(uint32_t);
1113 block_size = prs_data_size( ps );
1114 record_size = 0;
1115 memset( header, 0x0, sizeof(uint8_t)*REC_HDR_SIZE );
1116 while ( !found ) {
1118 curr_off = curr_off+record_size;
1119 if ( curr_off >= block_size )
1120 break;
1122 if ( !prs_set_offset( &hbin->ps, curr_off) )
1123 return False;
1125 if ( !prs_uint32( "record_size", ps, 0, &record_size ) )
1126 return False;
1127 if ( !prs_uint8s( True, "header", ps, 0, header, REC_HDR_SIZE ) )
1128 return False;
1130 if ( record_size & 0x80000000 ) {
1131 /* absolute_value(record_size) */
1132 record_size = (record_size ^ 0xffffffff) + 1;
1135 if ( memcmp( header, hdr, REC_HDR_SIZE ) == 0 ) {
1136 found = True;
1137 curr_off += sizeof(uint32_t);
1141 /* mark prs_struct as done ( at end ) if no more SK records */
1142 /* mark end-of-block as True */
1144 if ( !found ) {
1145 prs_set_offset( &hbin->ps, prs_data_size(&hbin->ps) );
1146 *eob = True;
1147 return False;
1150 if ( !prs_set_offset( ps, curr_off ) )
1151 return False;
1153 return True;
1156 /*******************************************************************
1157 *******************************************************************/
1159 static bool next_nk_record( REGF_FILE *file, REGF_HBIN *hbin, REGF_NK_REC *nk, bool *eob )
1161 if ( next_record( hbin, "nk", eob ) && hbin_prs_key( file, hbin, nk ) )
1162 return True;
1164 return False;
1167 /*******************************************************************
1168 Intialize the newly created REGF_BLOCK in *file and write the
1169 block header to disk
1170 *******************************************************************/
1172 static bool init_regf_block( REGF_FILE *file )
1174 prs_struct ps;
1175 bool result = True;
1177 if ( !prs_init( &ps, REGF_BLOCKSIZE, file->mem_ctx, MARSHALL ) )
1178 return False;
1180 memcpy( file->header, "regf", REGF_HDR_SIZE );
1181 file->data_offset = 0x20;
1182 file->last_block = 0x1000;
1184 /* set mod time */
1186 unix_to_nt_time( &file->mtime, time(NULL) );
1188 /* hard coded values...no diea what these are ... maybe in time */
1190 file->unknown1 = 0x2;
1191 file->unknown2 = 0x1;
1192 file->unknown3 = 0x3;
1193 file->unknown4 = 0x0;
1194 file->unknown5 = 0x1;
1195 file->unknown6 = 0x1;
1197 /* write header to the buffer */
1199 if ( !prs_regf_block( "regf_header", &ps, 0, file ) ) {
1200 result = False;
1201 goto out;
1204 /* calculate the checksum, re-marshall data (to include the checksum)
1205 and write to disk */
1207 file->checksum = regf_block_checksum( &ps );
1208 prs_set_offset( &ps, 0 );
1209 if ( !prs_regf_block( "regf_header", &ps, 0, file ) ) {
1210 result = False;
1211 goto out;
1214 if ( write_block( file, &ps, 0 ) == -1 ) {
1215 DEBUG(0,("init_regf_block: Failed to initialize registry header block!\n"));
1216 result = False;
1217 goto out;
1220 out:
1221 prs_mem_free( &ps );
1223 return result;
1225 /*******************************************************************
1226 Open the registry file and then read in the REGF block to get the
1227 first hbin offset.
1228 *******************************************************************/
1230 REGF_FILE* regfio_open( const char *filename, int flags, int mode )
1232 REGF_FILE *rb;
1234 if ( !(rb = SMB_MALLOC_P(REGF_FILE)) ) {
1235 DEBUG(0,("ERROR allocating memory\n"));
1236 return NULL;
1238 ZERO_STRUCTP( rb );
1239 rb->fd = -1;
1241 if ( !(rb->mem_ctx = talloc_init( "read_regf_block" )) ) {
1242 regfio_close( rb );
1243 return NULL;
1246 rb->open_flags = flags;
1248 /* open and existing file */
1250 if ( (rb->fd = open(filename, flags, mode)) == -1 ) {
1251 DEBUG(0,("regfio_open: failure to open %s (%s)\n", filename, strerror(errno)));
1252 regfio_close( rb );
1253 return NULL;
1256 /* check if we are creating a new file or overwriting an existing one */
1258 if ( flags & (O_CREAT|O_TRUNC) ) {
1259 if ( !init_regf_block( rb ) ) {
1260 DEBUG(0,("regfio_open: Failed to read initial REGF block\n"));
1261 regfio_close( rb );
1262 return NULL;
1265 /* success */
1266 return rb;
1269 /* read in an existing file */
1271 if ( !read_regf_block( rb ) ) {
1272 DEBUG(0,("regfio_open: Failed to read initial REGF block\n"));
1273 regfio_close( rb );
1274 return NULL;
1277 /* success */
1279 return rb;
1282 /*******************************************************************
1283 *******************************************************************/
1285 static void regfio_mem_free( REGF_FILE *file )
1287 /* free any talloc()'d memory */
1289 if ( file && file->mem_ctx )
1290 talloc_destroy( file->mem_ctx );
1293 /*******************************************************************
1294 *******************************************************************/
1296 int regfio_close( REGF_FILE *file )
1298 int fd;
1300 /* cleanup for a file opened for write */
1302 if ((file->fd != -1) && (file->open_flags & (O_WRONLY|O_RDWR))) {
1303 prs_struct ps;
1304 REGF_SK_REC *sk;
1306 /* write of sd list */
1308 for ( sk=file->sec_desc_list; sk; sk=sk->next ) {
1309 hbin_prs_sk_rec( "sk_rec", sk->hbin, 0, sk );
1312 /* flush any dirty blocks */
1314 while ( file->block_list ) {
1315 hbin_block_close( file, file->block_list );
1318 ZERO_STRUCT( ps );
1320 unix_to_nt_time( &file->mtime, time(NULL) );
1322 if ( read_block( file, &ps, 0, REGF_BLOCKSIZE ) != -1 ) {
1323 /* now use for writing */
1324 prs_switch_type( &ps, MARSHALL );
1326 /* stream the block once, generate the checksum,
1327 and stream it again */
1328 prs_set_offset( &ps, 0 );
1329 prs_regf_block( "regf_blocK", &ps, 0, file );
1330 file->checksum = regf_block_checksum( &ps );
1331 prs_set_offset( &ps, 0 );
1332 prs_regf_block( "regf_blocK", &ps, 0, file );
1334 /* now we are ready to write it to disk */
1335 if ( write_block( file, &ps, 0 ) == -1 )
1336 DEBUG(0,("regfio_close: failed to update the regf header block!\n"));
1339 prs_mem_free( &ps );
1342 regfio_mem_free( file );
1344 /* nothing tdo do if there is no open file */
1346 if (file->fd == -1)
1347 return 0;
1349 fd = file->fd;
1350 file->fd = -1;
1351 SAFE_FREE( file );
1353 return close( fd );
1356 /*******************************************************************
1357 *******************************************************************/
1359 static void regfio_flush( REGF_FILE *file )
1361 REGF_HBIN *hbin;
1363 for ( hbin=file->block_list; hbin; hbin=hbin->next ) {
1364 write_hbin_block( file, hbin );
1368 /*******************************************************************
1369 There should be only *one* root key in the registry file based
1370 on my experience. --jerry
1371 *******************************************************************/
1373 REGF_NK_REC* regfio_rootkey( REGF_FILE *file )
1375 REGF_NK_REC *nk;
1376 REGF_HBIN *hbin;
1377 uint32_t offset = REGF_BLOCKSIZE;
1378 bool found = False;
1379 bool eob;
1381 if ( !file )
1382 return NULL;
1384 if ( !(nk = talloc_zero( file->mem_ctx, REGF_NK_REC )) ) {
1385 DEBUG(0,("regfio_rootkey: talloc() failed!\n"));
1386 return NULL;
1389 /* scan through the file on HBIN block at a time looking
1390 for an NK record with a type == 0x002c.
1391 Normally this is the first nk record in the first hbin
1392 block (but I'm not assuming that for now) */
1394 while ( (hbin = read_hbin_block( file, offset )) ) {
1395 eob = False;
1397 while ( !eob) {
1398 if ( next_nk_record( file, hbin, nk, &eob ) ) {
1399 if ( nk->key_type == NK_TYPE_ROOTKEY ) {
1400 found = True;
1401 break;
1404 prs_mem_free( &hbin->ps );
1407 if ( found )
1408 break;
1410 offset += hbin->block_size;
1413 if ( !found ) {
1414 DEBUG(0,("regfio_rootkey: corrupt registry file ? No root key record located\n"));
1415 return NULL;
1418 DLIST_ADD( file->block_list, hbin );
1420 return nk;
1423 /*******************************************************************
1424 This acts as an interator over the subkeys defined for a given
1425 NK record. Remember that offsets are from the *first* HBIN block.
1426 *******************************************************************/
1428 REGF_NK_REC* regfio_fetch_subkey( REGF_FILE *file, REGF_NK_REC *nk )
1430 REGF_NK_REC *subkey;
1431 REGF_HBIN *hbin;
1432 uint32_t nk_offset;
1434 /* see if there is anything left to report */
1436 if ( !nk || (nk->subkeys_off==REGF_OFFSET_NONE) || (nk->subkey_index >= nk->num_subkeys) )
1437 return NULL;
1439 /* find the HBIN block which should contain the nk record */
1441 if ( !(hbin = lookup_hbin_block( file, nk->subkeys.hashes[nk->subkey_index].nk_off )) ) {
1442 DEBUG(0,("hbin_prs_key: Failed to find HBIN block containing offset [0x%x]\n",
1443 nk->subkeys.hashes[nk->subkey_index].nk_off));
1444 return NULL;
1447 nk_offset = nk->subkeys.hashes[nk->subkey_index].nk_off;
1448 if ( !prs_set_offset( &hbin->ps, (HBIN_HDR_SIZE + nk_offset - hbin->first_hbin_off) ) )
1449 return NULL;
1451 nk->subkey_index++;
1452 if ( !(subkey = talloc_zero( file->mem_ctx, REGF_NK_REC )) )
1453 return NULL;
1455 if ( !hbin_prs_key( file, hbin, subkey ) )
1456 return NULL;
1458 return subkey;
1462 /*******************************************************************
1463 *******************************************************************/
1465 static REGF_HBIN* regf_hbin_allocate( REGF_FILE *file, uint32_t block_size )
1467 REGF_HBIN *hbin;
1468 SMB_STRUCT_STAT sbuf;
1470 if ( !(hbin = talloc_zero( file->mem_ctx, REGF_HBIN )) )
1471 return NULL;
1473 memcpy( hbin->header, "hbin", HBIN_HDR_SIZE);
1476 if (sys_fstat(file->fd, &sbuf, false)) {
1477 DEBUG(0,("regf_hbin_allocate: stat() failed! (%s)\n", strerror(errno)));
1478 return NULL;
1481 hbin->file_off = sbuf.st_ex_size;
1483 hbin->free_off = HBIN_HEADER_REC_SIZE;
1484 hbin->free_size = block_size - hbin->free_off + sizeof(uint32_t);
1486 hbin->block_size = block_size;
1487 hbin->first_hbin_off = hbin->file_off - REGF_BLOCKSIZE;
1489 if ( !prs_init( &hbin->ps, block_size, file->mem_ctx, MARSHALL ) )
1490 return NULL;
1492 if ( !prs_hbin_block( "new_hbin", &hbin->ps, 0, hbin ) )
1493 return NULL;
1495 if ( !write_hbin_block( file, hbin ) )
1496 return NULL;
1498 file->last_block = hbin->file_off;
1500 return hbin;
1503 /*******************************************************************
1504 *******************************************************************/
1506 static void update_free_space( REGF_HBIN *hbin, uint32_t size_used )
1508 hbin->free_off += size_used;
1509 hbin->free_size -= size_used;
1511 if ( hbin->free_off >= hbin->block_size ) {
1512 hbin->free_off = REGF_OFFSET_NONE;
1515 return;
1518 /*******************************************************************
1519 *******************************************************************/
1521 static REGF_HBIN* find_free_space( REGF_FILE *file, uint32_t size )
1523 REGF_HBIN *hbin, *p_hbin;
1524 uint32_t block_off;
1525 bool cached;
1527 /* check open block list */
1529 for ( hbin=file->block_list; hbin!=NULL; hbin=hbin->next ) {
1530 /* only check blocks that actually have available space */
1532 if ( hbin->free_off == REGF_OFFSET_NONE )
1533 continue;
1535 /* check for a large enough available chunk */
1537 if ( (hbin->block_size - hbin->free_off) >= size ) {
1538 DLIST_PROMOTE( file->block_list, hbin );
1539 goto done;
1543 /* parse the file until we find a block with
1544 enough free space; save the last non-filled hbin */
1546 block_off = REGF_BLOCKSIZE;
1547 do {
1548 /* cleanup before the next round */
1549 cached = False;
1550 if ( hbin )
1551 prs_mem_free( &hbin->ps );
1553 hbin = read_hbin_block( file, block_off );
1555 if ( hbin ) {
1557 /* make sure that we don't already have this block in memory */
1559 for ( p_hbin=file->block_list; p_hbin!=NULL; p_hbin=p_hbin->next ) {
1560 if ( p_hbin->file_off == hbin->file_off ) {
1561 cached = True;
1562 break;
1566 block_off = hbin->file_off + hbin->block_size;
1568 if ( cached ) {
1569 prs_mem_free( &hbin->ps );
1570 hbin = NULL;
1571 continue;
1574 /* if (cached block or (new block and not enough free space)) then continue looping */
1575 } while ( cached || (hbin && (hbin->free_size < size)) );
1577 /* no free space; allocate a new one */
1579 if ( !hbin ) {
1580 uint32_t alloc_size;
1582 /* allocate in multiples of REGF_ALLOC_BLOCK; make sure (size + hbin_header) fits */
1584 alloc_size = (((size+HBIN_HEADER_REC_SIZE) / REGF_ALLOC_BLOCK ) + 1 ) * REGF_ALLOC_BLOCK;
1586 if ( !(hbin = regf_hbin_allocate( file, alloc_size )) ) {
1587 DEBUG(0,("find_free_space: regf_hbin_allocate() failed!\n"));
1588 return NULL;
1590 DLIST_ADD( file->block_list, hbin );
1593 done:
1594 /* set the offset to be ready to write */
1596 if ( !prs_set_offset( &hbin->ps, hbin->free_off-sizeof(uint32_t) ) )
1597 return NULL;
1599 /* write the record size as a placeholder for now, it should be
1600 probably updated by the caller once it all of the data necessary
1601 for the record */
1603 if ( !prs_uint32("allocated_size", &hbin->ps, 0, &size) )
1604 return NULL;
1606 update_free_space( hbin, size );
1608 return hbin;
1611 /*******************************************************************
1612 *******************************************************************/
1614 static uint32_t sk_record_data_size( struct security_descriptor * sd )
1616 uint32_t size, size_mod8;
1618 size_mod8 = 0;
1620 /* the record size is sizeof(hdr) + name + static members + data_size_field */
1622 size = sizeof(uint32_t)*5 + ndr_size_security_descriptor(sd, 0) + sizeof(uint32_t);
1624 /* multiple of 8 */
1625 size_mod8 = size & 0xfffffff8;
1626 if ( size_mod8 < size )
1627 size_mod8 += 8;
1629 return size_mod8;
1632 /*******************************************************************
1633 *******************************************************************/
1635 static uint32_t vk_record_data_size( REGF_VK_REC *vk )
1637 uint32_t size, size_mod8;
1639 size_mod8 = 0;
1641 /* the record size is sizeof(hdr) + name + static members + data_size_field */
1643 size = REC_HDR_SIZE + (sizeof(uint16_t)*3) + (sizeof(uint32_t)*3) + sizeof(uint32_t);
1645 if ( vk->valuename )
1646 size += strlen(vk->valuename);
1648 /* multiple of 8 */
1649 size_mod8 = size & 0xfffffff8;
1650 if ( size_mod8 < size )
1651 size_mod8 += 8;
1653 return size_mod8;
1656 /*******************************************************************
1657 *******************************************************************/
1659 static uint32_t lf_record_data_size( uint32_t num_keys )
1661 uint32_t size, size_mod8;
1663 size_mod8 = 0;
1665 /* the record size is sizeof(hdr) + num_keys + sizeof of hash_array + data_size_uint32_t */
1667 size = REC_HDR_SIZE + sizeof(uint16_t) + (sizeof(REGF_HASH_REC) * num_keys) + sizeof(uint32_t);
1669 /* multiple of 8 */
1670 size_mod8 = size & 0xfffffff8;
1671 if ( size_mod8 < size )
1672 size_mod8 += 8;
1674 return size_mod8;
1677 /*******************************************************************
1678 *******************************************************************/
1680 static uint32_t nk_record_data_size( REGF_NK_REC *nk )
1682 uint32_t size, size_mod8;
1684 size_mod8 = 0;
1686 /* the record size is static + length_of_keyname + length_of_classname + data_size_uint32_t */
1688 size = 0x4c + strlen(nk->keyname) + sizeof(uint32_t);
1690 if ( nk->classname )
1691 size += strlen( nk->classname );
1693 /* multiple of 8 */
1694 size_mod8 = size & 0xfffffff8;
1695 if ( size_mod8 < size )
1696 size_mod8 += 8;
1698 return size_mod8;
1701 /*******************************************************************
1702 *******************************************************************/
1704 static bool create_vk_record(REGF_FILE *file, REGF_VK_REC *vk,
1705 struct regval_blob *value)
1707 char *name = regval_name(value);
1708 REGF_HBIN *data_hbin;
1710 ZERO_STRUCTP( vk );
1712 memcpy( vk->header, "vk", REC_HDR_SIZE );
1714 if ( name ) {
1715 vk->valuename = talloc_strdup( file->mem_ctx, regval_name(value) );
1716 vk->flag = VK_FLAG_NAME_PRESENT;
1719 vk->data_size = regval_size( value );
1720 vk->type = regval_type( value );
1722 if ( vk->data_size > sizeof(uint32_t) ) {
1723 uint32_t data_size = ( (vk->data_size+sizeof(uint32_t)) & 0xfffffff8 ) + 8;
1725 vk->data = (uint8_t *)talloc_memdup( file->mem_ctx,
1726 regval_data_p(value),
1727 vk->data_size );
1728 if (vk->data == NULL) {
1729 return False;
1732 /* go ahead and store the offset....we'll pick this hbin block back up when
1733 we stream the data */
1735 if ((data_hbin = find_free_space(file, data_size )) == NULL) {
1736 return False;
1738 vk->data_off = prs_offset( &data_hbin->ps ) + data_hbin->first_hbin_off - HBIN_HDR_SIZE;
1740 else {
1741 /* make sure we don't try to copy from a NULL value pointer */
1743 if ( vk->data_size != 0 )
1744 memcpy( &vk->data_off, regval_data_p(value), vk->data_size);
1745 vk->data_size |= VK_DATA_IN_OFFSET;
1748 return True;
1751 /*******************************************************************
1752 *******************************************************************/
1754 static int hashrec_cmp( REGF_HASH_REC *h1, REGF_HASH_REC *h2 )
1756 return strcasecmp_m( h1->fullname, h2->fullname );
1759 /*******************************************************************
1760 *******************************************************************/
1762 REGF_NK_REC* regfio_write_key( REGF_FILE *file, const char *name,
1763 struct regval_ctr *values, struct regsubkey_ctr *subkeys,
1764 struct security_descriptor *sec_desc, REGF_NK_REC *parent )
1766 REGF_NK_REC *nk;
1767 REGF_HBIN *vlist_hbin = NULL;
1768 uint32_t size;
1770 if ( !(nk = talloc_zero( file->mem_ctx, REGF_NK_REC )) )
1771 return NULL;
1773 memcpy( nk->header, "nk", REC_HDR_SIZE );
1775 if ( !parent )
1776 nk->key_type = NK_TYPE_ROOTKEY;
1777 else
1778 nk->key_type = NK_TYPE_NORMALKEY;
1780 /* store the parent offset (or -1 if a the root key */
1782 nk->parent_off = parent ? (parent->hbin_off + parent->hbin->file_off - REGF_BLOCKSIZE - HBIN_HDR_SIZE ) : REGF_OFFSET_NONE;
1784 /* no classname currently */
1786 nk->classname_off = REGF_OFFSET_NONE;
1787 nk->classname = NULL;
1788 nk->keyname = talloc_strdup( file->mem_ctx, name );
1790 /* current modification time */
1792 unix_to_nt_time( &nk->mtime, time(NULL) );
1794 /* allocate the record on disk */
1796 size = nk_record_data_size( nk );
1797 nk->rec_size = ( size - 1 ) ^ 0XFFFFFFFF;
1798 if ((nk->hbin = find_free_space( file, size )) == NULL) {
1799 return NULL;
1801 nk->hbin_off = prs_offset( &nk->hbin->ps );
1803 /* Update the hash record in the parent */
1805 if ( parent ) {
1806 REGF_HASH_REC *hash = &parent->subkeys.hashes[parent->subkey_index];
1808 hash->nk_off = prs_offset( &nk->hbin->ps ) + nk->hbin->first_hbin_off - HBIN_HDR_SIZE;
1809 memcpy(hash->keycheck, name, MIN(strlen(name),sizeof(uint32_t)));
1810 hash->fullname = talloc_strdup( file->mem_ctx, name );
1811 parent->subkey_index++;
1813 /* sort the list by keyname */
1814 TYPESAFE_QSORT(parent->subkeys.hashes, parent->subkey_index, hashrec_cmp);
1816 if ( !hbin_prs_lf_records( "lf_rec", parent->subkeys.hbin, 0, parent ) )
1817 return NULL;
1820 /* write the security descriptor */
1822 nk->sk_off = REGF_OFFSET_NONE;
1823 if ( sec_desc ) {
1824 uint32_t sk_size = sk_record_data_size( sec_desc );
1825 REGF_HBIN *sk_hbin;
1827 /* search for it in the existing list of sd's */
1829 if ( (nk->sec_desc = find_sk_record_by_sec_desc( file, sec_desc )) == NULL ) {
1830 /* not found so add it to the list */
1832 if (!(sk_hbin = find_free_space( file, sk_size ))) {
1833 return NULL;
1836 if ( !(nk->sec_desc = talloc_zero( file->mem_ctx, REGF_SK_REC )) )
1837 return NULL;
1839 /* now we have to store the security descriptor in the list and
1840 update the offsets */
1842 memcpy( nk->sec_desc->header, "sk", REC_HDR_SIZE );
1843 nk->sec_desc->hbin = sk_hbin;
1844 nk->sec_desc->hbin_off = prs_offset( &sk_hbin->ps );
1845 nk->sec_desc->sk_off = prs_offset( &sk_hbin->ps ) + sk_hbin->first_hbin_off - HBIN_HDR_SIZE;
1846 nk->sec_desc->rec_size = (sk_size-1) ^ 0xFFFFFFFF;
1848 nk->sec_desc->sec_desc = sec_desc;
1849 nk->sec_desc->ref_count = 0;
1851 /* size value must be self-inclusive */
1852 nk->sec_desc->size = ndr_size_security_descriptor(sec_desc, 0)
1853 + sizeof(uint32_t);
1855 DLIST_ADD_END( file->sec_desc_list, nk->sec_desc);
1857 /* update the offsets for us and the previous sd in the list.
1858 if this is the first record, then just set the next and prev
1859 offsets to ourself. */
1861 if ( DLIST_PREV(nk->sec_desc) ) {
1862 REGF_SK_REC *prev = DLIST_PREV(nk->sec_desc);
1864 nk->sec_desc->prev_sk_off = prev->hbin_off + prev->hbin->first_hbin_off - HBIN_HDR_SIZE;
1865 prev->next_sk_off = nk->sec_desc->sk_off;
1867 /* the end must loop around to the front */
1868 nk->sec_desc->next_sk_off = file->sec_desc_list->sk_off;
1870 /* and first must loop around to the tail */
1871 file->sec_desc_list->prev_sk_off = nk->sec_desc->sk_off;
1872 } else {
1873 nk->sec_desc->prev_sk_off = nk->sec_desc->sk_off;
1874 nk->sec_desc->next_sk_off = nk->sec_desc->sk_off;
1878 /* bump the reference count +1 */
1880 nk->sk_off = nk->sec_desc->sk_off;
1881 nk->sec_desc->ref_count++;
1884 /* write the subkeys */
1886 nk->subkeys_off = REGF_OFFSET_NONE;
1887 if ( (nk->num_subkeys = regsubkey_ctr_numkeys( subkeys )) != 0 ) {
1888 uint32_t lf_size = lf_record_data_size( nk->num_subkeys );
1889 uint32_t namelen;
1890 int i;
1892 if (!(nk->subkeys.hbin = find_free_space( file, lf_size ))) {
1893 return NULL;
1895 nk->subkeys.hbin_off = prs_offset( &nk->subkeys.hbin->ps );
1896 nk->subkeys.rec_size = (lf_size-1) ^ 0xFFFFFFFF;
1897 nk->subkeys_off = prs_offset( &nk->subkeys.hbin->ps ) + nk->subkeys.hbin->first_hbin_off - HBIN_HDR_SIZE;
1899 memcpy( nk->subkeys.header, "lf", REC_HDR_SIZE );
1901 nk->subkeys.num_keys = nk->num_subkeys;
1902 if (nk->subkeys.num_keys) {
1903 if ( !(nk->subkeys.hashes = talloc_zero_array( file->mem_ctx, REGF_HASH_REC, nk->subkeys.num_keys )) )
1904 return NULL;
1905 } else {
1906 nk->subkeys.hashes = NULL;
1908 nk->subkey_index = 0;
1910 /* update the max_bytes_subkey{name,classname} fields */
1911 for ( i=0; i<nk->num_subkeys; i++ ) {
1912 namelen = strlen( regsubkey_ctr_specific_key(subkeys, i) );
1913 if ( namelen*2 > nk->max_bytes_subkeyname )
1914 nk->max_bytes_subkeyname = namelen * 2;
1918 /* write the values */
1920 nk->values_off = REGF_OFFSET_NONE;
1921 if ( (nk->num_values = regval_ctr_numvals( values )) != 0 ) {
1922 uint32_t vlist_size = ( ( nk->num_values * sizeof(uint32_t) ) & 0xfffffff8 ) + 8;
1923 int i;
1925 if (!(vlist_hbin = find_free_space( file, vlist_size ))) {
1926 return NULL;
1928 nk->values_off = prs_offset( &vlist_hbin->ps ) + vlist_hbin->first_hbin_off - HBIN_HDR_SIZE;
1930 if (nk->num_values) {
1931 if ( !(nk->values = talloc_array( file->mem_ctx, REGF_VK_REC, nk->num_values )) )
1932 return NULL;
1933 } else {
1934 nk->values = NULL;
1937 /* create the vk records */
1939 for ( i=0; i<nk->num_values; i++ ) {
1940 uint32_t vk_size, namelen, datalen;
1941 struct regval_blob *r;
1943 r = regval_ctr_specific_value( values, i );
1944 create_vk_record( file, &nk->values[i], r );
1945 vk_size = vk_record_data_size( &nk->values[i] );
1946 nk->values[i].hbin = find_free_space( file, vk_size );
1947 nk->values[i].hbin_off = prs_offset( &nk->values[i].hbin->ps );
1948 nk->values[i].rec_size = ( vk_size - 1 ) ^ 0xFFFFFFFF;
1949 nk->values[i].rec_off = prs_offset( &nk->values[i].hbin->ps )
1950 + nk->values[i].hbin->first_hbin_off
1951 - HBIN_HDR_SIZE;
1953 /* update the max bytes fields if necessary */
1955 namelen = strlen( regval_name(r) );
1956 if ( namelen*2 > nk->max_bytes_valuename )
1957 nk->max_bytes_valuename = namelen * 2;
1959 datalen = regval_size( r );
1960 if ( datalen > nk->max_bytes_value )
1961 nk->max_bytes_value = datalen;
1965 /* stream the records */
1967 prs_set_offset( &nk->hbin->ps, nk->hbin_off );
1968 if ( !prs_nk_rec( "nk_rec", &nk->hbin->ps, 0, nk ) )
1969 return NULL;
1971 if ( nk->num_values ) {
1972 if ( !hbin_prs_vk_records( "vk_records", vlist_hbin, 0, nk, file ) )
1973 return NULL;
1977 regfio_flush( file );
1979 return nk;