X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/42fff42165a0fa1602758a078746f8697f265f83..c502c5a50aae825683ee4cff629c6839a4209501:/services/keep-web/s3.go diff --git a/services/keep-web/s3.go b/services/keep-web/s3.go index 620a21b883..4117dafbc6 100644 --- a/services/keep-web/s3.go +++ b/services/keep-web/s3.go @@ -2,17 +2,20 @@ // // SPDX-License-Identifier: AGPL-3.0 -package main +package keepweb import ( "crypto/hmac" "crypto/sha256" + "encoding/base64" + "encoding/json" "encoding/xml" "errors" "fmt" "hash" "io" "net/http" + "net/textproto" "net/url" "os" "path/filepath" @@ -23,7 +26,9 @@ import ( "time" "git.arvados.org/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/arvadosclient" "git.arvados.org/arvados.git/sdk/go/ctxlog" + "git.arvados.org/arvados.git/sdk/go/keepclient" "github.com/AdRoll/goamz/s3" ) @@ -33,6 +38,42 @@ const ( s3MaxClockSkew = 5 * time.Minute ) +type commonPrefix struct { + Prefix string +} + +type listV1Resp struct { + XMLName string `xml:"http://s3.amazonaws.com/doc/2006-03-01/ ListBucketResult"` + s3.ListResp + // s3.ListResp marshals an empty tag when + // CommonPrefixes is nil, which confuses some clients. + // Fix by using this nested struct instead. + CommonPrefixes []commonPrefix + // Similarly, we need omitempty here, because an empty + // tag confuses some clients (e.g., + // github.com/aws/aws-sdk-net never terminates its + // paging loop). + NextMarker string `xml:"NextMarker,omitempty"` + // ListObjectsV2 has a KeyCount response field. + KeyCount int +} + +type listV2Resp struct { + XMLName string `xml:"http://s3.amazonaws.com/doc/2006-03-01/ ListBucketResult"` + IsTruncated bool + Contents []s3.Key + Name string + Prefix string + Delimiter string + MaxKeys int + CommonPrefixes []commonPrefix + EncodingType string `xml:",omitempty"` + KeyCount int + ContinuationToken string `xml:",omitempty"` + NextContinuationToken string `xml:",omitempty"` + StartAfter string `xml:",omitempty"` +} + func hmacstring(msg string, key []byte) []byte { h := hmac.New(sha256.New, key) io.WriteString(h, msg) @@ -99,15 +140,39 @@ func s3stringToSign(alg, scope, signedHeaders string, r *http.Request) (string, } } - normalizedURL := *r.URL - normalizedURL.RawPath = "" - normalizedURL.Path = reMultipleSlashChars.ReplaceAllString(normalizedURL.Path, "/") - ctxlog.FromContext(r.Context()).Infof("escapedPath %s", normalizedURL.EscapedPath()) - 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")) + normalizedPath := normalizePath(r.URL.Path) + ctxlog.FromContext(r.Context()).Debugf("normalizedPath %q", normalizedPath) + canonicalRequest := fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n%s", r.Method, normalizedPath, s3querystring(r.URL), canonicalHeaders, signedHeaders, r.Header.Get("X-Amz-Content-Sha256")) ctxlog.FromContext(r.Context()).Debugf("s3stringToSign: canonicalRequest %s", canonicalRequest) return fmt.Sprintf("%s\n%s\n%s\n%s", alg, r.Header.Get("X-Amz-Date"), scope, hashdigest(sha256.New(), canonicalRequest)), nil } +func normalizePath(s string) string { + // (url.URL).EscapedPath() would be incorrect here. AWS + // documentation specifies the URL path should be normalized + // according to RFC 3986, i.e., unescaping ALPHA / DIGIT / "-" + // / "." / "_" / "~". The implication is that everything other + // than those chars (and "/") _must_ be percent-encoded -- + // even chars like ";" and "," that are not normally + // percent-encoded in paths. + out := "" + for _, c := range []byte(reMultipleSlashChars.ReplaceAllString(s, "/")) { + if (c >= 'a' && c <= 'z') || + (c >= 'A' && c <= 'Z') || + (c >= '0' && c <= '9') || + c == '-' || + c == '.' || + c == '_' || + c == '~' || + c == '/' { + out += string(c) + } else { + out += fmt.Sprintf("%%%02X", c) + } + } + return out +} + func s3signature(secretKey, scope, signedHeaders, stringToSign string) (string, error) { // scope is {datestamp}/{region}/{service}/aws4_request drs := strings.Split(scope, "/") @@ -159,8 +224,8 @@ func (h *handler) checks3signature(r *http.Request) (string, error) { } client := (&arvados.Client{ - APIHost: h.Config.cluster.Services.Controller.ExternalURL.Host, - Insecure: h.Config.cluster.TLS.Insecure, + APIHost: h.Cluster.Services.Controller.ExternalURL.Host, + Insecure: h.Cluster.TLS.Insecure, }).WithRequestID(r.Header.Get("X-Request-Id")) var aca arvados.APIClientAuthorization var secret string @@ -168,7 +233,7 @@ func (h *handler) checks3signature(r *http.Request) (string, error) { if len(key) == 27 && key[5:12] == "-gj3su-" { // Access key is the UUID of an Arvados token, secret // key is the secret part. - ctx := arvados.ContextWithAuthorization(r.Context(), "Bearer "+h.Config.cluster.SystemRootToken) + ctx := arvados.ContextWithAuthorization(r.Context(), "Bearer "+h.Cluster.SystemRootToken) err = client.RequestAndDecodeContext(ctx, &aca, "GET", "arvados/v1/api_client_authorizations/"+key, nil, nil) secret = aca.APIToken } else { @@ -248,32 +313,38 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { var err error var fs arvados.CustomFileSystem + var arvclient *arvadosclient.ArvadosClient if r.Method == http.MethodGet || r.Method == http.MethodHead { // Use a single session (cached FileSystem) across // multiple read requests. - fs, err = h.Config.Cache.GetSession(token) + var sess *cachedSession + fs, sess, err = h.Cache.GetSession(token) if err != nil { s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusInternalServerError) return true } + arvclient = sess.arvadosclient } else { // Create a FileSystem for this request, to avoid // exposing incomplete write operations to concurrent // requests. - _, kc, client, release, err := h.getClients(r.Header.Get("X-Request-Id"), token) + var kc *keepclient.KeepClient + var release func() + var client *arvados.Client + arvclient, kc, client, release, err = h.getClients(r.Header.Get("X-Request-Id"), token) if err != nil { s3ErrorResponse(w, InternalError, err.Error(), r.URL.Path, http.StatusInternalServerError) return true } defer release() fs = client.SiteFileSystem(kc) - fs.ForwardSlashNameSubstitution(h.Config.cluster.Collections.ForwardSlashNameSubstitution) + fs.ForwardSlashNameSubstitution(h.Cluster.Collections.ForwardSlashNameSubstitution) } var objectNameGiven bool var bucketName string fspath := "/by_id" - if id := parseCollectionIDFromDNSName(r.Host); id != "" { + if id := arvados.CollectionIDFromDNSName(r.Host); id != "" { fspath += "/" + id bucketName = id objectNameGiven = strings.Count(strings.TrimSuffix(r.URL.Path, "/"), "/") > 0 @@ -296,7 +367,7 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { w.Header().Set("Content-Type", "application/xml") io.WriteString(w, xml.Header) fmt.Fprintln(w, ``+ - h.Config.cluster.ClusterID+ + h.Cluster.ClusterID+ ``) } else if reRawQueryIndicatesAPI.MatchString(r.URL.RawQuery) { // GetBucketWebsite ("GET /bucketid/?website"), GetBucketTagging, etc. @@ -316,6 +387,7 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { if r.Method == "HEAD" && !objectNameGiven { // HeadBucket if err == nil && fi.IsDir() { + setFileInfoHeaders(w.Header(), fs, fspath) w.WriteHeader(http.StatusOK) } else if os.IsNotExist(err) { s3ErrorResponse(w, NoSuchBucket, "The specified bucket does not exist.", r.URL.Path, http.StatusNotFound) @@ -324,7 +396,8 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { } return true } - if err == nil && fi.IsDir() && objectNameGiven && strings.HasSuffix(fspath, "/") && h.Config.cluster.Collections.S3FolderObjects { + if err == nil && fi.IsDir() && objectNameGiven && strings.HasSuffix(fspath, "/") && h.Cluster.Collections.S3FolderObjects { + setFileInfoHeaders(w.Header(), fs, fspath) w.Header().Set("Content-Type", "application/x-directory") w.WriteHeader(http.StatusOK) return true @@ -335,9 +408,18 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { s3ErrorResponse(w, NoSuchKey, "The specified key does not exist.", r.URL.Path, http.StatusNotFound) return true } + + tokenUser, err := h.Cache.GetTokenUser(token) + if !h.userPermittedToUploadOrDownload(r.Method, tokenUser) { + http.Error(w, "Not permitted", http.StatusForbidden) + return true + } + h.logUploadOrDownload(r, arvclient, fs, fspath, nil, tokenUser) + // shallow copy r, and change URL path r := *r r.URL.Path = fspath + setFileInfoHeaders(w.Header(), fs, fspath) http.FileServer(fs).ServeHTTP(w, &r) return true case r.Method == http.MethodPut: @@ -352,7 +434,7 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { } var objectIsDir bool if strings.HasSuffix(fspath, "/") { - if !h.Config.cluster.Collections.S3FolderObjects { + if !h.Cluster.Collections.S3FolderObjects { s3ErrorResponse(w, InvalidArgument, "invalid object name: trailing slash", r.URL.Path, http.StatusBadRequest) return true } @@ -394,7 +476,7 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { return true } err = fs.Mkdir(dir, 0755) - if err == arvados.ErrInvalidArgument { + if errors.Is(err, arvados.ErrInvalidArgument) || errors.Is(err, arvados.ErrInvalidOperation) { // Cannot create a directory // here. err = fmt.Errorf("mkdir %q failed: %w", dir, err) @@ -418,6 +500,14 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { return true } defer f.Close() + + tokenUser, err := h.Cache.GetTokenUser(token) + if !h.userPermittedToUploadOrDownload(r.Method, tokenUser) { + http.Error(w, "Not permitted", http.StatusForbidden) + return true + } + h.logUploadOrDownload(r, arvclient, fs, fspath, nil, tokenUser) + _, err = io.Copy(f, r.Body) if err != nil { err = fmt.Errorf("write to %q failed: %w", r.URL.Path, err) @@ -438,7 +528,7 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { return true } // Ensure a subsequent read operation will see the changes. - h.Config.Cache.ResetSession(token) + h.Cache.ResetSession(token) w.WriteHeader(http.StatusOK) return true case r.Method == http.MethodDelete: @@ -492,7 +582,7 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { return true } // Ensure a subsequent read operation will see the changes. - h.Config.Cache.ResetSession(token) + h.Cache.ResetSession(token) w.WriteHeader(http.StatusNoContent) return true default: @@ -501,6 +591,48 @@ func (h *handler) serveS3(w http.ResponseWriter, r *http.Request) bool { } } +func setFileInfoHeaders(header http.Header, fs arvados.CustomFileSystem, path string) { + path = strings.TrimSuffix(path, "/") + var props map[string]interface{} + for { + fi, err := fs.Stat(path) + if err != nil { + return + } + switch src := fi.Sys().(type) { + case *arvados.Collection: + props = src.Properties + case *arvados.Group: + props = src.Properties + default: + // Try parent + cut := strings.LastIndexByte(path, '/') + if cut < 0 { + return + } + path = path[:cut] + continue + } + break + } + for k, v := range props { + if !validMIMEHeaderKey(k) { + continue + } + k = "x-amz-meta-" + k + if s, ok := v.(string); ok { + header.Set(k, s) + } else if j, err := json.Marshal(v); err == nil { + header.Set(k, string(j)) + } + } +} + +func validMIMEHeaderKey(k string) bool { + check := "z-" + k + return check != textproto.CanonicalMIMEHeaderKey(check) +} + // Call fn on the given path (directory) and its contents, in // lexicographic order. // @@ -559,19 +691,50 @@ var errDone = errors.New("done") func (h *handler) s3list(bucket string, w http.ResponseWriter, r *http.Request, fs arvados.CustomFileSystem) { var params struct { - delimiter string - marker string - maxKeys int - prefix string + v2 bool + delimiter string + maxKeys int + prefix string + marker string // decoded continuationToken (v2) or provided by client (v1) + startAfter string // v2 + continuationToken string // v2 + encodingTypeURL bool // v2 } params.delimiter = r.FormValue("delimiter") - params.marker = r.FormValue("marker") if mk, _ := strconv.ParseInt(r.FormValue("max-keys"), 10, 64); mk > 0 && mk < s3MaxKeys { params.maxKeys = int(mk) } else { params.maxKeys = s3MaxKeys } params.prefix = r.FormValue("prefix") + switch r.FormValue("list-type") { + case "": + case "2": + params.v2 = true + default: + http.Error(w, "invalid list-type parameter", http.StatusBadRequest) + return + } + if params.v2 { + params.continuationToken = r.FormValue("continuation-token") + marker, err := base64.StdEncoding.DecodeString(params.continuationToken) + if err != nil { + http.Error(w, "invalid continuation token", http.StatusBadRequest) + return + } + params.marker = string(marker) + params.startAfter = r.FormValue("start-after") + switch r.FormValue("encoding-type") { + case "": + case "url": + params.encodingTypeURL = true + default: + http.Error(w, "invalid encoding-type parameter", http.StatusBadRequest) + return + } + } else { + params.marker = r.FormValue("marker") + } bucketdir := "by_id/" + bucket // walkpath is the directory (relative to bucketdir) we need @@ -588,33 +751,16 @@ func (h *handler) s3list(bucket string, w http.ResponseWriter, r *http.Request, walkpath = "" } - type commonPrefix struct { - Prefix string - } - type listResp struct { - XMLName string `xml:"http://s3.amazonaws.com/doc/2006-03-01/ ListBucketResult"` - s3.ListResp - // s3.ListResp marshals an empty tag when - // CommonPrefixes is nil, which confuses some clients. - // Fix by using this nested struct instead. - CommonPrefixes []commonPrefix - // Similarly, we need omitempty here, because an empty - // tag confuses some clients (e.g., - // github.com/aws/aws-sdk-net never terminates its - // paging loop). - NextMarker string `xml:"NextMarker,omitempty"` - // ListObjectsV2 has a KeyCount response field. - KeyCount int - } - resp := listResp{ - ListResp: s3.ListResp{ - Name: bucket, - Prefix: params.prefix, - Delimiter: params.delimiter, - Marker: params.marker, - MaxKeys: params.maxKeys, - }, - } + resp := listV2Resp{ + Name: bucket, + Prefix: params.prefix, + Delimiter: params.delimiter, + MaxKeys: params.maxKeys, + ContinuationToken: r.FormValue("continuation-token"), + StartAfter: params.startAfter, + } + nextMarker := "" + commonPrefixes := map[string]bool{} err := walkFS(fs, strings.TrimSuffix(bucketdir+"/"+walkpath, "/"), true, func(path string, fi os.FileInfo) error { if path == bucketdir { @@ -654,10 +800,10 @@ func (h *handler) s3list(bucket string, w http.ResponseWriter, r *http.Request, return errDone } } - if path < params.marker || path < params.prefix { + if path < params.marker || path < params.prefix || path <= params.startAfter { return nil } - if fi.IsDir() && !h.Config.cluster.Collections.S3FolderObjects { + if fi.IsDir() && !h.Cluster.Collections.S3FolderObjects { // Note we don't add anything to // commonPrefixes here even if delimiter is // "/". We descend into the directory, and @@ -665,6 +811,13 @@ func (h *handler) s3list(bucket string, w http.ResponseWriter, r *http.Request, // finding a regular file inside it. return nil } + if len(resp.Contents)+len(commonPrefixes) >= params.maxKeys { + resp.IsTruncated = true + if params.delimiter != "" || params.v2 { + nextMarker = path + } + return errDone + } if params.delimiter != "" { idx := strings.Index(path[len(params.prefix):], params.delimiter) if idx >= 0 { @@ -676,13 +829,6 @@ func (h *handler) s3list(bucket string, w http.ResponseWriter, r *http.Request, return filepath.SkipDir } } - if len(resp.Contents)+len(commonPrefixes) >= params.maxKeys { - resp.IsTruncated = true - if params.delimiter != "" { - resp.NextMarker = path - } - return errDone - } resp.Contents = append(resp.Contents, s3.Key{ Key: path, LastModified: fi.ModTime().UTC().Format("2006-01-02T15:04:05.999") + "Z", @@ -702,9 +848,66 @@ func (h *handler) s3list(bucket string, w http.ResponseWriter, r *http.Request, sort.Slice(resp.CommonPrefixes, func(i, j int) bool { return resp.CommonPrefixes[i].Prefix < resp.CommonPrefixes[j].Prefix }) } resp.KeyCount = len(resp.Contents) + var respV1orV2 interface{} + + if params.encodingTypeURL { + // https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html + // "If you specify the encoding-type request + // parameter, Amazon S3 includes this element in the + // response, and returns encoded key name values in + // the following response elements: + // + // Delimiter, Prefix, Key, and StartAfter. + // + // Type: String + // + // Valid Values: url" + // + // This is somewhat vague but in practice it appears + // to mean x-www-form-urlencoded as in RFC1866 8.2.1 + // para 1 (encode space as "+") rather than straight + // percent-encoding as in RFC1738 2.2. Presumably, + // the intent is to allow the client to decode XML and + // then paste the strings directly into another URI + // query or POST form like "https://host/path?foo=" + + // foo + "&bar=" + bar. + resp.EncodingType = "url" + resp.Delimiter = url.QueryEscape(resp.Delimiter) + resp.Prefix = url.QueryEscape(resp.Prefix) + resp.StartAfter = url.QueryEscape(resp.StartAfter) + for i, ent := range resp.Contents { + ent.Key = url.QueryEscape(ent.Key) + resp.Contents[i] = ent + } + for i, ent := range resp.CommonPrefixes { + ent.Prefix = url.QueryEscape(ent.Prefix) + resp.CommonPrefixes[i] = ent + } + } + + if params.v2 { + resp.NextContinuationToken = base64.StdEncoding.EncodeToString([]byte(nextMarker)) + respV1orV2 = resp + } else { + respV1orV2 = listV1Resp{ + CommonPrefixes: resp.CommonPrefixes, + NextMarker: nextMarker, + KeyCount: resp.KeyCount, + ListResp: s3.ListResp{ + IsTruncated: resp.IsTruncated, + Name: bucket, + Prefix: params.prefix, + Delimiter: params.delimiter, + Marker: params.marker, + MaxKeys: params.maxKeys, + Contents: resp.Contents, + }, + } + } + w.Header().Set("Content-Type", "application/xml") io.WriteString(w, xml.Header) - if err := xml.NewEncoder(w).Encode(resp); err != nil { + if err := xml.NewEncoder(w).Encode(respV1orV2); err != nil { ctxlog.FromContext(r.Context()).WithError(err).Error("error writing xml response") } }