From 9bcde0c09e96e17ed7092aa5fa5f6bfc89372a8d Mon Sep 17 00:00:00 2001
From: Sebastian Lackner
Date: Thu, 30 Nov 2017 20:53:38 +0100
Subject: fusefrontend: Improve documentation of mkdirWithIv and WriteDirIV

As requested in https://github.com/rfjakob/gocryptfs/pull/179
---
 internal/fusefrontend/fs_dir.go |  3 +++
 internal/nametransform/diriv.go | 13 ++++++++++---
 2 files changed, 13 insertions(+), 3 deletions(-)

(limited to 'internal')

diff --git a/internal/fusefrontend/fs_dir.go b/internal/fusefrontend/fs_dir.go
index 5cc269b..ae52412 100644
--- a/internal/fusefrontend/fs_dir.go
+++ b/internal/fusefrontend/fs_dir.go
@@ -24,6 +24,9 @@ import (
 
 const dsStoreName = ".DS_Store"
 
+// mkdirWithIv - create a new directory and corresponding diriv file. dirfd
+// should be a handle to the parent directory, cName is the name of the new
+// directory and mode specifies the access permissions to use.
 func (fs *FS) mkdirWithIv(dirfd *os.File, cName string, mode uint32) error {
 	// Between the creation of the directory and the creation of gocryptfs.diriv
 	// the directory is inconsistent. Take the lock to prevent other readers
diff --git a/internal/nametransform/diriv.go b/internal/nametransform/diriv.go
index f980a04..527ccce 100644
--- a/internal/nametransform/diriv.go
+++ b/internal/nametransform/diriv.go
@@ -3,6 +3,7 @@ package nametransform
 import (
 	"bytes"
 	"io"
+	"log"
 	"os"
 	"path/filepath"
 	"strings"
@@ -73,10 +74,16 @@ func fdReadDirIV(fd *os.File) (iv []byte, err error) {
 	return iv, nil
 }
 
-// WriteDirIV - create diriv file inside "dir" (absolute ciphertext path)
-// This function is exported because it is used from pathfs_frontend, main,
-// and also the automated tests.
+// WriteDirIV - create diriv file inside of the specified directory. If dirfd
+// is nil "dir" should be the absolute path to the directory. If dirfd != nil
+// "dir" should be a path (without slashes) relative to the directory
+// described by "dirfd". This function is exported because it is used from
+// pathfs_frontend, main, and also the automated tests.
 func WriteDirIV(dirfd *os.File, dir string) error {
+	// For relative paths we do not expect that "dir" contains slashes
+	if dirfd != nil && strings.Contains(dir, "/") {
+		log.Panicf("WriteDirIV: Relative path should not contain slashes: %v", dir)
+	}
 	iv := cryptocore.RandBytes(DirIVLen)
 	file := filepath.Join(dir, DirIVFilename)
 	// 0400 permissions: gocryptfs.diriv should never be modified after creation.
-- 
cgit v1.2.3