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

   1 /*
   2  * symlink.c
   3  *
   4  * Code to read and set symbolic links in WIM files.
   5  */
   6
   7 /*
   8  * Copyright (C) 2012, 2013 Eric Biggers
   9  *
  10  * This file is part of wimlib, a library for working with WIM files.
  11  *
  12  * wimlib is free software; you can redistribute it and/or modify it under the
  13  * terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 3 of the License, or (at your option)
  15  * any later version.
  16  *
  17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  20  * details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  24  */
  25
  26 #include "dentry.h"
  27 #include "buffer_io.h"
  28 #include "lookup_table.h"
  29 #include "sha1.h"
  30 #include <errno.h>
  31
  32 /* None of this file is ever needed in Win32 builds because the reparse point
  33  * buffers are not parsed. */
  34 #if !defined(__WIN32__) && !defined(WITH_FUSE)
  35
  36 /*
  37  * Find the symlink target of a symbolic link or junction point in the WIM.
  38  *
  39  * See http://msdn.microsoft.com/en-us/library/cc232006(v=prot.10).aspx for a
  40  * description of the format of the so-called "reparse point data buffers".
  41  *
  42  * But, in the WIM format, the first 8 bytes of the reparse point data buffer
  43  * are omitted, presumably because we already know the reparse tag from the
  44  * dentry, and we already know the reparse tag length from the lookup table
  45  * entry resource length.
  46  */
  47 static ssize_t
  48 get_symlink_name(const void *resource, size_t resource_len, mbchar *buf,
  49                  size_t buf_len, u32 reparse_tag)
  50 {
  51         const u8 *p = resource;
  52         u16 substitute_name_offset;
  53         u16 substitute_name_len;
  54         u16 print_name_offset;
  55         u16 print_name_len;
  56         mbchar *link_target;
  57         size_t link_target_len;
  58         ssize_t ret;
  59         unsigned header_size;
  60         mbchar *translated_target;
  61         bool is_absolute;
  62         u32 flags;
  63
  64         if (resource_len < 12)
  65                 return -EIO;
  66         p = get_u16(p, &substitute_name_offset);
  67         p = get_u16(p, &substitute_name_len);
  68         p = get_u16(p, &print_name_offset);
  69         p = get_u16(p, &print_name_len);
  70         get_u32(p, &flags);
  71
  72         wimlib_assert(reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
  73                       reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
  74
  75         if (reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT) {
  76                 header_size = 8;
  77         } else {
  78                 is_absolute = (flags & 1) ? false : true;
  79                 header_size = 12;
  80                 p += 4;
  81         }
  82         if (header_size + substitute_name_offset + substitute_name_len > resource_len)
  83                 return -EIO;
  84
  85         ret = utf16le_to_mbs((const utf16lechar*)(p + substitute_name_offset),
  86                             substitute_name_len,
  87                             &link_target, &link_target_len);
  88         if (ret == WIMLIB_ERR_INVALID_UTF16_STRING)
  89                 return -EILSEQ;
  90         else if (ret == WIMLIB_ERR_NOMEM)
  91                 return -ENOMEM;
  92
  93         wimlib_assert(ret == 0);
  94
  95         if (!link_target)
  96                 return -EIO;
  97
  98         if (link_target_len + 1 > buf_len) {
  99                 ret = -ENAMETOOLONG;
 100                 goto out;
 101         }
 102
 103         translated_target = link_target;
 104         if (reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT || is_absolute) {
 105                 if (link_target_len < 7
 106                       || memcmp(translated_target, "\\??\\", 4) != 0
 107                       || translated_target[4] == '\0'
 108                       || translated_target[5] != ':'
 109                       || translated_target[6] != '\\') {
 110                         ret = -EIO;
 111                         goto out;
 112                 }
 113                 translated_target += 4;
 114                 link_target_len -= 4;
 115                 /* There's a drive letter, so just leave the backslashes since
 116                  * it won't go anyhwere on UNIX anyway...
 117                  *
 118                  * XXX
 119                  * NTFS-3g tries to re-map these links to actually point to
 120                  * something, so maybe we could do something like that here
 121                  * XXX*/
 122         } else {
 123                 for (size_t i = 0; i < link_target_len; i++)
 124                         if (translated_target[i] == '\\')
 125                                 translated_target[i] = '/';
 126         }
 127
 128         memcpy(buf, translated_target, link_target_len + 1);
 129         ret = link_target_len;
 130 out:
 131         FREE(link_target);
 132         return ret;
 133 }
 134
 135 static int
 136 make_symlink_reparse_data_buf(const mbchar *symlink_target,
 137                               size_t *len_ret, void **buf_ret)
 138 {
 139         utf16lechar *name_utf16le;
 140         size_t name_utf16le_nbytes;
 141         int ret;
 142
 143         ret = mbs_to_utf16le(symlink_target, strlen(symlink_target),
 144                              &name_utf16le, &name_utf16le_nbytes);
 145         if (ret != 0)
 146                 return ret;
 147
 148         for (size_t i = 0; i < name_utf16le_nbytes / 2; i++)
 149                 if (name_utf16le[i] == cpu_to_le16('/'))
 150                         name_utf16le[i] = cpu_to_le16('\\');
 151
 152         size_t len = 12 + name_utf16le_nbytes * 2;
 153         void *buf = MALLOC(len);
 154         if (buf) {
 155                 u8 *p = buf;
 156                 p = put_u16(p, name_utf16le_nbytes); /* Substitute name offset */
 157                 p = put_u16(p, name_utf16le_nbytes); /* Substitute name length */
 158                 p = put_u16(p, 0); /* Print name offset */
 159                 p = put_u16(p, name_utf16le_nbytes); /* Print name length */
 160                 p = put_u32(p, 1); /* flags: 0 iff *full* target, including drive letter??? */
 161                 p = put_bytes(p, name_utf16le_nbytes, name_utf16le);
 162                 p = put_bytes(p, name_utf16le_nbytes, name_utf16le);
 163                 *len_ret = len;
 164                 *buf_ret = buf;
 165                 ret = 0;
 166         } else {
 167                 ret = WIMLIB_ERR_NOMEM;
 168         }
 169         FREE(name_utf16le);
 170         return ret;
 171 }
 172
 173 /* Get the symlink target from a WIM inode.
 174  *
 175  * The inode may be either a "real" symlink (reparse tag
 176  * WIM_IO_REPARSE_TAG_SYMLINK), or it may be a junction point (reparse tag
 177  * WIM_IO_REPARSE_TAG_MOUNT_POINT).
 178  */
 179 ssize_t
 180 inode_readlink(const struct wim_inode *inode, mbchar *buf, size_t buf_len,
 181                const WIMStruct *w, int read_resource_flags)
 182 {
 183         const struct wim_lookup_table_entry *lte;
 184         int ret;
 185
 186         wimlib_assert(inode_is_symlink(inode));
 187
 188         lte = inode_unnamed_lte(inode, w->lookup_table);
 189         if (!lte)
 190                 return -EIO;
 191
 192         if (wim_resource_size(lte) > 10000)
 193                 return -EIO;
 194
 195         u8 res_buf[wim_resource_size(lte)];
 196         ret = read_full_wim_resource(lte, res_buf, read_resource_flags);
 197         if (ret != 0)
 198                 return -EIO;
 199         return get_symlink_name(res_buf, wim_resource_size(lte), buf,
 200                                 buf_len, inode->i_reparse_tag);
 201 }
 202
 203 /*
 204  * Sets @inode to be a symbolic link pointing to @target.
 205  *
 206  * A lookup table entry for the symbolic link data buffer is created and
 207  * inserted into @lookup_table, unless there is an existing lookup table entry
 208  * for the exact same data, in which its reference count is incremented.
 209  *
 210  * The lookup table entry is returned in @lte_ret.
 211  *
 212  * On failure @dentry and @lookup_table are not modified.
 213  */
 214 int
 215 inode_set_symlink(struct wim_inode *inode,
 216                   const mbchar *target,
 217                   struct wim_lookup_table *lookup_table,
 218                   struct wim_lookup_table_entry **lte_ret)
 219
 220 {
 221         int ret;
 222         size_t symlink_buf_len;
 223         struct wim_lookup_table_entry *lte = NULL, *existing_lte;
 224         u8 symlink_buf_hash[SHA1_HASH_SIZE];
 225         void *symlink_buf;
 226
 227         ret = make_symlink_reparse_data_buf(target, &symlink_buf_len,
 228                                             &symlink_buf);
 229         if (ret != 0)
 230                 return ret;
 231
 232         DEBUG("Made symlink reparse data buf (len = %zu, name len = %zu)",
 233                         symlink_buf_len, symlink_buf_len);
 234
 235         sha1_buffer(symlink_buf, symlink_buf_len, symlink_buf_hash);
 236
 237         existing_lte = __lookup_resource(lookup_table, symlink_buf_hash);
 238
 239         if (existing_lte) {
 240                 lte = existing_lte;
 241                 FREE(symlink_buf);
 242                 symlink_buf = NULL;
 243         } else {
 244                 DEBUG("Creating new lookup table entry for symlink buf");
 245                 lte = new_lookup_table_entry();
 246                 if (!lte) {
 247                         ret = WIMLIB_ERR_NOMEM;
 248                         goto out_free_symlink_buf;
 249                 }
 250                 lte->resource_location            = RESOURCE_IN_ATTACHED_BUFFER;
 251                 lte->attached_buffer              = symlink_buf;
 252                 lte->resource_entry.original_size = symlink_buf_len;
 253                 lte->resource_entry.size          = symlink_buf_len;
 254                 copy_hash(lte->hash, symlink_buf_hash);
 255         }
 256
 257         inode->i_lte = lte;
 258         inode->i_resolved = 1;
 259
 260         DEBUG("Loaded symlink buf");
 261
 262         if (existing_lte)
 263                 lte->refcnt++;
 264         else
 265                 lookup_table_insert(lookup_table, lte);
 266         if (lte_ret)
 267                 *lte_ret = lte;
 268         return 0;
 269 out_free_symlink_buf:
 270         FREE(symlink_buf);
 271         return ret;
 272 }
 273
 274 #endif /* !defined(__WIN32__) && !defined(WITH_FUSE) */