2016-06-06 23:57:42 +02:00
|
|
|
package test_helpers
|
2015-11-12 21:02:44 +01:00
|
|
|
|
|
|
|
import (
|
|
|
|
"crypto/md5"
|
|
|
|
"encoding/hex"
|
2015-11-14 17:16:17 +01:00
|
|
|
"fmt"
|
|
|
|
"io/ioutil"
|
|
|
|
"os"
|
|
|
|
"os/exec"
|
2016-02-07 13:28:55 +01:00
|
|
|
"path/filepath"
|
2016-07-02 20:06:20 +02:00
|
|
|
"runtime"
|
2015-12-13 20:10:52 +01:00
|
|
|
"syscall"
|
2015-11-12 21:02:44 +01:00
|
|
|
"testing"
|
2015-11-27 23:34:55 +01:00
|
|
|
|
2016-02-06 19:20:54 +01:00
|
|
|
"github.com/rfjakob/gocryptfs/internal/nametransform"
|
2015-11-12 21:02:44 +01:00
|
|
|
)
|
|
|
|
|
2016-06-30 00:57:14 +02:00
|
|
|
const testParentDir = "/tmp/gocryptfs-test-parent"
|
2016-06-06 23:57:42 +02:00
|
|
|
const GocryptfsBinary = "../../gocryptfs"
|
2015-11-15 13:38:19 +01:00
|
|
|
|
2016-06-30 00:57:14 +02:00
|
|
|
// "go test" runs package tests in parallel! We must create a unique TmpDir on
|
|
|
|
// startup or the tests will interfere horribly
|
|
|
|
var TmpDir string
|
|
|
|
var DefaultPlainDir string
|
|
|
|
var DefaultCipherDir string
|
|
|
|
|
|
|
|
func init() {
|
|
|
|
os.MkdirAll(testParentDir, 0700)
|
|
|
|
var err error
|
|
|
|
TmpDir, err = ioutil.TempDir(testParentDir, "")
|
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
DefaultPlainDir = TmpDir + "/default-plain"
|
|
|
|
DefaultCipherDir = TmpDir + "/default-cipher"
|
|
|
|
}
|
|
|
|
|
2016-06-16 21:06:03 +02:00
|
|
|
// ResetTmpDir - delete TmpDir, create new dir tree:
|
|
|
|
//
|
|
|
|
// TmpDir
|
|
|
|
// |-- DefaultPlainDir
|
|
|
|
// *-- DefaultCipherDir
|
|
|
|
// *-- gocryptfs.diriv
|
2016-06-06 23:57:42 +02:00
|
|
|
func ResetTmpDir(plaintextNames bool) {
|
2016-06-30 00:57:14 +02:00
|
|
|
// Try to unmount and delete everything
|
2016-06-06 23:57:42 +02:00
|
|
|
entries, err := ioutil.ReadDir(TmpDir)
|
2016-04-10 19:43:37 +02:00
|
|
|
if err == nil {
|
|
|
|
for _, e := range entries {
|
2016-06-30 00:57:14 +02:00
|
|
|
d := filepath.Join(TmpDir, e.Name())
|
|
|
|
err = os.Remove(d)
|
|
|
|
if err != nil {
|
2016-07-11 20:40:53 +02:00
|
|
|
if testing.Verbose() {
|
|
|
|
fmt.Printf("%v, trying umount\n", d, err)
|
|
|
|
}
|
2016-07-11 20:31:36 +02:00
|
|
|
UnmountErr(d)
|
|
|
|
err = os.RemoveAll(d)
|
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
2016-06-30 00:57:14 +02:00
|
|
|
}
|
2016-04-10 19:43:37 +02:00
|
|
|
}
|
|
|
|
}
|
2016-06-30 00:57:14 +02:00
|
|
|
err = os.Mkdir(DefaultPlainDir, 0700)
|
2015-11-15 15:05:15 +01:00
|
|
|
if err != nil {
|
2016-06-30 00:57:14 +02:00
|
|
|
panic(err)
|
2015-11-15 15:05:15 +01:00
|
|
|
}
|
2016-06-30 00:57:14 +02:00
|
|
|
err = os.Mkdir(DefaultCipherDir, 0700)
|
2015-11-12 21:02:44 +01:00
|
|
|
if err != nil {
|
2016-06-30 00:57:14 +02:00
|
|
|
panic(err)
|
2015-11-12 21:02:44 +01:00
|
|
|
}
|
2016-02-07 13:28:55 +01:00
|
|
|
if !plaintextNames {
|
2016-06-06 23:57:42 +02:00
|
|
|
err = nametransform.WriteDirIV(DefaultCipherDir)
|
2016-02-07 13:28:55 +01:00
|
|
|
if err != nil {
|
2016-06-30 00:57:14 +02:00
|
|
|
panic(err)
|
2016-02-07 13:28:55 +01:00
|
|
|
}
|
2015-11-27 21:50:11 +01:00
|
|
|
}
|
2015-11-12 21:02:44 +01:00
|
|
|
}
|
|
|
|
|
2016-06-16 21:06:03 +02:00
|
|
|
// InitFS calls "gocryptfs -init" on a new directory in TmpDir, passing
|
|
|
|
// "extraArgs" in addition to practical defaults.
|
2016-06-27 21:39:02 +02:00
|
|
|
//
|
|
|
|
// The returned cipherdir has NO trailing slash.
|
2016-06-16 21:06:03 +02:00
|
|
|
func InitFS(t *testing.T, extraArgs ...string) string {
|
|
|
|
dir, err := ioutil.TempDir(TmpDir, "")
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
args := []string{"-q", "-init", "-extpass", "echo test", "-scryptn=10"}
|
|
|
|
args = append(args, extraArgs...)
|
|
|
|
args = append(args, dir)
|
|
|
|
|
|
|
|
cmd := exec.Command(GocryptfsBinary, args...)
|
|
|
|
cmd.Stdout = os.Stdout
|
|
|
|
cmd.Stderr = os.Stderr
|
|
|
|
|
|
|
|
err = cmd.Run()
|
|
|
|
if err != nil {
|
|
|
|
t.Fatalf("InitFS with args %v failed: %v", args, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
return dir
|
|
|
|
}
|
|
|
|
|
2016-06-06 23:57:42 +02:00
|
|
|
// Mount CIPHERDIR "c" on PLAINDIR "p"
|
2016-06-16 21:06:03 +02:00
|
|
|
// Creates "p" if it does not exist.
|
2016-06-23 21:29:00 +02:00
|
|
|
func Mount(c string, p string, showOutput bool, extraArgs ...string) error {
|
2015-11-12 21:02:44 +01:00
|
|
|
var args []string
|
|
|
|
args = append(args, extraArgs...)
|
2016-06-30 00:57:14 +02:00
|
|
|
args = append(args, "-q", "-wpanic")
|
2016-02-07 13:28:55 +01:00
|
|
|
//args = append(args, "-fusedebug")
|
|
|
|
//args = append(args, "-d")
|
2015-11-15 15:05:15 +01:00
|
|
|
args = append(args, c)
|
|
|
|
args = append(args, p)
|
2016-06-16 21:06:03 +02:00
|
|
|
|
|
|
|
if _, err := os.Stat(p); err != nil {
|
|
|
|
err = os.Mkdir(p, 0777)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-06 23:57:42 +02:00
|
|
|
cmd := exec.Command(GocryptfsBinary, args...)
|
2016-06-23 21:29:00 +02:00
|
|
|
if showOutput {
|
|
|
|
cmd.Stderr = os.Stderr
|
|
|
|
cmd.Stdout = os.Stdout
|
|
|
|
}
|
2016-06-19 20:01:29 +02:00
|
|
|
|
2016-06-06 22:30:39 +02:00
|
|
|
return cmd.Run()
|
|
|
|
}
|
|
|
|
|
2016-06-06 23:57:42 +02:00
|
|
|
// MountOrExit calls mount() and exits on failure.
|
|
|
|
func MountOrExit(c string, p string, extraArgs ...string) {
|
2016-06-23 21:29:00 +02:00
|
|
|
err := Mount(c, p, true, extraArgs...)
|
2015-11-12 21:02:44 +01:00
|
|
|
if err != nil {
|
2016-06-06 22:30:39 +02:00
|
|
|
fmt.Printf("mount failed: %v", err)
|
2015-11-12 21:02:44 +01:00
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-06 23:57:42 +02:00
|
|
|
// MountOrFatal calls mount() and calls t.Fatal() on failure.
|
|
|
|
func MountOrFatal(t *testing.T, c string, p string, extraArgs ...string) {
|
2016-06-23 21:29:00 +02:00
|
|
|
err := Mount(c, p, true, extraArgs...)
|
2016-06-06 22:30:39 +02:00
|
|
|
if err != nil {
|
|
|
|
t.Fatal(fmt.Errorf("mount failed: %v", err))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-07-11 20:31:36 +02:00
|
|
|
// UnmountPanic tries to umount "dir" and panics on error.
|
|
|
|
func UnmountPanic(dir string) {
|
|
|
|
err := UnmountErr(dir)
|
|
|
|
if err != nil {
|
|
|
|
fmt.Println(err)
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// UnmountError tries to unmount "dir" and returns the resulting error.
|
|
|
|
func UnmountErr(dir string) error {
|
2016-07-02 20:06:20 +02:00
|
|
|
var cmd *exec.Cmd
|
|
|
|
if runtime.GOOS == "darwin" {
|
2016-07-11 20:31:36 +02:00
|
|
|
cmd = exec.Command("umount", dir)
|
2016-07-02 20:06:20 +02:00
|
|
|
} else {
|
2016-07-11 20:31:36 +02:00
|
|
|
cmd = exec.Command("fusermount", "-u", "-z", dir)
|
2016-07-02 20:06:20 +02:00
|
|
|
}
|
|
|
|
cmd.Stdout = os.Stdout
|
|
|
|
cmd.Stderr = os.Stderr
|
2016-07-11 20:31:36 +02:00
|
|
|
return cmd.Run()
|
2015-11-12 21:02:44 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Return md5 string for file "filename"
|
2016-06-06 23:57:42 +02:00
|
|
|
func Md5fn(filename string) string {
|
2015-11-12 21:02:44 +01:00
|
|
|
buf, err := ioutil.ReadFile(filename)
|
|
|
|
if err != nil {
|
|
|
|
fmt.Printf("ReadFile: %v\n", err)
|
|
|
|
return ""
|
|
|
|
}
|
2016-06-06 23:57:42 +02:00
|
|
|
return Md5hex(buf)
|
2015-11-12 21:02:44 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Return md5 string for "buf"
|
2016-06-06 23:57:42 +02:00
|
|
|
func Md5hex(buf []byte) string {
|
2015-11-12 21:02:44 +01:00
|
|
|
rawHash := md5.Sum(buf)
|
|
|
|
hash := hex.EncodeToString(rawHash[:])
|
|
|
|
return hash
|
|
|
|
}
|
|
|
|
|
|
|
|
// Verify that the file size equals "want". This checks:
|
|
|
|
// 1) Size reported by Stat()
|
|
|
|
// 2) Number of bytes returned when reading the whole file
|
2016-06-06 23:57:42 +02:00
|
|
|
func VerifySize(t *testing.T, path string, want int) {
|
2015-11-12 21:02:44 +01:00
|
|
|
buf, err := ioutil.ReadFile(path)
|
|
|
|
if err != nil {
|
|
|
|
t.Errorf("ReadFile failed: %v", err)
|
|
|
|
} else if len(buf) != want {
|
|
|
|
t.Errorf("wrong read size: got=%d want=%d", len(buf), want)
|
|
|
|
}
|
|
|
|
|
|
|
|
fi, err := os.Stat(path)
|
|
|
|
if err != nil {
|
|
|
|
t.Errorf("Stat failed: %v", err)
|
|
|
|
} else if fi.Size() != int64(want) {
|
|
|
|
t.Errorf("wrong stat file size, got=%d want=%d", fi.Size(), want)
|
|
|
|
}
|
|
|
|
}
|
2015-12-10 20:02:18 +01:00
|
|
|
|
|
|
|
// Create and delete a directory
|
2016-06-06 23:57:42 +02:00
|
|
|
func TestMkdirRmdir(t *testing.T, plainDir string) {
|
2016-06-30 00:57:14 +02:00
|
|
|
dir := plainDir + "/dir1"
|
2015-12-10 20:02:18 +01:00
|
|
|
err := os.Mkdir(dir, 0777)
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
err = syscall.Rmdir(dir)
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
2015-12-11 19:54:53 +01:00
|
|
|
|
|
|
|
// Removing a non-empty dir should fail with ENOTEMPTY
|
|
|
|
if os.Mkdir(dir, 0777) != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
f, err := os.Create(dir + "/file")
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
f.Close()
|
|
|
|
err = syscall.Rmdir(dir)
|
|
|
|
errno := err.(syscall.Errno)
|
|
|
|
if errno != syscall.ENOTEMPTY {
|
|
|
|
t.Errorf("Should have gotten ENOTEMPTY, go %v", errno)
|
|
|
|
}
|
2015-12-13 20:10:52 +01:00
|
|
|
if syscall.Unlink(dir+"/file") != nil {
|
2015-12-11 19:54:53 +01:00
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
if syscall.Rmdir(dir) != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// We should also be able to remove a directory we do not have permissions to
|
|
|
|
// read or write
|
|
|
|
err = os.Mkdir(dir, 0000)
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
err = syscall.Rmdir(dir)
|
|
|
|
if err != nil {
|
2016-04-10 19:43:37 +02:00
|
|
|
// Make sure the directory can cleaned up by the next test run
|
|
|
|
os.Chmod(dir, 0700)
|
2015-12-11 19:54:53 +01:00
|
|
|
t.Fatal(err)
|
|
|
|
}
|
2015-12-10 20:02:18 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Create and rename a file
|
2016-06-06 23:57:42 +02:00
|
|
|
func TestRename(t *testing.T, plainDir string) {
|
2016-06-30 00:57:14 +02:00
|
|
|
file1 := plainDir + "/rename1"
|
|
|
|
file2 := plainDir + "/rename2"
|
2015-12-10 20:02:18 +01:00
|
|
|
err := ioutil.WriteFile(file1, []byte("content"), 0777)
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
err = syscall.Rename(file1, file2)
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
syscall.Unlink(file2)
|
|
|
|
}
|
2016-02-07 10:55:13 +01:00
|
|
|
|
|
|
|
// verifyExistence - check in 3 ways that "path" exists:
|
|
|
|
// stat, open, readdir
|
2016-06-06 23:57:42 +02:00
|
|
|
func VerifyExistence(path string) bool {
|
2016-02-07 10:55:13 +01:00
|
|
|
// Check that file can be stated
|
|
|
|
_, err := os.Stat(path)
|
|
|
|
if err != nil {
|
|
|
|
//t.Log(err)
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
// Check that file can be opened
|
|
|
|
fd, err := os.Open(path)
|
|
|
|
if err != nil {
|
|
|
|
//t.Log(err)
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
fd.Close()
|
|
|
|
// Check that file shows up in directory listing
|
|
|
|
dir := filepath.Dir(path)
|
|
|
|
name := filepath.Base(path)
|
|
|
|
fi, err := ioutil.ReadDir(dir)
|
|
|
|
if err != nil {
|
|
|
|
//t.Log(err)
|
|
|
|
return false
|
|
|
|
}
|
2016-02-07 13:28:55 +01:00
|
|
|
for _, i := range fi {
|
2016-02-07 10:55:13 +01:00
|
|
|
if i.Name() == name {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
2016-07-02 19:43:57 +02:00
|
|
|
|
|
|
|
// Du returns the disk usage of the file "fd" points to, in bytes.
|
|
|
|
// Same as "du --block-size=1".
|
|
|
|
func Du(t *testing.T, fd int) (nBytes int64, nBlocks int64) {
|
|
|
|
var st syscall.Stat_t
|
|
|
|
err := syscall.Fstat(fd, &st)
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
2016-07-04 08:20:52 +02:00
|
|
|
// On OSX, Blksize is int32, need to cast to int64.
|
|
|
|
return st.Blocks * int64(st.Blksize), st.Blocks
|
2016-07-02 19:43:57 +02:00
|
|
|
}
|