wimlib.net Git - wimlib/blob - src/verify.c

   1 /*
   2  * verify.c
   3  *
   4  * Some functions to verify that stuff in the WIM is valid.  Of course, not
   5  * *all* the verifications of the input data are in this file.
   6  */
   7
   8 /*
   9  * Copyright (C) 2012, 2013 Eric Biggers
  10  *
  11  * This file is part of wimlib, a library for working with WIM files.
  12  *
  13  * wimlib is free software; you can redistribute it and/or modify it under the
  14  * terms of the GNU General Public License as published by the Free
  15  * Software Foundation; either version 3 of the License, or (at your option)
  16  * any later version.
  17  *
  18  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  20  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  21  * details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 #  include "config.h"
  29 #endif
  30
  31 #include "wimlib/dentry.h"
  32 #include "wimlib/error.h"
  33 #include "wimlib/lookup_table.h"
  34 #include "wimlib/metadata.h"
  35 #include "wimlib/security.h"
  36
  37 static int
  38 verify_inode(struct wim_inode *inode, const WIMStruct *w)
  39 {
  40         const struct wim_lookup_table *table = w->lookup_table;
  41         const struct wim_security_data *sd = wim_const_security_data(w);
  42         struct wim_dentry *first_dentry = inode_first_dentry(inode);
  43         struct wim_dentry *dentry;
  44         int ret = WIMLIB_ERR_INVALID_DENTRY;
  45
  46         /* Check the security ID.  -1 is valid and means "no security
  47          * descriptor".  Anything else has to be a valid index into the WIM
  48          * image's security descriptors table. */
  49         if (inode->i_security_id < -1) {
  50                 ERROR("Dentry `%"TS"' has an invalid security ID (%d)",
  51                       dentry_full_path(first_dentry), inode->i_security_id);
  52                 goto out;
  53         }
  54
  55         if (inode->i_security_id >= 0 &&
  56             inode->i_security_id >= sd->num_entries)
  57         {
  58                 ERROR("Dentry `%"TS"' has an invalid security ID (%d) "
  59                       "(there are only %u entries in the security table)",
  60                       dentry_full_path(first_dentry), inode->i_security_id,
  61                       sd->num_entries);
  62                 goto out;
  63         }
  64
  65         /* Check that lookup table entries for all the inode's stream exist,
  66          * except if the SHA1 message digest is all 0's, which indicates an
  67          * empty stream.
  68          *
  69          * This check is skipped on split WIMs. */
  70         if (w->hdr.total_parts == 1) {
  71                 for (unsigned i = 0; i <= inode->i_num_ads; i++) {
  72                         struct wim_lookup_table_entry *lte;
  73                         const u8 *hash;
  74                         hash = inode_stream_hash_unresolved(inode, i);
  75                         lte = __lookup_resource(table, hash);
  76                         if (!lte && !is_zero_hash(hash)) {
  77                                 ERROR("Could not find lookup table entry for stream "
  78                                       "%u of dentry `%"TS"'",
  79                                       i, dentry_full_path(first_dentry));
  80                                 goto out;
  81                         }
  82                         if (lte)
  83                                 lte->real_refcnt += inode->i_nlink;
  84                 }
  85         }
  86
  87         /* Make sure there is only one unnamed data stream. */
  88         unsigned num_unnamed_streams = 0;
  89         for (unsigned i = 0; i <= inode->i_num_ads; i++) {
  90                 const u8 *hash;
  91                 hash = inode_stream_hash_unresolved(inode, i);
  92                 if (inode_stream_name_nbytes(inode, i) == 0 && !is_zero_hash(hash))
  93                         num_unnamed_streams++;
  94         }
  95         if (num_unnamed_streams > 1) {
  96                 ERROR("Dentry `%"TS"' has multiple (%u) un-named streams",
  97                       dentry_full_path(first_dentry), num_unnamed_streams);
  98                 goto out;
  99         }
 100
 101         /* Files cannot have multiple DOS names, even if they have multiple
 102          * names in multiple directories (i.e. hard links).
 103          * Source: NTFS-3g authors. */
 104         struct wim_dentry *dentry_with_dos_name = NULL;
 105         inode_for_each_dentry(dentry, inode) {
 106                 if (dentry_has_short_name(dentry)) {
 107                         if (dentry_with_dos_name) {
 108                                 ERROR("Hard-linked file has a DOS name at "
 109                                       "both `%"TS"' and `%"TS"'",
 110                                       dentry_full_path(dentry_with_dos_name),
 111                                       dentry_full_path(dentry));
 112                                 goto out;
 113                         }
 114                         dentry_with_dos_name = dentry;
 115                 }
 116         }
 117
 118         /* Directories with multiple links have not been tested. XXX */
 119         if (inode->i_nlink > 1 && inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
 120                 ERROR("Hard-linked directory `%"TS"' is unsupported",
 121                       dentry_full_path(first_dentry));
 122                 goto out;
 123         }
 124
 125         inode->i_verified = 1;
 126         ret = 0;
 127 out:
 128         return ret;
 129 }
 130
 131 /* Run some miscellaneous verifications on a WIM dentry */
 132 int
 133 verify_dentry(struct wim_dentry *dentry, void *wim)
 134 {
 135         int ret;
 136         WIMStruct *w = wim;
 137
 138         /* Verify the associated inode, but only one time no matter how many
 139          * dentries it has (unless we are doing a full verification of the WIM,
 140          * in which case we need to force the inode to be verified again.) */
 141         if (!dentry->d_inode->i_verified) {
 142                 ret = verify_inode(dentry->d_inode, w);
 143                 if (ret != 0)
 144                         return ret;
 145         }
 146
 147         /* Make sure root dentry is unnamed, while every other dentry has at
 148          * least a long name.
 149          *
 150          * I am assuming that dentries having only a DOS name is illegal; i.e.,
 151          * Windows will always combine the Win32 name and DOS name for a file
 152          * into a single WIM dentry, even if they are stored separately on NTFS.
 153          * (This seems to be the case...) */
 154         if (dentry_is_root(dentry)) {
 155                 if (dentry_has_long_name(dentry) || dentry_has_short_name(dentry)) {
 156                         ERROR("The root dentry has a nonempty name!");
 157                         return WIMLIB_ERR_INVALID_DENTRY;
 158                 }
 159         } else {
 160                 if (!dentry_has_long_name(dentry)) {
 161                         ERROR("Dentry `%"TS"' has no long name!",
 162                               dentry_full_path(dentry));
 163                         return WIMLIB_ERR_INVALID_DENTRY;
 164                 }
 165         }
 166
 167 #if 0
 168         /* Check timestamps */
 169         if (inode->i_last_access_time < inode->i_creation_time ||
 170             inode->i_last_write_time < inode->i_creation_time) {
 171                 WARNING("Dentry `%"TS"' was created after it was last accessed or "
 172                         "written to", dentry->full_path);
 173         }
 174 #endif
 175
 176         return 0;
 177 }
 178
 179 static int
 180 image_run_full_verifications(WIMStruct *w)
 181 {
 182         struct wim_image_metadata *imd;
 183         struct wim_inode *inode;
 184
 185         imd = wim_get_current_image_metadata(w);
 186         image_for_each_inode(inode, imd)
 187                 inode->i_verified = 0;
 188         return for_dentry_in_tree(imd->root_dentry, verify_dentry, w);
 189 }
 190
 191 static int
 192 lte_fix_refcnt(struct wim_lookup_table_entry *lte, void *ctr)
 193 {
 194         if (lte->refcnt != lte->real_refcnt) {
 195         #ifdef ENABLE_ERROR_MESSAGES
 196                 WARNING("The following lookup table entry has a reference "
 197                         "count of %u, but", lte->refcnt);
 198                 WARNING("We found %u references to it",
 199                         lte->real_refcnt);
 200                 print_lookup_table_entry(lte, stderr);
 201         #endif
 202                 lte->refcnt = lte->real_refcnt;
 203                 ++*(unsigned long *)ctr;
 204         }
 205         return 0;
 206 }
 207
 208 /* Ideally this would be unnecessary... however, the WIMs for Windows 8 are
 209  * screwed up because some lookup table entries are referenced more times than
 210  * their stated reference counts.  So theoretically, if we delete all the
 211  * references to a stream and then remove it, it might still be referenced
 212  * somewhere else, making a file be missing from the WIM... So, work around this
 213  * problem by looking at ALL the images to re-calculate the reference count of
 214  * EVERY lookup table entry.  This only absolutely has to be done before an image
 215  * is deleted or before an image is mounted read-write. */
 216 int
 217 wim_run_full_verifications(WIMStruct *w)
 218 {
 219         int ret;
 220
 221         for_lookup_table_entry(w->lookup_table, lte_zero_real_refcnt, NULL);
 222
 223         w->all_images_verified = 1; /* Set *before* image_run_full_verifications,
 224                                        because of check in read_metadata_resource() */
 225         ret = for_image(w, WIMLIB_ALL_IMAGES, image_run_full_verifications);
 226         if (ret == 0) {
 227                 unsigned long num_ltes_with_bogus_refcnt = 0;
 228                 for_lookup_table_entry(w->lookup_table, lte_fix_refcnt,
 229                                        &num_ltes_with_bogus_refcnt);
 230                 if (num_ltes_with_bogus_refcnt != 0) {
 231                         WARNING("A total of %lu entries in the WIM's stream "
 232                                 "lookup table had to have\n"
 233                                 "          their reference counts fixed.",
 234                                 num_ltes_with_bogus_refcnt);
 235                 }
 236         } else {
 237                 w->all_images_verified = 0;
 238         }
 239         return ret;
 240 }