1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
|
package main
import (
"bytes"
"log"
"log/syslog"
"math"
"os"
"os/exec"
"os/signal"
"path"
"path/filepath"
"runtime"
"runtime/debug"
"strings"
"syscall"
"time"
"golang.org/x/crypto/chacha20poly1305"
"github.com/hanwen/go-fuse/v2/fs"
"github.com/hanwen/go-fuse/v2/fuse"
"github.com/rfjakob/gocryptfs/v2/internal/configfile"
"github.com/rfjakob/gocryptfs/v2/internal/contentenc"
"github.com/rfjakob/gocryptfs/v2/internal/cryptocore"
"github.com/rfjakob/gocryptfs/v2/internal/ctlsocksrv"
"github.com/rfjakob/gocryptfs/v2/internal/exitcodes"
"github.com/rfjakob/gocryptfs/v2/internal/fusefrontend"
"github.com/rfjakob/gocryptfs/v2/internal/fusefrontend_reverse"
"github.com/rfjakob/gocryptfs/v2/internal/nametransform"
"github.com/rfjakob/gocryptfs/v2/internal/openfiletable"
"github.com/rfjakob/gocryptfs/v2/internal/tlog"
)
// AfterUnmount is called after the filesystem has been unmounted.
// This can be used for cleanup and printing statistics.
type AfterUnmounter interface {
AfterUnmount()
}
// doMount mounts an encrypted directory.
// Called from main.
func doMount(args *argContainer) {
// Check mountpoint
var err error
args.mountpoint, err = filepath.Abs(flagSet.Arg(1))
if err != nil {
tlog.Fatal.Printf("Invalid mountpoint: %v", err)
os.Exit(exitcodes.MountPoint)
}
// We cannot mount "/home/user/.cipher" at "/home/user" because the mount
// will hide ".cipher" also for us.
if args.cipherdir == args.mountpoint || strings.HasPrefix(args.cipherdir, args.mountpoint+"/") {
tlog.Fatal.Printf("Mountpoint %q would shadow cipherdir %q, this is not supported",
args.mountpoint, args.cipherdir)
os.Exit(exitcodes.MountPoint)
}
// Reverse-mounting "/foo" at "/foo/mnt" means we would be recursively
// encrypting ourselves.
if strings.HasPrefix(args.mountpoint, args.cipherdir+"/") {
tlog.Fatal.Printf("Mountpoint %q is contained in cipherdir %q, this is not supported",
args.mountpoint, args.cipherdir)
os.Exit(exitcodes.MountPoint)
}
if args.nonempty {
err = isDir(args.mountpoint)
} else if strings.HasPrefix(args.mountpoint, "/dev/fd/") {
// Magic fuse fd syntax, do nothing and let go-fuse figure it out.
//
// See https://github.com/libfuse/libfuse/commit/64e11073b9347fcf9c6d1eea143763ba9e946f70
// and `drop_privileges` in `man mount.fuse3` for background.
} else {
err = isEmptyDir(args.mountpoint)
// OSXFuse will create the mountpoint for us ( https://github.com/rfjakob/gocryptfs/issues/194 )
if runtime.GOOS == "darwin" && os.IsNotExist(err) {
tlog.Info.Printf("Mountpoint %q does not exist, but should be created by OSXFuse",
args.mountpoint)
err = nil
}
}
if err != nil {
tlog.Fatal.Printf("Invalid mountpoint: %v", err)
os.Exit(exitcodes.MountPoint)
}
// Open control socket early so we can error out before asking the user
// for the password
if args.ctlsock != "" {
// We must use an absolute path because we cd to / when daemonizing.
// This messes up the delete-on-close logic in the unix socket object.
args.ctlsock, _ = filepath.Abs(args.ctlsock)
args._ctlsockFd, err = ctlsocksrv.Listen(args.ctlsock)
if err != nil {
tlog.Fatal.Printf("ctlsock: %v", err)
os.Exit(exitcodes.CtlSock)
}
// Close also deletes the socket file
defer func() {
err = args._ctlsockFd.Close()
if err != nil {
tlog.Warn.Printf("ctlsock close: %v", err)
}
}()
}
// Initialize gocryptfs (read config file, ask for password, ...)
fs, wipeKeys := initFuseFrontend(args)
// Try to wipe secret keys from memory after unmount
defer wipeKeys()
// Initialize go-fuse FUSE server
srv := initGoFuse(fs, args)
if x, ok := fs.(AfterUnmounter); ok {
defer x.AfterUnmount()
}
tlog.Info.Println(tlog.ColorGreen + "Filesystem mounted and ready." + tlog.ColorReset)
// We have been forked into the background, as evidenced by the set
// "notifypid".
// Do what daemons should do: https://man7.org/linux/man-pages/man7/daemon.7.html
if args.notifypid > 0 {
// Chdir to the root directory so we don't block unmounting the CWD
os.Chdir("/")
// Disconnect from the controlling terminal by creating a new session.
// This prevents us from getting SIGINT when the user presses Ctrl-C
// to exit a running script that has called gocryptfs, or SIGHUP when
// xfce4-terminal closes itself ( https://github.com/rfjakob/gocryptfs/issues/660 ).
_, err = syscall.Setsid()
if err != nil {
tlog.Warn.Printf("Setsid: %v", err)
}
// Switch to syslog
if !args.nosyslog {
// Switch all of our logs and the generic logger to syslog
tlog.Info.SwitchToSyslog(syslog.LOG_USER | syslog.LOG_INFO)
tlog.Debug.SwitchToSyslog(syslog.LOG_USER | syslog.LOG_DEBUG)
tlog.Warn.SwitchToSyslog(syslog.LOG_USER | syslog.LOG_WARNING)
tlog.Fatal.SwitchToSyslog(syslog.LOG_USER | syslog.LOG_CRIT)
tlog.SwitchLoggerToSyslog()
// Daemons should redirect stdin, stdout and stderr
redirectStdFds()
}
// Send SIGUSR1 to our parent
sendUsr1(args.notifypid)
}
// Increase the open file limit to 4096. This is not essential, so do it after
// we have switched to syslog and don't bother the user with warnings.
setOpenFileLimit()
// Wait for SIGINT in the background and unmount ourselves if we get it.
// This prevents a dangling "Transport endpoint is not connected"
// mountpoint if the user hits CTRL-C.
handleSigint(srv, args.mountpoint)
// Return memory that was allocated for scrypt (64M by default!) and other
// stuff that is no longer needed to the OS
debug.FreeOSMemory()
// Set up autounmount, if requested.
if args.idle > 0 && !args.reverse {
// Not being in reverse mode means we always have a forward file system.
fwdFs := fs.(*fusefrontend.RootNode)
go idleMonitor(args.idle, fwdFs, srv, args.mountpoint)
}
// Wait for unmount.
srv.Wait()
}
// Based on the EncFS idle monitor:
// https://github.com/vgough/encfs/blob/1974b417af189a41ffae4c6feb011d2a0498e437/encfs/main.cpp#L851
// idleMonitor is a function to be run as a thread that checks for
// filesystem idleness and unmounts if we've been idle for long enough.
const checksDuringTimeoutPeriod = 4
func idleMonitor(idleTimeout time.Duration, fs *fusefrontend.RootNode, srv *fuse.Server, mountpoint string) {
// sleepNs is the sleep time between checks, in nanoseconds.
sleepNs := contentenc.MinUint64(
uint64(idleTimeout/checksDuringTimeoutPeriod),
uint64(2*time.Minute))
timeoutCycles := int(math.Ceil(float64(idleTimeout) / float64(sleepNs)))
idleCount := 0
idleTime := func() time.Duration {
return time.Duration(sleepNs * uint64(idleCount))
}
for {
// Atomically check whether the flag is 0 and reset it to 1 if so.
isIdle := !fs.IsIdle.CompareAndSwap(false, true)
// Any form of current or recent access resets the idle counter.
openFileCount := openfiletable.CountOpenFiles()
if !isIdle || openFileCount > 0 {
idleCount = 0
} else {
idleCount++
}
tlog.Debug.Printf(
"idleMonitor: idle for %v (idleCount = %d, isIdle = %t, open = %d)",
idleTime(), idleCount, isIdle, openFileCount)
if idleCount > 0 && idleCount%timeoutCycles == 0 {
tlog.Info.Printf("idleMonitor: filesystem idle; unmounting: %s", mountpoint)
err := srv.Unmount()
if err != nil {
// We get "Device or resource busy" when a process has its
// working directory on the mount. Log the event at Info level
// so the user finds out why their filesystem does not get
// unmounted.
tlog.Info.Printf("idleMonitor: unmount failed: %v. Resetting idle time.", err)
idleCount = 0
}
}
time.Sleep(time.Duration(sleepNs))
}
}
// setOpenFileLimit tries to increase the open file limit to 4096 (the default hard
// limit on Linux).
func setOpenFileLimit() {
var lim syscall.Rlimit
err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &lim)
if err != nil {
tlog.Warn.Printf("Getting RLIMIT_NOFILE failed: %v", err)
return
}
if lim.Cur >= 4096 {
return
}
lim.Cur = 4096
err = syscall.Setrlimit(syscall.RLIMIT_NOFILE, &lim)
if err != nil {
tlog.Warn.Printf("Setting RLIMIT_NOFILE to %+v failed: %v", lim, err)
// %+v output: "{Cur:4097 Max:4096}" ^
}
}
// initFuseFrontend - initialize gocryptfs/internal/fusefrontend
// Calls os.Exit on errors
func initFuseFrontend(args *argContainer) (rootNode fs.InodeEmbedder, wipeKeys func()) {
var err error
var confFile *configfile.ConfFile
// Get the masterkey from the command line if it was specified
masterkey := handleArgsMasterkey(args)
// Otherwise, load masterkey from config file (normal operation).
// Prompts the user for the password.
if masterkey == nil {
masterkey, confFile, err = loadConfig(args)
if err != nil {
if args._ctlsockFd != nil {
// Close the socket file (which also deletes it)
args._ctlsockFd.Close()
}
exitcodes.Exit(err)
}
}
// Reconciliate CLI and config file arguments into a fusefrontend.Args struct
// that is passed to the filesystem implementation
cryptoBackend := cryptocore.BackendGoGCM
IVBits := contentenc.DefaultIVBits
if args.openssl {
cryptoBackend = cryptocore.BackendOpenSSL
}
if args.aessiv {
cryptoBackend = cryptocore.BackendAESSIV
}
if args.xchacha {
if args.openssl {
cryptoBackend = cryptocore.BackendXChaCha20Poly1305OpenSSL
} else {
cryptoBackend = cryptocore.BackendXChaCha20Poly1305
}
IVBits = chacha20poly1305.NonceSizeX * 8
}
// forceOwner implies allow_other, as documented.
// Set this early, so args.allow_other can be relied on below this point.
if args._forceOwner != nil {
args.allow_other = true
}
frontendArgs := fusefrontend.Args{
Cipherdir: args.cipherdir,
PlaintextNames: args.plaintextnames,
LongNames: args.longnames,
ConfigCustom: args._configCustom,
NoPrealloc: args.noprealloc,
ForceOwner: args._forceOwner,
Exclude: args.exclude,
ExcludeWildcard: args.excludeWildcard,
ExcludeFrom: args.excludeFrom,
Suid: args.suid,
KernelCache: args.kernel_cache,
SharedStorage: args.sharedstorage,
OneFileSystem: args.one_file_system,
DeterministicNames: args.deterministic_names,
}
// 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(configfile.FlagPlaintextNames)
frontendArgs.DeterministicNames = !confFile.IsFeatureFlagSet(configfile.FlagDirIV)
// Things that don't have to be in frontendArgs are only in args
args.longnamemax = confFile.LongNameMax
args.raw64 = confFile.IsFeatureFlagSet(configfile.FlagRaw64)
args.hkdf = confFile.IsFeatureFlagSet(configfile.FlagHKDF)
// Note: this will always return the non-openssl variant
cryptoBackend, err = confFile.ContentEncryption()
if err != nil {
tlog.Fatal.Printf("%v", err)
os.Exit(exitcodes.DeprecatedFS)
}
IVBits = cryptoBackend.NonceSize * 8
if cryptoBackend != cryptocore.BackendAESSIV && args.reverse {
tlog.Fatal.Printf("AES-SIV is required by reverse mode, but not enabled in the config file")
os.Exit(exitcodes.Usage)
}
// Upgrade to OpenSSL variant if requested
if args.openssl {
switch cryptoBackend {
case cryptocore.BackendGoGCM:
cryptoBackend = cryptocore.BackendOpenSSL
case cryptocore.BackendXChaCha20Poly1305:
cryptoBackend = cryptocore.BackendXChaCha20Poly1305OpenSSL
}
}
}
// If allow_other is set and we run as root, create files as the accessing
// user.
// Except when -force_owner is set, because in this case the user may
// not have write permissions. And the point of -force_owner is to map uids,
// so we want the files on the backing dir to get the uid the gocryptfs process
// is running as.
if args.allow_other && os.Getuid() == 0 && args._forceOwner == nil {
frontendArgs.PreserveOwner = true
}
// Init crypto backend
cCore := cryptocore.New(masterkey, cryptoBackend, IVBits, args.hkdf)
cEnc := contentenc.New(cCore, contentenc.DefaultBS)
nameTransform := nametransform.New(cCore.EMECipher, frontendArgs.LongNames, args.longnamemax,
args.raw64, []string(args.badname), frontendArgs.DeterministicNames)
// After the crypto backend is initialized,
// we can purge the master key from memory.
for i := range masterkey {
masterkey[i] = 0
}
masterkey = nil
// Spawn fusefrontend
tlog.Debug.Printf("frontendArgs: %s", tlog.JSONDump(frontendArgs))
if args.reverse {
if cryptoBackend != cryptocore.BackendAESSIV {
log.Panic("reverse mode must use AES-SIV, everything else is insecure")
}
rootNode = fusefrontend_reverse.NewRootNode(frontendArgs, cEnc, nameTransform)
} else {
rootNode = fusefrontend.NewRootNode(frontendArgs, cEnc, nameTransform)
}
// We have opened the socket early so that we cannot fail here after
// asking the user for the password
if args._ctlsockFd != nil {
go ctlsocksrv.Serve(args._ctlsockFd, rootNode.(ctlsocksrv.Interface))
}
return rootNode, func() { cCore.Wipe() }
}
type RootInoer interface {
RootIno() uint64
}
// initGoFuse calls into go-fuse to mount `rootNode` on `args.mountpoint`.
// The mountpoint is ready to use when the functions returns.
// On error, it calls os.Exit and does not return.
func initGoFuse(rootNode fs.InodeEmbedder, args *argContainer) *fuse.Server {
var fuseOpts *fs.Options
sec := time.Second
if args.sharedstorage {
// sharedstorage mode sets all cache timeouts to zero so changes to the
// backing shared storage show up immediately.
// Hard links are disabled by using automatically incrementing
// inode numbers provided by go-fuse.
fuseOpts = &fs.Options{
FirstAutomaticIno: 1000,
}
} else {
fuseOpts = &fs.Options{
// These options are to be compatible with libfuse defaults,
// making benchmarking easier.
NegativeTimeout: &sec,
AttrTimeout: &sec,
EntryTimeout: &sec,
}
}
fuseOpts.NullPermissions = true
// The inode number for the root node must be manually set on mount
// https://github.com/hanwen/go-fuse/issues/399
fuseOpts.RootStableAttr = &fs.StableAttr{Ino: rootNode.(RootInoer).RootIno()}
// Enable go-fuse warnings
fuseOpts.Logger = log.New(os.Stderr, "go-fuse: ", log.Lmicroseconds)
fuseOpts.MountOptions = fuse.MountOptions{
// Writes and reads are usually capped at 128kiB on Linux through
// the FUSE_MAX_PAGES_PER_REQ kernel constant in fuse_i.h. Our
// sync.Pool buffer pools are sized acc. to the default. Users may set
// the kernel constant higher, and Synology NAS kernels are known to
// have it >128kiB. We cannot handle more than 128kiB, so we tell
// the kernel to limit the size explicitly.
MaxWrite: fuse.MAX_KERNEL_WRITE,
Debug: args.fusedebug,
// The kernel usually submits multiple read requests in parallel,
// which means we serve them in any order. Out-of-order reads are
// expensive on some backing network filesystems
// ( https://github.com/rfjakob/gocryptfs/issues/92 ).
//
// Setting SyncRead disables FUSE_CAP_ASYNC_READ. This makes the kernel
// do everything in-order without parallelism.
SyncRead: args.serialize_reads,
// Attempt to directly call mount(2) before trying fusermount. This means we
// can do without fusermount if running as root.
DirectMount: true,
}
mOpts := &fuseOpts.MountOptions
opts := make(map[string]string)
if args.allow_other {
tlog.Info.Printf(tlog.ColorYellow + "The option \"-allow_other\" is set. Make sure the file " +
"permissions protect your data from unwanted access." + tlog.ColorReset)
mOpts.AllowOther = true
// Make the kernel check the file permissions for us
opts["default_permissions"] = ""
}
if args.acl {
mOpts.EnableAcl = true
}
// fusermount from libfuse 3.x removed the "nonempty" option and exits
// with an error if it sees it. Only add it to the options on libfuse 2.x.
if args.nonempty && haveFusermount2() {
opts["nonempty"] = ""
}
// Set values shown in "df -T" and friends
// First column, "Filesystem"
fsname := args.cipherdir
if args.fsname != "" {
fsname = args.fsname
}
fsname2 := strings.Replace(fsname, ",", "_", -1)
if fsname2 != fsname {
tlog.Warn.Printf("Warning: %q will be displayed as %q in \"df -T\"", fsname, fsname2)
fsname = fsname2
}
mOpts.FsName = fsname
// Second column, "Type", will be shown as "fuse." + Name
mOpts.Name = "gocryptfs"
if args.reverse {
mOpts.Name += "-reverse"
}
// Add a volume name if running osxfuse. Otherwise the Finder will show it as
// something like "osxfuse Volume 0 (gocryptfs)".
if runtime.GOOS == "darwin" {
opts["volname"] = strings.Replace(path.Base(args.mountpoint), ",", "_", -1)
}
// The kernel enforces read-only operation, we just have to pass "ro".
// Reverse mounts are always read-only.
if args.ro || args.reverse {
opts["ro"] = ""
} else if args.rw {
opts["rw"] = ""
}
// If both "nosuid" & "suid", "nodev" & "dev", etc were passed, the safer
// option wins.
if args.nosuid {
opts["nosuid"] = ""
} else if args.suid {
opts["suid"] = ""
}
if args.nodev {
opts["nodev"] = ""
} else if args.dev {
opts["dev"] = ""
}
if args.noexec {
opts["noexec"] = ""
} else if args.exec {
opts["exec"] = ""
}
if args.context != "" {
opts["context"] = args.context
}
// Add additional mount options (if any) after the stock ones, so the user has
// a chance to override them.
if args.ko != "" {
parts := strings.Split(args.ko, ",")
tlog.Debug.Printf("Adding -ko mount options: %v", parts)
for _, part := range parts {
kv := strings.SplitN(part, "=", 2)
if len(kv) == 2 {
opts[kv[0]] = kv[1]
} else {
opts[kv[0]] = ""
}
}
}
for k, v := range opts {
if v == "" {
mOpts.Options = append(mOpts.Options, k)
} else {
mOpts.Options = append(mOpts.Options, k+"="+v)
}
}
srv, err := fs.Mount(args.mountpoint, rootNode, fuseOpts)
if err != nil {
tlog.Fatal.Printf("fs.Mount failed: %s", strings.TrimSpace(err.Error()))
if runtime.GOOS == "darwin" {
tlog.Info.Printf("Maybe you should run: /Library/Filesystems/osxfuse.fs/Contents/Resources/load_osxfuse")
}
os.Exit(exitcodes.FuseNewServer)
}
// 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
}
// haveFusermount2 finds out if the "fusermount" binary is from libfuse 2.x.
func haveFusermount2() bool {
path, err := exec.LookPath("fusermount")
if err != nil {
path = "/bin/fusermount"
}
cmd := exec.Command(path, "-V")
var out bytes.Buffer
cmd.Stdout = &out
err = cmd.Run()
if err != nil {
tlog.Warn.Printf("warning: haveFusermount2: %v", err)
return false
}
// libfuse 2: fusermount version: 2.9.9
// libfuse 3: fusermount3 version: 3.9.0
v := out.String()
return strings.HasPrefix(v, "fusermount version")
}
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
unmount(srv, mountpoint)
os.Exit(exitcodes.SigInt)
}()
}
// unmount() calls srv.Unmount(), and if that fails, calls "fusermount -u -z"
// (lazy unmount).
func unmount(srv *fuse.Server, mountpoint string) {
err := srv.Unmount()
if err != nil {
tlog.Warn.Printf("unmount: srv.Unmount returned %v", err)
if runtime.GOOS == "linux" {
// MacOSX does not support lazy unmount
tlog.Info.Printf("Trying lazy unmount")
cmd := exec.Command("fusermount", "-u", "-z", mountpoint)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Run()
}
}
}
|