X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/cae02ce88e24b9e760fbacbeea630c85946dcbe6..fddf29b24934aacaa2acf0e3c903fba3d9de52de:/services/keepproxy/keepproxy.go diff --git a/services/keepproxy/keepproxy.go b/services/keepproxy/keepproxy.go index c6fd99b9d8..f857ed3e4e 100644 --- a/services/keepproxy/keepproxy.go +++ b/services/keepproxy/keepproxy.go @@ -2,239 +2,113 @@ // // SPDX-License-Identifier: AGPL-3.0 -package main +package keepproxy import ( + "context" "errors" - "flag" "fmt" "io" "io/ioutil" "net" "net/http" - "os" - "os/signal" "regexp" "strings" - "sync" - "syscall" "time" - "git.curoverse.com/arvados.git/sdk/go/arvados" - "git.curoverse.com/arvados.git/sdk/go/arvadosclient" - "git.curoverse.com/arvados.git/sdk/go/config" - "git.curoverse.com/arvados.git/sdk/go/health" - "git.curoverse.com/arvados.git/sdk/go/httpserver" - "git.curoverse.com/arvados.git/sdk/go/keepclient" - "github.com/coreos/go-systemd/daemon" - "github.com/ghodss/yaml" + "git.arvados.org/arvados.git/lib/service" + "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/health" + "git.arvados.org/arvados.git/sdk/go/httpserver" + "git.arvados.org/arvados.git/sdk/go/keepclient" "github.com/gorilla/mux" - log "github.com/sirupsen/logrus" -) - -var version = "dev" - -type Config struct { - Client arvados.Client - Listen string - DisableGet bool - DisablePut bool - DefaultReplicas int - Timeout arvados.Duration - PIDFile string - Debug bool - ManagementToken string -} - -func DefaultConfig() *Config { - return &Config{ - Listen: ":25107", - Timeout: arvados.Duration(15 * time.Second), - } -} - -var ( - listener net.Listener - router http.Handler + lru "github.com/hashicorp/golang-lru" + "github.com/prometheus/client_golang/prometheus" + "github.com/sirupsen/logrus" ) const rfc3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00" -func main() { - log.SetFormatter(&log.JSONFormatter{ - TimestampFormat: rfc3339NanoFixed, - }) - - cfg := DefaultConfig() - - flagset := flag.NewFlagSet("keepproxy", flag.ExitOnError) - flagset.Usage = usage - - const deprecated = " (DEPRECATED -- use config file instead)" - flagset.StringVar(&cfg.Listen, "listen", cfg.Listen, "Local port to listen on."+deprecated) - flagset.BoolVar(&cfg.DisableGet, "no-get", cfg.DisableGet, "Disable GET operations."+deprecated) - flagset.BoolVar(&cfg.DisablePut, "no-put", cfg.DisablePut, "Disable PUT operations."+deprecated) - flagset.IntVar(&cfg.DefaultReplicas, "default-replicas", cfg.DefaultReplicas, "Default number of replicas to write if not specified by the client. If 0, use site default."+deprecated) - flagset.StringVar(&cfg.PIDFile, "pid", cfg.PIDFile, "Path to write pid file."+deprecated) - timeoutSeconds := flagset.Int("timeout", int(time.Duration(cfg.Timeout)/time.Second), "Timeout (in seconds) on requests to internal Keep services."+deprecated) - flagset.StringVar(&cfg.ManagementToken, "management-token", cfg.ManagementToken, "Authorization token to be included in all health check requests.") - - var cfgPath string - const defaultCfgPath = "/etc/arvados/keepproxy/keepproxy.yml" - flagset.StringVar(&cfgPath, "config", defaultCfgPath, "Configuration file `path`") - dumpConfig := flagset.Bool("dump-config", false, "write current configuration to stdout and exit") - getVersion := flagset.Bool("version", false, "Print version information and exit.") - flagset.Parse(os.Args[1:]) - - // Print version information if requested - if *getVersion { - fmt.Printf("keepproxy %s\n", version) - return - } +var Command = service.Command(arvados.ServiceNameKeepproxy, newHandlerOrErrorHandler) - err := config.LoadFile(cfg, cfgPath) +func newHandlerOrErrorHandler(ctx context.Context, cluster *arvados.Cluster, token string, reg *prometheus.Registry) service.Handler { + client, err := arvados.NewClientFromConfig(cluster) if err != nil { - h := os.Getenv("ARVADOS_API_HOST") - t := os.Getenv("ARVADOS_API_TOKEN") - if h == "" || t == "" || !os.IsNotExist(err) || cfgPath != defaultCfgPath { - log.Fatal(err) - } - log.Print("DEPRECATED: No config file found, but ARVADOS_API_HOST and ARVADOS_API_TOKEN environment variables are set. Please use a config file instead.") - cfg.Client.APIHost = h - cfg.Client.AuthToken = t - if regexp.MustCompile("^(?i:1|yes|true)$").MatchString(os.Getenv("ARVADOS_API_HOST_INSECURE")) { - cfg.Client.Insecure = true - } - if y, err := yaml.Marshal(cfg); err == nil && !*dumpConfig { - log.Print("Current configuration:\n", string(y)) - } - cfg.Timeout = arvados.Duration(time.Duration(*timeoutSeconds) * time.Second) + return service.ErrorHandler(ctx, cluster, fmt.Errorf("Error setting up arvados client: %w", err)) } - - if *dumpConfig { - log.Fatal(config.DumpAndExit(cfg)) - } - - log.Printf("keepproxy %s started", version) - - arv, err := arvadosclient.New(&cfg.Client) + arv, err := arvadosclient.New(client) if err != nil { - log.Fatalf("Error setting up arvados client %s", err.Error()) - } - - if cfg.Debug { - keepclient.DebugPrintf = log.Printf + return service.ErrorHandler(ctx, cluster, fmt.Errorf("Error setting up arvados client: %w", err)) } kc, err := keepclient.MakeKeepClient(arv) if err != nil { - log.Fatalf("Error setting up keep client %s", err.Error()) + return service.ErrorHandler(ctx, cluster, fmt.Errorf("Error setting up keep client: %w", err)) } keepclient.RefreshServiceDiscoveryOnSIGHUP() - - if cfg.PIDFile != "" { - f, err := os.Create(cfg.PIDFile) - if err != nil { - log.Fatal(err) - } - defer f.Close() - err = syscall.Flock(int(f.Fd()), syscall.LOCK_EX|syscall.LOCK_NB) - if err != nil { - log.Fatalf("flock(%s): %s", cfg.PIDFile, err) - } - defer os.Remove(cfg.PIDFile) - err = f.Truncate(0) - if err != nil { - log.Fatalf("truncate(%s): %s", cfg.PIDFile, err) - } - _, err = fmt.Fprint(f, os.Getpid()) - if err != nil { - log.Fatalf("write(%s): %s", cfg.PIDFile, err) - } - err = f.Sync() - if err != nil { - log.Fatalf("sync(%s): %s", cfg.PIDFile, err) - } - } - - if cfg.DefaultReplicas > 0 { - kc.Want_replicas = cfg.DefaultReplicas - } - - listener, err = net.Listen("tcp", cfg.Listen) + router, err := newHandler(ctx, kc, time.Duration(keepclient.DefaultProxyRequestTimeout), cluster) if err != nil { - log.Fatalf("listen(%s): %s", cfg.Listen, err) - } - if _, err := daemon.SdNotify(false, "READY=1"); err != nil { - log.Printf("Error notifying init daemon: %v", err) + return service.ErrorHandler(ctx, cluster, err) } - log.Println("Listening at", listener.Addr()) - - // Shut down the server gracefully (by closing the listener) - // if SIGTERM is received. - term := make(chan os.Signal, 1) - go func(sig <-chan os.Signal) { - s := <-sig - log.Println("caught signal:", s) - listener.Close() - }(term) - signal.Notify(term, syscall.SIGTERM) - signal.Notify(term, syscall.SIGINT) - - // Start serving requests. - router = MakeRESTRouter(!cfg.DisableGet, !cfg.DisablePut, kc, time.Duration(cfg.Timeout), cfg.ManagementToken) - http.Serve(listener, httpserver.AddRequestIDs(httpserver.LogRequests(nil, router))) + return router +} - log.Println("shutting down") +type tokenCacheEntry struct { + expire int64 + user *arvados.User } -type ApiTokenCache struct { - tokens map[string]int64 - lock sync.Mutex +type apiTokenCache struct { + tokens *lru.TwoQueueCache expireTime int64 } -// Cache the token and set an expire time. If we already have an expire time -// on the token, it is not updated. -func (this *ApiTokenCache) RememberToken(token string) { - this.lock.Lock() - defer this.lock.Unlock() - +// RememberToken caches the token and set an expire time. If the +// token is already in the cache, it is not updated. +func (cache *apiTokenCache) RememberToken(token string, user *arvados.User) { now := time.Now().Unix() - if this.tokens[token] == 0 { - this.tokens[token] = now + this.expireTime + _, ok := cache.tokens.Get(token) + if !ok { + cache.tokens.Add(token, tokenCacheEntry{ + expire: now + cache.expireTime, + user: user, + }) } } -// Check if the cached token is known and still believed to be valid. -func (this *ApiTokenCache) RecallToken(token string) bool { - this.lock.Lock() - defer this.lock.Unlock() +// RecallToken checks if the cached token is known and still believed to be +// valid. +func (cache *apiTokenCache) RecallToken(token string) (bool, *arvados.User) { + val, ok := cache.tokens.Get(token) + if !ok { + return false, nil + } + cacheEntry := val.(tokenCacheEntry) now := time.Now().Unix() - if this.tokens[token] == 0 { - // Unknown token - return false - } else if now < this.tokens[token] { + if now < cacheEntry.expire { // Token is known and still valid - return true + return true, cacheEntry.user } else { // Token is expired - this.tokens[token] = 0 - return false + cache.tokens.Remove(token) + return false, nil } } -func GetRemoteAddress(req *http.Request) string { - if xff := req.Header.Get("X-Forwarded-For"); xff != "" { - return xff + "," + req.RemoteAddr - } - return req.RemoteAddr +func (h *proxyHandler) Done() <-chan struct{} { + return nil } -func CheckAuthorizationHeader(kc *keepclient.KeepClient, cache *ApiTokenCache, req *http.Request) (pass bool, tok string) { +func (h *proxyHandler) CheckHealth() error { + return nil +} + +func (h *proxyHandler) checkAuthorizationHeader(req *http.Request) (pass bool, tok string, user *arvados.User) { parts := strings.SplitN(req.Header.Get("Authorization"), " ", 2) if len(parts) < 2 || !(parts[0] == "OAuth2" || parts[0] == "Bearer") || len(parts[1]) == 0 { - return false, "" + return false, "", nil } tok = parts[1] @@ -249,29 +123,56 @@ func CheckAuthorizationHeader(kc *keepclient.KeepClient, cache *ApiTokenCache, r op = "write" } - if cache.RecallToken(op + ":" + tok) { + if ok, user := h.apiTokenCache.RecallToken(op + ":" + tok); ok { // Valid in the cache, short circuit - return true, tok + return true, tok, user } var err error - arv := *kc.Arvados + arv := *h.KeepClient.Arvados arv.ApiToken = tok arv.RequestID = req.Header.Get("X-Request-Id") - if op == "read" { - err = arv.Call("HEAD", "keep_services", "", "accessible", nil, nil) - } else { - err = arv.Call("HEAD", "users", "", "current", nil, nil) + user = &arvados.User{} + userCurrentError := arv.Call("GET", "users", "", "current", nil, user) + err = userCurrentError + if err != nil && op == "read" { + apiError, ok := err.(arvadosclient.APIServerError) + if ok && apiError.HttpStatusCode == http.StatusForbidden { + // If it was a scoped "sharing" token it will + // return 403 instead of 401 for the current + // user check. If it is a download operation + // and they have permission to read the + // keep_services table, we can allow it. + err = arv.Call("HEAD", "keep_services", "", "accessible", nil, nil) + } } if err != nil { - log.Printf("%s: CheckAuthorizationHeader error: %v", GetRemoteAddress(req), err) - return false, "" + ctxlog.FromContext(req.Context()).WithError(err).Info("checkAuthorizationHeader error") + return false, "", nil + } + + if userCurrentError == nil && user.IsAdmin { + // checking userCurrentError is probably redundant, + // IsAdmin would be false anyway. But can't hurt. + if op == "read" && !h.cluster.Collections.KeepproxyPermission.Admin.Download { + return false, "", nil + } + if op == "write" && !h.cluster.Collections.KeepproxyPermission.Admin.Upload { + return false, "", nil + } + } else { + if op == "read" && !h.cluster.Collections.KeepproxyPermission.User.Download { + return false, "", nil + } + if op == "write" && !h.cluster.Collections.KeepproxyPermission.User.Upload { + return false, "", nil + } } // Success! Update cache - cache.RememberToken(op + ":" + tok) + h.apiTokenCache.RememberToken(op+":"+tok, user) - return true, tok + return true, tok, user } // We need to make a private copy of the default http transport early @@ -285,14 +186,13 @@ var defaultTransport = *(http.DefaultTransport.(*http.Transport)) type proxyHandler struct { http.Handler *keepclient.KeepClient - *ApiTokenCache + *apiTokenCache timeout time.Duration transport *http.Transport + cluster *arvados.Cluster } -// MakeRESTRouter returns an http.Handler that passes GET and PUT -// requests to the appropriate handlers. -func MakeRESTRouter(enable_get bool, enable_put bool, kc *keepclient.KeepClient, timeout time.Duration, mgmtToken string) http.Handler { +func newHandler(ctx context.Context, kc *keepclient.KeepClient, timeout time.Duration, cluster *arvados.Cluster) (service.Handler, error) { rest := mux.NewRouter() transport := defaultTransport @@ -304,78 +204,78 @@ func MakeRESTRouter(enable_get bool, enable_put bool, kc *keepclient.KeepClient, transport.TLSClientConfig = arvadosclient.MakeTLSConfig(kc.Arvados.ApiInsecure) transport.TLSHandshakeTimeout = keepclient.DefaultTLSHandshakeTimeout + cacheQ, err := lru.New2Q(500) + if err != nil { + return nil, fmt.Errorf("Error from lru.New2Q: %v", err) + } + h := &proxyHandler{ Handler: rest, KeepClient: kc, timeout: timeout, transport: &transport, - ApiTokenCache: &ApiTokenCache{ - tokens: make(map[string]int64), + apiTokenCache: &apiTokenCache{ + tokens: cacheQ, expireTime: 300, }, + cluster: cluster, } - if enable_get { - rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Get).Methods("GET", "HEAD") - rest.HandleFunc(`/{locator:[0-9a-f]{32}}`, h.Get).Methods("GET", "HEAD") + rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Get).Methods("GET", "HEAD") + rest.HandleFunc(`/{locator:[0-9a-f]{32}}`, h.Get).Methods("GET", "HEAD") - // List all blocks - rest.HandleFunc(`/index`, h.Index).Methods("GET") + // List all blocks + rest.HandleFunc(`/index`, h.Index).Methods("GET") - // List blocks whose hash has the given prefix - rest.HandleFunc(`/index/{prefix:[0-9a-f]{0,32}}`, h.Index).Methods("GET") - } + // List blocks whose hash has the given prefix + rest.HandleFunc(`/index/{prefix:[0-9a-f]{0,32}}`, h.Index).Methods("GET") - if enable_put { - rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Put).Methods("PUT") - rest.HandleFunc(`/{locator:[0-9a-f]{32}}`, h.Put).Methods("PUT") - rest.HandleFunc(`/`, h.Put).Methods("POST") - rest.HandleFunc(`/{any}`, h.Options).Methods("OPTIONS") - rest.HandleFunc(`/`, h.Options).Methods("OPTIONS") - } + rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Put).Methods("PUT") + rest.HandleFunc(`/{locator:[0-9a-f]{32}}`, h.Put).Methods("PUT") + rest.HandleFunc(`/`, h.Put).Methods("POST") + rest.HandleFunc(`/{any}`, h.Options).Methods("OPTIONS") + rest.HandleFunc(`/`, h.Options).Methods("OPTIONS") rest.Handle("/_health/{check}", &health.Handler{ - Token: mgmtToken, + Token: cluster.ManagementToken, Prefix: "/_health/", }).Methods("GET") - rest.NotFoundHandler = InvalidPathHandler{} - return h + rest.NotFoundHandler = invalidPathHandler{} + return h, nil } var errLoopDetected = errors.New("loop detected") -func (*proxyHandler) checkLoop(resp http.ResponseWriter, req *http.Request) error { +func (h *proxyHandler) checkLoop(resp http.ResponseWriter, req *http.Request) error { if via := req.Header.Get("Via"); strings.Index(via, " "+viaAlias) >= 0 { - log.Printf("proxy loop detected (request has Via: %q): perhaps keepproxy is misidentified by gateway config as an external client, or its keep_services record does not have service_type=proxy?", via) + ctxlog.FromContext(req.Context()).Printf("proxy loop detected (request has Via: %q): perhaps keepproxy is misidentified by gateway config as an external client, or its keep_services record does not have service_type=proxy?", via) http.Error(resp, errLoopDetected.Error(), http.StatusInternalServerError) return errLoopDetected } return nil } -func SetCorsHeaders(resp http.ResponseWriter) { +func setCORSHeaders(resp http.ResponseWriter) { resp.Header().Set("Access-Control-Allow-Methods", "GET, HEAD, POST, PUT, OPTIONS") resp.Header().Set("Access-Control-Allow-Origin", "*") resp.Header().Set("Access-Control-Allow-Headers", "Authorization, Content-Length, Content-Type, X-Keep-Desired-Replicas") resp.Header().Set("Access-Control-Max-Age", "86486400") } -type InvalidPathHandler struct{} +type invalidPathHandler struct{} -func (InvalidPathHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) { - log.Printf("%s: %s %s unroutable", GetRemoteAddress(req), req.Method, req.URL.Path) +func (invalidPathHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) { http.Error(resp, "Bad request", http.StatusBadRequest) } func (h *proxyHandler) Options(resp http.ResponseWriter, req *http.Request) { - log.Printf("%s: %s %s", GetRemoteAddress(req), req.Method, req.URL.Path) - SetCorsHeaders(resp) + setCORSHeaders(resp) } -var BadAuthorizationHeader = errors.New("Missing or invalid Authorization header") -var ContentLengthMismatch = errors.New("Actual length != expected content length") -var MethodNotSupported = errors.New("Method not supported") +var errBadAuthorizationHeader = errors.New("Missing or invalid Authorization header, or method not allowed") +var errContentLengthMismatch = errors.New("Actual length != expected content length") +var errMethodNotSupported = errors.New("Method not supported") var removeHint, _ = regexp.Compile("\\+K@[a-z0-9]{5}(\\+|$)") @@ -383,7 +283,7 @@ func (h *proxyHandler) Get(resp http.ResponseWriter, req *http.Request) { if err := h.checkLoop(resp, req); err != nil { return } - SetCorsHeaders(resp) + setCORSHeaders(resp) resp.Header().Set("Via", req.Proto+" "+viaAlias) locator := mux.Vars(req)["locator"] @@ -392,8 +292,15 @@ func (h *proxyHandler) Get(resp http.ResponseWriter, req *http.Request) { var expectLength, responseLength int64 var proxiedURI = "-" + logger := ctxlog.FromContext(req.Context()) defer func() { - log.Println(GetRemoteAddress(req), req.Method, req.URL.Path, status, expectLength, responseLength, proxiedURI, err) + httpserver.SetResponseLogFields(req.Context(), logrus.Fields{ + "locator": locator, + "expectLength": expectLength, + "responseLength": responseLength, + "proxiedURI": proxiedURI, + "err": err, + }) if status != http.StatusOK { http.Error(resp, err.Error(), status) } @@ -403,10 +310,15 @@ func (h *proxyHandler) Get(resp http.ResponseWriter, req *http.Request) { var pass bool var tok string - if pass, tok = CheckAuthorizationHeader(kc, h.ApiTokenCache, req); !pass { - status, err = http.StatusForbidden, BadAuthorizationHeader + var user *arvados.User + if pass, tok, user = h.checkAuthorizationHeader(req); !pass { + status, err = http.StatusForbidden, errBadAuthorizationHeader return } + httpserver.SetResponseLogFields(req.Context(), logrus.Fields{ + "userUUID": user.UUID, + "userFullName": user.FullName, + }) // Copy ArvadosClient struct and use the client's API token arvclient := *kc.Arvados @@ -426,12 +338,12 @@ func (h *proxyHandler) Get(resp http.ResponseWriter, req *http.Request) { defer reader.Close() } default: - status, err = http.StatusNotImplemented, MethodNotSupported + status, err = http.StatusNotImplemented, errMethodNotSupported return } if expectLength == -1 { - log.Println("Warning:", GetRemoteAddress(req), req.Method, proxiedURI, "Content-Length not provided") + logger.Warn("Content-Length not provided") } switch respErr := err.(type) { @@ -444,7 +356,7 @@ func (h *proxyHandler) Get(resp http.ResponseWriter, req *http.Request) { case "GET": responseLength, err = io.Copy(resp, reader) if err == nil && expectLength > -1 && responseLength != expectLength { - err = ContentLengthMismatch + err = errContentLengthMismatch } } case keepclient.Error: @@ -460,14 +372,14 @@ func (h *proxyHandler) Get(resp http.ResponseWriter, req *http.Request) { } } -var LengthRequiredError = errors.New(http.StatusText(http.StatusLengthRequired)) -var LengthMismatchError = errors.New("Locator size hint does not match Content-Length header") +var errLengthRequired = errors.New(http.StatusText(http.StatusLengthRequired)) +var errLengthMismatch = errors.New("Locator size hint does not match Content-Length header") func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { if err := h.checkLoop(resp, req); err != nil { return } - SetCorsHeaders(resp) + setCORSHeaders(resp) resp.Header().Set("Via", "HTTP/1.1 "+viaAlias) kc := h.makeKeepClient(req) @@ -479,7 +391,13 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { var locatorOut string = "-" defer func() { - log.Println(GetRemoteAddress(req), req.Method, req.URL.Path, status, expectLength, kc.Want_replicas, wroteReplicas, locatorOut, err) + httpserver.SetResponseLogFields(req.Context(), logrus.Fields{ + "expectLength": expectLength, + "wantReplicas": kc.Want_replicas, + "wroteReplicas": wroteReplicas, + "locator": strings.SplitN(locatorOut, "+A", 2)[0], + "err": err, + }) if status != http.StatusOK { http.Error(resp, err.Error(), status) } @@ -493,12 +411,12 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { for _, sc := range strings.Split(req.Header.Get("X-Keep-Storage-Classes"), ",") { scl = append(scl, strings.Trim(sc, " ")) } - kc.StorageClasses = scl + kc.SetStorageClasses(scl) } _, err = fmt.Sscanf(req.Header.Get("Content-Length"), "%d", &expectLength) if err != nil || expectLength < 0 { - err = LengthRequiredError + err = errLengthRequired status = http.StatusLengthRequired return } @@ -509,7 +427,7 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { status = http.StatusBadRequest return } else if loc.Size > 0 && int64(loc.Size) != expectLength { - err = LengthMismatchError + err = errLengthMismatch status = http.StatusBadRequest return } @@ -517,11 +435,16 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { var pass bool var tok string - if pass, tok = CheckAuthorizationHeader(kc, h.ApiTokenCache, req); !pass { - err = BadAuthorizationHeader + var user *arvados.User + if pass, tok, user = h.checkAuthorizationHeader(req); !pass { + err = errBadAuthorizationHeader status = http.StatusForbidden return } + httpserver.SetResponseLogFields(req.Context(), logrus.Fields{ + "userUUID": user.UUID, + "userFullName": user.FullName, + }) // Copy ArvadosClient struct and use the client's API token arvclient := *kc.Arvados @@ -529,9 +452,9 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { kc.Arvados = &arvclient // Check if the client specified the number of replicas - if req.Header.Get("X-Keep-Desired-Replicas") != "" { + if desiredReplicas := req.Header.Get(keepclient.XKeepDesiredReplicas); desiredReplicas != "" { var r int - _, err := fmt.Sscanf(req.Header.Get(keepclient.X_Keep_Desired_Replicas), "%d", &r) + _, err := fmt.Sscanf(desiredReplicas, "%d", &r) if err == nil { kc.Want_replicas = r } @@ -551,28 +474,33 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { } // Tell the client how many successful PUTs we accomplished - resp.Header().Set(keepclient.X_Keep_Replicas_Stored, fmt.Sprintf("%d", wroteReplicas)) + resp.Header().Set(keepclient.XKeepReplicasStored, fmt.Sprintf("%d", wroteReplicas)) switch err.(type) { case nil: status = http.StatusOK + if len(kc.StorageClasses) > 0 { + // A successful PUT request with storage classes means that all + // storage classes were fulfilled, so the client will get a + // confirmation via the X-Storage-Classes-Confirmed header. + hdr := "" + isFirst := true + for _, sc := range kc.StorageClasses { + if isFirst { + hdr = fmt.Sprintf("%s=%d", sc, wroteReplicas) + isFirst = false + } else { + hdr += fmt.Sprintf(", %s=%d", sc, wroteReplicas) + } + } + resp.Header().Set(keepclient.XKeepStorageClassesConfirmed, hdr) + } _, err = io.WriteString(resp, locatorOut) - case keepclient.OversizeBlockError: // Too much data status = http.StatusRequestEntityTooLarge - case keepclient.InsufficientReplicasError: - if wroteReplicas > 0 { - // At least one write is considered success. The - // client can decide if getting less than the number of - // replications it asked for is a fatal error. - status = http.StatusOK - _, err = io.WriteString(resp, locatorOut) - } else { - status = http.StatusServiceUnavailable - } - + status = http.StatusServiceUnavailable default: status = http.StatusBadGateway } @@ -586,7 +514,7 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { // Aborts on any errors // Concatenates responses from all those keep servers and returns func (h *proxyHandler) Index(resp http.ResponseWriter, req *http.Request) { - SetCorsHeaders(resp) + setCORSHeaders(resp) prefix := mux.Vars(req)["prefix"] var err error @@ -599,9 +527,9 @@ func (h *proxyHandler) Index(resp http.ResponseWriter, req *http.Request) { }() kc := h.makeKeepClient(req) - ok, token := CheckAuthorizationHeader(kc, h.ApiTokenCache, req) + ok, token, _ := h.checkAuthorizationHeader(req) if !ok { - status, err = http.StatusForbidden, BadAuthorizationHeader + status, err = http.StatusForbidden, errBadAuthorizationHeader return } @@ -612,7 +540,7 @@ func (h *proxyHandler) Index(resp http.ResponseWriter, req *http.Request) { // Only GET method is supported if req.Method != "GET" { - status, err = http.StatusNotImplemented, MethodNotSupported + status, err = http.StatusNotImplemented, errMethodNotSupported return }