source: trunk/lib/regfi.c @ 202

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

began implementing independent python subkey and value iterators
  • Property svn:keywords set to Id
File size: 97.7 KB
Line 
1/*
2 * Copyright (C) 2005-2010 Timothy D. Morgan
3 * Copyright (C) 2005 Gerald (Jerry) Carter
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; version 3 of the License.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 *
18 * $Id: regfi.c 202 2010-06-07 00:36:27Z tim $
19 */
20
21/**
22 * @file
23 *
24 * Windows NT (and later) read-only registry library
25 *
26 * See @ref regfi.h for more information.
27 *
28 * Branched from Samba project Subversion repository, version #7470:
29 *   http://viewcvs.samba.org/cgi-bin/viewcvs.cgi/trunk/source/registry/regfio.c?rev=7470&view=auto
30 *
31 * Since then, it has been heavily rewritten, simplified, and improved.
32 */
33
34#include "regfi.h"
35
36
37/* Registry types mapping */
38const unsigned int regfi_num_reg_types = 12;
39static const char* regfi_type_names[] =
40  {"NONE", "SZ", "EXPAND_SZ", "BINARY", "DWORD", "DWORD_BE", "LINK",
41   "MULTI_SZ", "RSRC_LIST", "RSRC_DESC", "RSRC_REQ_LIST", "QWORD"};
42
43const char* regfi_encoding_names[] =
44  {"US-ASCII//TRANSLIT", "UTF-8//TRANSLIT", "UTF-16LE//TRANSLIT"};
45
46
47/* Ensures regfi_init runs only once */
48static pthread_once_t regfi_init_once = PTHREAD_ONCE_INIT;
49
50
51
52/******************************************************************************
53 ******************************************************************************/
54void regfi_log_free(void* ptr)
55{
56  REGFI_LOG* log_info = (REGFI_LOG*)ptr;
57 
58  if(log_info->messages != NULL)
59    free(log_info->messages);
60
61  talloc_free(log_info);
62}
63
64
65/******************************************************************************
66 ******************************************************************************/
67void regfi_init()
68{
69  int err;
70  if((err = pthread_key_create(&regfi_log_key, regfi_log_free)) != 0)
71    fprintf(stderr, "ERROR: key_create: %s\n", strerror(err));
72  errno = err;
73}
74
75
76/******************************************************************************
77 ******************************************************************************/
78REGFI_LOG* regfi_log_new()
79{
80  int err;
81  REGFI_LOG* log_info = talloc(NULL, REGFI_LOG);
82  if(log_info == NULL)
83    return NULL;
84
85  log_info->msg_mask = REGFI_DEFAULT_LOG_MASK;
86  log_info->messages = NULL;
87
88  pthread_once(&regfi_init_once, regfi_init);
89
90  if((err = pthread_setspecific(regfi_log_key, log_info)) != 0)
91  {
92    fprintf(stderr, "ERROR: setspecific: %s\n", strerror(err));
93    goto fail;
94  }
95
96  return log_info;
97
98 fail:
99  talloc_free(log_info);
100  errno = err;
101  return NULL;
102}
103
104
105/******************************************************************************
106 ******************************************************************************/
107void regfi_log_add(uint16_t msg_type, const char* fmt, ...)
108{
109  /* XXX: Switch internal storage over to a linked list or stack.
110   *      Then add a regfi_log_get function that returns the list in some
111   *      convenient, user-friendly data structure.  regfi_log_get_str should
112   *      stick around and will simply smush the list into a big string when
113   *      it's called, rather than having messages smushed when they're first
114   *      written to the log.
115   */
116  uint32_t buf_size, buf_used;
117  char* new_msg;
118  REGFI_LOG* log_info;
119  va_list args;
120
121  log_info = (REGFI_LOG*)pthread_getspecific(regfi_log_key);
122  if(log_info == NULL && (log_info = regfi_log_new()) == NULL)
123    return;
124
125  if((log_info->msg_mask & msg_type) == 0)
126    return;
127
128  if(log_info->messages == NULL)
129    buf_used = 0;
130  else
131    buf_used = strlen(log_info->messages);
132 
133  buf_size = buf_used+strlen(fmt)+160;
134  new_msg = realloc(log_info->messages, buf_size);
135  if(new_msg == NULL)
136    /* XXX: should we report this? */
137    return;
138 
139  switch (msg_type)
140  {
141  case REGFI_LOG_INFO:
142    strcpy(new_msg+buf_used, "INFO: ");
143    buf_used += 6;
144    break;
145  case REGFI_LOG_WARN:
146    strcpy(new_msg+buf_used, "WARN: ");
147    buf_used += 6;
148    break;
149  case REGFI_LOG_ERROR:
150    strcpy(new_msg+buf_used, "ERROR: ");
151    buf_used += 7;
152    break;
153  }
154 
155  va_start(args, fmt);
156  vsnprintf(new_msg+buf_used, buf_size-buf_used, fmt, args);
157  va_end(args);
158  strncat(new_msg, "\n", buf_size-1);
159 
160  log_info->messages = new_msg;
161}
162
163
164/******************************************************************************
165 ******************************************************************************/
166char* regfi_log_get_str()
167{
168  char* ret_val;
169  REGFI_LOG* log_info = (REGFI_LOG*)pthread_getspecific(regfi_log_key);
170  if(log_info == NULL && (log_info = regfi_log_new()) == NULL)
171    return NULL;
172 
173  ret_val = log_info->messages;
174  log_info->messages = NULL;
175
176  return ret_val;
177}
178
179
180/******************************************************************************
181 ******************************************************************************/
182bool regfi_log_set_mask(uint16_t msg_mask)
183{
184  REGFI_LOG* log_info = (REGFI_LOG*)pthread_getspecific(regfi_log_key);
185  if(log_info == NULL && (log_info = regfi_log_new()) == NULL)
186  {
187      return false;
188  }
189
190  log_info->msg_mask = msg_mask;
191  return true;
192}
193
194
195/******************************************************************************
196 * Returns NULL for an invalid e
197 *****************************************************************************/
198static const char* regfi_encoding_int2str(REGFI_ENCODING e)
199{
200  if(e < REGFI_NUM_ENCODINGS)
201    return regfi_encoding_names[e];
202
203  return NULL;
204}
205
206
207/******************************************************************************
208 * Returns NULL for an invalid val
209 *****************************************************************************/
210const char* regfi_type_val2str(unsigned int val)
211{
212  if(val == REG_KEY)
213    return "KEY";
214 
215  if(val >= regfi_num_reg_types)
216    return NULL;
217 
218  return regfi_type_names[val];
219}
220
221
222/******************************************************************************
223 * Returns -1 on error
224 *****************************************************************************/
225int regfi_type_str2val(const char* str)
226{
227  int i;
228
229  if(strcmp("KEY", str) == 0)
230    return REG_KEY;
231
232  for(i=0; i < regfi_num_reg_types; i++)
233    if (strcmp(regfi_type_names[i], str) == 0) 
234      return i;
235
236  if(strcmp("DWORD_LE", str) == 0)
237    return REG_DWORD_LE;
238
239  return -1;
240}
241
242
243/* Security descriptor formatting functions  */
244
245const char* regfi_ace_type2str(uint8_t type)
246{
247  static const char* map[7] 
248    = {"ALLOW", "DENY", "AUDIT", "ALARM", 
249       "ALLOW CPD", "OBJ ALLOW", "OBJ DENY"};
250  if(type < 7)
251    return map[type];
252  else
253    /* XXX: would be nice to return the unknown integer value. 
254     *      However, as it is a const string, it can't be free()ed later on,
255     *      so that would need to change.
256     */
257    return "UNKNOWN";
258}
259
260
261/* XXX: need a better reference on the meaning of each flag. */
262/* For more info, see:
263 *   http://msdn2.microsoft.com/en-us/library/aa772242.aspx
264 */
265char* regfi_ace_flags2str(uint8_t flags)
266{
267  static const char* flag_map[32] = 
268    { "OI", /* Object Inherit */
269      "CI", /* Container Inherit */
270      "NP", /* Non-Propagate */
271      "IO", /* Inherit Only */
272      "IA", /* Inherited ACE */
273      NULL,
274      NULL,
275      NULL,
276    };
277
278  char* ret_val = malloc(35*sizeof(char));
279  char* fo = ret_val;
280  uint32_t i;
281  uint8_t f;
282
283  if(ret_val == NULL)
284    return NULL;
285
286  fo[0] = '\0';
287  if (!flags)
288    return ret_val;
289
290  for(i=0; i < 8; i++)
291  {
292    f = (1<<i);
293    if((flags & f) && (flag_map[i] != NULL))
294    {
295      strcpy(fo, flag_map[i]);
296      fo += strlen(flag_map[i]);
297      *(fo++) = ' ';
298      flags ^= f;
299    }
300  }
301 
302  /* Any remaining unknown flags are added at the end in hex. */
303  if(flags != 0)
304    sprintf(fo, "0x%.2X ", flags);
305
306  /* Chop off the last space if we've written anything to ret_val */
307  if(fo != ret_val)
308    fo[-1] = '\0';
309
310  return ret_val;
311}
312
313
314char* regfi_ace_perms2str(uint32_t perms)
315{
316  uint32_t i, p;
317  /* This is more than is needed by a fair margin. */
318  char* ret_val = malloc(350*sizeof(char));
319  char* r = ret_val;
320
321  /* Each represents one of 32 permissions bits.  NULL is for undefined/reserved bits.
322   * For more information, see:
323   *   http://msdn2.microsoft.com/en-gb/library/aa374892.aspx
324   *   http://msdn2.microsoft.com/en-gb/library/ms724878.aspx
325   */
326  static const char* perm_map[32] = 
327    {/* object-specific permissions (registry keys, in this case) */
328      "QRY_VAL",       /* KEY_QUERY_VALUE */
329      "SET_VAL",       /* KEY_SET_VALUE */
330      "CREATE_KEY",    /* KEY_CREATE_SUB_KEY */
331      "ENUM_KEYS",     /* KEY_ENUMERATE_SUB_KEYS */
332      "NOTIFY",        /* KEY_NOTIFY */
333      "CREATE_LNK",    /* KEY_CREATE_LINK - Reserved for system use. */
334      NULL,
335      NULL,
336      "WOW64_64",      /* KEY_WOW64_64KEY */
337      "WOW64_32",      /* KEY_WOW64_32KEY */
338      NULL,
339      NULL,
340      NULL,
341      NULL,
342      NULL,
343      NULL,
344      /* standard access rights */
345      "DELETE",        /* DELETE */
346      "R_CONT",        /* READ_CONTROL */
347      "W_DAC",         /* WRITE_DAC */
348      "W_OWNER",       /* WRITE_OWNER */
349      "SYNC",          /* SYNCHRONIZE - Shouldn't be set in registries */
350      NULL,
351      NULL,
352      NULL,
353      /* other generic */
354      "SYS_SEC",       /* ACCESS_SYSTEM_SECURITY */
355      "MAX_ALLWD",     /* MAXIMUM_ALLOWED */
356      NULL,
357      NULL,
358      "GEN_A",         /* GENERIC_ALL */
359      "GEN_X",         /* GENERIC_EXECUTE */
360      "GEN_W",         /* GENERIC_WRITE */
361      "GEN_R",         /* GENERIC_READ */
362    };
363
364
365  if(ret_val == NULL)
366    return NULL;
367
368  r[0] = '\0';
369  for(i=0; i < 32; i++)
370  {
371    p = (1<<i);
372    if((perms & p) && (perm_map[i] != NULL))
373    {
374      strcpy(r, perm_map[i]);
375      r += strlen(perm_map[i]);
376      *(r++) = ' ';
377      perms ^= p;
378    }
379  }
380 
381  /* Any remaining unknown permission bits are added at the end in hex. */
382  if(perms != 0)
383    sprintf(r, "0x%.8X ", perms);
384
385  /* Chop off the last space if we've written anything to ret_val */
386  if(r != ret_val)
387    r[-1] = '\0';
388
389  return ret_val;
390}
391
392
393char* regfi_sid2str(WINSEC_DOM_SID* sid)
394{
395  uint32_t i, size = WINSEC_MAX_SUBAUTHS*11 + 24;
396  uint32_t left = size;
397  uint8_t comps = sid->num_auths;
398  char* ret_val = malloc(size);
399 
400  if(ret_val == NULL)
401    return NULL;
402
403  if(comps > WINSEC_MAX_SUBAUTHS)
404    comps = WINSEC_MAX_SUBAUTHS;
405
406  left -= sprintf(ret_val, "S-%u-%u", sid->sid_rev_num, sid->id_auth[5]);
407
408  for (i = 0; i < comps; i++) 
409    left -= snprintf(ret_val+(size-left), left, "-%u", sid->sub_auths[i]);
410
411  return ret_val;
412}
413
414
415char* regfi_get_acl(WINSEC_ACL* acl)
416{
417  uint32_t i, extra, size = 0;
418  const char* type_str;
419  char* flags_str;
420  char* perms_str;
421  char* sid_str;
422  char* ace_delim = "";
423  char* ret_val = NULL;
424  char* tmp_val = NULL;
425  bool failed = false;
426  char field_delim = ':';
427
428  for (i = 0; i < acl->num_aces && !failed; i++)
429  {
430    sid_str = regfi_sid2str(acl->aces[i]->trustee);
431    type_str = regfi_ace_type2str(acl->aces[i]->type);
432    perms_str = regfi_ace_perms2str(acl->aces[i]->access_mask);
433    flags_str = regfi_ace_flags2str(acl->aces[i]->flags);
434   
435    if(flags_str != NULL && perms_str != NULL 
436       && type_str != NULL && sid_str != NULL)
437    {
438      /* XXX: this is slow */
439      extra = strlen(sid_str) + strlen(type_str) 
440        + strlen(perms_str) + strlen(flags_str) + 5;
441      tmp_val = realloc(ret_val, size+extra);
442
443      if(tmp_val == NULL)
444      {
445        free(ret_val);
446        ret_val = NULL;
447        failed = true;
448      }
449      else
450      {
451        ret_val = tmp_val;
452        size += sprintf(ret_val+size, "%s%s%c%s%c%s%c%s",
453                        ace_delim,sid_str,
454                        field_delim,type_str,
455                        field_delim,perms_str,
456                        field_delim,flags_str);
457        ace_delim = "|";
458      }
459    }
460    else
461      failed = true;
462
463    if(sid_str != NULL)
464      free(sid_str);
465    if(sid_str != NULL)
466      free(perms_str);
467    if(sid_str != NULL)
468      free(flags_str);
469  }
470
471  return ret_val;
472}
473
474
475char* regfi_get_sacl(WINSEC_DESC *sec_desc)
476{
477  if (sec_desc->sacl)
478    return regfi_get_acl(sec_desc->sacl);
479  else
480    return NULL;
481}
482
483
484char* regfi_get_dacl(WINSEC_DESC *sec_desc)
485{
486  if (sec_desc->dacl)
487    return regfi_get_acl(sec_desc->dacl);
488  else
489    return NULL;
490}
491
492
493char* regfi_get_owner(WINSEC_DESC *sec_desc)
494{
495  return regfi_sid2str(sec_desc->owner_sid);
496}
497
498
499char* regfi_get_group(WINSEC_DESC *sec_desc)
500{
501  return regfi_sid2str(sec_desc->grp_sid);
502}
503
504
505bool regfi_read_lock(REGFI_FILE* file, pthread_rwlock_t* lock, const char* context)
506{
507  int lock_ret = pthread_rwlock_rdlock(lock);
508  if(lock_ret != 0)
509  {
510    regfi_log_add(REGFI_LOG_ERROR, "Error obtaining read lock in"
511                      "%s due to: %s\n", context, strerror(lock_ret));
512    return false;
513  }
514
515  return true;
516}
517
518
519bool regfi_write_lock(REGFI_FILE* file, pthread_rwlock_t* lock, const char* context)
520{
521  int lock_ret = pthread_rwlock_wrlock(lock);
522  if(lock_ret != 0)
523  {
524    regfi_log_add(REGFI_LOG_ERROR, "Error obtaining write lock in"
525                      "%s due to: %s\n", context, strerror(lock_ret));
526    return false;
527  }
528
529  return true;
530}
531
532
533bool regfi_rw_unlock(REGFI_FILE* file, pthread_rwlock_t* lock, const char* context)
534{
535  int lock_ret = pthread_rwlock_unlock(lock);
536  if(lock_ret != 0)
537  {
538    regfi_log_add(REGFI_LOG_ERROR, "Error releasing lock in"
539                      "%s due to: %s\n", context, strerror(lock_ret));
540    return false;
541  }
542
543  return true;
544}
545
546
547bool regfi_lock(REGFI_FILE* file, pthread_mutex_t* lock, const char* context)
548{
549  int lock_ret = pthread_mutex_lock(lock);
550  if(lock_ret != 0)
551  {
552    regfi_log_add(REGFI_LOG_ERROR, "Error obtaining mutex lock in"
553                      "%s due to: %s\n", context, strerror(lock_ret));
554    return false;
555  }
556
557  return true;
558}
559
560
561bool regfi_unlock(REGFI_FILE* file, pthread_mutex_t* lock, const char* context)
562{
563  int lock_ret = pthread_mutex_unlock(lock);
564  if(lock_ret != 0)
565  {
566    regfi_log_add(REGFI_LOG_ERROR, "Error releasing mutex lock in"
567                      "%s due to: %s\n", context, strerror(lock_ret));
568    return false;
569  }
570
571  return true;
572}
573
574
575off_t regfi_raw_seek(REGFI_RAW_FILE* self, off_t offset, int whence)
576{
577  return lseek(*(int*)self->state, offset, whence);
578}
579
580ssize_t regfi_raw_read(REGFI_RAW_FILE* self, void* buf, size_t count)
581{
582  return read(*(int*)self->state, buf, count);
583}
584
585
586/*****************************************************************************
587 * Convenience function to wrap up the ugly callback stuff
588 *****************************************************************************/
589off_t regfi_seek(REGFI_RAW_FILE* file_cb, off_t offset, int whence)
590{
591  return file_cb->seek(file_cb, offset, whence);
592}
593
594
595/*****************************************************************************
596 * This function is just like read(2), except that it continues to
597 * re-try reading from the file descriptor if EINTR or EAGAIN is received. 
598 * regfi_read will attempt to read length bytes from the file and write them to
599 * buf.
600 *
601 * On success, 0 is returned.  Upon failure, an errno code is returned.
602 *
603 * The number of bytes successfully read is returned through the length
604 * parameter by reference.  If both the return value and length parameter are
605 * returned as 0, then EOF was encountered immediately
606 *****************************************************************************/
607uint32_t regfi_read(REGFI_RAW_FILE* file_cb, uint8_t* buf, uint32_t* length)
608{
609  uint32_t rsize = 0;
610  uint32_t rret = 0;
611
612  do
613  {
614    rret = file_cb->read(file_cb, buf + rsize, *length - rsize);
615    if(rret > 0)
616      rsize += rret;
617  }while(*length - rsize > 0 
618         && (rret > 0 || (rret == -1 && (errno == EAGAIN || errno == EINTR))));
619 
620  *length = rsize;
621  if (rret == -1 && errno != EINTR && errno != EAGAIN)
622    return errno;
623
624  return 0;
625}
626
627
628/*****************************************************************************
629 *
630 *****************************************************************************/
631bool regfi_parse_cell(REGFI_RAW_FILE* file_cb, uint32_t offset, uint8_t* hdr, 
632                      uint32_t hdr_len, uint32_t* cell_length, bool* unalloc)
633{
634  uint32_t length;
635  int32_t raw_length;
636  uint8_t tmp[4];
637
638  if(regfi_seek(file_cb, offset, SEEK_SET) == -1)
639    return false;
640
641  length = 4;
642  if((regfi_read(file_cb, tmp, &length) != 0) || length != 4)
643    return false;
644  raw_length = IVALS(tmp, 0);
645
646  if(raw_length < 0)
647  {
648    (*cell_length) = raw_length*(-1);
649    (*unalloc) = false;
650  }
651  else
652  {
653    (*cell_length) = raw_length;
654    (*unalloc) = true;
655  }
656
657  if(*cell_length - 4 < hdr_len)
658    return false;
659
660  if(hdr_len > 0)
661  {
662    length = hdr_len;
663    if((regfi_read(file_cb, hdr, &length) != 0) || length != hdr_len)
664      return false;
665  }
666
667  return true;
668}
669
670
671/******************************************************************************
672 * Given an offset and an hbin, is the offset within that hbin?
673 * The offset is a virtual file offset.
674 ******************************************************************************/
675static bool regfi_offset_in_hbin(const REGFI_HBIN* hbin, uint32_t voffset)
676{
677  if(!hbin)
678    return false;
679
680  if((voffset > hbin->first_hbin_off) 
681     && (voffset < (hbin->first_hbin_off + hbin->block_size)))
682    return true;
683               
684  return false;
685}
686
687
688
689/******************************************************************************
690 * Provide a physical offset and receive the correpsonding HBIN
691 * block for it.  NULL if one doesn't exist.
692 ******************************************************************************/
693const REGFI_HBIN* regfi_lookup_hbin(REGFI_FILE* file, uint32_t offset)
694{
695  return (const REGFI_HBIN*)range_list_find_data(file->hbins, offset);
696}
697
698
699/******************************************************************************
700 * Calculate the largest possible cell size given a physical offset.
701 * Largest size is based on the HBIN the offset is currently a member of.
702 * Returns negative values on error.
703 * (Since cells can only be ~2^31 in size, this works out.)
704 ******************************************************************************/
705int32_t regfi_calc_maxsize(REGFI_FILE* file, uint32_t offset)
706{
707  const REGFI_HBIN* hbin = regfi_lookup_hbin(file, offset);
708  if(hbin == NULL)
709    return -1;
710
711  return (hbin->block_size + hbin->file_off) - offset;
712}
713
714
715/******************************************************************************
716 ******************************************************************************/
717REGFI_SUBKEY_LIST* regfi_load_subkeylist(REGFI_FILE* file, uint32_t offset, 
718                                         uint32_t num_keys, uint32_t max_size, 
719                                         bool strict)
720{
721  REGFI_SUBKEY_LIST* ret_val;
722
723  ret_val = regfi_load_subkeylist_aux(file, offset, max_size, strict, 
724                                      REGFI_MAX_SUBKEY_DEPTH);
725  if(ret_val == NULL)
726  {
727    regfi_log_add(REGFI_LOG_WARN, "Failed to load subkey list at"
728                      " offset 0x%.8X.", offset);
729    return NULL;
730  }
731
732  if(num_keys != ret_val->num_keys)
733  {
734    /*  Not sure which should be authoritative, the number from the
735     *  NK record, or the number in the subkey list.  Just emit a warning for
736     *  now if they don't match.
737     */
738    regfi_log_add(REGFI_LOG_WARN, "Number of subkeys listed in parent"
739                      " (%d) did not match number found in subkey list/tree (%d)"
740                      " while parsing subkey list/tree at offset 0x%.8X.", 
741                      num_keys, ret_val->num_keys, offset);
742  }
743
744  return ret_val;
745}
746
747
748/******************************************************************************
749 ******************************************************************************/
750REGFI_SUBKEY_LIST* regfi_load_subkeylist_aux(REGFI_FILE* file, uint32_t offset, 
751                                             uint32_t max_size, bool strict,
752                                             uint8_t depth_left)
753{
754  REGFI_SUBKEY_LIST* ret_val;
755  REGFI_SUBKEY_LIST** sublists;
756  uint32_t i, num_sublists, off;
757  int32_t sublist_maxsize;
758
759  if(depth_left == 0)
760  {
761    regfi_log_add(REGFI_LOG_WARN, "Maximum depth reached"
762                      " while parsing subkey list/tree at offset 0x%.8X.", 
763                      offset);
764    return NULL;
765  }
766
767  ret_val = regfi_parse_subkeylist(file, offset, max_size, strict);
768  if(ret_val == NULL)
769    return NULL;
770
771  if(ret_val->recursive_type)
772  {
773    num_sublists = ret_val->num_children;
774    sublists = (REGFI_SUBKEY_LIST**)malloc(num_sublists
775                                           * sizeof(REGFI_SUBKEY_LIST*));
776    for(i=0; i < num_sublists; i++)
777    {
778      off = ret_val->elements[i].offset + REGFI_REGF_SIZE;
779
780      sublist_maxsize = regfi_calc_maxsize(file, off);
781      if(sublist_maxsize < 0)
782        sublists[i] = NULL;
783      else
784        sublists[i] = regfi_load_subkeylist_aux(file, off, sublist_maxsize, 
785                                                strict, depth_left-1);
786    }
787    talloc_free(ret_val);
788
789    return regfi_merge_subkeylists(num_sublists, sublists, strict);
790  }
791
792  return ret_val;
793}
794
795
796/******************************************************************************
797 ******************************************************************************/
798REGFI_SUBKEY_LIST* regfi_parse_subkeylist(REGFI_FILE* file, uint32_t offset, 
799                                          uint32_t max_size, bool strict)
800{
801  REGFI_SUBKEY_LIST* ret_val;
802  uint32_t i, cell_length, length, elem_size, read_len;
803  uint8_t* elements = NULL;
804  uint8_t buf[REGFI_SUBKEY_LIST_MIN_LEN];
805  bool unalloc;
806  bool recursive_type;
807
808  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_subkeylist"))
809     goto fail;
810
811  if(!regfi_parse_cell(file->cb, offset, buf, REGFI_SUBKEY_LIST_MIN_LEN,
812                       &cell_length, &unalloc))
813  {
814    regfi_log_add(REGFI_LOG_WARN, "Could not parse cell while "
815                      "parsing subkey-list at offset 0x%.8X.", offset);
816    goto fail_locked;
817  }
818
819  if(cell_length > max_size)
820  {
821    regfi_log_add(REGFI_LOG_WARN, "Cell size longer than max_size"
822                      " while parsing subkey-list at offset 0x%.8X.", offset);
823    if(strict)
824      goto fail_locked;
825    cell_length = max_size & 0xFFFFFFF8;
826  }
827
828  recursive_type = false;
829  if(buf[0] == 'r' && buf[1] == 'i')
830  {
831    recursive_type = true;
832    elem_size = sizeof(uint32_t);
833  }
834  else if(buf[0] == 'l' && buf[1] == 'i')
835    elem_size = sizeof(uint32_t);
836  else if((buf[0] == 'l') && (buf[1] == 'f' || buf[1] == 'h'))
837    elem_size = sizeof(REGFI_SUBKEY_LIST_ELEM);
838  else
839  {
840    regfi_log_add(REGFI_LOG_ERROR, "Unknown magic number"
841                      " (0x%.2X, 0x%.2X) encountered while parsing"
842                      " subkey-list at offset 0x%.8X.", buf[0], buf[1], offset);
843    goto fail_locked;
844  }
845
846  ret_val = talloc(NULL, REGFI_SUBKEY_LIST);
847  if(ret_val == NULL)
848    goto fail_locked;
849
850  ret_val->offset = offset;
851  ret_val->cell_size = cell_length;
852  ret_val->magic[0] = buf[0];
853  ret_val->magic[1] = buf[1];
854  ret_val->recursive_type = recursive_type;
855  ret_val->num_children = SVAL(buf, 0x2);
856
857  if(!recursive_type)
858    ret_val->num_keys = ret_val->num_children;
859
860  length = elem_size*ret_val->num_children;
861  if(cell_length - REGFI_SUBKEY_LIST_MIN_LEN - sizeof(uint32_t) < length)
862  {
863    regfi_log_add(REGFI_LOG_WARN, "Number of elements too large for"
864                      " cell while parsing subkey-list at offset 0x%.8X.", 
865                      offset);
866    if(strict)
867      goto fail_locked;
868    length = cell_length - REGFI_SUBKEY_LIST_MIN_LEN - sizeof(uint32_t);
869  }
870
871  ret_val->elements = talloc_array(ret_val, REGFI_SUBKEY_LIST_ELEM, 
872                                   ret_val->num_children);
873  if(ret_val->elements == NULL)
874    goto fail_locked;
875
876  elements = (uint8_t*)malloc(length);
877  if(elements == NULL)
878    goto fail_locked;
879
880  read_len = length;
881  if(regfi_read(file->cb, elements, &read_len) != 0 || read_len!=length)
882    goto fail_locked;
883
884  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_subkeylist"))
885     goto fail;
886
887  if(elem_size == sizeof(uint32_t))
888  {
889    for (i=0; i < ret_val->num_children; i++)
890    {
891      ret_val->elements[i].offset = IVAL(elements, i*elem_size);
892      ret_val->elements[i].hash = 0;
893    }
894  }
895  else
896  {
897    for (i=0; i < ret_val->num_children; i++)
898    {
899      ret_val->elements[i].offset = IVAL(elements, i*elem_size);
900      ret_val->elements[i].hash = IVAL(elements, i*elem_size+4);
901    }
902  }
903  free(elements);
904
905  return ret_val;
906
907 fail_locked:
908  regfi_unlock(file, &file->cb_lock, "regfi_parse_subkeylist");
909 fail:
910  if(elements != NULL)
911    free(elements);
912  talloc_free(ret_val);
913  return NULL;
914}
915
916
917/*******************************************************************
918 *******************************************************************/
919REGFI_SUBKEY_LIST* regfi_merge_subkeylists(uint16_t num_lists, 
920                                           REGFI_SUBKEY_LIST** lists,
921                                           bool strict)
922{
923  uint32_t i,j,k;
924  REGFI_SUBKEY_LIST* ret_val;
925
926  if(lists == NULL)
927    return NULL;
928  ret_val = talloc(NULL, REGFI_SUBKEY_LIST);
929
930  if(ret_val == NULL)
931    return NULL;
932 
933  /* Obtain total number of elements */
934  ret_val->num_keys = 0;
935  for(i=0; i < num_lists; i++)
936  {
937    if(lists[i] != NULL)
938      ret_val->num_keys += lists[i]->num_children;
939  }
940  ret_val->num_children = ret_val->num_keys;
941
942  if(ret_val->num_keys > 0)
943  {
944    ret_val->elements = talloc_array(ret_val, REGFI_SUBKEY_LIST_ELEM,
945                                     ret_val->num_keys);
946    k=0;
947
948    if(ret_val->elements != NULL)
949    {
950      for(i=0; i < num_lists; i++)
951      {
952        if(lists[i] != NULL)
953        {
954          for(j=0; j < lists[i]->num_keys; j++)
955          {
956            ret_val->elements[k].hash = lists[i]->elements[j].hash;
957            ret_val->elements[k++].offset = lists[i]->elements[j].offset;
958          }
959        }
960      }
961    }
962  }
963 
964  for(i=0; i < num_lists; i++)
965    talloc_free(lists[i]);
966  free(lists);
967
968  return ret_val;
969}
970
971
972/******************************************************************************
973 *
974 ******************************************************************************/
975REGFI_SK_REC* regfi_parse_sk(REGFI_FILE* file, uint32_t offset, uint32_t max_size, 
976                             bool strict)
977{
978  REGFI_SK_REC* ret_val = NULL;
979  uint8_t* sec_desc_buf = NULL;
980  uint32_t cell_length, length;
981  uint8_t sk_header[REGFI_SK_MIN_LENGTH];
982  bool unalloc = false;
983
984  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_sk"))
985     goto fail;
986
987  if(!regfi_parse_cell(file->cb, offset, sk_header, REGFI_SK_MIN_LENGTH,
988                       &cell_length, &unalloc))
989  {
990    regfi_log_add(REGFI_LOG_WARN, "Could not parse SK record cell"
991                      " at offset 0x%.8X.", offset);
992    goto fail_locked;
993  }
994   
995  if(sk_header[0] != 's' || sk_header[1] != 'k')
996  {
997    regfi_log_add(REGFI_LOG_WARN, "Magic number mismatch in parsing"
998                      " SK record at offset 0x%.8X.", offset);
999    goto fail_locked;
1000  }
1001
1002  ret_val = talloc(NULL, REGFI_SK_REC);
1003  if(ret_val == NULL)
1004    goto fail_locked;
1005
1006  ret_val->offset = offset;
1007  /* XXX: Is there a way to be more conservative (shorter) with
1008   *      cell length when cell is unallocated?
1009   */
1010  ret_val->cell_size = cell_length;
1011
1012  if(ret_val->cell_size > max_size)
1013    ret_val->cell_size = max_size & 0xFFFFFFF8;
1014  if((ret_val->cell_size < REGFI_SK_MIN_LENGTH) 
1015     || (strict && (ret_val->cell_size & 0x00000007) != 0))
1016  {
1017    regfi_log_add(REGFI_LOG_WARN, "Invalid cell size found while"
1018                      " parsing SK record at offset 0x%.8X.", offset);
1019    goto fail_locked;
1020  }
1021
1022  ret_val->magic[0] = sk_header[0];
1023  ret_val->magic[1] = sk_header[1];
1024
1025  ret_val->unknown_tag = SVAL(sk_header, 0x2);
1026  ret_val->prev_sk_off = IVAL(sk_header, 0x4);
1027  ret_val->next_sk_off = IVAL(sk_header, 0x8);
1028  ret_val->ref_count = IVAL(sk_header, 0xC);
1029  ret_val->desc_size = IVAL(sk_header, 0x10);
1030
1031  if((ret_val->prev_sk_off & 0x00000007) != 0
1032     || (ret_val->next_sk_off & 0x00000007) != 0)
1033  {
1034    regfi_log_add(REGFI_LOG_WARN, "SK record's next/previous offsets"
1035                      " are not a multiple of 8 while parsing SK record at"
1036                      " offset 0x%.8X.", offset);
1037    goto fail_locked;
1038  }
1039
1040  if(ret_val->desc_size + REGFI_SK_MIN_LENGTH > ret_val->cell_size)
1041  {
1042    regfi_log_add(REGFI_LOG_WARN, "Security descriptor too large for"
1043                      " cell while parsing SK record at offset 0x%.8X.", 
1044                      offset);
1045    goto fail_locked;
1046  }
1047
1048  sec_desc_buf = (uint8_t*)malloc(ret_val->desc_size);
1049  if(sec_desc_buf == NULL)
1050    goto fail_locked;
1051
1052  length = ret_val->desc_size;
1053  if(regfi_read(file->cb, sec_desc_buf, &length) != 0 
1054     || length != ret_val->desc_size)
1055  {
1056    regfi_log_add(REGFI_LOG_ERROR, "Failed to read security"
1057                      " descriptor while parsing SK record at offset 0x%.8X.",
1058                      offset);
1059    goto fail_locked;
1060  }
1061
1062  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_sk"))
1063     goto fail;
1064
1065  if(!(ret_val->sec_desc = winsec_parse_desc(ret_val, sec_desc_buf, 
1066                                                   ret_val->desc_size)))
1067  {
1068    regfi_log_add(REGFI_LOG_ERROR, "Failed to parse security"
1069                      " descriptor while parsing SK record at offset 0x%.8X.",
1070                      offset);
1071    goto fail;
1072  }
1073
1074  free(sec_desc_buf);
1075  return ret_val;
1076
1077 fail_locked:
1078  regfi_unlock(file, &file->cb_lock, "regfi_parse_sk");
1079 fail:
1080  if(sec_desc_buf != NULL)
1081    free(sec_desc_buf);
1082  talloc_free(ret_val);
1083  return NULL;
1084}
1085
1086
1087REGFI_VALUE_LIST* regfi_parse_valuelist(REGFI_FILE* file, uint32_t offset, 
1088                                        uint32_t num_values, bool strict)
1089{
1090  REGFI_VALUE_LIST* ret_val;
1091  uint32_t i, cell_length, length, read_len;
1092  bool unalloc;
1093
1094  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_valuelist"))
1095     goto fail;
1096
1097  if(!regfi_parse_cell(file->cb, offset, NULL, 0, &cell_length, &unalloc))
1098  {
1099    regfi_log_add(REGFI_LOG_ERROR, "Failed to read cell header"
1100                      " while parsing value list at offset 0x%.8X.", offset);
1101    goto fail_locked;
1102  }
1103
1104  if((cell_length & 0x00000007) != 0)
1105  {
1106    regfi_log_add(REGFI_LOG_WARN, "Cell length not a multiple of 8"
1107                      " while parsing value list at offset 0x%.8X.", offset);
1108    if(strict)
1109      goto fail_locked;
1110    cell_length = cell_length & 0xFFFFFFF8;
1111  }
1112
1113  if((num_values * sizeof(uint32_t)) > cell_length-sizeof(uint32_t))
1114  {
1115    regfi_log_add(REGFI_LOG_WARN, "Too many values found"
1116                      " while parsing value list at offset 0x%.8X.", offset);
1117    if(strict)
1118      goto fail_locked;
1119    num_values = cell_length/sizeof(uint32_t) - sizeof(uint32_t);
1120  }
1121
1122  read_len = num_values*sizeof(uint32_t);
1123  ret_val = talloc(NULL, REGFI_VALUE_LIST);
1124  if(ret_val == NULL)
1125    goto fail_locked;
1126
1127  ret_val->elements = (REGFI_VALUE_LIST_ELEM*)talloc_size(ret_val, read_len);
1128  if(ret_val->elements == NULL)
1129    goto fail_locked;
1130
1131  ret_val->num_values = num_values;
1132
1133  length = read_len;
1134  if((regfi_read(file->cb, (uint8_t*)ret_val->elements, &length) != 0) 
1135     || length != read_len)
1136  {
1137    regfi_log_add(REGFI_LOG_ERROR, "Failed to read value pointers"
1138                      " while parsing value list at offset 0x%.8X.", offset);
1139    goto fail_locked;
1140  }
1141 
1142  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_valuelist"))
1143     goto fail;
1144
1145  for(i=0; i < num_values; i++)
1146  {
1147    /* Fix endianness */
1148    ret_val->elements[i] = IVAL(&ret_val->elements[i], 0);
1149
1150    /* Validate the first num_values values to ensure they make sense */
1151    if(strict)
1152    {
1153      /* XXX: Need to revisit this file length check when we start dealing
1154       *      with partial files. */
1155      if((ret_val->elements[i] + REGFI_REGF_SIZE > file->file_length)
1156         || ((ret_val->elements[i] & 0x00000007) != 0))
1157      {
1158        regfi_log_add(REGFI_LOG_WARN, "Invalid value pointer"
1159                          " (0x%.8X) found while parsing value list at offset"
1160                          " 0x%.8X.", ret_val->elements[i], offset);
1161        goto fail;
1162      }
1163    }
1164  }
1165
1166  return ret_val;
1167
1168 fail_locked:
1169  regfi_unlock(file, &file->cb_lock, "regfi_parse_valuelist");
1170 fail:
1171  talloc_free(ret_val);
1172  return NULL;
1173}
1174
1175
1176void regfi_interpret_valuename(REGFI_FILE* file, REGFI_VK_REC* vk, 
1177                               REGFI_ENCODING output_encoding, bool strict)
1178{
1179  /* XXX: Registry value names are supposedly limited to 16383 characters
1180   *      according to:
1181   *      http://msdn.microsoft.com/en-us/library/ms724872%28VS.85%29.aspx
1182   *      Might want to emit a warning if this is exceeded. 
1183   *      It is expected that "characters" could be variable width.
1184   *      Also, it may be useful to use this information to limit false positives
1185   *      when recovering deleted VK records.
1186   */
1187  int32_t tmp_size;
1188  REGFI_ENCODING from_encoding = (vk->flags & REGFI_VK_FLAG_ASCIINAME)
1189    ? REGFI_ENCODING_ASCII : REGFI_ENCODING_UTF16LE;
1190
1191  if(from_encoding == output_encoding)
1192  {
1193    vk->valuename_raw = talloc_realloc(vk, vk->valuename_raw,
1194                                            uint8_t, vk->name_length+1);
1195    vk->valuename_raw[vk->name_length] = '\0';
1196    vk->valuename = (char*)vk->valuename_raw;
1197  }
1198  else
1199  {
1200    vk->valuename = talloc_array(vk, char, vk->name_length+1);
1201    if(vk->valuename == NULL)
1202    {
1203      talloc_free(vk);
1204      return;
1205    }
1206
1207    tmp_size = regfi_conv_charset(regfi_encoding_int2str(from_encoding),
1208                                  regfi_encoding_int2str(output_encoding),
1209                                  vk->valuename_raw, vk->valuename,
1210                                  vk->name_length, vk->name_length+1);
1211    if(tmp_size < 0)
1212    {
1213      regfi_log_add(REGFI_LOG_WARN, "Error occurred while converting"
1214                        " valuename to encoding %s.  Error message: %s",
1215                        regfi_encoding_int2str(output_encoding), 
1216                        strerror(-tmp_size));
1217      talloc_free(vk->valuename);
1218      vk->valuename = NULL;
1219    }
1220  }
1221}
1222
1223
1224/******************************************************************************
1225 ******************************************************************************/
1226REGFI_VK_REC* regfi_load_value(REGFI_FILE* file, uint32_t offset, 
1227                               REGFI_ENCODING output_encoding, bool strict)
1228{
1229  REGFI_VK_REC* ret_val = NULL;
1230  int32_t max_size;
1231
1232  max_size = regfi_calc_maxsize(file, offset);
1233  if(max_size < 0)
1234    return NULL;
1235 
1236  ret_val = regfi_parse_vk(file, offset, max_size, strict);
1237  if(ret_val == NULL)
1238    return NULL;
1239
1240  regfi_interpret_valuename(file, ret_val, output_encoding, strict);
1241
1242  return ret_val;
1243}
1244
1245
1246/******************************************************************************
1247 * If !strict, the list may contain NULLs, VK records may point to NULL.
1248 ******************************************************************************/
1249REGFI_VALUE_LIST* regfi_load_valuelist(REGFI_FILE* file, uint32_t offset, 
1250                                       uint32_t num_values, uint32_t max_size,
1251                                       bool strict)
1252{
1253  uint32_t usable_num_values;
1254
1255  if((num_values+1) * sizeof(uint32_t) > max_size)
1256  {
1257    regfi_log_add(REGFI_LOG_WARN, "Number of values indicated by"
1258                      " parent key (%d) would cause cell to straddle HBIN"
1259                      " boundary while loading value list at offset"
1260                      " 0x%.8X.", num_values, offset);
1261    if(strict)
1262      return NULL;
1263    usable_num_values = max_size/sizeof(uint32_t) - sizeof(uint32_t);
1264  }
1265  else
1266    usable_num_values = num_values;
1267
1268  return regfi_parse_valuelist(file, offset, usable_num_values, strict);
1269}
1270
1271
1272void regfi_interpret_keyname(REGFI_FILE* file, REGFI_NK_REC* nk, 
1273                             REGFI_ENCODING output_encoding, bool strict)
1274{
1275  /* XXX: Registry key names are supposedly limited to 255 characters according to:
1276   *      http://msdn.microsoft.com/en-us/library/ms724872%28VS.85%29.aspx
1277   *      Might want to emit a warning if this is exceeded. 
1278   *      It is expected that "characters" could be variable width.
1279   *      Also, it may be useful to use this information to limit false positives
1280   *      when recovering deleted NK records.
1281   */
1282  int32_t tmp_size;
1283  REGFI_ENCODING from_encoding = (nk->flags & REGFI_NK_FLAG_ASCIINAME) 
1284    ? REGFI_ENCODING_ASCII : REGFI_ENCODING_UTF16LE;
1285 
1286  if(from_encoding == output_encoding)
1287  {
1288    nk->keyname_raw = talloc_realloc(nk, nk->keyname_raw, uint8_t, nk->name_length+1);
1289    nk->keyname_raw[nk->name_length] = '\0';
1290    nk->keyname = (char*)nk->keyname_raw;
1291  }
1292  else
1293  {
1294    nk->keyname = talloc_array(nk, char, nk->name_length+1);
1295    if(nk->keyname == NULL)
1296    {
1297      talloc_free(nk);
1298      return;
1299    }
1300
1301    tmp_size = regfi_conv_charset(regfi_encoding_int2str(from_encoding),
1302                                  regfi_encoding_int2str(output_encoding),
1303                                  nk->keyname_raw, nk->keyname,
1304                                  nk->name_length, nk->name_length+1);
1305    if(tmp_size < 0)
1306    {
1307      regfi_log_add(REGFI_LOG_WARN, "Error occurred while converting"
1308                        " keyname to encoding %s.  Error message: %s",
1309                        regfi_encoding_int2str(output_encoding), 
1310                        strerror(-tmp_size));
1311      talloc_free(nk->keyname);
1312      nk->keyname = NULL;
1313    }
1314  }
1315}
1316
1317
1318/******************************************************************************
1319 *
1320 ******************************************************************************/
1321REGFI_NK_REC* regfi_load_key(REGFI_FILE* file, uint32_t offset,
1322                             REGFI_ENCODING output_encoding, bool strict)
1323{
1324  REGFI_NK_REC* nk;
1325  uint32_t off;
1326  int32_t max_size;
1327
1328  max_size = regfi_calc_maxsize(file, offset);
1329  if (max_size < 0) 
1330    return NULL;
1331
1332  /* get the initial nk record */
1333  if((nk = regfi_parse_nk(file, offset, max_size, true)) == NULL)
1334  {
1335    regfi_log_add(REGFI_LOG_ERROR, "Could not load NK record at"
1336                  " offset 0x%.8X.", offset);
1337    return NULL;
1338  }
1339
1340  regfi_interpret_keyname(file, nk, output_encoding, strict);
1341
1342  /* get value list */
1343  if(nk->num_values && (nk->values_off!=REGFI_OFFSET_NONE)) 
1344  {
1345    off = nk->values_off + REGFI_REGF_SIZE;
1346    max_size = regfi_calc_maxsize(file, off);
1347    if(max_size < 0)
1348    {
1349      if(strict)
1350      {
1351        talloc_free(nk);
1352        return NULL;
1353      }
1354      else
1355        nk->values = NULL;
1356
1357    }
1358    else
1359    {
1360      nk->values = regfi_load_valuelist(file, off, nk->num_values, 
1361                                        max_size, true);
1362      if(nk->values == NULL)
1363      {
1364        regfi_log_add(REGFI_LOG_WARN, "Could not load value list"
1365                      " for NK record at offset 0x%.8X.", offset);
1366        if(strict)
1367        {
1368          talloc_free(nk);
1369          return NULL;
1370        }
1371      }
1372      talloc_steal(nk, nk->values);
1373    }
1374  }
1375
1376  /* now get subkey list */
1377  if(nk->num_subkeys && (nk->subkeys_off != REGFI_OFFSET_NONE)) 
1378  {
1379    off = nk->subkeys_off + REGFI_REGF_SIZE;
1380    max_size = regfi_calc_maxsize(file, off);
1381    if(max_size < 0) 
1382    {
1383      if(strict)
1384      {
1385        talloc_free(nk);
1386        return NULL;
1387      }
1388      else
1389        nk->subkeys = NULL;
1390    }
1391    else
1392    {
1393      nk->subkeys = regfi_load_subkeylist(file, off, nk->num_subkeys,
1394                                          max_size, true);
1395
1396      if(nk->subkeys == NULL)
1397      {
1398        regfi_log_add(REGFI_LOG_WARN, "Could not load subkey list"
1399                      " while parsing NK record at offset 0x%.8X.", offset);
1400        nk->num_subkeys = 0;
1401      }
1402      talloc_steal(nk, nk->subkeys);
1403    }
1404  }
1405
1406  return nk;
1407}
1408
1409
1410/******************************************************************************
1411 ******************************************************************************/
1412const REGFI_SK_REC* regfi_load_sk(REGFI_FILE* file, uint32_t offset, bool strict)
1413{
1414  REGFI_SK_REC* ret_val = NULL;
1415  int32_t max_size;
1416  void* failure_ptr = NULL;
1417 
1418  max_size = regfi_calc_maxsize(file, offset);
1419  if(max_size < 0)
1420    return NULL;
1421
1422  if(file->sk_cache == NULL)
1423    return regfi_parse_sk(file, offset, max_size, strict);
1424
1425  if(!regfi_lock(file, &file->sk_lock, "regfi_load_sk"))
1426    return NULL;
1427
1428  /* First look if we have already parsed it */
1429  ret_val = (REGFI_SK_REC*)lru_cache_find(file->sk_cache, &offset, 4);
1430
1431  /* Bail out if we have previously cached a parse failure at this offset. */
1432  if(ret_val == (void*)REGFI_OFFSET_NONE)
1433    return NULL;
1434
1435  if(ret_val == NULL)
1436  {
1437    ret_val = regfi_parse_sk(file, offset, max_size, strict);
1438    if(ret_val == NULL)
1439    { /* Cache the parse failure and bail out. */
1440      failure_ptr = talloc(NULL, uint32_t);
1441      if(failure_ptr == NULL)
1442        return NULL;
1443      *(uint32_t*)failure_ptr = REGFI_OFFSET_NONE;
1444      lru_cache_update(file->sk_cache, &offset, 4, failure_ptr);
1445
1446      /* Let the cache be the only owner of this */
1447      talloc_unlink(NULL, failure_ptr);
1448      return NULL;
1449    }
1450  }
1451
1452  if(!regfi_unlock(file, &file->sk_lock, "regfi_load_sk"))
1453  {
1454    talloc_unlink(NULL, ret_val);
1455    return NULL;
1456  }
1457
1458  return ret_val;
1459}
1460
1461
1462
1463/******************************************************************************
1464 ******************************************************************************/
1465REGFI_NK_REC* regfi_find_root_nk(REGFI_FILE* file, const REGFI_HBIN* hbin, 
1466                                 REGFI_ENCODING output_encoding)
1467{
1468  REGFI_NK_REC* nk = NULL;
1469  uint32_t cell_length;
1470  uint32_t cur_offset = hbin->file_off+REGFI_HBIN_HEADER_SIZE;
1471  uint32_t hbin_end = hbin->file_off+hbin->block_size;
1472  bool unalloc;
1473
1474  while(cur_offset < hbin_end)
1475  {
1476
1477    if(!regfi_lock(file, &file->cb_lock, "regfi_find_root_nk"))
1478      return NULL;
1479
1480    if(!regfi_parse_cell(file->cb, cur_offset, NULL, 0, &cell_length, &unalloc))
1481    {
1482      regfi_log_add(REGFI_LOG_WARN, "Could not parse cell at offset"
1483                    " 0x%.8X while searching for root key.", cur_offset);
1484      return NULL;
1485    }
1486
1487    if(!regfi_unlock(file, &file->cb_lock, "regfi_find_root_nk"))
1488      return NULL;
1489
1490    if(!unalloc)
1491    {
1492      nk = regfi_load_key(file, cur_offset, output_encoding, true);
1493      if(nk != NULL)
1494      {
1495        if(nk->flags & REGFI_NK_FLAG_ROOT)
1496          return nk;
1497      }
1498    }
1499
1500    cur_offset += cell_length;
1501  }
1502
1503  return NULL;
1504}
1505
1506
1507
1508/******************************************************************************
1509 ******************************************************************************/
1510REGFI_FILE* regfi_alloc(int fd)
1511{
1512  REGFI_FILE* ret_val;
1513  REGFI_RAW_FILE* file_cb = talloc(NULL, REGFI_RAW_FILE);
1514  if(file_cb == NULL) 
1515    return NULL;
1516
1517  file_cb->state = (void*)talloc(file_cb, int);
1518  if(file_cb->state == NULL)
1519    goto fail;
1520  *(int*)file_cb->state = fd;
1521 
1522  file_cb->cur_off = 0;
1523  file_cb->size = 0;
1524  file_cb->read = &regfi_raw_read;
1525  file_cb->seek = &regfi_raw_seek;
1526 
1527  ret_val = regfi_alloc_cb(file_cb);
1528  if(ret_val == NULL)
1529    goto fail;
1530
1531  /* In this case, we want file_cb to be freed when ret_val is */
1532  talloc_steal(ret_val, file_cb);
1533  return ret_val;
1534
1535 fail:
1536    talloc_free(file_cb);
1537    return NULL;
1538}
1539
1540
1541/******************************************************************************
1542 ******************************************************************************/
1543int regfi_free_cb(void* f)
1544{
1545  REGFI_FILE* file = (REGFI_FILE*)f;
1546
1547  pthread_mutex_destroy(&file->cb_lock);
1548  pthread_rwlock_destroy(&file->hbins_lock);
1549  pthread_mutex_destroy(&file->sk_lock);
1550
1551  return 0;
1552}
1553
1554
1555/******************************************************************************
1556 ******************************************************************************/
1557REGFI_FILE* regfi_alloc_cb(REGFI_RAW_FILE* file_cb)
1558{
1559  REGFI_FILE* rb;
1560  REGFI_HBIN* hbin = NULL;
1561  uint32_t hbin_off, cache_secret;
1562  int32_t file_length;
1563  bool rla;
1564
1565  /* Determine file length.  Must be at least big enough for the header
1566   * and one hbin.
1567   */
1568  file_length = file_cb->seek(file_cb, 0, SEEK_END);
1569  if(file_length < REGFI_REGF_SIZE+REGFI_HBIN_ALLOC)
1570  {
1571    regfi_log_add(REGFI_LOG_ERROR, "File length (%d) too short to contain a"
1572                  " header and at least one HBIN.", file_length);
1573    return NULL;
1574  }
1575  file_cb->seek(file_cb, 0, SEEK_SET);
1576
1577  /* Read file header */
1578  if ((rb = regfi_parse_regf(file_cb, false)) == NULL) 
1579  {
1580    regfi_log_add(REGFI_LOG_ERROR, "Failed to read REGF block.");
1581    return NULL;
1582  }
1583  rb->file_length = file_length; 
1584  rb->cb = file_cb;
1585
1586  if(pthread_mutex_init(&rb->cb_lock, NULL) != 0)
1587  {
1588    regfi_log_add(REGFI_LOG_ERROR, "Failed to create cb_lock mutex.");
1589    goto fail;
1590  }
1591
1592  if(pthread_rwlock_init(&rb->hbins_lock, NULL) != 0)
1593  {
1594    regfi_log_add(REGFI_LOG_ERROR, "Failed to create hbins_lock rwlock.");
1595    goto fail;
1596  }
1597
1598  if(pthread_mutex_init(&rb->sk_lock, NULL) != 0)
1599  {
1600    regfi_log_add(REGFI_LOG_ERROR, "Failed to create sk_lock mutex.");
1601    goto fail;
1602  }
1603
1604  rb->hbins = range_list_new();
1605  if(rb->hbins == NULL)
1606  {
1607    regfi_log_add(REGFI_LOG_ERROR, "Failed to create HBIN range_list.");
1608    goto fail;
1609  }
1610  talloc_steal(rb, rb->hbins);
1611
1612  rla = true;
1613  hbin_off = REGFI_REGF_SIZE;
1614  hbin = regfi_parse_hbin(rb, hbin_off, true);
1615  while(hbin && rla)
1616  {
1617    rla = range_list_add(rb->hbins, hbin->file_off, hbin->block_size, hbin);
1618    if(rla)
1619      talloc_steal(rb->hbins, hbin);
1620
1621    hbin_off = hbin->file_off + hbin->block_size;
1622    hbin = regfi_parse_hbin(rb, hbin_off, true);
1623  }
1624
1625  /* This secret isn't very secret, but we don't need a good one.  This
1626   * secret is just designed to prevent someone from trying to blow our
1627   * caching and make things slow.
1628   */
1629  cache_secret = 0x15DEAD05^time(NULL)^(getpid()<<16);
1630
1631  if(REGFI_CACHE_SK)
1632    rb->sk_cache = lru_cache_create_ctx(rb, 64, cache_secret, true);
1633  else
1634    rb->sk_cache = NULL;
1635
1636  /* success */
1637  talloc_set_destructor(rb, regfi_free_cb);
1638  return rb;
1639
1640 fail:
1641  pthread_mutex_destroy(&rb->cb_lock);
1642  pthread_rwlock_destroy(&rb->hbins_lock);
1643  pthread_mutex_destroy(&rb->sk_lock);
1644
1645  range_list_free(rb->hbins);
1646  talloc_free(rb);
1647  return NULL;
1648}
1649
1650
1651/******************************************************************************
1652 ******************************************************************************/
1653void regfi_free(REGFI_FILE* file)
1654{
1655  /* Callback handles cleanup side effects */
1656  talloc_free(file);
1657}
1658
1659
1660/******************************************************************************
1661 * First checks the offset given by the file header, then checks the
1662 * rest of the file if that fails.
1663 ******************************************************************************/
1664REGFI_NK_REC* regfi_rootkey(REGFI_FILE* file, REGFI_ENCODING output_encoding)
1665{
1666  REGFI_NK_REC* nk = NULL;
1667  REGFI_HBIN* hbin;
1668  uint32_t root_offset, i, num_hbins;
1669 
1670  if(!file)
1671    return NULL;
1672
1673  root_offset = file->root_cell+REGFI_REGF_SIZE;
1674  nk = regfi_load_key(file, root_offset, output_encoding, true);
1675  if(nk != NULL)
1676  {
1677    if(nk->flags & REGFI_NK_FLAG_ROOT)
1678      return nk;
1679  }
1680
1681  regfi_log_add(REGFI_LOG_WARN, "File header indicated root key at"
1682                " location 0x%.8X, but no root key found."
1683                " Searching rest of file...", root_offset);
1684 
1685  /* If the file header gives bad info, scan through the file one HBIN
1686   * block at a time looking for an NK record with a root key type.
1687   */
1688 
1689  if(!regfi_read_lock(file, &file->hbins_lock, "regfi_rootkey"))
1690    return NULL;
1691
1692  num_hbins = range_list_size(file->hbins);
1693  for(i=0; i < num_hbins && nk == NULL; i++)
1694  {
1695    hbin = (REGFI_HBIN*)range_list_get(file->hbins, i)->data;
1696    nk = regfi_find_root_nk(file, hbin, output_encoding);
1697  }
1698
1699  if(!regfi_rw_unlock(file, &file->hbins_lock, "regfi_rootkey"))
1700    return NULL;
1701
1702  return nk;
1703}
1704
1705
1706/******************************************************************************
1707 *****************************************************************************/
1708void regfi_free_record(const void* record)
1709{
1710  talloc_unlink(NULL, (void*)record);
1711}
1712
1713
1714
1715/******************************************************************************
1716 *****************************************************************************/
1717REGFI_ITERATOR* regfi_iterator_new(REGFI_FILE* file, 
1718                                   REGFI_ENCODING output_encoding)
1719{
1720  REGFI_NK_REC* root;
1721  REGFI_ITERATOR* ret_val;
1722
1723  if(output_encoding != REGFI_ENCODING_UTF8
1724     && output_encoding != REGFI_ENCODING_ASCII)
1725  { 
1726    regfi_log_add(REGFI_LOG_ERROR, "Invalid output_encoding supplied"
1727                  " in creation of regfi iterator.");
1728    return NULL;
1729  }
1730
1731  ret_val = talloc(NULL, REGFI_ITERATOR);
1732  if(ret_val == NULL)
1733    return NULL;
1734
1735  root = regfi_rootkey(file, output_encoding);
1736  if(root == NULL)
1737  {
1738    talloc_free(ret_val);
1739    return NULL;
1740  }
1741  ret_val->cur_key = root;
1742  talloc_reference(ret_val, root);
1743
1744  ret_val->key_positions = void_stack_new(REGFI_MAX_DEPTH);
1745  if(ret_val->key_positions == NULL)
1746  {
1747    talloc_free(ret_val);
1748    return NULL;
1749  }
1750  talloc_steal(ret_val, ret_val->key_positions);
1751
1752  ret_val->f = file;
1753  ret_val->cur_subkey = 0;
1754  ret_val->cur_value = 0;
1755  ret_val->string_encoding = output_encoding;
1756   
1757  return ret_val;
1758}
1759
1760
1761/******************************************************************************
1762 *****************************************************************************/
1763void regfi_iterator_free(REGFI_ITERATOR* i)
1764{
1765  talloc_free(i);
1766}
1767
1768
1769
1770/******************************************************************************
1771 *****************************************************************************/
1772/* XXX: some way of indicating reason for failure should be added. */
1773bool regfi_iterator_down(REGFI_ITERATOR* i)
1774{
1775  REGFI_NK_REC* subkey;
1776  REGFI_ITER_POSITION* pos;
1777
1778  pos = talloc(i->key_positions, REGFI_ITER_POSITION);
1779  if(pos == NULL)
1780    return false;
1781
1782  subkey = (REGFI_NK_REC*)regfi_iterator_cur_subkey(i);
1783  if(subkey == NULL)
1784  {
1785    talloc_free(pos);
1786    return false;
1787  }
1788
1789  pos->nk = i->cur_key;
1790  pos->cur_subkey = i->cur_subkey;
1791  if(!void_stack_push(i->key_positions, pos))
1792  {
1793    talloc_free(pos);
1794    talloc_unlink(NULL, subkey);
1795    return false;
1796  }
1797  talloc_reference(i, subkey);
1798
1799  i->cur_key = subkey;
1800  i->cur_subkey = 0;
1801  i->cur_value = 0;
1802
1803  return true;
1804}
1805
1806
1807/******************************************************************************
1808 *****************************************************************************/
1809bool regfi_iterator_up(REGFI_ITERATOR* i)
1810{
1811  REGFI_ITER_POSITION* pos;
1812
1813  pos = (REGFI_ITER_POSITION*)void_stack_pop(i->key_positions);
1814  if(pos == NULL)
1815    return false;
1816
1817  talloc_unlink(i, i->cur_key);
1818  i->cur_key = pos->nk;
1819  i->cur_subkey = pos->cur_subkey;
1820  i->cur_value = 0;
1821  talloc_free(pos);
1822
1823  return true;
1824}
1825
1826
1827/******************************************************************************
1828 *****************************************************************************/
1829bool regfi_iterator_to_root(REGFI_ITERATOR* i)
1830{
1831  while(regfi_iterator_up(i))
1832    continue;
1833
1834  return true;
1835}
1836
1837
1838/******************************************************************************
1839 *****************************************************************************/
1840bool regfi_iterator_find_subkey(REGFI_ITERATOR* i, const char* subkey_name)
1841{
1842  REGFI_NK_REC* subkey;
1843  bool found = false;
1844  uint32_t old_subkey = i->cur_subkey;
1845
1846  if(subkey_name == NULL)
1847    return false;
1848
1849  /* XXX: this alloc/free of each sub key might be a bit excessive */
1850  regfi_iterator_first_subkey(i);
1851  while((subkey = regfi_iterator_cur_subkey(i)) != NULL && (found == false))
1852  {
1853    if(subkey->keyname != NULL 
1854       && strcasecmp(subkey->keyname, subkey_name) == 0)
1855      found = true;
1856    else
1857    {
1858      talloc_unlink(NULL, subkey);
1859      regfi_iterator_next_subkey(i);
1860    }
1861  }
1862
1863  if(found == false)
1864  {
1865    i->cur_subkey = old_subkey;
1866    return false;
1867  }
1868
1869  talloc_unlink(NULL, subkey);
1870  return true;
1871}
1872
1873
1874/******************************************************************************
1875 *****************************************************************************/
1876bool regfi_iterator_walk_path(REGFI_ITERATOR* i, const char** path)
1877{
1878  uint32_t x;
1879  if(path == NULL)
1880    return false;
1881
1882  for(x=0; 
1883      ((path[x] != NULL) && regfi_iterator_find_subkey(i, path[x])
1884       && regfi_iterator_down(i));
1885      x++)
1886  { continue; }
1887
1888  if(path[x] == NULL)
1889    return true;
1890 
1891  /* XXX: is this the right number of times? */
1892  for(; x > 0; x--)
1893    regfi_iterator_up(i);
1894 
1895  return false;
1896}
1897
1898
1899/******************************************************************************
1900 *****************************************************************************/
1901const REGFI_NK_REC* regfi_iterator_cur_key(REGFI_ITERATOR* i)
1902{
1903  return i->cur_key;
1904}
1905
1906
1907/******************************************************************************
1908 *****************************************************************************/
1909const REGFI_SK_REC* regfi_iterator_cur_sk(REGFI_ITERATOR* i)
1910{
1911  if(i->cur_key == NULL || i->cur_key->sk_off == REGFI_OFFSET_NONE)
1912    return NULL;
1913
1914  return regfi_load_sk(i->f, i->cur_key->sk_off + REGFI_REGF_SIZE, true);
1915}
1916
1917
1918/******************************************************************************
1919 *****************************************************************************/
1920bool regfi_iterator_first_subkey(REGFI_ITERATOR* i)
1921{
1922  i->cur_subkey = 0;
1923 
1924  return ((i->cur_key != NULL) && (i->cur_key->subkeys_off!=REGFI_OFFSET_NONE) 
1925          && (i->cur_subkey < i->cur_key->num_subkeys)); 
1926}
1927
1928
1929/******************************************************************************
1930 *****************************************************************************/
1931const REGFI_NK_REC* regfi_iterator_cur_subkey(REGFI_ITERATOR* i)
1932{
1933  uint32_t nk_offset;
1934
1935  if((i->cur_key != NULL) && (i->cur_key->subkeys_off!=REGFI_OFFSET_NONE) 
1936     && (i->cur_subkey < i->cur_key->num_subkeys))
1937  {
1938    nk_offset = i->cur_key->subkeys->elements[i->cur_subkey].offset;
1939
1940    return regfi_load_key(i->f, nk_offset+REGFI_REGF_SIZE, 
1941                          i->string_encoding, true);
1942  }
1943
1944  return NULL;
1945}
1946
1947
1948/******************************************************************************
1949 *****************************************************************************/
1950bool regfi_iterator_next_subkey(REGFI_ITERATOR* i)
1951{
1952  i->cur_subkey++;
1953
1954  return ((i->cur_key != NULL) && (i->cur_key->subkeys_off!=REGFI_OFFSET_NONE) 
1955          && (i->cur_subkey < i->cur_key->num_subkeys)); 
1956}
1957
1958
1959/******************************************************************************
1960 *****************************************************************************/
1961bool regfi_iterator_find_value(REGFI_ITERATOR* i, const char* value_name)
1962{
1963  const REGFI_VK_REC* cur;
1964  bool found = false;
1965  uint32_t old_value = i->cur_value;
1966
1967  /* XXX: cur->valuename can be NULL in the registry. 
1968   *      Should we allow for a way to search for that?
1969   */
1970  if(value_name == NULL)
1971    return false;
1972
1973  regfi_iterator_first_value(i);
1974  while((cur = regfi_iterator_cur_value(i)) != NULL && (found == false))
1975  {
1976    if((cur->valuename != NULL)
1977       && (strcasecmp(cur->valuename, value_name) == 0))
1978      found = true;
1979    else
1980    {
1981      regfi_free_record(cur);
1982      regfi_iterator_next_value(i);
1983    }
1984  }
1985 
1986  if(found == false)
1987  {
1988    i->cur_value = old_value;
1989    return false;
1990  }
1991
1992  regfi_free_record(cur);
1993  return true;
1994}
1995
1996
1997/******************************************************************************
1998 *****************************************************************************/
1999bool regfi_iterator_first_value(REGFI_ITERATOR* i)
2000{
2001  i->cur_value = 0;
2002  return (i->cur_key->values != NULL && i->cur_key->values->elements != NULL 
2003          && (i->cur_value < i->cur_key->values->num_values));
2004}
2005
2006
2007/******************************************************************************
2008 *****************************************************************************/
2009const REGFI_VK_REC* regfi_iterator_cur_value(REGFI_ITERATOR* i)
2010{
2011  REGFI_VK_REC* ret_val = NULL;
2012  uint32_t voffset;
2013
2014  if(i->cur_key->values != NULL && i->cur_key->values->elements != NULL 
2015     && (i->cur_value < i->cur_key->values->num_values))
2016  {
2017    voffset = i->cur_key->values->elements[i->cur_value];
2018    ret_val = regfi_load_value(i->f, voffset+REGFI_REGF_SIZE, 
2019                               i->string_encoding, true);
2020  }
2021
2022  return ret_val;
2023}
2024
2025
2026/******************************************************************************
2027 *****************************************************************************/
2028bool regfi_iterator_next_value(REGFI_ITERATOR* i)
2029{
2030  i->cur_value++;
2031  return (i->cur_key->values != NULL && i->cur_key->values->elements != NULL 
2032          && (i->cur_value < i->cur_key->values->num_values));
2033}
2034
2035
2036/******************************************************************************
2037 *****************************************************************************/
2038const REGFI_CLASSNAME* regfi_iterator_fetch_classname(REGFI_ITERATOR* i,
2039                                                      const REGFI_NK_REC* key)
2040{
2041  REGFI_CLASSNAME* ret_val;
2042  uint8_t* raw;
2043  char* interpreted;
2044  uint32_t offset;
2045  int32_t conv_size, max_size;
2046  uint16_t parse_length;
2047
2048  if(key->classname_off == REGFI_OFFSET_NONE || key->classname_length == 0)
2049    return NULL;
2050
2051  offset = key->classname_off + REGFI_REGF_SIZE;
2052  max_size = regfi_calc_maxsize(i->f, offset);
2053  if(max_size <= 0)
2054    return NULL;
2055
2056  parse_length = key->classname_length;
2057  raw = regfi_parse_classname(i->f, offset, &parse_length, max_size, true);
2058 
2059  if(raw == NULL)
2060  {
2061    regfi_log_add(REGFI_LOG_WARN, "Could not parse class"
2062                  " name at offset 0x%.8X for key record at offset 0x%.8X.",
2063                  offset, key->offset);
2064    return NULL;
2065  }
2066
2067  ret_val = talloc(NULL, REGFI_CLASSNAME);
2068  if(ret_val == NULL)
2069    return NULL;
2070
2071  ret_val->raw = raw;
2072  ret_val->size = parse_length;
2073  talloc_steal(ret_val, raw);
2074
2075  interpreted = talloc_array(NULL, char, parse_length);
2076
2077  conv_size = regfi_conv_charset(regfi_encoding_int2str(REGFI_ENCODING_UTF16LE),
2078                                 regfi_encoding_int2str(i->string_encoding),
2079                                 raw, interpreted,
2080                                 parse_length, parse_length);
2081  if(conv_size < 0)
2082  {
2083    regfi_log_add(REGFI_LOG_WARN, "Error occurred while"
2084                  " converting classname to charset %s.  Error message: %s",
2085                  i->string_encoding, strerror(-conv_size));
2086    talloc_free(interpreted);
2087    ret_val->interpreted = NULL;
2088  }
2089  else
2090  {
2091    interpreted = talloc_realloc(NULL, interpreted, char, conv_size);
2092    ret_val->interpreted = interpreted;
2093    talloc_steal(ret_val, interpreted);
2094  }
2095
2096  return ret_val;
2097}
2098
2099
2100/******************************************************************************
2101 *****************************************************************************/
2102const REGFI_DATA* regfi_iterator_fetch_data(REGFI_ITERATOR* i, 
2103                                            const REGFI_VK_REC* value)
2104{
2105  REGFI_DATA* ret_val = NULL;
2106  REGFI_BUFFER raw_data;
2107
2108  if(value->data_size != 0)
2109  {
2110    raw_data = regfi_load_data(i->f, value->data_off, value->data_size,
2111                              value->data_in_offset, true);
2112    if(raw_data.buf == NULL)
2113    {
2114      regfi_log_add(REGFI_LOG_WARN, "Could not parse data record"
2115                    " while parsing VK record at offset 0x%.8X.",
2116                    value->offset);
2117    }
2118    else
2119    {
2120      ret_val = regfi_buffer_to_data(raw_data);
2121
2122      if(ret_val == NULL)
2123      {
2124        regfi_log_add(REGFI_LOG_WARN, "Error occurred in converting"
2125                      " data buffer to data structure while interpreting "
2126                      "data for VK record at offset 0x%.8X.",
2127                      value->offset);
2128        talloc_free(raw_data.buf);
2129        return NULL;
2130      }
2131
2132      if(!regfi_interpret_data(i->f, i->string_encoding, value->type, ret_val))
2133      {
2134        regfi_log_add(REGFI_LOG_INFO, "Error occurred while"
2135                      " interpreting data for VK record at offset 0x%.8X.",
2136                      value->offset);
2137      }
2138    }
2139  }
2140 
2141  return ret_val;
2142}
2143
2144
2145/******************************************************************************
2146 *****************************************************************************/
2147REGFI_DATA* regfi_buffer_to_data(REGFI_BUFFER raw_data)
2148{
2149  REGFI_DATA* ret_val;
2150
2151  if(raw_data.buf == NULL)
2152    return NULL;
2153
2154  ret_val = talloc(NULL, REGFI_DATA);
2155  if(ret_val == NULL)
2156    return NULL;
2157 
2158  talloc_steal(ret_val, raw_data.buf);
2159  ret_val->raw = raw_data.buf;
2160  ret_val->size = raw_data.len;
2161  ret_val->interpreted_size = 0;
2162  ret_val->interpreted.qword = 0;
2163
2164  return ret_val;
2165}
2166
2167
2168/******************************************************************************
2169 *****************************************************************************/
2170bool regfi_interpret_data(REGFI_FILE* file, REGFI_ENCODING string_encoding,
2171                          uint32_t type, REGFI_DATA* data)
2172{
2173  uint8_t** tmp_array;
2174  uint8_t* tmp_str;
2175  int32_t tmp_size;
2176  uint32_t i, j, array_size;
2177
2178  if(data == NULL)
2179    return false;
2180
2181  switch (type)
2182  {
2183  case REG_SZ:
2184  case REG_EXPAND_SZ:
2185  /* REG_LINK is a symbolic link, stored as a unicode string. */
2186  case REG_LINK:
2187    tmp_str = talloc_array(NULL, uint8_t, data->size);
2188    if(tmp_str == NULL)
2189    {
2190      data->interpreted.string = NULL;
2191      data->interpreted_size = 0;
2192      return false;
2193    }
2194     
2195    tmp_size = regfi_conv_charset(regfi_encoding_int2str(REGFI_ENCODING_UTF16LE),
2196                                  regfi_encoding_int2str(string_encoding),
2197                                  data->raw, (char*)tmp_str, 
2198                                  data->size, data->size);
2199    if(tmp_size < 0)
2200    {
2201      regfi_log_add(REGFI_LOG_INFO, "Error occurred while"
2202                    " converting data of type %d to %d.  Error message: %s",
2203                    type, string_encoding, strerror(-tmp_size));
2204      talloc_free(tmp_str);
2205      data->interpreted.string = NULL;
2206      data->interpreted_size = 0;
2207      return false;
2208    }
2209
2210    tmp_str = talloc_realloc(NULL, tmp_str, uint8_t, tmp_size);
2211    data->interpreted.string = tmp_str;
2212    data->interpreted_size = tmp_size;
2213    talloc_steal(data, tmp_str);
2214    break;
2215
2216  case REG_DWORD:
2217    if(data->size < 4)
2218    {
2219      data->interpreted.dword = 0;
2220      data->interpreted_size = 0;
2221      return false;
2222    }
2223    data->interpreted.dword = IVAL(data->raw, 0);
2224    data->interpreted_size = 4;
2225    break;
2226
2227  case REG_DWORD_BE:
2228    if(data->size < 4)
2229    {
2230      data->interpreted.dword_be = 0;
2231      data->interpreted_size = 0;
2232      return false;
2233    }
2234    data->interpreted.dword_be = RIVAL(data->raw, 0);
2235    data->interpreted_size = 4;
2236    break;
2237
2238  case REG_QWORD:
2239    if(data->size < 8)
2240    {
2241      data->interpreted.qword = 0;
2242      data->interpreted_size = 0;
2243      return false;
2244    }
2245    data->interpreted.qword = 
2246      (uint64_t)IVAL(data->raw, 0) + (((uint64_t)IVAL(data->raw, 4))<<32);
2247    data->interpreted_size = 8;
2248    break;
2249   
2250  case REG_MULTI_SZ:
2251    tmp_str = talloc_array(NULL, uint8_t, data->size);
2252    if(tmp_str == NULL)
2253    {
2254      data->interpreted.multiple_string = NULL;
2255      data->interpreted_size = 0;
2256      return false;
2257    }
2258
2259    /* Attempt to convert entire string from UTF-16LE to output encoding,
2260     * then parse and quote fields individually.
2261     */
2262    tmp_size = regfi_conv_charset(regfi_encoding_int2str(REGFI_ENCODING_UTF16LE),
2263                                  regfi_encoding_int2str(string_encoding),
2264                                  data->raw, (char*)tmp_str,
2265                                  data->size, data->size);
2266    if(tmp_size < 0)
2267    {
2268      regfi_log_add(REGFI_LOG_INFO, "Error occurred while"
2269                    " converting data of type %d to %s.  Error message: %s",
2270                    type, string_encoding, strerror(-tmp_size));
2271      talloc_free(tmp_str);
2272      data->interpreted.multiple_string = NULL;
2273      data->interpreted_size = 0;
2274      return false;
2275    }
2276
2277    array_size = tmp_size+1;
2278    tmp_array = talloc_array(NULL, uint8_t*, array_size);
2279    if(tmp_array == NULL)
2280    {
2281      talloc_free(tmp_str);
2282      data->interpreted.string = NULL;
2283      data->interpreted_size = 0;
2284      return false;
2285    }
2286   
2287    tmp_array[0] = tmp_str;
2288    for(i=0,j=1; i < tmp_size && j < array_size-1; i++)
2289    {
2290      if(tmp_str[i] == '\0' && (i+1 < tmp_size))
2291        tmp_array[j++] = tmp_str+i+1;
2292    }
2293    tmp_array[j] = NULL;
2294    tmp_array = talloc_realloc(NULL, tmp_array, uint8_t*, j+1);
2295    data->interpreted.multiple_string = tmp_array;
2296    /* XXX: how meaningful is this?  should we store number of strings instead? */
2297    data->interpreted_size = tmp_size;
2298    talloc_steal(tmp_array, tmp_str);
2299    talloc_steal(data, tmp_array);
2300    break;
2301
2302  /* XXX: Dont know how to interpret these yet, just treat as binary */
2303  case REG_NONE:
2304    data->interpreted.none = data->raw;
2305    data->interpreted_size = data->size;
2306    break;
2307
2308  case REG_RESOURCE_LIST:
2309    data->interpreted.resource_list = data->raw;
2310    data->interpreted_size = data->size;
2311    break;
2312
2313  case REG_FULL_RESOURCE_DESCRIPTOR:
2314    data->interpreted.full_resource_descriptor = data->raw;
2315    data->interpreted_size = data->size;
2316    break;
2317
2318  case REG_RESOURCE_REQUIREMENTS_LIST:
2319    data->interpreted.resource_requirements_list = data->raw;
2320    data->interpreted_size = data->size;
2321    break;
2322
2323  case REG_BINARY:
2324    data->interpreted.binary = data->raw;
2325    data->interpreted_size = data->size;
2326    break;
2327
2328  default:
2329    data->interpreted.qword = 0;
2330    data->interpreted_size = 0;
2331    return false;
2332  }
2333
2334  data->type = type;
2335  return true;
2336}
2337
2338
2339/******************************************************************************
2340 * Convert from UTF-16LE to specified character set.
2341 * On error, returns a negative errno code.
2342 *****************************************************************************/
2343int32_t regfi_conv_charset(const char* input_charset, const char* output_charset,
2344                         uint8_t* input, char* output, 
2345                         uint32_t input_len, uint32_t output_max)
2346{
2347  iconv_t conv_desc;
2348  char* inbuf = (char*)input;
2349  char* outbuf = output;
2350  size_t in_len = (size_t)input_len;
2351  size_t out_len = (size_t)(output_max-1);
2352  int ret;
2353
2354  /* XXX: Consider creating a couple of conversion descriptors earlier,
2355   *      storing them on an iterator so they don't have to be recreated
2356   *      each time.
2357   */
2358
2359  /* Set up conversion descriptor. */
2360  conv_desc = iconv_open(output_charset, input_charset);
2361
2362  ret = iconv(conv_desc, &inbuf, &in_len, &outbuf, &out_len);
2363  if(ret == -1)
2364  {
2365    iconv_close(conv_desc);
2366    return -errno;
2367  }
2368  *outbuf = '\0';
2369
2370  iconv_close(conv_desc); 
2371  return output_max-out_len-1;
2372}
2373
2374
2375
2376/*******************************************************************
2377 * Computes the checksum of the registry file header.
2378 * buffer must be at least the size of a regf header (4096 bytes).
2379 *******************************************************************/
2380static uint32_t regfi_compute_header_checksum(uint8_t* buffer)
2381{
2382  uint32_t checksum, x;
2383  int i;
2384
2385  /* XOR of all bytes 0x0000 - 0x01FB */
2386
2387  checksum = x = 0;
2388 
2389  for ( i=0; i<0x01FB; i+=4 ) {
2390    x = IVAL(buffer, i );
2391    checksum ^= x;
2392  }
2393 
2394  return checksum;
2395}
2396
2397
2398/*******************************************************************
2399 *******************************************************************/
2400REGFI_FILE* regfi_parse_regf(REGFI_RAW_FILE* file_cb, bool strict)
2401{
2402  uint8_t file_header[REGFI_REGF_SIZE];
2403  uint32_t length;
2404  REGFI_FILE* ret_val;
2405
2406  ret_val = talloc(NULL, REGFI_FILE);
2407  if(ret_val == NULL)
2408    return NULL;
2409
2410  ret_val->sk_cache = NULL;
2411  ret_val->hbins = NULL;
2412
2413  length = REGFI_REGF_SIZE;
2414  if((regfi_read(file_cb, file_header, &length)) != 0 
2415     || length != REGFI_REGF_SIZE)
2416  {
2417    regfi_log_add(REGFI_LOG_WARN, "Read failed while parsing REGF structure.");
2418    goto fail;
2419  }
2420
2421  ret_val->checksum = IVAL(file_header, 0x1FC);
2422  ret_val->computed_checksum = regfi_compute_header_checksum(file_header);
2423  if (strict && (ret_val->checksum != ret_val->computed_checksum))
2424  {
2425    regfi_log_add(REGFI_LOG_WARN, "Stored header checksum (%.8X) did not equal"
2426                  " computed checksum (%.8X).",
2427                  ret_val->checksum, ret_val->computed_checksum);
2428    if(strict)
2429      goto fail;
2430  }
2431
2432  memcpy(ret_val->magic, file_header, REGFI_REGF_MAGIC_SIZE);
2433  if(memcmp(ret_val->magic, "regf", REGFI_REGF_MAGIC_SIZE) != 0)
2434  {
2435    regfi_log_add(REGFI_LOG_ERROR, "Magic number mismatch "
2436                  "(%.2X %.2X %.2X %.2X) while parsing hive header",
2437                  ret_val->magic[0], ret_val->magic[1], 
2438                  ret_val->magic[2], ret_val->magic[3]);
2439    goto fail;
2440  }
2441
2442  ret_val->sequence1 = IVAL(file_header, 0x4);
2443  ret_val->sequence2 = IVAL(file_header, 0x8);
2444  ret_val->mtime.low = IVAL(file_header, 0xC);
2445  ret_val->mtime.high = IVAL(file_header, 0x10);
2446  ret_val->major_version = IVAL(file_header, 0x14);
2447  ret_val->minor_version = IVAL(file_header, 0x18);
2448  ret_val->type = IVAL(file_header, 0x1C);
2449  ret_val->format = IVAL(file_header, 0x20);
2450  ret_val->root_cell = IVAL(file_header, 0x24);
2451  ret_val->last_block = IVAL(file_header, 0x28);
2452  ret_val->cluster = IVAL(file_header, 0x2C);
2453
2454  memcpy(ret_val->file_name, file_header+0x30,  REGFI_REGF_NAME_SIZE);
2455
2456  /* XXX: Should we add a warning if these uuid parsers fail?  Can they? */
2457  ret_val->rm_id = winsec_parse_uuid(ret_val, file_header+0x70, 16);
2458  ret_val->log_id = winsec_parse_uuid(ret_val, file_header+0x80, 16);
2459  ret_val->flags = IVAL(file_header, 0x90);
2460  ret_val->tm_id = winsec_parse_uuid(ret_val, file_header+0x94, 16);
2461  ret_val->guid_signature = IVAL(file_header, 0xa4);
2462
2463  memcpy(ret_val->reserved1, file_header+0xa8, REGFI_REGF_RESERVED1_SIZE);
2464  memcpy(ret_val->reserved2, file_header+0x200, REGFI_REGF_RESERVED2_SIZE);
2465
2466  ret_val->thaw_tm_id = winsec_parse_uuid(ret_val, file_header+0xFC8, 16);
2467  ret_val->thaw_rm_id = winsec_parse_uuid(ret_val, file_header+0xFD8, 16);
2468  ret_val->thaw_log_id = winsec_parse_uuid(ret_val, file_header+0xFE8, 16);
2469  ret_val->boot_type = IVAL(file_header, 0xFF8);
2470  ret_val->boot_recover = IVAL(file_header, 0xFFC);
2471
2472  return ret_val;
2473
2474 fail:
2475  talloc_free(ret_val);
2476  return NULL;
2477}
2478
2479
2480
2481/******************************************************************************
2482 * Given real file offset, read and parse the hbin at that location
2483 * along with it's associated cells.
2484 ******************************************************************************/
2485REGFI_HBIN* regfi_parse_hbin(REGFI_FILE* file, uint32_t offset, bool strict)
2486{
2487  REGFI_HBIN* hbin = NULL;
2488  uint8_t hbin_header[REGFI_HBIN_HEADER_SIZE];
2489  uint32_t length;
2490 
2491  if(offset >= file->file_length)
2492    goto fail;
2493 
2494  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_hbin"))
2495    goto fail;
2496
2497  if(regfi_seek(file->cb, offset, SEEK_SET) == -1)
2498  {
2499    regfi_log_add(REGFI_LOG_ERROR, "Seek failed"
2500                  " while parsing hbin at offset 0x%.8X.", offset);
2501    goto fail_locked;
2502  }
2503
2504  length = REGFI_HBIN_HEADER_SIZE;
2505  if((regfi_read(file->cb, hbin_header, &length) != 0) 
2506     || length != REGFI_HBIN_HEADER_SIZE)
2507  {
2508    regfi_log_add(REGFI_LOG_ERROR, "Read failed"
2509                  " while parsing hbin at offset 0x%.8X.", offset);
2510    goto fail_locked;
2511  }
2512
2513  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_hbin"))
2514    goto fail;
2515
2516  hbin = talloc(NULL, REGFI_HBIN);
2517  if(hbin == NULL)
2518    goto fail;
2519  hbin->file_off = offset;
2520
2521  memcpy(hbin->magic, hbin_header, 4);
2522  if(strict && (memcmp(hbin->magic, "hbin", 4) != 0))
2523  {
2524    /* This always seems to happen at the end of a file, so we make it an INFO
2525     * message, rather than something more serious.
2526     */
2527    regfi_log_add(REGFI_LOG_INFO, "Magic number mismatch "
2528                  "(%.2X %.2X %.2X %.2X) while parsing hbin at offset"
2529                  " 0x%.8X.", hbin->magic[0], hbin->magic[1], 
2530                  hbin->magic[2], hbin->magic[3], offset);
2531    goto fail;
2532  }
2533
2534  hbin->first_hbin_off = IVAL(hbin_header, 0x4);
2535  hbin->block_size = IVAL(hbin_header, 0x8);
2536  /* this should be the same thing as hbin->block_size, but just in case */
2537  hbin->next_block = IVAL(hbin_header, 0x1C);
2538
2539
2540  /* Ensure the block size is a multiple of 0x1000 and doesn't run off
2541   * the end of the file.
2542   */
2543  /* XXX: This may need to be relaxed for dealing with
2544   *      partial or corrupt files.
2545   */
2546  if((offset + hbin->block_size > file->file_length)
2547     || (hbin->block_size & 0xFFFFF000) != hbin->block_size)
2548  {
2549    regfi_log_add(REGFI_LOG_ERROR, "The hbin offset is not aligned"
2550                  " or runs off the end of the file"
2551                  " while parsing hbin at offset 0x%.8X.", offset);
2552    goto fail;
2553  }
2554
2555  return hbin;
2556
2557 fail_locked:
2558  regfi_unlock(file, &file->cb_lock, "regfi_parse_hbin");
2559 fail:
2560  talloc_free(hbin);
2561  return NULL;
2562}
2563
2564
2565/*******************************************************************
2566 *******************************************************************/
2567REGFI_NK_REC* regfi_parse_nk(REGFI_FILE* file, uint32_t offset, 
2568                             uint32_t max_size, bool strict)
2569{
2570  uint8_t nk_header[REGFI_NK_MIN_LENGTH];
2571  REGFI_NK_REC* ret_val;
2572  uint32_t length,cell_length;
2573  bool unalloc = false;
2574
2575  ret_val = talloc(NULL, REGFI_NK_REC);
2576  if(ret_val == NULL)
2577  {
2578    regfi_log_add(REGFI_LOG_ERROR, "Failed to allocate memory while"
2579                  " parsing NK record at offset 0x%.8X.", offset);
2580    goto fail;
2581  }
2582
2583  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_nk"))
2584    goto fail;
2585
2586  if(!regfi_parse_cell(file->cb, offset, nk_header, REGFI_NK_MIN_LENGTH,
2587                       &cell_length, &unalloc))
2588  {
2589    regfi_log_add(REGFI_LOG_WARN, "Could not parse cell header"
2590                  " while parsing NK record at offset 0x%.8X.", offset);
2591    goto fail_locked;
2592  }
2593
2594  if((nk_header[0x0] != 'n') || (nk_header[0x1] != 'k'))
2595  {
2596    regfi_log_add(REGFI_LOG_WARN, "Magic number mismatch in parsing"
2597                  " NK record at offset 0x%.8X.", offset);
2598    goto fail_locked;
2599  }
2600
2601  ret_val->values = NULL;
2602  ret_val->subkeys = NULL;
2603  ret_val->offset = offset;
2604  ret_val->cell_size = cell_length;
2605
2606  if(ret_val->cell_size > max_size)
2607    ret_val->cell_size = max_size & 0xFFFFFFF8;
2608  if((ret_val->cell_size < REGFI_NK_MIN_LENGTH) 
2609     || (strict && (ret_val->cell_size & 0x00000007) != 0))
2610  {
2611    regfi_log_add(REGFI_LOG_WARN, "A length check failed while"
2612                  " parsing NK record at offset 0x%.8X.", offset);
2613    goto fail_locked;
2614  }
2615
2616  ret_val->magic[0] = nk_header[0x0];
2617  ret_val->magic[1] = nk_header[0x1];
2618  ret_val->flags = SVAL(nk_header, 0x2);
2619 
2620  if((ret_val->flags & ~REGFI_NK_KNOWN_FLAGS) != 0)
2621  {
2622    regfi_log_add(REGFI_LOG_WARN, "Unknown key flags (0x%.4X) while"
2623                  " parsing NK record at offset 0x%.8X.", 
2624                  (ret_val->flags & ~REGFI_NK_KNOWN_FLAGS), offset);
2625  }
2626
2627  ret_val->mtime.low = IVAL(nk_header, 0x4);
2628  ret_val->mtime.high = IVAL(nk_header, 0x8);
2629  /* If the key is unallocated and the MTIME is earlier than Jan 1, 1990
2630   * or later than Jan 1, 2290, we consider this a bad key.  This helps
2631   * weed out some false positives during deleted data recovery.
2632   */
2633  if(unalloc
2634     && (ret_val->mtime.high < REGFI_MTIME_MIN_HIGH
2635         || ret_val->mtime.high > REGFI_MTIME_MAX_HIGH))
2636  { goto fail_locked; }
2637
2638  ret_val->unknown1 = IVAL(nk_header, 0xC);
2639  ret_val->parent_off = IVAL(nk_header, 0x10);
2640  ret_val->num_subkeys = IVAL(nk_header, 0x14);
2641  ret_val->unknown2 = IVAL(nk_header, 0x18);
2642  ret_val->subkeys_off = IVAL(nk_header, 0x1C);
2643  ret_val->unknown3 = IVAL(nk_header, 0x20);
2644  ret_val->num_values = IVAL(nk_header, 0x24);
2645  ret_val->values_off = IVAL(nk_header, 0x28);
2646  ret_val->sk_off = IVAL(nk_header, 0x2C);
2647  ret_val->classname_off = IVAL(nk_header, 0x30);
2648
2649  ret_val->max_bytes_subkeyname = IVAL(nk_header, 0x34);
2650  ret_val->max_bytes_subkeyclassname = IVAL(nk_header, 0x38);
2651  ret_val->max_bytes_valuename = IVAL(nk_header, 0x3C);
2652  ret_val->max_bytes_value = IVAL(nk_header, 0x40);
2653  ret_val->unk_index = IVAL(nk_header, 0x44);
2654
2655  ret_val->name_length = SVAL(nk_header, 0x48);
2656  ret_val->classname_length = SVAL(nk_header, 0x4A);
2657  ret_val->keyname = NULL;
2658
2659  if(ret_val->name_length + REGFI_NK_MIN_LENGTH > ret_val->cell_size)
2660  {
2661    if(strict)
2662    {
2663      regfi_log_add(REGFI_LOG_ERROR, "Contents too large for cell"
2664                    " while parsing NK record at offset 0x%.8X.", offset);
2665      goto fail_locked;
2666    }
2667    else
2668      ret_val->name_length = ret_val->cell_size - REGFI_NK_MIN_LENGTH;
2669  }
2670  else if (unalloc)
2671  { /* Truncate cell_size if it's much larger than the apparent total record length. */
2672    /* Round up to the next multiple of 8 */
2673    length = (ret_val->name_length + REGFI_NK_MIN_LENGTH) & 0xFFFFFFF8;
2674    if(length < ret_val->name_length + REGFI_NK_MIN_LENGTH)
2675      length+=8;
2676
2677    /* If cell_size is still greater, truncate. */
2678    if(length < ret_val->cell_size)
2679      ret_val->cell_size = length;
2680  }
2681
2682  ret_val->keyname_raw = talloc_array(ret_val, uint8_t, ret_val->name_length);
2683  if(ret_val->keyname_raw == NULL)
2684    goto fail_locked;
2685
2686  /* Don't need to seek, should be at the right offset */
2687  length = ret_val->name_length;
2688  if((regfi_read(file->cb, (uint8_t*)ret_val->keyname_raw, &length) != 0)
2689     || length != ret_val->name_length)
2690  {
2691    regfi_log_add(REGFI_LOG_ERROR, "Failed to read key name"
2692                  " while parsing NK record at offset 0x%.8X.", offset);
2693    goto fail_locked;
2694  }
2695
2696  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_nk"))
2697    goto fail;
2698
2699  return ret_val;
2700
2701 fail_locked:
2702  regfi_unlock(file, &file->cb_lock, "regfi_parse_nk");
2703 fail:
2704  talloc_free(ret_val);
2705  return NULL;
2706}
2707
2708
2709uint8_t* regfi_parse_classname(REGFI_FILE* file, uint32_t offset, 
2710                             uint16_t* name_length, uint32_t max_size, bool strict)
2711{
2712  uint8_t* ret_val = NULL;
2713  uint32_t length;
2714  uint32_t cell_length;
2715  bool unalloc = false;
2716
2717  if(*name_length <= 0 || offset == REGFI_OFFSET_NONE 
2718     || (offset & 0x00000007) != 0)
2719  { goto fail; }
2720
2721  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_classname"))
2722    goto fail;
2723
2724  if(!regfi_parse_cell(file->cb, offset, NULL, 0, &cell_length, &unalloc))
2725  {
2726    regfi_log_add(REGFI_LOG_WARN, "Could not parse cell header"
2727                  " while parsing class name at offset 0x%.8X.", offset);
2728    goto fail_locked;
2729  }
2730 
2731  if((cell_length & 0x0000007) != 0)
2732  {
2733    regfi_log_add(REGFI_LOG_ERROR, "Cell length not a multiple of 8"
2734                  " while parsing class name at offset 0x%.8X.", offset);
2735    goto fail_locked;
2736  }
2737 
2738  if(cell_length > max_size)
2739  {
2740    regfi_log_add(REGFI_LOG_WARN, "Cell stretches past hbin "
2741                  "boundary while parsing class name at offset 0x%.8X.",
2742                  offset);
2743    if(strict)
2744      goto fail_locked;
2745    cell_length = max_size;
2746  }
2747 
2748  if((cell_length - 4) < *name_length)
2749  {
2750    regfi_log_add(REGFI_LOG_WARN, "Class name is larger than"
2751                  " cell_length while parsing class name at offset"
2752                  " 0x%.8X.", offset);
2753    if(strict)
2754      goto fail_locked;
2755    *name_length = cell_length - 4;
2756  }
2757 
2758  ret_val = talloc_array(NULL, uint8_t, *name_length);
2759  if(ret_val != NULL)
2760  {
2761    length = *name_length;
2762    if((regfi_read(file->cb, ret_val, &length) != 0)
2763       || length != *name_length)
2764    {
2765      regfi_log_add(REGFI_LOG_ERROR, "Could not read class name"
2766                    " while parsing class name at offset 0x%.8X.", offset);
2767      goto fail_locked;
2768    }
2769  }
2770
2771  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_classname"))
2772    goto fail;
2773
2774  return ret_val;
2775
2776 fail_locked:
2777  regfi_unlock(file, &file->cb_lock, "regfi_parse_classname");
2778 fail:
2779  talloc_free(ret_val);
2780  return NULL;
2781}
2782
2783
2784/******************************************************************************
2785*******************************************************************************/
2786REGFI_VK_REC* regfi_parse_vk(REGFI_FILE* file, uint32_t offset, 
2787                             uint32_t max_size, bool strict)
2788{
2789  REGFI_VK_REC* ret_val;
2790  uint8_t vk_header[REGFI_VK_MIN_LENGTH];
2791  uint32_t raw_data_size, length, cell_length;
2792  bool unalloc = false;
2793
2794  ret_val = talloc(NULL, REGFI_VK_REC);
2795  if(ret_val == NULL)
2796    goto fail;
2797
2798  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_nk"))
2799    goto fail;
2800
2801  if(!regfi_parse_cell(file->cb, offset, vk_header, REGFI_VK_MIN_LENGTH,
2802                       &cell_length, &unalloc))
2803  {
2804    regfi_log_add(REGFI_LOG_WARN, "Could not parse cell header"
2805                  " while parsing VK record at offset 0x%.8X.", offset);
2806    goto fail_locked;
2807  }
2808
2809  ret_val->offset = offset;
2810  ret_val->cell_size = cell_length;
2811  ret_val->valuename = NULL;
2812  ret_val->valuename_raw = NULL;
2813 
2814  if(ret_val->cell_size > max_size)
2815    ret_val->cell_size = max_size & 0xFFFFFFF8;
2816  if((ret_val->cell_size < REGFI_VK_MIN_LENGTH) 
2817     || (ret_val->cell_size & 0x00000007) != 0)
2818  {
2819    regfi_log_add(REGFI_LOG_WARN, "Invalid cell size encountered"
2820                  " while parsing VK record at offset 0x%.8X.", offset);
2821    goto fail_locked;
2822  }
2823
2824  ret_val->magic[0] = vk_header[0x0];
2825  ret_val->magic[1] = vk_header[0x1];
2826  if((ret_val->magic[0] != 'v') || (ret_val->magic[1] != 'k'))
2827  {
2828    /* XXX: This does not account for deleted keys under Win2K which
2829     *      often have this (and the name length) overwritten with
2830     *      0xFFFF.
2831     */
2832    regfi_log_add(REGFI_LOG_WARN, "Magic number mismatch"
2833                  " while parsing VK record at offset 0x%.8X.", offset);
2834    goto fail_locked;
2835  }
2836
2837  ret_val->name_length = SVAL(vk_header, 0x2);
2838  raw_data_size = IVAL(vk_header, 0x4);
2839  ret_val->data_size = raw_data_size & ~REGFI_VK_DATA_IN_OFFSET;
2840  /* The data is typically stored in the offset if the size <= 4,
2841   * in which case this flag is set.
2842   */
2843  ret_val->data_in_offset = (bool)(raw_data_size & REGFI_VK_DATA_IN_OFFSET);
2844  ret_val->data_off = IVAL(vk_header, 0x8);
2845  ret_val->type = IVAL(vk_header, 0xC);
2846  ret_val->flags = SVAL(vk_header, 0x10);
2847  ret_val->unknown1 = SVAL(vk_header, 0x12);
2848
2849  if(ret_val->name_length > 0)
2850  {
2851    if(ret_val->name_length + REGFI_VK_MIN_LENGTH + 4 > ret_val->cell_size)
2852    {
2853      regfi_log_add(REGFI_LOG_WARN, "Name too long for remaining cell"
2854                    " space while parsing VK record at offset 0x%.8X.",
2855                    offset);
2856      if(strict)
2857        goto fail_locked;
2858      else
2859        ret_val->name_length = ret_val->cell_size - REGFI_VK_MIN_LENGTH - 4;
2860    }
2861
2862    /* Round up to the next multiple of 8 */
2863    cell_length = (ret_val->name_length + REGFI_VK_MIN_LENGTH + 4) & 0xFFFFFFF8;
2864    if(cell_length < ret_val->name_length + REGFI_VK_MIN_LENGTH + 4)
2865      cell_length+=8;
2866
2867    ret_val->valuename_raw = talloc_array(ret_val, uint8_t, ret_val->name_length);
2868    if(ret_val->valuename_raw == NULL)
2869      goto fail_locked;
2870
2871    length = ret_val->name_length;
2872    if((regfi_read(file->cb, (uint8_t*)ret_val->valuename_raw, &length) != 0)
2873       || length != ret_val->name_length)
2874    {
2875      regfi_log_add(REGFI_LOG_ERROR, "Could not read value name"
2876                    " while parsing VK record at offset 0x%.8X.", offset);
2877      goto fail_locked;
2878    }
2879  }
2880  else
2881    cell_length = REGFI_VK_MIN_LENGTH + 4;
2882
2883  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_nk"))
2884    goto fail;
2885
2886  if(unalloc)
2887  {
2888    /* If cell_size is still greater, truncate. */
2889    if(cell_length < ret_val->cell_size)
2890      ret_val->cell_size = cell_length;
2891  }
2892
2893  return ret_val;
2894 
2895 fail_locked:
2896  regfi_unlock(file, &file->cb_lock, "regfi_parse_vk");
2897 fail:
2898  talloc_free(ret_val);
2899  return NULL;
2900}
2901
2902
2903/******************************************************************************
2904 *
2905 ******************************************************************************/
2906REGFI_BUFFER regfi_load_data(REGFI_FILE* file, uint32_t voffset,
2907                             uint32_t length, bool data_in_offset,
2908                             bool strict)
2909{
2910  REGFI_BUFFER ret_val;
2911  uint32_t cell_length, offset;
2912  int32_t max_size;
2913  bool unalloc;
2914 
2915  /* Microsoft's documentation indicates that "available memory" is
2916   * the limit on value sizes for the more recent registry format version.
2917   * This is not only annoying, but it's probably also incorrect, since clearly
2918   * value data sizes are limited to 2^31 (high bit used as a flag) and even
2919   * with big data records, the apparent max size is:
2920   *   16344 * 2^16 = 1071104040 (~1GB).
2921   *
2922   * We choose to limit it to 1M which was the limit in older versions and
2923   * should rarely be exceeded unless the file is corrupt or malicious.
2924   * For more info, see:
2925   *   http://msdn.microsoft.com/en-us/library/ms724872%28VS.85%29.aspx
2926   */
2927  /* XXX: add way to skip this check at user discression. */
2928  if(length > REGFI_VK_MAX_DATA_LENGTH)
2929  {
2930    regfi_log_add(REGFI_LOG_WARN, "Value data size %d larger than "
2931                  "%d, truncating...", length, REGFI_VK_MAX_DATA_LENGTH);
2932    length = REGFI_VK_MAX_DATA_LENGTH;
2933  }
2934
2935  if(data_in_offset)
2936    return regfi_parse_little_data(file, voffset, length, strict);
2937  else
2938  {
2939    offset = voffset + REGFI_REGF_SIZE;
2940    max_size = regfi_calc_maxsize(file, offset);
2941    if(max_size < 0)
2942    {
2943      regfi_log_add(REGFI_LOG_WARN, "Could not find HBIN for data"
2944                    " at offset 0x%.8X.", offset);
2945      goto fail;
2946    }
2947   
2948    if(!regfi_lock(file, &file->cb_lock, "regfi_load_data"))
2949      goto fail;
2950
2951    if(!regfi_parse_cell(file->cb, offset, NULL, 0,
2952                         &cell_length, &unalloc))
2953    {
2954      regfi_log_add(REGFI_LOG_WARN, "Could not parse cell while"
2955                    " parsing data record at offset 0x%.8X.", offset);
2956      goto fail_locked;
2957    }
2958
2959    if(!regfi_unlock(file, &file->cb_lock, "regfi_load_data"))
2960      goto fail;
2961
2962    if((cell_length & 0x00000007) != 0)
2963    {
2964      regfi_log_add(REGFI_LOG_WARN, "Cell length not multiple of 8"
2965                    " while parsing data record at offset 0x%.8X.",
2966                    offset);
2967      goto fail;
2968    }
2969
2970    if(cell_length > max_size)
2971    {
2972      regfi_log_add(REGFI_LOG_WARN, "Cell extends past HBIN boundary"
2973                    " while parsing data record at offset 0x%.8X.",
2974                    offset);
2975      goto fail;
2976    }
2977
2978    if(cell_length - 4 < length)
2979    {
2980      /* XXX: All big data records thus far have been 16 bytes long. 
2981       *      Should we check for this precise size instead of just
2982       *      relying upon the above check?
2983       */
2984      if (file->major_version >= 1 && file->minor_version >= 5)
2985      {
2986        /* Attempt to parse a big data record */
2987        return regfi_load_big_data(file, offset, length, cell_length, 
2988                                   NULL, strict);
2989      }
2990      else
2991      {
2992        regfi_log_add(REGFI_LOG_WARN, "Data length (0x%.8X) larger than"
2993                      " remaining cell length (0x%.8X)"
2994                      " while parsing data record at offset 0x%.8X.", 
2995                      length, cell_length - 4, offset);
2996        if(strict)
2997          goto fail;
2998        else
2999          length = cell_length - 4;
3000      }
3001    }
3002
3003    ret_val = regfi_parse_data(file, offset, length, strict);
3004  }
3005
3006  return ret_val;
3007
3008 fail_locked:
3009  regfi_unlock(file, &file->cb_lock, "regfi_load_data");
3010 fail:
3011  ret_val.buf = NULL;
3012  ret_val.len = 0;
3013  return ret_val;
3014}
3015
3016
3017/******************************************************************************
3018 * Parses the common case data records stored in a single cell.
3019 ******************************************************************************/
3020REGFI_BUFFER regfi_parse_data(REGFI_FILE* file, uint32_t offset,
3021                              uint32_t length, bool strict)
3022{
3023  REGFI_BUFFER ret_val;
3024  uint32_t read_length;
3025
3026  ret_val.buf = NULL;
3027  ret_val.len = 0;
3028 
3029  if((ret_val.buf = talloc_array(NULL, uint8_t, length)) == NULL)
3030    goto fail;
3031  ret_val.len = length;
3032
3033  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_data"))
3034    goto fail;
3035
3036  if(regfi_seek(file->cb, offset+4, SEEK_SET) == -1)
3037  {
3038    regfi_log_add(REGFI_LOG_WARN, "Could not seek while "
3039                  "reading data at offset 0x%.8X.", offset);
3040    goto fail_locked;
3041  }
3042 
3043  read_length = length;
3044  if((regfi_read(file->cb, ret_val.buf, &read_length) != 0)
3045     || read_length != length)
3046  {
3047    regfi_log_add(REGFI_LOG_ERROR, "Could not read data block while"
3048                  " parsing data record at offset 0x%.8X.", offset);
3049    goto fail_locked;
3050  }
3051
3052  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_data"))
3053    goto fail;
3054
3055  return ret_val;
3056
3057 fail_locked:
3058  regfi_unlock(file, &file->cb_lock, "regfi_parse_data");
3059 fail:
3060  talloc_free(ret_val.buf);
3061  ret_val.buf = NULL;
3062  ret_val.buf = 0;
3063  return ret_val;
3064}
3065
3066
3067
3068/******************************************************************************
3069 *
3070 ******************************************************************************/
3071REGFI_BUFFER regfi_parse_little_data(REGFI_FILE* file, uint32_t voffset,
3072                                     uint32_t length, bool strict)
3073{
3074  uint8_t i;
3075  REGFI_BUFFER ret_val;
3076
3077  ret_val.buf = NULL;
3078  ret_val.len = 0;
3079
3080  if(length > 4)
3081  {
3082    regfi_log_add(REGFI_LOG_ERROR, "Data in offset but length > 4"
3083                  " while parsing data record. (voffset=0x%.8X, length=%d)",
3084                  voffset, length);
3085    return ret_val;
3086  }
3087
3088  if((ret_val.buf = talloc_array(NULL, uint8_t, length)) == NULL)
3089    return ret_val;
3090  ret_val.len = length;
3091 
3092  for(i = 0; i < length; i++)
3093    ret_val.buf[i] = (uint8_t)((voffset >> i*8) & 0xFF);
3094
3095  return ret_val;
3096}
3097
3098/******************************************************************************
3099*******************************************************************************/
3100REGFI_BUFFER regfi_parse_big_data_header(REGFI_FILE* file, uint32_t offset, 
3101                                         uint32_t max_size, bool strict)
3102{
3103  REGFI_BUFFER ret_val;
3104  uint32_t cell_length;
3105  bool unalloc;
3106
3107  /* XXX: do something with unalloc? */
3108  ret_val.buf = (uint8_t*)talloc_array(NULL, uint8_t, REGFI_BIG_DATA_MIN_LENGTH);
3109  if(ret_val.buf == NULL)
3110    goto fail;
3111
3112  if(REGFI_BIG_DATA_MIN_LENGTH > max_size)
3113  {
3114    regfi_log_add(REGFI_LOG_WARN, "Big data header exceeded max_size "
3115                  "while parsing big data header at offset 0x%.8X.",offset);
3116    goto fail;
3117  }
3118
3119  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_big_data_header"))
3120    goto fail;
3121
3122
3123  if(!regfi_parse_cell(file->cb, offset, ret_val.buf, REGFI_BIG_DATA_MIN_LENGTH,
3124                       &cell_length, &unalloc))
3125  {
3126    regfi_log_add(REGFI_LOG_WARN, "Could not parse cell while"
3127                  " parsing big data header at offset 0x%.8X.", offset);
3128    goto fail_locked;
3129  }
3130
3131  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_big_data_header"))
3132    goto fail;
3133
3134  if((ret_val.buf[0] != 'd') || (ret_val.buf[1] != 'b'))
3135  {
3136    regfi_log_add(REGFI_LOG_WARN, "Unknown magic number"
3137                  " (0x%.2X, 0x%.2X) encountered while parsing"
3138                  " big data header at offset 0x%.8X.", 
3139                  ret_val.buf[0], ret_val.buf[1], offset);
3140    goto fail;
3141  }
3142
3143  ret_val.len = REGFI_BIG_DATA_MIN_LENGTH;
3144  return ret_val;
3145
3146 fail_locked:
3147  regfi_unlock(file, &file->cb_lock, "regfi_parse_big_data_header");
3148 fail:
3149  talloc_free(ret_val.buf);
3150  ret_val.buf = NULL;
3151  ret_val.len = 0;
3152  return ret_val;
3153}
3154
3155
3156
3157/******************************************************************************
3158 *
3159 ******************************************************************************/
3160uint32_t* regfi_parse_big_data_indirect(REGFI_FILE* file, uint32_t offset,
3161                                      uint16_t num_chunks, bool strict)
3162{
3163  uint32_t* ret_val;
3164  uint32_t indirect_length;
3165  int32_t max_size;
3166  uint16_t i;
3167  bool unalloc;
3168
3169  /* XXX: do something with unalloc? */
3170
3171  max_size = regfi_calc_maxsize(file, offset);
3172  if((max_size < 0) || (num_chunks*sizeof(uint32_t) + 4 > max_size))
3173    return NULL;
3174
3175  ret_val = (uint32_t*)talloc_array(NULL, uint32_t, num_chunks);
3176  if(ret_val == NULL)
3177    goto fail;
3178
3179  if(!regfi_lock(file, &file->cb_lock, "regfi_parse_big_data_indirect"))
3180    goto fail;
3181
3182  if(!regfi_parse_cell(file->cb, offset, (uint8_t*)ret_val,
3183                       num_chunks*sizeof(uint32_t),
3184                       &indirect_length, &unalloc))
3185  {
3186    regfi_log_add(REGFI_LOG_WARN, "Could not parse cell while"
3187                  " parsing big data indirect record at offset 0x%.8X.", 
3188                  offset);
3189    goto fail_locked;
3190  }
3191
3192  if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_big_data_indirect"))
3193    goto fail;
3194
3195  /* Convert pointers to proper endianess, verify they are aligned. */
3196  for(i=0; i<num_chunks; i++)
3197  {
3198    ret_val[i] = IVAL(ret_val, i*sizeof(uint32_t));
3199    if((ret_val[i] & 0x00000007) != 0)
3200      goto fail;
3201  }
3202 
3203  return ret_val;
3204
3205 fail_locked:
3206  regfi_unlock(file, &file->cb_lock, "regfi_parse_big_data_indirect");
3207 fail:
3208  talloc_free(ret_val);
3209  return NULL;
3210}
3211
3212
3213/******************************************************************************
3214 * Arguments:
3215 *  file       --
3216 *  offsets    -- list of virtual offsets.
3217 *  num_chunks --
3218 *  strict     --
3219 *
3220 * Returns:
3221 *  A range_list with physical offsets and complete lengths
3222 *  (including cell headers) of associated cells. 
3223 *  No data in range_list elements.
3224 ******************************************************************************/
3225range_list* regfi_parse_big_data_cells(REGFI_FILE* file, uint32_t* offsets,
3226                                       uint16_t num_chunks, bool strict)
3227{
3228  uint32_t cell_length, chunk_offset;
3229  range_list* ret_val;
3230  uint16_t i;
3231  bool unalloc;
3232 
3233  /* XXX: do something with unalloc? */
3234  ret_val = range_list_new();
3235  if(ret_val == NULL)
3236    goto fail;
3237 
3238  for(i=0; i<num_chunks; i++)
3239  {
3240    if(!regfi_lock(file, &file->cb_lock, "regfi_parse_big_data_cells"))
3241      goto fail;
3242
3243    chunk_offset = offsets[i]+REGFI_REGF_SIZE;
3244    if(!regfi_parse_cell(file->cb, chunk_offset, NULL, 0,
3245                         &cell_length, &unalloc))
3246    {
3247      regfi_log_add(REGFI_LOG_WARN, "Could not parse cell while"
3248                    " parsing big data chunk at offset 0x%.8X.", 
3249                    chunk_offset);
3250      goto fail_locked;
3251    }
3252
3253    if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_big_data_cells"))
3254      goto fail;
3255
3256    if(!range_list_add(ret_val, chunk_offset, cell_length, NULL))
3257      goto fail;
3258  }
3259
3260  return ret_val;
3261
3262 fail_locked:
3263  regfi_unlock(file, &file->cb_lock, "regfi_parse_big_data_cells");
3264 fail:
3265  if(ret_val != NULL)
3266    range_list_free(ret_val);
3267  return NULL;
3268}
3269
3270
3271/******************************************************************************
3272*******************************************************************************/
3273REGFI_BUFFER regfi_load_big_data(REGFI_FILE* file, 
3274                                 uint32_t offset, uint32_t data_length, 
3275                                 uint32_t cell_length, range_list* used_ranges,
3276                                 bool strict)
3277{
3278  REGFI_BUFFER ret_val;
3279  uint16_t num_chunks, i;
3280  uint32_t read_length, data_left, tmp_len, indirect_offset;
3281  uint32_t* indirect_ptrs = NULL;
3282  REGFI_BUFFER bd_header;
3283  range_list* bd_cells = NULL;
3284  const range_list_element* cell_info;
3285
3286  ret_val.buf = NULL;
3287
3288  /* XXX: Add better error/warning messages */
3289
3290  bd_header = regfi_parse_big_data_header(file, offset, cell_length, strict);
3291  if(bd_header.buf == NULL)
3292    goto fail;
3293
3294  /* Keep track of used space for use by reglookup-recover */
3295  if(used_ranges != NULL)
3296    if(!range_list_add(used_ranges, offset, cell_length, NULL))
3297      goto fail;
3298
3299  num_chunks = SVAL(bd_header.buf, 0x2);
3300  indirect_offset = IVAL(bd_header.buf, 0x4) + REGFI_REGF_SIZE;
3301  talloc_free(bd_header.buf);
3302
3303  indirect_ptrs = regfi_parse_big_data_indirect(file, indirect_offset,
3304                                                num_chunks, strict);
3305  if(indirect_ptrs == NULL)
3306    goto fail;
3307
3308  if(used_ranges != NULL)
3309    if(!range_list_add(used_ranges, indirect_offset, num_chunks*4+4, NULL))
3310      goto fail;
3311 
3312  if((ret_val.buf = talloc_array(NULL, uint8_t, data_length)) == NULL)
3313    goto fail;
3314  data_left = data_length;
3315
3316  bd_cells = regfi_parse_big_data_cells(file, indirect_ptrs, num_chunks, strict);
3317  if(bd_cells == NULL)
3318    goto fail;
3319
3320  talloc_free(indirect_ptrs);
3321  indirect_ptrs = NULL;
3322 
3323  for(i=0; (i<num_chunks) && (data_left>0); i++)
3324  {
3325    cell_info = range_list_get(bd_cells, i);
3326    if(cell_info == NULL)
3327      goto fail;
3328
3329    /* XXX: This should be "cell_info->length-4" to account for the 4 byte cell
3330     *      length.  However, it has been observed that some (all?) chunks
3331     *      have an additional 4 bytes of 0 at the end of their cells that
3332     *      isn't part of the data, so we're trimming that off too.
3333     *      Perhaps it's just an 8 byte alignment requirement...
3334     */
3335    if(cell_info->length - 8 >= data_left)
3336    {
3337      if(i+1 != num_chunks)
3338      {
3339        regfi_log_add(REGFI_LOG_WARN, "Left over chunks detected "
3340                      "while constructing big data at offset 0x%.8X "
3341                      "(chunk offset 0x%.8X).", offset, cell_info->offset);
3342      }
3343      read_length = data_left;
3344    }
3345    else
3346      read_length = cell_info->length - 8;
3347
3348
3349    if(read_length > regfi_calc_maxsize(file, cell_info->offset))
3350    {
3351      regfi_log_add(REGFI_LOG_WARN, "A chunk exceeded the maxsize "
3352                    "while constructing big data at offset 0x%.8X "
3353                    "(chunk offset 0x%.8X).", offset, cell_info->offset);
3354      goto fail;
3355    }
3356
3357    if(!regfi_lock(file, &file->cb_lock, "regfi_load_big_data"))
3358      goto fail;
3359
3360    if(regfi_seek(file->cb, cell_info->offset+sizeof(uint32_t), SEEK_SET) == -1)
3361    {
3362      regfi_log_add(REGFI_LOG_WARN, "Could not seek to chunk while "
3363                    "constructing big data at offset 0x%.8X "
3364                    "(chunk offset 0x%.8X).", offset, cell_info->offset);
3365      goto fail_locked;
3366    }
3367
3368    tmp_len = read_length;
3369    if(regfi_read(file->cb, ret_val.buf+(data_length-data_left), 
3370                  &read_length) != 0 || (read_length != tmp_len))
3371    {
3372      regfi_log_add(REGFI_LOG_WARN, "Could not read data chunk while"
3373                    " constructing big data at offset 0x%.8X"
3374                    " (chunk offset 0x%.8X).", offset, cell_info->offset);
3375      goto fail_locked;
3376    }
3377
3378    if(!regfi_unlock(file, &file->cb_lock, "regfi_load_big_data"))
3379      goto fail;
3380
3381    if(used_ranges != NULL)
3382      if(!range_list_add(used_ranges, cell_info->offset,cell_info->length,NULL))
3383        goto fail;
3384
3385    data_left -= read_length;
3386  }
3387  range_list_free(bd_cells);
3388
3389  ret_val.len = data_length-data_left;
3390  return ret_val;
3391
3392 fail_locked:
3393  regfi_unlock(file, &file->cb_lock, "regfi_load_big_data");
3394 fail:
3395  talloc_free(ret_val.buf);
3396  talloc_free(indirect_ptrs);
3397  if(bd_cells != NULL)
3398    range_list_free(bd_cells);
3399  ret_val.buf = NULL;
3400  ret_val.len = 0;
3401  return ret_val;
3402}
3403
3404
3405range_list* regfi_parse_unalloc_cells(REGFI_FILE* file)
3406{
3407  range_list* ret_val;
3408  REGFI_HBIN* hbin;
3409  const range_list_element* hbins_elem;
3410  uint32_t i, num_hbins, curr_off, cell_len;
3411  bool is_unalloc;
3412
3413  ret_val = range_list_new();
3414  if(ret_val == NULL)
3415    return NULL;
3416
3417  if(!regfi_read_lock(file, &file->hbins_lock, "regfi_parse_unalloc_cells"))
3418  {
3419    range_list_free(ret_val);
3420    return NULL;
3421  }
3422
3423  num_hbins = range_list_size(file->hbins);
3424  for(i=0; i<num_hbins; i++)
3425  {
3426    hbins_elem = range_list_get(file->hbins, i);
3427    if(hbins_elem == NULL)
3428      break;
3429    hbin = (REGFI_HBIN*)hbins_elem->data;
3430
3431    curr_off = REGFI_HBIN_HEADER_SIZE;
3432    while(curr_off < hbin->block_size)
3433    {
3434      if(!regfi_lock(file, &file->cb_lock, "regfi_parse_unalloc_cells"))
3435        break;
3436
3437      if(!regfi_parse_cell(file->cb, hbin->file_off+curr_off, NULL, 0,
3438                           &cell_len, &is_unalloc))
3439      {
3440        regfi_unlock(file, &file->cb_lock, "regfi_parse_unalloc_cells");
3441        break;
3442      }
3443
3444      if(!regfi_unlock(file, &file->cb_lock, "regfi_parse_unalloc_cells"))
3445        break;
3446
3447      if((cell_len == 0) || ((cell_len & 0x00000007) != 0))
3448      {
3449        regfi_log_add(REGFI_LOG_ERROR, "Bad cell length encountered"
3450                      " while parsing unallocated cells at offset 0x%.8X.",
3451                      hbin->file_off+curr_off);
3452        break;
3453      }
3454
3455      /* for some reason the record_size of the last record in
3456         an hbin block can extend past the end of the block
3457         even though the record fits within the remaining
3458         space....aaarrrgggghhhhhh */ 
3459      if(curr_off + cell_len >= hbin->block_size)
3460        cell_len = hbin->block_size - curr_off;
3461     
3462      if(is_unalloc)
3463        range_list_add(ret_val, hbin->file_off+curr_off, 
3464                       cell_len, NULL);
3465     
3466      curr_off = curr_off+cell_len;
3467    }
3468  }
3469
3470  if(!regfi_rw_unlock(file, &file->hbins_lock, "regfi_parse_unalloc_cells"))
3471  {
3472    range_list_free(ret_val);
3473    return NULL;
3474  }
3475
3476  return ret_val;
3477}
3478
3479
3480/* From lib/time.c */
3481
3482/****************************************************************************
3483 Put a 8 byte filetime from a time_t
3484 This takes real GMT as input and converts to kludge-GMT
3485****************************************************************************/
3486void regfi_unix2nt_time(REGFI_NTTIME *nt, time_t t)
3487{
3488  double d;
3489 
3490  if (t==0) 
3491  {
3492    nt->low = 0;
3493    nt->high = 0;
3494    return;
3495  }
3496 
3497  if (t == TIME_T_MAX) 
3498  {
3499    nt->low = 0xffffffff;
3500    nt->high = 0x7fffffff;
3501    return;
3502  }             
3503 
3504  if (t == -1) 
3505  {
3506    nt->low = 0xffffffff;
3507    nt->high = 0xffffffff;
3508    return;
3509  }             
3510 
3511  /* this converts GMT to kludge-GMT */
3512  /* XXX: This was removed due to difficult dependency requirements. 
3513   *      So far, times appear to be correct without this adjustment, but
3514   *      that may be proven wrong with adequate testing.
3515   */
3516  /* t -= TimeDiff(t) - get_serverzone(); */
3517 
3518  d = (double)(t);
3519  d += TIME_FIXUP_CONSTANT;
3520  d *= 1.0e7;
3521 
3522  nt->high = (uint32_t)(d * (1.0/(4.0*(double)(1<<30))));
3523  nt->low  = (uint32_t)(d - ((double)nt->high)*4.0*(double)(1<<30));
3524}
3525
3526
3527/****************************************************************************
3528 Interpret an 8 byte "filetime" structure to a time_t
3529 It's originally in "100ns units since jan 1st 1601"
3530
3531 An 8 byte value of 0xffffffffffffffff will be returned as (time_t)0.
3532
3533 It appears to be kludge-GMT (at least for file listings). This means
3534 its the GMT you get by taking a localtime and adding the
3535 serverzone. This is NOT the same as GMT in some cases. This routine
3536 converts this to real GMT.
3537****************************************************************************/
3538time_t regfi_nt2unix_time(const REGFI_NTTIME* nt)
3539{
3540  double d;
3541  time_t ret;
3542  /* The next two lines are a fix needed for the
3543     broken SCO compiler. JRA. */
3544  time_t l_time_min = TIME_T_MIN;
3545  time_t l_time_max = TIME_T_MAX;
3546 
3547  if (nt->high == 0 || (nt->high == 0xffffffff && nt->low == 0xffffffff))
3548    return(0);
3549 
3550  d = ((double)nt->high)*4.0*(double)(1<<30);
3551  d += (nt->low&0xFFF00000);
3552  d *= 1.0e-7;
3553 
3554  /* now adjust by 369 years to make the secs since 1970 */
3555  d -= TIME_FIXUP_CONSTANT;
3556 
3557  if (d <= l_time_min)
3558    return (l_time_min);
3559 
3560  if (d >= l_time_max)
3561    return (l_time_max);
3562 
3563  ret = (time_t)(d+0.5);
3564 
3565  /* this takes us from kludge-GMT to real GMT */
3566  /* XXX: This was removed due to difficult dependency requirements. 
3567   *      So far, times appear to be correct without this adjustment, but
3568   *      that may be proven wrong with adequate testing.
3569   */
3570  /*
3571    ret -= get_serverzone();
3572    ret += LocTimeDiff(ret);
3573  */
3574
3575  return(ret);
3576}
3577
3578/* End of stuff from lib/time.c */
Note: See TracBrowser for help on using the repository browser.