X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/21006cfaf6d4d0ac3884a72803a8723bc4bb76fb..59a972c831bc8f7cd4e896ed8e1c71277b97f04e:/services/keepproxy/keepproxy.go diff --git a/services/keepproxy/keepproxy.go b/services/keepproxy/keepproxy.go index 79ed51eb0e..2b15d79940 100644 --- a/services/keepproxy/keepproxy.go +++ b/services/keepproxy/keepproxy.go @@ -1,117 +1,149 @@ +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: AGPL-3.0 + package main import ( "errors" "flag" "fmt" - "git.curoverse.com/arvados.git/sdk/go/arvadosclient" - "git.curoverse.com/arvados.git/sdk/go/keepclient" - "github.com/gorilla/mux" "io" "io/ioutil" - "log" "net" "net/http" "os" "os/signal" - "reflect" "regexp" + "strings" "sync" "syscall" "time" + + "git.arvados.org/arvados.git/lib/config" + "git.arvados.org/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/arvadosclient" + "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/coreos/go-systemd/daemon" + "github.com/ghodss/yaml" + "github.com/gorilla/mux" + log "github.com/sirupsen/logrus" +) + +var version = "dev" + +var ( + listener net.Listener + router http.Handler ) -// Default TCP address on which to listen for requests. -// Initialized by the -listen flag. -const DEFAULT_ADDR = ":25107" +const rfc3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00" -var listener net.Listener +func configure(logger log.FieldLogger, args []string) (*arvados.Cluster, error) { + flags := flag.NewFlagSet(args[0], flag.ExitOnError) -func main() { - var ( - listen string - no_get bool - no_put bool - default_replicas int - timeout int64 - pidfile string - ) - - flagset := flag.NewFlagSet("keepproxy", flag.ExitOnError) - - flagset.StringVar( - &listen, - "listen", - DEFAULT_ADDR, - "Interface on which to listen for requests, in the format "+ - "ipaddr:port. e.g. -listen=10.0.1.24:8000. Use -listen=:port "+ - "to listen on all network interfaces.") - - flagset.BoolVar( - &no_get, - "no-get", - false, - "If set, disable GET operations") - - flagset.BoolVar( - &no_put, - "no-put", - false, - "If set, disable PUT operations") - - flagset.IntVar( - &default_replicas, - "default-replicas", - 2, - "Default number of replicas to write if not specified by the client.") - - flagset.Int64Var( - &timeout, - "timeout", - 15, - "Timeout on requests to internal Keep services (default 15 seconds)") - - flagset.StringVar( - &pidfile, - "pid", - "", - "Path to write pid file") - - flagset.Parse(os.Args[1:]) - - arv, err := arvadosclient.MakeArvadosClient() - if err != nil { - log.Fatalf("Error setting up arvados client %s", err.Error()) + dumpConfig := flags.Bool("dump-config", false, "write current configuration to stdout and exit") + getVersion := flags.Bool("version", false, "Print version information and exit.") + + loader := config.NewLoader(os.Stdin, logger) + loader.SetupFlags(flags) + + args = loader.MungeLegacyConfigArgs(logger, args[1:], "-legacy-keepproxy-config") + flags.Parse(args) + + // Print version information if requested + if *getVersion { + fmt.Printf("keepproxy %s\n", version) + return nil, nil } - if os.Getenv("ARVADOS_DEBUG") != "" { - keepclient.DebugPrintf = log.Printf + cfg, err := loader.Load() + if err != nil { + return nil, err } - kc, err := keepclient.MakeKeepClient(&arv) + cluster, err := cfg.GetCluster("") if err != nil { - log.Fatalf("Error setting up keep client %s", err.Error()) + return nil, err } - if pidfile != "" { - f, err := os.Create(pidfile) + if *dumpConfig { + out, err := yaml.Marshal(cfg) if err != nil { - log.Fatalf("Error writing pid file (%s): %s", pidfile, err.Error()) + return nil, err } - fmt.Fprint(f, os.Getpid()) - f.Close() - defer os.Remove(pidfile) + if _, err := os.Stdout.Write(out); err != nil { + return nil, err + } + return nil, nil + } + return cluster, nil +} + +func main() { + logger := log.New() + logger.Formatter = &log.JSONFormatter{ + TimestampFormat: rfc3339NanoFixed, + } + + cluster, err := configure(logger, os.Args) + if err != nil { + log.Fatal(err) + } + if cluster == nil { + return + } + + log.Printf("keepproxy %s started", version) + + if err := run(logger, cluster); err != nil { + log.Fatal(err) } - kc.Want_replicas = default_replicas + log.Println("shutting down") +} + +func run(logger log.FieldLogger, cluster *arvados.Cluster) error { + client, err := arvados.NewClientFromConfig(cluster) + if err != nil { + return err + } + client.AuthToken = cluster.SystemRootToken - kc.Client.Timeout = time.Duration(timeout) * time.Second + arv, err := arvadosclient.New(client) + if err != nil { + return fmt.Errorf("Error setting up arvados client %v", err) + } - listener, err = net.Listen("tcp", listen) + if cluster.SystemLogs.LogLevel == "debug" { + keepclient.DebugPrintf = log.Printf + } + kc, err := keepclient.MakeKeepClient(arv) if err != nil { - log.Fatalf("Could not listen on %v", listen) + return fmt.Errorf("Error setting up keep client %v", err) + } + keepclient.RefreshServiceDiscoveryOnSIGHUP() + + if cluster.Collections.DefaultReplication > 0 { + kc.Want_replicas = cluster.Collections.DefaultReplication + } + + var listen arvados.URL + for listen = range cluster.Services.Keepproxy.InternalURLs { + break + } + + var lErr error + listener, lErr = net.Listen("tcp", listen.Host) + if lErr != nil { + return fmt.Errorf("listen(%s): %v", listen.Host, lErr) } - go RefreshServicesList(kc) + if _, err := daemon.SdNotify(false, "READY=1"); err != nil { + log.Printf("Error notifying init daemon: %v", err) + } + log.Println("listening at", listener.Addr()) // Shut down the server gracefully (by closing the listener) // if SIGTERM is received. @@ -124,12 +156,9 @@ func main() { signal.Notify(term, syscall.SIGTERM) signal.Notify(term, syscall.SIGINT) - log.Printf("Arvados Keep proxy started listening on %v", listener.Addr()) - - // Start listening for requests. - http.Serve(listener, MakeRESTRouter(!no_get, !no_put, kc)) - - log.Println("shutting down") + // Start serving requests. + router = MakeRESTRouter(kc, time.Duration(cluster.API.KeepServiceRequestTimeout), cluster.ManagementToken) + return http.Serve(listener, httpserver.AddRequestIDs(httpserver.LogRequests(router))) } type ApiTokenCache struct { @@ -138,30 +167,6 @@ type ApiTokenCache struct { expireTime int64 } -// Refresh the keep service list every five minutes. -func RefreshServicesList(kc *keepclient.KeepClient) { - var previousRoots = []map[string]string{} - var delay time.Duration = 0 - for { - time.Sleep(delay * time.Second) - delay = 300 - if err := kc.DiscoverKeepServers(); err != nil { - log.Println("Error retrieving services list:", err) - delay = 3 - continue - } - newRoots := []map[string]string{kc.LocalRoots(), kc.GatewayRoots()} - if !reflect.DeepEqual(previousRoots, newRoots) { - log.Printf("Updated services list: locals %v gateways %v", newRoots[0], newRoots[1]) - } - if len(newRoots[0]) == 0 { - log.Print("WARNING: No local services. Retrying in 3 seconds.") - delay = 3 - } - previousRoots = newRoots - } -} - // 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) { @@ -194,101 +199,129 @@ func (this *ApiTokenCache) RecallToken(token string) bool { } func GetRemoteAddress(req *http.Request) string { - if realip := req.Header.Get("X-Real-IP"); realip != "" { - if forwarded := req.Header.Get("X-Forwarded-For"); forwarded != realip { - return fmt.Sprintf("%s (X-Forwarded-For %s)", realip, forwarded) - } else { - return realip - } + if xff := req.Header.Get("X-Forwarded-For"); xff != "" { + return xff + "," + req.RemoteAddr } return req.RemoteAddr } func CheckAuthorizationHeader(kc *keepclient.KeepClient, cache *ApiTokenCache, req *http.Request) (pass bool, tok string) { - var auth string - if auth = req.Header.Get("Authorization"); auth == "" { + parts := strings.SplitN(req.Header.Get("Authorization"), " ", 2) + if len(parts) < 2 || !(parts[0] == "OAuth2" || parts[0] == "Bearer") || len(parts[1]) == 0 { return false, "" } - - _, err := fmt.Sscanf(auth, "OAuth2 %s", &tok) - if err != nil { - // Scanning error - return false, "" + 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 cache.RecallToken(tok) { - // Valid in the cache, short circut + if cache.RecallToken(op + ":" + tok) { + // Valid in the cache, short circuit return true, tok } + var err error arv := *kc.Arvados arv.ApiToken = tok - if err := arv.Call("HEAD", "users", "", "current", nil, nil); err != nil { + 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) + } + if err != nil { log.Printf("%s: CheckAuthorizationHeader error: %v", GetRemoteAddress(req), err) return false, "" } // Success! Update cache - cache.RememberToken(tok) + cache.RememberToken(op + ":" + tok) return true, tok } -type GetBlockHandler struct { - *keepclient.KeepClient - *ApiTokenCache -} +// 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 PutBlockHandler struct { +type proxyHandler struct { + http.Handler *keepclient.KeepClient *ApiTokenCache + timeout time.Duration + transport *http.Transport } -type IndexHandler struct { - *keepclient.KeepClient - *ApiTokenCache -} +// MakeRESTRouter returns an http.Handler that passes GET and PUT +// requests to the appropriate handlers. +func MakeRESTRouter(kc *keepclient.KeepClient, timeout time.Duration, mgmtToken string) http.Handler { + rest := mux.NewRouter() -type InvalidPathHandler struct{} + 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 + + h := &proxyHandler{ + Handler: rest, + KeepClient: kc, + timeout: timeout, + transport: &transport, + ApiTokenCache: &ApiTokenCache{ + tokens: make(map[string]int64), + expireTime: 300, + }, + } -type OptionsHandler struct{} + rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Get).Methods("GET", "HEAD") + rest.HandleFunc(`/{locator:[0-9a-f]{32}}`, h.Get).Methods("GET", "HEAD") -// MakeRESTRouter -// Returns a mux.Router that passes GET and PUT requests to the -// appropriate handlers. -// -func MakeRESTRouter( - enable_get bool, - enable_put bool, - kc *keepclient.KeepClient) *mux.Router { + // List all blocks + rest.HandleFunc(`/index`, h.Index).Methods("GET") - t := &ApiTokenCache{tokens: make(map[string]int64), expireTime: 300} + // List blocks whose hash has the given prefix + rest.HandleFunc(`/index/{prefix:[0-9a-f]{0,32}}`, h.Index).Methods("GET") - rest := mux.NewRouter() + 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") - if enable_get { - rest.Handle(`/{locator:[0-9a-f]{32}\+.*}`, - GetBlockHandler{kc, t}).Methods("GET", "HEAD") - rest.Handle(`/{locator:[0-9a-f]{32}}`, GetBlockHandler{kc, t}).Methods("GET", "HEAD") + rest.Handle("/_health/{check}", &health.Handler{ + Token: mgmtToken, + Prefix: "/_health/", + }).Methods("GET") - // List all blocks - rest.Handle(`/index`, IndexHandler{kc, t}).Methods("GET") + rest.NotFoundHandler = InvalidPathHandler{} + return h +} - // List blocks whose hash has the given prefix - rest.Handle(`/index/{prefix:[0-9a-f]{0,32}}`, IndexHandler{kc, t}).Methods("GET") - } +var errLoopDetected = errors.New("loop detected") - if enable_put { - rest.Handle(`/{locator:[0-9a-f]{32}\+.*}`, PutBlockHandler{kc, t}).Methods("PUT") - rest.Handle(`/{locator:[0-9a-f]{32}}`, PutBlockHandler{kc, t}).Methods("PUT") - rest.Handle(`/`, PutBlockHandler{kc, t}).Methods("POST") - rest.Handle(`/{any}`, OptionsHandler{}).Methods("OPTIONS") - rest.Handle(`/`, OptionsHandler{}).Methods("OPTIONS") +func (*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) + http.Error(resp, errLoopDetected.Error(), http.StatusInternalServerError) + return errLoopDetected } - - rest.NotFoundHandler = InvalidPathHandler{} - - return rest + return nil } func SetCorsHeaders(resp http.ResponseWriter) { @@ -298,12 +331,14 @@ func SetCorsHeaders(resp http.ResponseWriter) { resp.Header().Set("Access-Control-Max-Age", "86486400") } -func (this InvalidPathHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) { +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) http.Error(resp, "Bad request", http.StatusBadRequest) } -func (this OptionsHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) { +func (h *proxyHandler) Options(resp http.ResponseWriter, req *http.Request) { log.Printf("%s: %s %s", GetRemoteAddress(req), req.Method, req.URL.Path) SetCorsHeaders(resp) } @@ -314,8 +349,12 @@ var MethodNotSupported = errors.New("Method not supported") var removeHint, _ = regexp.Compile("\\+K@[a-z0-9]{5}(\\+|$)") -func (this GetBlockHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) { +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 @@ -330,11 +369,11 @@ func (this GetBlockHandler) ServeHTTP(resp http.ResponseWriter, req *http.Reques } }() - kc := *this.KeepClient + kc := h.makeKeepClient(req) var pass bool var tok string - if pass, tok = CheckAuthorizationHeader(&kc, this.ApiTokenCache, req); !pass { + if pass, tok = CheckAuthorizationHeader(kc, h.ApiTokenCache, req); !pass { status, err = http.StatusForbidden, BadAuthorizationHeader return } @@ -394,12 +433,17 @@ func (this GetBlockHandler) ServeHTTP(resp http.ResponseWriter, req *http.Reques var LengthRequiredError = errors.New(http.StatusText(http.StatusLengthRequired)) var LengthMismatchError = errors.New("Locator size hint does not match Content-Length header") -func (this PutBlockHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) { +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) - kc := *this.KeepClient var err error - var expectLength int64 = -1 + var expectLength int64 var status = http.StatusInternalServerError var wroteReplicas int var locatorOut string = "-" @@ -413,15 +457,17 @@ func (this PutBlockHandler) ServeHTTP(resp http.ResponseWriter, req *http.Reques locatorIn := mux.Vars(req)["locator"] - if req.Header.Get("Content-Length") != "" { - _, err := fmt.Sscanf(req.Header.Get("Content-Length"), "%d", &expectLength) - if err != nil { - resp.Header().Set("Content-Length", fmt.Sprintf("%d", expectLength)) + // 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.StorageClasses = scl } - if expectLength < 0 { + _, err = fmt.Sscanf(req.Header.Get("Content-Length"), "%d", &expectLength) + if err != nil || expectLength < 0 { err = LengthRequiredError status = http.StatusLengthRequired return @@ -441,7 +487,7 @@ func (this PutBlockHandler) ServeHTTP(resp http.ResponseWriter, req *http.Reques var pass bool var tok string - if pass, tok = CheckAuthorizationHeader(&kc, this.ApiTokenCache, req); !pass { + if pass, tok = CheckAuthorizationHeader(kc, h.ApiTokenCache, req); !pass { err = BadAuthorizationHeader status = http.StatusForbidden return @@ -456,20 +502,20 @@ func (this PutBlockHandler) ServeHTTP(resp http.ResponseWriter, req *http.Reques if req.Header.Get("X-Keep-Desired-Replicas") != "" { var r int _, err := fmt.Sscanf(req.Header.Get(keepclient.X_Keep_Desired_Replicas), "%d", &r) - if err != nil { + if err == nil { kc.Want_replicas = r } } // Now try to put the block through if locatorIn == "" { - if bytes, err := ioutil.ReadAll(req.Body); err != nil { - err = errors.New(fmt.Sprintf("Error reading request body: %s", err)) + bytes, err2 := ioutil.ReadAll(req.Body) + if err2 != nil { + err = fmt.Errorf("Error reading request body: %s", err2) status = http.StatusInternalServerError return - } else { - locatorOut, wroteReplicas, err = kc.PutB(bytes) } + locatorOut, wroteReplicas, err = kc.PutB(bytes) } else { locatorOut, wroteReplicas, err = kc.PutHR(locatorIn, req.Body, expectLength) } @@ -477,7 +523,7 @@ func (this PutBlockHandler) ServeHTTP(resp http.ResponseWriter, req *http.Reques // Tell the client how many successful PUTs we accomplished resp.Header().Set(keepclient.X_Keep_Replicas_Stored, fmt.Sprintf("%d", wroteReplicas)) - switch err { + switch err.(type) { case nil: status = http.StatusOK _, err = io.WriteString(resp, locatorOut) @@ -509,7 +555,7 @@ func (this PutBlockHandler) ServeHTTP(resp http.ResponseWriter, req *http.Reques // Expects "complete" response (terminating with blank new line) // Aborts on any errors // Concatenates responses from all those keep servers and returns -func (handler IndexHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request) { +func (h *proxyHandler) Index(resp http.ResponseWriter, req *http.Request) { SetCorsHeaders(resp) prefix := mux.Vars(req)["prefix"] @@ -522,9 +568,8 @@ func (handler IndexHandler) ServeHTTP(resp http.ResponseWriter, req *http.Reques } }() - kc := *handler.KeepClient - - ok, token := CheckAuthorizationHeader(&kc, handler.ApiTokenCache, req) + kc := h.makeKeepClient(req) + ok, token := CheckAuthorizationHeader(kc, h.ApiTokenCache, req) if !ok { status, err = http.StatusForbidden, BadAuthorizationHeader return @@ -561,3 +606,16 @@ func (handler IndexHandler) ServeHTTP(resp http.ResponseWriter, req *http.Reques 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 +}