Comments
[wimlib] / 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 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 Lesser General Public License as published by the Free
14  * Software Foundation; either version 2.1 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 Lesser General Public License for more
20  * details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
24  */
25
26 #include "dentry.h"
27 #include "io.h"
28 #include "lookup_table.h"
29 #include "sha1.h"
30 #include <errno.h>
31
32 /*
33  * Find the symlink target of a symbolic link or junction point in the WIM.
34  *
35  * See http://msdn.microsoft.com/en-us/library/cc232006(v=prot.10).aspx
36  * Except the first 8 bytes aren't included in the resource (presumably because
37  * we already know the reparse tag from the dentry, and we already know the
38  * reparse tag len from the lookup table entry resource length).
39  */
40 static ssize_t get_symlink_name(const u8 *resource, size_t resource_len,
41                                 char *buf, size_t buf_len,
42                                 u32 reparse_tag)
43 {
44         const u8 *p = resource;
45         u16 substitute_name_offset;
46         u16 substitute_name_len;
47         u16 print_name_offset;
48         u16 print_name_len;
49         char *link_target;
50         size_t link_target_len;
51         ssize_t ret;
52         unsigned header_size;
53         char *translated_target;
54         bool is_absolute;
55         u32 flags;
56
57         if (resource_len < 12)
58                 return -EIO;
59         p = get_u16(p, &substitute_name_offset);
60         p = get_u16(p, &substitute_name_len);
61         p = get_u16(p, &print_name_offset);
62         p = get_u16(p, &print_name_len);
63         get_u32(p, &flags);
64
65         wimlib_assert(reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
66                       reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
67
68         /* I think that some junction points incorrectly get marked as symbolic
69          * links.  So, parse the link buffer as a symlink if the flags seem
70          * plausible. */
71         if (flags <= 1)
72                 reparse_tag = WIM_IO_REPARSE_TAG_SYMLINK;
73
74         if (reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT) {
75                 header_size = 8;
76         } else {
77                 is_absolute = (flags & 1) ? false : true;
78                 header_size = 12;
79                 p += 4;
80         }
81         if (header_size + substitute_name_offset + substitute_name_len > resource_len)
82                 return -EIO;
83         link_target = utf16_to_utf8(p + substitute_name_offset,
84                                     substitute_name_len,
85                                     &link_target_len);
86
87         if (!link_target)
88                 return -EIO;
89
90         if (link_target_len + 1 > buf_len) {
91                 ret = -ENAMETOOLONG;
92                 goto out;
93         }
94
95         translated_target = link_target;
96         if (reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT || is_absolute) {
97                 if (link_target_len < 7
98                       || memcmp(translated_target, "\\??\\", 4) != 0
99                       || translated_target[4] == '\0'
100                       || translated_target[5] != ':'
101                       || translated_target[6] != '\\') {
102                         ret = -EIO;
103                         goto out;
104                 }
105                 translated_target += 4;
106                 link_target_len -= 4;
107                 /* There's a drive letter, so just leave the backslashes since
108                  * it won't go anyhwere on UNIX anyway... 
109                  *
110                  * XXX
111                  * NTFS-3g tries to re-map these links to actually point to
112                  * something, so maybe we could do something like that here
113                  * XXX*/
114         } else {
115                 for (size_t i = 0; i < link_target_len; i++)
116                         if (translated_target[i] == '\\')
117                                 translated_target[i] = '/';
118         }
119
120         memcpy(buf, translated_target, link_target_len + 1);
121         ret = link_target_len;
122 out:
123         FREE(link_target);
124         return ret;
125 }
126
127 void *make_symlink_reparse_data_buf(const char *symlink_target, size_t *len_ret)
128 {
129         size_t utf8_len = strlen(symlink_target);
130         size_t utf16_len;
131         char *name_utf16 = utf8_to_utf16(symlink_target, utf8_len, &utf16_len);
132         if (!name_utf16)
133                 return NULL;
134         /*DEBUG("utf16_len = %zu", utf16_len);*/
135         for (size_t i = 0; i < utf16_len / 2; i++)
136                 if (((u16*)name_utf16)[i] == to_le16('/'))
137                         ((u16*)name_utf16)[i] = to_le16('\\');
138         size_t len = 12 + utf16_len * 2;
139         void *buf = MALLOC(len);
140         if (!buf)
141                 goto out;
142         /* XXX Fix absolute paths */
143
144         u8 *p = buf;
145         p = put_u16(p, utf16_len); /* Substitute name offset */
146         p = put_u16(p, utf16_len); /* Substitute name length */
147         p = put_u16(p, 0); /* Print name offset */
148         p = put_u16(p, utf16_len); /* Print name length */
149         p = put_u32(p, 1);
150         p = put_bytes(p, utf16_len, name_utf16);
151         p = put_bytes(p, utf16_len, name_utf16);
152         /*DEBUG("utf16_len = %zu, len = %zu", utf16_len, len);*/
153         *len_ret = len;
154 out:
155         FREE(name_utf16);
156         return buf;
157 }
158
159 /* Get the symlink target from a dentry.
160  *
161  * The dentry may be either "real" symlink or a junction point.
162  */
163 ssize_t dentry_readlink(const struct dentry *dentry, char *buf, size_t buf_len,
164                         const WIMStruct *w)
165 {
166         const struct lookup_table_entry *lte;
167         int ret;
168
169         wimlib_assert(dentry_is_symlink(dentry));
170
171         lte = dentry_first_lte(dentry, w->lookup_table);
172         if (!lte)
173                 return -EIO;
174
175         if (wim_resource_size(lte) > 10000)
176                 return -EIO;
177
178         char res_buf[wim_resource_size(lte)];
179         ret = read_full_wim_resource(lte, res_buf);
180         if (ret != 0)
181                 return -EIO;
182         return get_symlink_name(res_buf, wim_resource_size(lte), buf,
183                                 buf_len, dentry->reparse_tag);
184 }
185
186 static int dentry_set_symlink_buf(struct dentry *dentry,
187                                   struct lookup_table_entry *lte)
188 {
189         struct ads_entry *ads_entries;
190
191         ads_entries = CALLOC(2, sizeof(struct ads_entry));
192         if (!ads_entries)
193                 return WIMLIB_ERR_NOMEM;
194
195         wimlib_assert(dentry->num_ads == 0);
196         wimlib_assert(dentry->ads_entries == NULL);
197
198         ads_entries[0].lte = lte;
199
200         /*dentry_free_ads_entries(dentry);*/
201         dentry->num_ads = 2;
202         dentry->ads_entries = ads_entries;
203         return 0;
204 }
205
206 /* 
207  * Sets @dentry to be a symbolic link pointing to @target.
208  *
209  * A lookup table entry for the symbolic link data buffer is created and
210  * inserted into @lookup_table, unless there is an existing lookup table entry
211  * for the exact same data, in which its reference count is incremented.
212  *
213  * The lookup table entry is returned in @lte_ret.
214  *
215  * On failure @dentry and @lookup_table are not modified.
216  */
217 int dentry_set_symlink(struct dentry *dentry, const char *target,
218                        struct lookup_table *lookup_table,
219                        struct lookup_table_entry **lte_ret)
220
221 {
222         int ret;
223         size_t symlink_buf_len;
224         struct lookup_table_entry *lte = NULL, *existing_lte;
225         u8 symlink_buf_hash[SHA1_HASH_SIZE];
226         void *symlink_buf;
227         
228         symlink_buf = make_symlink_reparse_data_buf(target, &symlink_buf_len);
229         if (!symlink_buf)
230                 return WIMLIB_ERR_NOMEM;
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                 lte->resource_entry.flags         = 0;
255                 copy_hash(lte->hash, symlink_buf_hash);
256         }
257
258         ret = dentry_set_symlink_buf(dentry, lte);
259
260         if (ret != 0)
261                 goto out_free_lte;
262
263         dentry->resolved = true;
264
265         DEBUG("Loaded symlink buf");
266
267         if (existing_lte)
268                 lte->refcnt++;
269         else
270                 lookup_table_insert(lookup_table, lte);
271         if (lte_ret)
272                 *lte_ret = lte;
273         return 0;
274 out_free_lte:
275         if (lte != existing_lte)
276                 FREE(lte);
277 out_free_symlink_buf:
278         FREE(symlink_buf);
279         return ret;
280 }