libgocryptfs/main.go

390 lines
12 KiB
Go
Raw Normal View History

2015-09-03 19:27:07 +02:00
package main
import (
"encoding/json"
"flag"
2015-09-05 11:49:05 +02:00
"fmt"
"io/ioutil"
2015-09-06 12:12:14 +02:00
"os"
"os/exec"
"os/signal"
2015-09-06 12:12:14 +02:00
"path/filepath"
"runtime"
2015-10-04 14:36:20 +02:00
"runtime/pprof"
"syscall"
2015-10-04 14:36:20 +02:00
"time"
2015-12-19 15:46:19 +01:00
"golang.org/x/crypto/ssh/terminal"
"github.com/rfjakob/gocryptfs/cryptfs"
2015-10-04 14:36:20 +02:00
"github.com/rfjakob/gocryptfs/pathfs_frontend"
"github.com/hanwen/go-fuse/fuse"
"github.com/hanwen/go-fuse/fuse/nodefs"
"github.com/hanwen/go-fuse/fuse/pathfs"
2015-09-03 19:27:07 +02:00
)
2015-09-05 11:49:05 +02:00
const (
PROGRAM_NAME = "gocryptfs"
// Exit codes
2015-10-11 18:51:56 +02:00
ERREXIT_USAGE = 1
ERREXIT_MOUNT = 3
ERREXIT_CIPHERDIR = 6
ERREXIT_INIT = 7
ERREXIT_LOADCONF = 8
ERREXIT_PASSWORD = 9
ERREXIT_MOUNTPOINT = 10
2015-09-05 11:49:05 +02:00
)
type argContainer struct {
debug, init, zerokey, fusedebug, openssl, passwd, foreground, version,
plaintextnames, quiet, diriv, emenames, gcmiv128 bool
masterkey, mountpoint, cipherdir, cpuprofile, config, extpass string
notifypid, scryptn int
}
var flagSet *flag.FlagSet
2015-11-02 22:50:53 +01:00
// GitVersion will be set by the build script "build.bash"
var GitVersion = "[version not set - please compile using ./build.bash]"
func initDir(args *argContainer) {
err := checkDirEmpty(args.cipherdir)
if err != nil {
2015-12-19 15:46:19 +01:00
fmt.Printf("Invalid cipherdir: %v\n", err)
2015-10-04 14:36:20 +02:00
os.Exit(ERREXIT_INIT)
}
// Create gocryptfs.conf
cryptfs.Info.Printf("Choose a password for protecting your files.")
password := readPasswordTwice(args.extpass)
err = cryptfs.CreateConfFile(args.config, password, args.plaintextnames, args.scryptn)
if err != nil {
fmt.Println(err)
os.Exit(ERREXIT_INIT)
}
if args.diriv && !args.plaintextnames {
// Create gocryptfs.diriv in the root dir
err = cryptfs.WriteDirIV(args.cipherdir)
if err != nil {
fmt.Println(err)
os.Exit(ERREXIT_INIT)
}
2015-10-04 14:36:20 +02:00
}
cryptfs.Info.Printf(colorGreen + "The filesystem has been created successfully." + colorReset)
cryptfs.Info.Printf(colorGrey+"You can now mount it using: %s %s MOUNTPOINT"+colorReset,
2016-01-04 20:55:25 +01:00
PROGRAM_NAME, args.cipherdir)
2015-10-04 14:36:20 +02:00
os.Exit(0)
}
2015-10-07 21:59:54 +02:00
func usageText() {
printVersion()
fmt.Printf("\n")
fmt.Printf("Usage: %s -init|-passwd [OPTIONS] CIPHERDIR\n", PROGRAM_NAME)
fmt.Printf(" or %s [OPTIONS] CIPHERDIR MOUNTPOINT\n", PROGRAM_NAME)
fmt.Printf("\nOptions:\n")
flagSet.PrintDefaults()
2015-10-07 21:59:54 +02:00
}
// loadConfig - load the config file "filename", prompting the user for the password
func loadConfig(args *argContainer) (masterkey []byte, confFile *cryptfs.ConfFile) {
// Check if the file exists at all before prompting for a password
_, err := os.Stat(args.config)
if err != nil {
fmt.Println(err)
os.Exit(ERREXIT_LOADCONF)
}
fmt.Printf("Password: ")
pw := readPassword(args.extpass)
cryptfs.Info.Printf("Decrypting master key... ")
cryptfs.Warn.SetOutput(ioutil.Discard) // Silence DecryptBlock() error messages on incorrect password
masterkey, confFile, err = cryptfs.LoadConfFile(args.config, pw)
cryptfs.Warn.SetOutput(os.Stderr)
if err != nil {
fmt.Println(err)
2015-12-19 15:46:19 +01:00
fmt.Println(colorRed + "Wrong password." + colorReset)
os.Exit(ERREXIT_LOADCONF)
}
cryptfs.Info.Printf("done.")
return masterkey, confFile
}
// changePassword - change the password of config file "filename"
func changePassword(args *argContainer) {
masterkey, confFile := loadConfig(args)
fmt.Println("Please enter your new password.")
newPw := readPasswordTwice(args.extpass)
confFile.EncryptKey(masterkey, newPw, confFile.ScryptObject.LogN())
err := confFile.WriteFile()
if err != nil {
fmt.Println(err)
os.Exit(ERREXIT_INIT)
}
cryptfs.Info.Printf("Password changed.")
os.Exit(0)
}
// printVersion - print a version string like
// "gocryptfs v0.3.1-31-g6736212-dirty; on-disk format 2"
func printVersion() {
fmt.Printf("%s %s; on-disk format %d\n", PROGRAM_NAME, GitVersion, cryptfs.HEADER_CURRENT_VERSION)
}
func main() {
runtime.GOMAXPROCS(4)
var err error
var args argContainer
2015-12-19 15:46:19 +01:00
setupColors()
2015-09-18 22:14:07 +02:00
// Parse command line arguments
flagSet = flag.NewFlagSet(PROGRAM_NAME, flag.ExitOnError)
flagSet.Usage = usageText
flagSet.BoolVar(&args.debug, "debug", false, "Enable debug output")
flagSet.BoolVar(&args.fusedebug, "fusedebug", false, "Enable fuse library debug output")
flagSet.BoolVar(&args.init, "init", false, "Initialize encrypted directory")
flagSet.BoolVar(&args.zerokey, "zerokey", false, "Use all-zero dummy master key")
flagSet.BoolVar(&args.openssl, "openssl", true, "Use OpenSSL instead of built-in Go crypto")
flagSet.BoolVar(&args.passwd, "passwd", false, "Change password")
flagSet.BoolVar(&args.foreground, "f", false, "Stay in the foreground")
flagSet.BoolVar(&args.version, "version", false, "Print version and exit")
2015-11-14 17:16:17 +01:00
flagSet.BoolVar(&args.plaintextnames, "plaintextnames", false, "Do not encrypt "+
"file names")
flagSet.BoolVar(&args.quiet, "q", false, "Quiet - silence informational messages")
flagSet.BoolVar(&args.diriv, "diriv", true, "Use per-directory file name IV")
flagSet.BoolVar(&args.emenames, "emenames", true, "Use EME filename encryption. This option implies diriv.")
flagSet.BoolVar(&args.gcmiv128, "gcmiv128", true, "Use an 128-bit IV for GCM encryption instead of Go's default of 96 bits")
flagSet.StringVar(&args.masterkey, "masterkey", "", "Mount with explicit master key")
2015-11-14 17:16:17 +01:00
flagSet.StringVar(&args.cpuprofile, "cpuprofile", "", "Write cpu profile to specified file")
flagSet.StringVar(&args.config, "config", "", "Use specified config file instead of CIPHERDIR/gocryptfs.conf")
flagSet.StringVar(&args.extpass, "extpass", "", "Use external program for the password prompt")
2015-11-14 17:16:17 +01:00
flagSet.IntVar(&args.notifypid, "notifypid", 0, "Send USR1 to the specified process after "+
"successful mount - used internally for daemonization")
flagSet.IntVar(&args.scryptn, "scryptn", cryptfs.SCRYPT_DEFAULT_LOGN, "scrypt cost parameter logN. "+
"Setting this to a lower value speeds up mounting but makes the password susceptible to brute-force attacks")
flagSet.Parse(os.Args[1:])
// Fork a child into the background if "-f" is not set AND we are mounting a filesystem
if !args.foreground && flagSet.NArg() == 2 {
forkChild() // does not return
}
// "-v"
if args.version {
printVersion()
os.Exit(0)
}
if args.debug {
cryptfs.Debug.SetOutput(os.Stdout)
cryptfs.Debug.Printf("Debug output enabled")
}
// Every operation below requires CIPHERDIR. Check that we have it.
if flagSet.NArg() >= 1 {
args.cipherdir, _ = filepath.Abs(flagSet.Arg(0))
err := checkDir(args.cipherdir)
if err != nil {
2015-12-19 15:46:19 +01:00
fmt.Printf(colorRed+"Invalid cipherdir: %v\n"+colorReset, err)
os.Exit(ERREXIT_CIPHERDIR)
}
} else {
usageText()
os.Exit(ERREXIT_USAGE)
}
// "-q"
2015-11-09 22:33:42 +01:00
if args.quiet {
cryptfs.Info.SetOutput(ioutil.Discard)
2015-11-09 22:33:42 +01:00
}
// "-config"
if args.config != "" {
args.config, err = filepath.Abs(args.config)
if err != nil {
2015-12-19 15:46:19 +01:00
fmt.Printf(colorRed+"Invalid \"-config\" setting: %v\n"+colorReset, err)
}
cryptfs.Info.Printf("Using config file at custom location %s", args.config)
} else {
args.config = filepath.Join(args.cipherdir, cryptfs.ConfDefaultName)
2015-10-11 18:02:48 +02:00
}
// "-cpuprofile"
2015-11-14 17:16:17 +01:00
if args.cpuprofile != "" {
f, err := os.Create(args.cpuprofile)
2015-10-04 14:36:20 +02:00
if err != nil {
fmt.Println(err)
2015-09-18 22:14:07 +02:00
os.Exit(ERREXIT_INIT)
2015-10-04 14:36:20 +02:00
}
cryptfs.Info.Printf("Writing CPU profile to %s", args.cpuprofile)
2015-10-04 14:36:20 +02:00
pprof.StartCPUProfile(f)
defer pprof.StopCPUProfile()
}
// "-openssl"
if args.openssl == false {
cryptfs.Info.Printf("Openssl disabled")
}
// Operation flags: init, passwd or mount
// "-init"
if args.init {
if flagSet.NArg() > 1 {
fmt.Printf("Usage: %s -init [OPTIONS] CIPHERDIR\n", PROGRAM_NAME)
os.Exit(ERREXIT_USAGE)
}
initDir(&args) // does not return
}
// "-passwd"
if args.passwd {
if flagSet.NArg() > 1 {
fmt.Printf("Usage: %s -passwd [OPTIONS] CIPHERDIR\n", PROGRAM_NAME)
os.Exit(ERREXIT_USAGE)
}
changePassword(&args) // does not return
2015-09-03 19:27:07 +02:00
}
// Mount
// Check mountpoint
if flagSet.NArg() != 2 {
usageText()
os.Exit(ERREXIT_USAGE)
}
args.mountpoint, err = filepath.Abs(flagSet.Arg(1))
if err != nil {
2015-12-19 15:46:19 +01:00
fmt.Printf(colorRed+"Invalid mountpoint: %v\n"+colorReset, err)
os.Exit(ERREXIT_MOUNTPOINT)
}
err = checkDirEmpty(args.mountpoint)
if err != nil {
2015-12-19 15:46:19 +01:00
fmt.Printf(colorRed+"Invalid mountpoint: %v\n"+colorReset, err)
os.Exit(ERREXIT_MOUNTPOINT)
}
// Get master key
var masterkey []byte
2015-11-28 16:52:57 +01:00
var confFile *cryptfs.ConfFile
if args.masterkey != "" {
// "-masterkey"
cryptfs.Info.Printf("Using explicit master key.")
masterkey = parseMasterKey(args.masterkey)
cryptfs.Info.Printf("THE MASTER KEY IS VISIBLE VIA \"ps -auxwww\", ONLY USE THIS MODE FOR EMERGENCIES.")
} else if args.zerokey {
// "-zerokey"
cryptfs.Info.Printf("Using all-zero dummy master key.")
cryptfs.Info.Printf("ZEROKEY MODE PROVIDES NO SECURITY AT ALL AND SHOULD ONLY BE USED FOR TESTING.")
masterkey = make([]byte, cryptfs.KEY_LEN)
} else {
// Load master key from config file
masterkey, confFile = loadConfig(&args)
printMasterKey(masterkey)
}
// Initialize FUSE server
cryptfs.Debug.Printf("cli args: %v", args)
2015-11-28 16:52:57 +01:00
srv := pathfsFrontend(masterkey, args, confFile)
2015-12-19 15:46:19 +01:00
cryptfs.Info.Println(colorGreen + "Filesystem mounted and ready." + colorReset)
// We are ready - send USR1 signal to our parent
if args.notifypid > 0 {
sendUsr1(args.notifypid)
}
// Wait for SIGINT in the background and unmount ourselves if we get it.
// This prevents a dangling "Transport endpoint is not connected" mountpoint.
handleSigint(srv, args.mountpoint)
// Jump into server loop. Returns when it gets an umount request from the kernel.
srv.Serve()
// main exits with code 0
}
2015-11-28 16:52:57 +01:00
// pathfsFrontend - initialize gocryptfs/pathfs_frontend
// Calls os.Exit on errors
2015-11-28 16:52:57 +01:00
func pathfsFrontend(key []byte, args argContainer, confFile *cryptfs.ConfFile) *fuse.Server {
// Reconciliate CLI and config file arguments into a Args struct that is passed to the
// filesystem implementation
frontendArgs := pathfs_frontend.Args{
2015-11-29 21:55:20 +01:00
Cipherdir: args.cipherdir,
Masterkey: key,
OpenSSL: args.openssl,
2015-11-28 16:52:57 +01:00
PlaintextNames: args.plaintextnames,
2015-11-29 21:55:20 +01:00
DirIV: args.diriv,
EMENames: args.emenames,
GCMIV128: args.gcmiv128,
2015-11-28 16:52:57 +01:00
}
// confFile is nil when "-zerokey" or "-masterkey" was used
if confFile != nil {
// Settings from the config file override command line args
frontendArgs.PlaintextNames = confFile.IsFeatureFlagSet(cryptfs.FlagPlaintextNames)
frontendArgs.DirIV = confFile.IsFeatureFlagSet(cryptfs.FlagDirIV)
frontendArgs.EMENames = confFile.IsFeatureFlagSet(cryptfs.FlagEMENames)
frontendArgs.GCMIV128 = confFile.IsFeatureFlagSet(cryptfs.FlagGCMIV128)
2015-11-28 16:52:57 +01:00
}
// EMENames implies DirIV, both on the command line and in the config file.
if frontendArgs.EMENames {
frontendArgs.DirIV = true
}
// PlainTexnames disables both EMENames and DirIV
if frontendArgs.PlaintextNames {
frontendArgs.DirIV = false
frontendArgs.EMENames = false
}
jsonBytes, _ := json.MarshalIndent(frontendArgs, "", "\t")
cryptfs.Debug.Printf("frontendArgs: %s", string(jsonBytes))
2015-11-28 16:52:57 +01:00
finalFs := pathfs_frontend.NewFS(frontendArgs)
pathFsOpts := &pathfs.PathNodeFsOptions{ClientInodes: true}
pathFs := pathfs.NewPathNodeFs(finalFs, pathFsOpts)
fuseOpts := &nodefs.Options{
// These options are to be compatible with libfuse defaults,
// making benchmarking easier.
NegativeTimeout: time.Second,
AttrTimeout: time.Second,
EntryTimeout: time.Second,
}
conn := nodefs.NewFileSystemConnector(pathFs.Root(), fuseOpts)
var mOpts fuse.MountOptions
mOpts.AllowOther = false
// Set values shown in "df -T" and friends
// First column, "Filesystem"
mOpts.Options = append(mOpts.Options, "fsname="+args.cipherdir)
// Second column, "Type", will be shown as "fuse." + Name
2015-10-04 14:36:20 +02:00
mOpts.Name = "gocryptfs"
srv, err := fuse.NewServer(conn.RawFS(), args.mountpoint, &mOpts)
if err != nil {
fmt.Printf("Mount failed: %v", err)
os.Exit(ERREXIT_MOUNT)
}
srv.SetDebug(args.fusedebug)
// All FUSE file and directory create calls carry explicit permission
// information. We need an unrestricted umask to create the files and
// directories with the requested permissions.
syscall.Umask(0000)
return srv
}
func handleSigint(srv *fuse.Server, mountpoint string) {
ch := make(chan os.Signal, 1)
signal.Notify(ch, os.Interrupt)
signal.Notify(ch, syscall.SIGTERM)
go func() {
<-ch
err := srv.Unmount()
if err != nil {
fmt.Print(err)
cryptfs.Info.Printf("Trying lazy unmount")
cmd := exec.Command("fusermount", "-u", "-z", mountpoint)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Run()
}
os.Exit(1)
}()
}
2015-12-19 15:46:19 +01:00
// Escape sequences for terminal colors
var colorReset, colorGrey, colorRed, colorGreen string
func setupColors() {
if terminal.IsTerminal(int(os.Stdout.Fd())) {
colorReset = "\033[0m"
colorGrey = "\033[2m"
colorRed = "\033[31m"
colorGreen = "\033[32m"
}
}