[Issue #220] - dcRUSTy - Implement utility function wrapper for iouti…

…l.ReadFile which skips following symlink

directory_hook.go

@@ -1,8 +1,8 @@
 package main
 
 import (
-	"io/ioutil"
 	"talisman/gitrepo"
+	"talisman/utility"
 
 	log "github.com/Sirupsen/logrus"
 
@@ -35,5 +35,5 @@ func (p *DirectoryHook) GetFilesFromDirectory(globPattern string) []gitrepo.Addi
 
 func ReadFile(filepath string) ([]byte, error) {
 	log.Debugf("reading file %s", filepath)
-	return ioutil.ReadFile(filepath)
+	return utility.SafeReadFile(filepath)
 }

git_testing/git_testing.go

@@ -23,7 +23,7 @@ func Init(gitRoot string) *GitTesting {
 	os.MkdirAll(gitRoot, 0777)
 	testingRepo := &GitTesting{gitRoot}
 	testingRepo.ExecCommand("git", "init", ".")
-	gitConfigFileObject, _ := ioutil.TempFile("/tmp", "gitConfigForTalismanTests")
+	gitConfigFileObject, _ := ioutil.TempFile(os.TempDir(), "gitConfigForTalismanTests")
 	gitConfigFile = gitConfigFileObject.Name()
 	testingRepo.CreateFileWithContents(gitConfigFile, `[user]
 	email = talisman-test-user@example.com
@@ -144,7 +144,6 @@ func (git *GitTesting) GetBlobDetails(fileName string) string {
 	return object_hash_and_filename
 }
 
-
 //ExecCommand executes a command with given arguments in the git repo directory
 func (git *GitTesting) ExecCommand(commandName string, args ...string) string {
 	var output []byte

gitrepo/gitrepo.go

@@ -3,13 +3,13 @@ package gitrepo
 import (
 	"fmt"
 	log "github.com/Sirupsen/logrus"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"path"
 	"path/filepath"
 	"regexp"
 	"strings"
+	"talisman/utility"
 )
 
 //FilePath represents the absolute path of an added file
@@ -161,7 +161,7 @@ func NewScannerAddition(filePath string, commits []string, content []byte) Addit
 func (repo GitRepo) ReadRepoFile(fileName string) ([]byte, error) {
 	path := filepath.Join(repo.root, fileName)
 	log.Debugf("reading file %s", path)
-	return ioutil.ReadFile(path)
+	return utility.SafeReadFile(path)
 }
 
 //ReadRepoFileOrNothing returns the contents of the supplied relative filename by locating it in the git repo.

utility/sha_256_hasher.go

@@ -3,14 +3,13 @@ package utility
 import (
 	"crypto/sha256"
 	"encoding/hex"
-	"io/ioutil"
 )
 
 type SHA256Hasher interface {
 	CollectiveSHA256Hash(paths []string) string
 }
 
-type DefaultSHA256Hasher struct {}
+type DefaultSHA256Hasher struct{}
 
 //CollectiveSHA256Hash return collective sha256 hash of the passed paths
 func (DefaultSHA256Hasher) CollectiveSHA256Hash(paths []string) string {
@@ -20,7 +19,7 @@ func (DefaultSHA256Hasher) CollectiveSHA256Hash(paths []string) string {
 		concatBytes := hashByte(&sbyte)
 		nameByte := []byte(path)
 		nameHash := hashByte(&nameByte)
-		fileBytes, _ := ioutil.ReadFile(path)
+		fileBytes, _ := SafeReadFile(path)
 		fileHash := hashByte(&fileBytes)
 		finHash = concatBytes + fileHash + nameHash
 	}

utility/utility.go

@@ -2,6 +2,7 @@ package utility
 
 import (
 	"fmt"
+	log "github.com/Sirupsen/logrus"
 	"io"
 	"io/ioutil"
 	"os"
@@ -89,3 +90,19 @@ func Dir(src string, dst string) error {
 	}
 	return nil
 }
+
+func IsFileSymlink(path string) bool {
+	fileMetadata, err := os.Lstat(path)
+	if err != nil {
+		return false
+	}
+	return fileMetadata.Mode()&os.ModeSymlink != 0
+}
+
+func SafeReadFile(path string) ([]byte, error) {
+	if IsFileSymlink(path) {
+		log.Debug("Symlink was detected! Not following symlink ", path)
+		return []byte{}, nil
+	}
+	return ioutil.ReadFile(path)
+}

utility/utility_test.go

@@ -0,0 +1,39 @@
+package utility
+
+import (
+	"github.com/stretchr/testify/assert"
+	"io/ioutil"
+	"os"
+	"testing"
+)
+
+func TestShouldReadNormalFileCorrectly(t *testing.T) {
+	tempFile, _ := ioutil.TempFile(os.TempDir(), "somefile")
+	dataToBeWrittenInFile := []byte{0, 1, 2, 3}
+	tempFile.Write(dataToBeWrittenInFile)
+	tempFile.Close()
+
+	readDataFromFileUsingIoutilDotReadFile, _ := ioutil.ReadFile(tempFile.Name())
+	readDataFromFileUsingSafeFileRead, _ := SafeReadFile(tempFile.Name())
+	os.Remove(tempFile.Name())
+
+	assert.Equal(t, readDataFromFileUsingIoutilDotReadFile, dataToBeWrittenInFile)
+	assert.Equal(t, readDataFromFileUsingSafeFileRead, dataToBeWrittenInFile)
+}
+
+func TestShouldNotReadSymbolicLinkTargetFile(t *testing.T) {
+	tempFile, _ := ioutil.TempFile(os.TempDir(), "somefile")
+	dataToBeWrittenInFile := []byte{0, 1, 2, 3}
+	tempFile.Write(dataToBeWrittenInFile)
+	tempFile.Close()
+	symlinkFileName := tempFile.Name() + "symlink"
+	os.Symlink(tempFile.Name(), symlinkFileName)
+
+	readDataFromSymlinkUsingIoutilDotReadFile, _ := ioutil.ReadFile(symlinkFileName)
+	readDataFromSymlinkUsingSafeFileRead, _ := SafeReadFile(symlinkFileName)
+	os.Remove(symlinkFileName)
+	os.Remove(tempFile.Name())
+
+	assert.Equal(t, readDataFromSymlinkUsingIoutilDotReadFile, dataToBeWrittenInFile)
+	assert.Equal(t, []byte{}, readDataFromSymlinkUsingSafeFileRead)
+}