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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
// Copyright (c) 2019, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package security
import (
"fmt"
"os"
"testing"
"github.com/sylabs/singularity/v4/e2e/internal/e2e"
"github.com/sylabs/singularity/v4/e2e/internal/testhelper"
"github.com/sylabs/singularity/v4/internal/pkg/buildcfg"
"github.com/sylabs/singularity/v4/internal/pkg/test/tool/require"
"github.com/sylabs/singularity/v4/pkg/util/capabilities"
)
type ctx struct {
env e2e.TestEnv
}
// testSecurityUnpriv tests the security flag fuctionality for singularity exec without elevated privileges
func (c ctx) testSecurityUnpriv(t *testing.T) {
tests := []struct {
name string
image string
argv []string
opts []string
preFn func(*testing.T)
expectOp e2e.SingularityCmdResultOp
expectExit int
}{
// target UID/GID
{
name: "Set_uid",
argv: []string{"id", "-u"},
opts: []string{"--security", "uid:99"},
expectExit: 255,
// TODO: add expect stderr for "uid security feature requires root privileges"
// pending issue: https://github.com/sylabs/singularity/issues/4280
},
{
name: "Set_gid",
argv: []string{"id", "-g"},
opts: []string{"--security", "gid:99"},
expectExit: 255,
},
// seccomp from json file
{
name: "SecComp_BlackList",
argv: []string{"mkdir", "/tmp/foo"},
opts: []string{"--security", "seccomp:./security/testdata/seccomp-profile.json"},
preFn: require.Seccomp,
expectExit: 159, // process should be killed with SIGSYS (128+31)
},
{
name: "SecComp_true",
argv: []string{"true"},
opts: []string{"--security", "seccomp:./security/testdata/seccomp-profile.json"},
preFn: require.Seccomp,
expectExit: 0,
},
// capabilities
{
name: "capabilities_keep_true",
argv: []string{"grep", "^CapEff:", "/proc/self/status"},
opts: []string{"--keep-privs"},
expectExit: 255, // singularity errors out, --keep-privs needs root
},
{
// we start without any capabilities, the
// expected set is empty.
name: "capabilities_keep-false",
argv: []string{"grep", "^CapEff:", "/proc/self/status"},
expectOp: e2e.ExpectOutput(e2e.RegexMatch, `CapEff:\s+0+\n`),
},
{
// this one is tricky: we are asking to drop
// cap_net_raw, but since we start without any
// capabilities the expected set is empty.
name: "capabilities_drop",
argv: []string{"grep", "^Cap.*:", "/proc/self/status"},
opts: []string{"--drop-caps", "CAP_NET_RAW"},
expectOp: e2e.ExpectOutput(e2e.RegexMatch, `CapEff:\s+0+\n`),
},
}
e2e.EnsureImage(t, c.env)
for _, tt := range tests {
optArgs := []string{}
optArgs = append(optArgs, tt.opts...)
optArgs = append(optArgs, c.env.ImagePath)
optArgs = append(optArgs, tt.argv...)
c.env.RunSingularity(
t,
e2e.AsSubtest(tt.name),
e2e.WithProfile(e2e.UserProfile),
e2e.WithCommand("exec"),
e2e.WithArgs(optArgs...),
e2e.PreRun(tt.preFn),
e2e.ExpectExit(tt.expectExit, tt.expectOp),
)
}
}
// testSecurityPriv tests security flag fuctionality for singularity exec with elevated privileges
func (c ctx) testSecurityPriv(t *testing.T) {
var caps uint64
var err error
// Get the capability set for root on this system
// e.g. "CapEff: 000001ffffffffff"
e2e.Privileged(func(_ *testing.T) {
caps, err = capabilities.GetProcessEffective()
})(t)
if err != nil {
t.Fatalf("Could not get CapEff: %v", err)
}
fullCap := fmt.Sprintf("CapEff:\t%0.16x", caps)
// We are going to drop CAP_NET_RAW which should result in the CapEff
// string ending dfff
dropCap := fmt.Sprintf("CapEff:\t%0.16x", caps-uint64(1<<capabilities.Map["CAP_NET_RAW"].Value))
tests := []struct {
name string
argv []string
opts []string
preFn func(*testing.T)
expectOp e2e.SingularityCmdResultOp
expectExit int
}{
// target UID/GID
{
name: "Set_uid",
argv: []string{"id", "-u"},
opts: []string{"--security", "uid:99"},
expectOp: e2e.ExpectOutput(e2e.ExactMatch, "99"),
expectExit: 0,
},
{
name: "Set_gid",
argv: []string{"id", "-g"},
opts: []string{"--security", "gid:99"},
expectOp: e2e.ExpectOutput(e2e.ExactMatch, "99"),
expectExit: 0,
},
// seccomp from json file
{
name: "SecComp_BlackList",
argv: []string{"mkdir", "/tmp/foo"},
opts: []string{"--security", "seccomp:./testdata/seccomp-profile.json"},
preFn: require.Seccomp,
expectExit: 159, // process should be killed with SIGSYS (128+31)
},
{
name: "SecComp_true",
argv: []string{"true"},
opts: []string{"--security", "seccomp:./testdata/seccomp-profile.json"},
preFn: require.Seccomp,
expectExit: 0,
},
// capabilities
{
name: "capabilities_keep",
argv: []string{"grep", "^CapEff:", "/proc/self/status"},
opts: []string{"--keep-privs"},
expectOp: e2e.ExpectOutput(e2e.ContainMatch, fullCap),
},
{
name: "capabilities_drop",
argv: []string{"grep", "^CapEff:", "/proc/self/status"},
opts: []string{"--drop-caps", "CAP_NET_RAW"},
expectOp: e2e.ExpectOutput(e2e.ContainMatch, dropCap),
},
}
e2e.EnsureImage(t, c.env)
for _, tt := range tests {
optArgs := []string{}
optArgs = append(optArgs, tt.opts...)
optArgs = append(optArgs, c.env.ImagePath)
optArgs = append(optArgs, tt.argv...)
c.env.RunSingularity(
t,
e2e.AsSubtest(tt.name),
e2e.WithProfile(e2e.RootProfile),
e2e.WithCommand("exec"),
e2e.WithArgs(optArgs...),
e2e.PreRun(tt.preFn),
e2e.ExpectExit(tt.expectExit, tt.expectOp),
)
}
}
// testSecurityConfOwnership tests checks on config files ownerships
func (c ctx) testSecurityConfOwnership(t *testing.T) {
e2e.EnsureImage(t, c.env)
configFile := buildcfg.SINGULARITY_CONF_FILE
c.env.RunSingularity(
t,
e2e.AsSubtest("non root config"),
e2e.WithProfile(e2e.UserProfile),
e2e.PreRun(func(t *testing.T) {
e2e.Privileged(func(t *testing.T) {
// Change file ownership (do not try this at home)
err := os.Chown(configFile, 1001, 0)
if err != nil {
t.Fatalf("failed to change owner for: %s: %s", configFile, err)
}
})(t)
}),
e2e.PostRun(func(t *testing.T) {
e2e.Privileged(func(t *testing.T) {
// return file ownership to normal
err := os.Chown(configFile, 0, 0)
if err != nil {
t.Fatalf("failed to change config file owner to root: %s: %s", configFile, err)
}
})(t)
}),
e2e.WithCommand("exec"),
e2e.WithArgs([]string{c.env.ImagePath, "/bin/true"}...),
e2e.ExpectExit(255),
)
}
// E2ETests is the main func to trigger the test suite
func E2ETests(env e2e.TestEnv) testhelper.Tests {
c := ctx{
env: env,
}
np := testhelper.NoParallel
return testhelper.Tests{
"singularitySecurityUnpriv": c.testSecurityUnpriv,
"singularitySecurityPriv": c.testSecurityPriv,
"testSecurityConfOwnership": np(c.testSecurityConfOwnership),
// OCI-Mode
"ociCapabilities": c.ociCapabilities,
}
}
|
