aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoe Richey <joerichey@google.com>2017-03-02 10:38:33 -0800
committerJoe Richey joerichey@google.com <joerichey@google.com>2017-05-02 13:39:18 -0700
commita683ab55245aa44ada5059f8e9816adbd94198ff (patch)
tree13b966a777803e1b2a870b89219c3440259e9ffb /README.md
parent06e86bde8886aca3e1cd8cbc948cff7a103f97ab (diff)
metadata: get and set policies from go
This commit adds in the ability to get and set policy data from go using the GetPolicy and SetPolicy functions. This is done via a patch of the x/sys/unix package that exposes the filesystem encryption structures. Note that not all the fields of the PolicyData protocol buffer are needed to get and set policies. The wrapped_policy_keys are not used and will be written and read by other components of fscrypt. To run the policy tests, the environment variable BASE_TEST_DIR must be set to a directory for testing on a filesystem that supports encryption. Change-Id: I13b1d983356845f3ffc1945cedf53234218f32e5
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.md b/README.md
index ba31826..e9cb5c8 100644
--- a/README.md
+++ b/README.md
@@ -71,7 +71,7 @@ You will also want to add `$GOPATH/bin` to your `$PATH`.
`fscrypt` has the following build dependencies:
* `make`
-* A C compiler ('gcc' or 'clang')
+* A C compiler (`gcc` or `clang`)
* Go
Once this is setup, you can run `make fscrypt` to build the executable in
@@ -81,10 +81,13 @@ dynamically linked binary by default.
## Running and Installing
-`fscrypt` currently has no runtime dependencies. Installing it just requires
-placing it in your path or running `make install`. Change `$GOBIN` to change the
-install location of `fscrypt`. By default, `fscrypt` is installed to
-`$GOPATH/bin`.
+`fscrypt` has the following runtime dependencies:
+* Kernel support for filesystem encryption (this will depend on your kernel
+ configuration and specific filesystem)
+
+Installing it just requires placing it in your path or running `make install`.
+Change `$GOBIN` to change the install location of `fscrypt`. By default,
+`fscrypt` is installed to `$GOPATH/bin`.
## Example Usage