mirror of https://github.com/vbatts/go-mtree.git synced 2024-12-31 09:41:11 +00:00

File systems verification utility and library, in likeness of mtree(8)

Find a file

Vincent Batts 738b0fed45 Merge pull request #24 from stephen679/leading_whitespace_comments parse: ignore leading whitespace for comments		2016-07-19 09:00:56 +09:00
cmd/gomtree	main: 'type' keyword should always be evaluated	2016-07-15 09:59:18 -04:00
testdata	*: initial thoughts	2016-03-10 16:15:55 -05:00
xattr	travis: add travis check	2016-04-06 13:57:11 -04:00
.travis.yml	travis: go1.5 and go1.6 have vet builtin	2016-04-13 15:34:50 -04:00
check.go	Merge pull request #20 from stephen679/validate_correct_path	2016-07-15 11:34:32 +09:00
check_test.go	parse: ignore leading whitespace for comments	2016-07-17 12:21:52 -04:00
cksum.go	cksum: comment	2016-03-24 16:35:09 -04:00
cksum_test.go	cksum: test is fine. commenting.	2016-04-05 16:47:36 -04:00
hierarchy.go	travis: add travis check	2016-04-06 13:57:11 -04:00
keywords.go	keywords: time keyword 9 postition decimal	2016-06-27 13:24:03 -04:00
keywords_linux.go	mtree: non-relative import path	2016-03-31 14:04:53 -04:00
keywords_unsupported.go	keywords: added experimental "xattr" keyword	2016-03-24 16:35:09 -04:00
LICENSE	LICENSE: adding a license	2016-03-24 16:34:58 -04:00
mtree_test.go	hierarchy: testing works	2016-04-05 17:16:44 -04:00
parse.go	parse: ignore leading whitespace for comments	2016-07-17 12:21:52 -04:00
README.md	README: add a README	2016-03-30 16:57:23 -04:00
walk.go	Create and insert metadata Entry's	2016-07-14 09:57:37 -04:00
walk_test.go	walk: test passes and validates parse	2016-04-06 12:45:08 -04:00

README.md

go-mtree

mtree is a filesystem hierarchy validation tooling and format. This is a library and simple cli tool for mtree(8) support.

While the traditional mtree cli utility is primarily on BSDs (FreeBSD, openBSD, etc), but even broader support for the mtree specification format is provided with libarchive (libarchive-formats(5)).

There is also an mtree port for Linux though it is not widely packaged for Linux distributions.

Format

The format of hierarchy specification is consistent with the # mtree v2.0 format. Both the BSD mtree and libarchive ought to be interoperable with it with only one definite caveat. On Linux, extended attributes (xattr) on files are often a critical aspect of the file, holding ACLs, capabilities, etc. While FreeBSD filesystem do support extattr, this feature has not made its way into their mtree.

This implementation of mtree supports an additional "keyword" of xattr. If you include this keyword, then the FreeBSD mtree will fail as it is an unknown keyword to that implementation.

Typical form

With the standard keywords, plus say sha256digest, the hierarchy specification looks like:

# .
/set type=file nlink=1 mode=0664 uid=1000 gid=100
. size=4096 type=dir mode=0755 nlink=6 time=1459370393.273231538
    LICENSE size=1502 mode=0644 time=1458851690.0 sha256digest=ef4e53d83096be56dc38dbf9bc8ba9e3068bec1ec37c179033d1e8f99a1c2a95
    README.md size=2820 mode=0644 time=1459370256.316148361 sha256digest=d9b955134d99f84b17c0a711ce507515cc93cd7080a9dcd50400e3d993d876ac

[...]

See the directory presently in, and the files present. Along with each path, is provided the keywords and the unique values for each path. Any common keyword and values are established in the /set command.

Extended attributes form

# .
/set type=file nlink=1 mode=0664 uid=1000 gid=1000
. size=4096 type=dir mode=0775 nlink=6 time=1459370191.11179595 xattr.security.selinux=6b53fb56e2e61a6c6d672817791db03ebe693748
    LICENSE size=1502 time=1458851690.583562292 xattr.security.selinux=6b53fb56e2e61a6c6d672817791db03ebe693748
    README.md size=2366 mode=0644 time=1459369604.0 xattr.security.selinux=6b53fb56e2e61a6c6d672817791db03ebe693748

[...]

See the keyword prefixed with xattr. followed by the extended attribute's namespace and keyword. This setup is consistent for use with Linux extended attributes as well as FreeBSD extended attributes.

Since extended attributes are an unordered hashmap, this approach allows for checking each <namespace>.<key> individually.

The value is the SHA1 digest of the value of the particular extended attribute. Since the values themselves could be raw bytes, this approach both avoids issues with encoding, as well as issues of information leaking. The designation of SHA1 is arbitrary and seen as a general "good enough" assertion of the value.

Usage

To use the Go programming language library, see the docs.

To use the command line tool, first build it, then the following.

Create a manifest

This will also include the sha512 digest of the files.

gomtree -c -K sha512digest -p . > /tmp/mtree.txt

Validate a manifest

gomtree -p . -f /tmp/mtree.txt

See the supported keywords

gomtree -l

Building

Either:

go get github.com/vbatts/go-mtree/cmd/gomtree

git clone git://github.com/vbatts/go-mtree.git
cd ./go-mtree/cmd/gomtree
go build .