Improve handling of invalid filenames
[wimlib] / include / wimlib / dentry.h
1 #ifndef _WIMLIB_DENTRY_H
2 #define _WIMLIB_DENTRY_H
3
4 #include "wimlib/compiler.h"
5 #include "wimlib/list.h"
6 #include "wimlib/rbtree.h"
7 #include "wimlib/sha1.h"
8 #include "wimlib/types.h"
9
10 #include <string.h>
11 #include <sys/types.h> /* uid_t, gid_t */
12
13 #ifdef WITH_FUSE
14 #  include <pthread.h>
15 #endif
16
17 struct wim_lookup_table;
18 struct wim_lookup_table_entry;
19 struct wimfs_fd;
20 struct wim_inode;
21
22 /* Size of the struct wim_dentry up to and including the file_name_len. */
23 #define WIM_DENTRY_DISK_SIZE    102
24
25 /*
26  * Reparse tags documented at
27  * http://msdn.microsoft.com/en-us/library/dd541667(v=prot.10).aspx
28  */
29 #define WIM_IO_REPARSE_TAG_RESERVED_ZERO        0x00000000
30 #define WIM_IO_REPARSE_TAG_RESERVED_ONE         0x00000001
31 #define WIM_IO_REPARSE_TAG_MOUNT_POINT          0xA0000003
32 #define WIM_IO_REPARSE_TAG_HSM                  0xC0000004
33 #define WIM_IO_REPARSE_TAG_HSM2                 0x80000006
34 #define WIM_IO_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
35 #define WIM_IO_REPARSE_TAG_SIS                  0x80000007
36 #define WIM_IO_REPARSE_TAG_DFS                  0x8000000A
37 #define WIM_IO_REPARSE_TAG_DFSR                 0x80000012
38 #define WIM_IO_REPARSE_TAG_FILTER_MANAGER       0x8000000B
39 #define WIM_IO_REPARSE_TAG_SYMLINK              0xA000000C
40
41 #define FILE_ATTRIBUTE_READONLY            0x00000001
42 #define FILE_ATTRIBUTE_HIDDEN              0x00000002
43 #define FILE_ATTRIBUTE_SYSTEM              0x00000004
44 #define FILE_ATTRIBUTE_DIRECTORY           0x00000010
45 #define FILE_ATTRIBUTE_ARCHIVE             0x00000020
46 #define FILE_ATTRIBUTE_DEVICE              0x00000040
47 #define FILE_ATTRIBUTE_NORMAL              0x00000080
48 #define FILE_ATTRIBUTE_TEMPORARY           0x00000100
49 #define FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
50 #define FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
51 #define FILE_ATTRIBUTE_COMPRESSED          0x00000800
52 #define FILE_ATTRIBUTE_OFFLINE             0x00001000
53 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
54 #define FILE_ATTRIBUTE_ENCRYPTED           0x00004000
55 #define FILE_ATTRIBUTE_VIRTUAL             0x00010000
56
57
58 /* Alternate data stream entry.
59  *
60  * We read this from disk in the read_ads_entries() function; see that function
61  * for more explanation. */
62 struct wim_ads_entry {
63         union {
64                 /* SHA-1 message digest of stream contents */
65                 u8 hash[SHA1_HASH_SIZE];
66
67                 /* The corresponding lookup table entry (only for resolved
68                  * streams) */
69                 struct wim_lookup_table_entry *lte;
70         };
71
72         /* Length of UTF16-encoded stream name, in bytes, not including the
73          * terminating null character; or 0 if the stream is unnamed. */
74         u16 stream_name_nbytes;
75
76         /* Number to identify an alternate data stream even after it's possibly
77          * been moved or renamed. */
78         u32 stream_id;
79
80         /* Stream name (UTF-16LE), null-terminated, or NULL if the stream is
81          * unnamed.  */
82         utf16lechar *stream_name;
83
84         /* Reserved field.  We read it into memory so we can write it out
85          * unchanged. */
86         u64 reserved;
87 };
88
89
90 static inline bool
91 ads_entries_have_same_name(const struct wim_ads_entry *entry_1,
92                            const struct wim_ads_entry *entry_2)
93 {
94         return entry_1->stream_name_nbytes == entry_2->stream_name_nbytes &&
95                memcmp(entry_1->stream_name, entry_2->stream_name,
96                       entry_1->stream_name_nbytes) == 0;
97 }
98
99 /*
100  * In-memory structure for a WIM directory entry (dentry).  There is a directory
101  * tree for each image in the WIM.
102  *
103  * Note that this is a directory entry and not an inode.  Since NTFS allows hard
104  * links, it's possible for a NTFS inode to correspond to multiple WIM dentries.
105  * The hard link group ID field of the on-disk WIM dentry tells us the number of
106  * the NTFS inode that the dentry corresponds to (and this gets placed in
107  * d_inode->i_ino).
108  *
109  * Unfortunately, WIM files do not have an analogue to an inode; instead certain
110  * information, such as file attributes, the security descriptor, and file
111  * streams is replicated in each hard-linked dentry, even though this
112  * information really is associated with an inode.  In-memory, we fix up this
113  * flaw by allocating a `struct wim_inode' for each dentry that contains some of
114  * this duplicated information, then combining the inodes for each hard link
115  * group together.
116  *
117  * Confusingly, it's possible for stream information to be missing from a dentry
118  * in a hard link set, in which case the stream information needs to be gotten
119  * from one of the other dentries in the hard link set.  In addition, it is
120  * possible for dentries to have inconsistent security IDs, file attributes, or
121  * file streams when they share the same hard link ID (don't even ask.  I hope
122  * that Microsoft may have fixed this problem, since I've only noticed it in the
123  * 'install.wim' for Windows 7).  For those dentries, we have to use the
124  * conflicting fields to split up the hard link groups.  (See
125  * dentry_tree_fix_inodes() in hardlink.c).
126  */
127 struct wim_dentry {
128         /* The inode for this dentry */
129         struct wim_inode *d_inode;
130
131         /* Node for the parent's red-black tree of child dentries, sorted by
132          * case sensitive long name. */
133         struct rb_node rb_node;
134
135 #ifdef __WIN32__
136         /* Node for the parent's red-black tree of child dentries, sorted by
137          * case insensitive long name. */
138         struct rb_node rb_node_case_insensitive;
139
140         /* List of dentries in a directory that have different case sensitive
141          * long names but share the same case insensitive long name */
142         struct list_head case_insensitive_conflict_list;
143 #endif
144
145         /* Length of UTF-16LE encoded short filename, in bytes, not including
146          * the terminating zero wide-character. */
147         u16 short_name_nbytes;
148
149         /* Length of UTF-16LE encoded "long" file name, in bytes, not including
150          * the terminating null character. */
151         u16 file_name_nbytes;
152
153         /* Length of full path name encoded using "tchars", in bytes, not
154          * including the terminating null character. */
155         u32 full_path_nbytes;
156
157         /* Does this dentry need to be extracted? */
158         u8 needs_extraction : 1;
159
160         /* Only used during NTFS capture */
161         u8 is_win32_name : 1;
162
163         u8 not_extracted : 1;
164
165         /* Temporary list */
166         struct list_head tmp_list;
167
168         /* List of dentries in the inode (hard link set)  */
169         struct list_head d_alias;
170
171         /* The parent of this directory entry. */
172         struct wim_dentry *parent;
173
174         /*
175          * Size of directory entry on disk, in bytes.  Typical size is around
176          * 104 to 120 bytes.
177          *
178          * It is possible for the length field to be 0.  This situation, which
179          * is undocumented, indicates the end of a list of sibling nodes in a
180          * directory.  It also means the real length is 8, because the dentry
181          * included only the length field, but that takes up 8 bytes.
182          *
183          * The length here includes the base directory entry on disk as well as
184          * the long and short filenames.  It does NOT include any alternate
185          * stream entries that may follow the directory entry, even though the
186          * size of those needs to be considered.  The length SHOULD be 8-byte
187          * aligned, although we don't require it to be.  We do require the
188          * length to be large enough to hold the file name(s) of the dentry;
189          * additionally, a warning is issued if this field is larger than the
190          * aligned size.
191          */
192         u64 length;
193
194         /* The offset, from the start of the uncompressed WIM metadata resource
195          * for this image, of this dentry's child dentries.  0 if the directory
196          * entry has no children, which is the case for regular files or reparse
197          * points. */
198         u64 subdir_offset;
199
200         u64 d_unused_1;
201         u64 d_unused_2;
202
203         /* Pointer to the UTF-16LE short filename (malloc()ed buffer) */
204         utf16lechar *short_name;
205
206         /* Pointer to the UTF-16LE filename (malloc()ed buffer). */
207         utf16lechar *file_name;
208
209         /* Full path of this dentry in the WIM */
210         tchar *_full_path;
211
212         /* Actual name to extract this dentry as. */
213         tchar *extraction_name;
214         size_t extraction_name_nchars;
215
216         /* List head for building a list of dentries that contain a certain
217          * stream. */
218         struct list_head extraction_stream_list;
219 };
220
221 #define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
222
223 /*
224  * WIM inode.
225  *
226  * As mentioned above, in the WIM file that is no on-disk analogue of a real
227  * inode, as most of these fields are duplicated in the dentries.
228  */
229 struct wim_inode {
230         /* Timestamps for the inode.  The timestamps are the number of
231          * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
232          * 1st, 1601, UTC.  This is the same format used in NTFS inodes. */
233         u64 i_creation_time;
234         u64 i_last_access_time;
235         u64 i_last_write_time;
236
237         /* The file attributes associated with this inode.  This is a bitwise OR
238          * of the FILE_ATTRIBUTE_* flags. */
239         u32 i_attributes;
240
241         /* The index of the security descriptor in the WIM image's table of
242          * security descriptors that contains this file's security information.
243          * If -1, no security information exists for this file.  */
244         int32_t i_security_id;
245
246         /* %true iff the inode's lookup table entries has been resolved (i.e.
247          * the @lte field is valid, but the @hash field is not valid)
248          *
249          * (This is not an on-disk field.) */
250         u8 i_resolved : 1;
251
252         /* %true iff verify_inode() has run on this inode. */
253         u8 i_verified : 1;
254
255         u8 i_visited : 1;
256
257         /* Used only in NTFS-mode extraction */
258         u8 i_dos_name_extracted : 1;
259
260         /* Set to 0 if reparse point fixups have been done.  Otherwise set to 1.
261          *
262          * Note: this actually may reflect the SYMBOLIC_LINK_RELATIVE flag.  */
263         u16 i_not_rpfixed;
264
265         /* Number of alternate data streams associated with this inode */
266         u16 i_num_ads;
267
268         /* Unused/unknown fields that we just read into memory so we can
269          * re-write them unchanged.  */
270         u32 i_rp_unknown_1;
271         u16 i_rp_unknown_2;
272
273         /* If i_resolved == 0:
274          *      SHA1 message digest of the contents of the unnamed-data stream
275          *      of this inode, or all zeroes if this inode has no unnamed data
276          *      stream, or optionally all zeroes if this inode has an empty
277          *      unnamed data stream.
278          *
279          * If i_resolved == 1:
280          *      Pointer to the lookup table entry for the unnamed data stream
281          *      of this inode, or NULL if this inode has no unnamed data stream,
282          *      or optionally all zeroes if this inode has an empty unnamed data
283          *      stream.
284          */
285         union {
286                 u8 i_hash[SHA1_HASH_SIZE];
287                 struct wim_lookup_table_entry *i_lte;
288         };
289
290         /* Identity of a reparse point.  See
291          * http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
292          * for what a reparse point is. */
293         u32 i_reparse_tag;
294
295         /* Number of dentries that reference this inode */
296         u32 i_nlink;
297
298         /* Alternate data stream entries. */
299         struct wim_ads_entry *i_ads_entries;
300
301         /* Inode number */
302         u64 i_ino;
303
304         /* Device number, used only during image capture */
305         u64 i_devno;
306
307         /* List of dentries that reference this inode (there should be
308          * link_count of them) */
309         struct list_head i_dentry;
310
311         union {
312                 struct hlist_node i_hlist;
313                 struct list_head i_list;
314         };
315
316         tchar *i_extracted_file;
317
318         /* Root of a red-black tree storing the children of this inode (if
319          * non-empty, implies the inode is a directory, although that is also
320          * noted in the @attributes field.) */
321         struct rb_root i_children;
322
323 #ifdef __WIN32__
324         struct rb_root i_children_case_insensitive;
325 #endif
326
327         /* Next alternate data stream ID to be assigned */
328         u32 i_next_stream_id;
329
330 #ifdef WITH_FUSE
331         /* wimfs file descriptors table for the inode */
332         u16 i_num_opened_fds;
333         u16 i_num_allocated_fds;
334         struct wimfs_fd **i_fds;
335         /* This mutex protects the inode's file descriptors table during
336          * read-only mounts.  Read-write mounts are still restricted to 1
337          * thread. */
338         pthread_mutex_t i_mutex;
339 #endif
340 };
341
342 #define inode_for_each_dentry(dentry, inode) \
343                 list_for_each_entry((dentry), &(inode)->i_dentry, d_alias)
344
345 #define inode_add_dentry(dentry, inode) \
346                 list_add_tail(&(dentry)->d_alias, &(inode)->i_dentry)
347
348 #define inode_first_dentry(inode) \
349                 container_of(inode->i_dentry.next, struct wim_dentry, d_alias)
350
351 static inline bool
352 dentry_is_first_in_inode(const struct wim_dentry *dentry)
353 {
354         return inode_first_dentry(dentry->d_inode) == dentry;
355 }
356
357 extern u64
358 dentry_correct_total_length(const struct wim_dentry *dentry);
359
360 extern int
361 for_dentry_in_tree(struct wim_dentry *root,
362                    int (*visitor)(struct wim_dentry*, void*),
363                    void *args);
364
365 extern int
366 for_dentry_in_rbtree(struct rb_node *node,
367                      int (*visitor)(struct wim_dentry *, void *),
368                      void *arg);
369
370 static inline int
371 for_dentry_child(const struct wim_dentry *dentry,
372                  int (*visitor)(struct wim_dentry *, void *),
373                  void *arg)
374 {
375         return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
376                                     visitor,
377                                     arg);
378 }
379
380 extern int
381 for_dentry_in_tree_depth(struct wim_dentry *root,
382                          int (*visitor)(struct wim_dentry*, void*),
383                          void *args);
384
385 extern void
386 calculate_subdir_offsets(struct wim_dentry *dentry, u64 *subdir_offset_p);
387
388 extern int
389 set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
390
391 extern struct wim_dentry *
392 get_dentry(struct WIMStruct *w, const tchar *path);
393
394 extern struct wim_inode *
395 wim_pathname_to_inode(struct WIMStruct *w, const tchar *path);
396
397 extern struct wim_dentry *
398 get_dentry_child_with_name(const struct wim_dentry *dentry,
399                            const tchar *name);
400
401 extern struct wim_dentry *
402 get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
403                                    const utf16lechar *name,
404                                    size_t name_nbytes);
405
406 extern struct wim_dentry *
407 get_parent_dentry(struct WIMStruct *w, const tchar *path);
408
409 extern int
410 print_dentry(struct wim_dentry *dentry, void *lookup_table);
411
412 extern int
413 print_dentry_full_path(struct wim_dentry *entry, void *ignore);
414
415 extern int
416 calculate_dentry_full_path(struct wim_dentry *dentry);
417
418 extern int
419 calculate_dentry_tree_full_paths(struct wim_dentry *root);
420
421 extern tchar *
422 dentry_full_path(struct wim_dentry *dentry);
423
424 extern struct wim_inode *
425 new_timeless_inode(void) _malloc_attribute;
426
427 extern int
428 new_dentry(const tchar *name, struct wim_dentry **dentry_ret);
429
430 extern int
431 new_dentry_with_inode(const tchar *name, struct wim_dentry **dentry_ret);
432
433 extern int
434 new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
435
436 extern int
437 new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
438
439 extern void
440 free_inode(struct wim_inode *inode);
441
442 extern void
443 free_dentry(struct wim_dentry *dentry);
444
445 extern void
446 put_dentry(struct wim_dentry *dentry);
447
448 extern void
449 free_dentry_tree(struct wim_dentry *root,
450                  struct wim_lookup_table *lookup_table);
451
452 extern void
453 unlink_dentry(struct wim_dentry *dentry);
454
455 extern struct wim_dentry *
456 dentry_add_child(struct wim_dentry * restrict parent,
457                  struct wim_dentry * restrict child);
458
459 extern struct wim_ads_entry *
460 inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
461                     u16 *idx_ret);
462
463 extern struct wim_ads_entry *
464 inode_add_ads_utf16le(struct wim_inode *inode,
465                       const utf16lechar *stream_name,
466                       size_t stream_name_nbytes);
467
468 extern struct wim_ads_entry *
469 inode_add_ads(struct wim_inode *dentry, const tchar *stream_name);
470
471 extern int
472 inode_add_ads_with_data(struct wim_inode *inode, const tchar *name,
473                         const void *value, size_t size,
474                         struct wim_lookup_table *lookup_table);
475
476 extern int
477 inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
478                          struct wim_lookup_table *lookup_table);
479
480 extern void
481 inode_remove_ads(struct wim_inode *inode, u16 idx,
482                  struct wim_lookup_table *lookup_table);
483
484
485 #define WIMLIB_UNIX_DATA_TAG "$$__wimlib_UNIX_data"
486 #define WIMLIB_UNIX_DATA_TAG_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG) - 1)
487
488 #define WIMLIB_UNIX_DATA_TAG_UTF16LE "$\0$\0_\0_\0w\0i\0m\0l\0i\0b\0_\0U\0N\0I\0X\0_\0d\0a\0t\0a\0"
489 #define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
490
491 /* Format for special alternate data stream entries to store UNIX data for files
492  * and directories (see: WIMLIB_ADD_FLAG_UNIX_DATA) */
493 struct wimlib_unix_data {
494         u16 version; /* Must be 0 */
495         u16 uid;
496         u16 gid;
497         u16 mode;
498 } _packed_attribute;
499
500 #ifndef __WIN32__
501
502 #define NO_UNIX_DATA (-1)
503 #define BAD_UNIX_DATA (-2)
504 extern int
505 inode_get_unix_data(const struct wim_inode *inode,
506                     struct wimlib_unix_data *unix_data,
507                     u16 *stream_idx_ret);
508
509 #define UNIX_DATA_UID    0x1
510 #define UNIX_DATA_GID    0x2
511 #define UNIX_DATA_MODE   0x4
512 #define UNIX_DATA_ALL    (UNIX_DATA_UID | UNIX_DATA_GID | UNIX_DATA_MODE)
513 #define UNIX_DATA_CREATE 0x8
514 extern int
515 inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
516                     struct wim_lookup_table *lookup_table, int which);
517 #endif
518
519 extern int
520 read_dentry(const u8 *metadata_resource, u64 metadata_resource_len,
521             u64 offset, struct wim_dentry *dentry);
522
523 extern int
524 read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
525                  struct wim_dentry *dentry);
526
527 extern u8 *
528 write_dentry_tree(const struct wim_dentry *tree, u8 *p);
529
530 static inline bool
531 dentry_is_root(const struct wim_dentry *dentry)
532 {
533         return dentry->parent == dentry;
534 }
535
536 static inline bool
537 inode_is_directory(const struct wim_inode *inode)
538 {
539         return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
540                 && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
541 }
542
543 static inline bool
544 dentry_is_directory(const struct wim_dentry *dentry)
545 {
546         return inode_is_directory(dentry->d_inode);
547 }
548
549 /* For our purposes, we consider "real" symlinks and "junction points" to both
550  * be symlinks. */
551 static inline bool
552 inode_is_symlink(const struct wim_inode *inode)
553 {
554         return (inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
555                 && (inode->i_reparse_tag == WIM_IO_REPARSE_TAG_SYMLINK ||
556                     inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
557 }
558
559 static inline bool
560 inode_is_regular_file(const struct wim_inode *inode)
561 {
562         return !inode_is_directory(inode) && !inode_is_symlink(inode);
563 }
564
565 static inline bool
566 dentry_is_regular_file(const struct wim_dentry *dentry)
567 {
568         return inode_is_regular_file(dentry->d_inode);
569 }
570
571 static inline bool
572 inode_has_children(const struct wim_inode *inode)
573 {
574         return inode->i_children.rb_node != NULL;
575 }
576
577 static inline bool
578 dentry_has_children(const struct wim_dentry *dentry)
579 {
580         return inode_has_children(dentry->d_inode);
581 }
582
583 static inline bool
584 dentry_has_short_name(const struct wim_dentry *dentry)
585 {
586         return dentry->short_name_nbytes != 0;
587 }
588
589 static inline bool
590 dentry_has_long_name(const struct wim_dentry *dentry)
591 {
592         return dentry->file_name_nbytes != 0;
593 }
594
595 extern void
596 inode_ref_streams(struct wim_inode *inode);
597
598 extern int
599 dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
600
601 extern int
602 verify_dentry(struct wim_dentry *dentry, void *wim);
603
604 #endif