summaryrefslogtreecommitdiff
path: root/internal/namespace/preflight_test.go
blob: 49790f2e298cec4887e0e5d64ee417095cb82679 (plain)
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
package namespace

import (
	"os"
	"testing"
	"time"
)

type mockFileInfo struct {
	name string
}

func (m *mockFileInfo) Name() string       { return m.name }
func (m *mockFileInfo) Size() int64        { return 0 }
func (m *mockFileInfo) Mode() os.FileMode  { return 0 }
func (m *mockFileInfo) ModTime() time.Time { return time.Now() }
func (m *mockFileInfo) IsDir() bool        { return false }
func (m *mockFileInfo) Sys() any           { return nil }

type mockFS struct {
	files   map[string][]byte
	canOpen map[string]bool
}

func (m *mockFS) Stat(name string) (os.FileInfo, error) {
	if _, ok := m.files[name]; ok {
		return &mockFileInfo{name: name}, nil
	}
	return nil, os.ErrNotExist
}

func (m *mockFS) MkdirAll(path string, perm os.FileMode) error     { return nil }
func (m *mockFS) CreateTemp(dir, pattern string) (*os.File, error) { return nil, nil }
func (m *mockFS) MkdirTemp(dir, pattern string) (string, error)    { return "", nil }
func (m *mockFS) Remove(name string) error                         { return nil }

func (m *mockFS) ReadFile(name string) ([]byte, error) {
	if data, ok := m.files[name]; ok {
		return data, nil
	}
	return nil, os.ErrNotExist
}

func (m *mockFS) Open(name string) (*os.File, error) {
	if m.canOpen[name] {
		f, _ := os.CreateTemp("", "mock-file")
		return f, nil
	}
	return nil, os.ErrPermission
}

func TestCheckSystemRequirements(t *testing.T) {
	tests := []struct {
		name    string
		files   map[string][]byte
		canOpen map[string]bool
		wantErr bool
	}{
		{
			name: "all requirements met",
			files: map[string][]byte{
				"/dev/net/tun": {},
			},
			canOpen: map[string]bool{
				"/dev/net/tun": true,
			},
			wantErr: false,
		},
		{
			name:    "tun device missing",
			files:   map[string][]byte{},
			canOpen: map[string]bool{},
			wantErr: true,
		},
		{
			name: "tun device not accessible",
			files: map[string][]byte{
				"/dev/net/tun": {},
			},
			canOpen: map[string]bool{
				"/dev/net/tun": false,
			},
			wantErr: true,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			fs := &mockFS{files: tt.files, canOpen: tt.canOpen}
			p := NewPreflight(fs)
			err := p.CheckSystemRequirements()
			if (err != nil) != tt.wantErr {
				t.Errorf("CheckSystemRequirements() error = %v, wantErr %v", err, tt.wantErr)
			}
		})
	}
}

func TestRunHealthCheck(t *testing.T) {
	tests := []struct {
		name     string
		files    map[string][]byte
		canOpen  map[string]bool
		uid      int
		username string
		wantPass map[string]bool
	}{
		{
			name: "healthy non-root user on Debian",
			files: map[string][]byte{
				"/dev/net/tun": {},
				"/proc/sys/kernel/unprivileged_userns_clone": []byte("1"),
				"/proc/sys/user/max_user_namespaces":         []byte("1024"),
				"/etc/subuid":                                []byte("james:100000:60000"),
			},
			canOpen: map[string]bool{
				"/dev/net/tun": true,
			},
			uid:      1000,
			username: "james",
			wantPass: map[string]bool{
				"TUN Device Accessibility":                     true,
				"Unprivileged User Namespaces (Debian/Ubuntu)": true,
				"User Namespace Limit":                         true,
				"SubUID/SubGID Mappings":                       true,
			},
		},
		{
			name: "healthy root user",
			files: map[string][]byte{
				"/dev/net/tun": {},
			},
			canOpen: map[string]bool{
				"/dev/net/tun": true,
			},
			uid:      0,
			username: "root",
			wantPass: map[string]bool{
				"TUN Device Accessibility": true,
				"SubUID/SubGID Mappings":   true, // Should be bypassed
			},
		},
		{
			name: "broken config",
			files: map[string][]byte{
				"/dev/net/tun": {},
				"/proc/sys/kernel/unprivileged_userns_clone": []byte("0"),
				"/proc/sys/user/max_user_namespaces":         []byte("0"),
				"/etc/subuid":                                []byte("someone-else:100000:60000"),
			},
			canOpen: map[string]bool{
				"/dev/net/tun": true,
			},
			uid:      1000,
			username: "james",
			wantPass: map[string]bool{
				"TUN Device Accessibility":                     true,
				"Unprivileged User Namespaces (Debian/Ubuntu)": false,
				"User Namespace Limit":                         false,
				"SubUID/SubGID Mappings":                       false,
			},
		},
		{
			name: "non-debian healthy",
			files: map[string][]byte{
				"/dev/net/tun":                       {},
				"/proc/sys/user/max_user_namespaces": []byte("1024"),
				"/etc/subuid":                        []byte("james:100000:60000"),
			},
			canOpen: map[string]bool{
				"/dev/net/tun": true,
			},
			uid:      1000,
			username: "james",
			wantPass: map[string]bool{
				"TUN Device Accessibility":                     true,
				"Unprivileged User Namespaces (Debian/Ubuntu)": true, // Not applicable is considered passed
				"User Namespace Limit":                         true,
				"SubUID/SubGID Mappings":                       true,
			},
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			fs := &mockFS{files: tt.files, canOpen: tt.canOpen}
			p := NewPreflight(fs)
			results := p.RunHealthCheck(tt.uid, tt.username)

			for _, res := range results {
				if pass, ok := tt.wantPass[res.Name]; ok {
					if res.Passed != pass {
						t.Errorf("Requirement %s: passed = %v, want %v (Msg: %s)", res.Name, res.Passed, pass, res.Message)
					}
				}
			}
		})
	}
}