aboutsummaryrefslogtreecommitdiffstats
path: root/client/go/internal/util/fix_fs.go
blob: f7b5f767456710163013f8e84a5464105d16c8b2 (plain) (blame)
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
// Author: arnej

package util

import (
	"errors"
	"fmt"
	"os"
	"os/user"
	"strings"

	"github.com/vespa-engine/vespa/client/go/internal/admin/trace"
)

type FixSpec struct {
	UserId   int
	GroupId  int
	DirMode  os.FileMode
	FileMode os.FileMode
}

func NewFixSpec() FixSpec {
	return FixSpec{
		UserId:   -1,
		GroupId:  -1,
		DirMode:  0755,
		FileMode: 0644,
	}
}

func statNoSymlinks(path string) (info os.FileInfo, err error) {
	components := strings.Split(path, "/")
	var name string
	for idx, x := range components {
		if idx == 0 {
			name = x
			if x == "" {
				continue
			}
		} else {
			name = name + "/" + x
		}
		info, err = os.Lstat(name)
		if err != nil {
			return
		}
		if (info.Mode() & os.ModeSymlink) != 0 {
			return nil, fmt.Errorf("the path '%s' is a symlink, not allowed", name)
		}
		trace.SpamDebug("lstat", name, "=>", info.Mode(), err)
	}
	return info, err
}

// ensure directory exists with suitable permissions
func (spec *FixSpec) FixDir(dirName string) {
	info, err := statNoSymlinks(dirName)
	if errors.Is(err, os.ErrNotExist) {
		trace.Trace("mkdir: ", dirName)
		err = os.MkdirAll(dirName, spec.DirMode)
		if err != nil {
			spec.complainAndExit(err, dirName, spec.DirMode)
		}
		info, err = statNoSymlinks(dirName)
	}
	if err != nil {
		spec.complainAndExit(err, dirName, spec.DirMode)
	}
	if !info.IsDir() {
		err = fmt.Errorf("Not a directory: '%s'", dirName)
		spec.complainAndExit(err, dirName, spec.DirMode)
	}
	trace.SpamDebug("chown: ", dirName, spec.UserId, spec.GroupId)
	err = os.Chown(dirName, spec.UserId, spec.GroupId)
	if err != nil {
		spec.ensureWritableDir(dirName)
		return
	}
	trace.SpamDebug("chmod: ", dirName, spec.DirMode)
	err = os.Chmod(dirName, spec.DirMode)
	if err != nil {
		spec.ensureWritableDir(dirName)
	}
	trace.Debug("directory ok:", dirName)
}

// ensure file has suitable permissions if it exists
func (spec *FixSpec) FixFile(fileName string) {
	info, err := statNoSymlinks(fileName)
	if err != nil {
		if !errors.Is(err, os.ErrNotExist) {
			spec.complainAndExit(err, fileName, spec.FileMode)
		}
		return
	}
	if info.IsDir() {
		err = fmt.Errorf("Should not be a directory: '%s'", fileName)
		spec.complainAndExit(err, fileName, spec.FileMode)
	}
	trace.SpamDebug("chown: ", fileName, spec.UserId, spec.GroupId)
	err = os.Chown(fileName, spec.UserId, spec.GroupId)
	if err != nil {
		spec.ensureWritableFile(fileName)
		return
	}
	trace.SpamDebug("chmod: ", fileName, spec.FileMode)
	err = os.Chmod(fileName, spec.FileMode)
	if err != nil {
		spec.ensureWritableFile(fileName)
	}
}

func (spec *FixSpec) ensureWritableFile(fileName string) {
	f, err := os.OpenFile(fileName, os.O_APPEND|os.O_RDWR, spec.FileMode)
	if err == nil {
		f.Close()
		return
	}
	trace.Warning(err, "- will try to remove this file")
	err = os.Remove(fileName)
	if err != nil {
		trace.Warning("Could neither write to nor remove '" + fileName + "'")
		spec.complainAndExit(err, fileName, spec.FileMode)
	}
}

func (spec *FixSpec) ensureWritableDir(dirName string) {
	tmpFile, err := os.CreateTemp(dirName, "tmp.probe.*.tmp")
	if err != nil {
		trace.Warning("Could not create a file in directory '" + dirName + "'")
		spec.complainAndExit(err, dirName, spec.DirMode)
	}
	tmpFile.Close()
	err = os.Remove(tmpFile.Name())
	if err != nil {
		spec.complainAndExit(err, dirName, spec.DirMode)
	}
}

func (spec *FixSpec) complainAndExit(got error, fn string, wanted os.FileMode) {
	trace.Warning("problem:", got)
	currentUser, _ := user.Current()
	trace.Warning("Currently running as user:", currentUser.Username)
	trace.Warning("Wanted", fn, "to be owned by user id:", spec.UserId)
	trace.Warning("Wanted", fn, "to have group id:", spec.GroupId)
	trace.Warning("Wanted", fn, "to have permissions:", wanted)
	trace.Warning("current status of", fn, "is:")
	out, _ := BackTicksWithStderr.Run("stat", "--", fn)
	trace.Warning(out)
	trace.Warning("this is a fatal error!")
	JustExitWith(got)
}