Titokhan / apfs-fuse

FUSE driver for APFS (Apple File System)

APFS FUSE Driver for Linux

This project is a read-only FUSE driver for the new Apple File System. Since Apple didn't yet document the disk format of APFS, this driver should be considered experimental... It may not be able to read all files, it may return wrong data, or it may simply crash. Use at your own risk. But since it's read-only, at least the data on your apfs drive should be safe.

Be aware that not all compression methods are supported yet (only the ones I have encountered so far). Thus, the driver may return compressed files instead of uncompressed ones ...

Usage

Compile the source code

The following libraries are needed:

• FUSE 2.6 or greater
• ICU

mkdir build
cd build
cmake ..
make

After compilation, the binaries are located in bin.

Mount a drive

apfs-fuse <device> <mount-directory>

Supported options:

• -d n: If n > 0, enable debug output.
• -o opts: Comma-separated list of mount options.
• -v n: Instead of mounting the first volume in a container, mount volume n (starting at 0).

The device has to be the one containing the APFS container. If a container contains more than one volume, the volume can be specified by the -v option.

If a volume is encrypted, the apfs-fuse command will prompt for a password.

Unmount a drive

fusermount -u <mount-directory>

Features

The following features are implemented:

• Can read macOS 10.13 case sensitive and insensitive volumes, as well as iOS 11 / macOS 10.12 volumes
• Transparent decompression of ZLib and LZVN
• Symlinks
• Hardlinks (it seems ...)
• Extended attributes
• Encryption (at least full-disk encryption)

Limitations

These things are not supported (yet):

• Transparent decompression of LZFSE
• Writing