// Copyright (C) The Arvados Authors. All rights reserved. // // SPDX-License-Identifier: AGPL-3.0 package keepproxy import ( "context" "errors" "fmt" "io" "io/ioutil" "net" "net/http" "regexp" "strings" "time" "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" 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" var Command = service.Command(arvados.ServiceNameKeepproxy, newHandlerOrErrorHandler) func newHandlerOrErrorHandler(ctx context.Context, cluster *arvados.Cluster, token string, reg *prometheus.Registry) service.Handler { client, err := arvados.NewClientFromConfig(cluster) if err != nil { return service.ErrorHandler(ctx, cluster, fmt.Errorf("Error setting up arvados client: %w", err)) } arv, err := arvadosclient.New(client) if err != nil { return service.ErrorHandler(ctx, cluster, fmt.Errorf("Error setting up arvados client: %w", err)) } kc, err := keepclient.MakeKeepClient(arv) if err != nil { return service.ErrorHandler(ctx, cluster, fmt.Errorf("Error setting up keep client: %w", err)) } keepclient.RefreshServiceDiscoveryOnSIGHUP() router, err := newHandler(ctx, kc, time.Duration(keepclient.DefaultProxyRequestTimeout), cluster) if err != nil { return service.ErrorHandler(ctx, cluster, err) } return router } type tokenCacheEntry struct { expire int64 user *arvados.User } type apiTokenCache struct { tokens *lru.TwoQueueCache expireTime int64 } // 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() _, ok := cache.tokens.Get(token) if !ok { cache.tokens.Add(token, tokenCacheEntry{ expire: now + cache.expireTime, user: user, }) } } // 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 now < cacheEntry.expire { // Token is known and still valid return true, cacheEntry.user } else { // Token is expired cache.tokens.Remove(token) return false, nil } } func (h *proxyHandler) Done() <-chan struct{} { return nil } 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, "", nil } tok = parts[1] // Tokens are validated differently depending on what kind of // operation is being performed. For example, tokens in // collection-sharing links permit GET requests, but not // PUT requests. var op string if req.Method == "GET" || req.Method == "HEAD" { op = "read" } else { op = "write" } if ok, user := h.apiTokenCache.RecallToken(op + ":" + tok); ok { // Valid in the cache, short circuit return true, tok, user } var err error arv := *h.KeepClient.Arvados arv.ApiToken = tok arv.RequestID = req.Header.Get("X-Request-Id") 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 { 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 h.apiTokenCache.RememberToken(op+":"+tok, user) return true, tok, user } // We need to make a private copy of the default http transport early // in initialization, then make copies of our private copy later. It // won't be safe to copy http.DefaultTransport itself later, because // its private mutexes might have already been used. (Without this, // the test suite sometimes panics "concurrent map writes" in // net/http.(*Transport).removeIdleConnLocked().) var defaultTransport = *(http.DefaultTransport.(*http.Transport)) type proxyHandler struct { http.Handler *keepclient.KeepClient *apiTokenCache timeout time.Duration transport *http.Transport cluster *arvados.Cluster } func newHandler(ctx context.Context, kc *keepclient.KeepClient, timeout time.Duration, cluster *arvados.Cluster) (service.Handler, error) { rest := mux.NewRouter() transport := defaultTransport transport.DialContext = (&net.Dialer{ Timeout: keepclient.DefaultConnectTimeout, KeepAlive: keepclient.DefaultKeepAlive, DualStack: true, }).DialContext 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: cacheQ, expireTime: 300, }, cluster: cluster, } 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 blocks whose hash has the given prefix rest.HandleFunc(`/index/{prefix:[0-9a-f]{0,32}}`, h.Index).Methods("GET") 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: cluster.ManagementToken, Prefix: "/_health/", }).Methods("GET") rest.NotFoundHandler = invalidPathHandler{} return h, nil } var errLoopDetected = errors.New("loop detected") func (h *proxyHandler) checkLoop(resp http.ResponseWriter, req *http.Request) error { if via := req.Header.Get("Via"); strings.Index(via, " "+viaAlias) >= 0 { 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) { 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{} 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) { setCORSHeaders(resp) } 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}(\\+|$)") func (h *proxyHandler) Get(resp http.ResponseWriter, req *http.Request) { if err := h.checkLoop(resp, req); err != nil { return } setCORSHeaders(resp) resp.Header().Set("Via", req.Proto+" "+viaAlias) locator := mux.Vars(req)["locator"] var err error var status int var expectLength, responseLength int64 var proxiedURI = "-" logger := ctxlog.FromContext(req.Context()) defer func() { 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) } }() kc := h.makeKeepClient(req) var pass bool var tok string 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 arvclient.ApiToken = tok kc.Arvados = &arvclient var reader io.ReadCloser locator = removeHint.ReplaceAllString(locator, "$1") switch req.Method { case "HEAD": expectLength, proxiedURI, err = kc.Ask(locator) case "GET": reader, expectLength, proxiedURI, err = kc.Get(locator) if reader != nil { defer reader.Close() } default: status, err = http.StatusNotImplemented, errMethodNotSupported return } if expectLength == -1 { logger.Warn("Content-Length not provided") } switch respErr := err.(type) { case nil: status = http.StatusOK resp.Header().Set("Content-Length", fmt.Sprint(expectLength)) switch req.Method { case "HEAD": responseLength = 0 case "GET": responseLength, err = io.Copy(resp, reader) if err == nil && expectLength > -1 && responseLength != expectLength { err = errContentLengthMismatch } } case keepclient.Error: if respErr == keepclient.BlockNotFound { status = http.StatusNotFound } else if respErr.Temporary() { status = http.StatusBadGateway } else { status = 422 } default: status = http.StatusInternalServerError } } 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) resp.Header().Set("Via", "HTTP/1.1 "+viaAlias) kc := h.makeKeepClient(req) var err error var expectLength int64 var status = http.StatusInternalServerError var wroteReplicas int var locatorOut string = "-" defer func() { 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) } }() locatorIn := mux.Vars(req)["locator"] // Check if the client specified storage classes if req.Header.Get("X-Keep-Storage-Classes") != "" { var scl []string for _, sc := range strings.Split(req.Header.Get("X-Keep-Storage-Classes"), ",") { scl = append(scl, strings.Trim(sc, " ")) } kc.SetStorageClasses(scl) } _, err = fmt.Sscanf(req.Header.Get("Content-Length"), "%d", &expectLength) if err != nil || expectLength < 0 { err = errLengthRequired status = http.StatusLengthRequired return } if locatorIn != "" { var loc *keepclient.Locator if loc, err = keepclient.MakeLocator(locatorIn); err != nil { status = http.StatusBadRequest return } else if loc.Size > 0 && int64(loc.Size) != expectLength { err = errLengthMismatch status = http.StatusBadRequest return } } var pass bool var tok string 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 arvclient.ApiToken = tok kc.Arvados = &arvclient // Check if the client specified the number of replicas if desiredReplicas := req.Header.Get(keepclient.XKeepDesiredReplicas); desiredReplicas != "" { var r int _, err := fmt.Sscanf(desiredReplicas, "%d", &r) if err == nil { kc.Want_replicas = r } } // Now try to put the block through if locatorIn == "" { bytes, err2 := ioutil.ReadAll(req.Body) if err2 != nil { err = fmt.Errorf("Error reading request body: %s", err2) status = http.StatusInternalServerError return } locatorOut, wroteReplicas, err = kc.PutB(bytes) } else { locatorOut, wroteReplicas, err = kc.PutHR(locatorIn, req.Body, expectLength) } // Tell the client how many successful PUTs we accomplished 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: status = http.StatusServiceUnavailable default: status = http.StatusBadGateway } } // ServeHTTP implementation for IndexHandler // Supports only GET requests for /index/{prefix:[0-9a-f]{0,32}} // For each keep server found in LocalRoots: // Invokes GetIndex using keepclient // Expects "complete" response (terminating with blank new line) // 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) prefix := mux.Vars(req)["prefix"] var err error var status int defer func() { if status != http.StatusOK { http.Error(resp, err.Error(), status) } }() kc := h.makeKeepClient(req) ok, token, _ := h.checkAuthorizationHeader(req) if !ok { status, err = http.StatusForbidden, errBadAuthorizationHeader return } // Copy ArvadosClient struct and use the client's API token arvclient := *kc.Arvados arvclient.ApiToken = token kc.Arvados = &arvclient // Only GET method is supported if req.Method != "GET" { status, err = http.StatusNotImplemented, errMethodNotSupported return } // Get index from all LocalRoots and write to resp var reader io.Reader for uuid := range kc.LocalRoots() { reader, err = kc.GetIndex(uuid, prefix) if err != nil { status = http.StatusBadGateway return } _, err = io.Copy(resp, reader) if err != nil { status = http.StatusBadGateway return } } // Got index from all the keep servers and wrote to resp status = http.StatusOK resp.Write([]byte("\n")) } func (h *proxyHandler) makeKeepClient(req *http.Request) *keepclient.KeepClient { kc := *h.KeepClient kc.RequestID = req.Header.Get("X-Request-Id") kc.HTTPClient = &proxyClient{ client: &http.Client{ Timeout: h.timeout, Transport: h.transport, }, proto: req.Proto, } return &kc }