filesystem

type DeviceNumber ¶

type DeviceNumber uint64

DeviceNumber represents a combined major:minor device number.

func (num DeviceNumber) String() string

type ErrAlreadySetup ¶

type ErrAlreadySetup struct {
	Mount *Mount
}

ErrAlreadySetup indicates that a filesystem is already setup for fscrypt.

func (err *ErrAlreadySetup) Error() string

type ErrCorruptMetadata ¶

type ErrCorruptMetadata struct {
	Path            string
	UnderlyingError error
}

ErrCorruptMetadata indicates that an fscrypt metadata file is corrupt.

func (err *ErrCorruptMetadata) Error() string

type ErrFollowLink ¶

type ErrFollowLink struct {
	Link            string
	UnderlyingError error
}

ErrFollowLink indicates that a protector link can't be followed.

func (err *ErrFollowLink) Error() string

type ErrMakeLink ¶

type ErrMakeLink struct {
	Target          *Mount
	UnderlyingError error
}

ErrMakeLink indicates that a protector link can't be created.

func (err *ErrMakeLink) Error() string

type ErrNotAMountpoint ¶

type ErrNotAMountpoint struct {
	Path string
}

ErrNotAMountpoint indicates that a path is not a mountpoint.

func (err *ErrNotAMountpoint) Error() string

type ErrNotSetup ¶

type ErrNotSetup struct {
	Mount *Mount
}

ErrNotSetup indicates that a filesystem is not setup for fscrypt.

func (err *ErrNotSetup) Error() string

type ErrPolicyNotFound ¶

type ErrPolicyNotFound struct {
	Descriptor string
	Mount      *Mount
}

ErrPolicyNotFound indicates that the policy metadata was not found.

func (err *ErrPolicyNotFound) Error() string

type ErrProtectorNotFound ¶

type ErrProtectorNotFound struct {
	Descriptor string
	Mount      *Mount
}

ErrProtectorNotFound indicates that the protector metadata was not found.

func (err *ErrProtectorNotFound) Error() string

type Mount ¶

type Mount struct {
	Path           string
	FilesystemType string
	Device         string
	DeviceNumber   DeviceNumber
	Subtree        string
	ReadOnly       bool
}

Mount contains information for a specific mounted filesystem.

Path           - Absolute path where the directory is mounted
FilesystemType - Type of the mounted filesystem, e.g. "ext4"
Device         - Device for filesystem (empty string if we cannot find one)
DeviceNumber   - Device number of the filesystem.  This is set even if
		 Device isn't, since all filesystems have a device
		 number assigned by the kernel, even pseudo-filesystems.
Subtree        - The mounted subtree of the filesystem.  This is usually
		 "/", meaning that the entire filesystem is mounted, but
		 it can differ for bind mounts.
ReadOnly       - True if this is a read-only mount

In order to use a Mount to store fscrypt metadata, some directories must be setup first. Specifically, the directories created look like: <mountpoint> └── .fscrypt

├── policies
└── protectors

These "policies" and "protectors" directories will contain files that are the corresponding metadata structures for policies and protectors. The public interface includes functions for setting up these directories and Adding, Getting, and Removing these files.

There is also the ability to reference another filesystem's metadata. This is used when a Policy on filesystem A is protected with Protector on filesystem B. In this scenario, we store a "link file" in the protectors directory whose contents look like "UUID=3a6d9a76-47f0-4f13-81bf-3332fbe984fb".

We also allow ".fscrypt" to be a symlink which was previously created. This allows login protectors to be created when the root filesystem is read-only, provided that "/.fscrypt" is a symlink pointing to a writable location.

func AllFilesystems() ([]*Mount, error)

func FindMount(path string) (*Mount, error)

func GetMount(mountpoint string) (*Mount, error)

type PathSorter ¶

type PathSorter []*Mount

PathSorter allows mounts to be sorted by Path.

func (p PathSorter) Len() int

func (p PathSorter) Less(i, j int) bool

func (p PathSorter) Swap(i, j int)