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
|
package storage
import (
"errors"
"os"
"path/filepath"
"strings"
"gitlab.com/gitlab-org/gitaly/internal/git/repository"
)
// Locator allows to get info about location of the repository or storage at the local file system.
type Locator interface {
// GetRepoPath returns the full path of the repository referenced by an
// RPC Repository message. It verifies the path is an existing git directory.
// The errors returned are gRPC errors with relevant error codes and should
// be passed back to gRPC without further decoration.
GetRepoPath(repo repository.GitRepo) (string, error)
// GetPath returns the path of the repo passed as first argument. An error is
// returned when either the storage can't be found or the path includes
// constructs trying to perform directory traversal.
GetPath(repo repository.GitRepo) (string, error)
// GetStorageByName will return the path for the storage, which is fetched by
// its key. An error is return if it cannot be found.
GetStorageByName(storageName string) (string, error)
// GetObjectDirectoryPath returns the full path of the object directory in a
// repository referenced by an RPC Repository message. The errors returned are
// gRPC errors with relevant error codes and should be passed back to gRPC
// without further decoration.
GetObjectDirectoryPath(repo repository.GitRepo) (string, error)
// InfoAlternatesPath finds the fully qualified path for the alternates file.
InfoAlternatesPath(repo repository.GitRepo) (string, error)
}
var ErrRelativePathEscapesRoot = errors.New("relative path escapes root directory")
// ValidateRelativePath validates a relative path by joining it with rootDir and verifying the result
// is either rootDir or a path within rootDir. Returns clean relative path from rootDir to relativePath
// or an ErrRelativePathEscapesRoot if the resulting path is not contained within rootDir.
func ValidateRelativePath(rootDir, relativePath string) (string, error) {
absPath := filepath.Join(rootDir, relativePath)
if rootDir != absPath && !strings.HasPrefix(absPath, rootDir+string(os.PathSeparator)) {
return "", ErrRelativePathEscapesRoot
}
return filepath.Rel(rootDir, absPath)
}
// IsGitDirectory checks if the directory passed as first argument looks like
// a valid git directory.
func IsGitDirectory(dir string) bool {
if dir == "" {
return false
}
for _, element := range []string{"objects", "refs", "HEAD"} {
if _, err := os.Stat(filepath.Join(dir, element)); err != nil {
return false
}
}
// See: https://gitlab.com/gitlab-org/gitaly/issues/1339
//
// This is a workaround for Gitaly running on top of an NFS mount. There
// is a Linux NFS v4.0 client bug where opening the packed-refs file can
// either result in a stale file handle or stale data. This can happen if
// git gc runs for a long time while keeping open the packed-refs file.
// Running stat() on the file causes the kernel to revalidate the cached
// directory entry. We don't actually care if this file exists.
os.Stat(filepath.Join(dir, "packed-refs"))
return true
}
|
