-
Notifications
You must be signed in to change notification settings - Fork 933
Expand file tree
/
Copy pathbase_client_test.go
More file actions
347 lines (307 loc) · 12.2 KB
/
Copy pathbase_client_test.go
File metadata and controls
347 lines (307 loc) · 12.2 KB
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
package client
import (
"bytes"
"crypto/tls"
"io"
"net/http"
"net/http/httptest"
"path/filepath"
"strings"
"testing"
"github.com/fleetdm/fleet/v4/pkg/certificate"
"github.com/fleetdm/fleet/v4/server/fleet"
"github.com/stretchr/testify/require"
)
func TestUrlGeneration(t *testing.T) {
t.Run("without prefix", func(t *testing.T) {
bc, err := NewBaseClient("https://test.com", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
require.Equal(t, "https://test.com/test/path", bc.URL("test/path", "").String())
require.Equal(t, "https://test.com/test/path?raw=query", bc.URL("test/path", "raw=query").String())
})
t.Run("with prefix", func(t *testing.T) {
bc, err := NewBaseClient("https://test.com", true, "", "prefix/", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
require.Equal(t, "https://test.com/prefix/test/path", bc.URL("test/path", "").String())
require.Equal(t, "https://test.com/prefix/test/path?raw=query", bc.URL("test/path", "raw=query").String())
})
t.Run("with subpath in base URL", func(t *testing.T) {
bc, err := NewBaseClient("https://test.com/subpath", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
require.Equal(t, "https://test.com/subpath/api/fleet/orbit/enroll", bc.URL("/api/fleet/orbit/enroll", "").String())
require.Equal(t, "https://test.com/subpath/api/fleet/orbit/enroll?raw=query", bc.URL("/api/fleet/orbit/enroll", "raw=query").String())
})
t.Run("with subpath and trailing slash in base URL", func(t *testing.T) {
bc, err := NewBaseClient("https://test.com/subpath/", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
require.Equal(t, "https://test.com/subpath/api/fleet/orbit/enroll", bc.URL("/api/fleet/orbit/enroll", "").String())
})
t.Run("with subpath and path without leading slash", func(t *testing.T) {
bc, err := NewBaseClient("https://test.com/subpath", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
require.Equal(t, "https://test.com/subpath/test/path", bc.URL("test/path", "").String())
})
t.Run("with subpath in base URL and a prefix", func(t *testing.T) {
bc, err := NewBaseClient("https://test.com/subpath", true, "", "prefix/", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
require.Equal(t, "https://test.com/subpath/prefix/test/path", bc.URL("test/path", "").String())
require.Equal(t, "https://test.com/subpath/prefix/test/path?raw=query", bc.URL("test/path", "raw=query").String())
})
}
func TestParseResponseKnownErrors(t *testing.T) {
cases := []struct {
message string
code int
out error
}{
{"not found errors", http.StatusNotFound, &NotFoundErr{}},
{"unauthenticated errors", http.StatusUnauthorized, ErrUnauthenticated},
{"license errors", http.StatusPaymentRequired, ErrMissingLicense},
}
for _, c := range cases {
t.Run(c.message, func(t *testing.T) {
bc, err := NewBaseClient("https://test.com", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
response := &http.Response{
StatusCode: c.code,
Body: io.NopCloser(bytes.NewBufferString(`{"test": "ok"}`)),
}
err = bc.ParseResponse("GET", "", response, &struct{}{})
require.ErrorIs(t, err, c.out)
})
}
}
func TestParseResponseOK(t *testing.T) {
bc, err := NewBaseClient("https://test.com", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
response := &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewBufferString(`{"test": "ok"}`)),
}
var resDest struct{ Test string }
err = bc.ParseResponse("", "", response, &resDest)
require.NoError(t, err)
require.Equal(t, "ok", resDest.Test)
}
func TestParseResponseOKNoContent(t *testing.T) {
bc, err := NewBaseClient("https://test.com", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
response := &http.Response{
StatusCode: http.StatusNoContent,
Body: io.NopCloser(bytes.NewBufferString("")),
}
var resDest struct{ Err error }
err = bc.ParseResponse("", "", response, &resDest)
require.NoError(t, err)
require.Nil(t, resDest.Err)
}
func TestParseResponseGeneralErrors(t *testing.T) {
t.Run("general HTTP errors", func(t *testing.T) {
bc, err := NewBaseClient("https://test.com", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
response := &http.Response{
StatusCode: http.StatusBadRequest,
Body: io.NopCloser(bytes.NewBufferString(`{"test": "ok"}`)),
}
err = bc.ParseResponse("GET", "", response, &struct{}{})
require.Error(t, err)
})
t.Run("parse errors", func(t *testing.T) {
bc, err := NewBaseClient("https://test.com", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
response := &http.Response{
StatusCode: http.StatusBadRequest,
Body: io.NopCloser(bytes.NewBufferString(`invalid json`)),
}
err = bc.ParseResponse("GET", "", response, &struct{}{})
require.Error(t, err)
})
}
func TestNewBaseClient(t *testing.T) {
t.Run("invalid addresses are an error", func(t *testing.T) {
_, err := NewBaseClient("http://foo\x7f.com/", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.Error(t, err)
})
t.Run("http is only valid in development", func(t *testing.T) {
cases := []struct {
name string
address string
insecureSkipVerify bool
expectedErr error
}{
{"http non-local URL without insecureSkipVerify", "http://test.com", false, ErrInvalidScheme},
{"http non-local URL with insecureSkipVerify", "http://test.com", true, nil},
{"https", "https://test.com", false, nil},
{"http localhost with insecureSkipVerify", "http://localhost:8080", true, nil},
{"http localhost without insecureSkipVerify", "http://localhost:8080", false, nil},
{"http local ip with insecureSkipVerify", "http://127.0.0.1:8080", true, nil},
{"http local ip without insecureSkipVerify", "http://127.0.0.1:8080", false, nil},
}
for _, c := range cases {
_, err := NewBaseClient(c.address, c.insecureSkipVerify, "", "", nil, fleet.CapabilityMap{}, nil)
require.Equal(t, c.expectedErr, err, c.name)
}
})
}
func TestClientCapabilities(t *testing.T) {
cases := []struct {
name string
capabilities fleet.CapabilityMap
expected string
}{
{"no capabilities", fleet.CapabilityMap{}, ""},
{"one capability", fleet.CapabilityMap{fleet.Capability("test_capability"): {}}, "test_capability"},
{
"multiple capabilities",
fleet.CapabilityMap{
fleet.Capability("test_capability"): {},
fleet.Capability("test_capability_2"): {},
},
"test_capability,test_capability_2",
},
}
for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
bc, err := NewBaseClient("https://test.com", true, "", "", nil, c.capabilities, nil)
require.NoError(t, err)
var req http.Request
bc.SetClientCapabilitiesHeader(&req)
require.ElementsMatch(t, strings.Split(c.expected, ","), strings.Split(req.Header.Get(fleet.CapabilitiesHeader), ","))
})
}
}
func TestServerCapabilities(t *testing.T) {
// initial response has a single capability
response := &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewBufferString(`{}`)),
Header: http.Header{fleet.CapabilitiesHeader: []string{"test_capability"}},
}
bc, err := NewBaseClient("https://test.com", true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
testCapability := fleet.Capability("test_capability")
err = bc.ParseResponse("", "", response, &struct{}{})
require.NoError(t, err)
require.True(t, bc.GetServerCapabilities().Has(testCapability))
// later on, the server is downgraded and no longer has the capability
response = &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewBufferString(`{}`)),
Header: http.Header{},
}
err = bc.ParseResponse("", "", response, &struct{}{})
require.NoError(t, err)
require.Equal(t, fleet.CapabilityMap{}, bc.ServerCapabilities)
require.False(t, bc.GetServerCapabilities().Has(testCapability))
// after an upgrade, the server has many capabilities
response = &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewBufferString(`{}`)),
Header: http.Header{fleet.CapabilitiesHeader: []string{"test_capability,test_capability_2"}},
}
err = bc.ParseResponse("", "", response, &struct{}{})
require.NoError(t, err)
require.Equal(t, fleet.CapabilityMap{
testCapability: {},
fleet.Capability("test_capability_2"): {},
}, bc.ServerCapabilities)
require.True(t, bc.GetServerCapabilities().Has(testCapability))
require.True(t, bc.GetServerCapabilities().Has(fleet.Capability("test_capability")))
}
func TestFileResponseHandlePathTraversal(t *testing.T) {
t.Run("unix path traversal is stripped to base filename", func(t *testing.T) {
destDir := t.TempDir()
fr := &FileResponse{DestPath: destDir}
resp := &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(strings.NewReader("content")),
Header: http.Header{
"Content-Disposition": []string{`attachment;filename="../../../etc/cron.d/backdoor"`},
},
}
err := fr.Handle(resp)
require.NoError(t, err)
require.Equal(t, "backdoor", filepath.Base(fr.DestFilePath))
require.True(t, strings.HasPrefix(fr.DestFilePath, destDir+string(filepath.Separator)))
})
t.Run("normal filename is unchanged", func(t *testing.T) {
destDir := t.TempDir()
fr := &FileResponse{DestPath: destDir}
resp := &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(strings.NewReader("content")),
Header: http.Header{
"Content-Disposition": []string{`attachment;filename="installer.pkg"`},
},
}
err := fr.Handle(resp)
require.NoError(t, err)
require.Equal(t, "installer.pkg", filepath.Base(fr.DestFilePath))
require.True(t, strings.HasPrefix(fr.DestFilePath, destDir+string(filepath.Separator)))
})
t.Run("dot filename falls back to DestFile", func(t *testing.T) {
destDir := t.TempDir()
fr := &FileResponse{DestPath: destDir, DestFile: "fallback.txt"}
resp := &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(strings.NewReader("content")),
Header: http.Header{
"Content-Disposition": []string{`attachment;filename="."`},
},
}
err := fr.Handle(resp)
require.NoError(t, err)
require.Equal(t, "fallback.txt", filepath.Base(fr.DestFilePath))
require.True(t, strings.HasPrefix(fr.DestFilePath, destDir+string(filepath.Separator)))
})
t.Run("dotdot filename falls back to UUID", func(t *testing.T) {
destDir := t.TempDir()
fr := &FileResponse{DestPath: destDir}
resp := &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(strings.NewReader("content")),
Header: http.Header{
"Content-Disposition": []string{`attachment;filename=".."`},
},
}
err := fr.Handle(resp)
require.NoError(t, err)
require.True(t, strings.HasPrefix(fr.DestFilePath, destDir+string(filepath.Separator)))
})
}
func TestClientCertificateAuth(t *testing.T) {
httpRequestReceived := false
clientCAs, err := certificate.LoadPEM(filepath.Join("testdata", "client-ca.crt"))
require.NoError(t, err)
ts := httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
httpRequestReceived = true
}))
ts.TLS = &tls.Config{
MinVersion: tls.VersionTLS12,
ClientAuth: tls.RequireAndVerifyClientCert,
ClientCAs: clientCAs,
}
ts.StartTLS()
t.Cleanup(func() {
ts.Close()
})
// Try connecting without setting TLS client certificates.
bc, err := NewBaseClient(ts.URL, true, "", "", nil, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
request, err := http.NewRequest("GET", ts.URL, nil)
require.NoError(t, err)
_, err = bc.HTTP.Do(request)
require.Error(t, err)
require.False(t, httpRequestReceived)
// Now try connecting by setting the correct TLS client certificates.
clientCrt, err := certificate.LoadClientCertificateFromFiles(filepath.Join("testdata", "client.crt"), filepath.Join("testdata", "client.key"))
require.NoError(t, err)
require.NotNil(t, clientCrt)
bc, err = NewBaseClient(ts.URL, true, "", "", &clientCrt.Crt, fleet.CapabilityMap{}, nil)
require.NoError(t, err)
request, err = http.NewRequest("GET", ts.URL, nil)
require.NoError(t, err)
_, err = bc.HTTP.Do(request)
require.NoError(t, err)
require.True(t, httpRequestReceived)
}