d500f1e65a37e13739529f80e10a2e52a6dcf181
[arvados.git] / services / keep-web / s3.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package main
6
7 import (
8         "crypto/hmac"
9         "crypto/sha256"
10         "encoding/xml"
11         "errors"
12         "fmt"
13         "hash"
14         "io"
15         "net/http"
16         "net/url"
17         "os"
18         "path/filepath"
19         "regexp"
20         "sort"
21         "strconv"
22         "strings"
23         "time"
24
25         "git.arvados.org/arvados.git/sdk/go/arvados"
26         "git.arvados.org/arvados.git/sdk/go/ctxlog"
27         "github.com/AdRoll/goamz/s3"
28 )
29
30 const (
31         s3MaxKeys       = 1000
32         s3SignAlgorithm = "AWS4-HMAC-SHA256"
33         s3MaxClockSkew  = 5 * time.Minute
34 )
35
36 func hmacstring(msg string, key []byte) []byte {
37         h := hmac.New(sha256.New, key)
38         io.WriteString(h, msg)
39         return h.Sum(nil)
40 }
41
42 func hashdigest(h hash.Hash, payload string) string {
43         io.WriteString(h, payload)
44         return fmt.Sprintf("%x", h.Sum(nil))
45 }
46
47 // Signing key for given secret key and request attrs.
48 func s3signatureKey(key, datestamp, regionName, serviceName string) []byte {
49         return hmacstring("aws4_request",
50                 hmacstring(serviceName,
51                         hmacstring(regionName,
52                                 hmacstring(datestamp, []byte("AWS4"+key)))))
53 }
54
55 // Canonical query string for S3 V4 signature: sorted keys, spaces
56 // escaped as %20 instead of +, keyvalues joined with &.
57 func s3querystring(u *url.URL) string {
58         keys := make([]string, 0, len(u.Query()))
59         values := make(map[string]string, len(u.Query()))
60         for k, vs := range u.Query() {
61                 k = strings.Replace(url.QueryEscape(k), "+", "%20", -1)
62                 keys = append(keys, k)
63                 for _, v := range vs {
64                         v = strings.Replace(url.QueryEscape(v), "+", "%20", -1)
65                         if values[k] != "" {
66                                 values[k] += "&"
67                         }
68                         values[k] += k + "=" + v
69                 }
70         }
71         sort.Strings(keys)
72         for i, k := range keys {
73                 keys[i] = values[k]
74         }
75         return strings.Join(keys, "&")
76 }
77
78 var reMultipleSlashChars = regexp.MustCompile(`//+`)
79
80 func s3stringToSign(alg, scope, signedHeaders string, r *http.Request) (string, error) {
81         timefmt, timestr := "20060102T150405Z", r.Header.Get("X-Amz-Date")
82         if timestr == "" {
83                 timefmt, timestr = time.RFC1123, r.Header.Get("Date")
84         }
85         t, err := time.Parse(timefmt, timestr)
86         if err != nil {
87                 return "", fmt.Errorf("invalid timestamp %q: %s", timestr, err)
88         }
89         if skew := time.Now().Sub(t); skew < -s3MaxClockSkew || skew > s3MaxClockSkew {
90                 return "", errors.New("exceeded max clock skew")
91         }
92
93         var canonicalHeaders string
94         for _, h := range strings.Split(signedHeaders, ";") {
95                 if h == "host" {
96                         canonicalHeaders += h + ":" + r.Host + "\n"
97                 } else {
98                         canonicalHeaders += h + ":" + r.Header.Get(h) + "\n"
99                 }
100         }
101
102         normalizedURL := *r.URL
103         normalizedURL.RawPath = ""
104         normalizedURL.Path = reMultipleSlashChars.ReplaceAllString(normalizedURL.Path, "/")
105         canonicalRequest := fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n%s", r.Method, normalizedURL.EscapedPath(), s3querystring(r.URL), canonicalHeaders, signedHeaders, r.Header.Get("X-Amz-Content-Sha256"))
106         ctxlog.FromContext(r.Context()).Debugf("s3stringToSign: canonicalRequest %s", canonicalRequest)
107         return fmt.Sprintf("%s\n%s\n%s\n%s", alg, r.Header.Get("X-Amz-Date"), scope, hashdigest(sha256.New(), canonicalRequest)), nil
108 }
109
110 func s3signature(secretKey, scope, signedHeaders, stringToSign string) (string, error) {
111         // scope is {datestamp}/{region}/{service}/aws4_request
112         drs := strings.Split(scope, "/")
113         if len(drs) != 4 {
114                 return "", fmt.Errorf("invalid scope %q", scope)
115         }
116         key := s3signatureKey(secretKey, drs[0], drs[1], drs[2])
117         return hashdigest(hmac.New(sha256.New, key), stringToSign), nil
118 }
119
120 var v2tokenUnderscore = regexp.MustCompile(`^v2_[a-z0-9]{5}-gj3su-[a-z0-9]{15}_`)
121
122 func unescapeKey(key string) string {
123         if v2tokenUnderscore.MatchString(key) {
124                 // Entire Arvados token, with "/" replaced by "_" to
125                 // avoid colliding with the Authorization header
126                 // format.
127                 return strings.Replace(key, "_", "/", -1)
128         } else if s, err := url.PathUnescape(key); err == nil {
129                 return s
130         } else {
131                 return key
132         }
133 }
134
135 // checks3signature verifies the given S3 V4 signature and returns the
136 // Arvados token that corresponds to the given accessKey. An error is
137 // returned if accessKey is not a valid token UUID or the signature
138 // does not match.
139 func (h *handler) checks3signature(r *http.Request) (string, error) {
140         var key, scope, signedHeaders, signature string
141         authstring := strings.TrimPrefix(r.Header.Get("Authorization"), s3SignAlgorithm+" ")
142         for _, cmpt := range strings.Split(authstring, ",") {
143                 cmpt = strings.TrimSpace(cmpt)
144                 split := strings.SplitN(cmpt, "=", 2)
145                 switch {
146                 case len(split) != 2:
147                         // (?) ignore
148                 case split[0] == "Credential":
149                         keyandscope := strings.SplitN(split[1], "/", 2)
150                         if len(keyandscope) == 2 {
151                                 key, scope = keyandscope[0], keyandscope[1]
152                         }
153                 case split[0] == "SignedHeaders":
154                         signedHeaders = split[1]
155                 case split[0] == "Signature":
156                         signature = split[1]
157                 }
158         }
159
160         client := (&arvados.Client{
161                 APIHost:  h.Config.cluster.Services.Controller.ExternalURL.Host,
162                 Insecure: h.Config.cluster.TLS.Insecure,
163         }).WithRequestID(r.Header.Get("X-Request-Id"))
164         var aca arvados.APIClientAuthorization
165         var secret string
166         var err error
167         if len(key) == 27 && key[5:12] == "-gj3su-" {
168                 // Access key is the UUID of an Arvados token, secret
169                 // key is the secret part.
170                 ctx := arvados.ContextWithAuthorization(r.Context(), "Bearer "+h.Config.cluster.SystemRootToken)
171                 err = client.RequestAndDecodeContext(ctx, &aca, "GET", "arvados/v1/api_client_authorizations/"+key, nil, nil)
172                 secret = aca.APIToken
173         } else {
174                 // Access key and secret key are both an entire
175                 // Arvados token or OIDC access token.
176                 ctx := arvados.ContextWithAuthorization(r.Context(), "Bearer "+unescapeKey(key))
177                 err = client.RequestAndDecodeContext(ctx, &aca, "GET", "arvados/v1/api_client_authorizations/current", nil, nil)
178                 secret = key
179         }
180         if err != nil {
181                 ctxlog.FromContext(r.Context()).WithError(err).WithField("UUID", key).Info("token lookup failed")
182                 return "", errors.New("invalid access key")
183         }
184         stringToSign, err := s3stringToSign(s3SignAlgorithm, scope, signedHeaders, r)
185         if err != nil {
186                 return "", err
187         }
188         expect, err := s3signature(secret, scope, signedHeaders, stringToSign)
189         if err != nil {
190                 return "", err
191         } else if expect != signature {
192                 return "", fmt.Errorf("signature does not match (scope %q signedHeaders %q stringToSign %q)", scope, signedHeaders, stringToSign)
193         }
194         return aca.TokenV2(), nil
195 }
196
197 func s3ErrorResponse(w http.ResponseWriter, s3code string, message string, resource string, code int) {
198         w.Header().Set("Content-Type", "application/xml")
199         w.Header().Set("X-Content-Type-Options", "nosniff")
200         w.WriteHeader(code)
201         var errstruct struct {
202                 Code      string
203                 Message   string
204                 Resource  string
205                 RequestId string
206         }
207         errstruct.Code = s3code
208         errstruct.Message = message
209         errstruct.Resource = resource
210         errstruct.RequestId = ""
211         enc := xml.NewEncoder(w)
212         fmt.Fprint(w, xml.Header)
213         enc.EncodeElement(errstruct, xml.StartElement{Name: xml.Name{Local: "Error"}})
214 }
215
216 var NoSuchKey = "NoSuchKey"
217 var NoSuchBucket = "NoSuchBucket"
218 var InvalidArgument = "InvalidArgument"
219 var InternalError = "InternalError"
220 var UnauthorizedAccess = "UnauthorizedAccess"
221 var InvalidRequest = "InvalidRequest"
222 var SignatureDoesNotMatch = "SignatureDoesNotMatch"
223
224 // serveS3 handles r and returns true if r is a request from an S3
225 // client, otherwise it returns false.
226 func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool {
227         var token string
228         if auth := r.Header.Get("Authorization"); strings.HasPrefix(auth, "AWS ") {
229                 split := strings.SplitN(auth[4:], ":", 2)
230                 if len(split) < 2 {
231                         s3ErrorResponse(w, InvalidRequest, "malformed Authorization header", r.URL.Path, http.StatusUnauthorized)
232                         return true
233                 }
234                 token = unescapeKey(split[0])
235         } else if strings.HasPrefix(auth, s3SignAlgorithm+" ") {
236                 t, err := h.checks3signature(r)
237                 if err != nil {
238                         s3ErrorResponse(w, SignatureDoesNotMatch, "signature verification failed: "+err.Error(), r.URL.Path, http.StatusForbidden)
239                         return true
240                 }
241                 token = t
242         } else {
243                 return false
244         }
245
246         var err error
247         var fs arvados.CustomFileSystem
248         if r.Method == http.MethodGet || r.Method == http.MethodHead {
249                 // Use a single session (cached FileSystem) across
250                 // multiple read requests.
251                 fs, err = h.Config.Cache.GetSession(token)
252                 if err != nil {
253                         s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusInternalServerError)
254                         return true
255                 }
256         } else {
257                 // Create a FileSystem for this request, to avoid
258                 // exposing incomplete write operations to concurrent
259                 // requests.
260                 _, kc, client, release, err := h.getClients(r.Header.Get("X-Request-Id"), token)
261                 if err != nil {
262                         s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusInternalServerError)
263                         return true
264                 }
265                 defer release()
266                 fs = client.SiteFileSystem(kc)
267                 fs.ForwardSlashNameSubstitution(h.Config.cluster.Collections.ForwardSlashNameSubstitution)
268         }
269
270         var objectNameGiven bool
271         var bucketName string
272         fspath := "/by_id"
273         if id := parseCollectionIDFromDNSName(r.Host); id != "" {
274                 fspath += "/" + id
275                 bucketName = id
276                 objectNameGiven = strings.Count(strings.TrimSuffix(r.URL.Path, "/"), "/") > 0
277         } else {
278                 bucketName = strings.SplitN(strings.TrimPrefix(r.URL.Path, "/"), "/", 2)[0]
279                 objectNameGiven = strings.Count(strings.TrimSuffix(r.URL.Path, "/"), "/") > 1
280         }
281         fspath += reMultipleSlashChars.ReplaceAllString(r.URL.Path, "/")
282
283         switch {
284         case r.Method == http.MethodGet && !objectNameGiven:
285                 // Path is "/{uuid}" or "/{uuid}/", has no object name
286                 if _, ok := r.URL.Query()["versioning"]; ok {
287                         // GetBucketVersioning
288                         w.Header().Set("Content-Type", "application/xml")
289                         io.WriteString(w, xml.Header)
290                         fmt.Fprintln(w, `<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"/>`)
291                 } else {
292                         // ListObjects
293                         h.s3list(bucketName, w, r, fs)
294                 }
295                 return true
296         case r.Method == http.MethodGet || r.Method == http.MethodHead:
297                 fi, err := fs.Stat(fspath)
298                 if r.Method == "HEAD" && !objectNameGiven {
299                         // HeadBucket
300                         if err == nil && fi.IsDir() {
301                                 w.WriteHeader(http.StatusOK)
302                         } else if os.IsNotExist(err) {
303                                 s3ErrorResponse(w, NoSuchBucket, "The specified bucket does not exist.", r.URL.Path, http.StatusNotFound)
304                         } else {
305                                 s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusBadGateway)
306                         }
307                         return true
308                 }
309                 if err == nil && fi.IsDir() && objectNameGiven && strings.HasSuffix(fspath, "/") && h.Config.cluster.Collections.S3FolderObjects {
310                         w.Header().Set("Content-Type", "application/x-directory")
311                         w.WriteHeader(http.StatusOK)
312                         return true
313                 }
314                 if os.IsNotExist(err) ||
315                         (err != nil && err.Error() == "not a directory") ||
316                         (fi != nil && fi.IsDir()) {
317                         s3ErrorResponse(w, NoSuchKey, "The specified key does not exist.", r.URL.Path, http.StatusNotFound)
318                         return true
319                 }
320                 // shallow copy r, and change URL path
321                 r := *r
322                 r.URL.Path = fspath
323                 http.FileServer(fs).ServeHTTP(w, &r)
324                 return true
325         case r.Method == http.MethodPut:
326                 if !objectNameGiven {
327                         s3ErrorResponse(w, InvalidArgument, "Missing object name in PUT request.", r.URL.Path, http.StatusBadRequest)
328                         return true
329                 }
330                 var objectIsDir bool
331                 if strings.HasSuffix(fspath, "/") {
332                         if !h.Config.cluster.Collections.S3FolderObjects {
333                                 s3ErrorResponse(w, InvalidArgument, "invalid object name: trailing slash", r.URL.Path, http.StatusBadRequest)
334                                 return true
335                         }
336                         n, err := r.Body.Read(make([]byte, 1))
337                         if err != nil && err != io.EOF {
338                                 s3ErrorResponse(w, InternalError, fmt.Sprintf("error reading request body: %s", err), r.URL.Path, http.StatusInternalServerError)
339                                 return true
340                         } else if n > 0 {
341                                 s3ErrorResponse(w, InvalidArgument, "cannot create object with trailing '/' char unless content is empty", r.URL.Path, http.StatusBadRequest)
342                                 return true
343                         } else if strings.SplitN(r.Header.Get("Content-Type"), ";", 2)[0] != "application/x-directory" {
344                                 s3ErrorResponse(w, InvalidArgument, "cannot create object with trailing '/' char unless Content-Type is 'application/x-directory'", r.URL.Path, http.StatusBadRequest)
345                                 return true
346                         }
347                         // Given PUT "foo/bar/", we'll use "foo/bar/."
348                         // in the "ensure parents exist" block below,
349                         // and then we'll be done.
350                         fspath += "."
351                         objectIsDir = true
352                 }
353                 fi, err := fs.Stat(fspath)
354                 if err != nil && err.Error() == "not a directory" {
355                         // requested foo/bar, but foo is a file
356                         s3ErrorResponse(w, InvalidArgument, "object name conflicts with existing object", r.URL.Path, http.StatusBadRequest)
357                         return true
358                 }
359                 if strings.HasSuffix(r.URL.Path, "/") && err == nil && !fi.IsDir() {
360                         // requested foo/bar/, but foo/bar is a file
361                         s3ErrorResponse(w, InvalidArgument, "object name conflicts with existing object", r.URL.Path, http.StatusBadRequest)
362                         return true
363                 }
364                 // create missing parent/intermediate directories, if any
365                 for i, c := range fspath {
366                         if i > 0 && c == '/' {
367                                 dir := fspath[:i]
368                                 if strings.HasSuffix(dir, "/") {
369                                         err = errors.New("invalid object name (consecutive '/' chars)")
370                                         s3ErrorResponse(w, InvalidArgument, err.Error(), r.URL.Path, http.StatusBadRequest)
371                                         return true
372                                 }
373                                 err = fs.Mkdir(dir, 0755)
374                                 if err == arvados.ErrInvalidArgument {
375                                         // Cannot create a directory
376                                         // here.
377                                         err = fmt.Errorf("mkdir %q failed: %w", dir, err)
378                                         s3ErrorResponse(w, InvalidArgument, err.Error(), r.URL.Path, http.StatusBadRequest)
379                                         return true
380                                 } else if err != nil && !os.IsExist(err) {
381                                         err = fmt.Errorf("mkdir %q failed: %w", dir, err)
382                                         s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusInternalServerError)
383                                         return true
384                                 }
385                         }
386                 }
387                 if !objectIsDir {
388                         f, err := fs.OpenFile(fspath, os.O_WRONLY|os.O_TRUNC|os.O_CREATE, 0644)
389                         if os.IsNotExist(err) {
390                                 f, err = fs.OpenFile(fspath, os.O_WRONLY|os.O_TRUNC|os.O_CREATE, 0644)
391                         }
392                         if err != nil {
393                                 err = fmt.Errorf("open %q failed: %w", r.URL.Path, err)
394                                 s3ErrorResponse(w, InvalidArgument, err.Error(), r.URL.Path, http.StatusBadRequest)
395                                 return true
396                         }
397                         defer f.Close()
398                         _, err = io.Copy(f, r.Body)
399                         if err != nil {
400                                 err = fmt.Errorf("write to %q failed: %w", r.URL.Path, err)
401                                 s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusBadGateway)
402                                 return true
403                         }
404                         err = f.Close()
405                         if err != nil {
406                                 err = fmt.Errorf("write to %q failed: close: %w", r.URL.Path, err)
407                                 s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusBadGateway)
408                                 return true
409                         }
410                 }
411                 err = fs.Sync()
412                 if err != nil {
413                         err = fmt.Errorf("sync failed: %w", err)
414                         s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusInternalServerError)
415                         return true
416                 }
417                 // Ensure a subsequent read operation will see the changes.
418                 h.Config.Cache.ResetSession(token)
419                 w.WriteHeader(http.StatusOK)
420                 return true
421         case r.Method == http.MethodDelete:
422                 if !objectNameGiven || r.URL.Path == "/" {
423                         s3ErrorResponse(w, InvalidArgument, "missing object name in DELETE request", r.URL.Path, http.StatusBadRequest)
424                         return true
425                 }
426                 if strings.HasSuffix(fspath, "/") {
427                         fspath = strings.TrimSuffix(fspath, "/")
428                         fi, err := fs.Stat(fspath)
429                         if os.IsNotExist(err) {
430                                 w.WriteHeader(http.StatusNoContent)
431                                 return true
432                         } else if err != nil {
433                                 s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusInternalServerError)
434                                 return true
435                         } else if !fi.IsDir() {
436                                 // if "foo" exists and is a file, then
437                                 // "foo/" doesn't exist, so we say
438                                 // delete was successful.
439                                 w.WriteHeader(http.StatusNoContent)
440                                 return true
441                         }
442                 } else if fi, err := fs.Stat(fspath); err == nil && fi.IsDir() {
443                         // if "foo" is a dir, it is visible via S3
444                         // only as "foo/", not "foo" -- so we leave
445                         // the dir alone and return 204 to indicate
446                         // that "foo" does not exist.
447                         w.WriteHeader(http.StatusNoContent)
448                         return true
449                 }
450                 err = fs.Remove(fspath)
451                 if os.IsNotExist(err) {
452                         w.WriteHeader(http.StatusNoContent)
453                         return true
454                 }
455                 if err != nil {
456                         err = fmt.Errorf("rm failed: %w", err)
457                         s3ErrorResponse(w, InvalidArgument, err.Error(), r.URL.Path, http.StatusBadRequest)
458                         return true
459                 }
460                 err = fs.Sync()
461                 if err != nil {
462                         err = fmt.Errorf("sync failed: %w", err)
463                         s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusInternalServerError)
464                         return true
465                 }
466                 // Ensure a subsequent read operation will see the changes.
467                 h.Config.Cache.ResetSession(token)
468                 w.WriteHeader(http.StatusNoContent)
469                 return true
470         default:
471                 s3ErrorResponse(w, InvalidRequest, "method not allowed", r.URL.Path, http.StatusMethodNotAllowed)
472                 return true
473         }
474 }
475
476 // Call fn on the given path (directory) and its contents, in
477 // lexicographic order.
478 //
479 // If isRoot==true and path is not a directory, return nil.
480 //
481 // If fn returns filepath.SkipDir when called on a directory, don't
482 // descend into that directory.
483 func walkFS(fs arvados.CustomFileSystem, path string, isRoot bool, fn func(path string, fi os.FileInfo) error) error {
484         if isRoot {
485                 fi, err := fs.Stat(path)
486                 if os.IsNotExist(err) || (err == nil && !fi.IsDir()) {
487                         return nil
488                 } else if err != nil {
489                         return err
490                 }
491                 err = fn(path, fi)
492                 if err == filepath.SkipDir {
493                         return nil
494                 } else if err != nil {
495                         return err
496                 }
497         }
498         f, err := fs.Open(path)
499         if os.IsNotExist(err) && isRoot {
500                 return nil
501         } else if err != nil {
502                 return fmt.Errorf("open %q: %w", path, err)
503         }
504         defer f.Close()
505         if path == "/" {
506                 path = ""
507         }
508         fis, err := f.Readdir(-1)
509         if err != nil {
510                 return err
511         }
512         sort.Slice(fis, func(i, j int) bool { return fis[i].Name() < fis[j].Name() })
513         for _, fi := range fis {
514                 err = fn(path+"/"+fi.Name(), fi)
515                 if err == filepath.SkipDir {
516                         continue
517                 } else if err != nil {
518                         return err
519                 }
520                 if fi.IsDir() {
521                         err = walkFS(fs, path+"/"+fi.Name(), false, fn)
522                         if err != nil {
523                                 return err
524                         }
525                 }
526         }
527         return nil
528 }
529
530 var errDone = errors.New("done")
531
532 func (h *handler) s3list(bucket string, w http.ResponseWriter, r *http.Request, fs arvados.CustomFileSystem) {
533         var params struct {
534                 delimiter string
535                 marker    string
536                 maxKeys   int
537                 prefix    string
538         }
539         params.delimiter = r.FormValue("delimiter")
540         params.marker = r.FormValue("marker")
541         if mk, _ := strconv.ParseInt(r.FormValue("max-keys"), 10, 64); mk > 0 && mk < s3MaxKeys {
542                 params.maxKeys = int(mk)
543         } else {
544                 params.maxKeys = s3MaxKeys
545         }
546         params.prefix = r.FormValue("prefix")
547
548         bucketdir := "by_id/" + bucket
549         // walkpath is the directory (relative to bucketdir) we need
550         // to walk: the innermost directory that is guaranteed to
551         // contain all paths that have the requested prefix. Examples:
552         // prefix "foo/bar"  => walkpath "foo"
553         // prefix "foo/bar/" => walkpath "foo/bar"
554         // prefix "foo"      => walkpath ""
555         // prefix ""         => walkpath ""
556         walkpath := params.prefix
557         if cut := strings.LastIndex(walkpath, "/"); cut >= 0 {
558                 walkpath = walkpath[:cut]
559         } else {
560                 walkpath = ""
561         }
562
563         type commonPrefix struct {
564                 Prefix string
565         }
566         type listResp struct {
567                 XMLName string `xml:"http://s3.amazonaws.com/doc/2006-03-01/ ListBucketResult"`
568                 s3.ListResp
569                 // s3.ListResp marshals an empty tag when
570                 // CommonPrefixes is nil, which confuses some clients.
571                 // Fix by using this nested struct instead.
572                 CommonPrefixes []commonPrefix
573                 // Similarly, we need omitempty here, because an empty
574                 // tag confuses some clients (e.g.,
575                 // github.com/aws/aws-sdk-net never terminates its
576                 // paging loop).
577                 NextMarker string `xml:"NextMarker,omitempty"`
578                 // ListObjectsV2 has a KeyCount response field.
579                 KeyCount int
580         }
581         resp := listResp{
582                 ListResp: s3.ListResp{
583                         Name:      bucket,
584                         Prefix:    params.prefix,
585                         Delimiter: params.delimiter,
586                         Marker:    params.marker,
587                         MaxKeys:   params.maxKeys,
588                 },
589         }
590         commonPrefixes := map[string]bool{}
591         err := walkFS(fs, strings.TrimSuffix(bucketdir+"/"+walkpath, "/"), true, func(path string, fi os.FileInfo) error {
592                 if path == bucketdir {
593                         return nil
594                 }
595                 path = path[len(bucketdir)+1:]
596                 filesize := fi.Size()
597                 if fi.IsDir() {
598                         path += "/"
599                         filesize = 0
600                 }
601                 if len(path) <= len(params.prefix) {
602                         if path > params.prefix[:len(path)] {
603                                 // with prefix "foobar", walking "fooz" means we're done
604                                 return errDone
605                         }
606                         if path < params.prefix[:len(path)] {
607                                 // with prefix "foobar", walking "foobag" is pointless
608                                 return filepath.SkipDir
609                         }
610                         if fi.IsDir() && !strings.HasPrefix(params.prefix+"/", path) {
611                                 // with prefix "foo/bar", walking "fo"
612                                 // is pointless (but walking "foo" or
613                                 // "foo/bar" is necessary)
614                                 return filepath.SkipDir
615                         }
616                         if len(path) < len(params.prefix) {
617                                 // can't skip anything, and this entry
618                                 // isn't in the results, so just
619                                 // continue descent
620                                 return nil
621                         }
622                 } else {
623                         if path[:len(params.prefix)] > params.prefix {
624                                 // with prefix "foobar", nothing we
625                                 // see after "foozzz" is relevant
626                                 return errDone
627                         }
628                 }
629                 if path < params.marker || path < params.prefix {
630                         return nil
631                 }
632                 if fi.IsDir() && !h.Config.cluster.Collections.S3FolderObjects {
633                         // Note we don't add anything to
634                         // commonPrefixes here even if delimiter is
635                         // "/". We descend into the directory, and
636                         // return a commonPrefix only if we end up
637                         // finding a regular file inside it.
638                         return nil
639                 }
640                 if params.delimiter != "" {
641                         idx := strings.Index(path[len(params.prefix):], params.delimiter)
642                         if idx >= 0 {
643                                 // with prefix "foobar" and delimiter
644                                 // "z", when we hit "foobar/baz", we
645                                 // add "/baz" to commonPrefixes and
646                                 // stop descending.
647                                 commonPrefixes[path[:len(params.prefix)+idx+1]] = true
648                                 return filepath.SkipDir
649                         }
650                 }
651                 if len(resp.Contents)+len(commonPrefixes) >= params.maxKeys {
652                         resp.IsTruncated = true
653                         if params.delimiter != "" {
654                                 resp.NextMarker = path
655                         }
656                         return errDone
657                 }
658                 resp.Contents = append(resp.Contents, s3.Key{
659                         Key:          path,
660                         LastModified: fi.ModTime().UTC().Format("2006-01-02T15:04:05.999") + "Z",
661                         Size:         filesize,
662                 })
663                 return nil
664         })
665         if err != nil && err != errDone {
666                 http.Error(w, err.Error(), http.StatusInternalServerError)
667                 return
668         }
669         if params.delimiter != "" {
670                 resp.CommonPrefixes = make([]commonPrefix, 0, len(commonPrefixes))
671                 for prefix := range commonPrefixes {
672                         resp.CommonPrefixes = append(resp.CommonPrefixes, commonPrefix{prefix})
673                 }
674                 sort.Slice(resp.CommonPrefixes, func(i, j int) bool { return resp.CommonPrefixes[i].Prefix < resp.CommonPrefixes[j].Prefix })
675         }
676         resp.KeyCount = len(resp.Contents)
677         w.Header().Set("Content-Type", "application/xml")
678         io.WriteString(w, xml.Header)
679         if err := xml.NewEncoder(w).Encode(resp); err != nil {
680                 ctxlog.FromContext(r.Context()).WithError(err).Error("error writing xml response")
681         }
682 }