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