X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/100ae537a8329048452c656229750b97c78a3296..a271aaf8e345f8035a8818cee15868bd1c38ceb0:/services/keepproxy/keepproxy.go diff --git a/services/keepproxy/keepproxy.go b/services/keepproxy/keepproxy.go index f75079565b..df6e06a741 100644 --- a/services/keepproxy/keepproxy.go +++ b/services/keepproxy/keepproxy.go @@ -20,16 +20,16 @@ import ( "syscall" "time" - "git.curoverse.com/arvados.git/lib/config" - "git.curoverse.com/arvados.git/sdk/go/arvados" - "git.curoverse.com/arvados.git/sdk/go/arvadosclient" - "git.curoverse.com/arvados.git/sdk/go/health" - "git.curoverse.com/arvados.git/sdk/go/httpserver" - "git.curoverse.com/arvados.git/sdk/go/keepclient" + "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" - "gopkg.in/yaml.v2" ) var version = "dev" @@ -41,9 +41,8 @@ var ( const rfc3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00" -func configure(logger log.FieldLogger, args []string) *arvados.Cluster { +func configure(logger log.FieldLogger, args []string) (*arvados.Cluster, error) { flags := flag.NewFlagSet(args[0], flag.ExitOnError) - flags.Usage = usage dumpConfig := flags.Bool("dump-config", false, "write current configuration to stdout and exit") getVersion := flags.Bool("version", false, "Print version information and exit.") @@ -57,31 +56,29 @@ func configure(logger log.FieldLogger, args []string) *arvados.Cluster { // Print version information if requested if *getVersion { fmt.Printf("keepproxy %s\n", version) - return nil + return nil, nil } cfg, err := loader.Load() if err != nil { - log.Fatal(err) + return nil, err } - cluster, err := cfg.GetCluster("") if err != nil { - log.Fatal(err) + return nil, err } if *dumpConfig { out, err := yaml.Marshal(cfg) if err != nil { - log.Fatal(err) + return nil, err } - _, err = os.Stdout.Write(out) - if err != nil { - log.Fatal(err) + if _, err := os.Stdout.Write(out); err != nil { + return nil, err } - return nil + return nil, nil } - return cluster + return cluster, nil } func main() { @@ -90,22 +87,39 @@ func main() { TimestampFormat: rfc3339NanoFixed, } - cluster := configure(logger, os.Args) + 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) + } + + log.Println("shutting down") +} + +func run(logger log.FieldLogger, cluster *arvados.Cluster) error { client, err := arvados.NewClientFromConfig(cluster) if err != nil { - log.Fatal(err) + return err } client.AuthToken = cluster.SystemRootToken arv, err := arvadosclient.New(client) if err != nil { - log.Fatalf("Error setting up arvados client %s", err.Error()) + return fmt.Errorf("Error setting up arvados client %v", err) + } + + // If a config file is available, use the keepstores defined there + // instead of the legacy autodiscover mechanism via the API server + for k := range cluster.Services.Keepstore.InternalURLs { + arv.KeepServiceURIs = append(arv.KeepServiceURIs, strings.TrimRight(k.String(), "/")) } if cluster.SystemLogs.LogLevel == "debug" { @@ -113,7 +127,7 @@ func main() { } kc, err := keepclient.MakeKeepClient(arv) if err != nil { - log.Fatalf("Error setting up keep client %s", err.Error()) + return fmt.Errorf("Error setting up keep client %v", err) } keepclient.RefreshServiceDiscoveryOnSIGHUP() @@ -125,15 +139,17 @@ func main() { for listen = range cluster.Services.Keepproxy.InternalURLs { break } - listener, err := net.Listen("tcp", listen.Host) - if err != nil { - log.Fatalf("listen(%s): %s", listen.Host, err) + + var lErr error + listener, lErr = net.Listen("tcp", listen.Host) + if lErr != nil { + return fmt.Errorf("listen(%s): %v", listen.Host, lErr) } if _, err := daemon.SdNotify(false, "READY=1"); err != nil { log.Printf("Error notifying init daemon: %v", err) } - log.Println("Listening at", listener.Addr()) + log.Println("listening at", listener.Addr()) // Shut down the server gracefully (by closing the listener) // if SIGTERM is received. @@ -147,49 +163,54 @@ func main() { signal.Notify(term, syscall.SIGINT) // Start serving requests. - router = MakeRESTRouter(kc, time.Duration(cluster.API.KeepServiceRequestTimeout), cluster.SystemRootToken) - http.Serve(listener, httpserver.AddRequestIDs(httpserver.LogRequests(router))) - - log.Println("shutting down") + router = MakeRESTRouter(kc, time.Duration(keepclient.DefaultProxyRequestTimeout), cluster, logger) + return http.Serve(listener, httpserver.AddRequestIDs(httpserver.LogRequests(router))) } -type ApiTokenCache struct { +type APITokenCache struct { tokens map[string]int64 + tokenUser map[string]*arvados.User lock sync.Mutex 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 we already have +// an expire time on the token, it is not updated. +func (cache *APITokenCache) RememberToken(token string, user *arvados.User) { + cache.lock.Lock() + defer cache.lock.Unlock() now := time.Now().Unix() - if this.tokens[token] == 0 { - this.tokens[token] = now + this.expireTime + if cache.tokens[token] == 0 { + cache.tokens[token] = now + cache.expireTime } + cache.tokenUser[token] = 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) { + cache.lock.Lock() + defer cache.lock.Unlock() now := time.Now().Unix() - if this.tokens[token] == 0 { + if cache.tokens[token] == 0 { // Unknown token - return false - } else if now < this.tokens[token] { + return false, nil + } else if now < cache.tokens[token] { // Token is known and still valid - return true + return true, cache.tokenUser[token] } else { // Token is expired - this.tokens[token] = 0 - return false + cache.tokens[token] = 0 + return false, nil } } +// GetRemoteAddress returns a string with the remote address for the request. +// If the X-Forwarded-For header is set and has a non-zero length, it returns a +// string made from a comma separated list of all the remote addresses, +// starting with the one(s) from the X-Forwarded-For header. func GetRemoteAddress(req *http.Request) string { if xff := req.Header.Get("X-Forwarded-For"); xff != "" { return xff + "," + req.RemoteAddr @@ -197,10 +218,10 @@ func GetRemoteAddress(req *http.Request) string { return req.RemoteAddr } -func CheckAuthorizationHeader(kc *keepclient.KeepClient, cache *ApiTokenCache, req *http.Request) (pass bool, tok string) { +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] @@ -215,29 +236,52 @@ 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") + user = &arvados.User{} + userCurrentError := arv.Call("GET", "users", "", "current", nil, user) if op == "read" { + // scoped token this will fail the user current check, + // but if it is a download operation and they can read + // the keep_services table, it's okay. err = arv.Call("HEAD", "keep_services", "", "accessible", nil, nil) } else { - err = arv.Call("HEAD", "users", "", "current", nil, nil) + err = userCurrentError } if err != nil { log.Printf("%s: CheckAuthorizationHeader error: %v", GetRemoteAddress(req), err) - return false, "" + 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 @@ -251,14 +295,16 @@ var defaultTransport = *(http.DefaultTransport.(*http.Transport)) type proxyHandler struct { http.Handler *keepclient.KeepClient - *ApiTokenCache + *APITokenCache timeout time.Duration transport *http.Transport + logger log.FieldLogger + cluster *arvados.Cluster } // 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 { +func MakeRESTRouter(kc *keepclient.KeepClient, timeout time.Duration, cluster *arvados.Cluster, logger log.FieldLogger) http.Handler { rest := mux.NewRouter() transport := defaultTransport @@ -275,10 +321,13 @@ func MakeRESTRouter(kc *keepclient.KeepClient, timeout time.Duration, mgmtToken KeepClient: kc, timeout: timeout, transport: &transport, - ApiTokenCache: &ApiTokenCache{ + APITokenCache: &APITokenCache{ tokens: make(map[string]int64), + tokenUser: make(map[string]*arvados.User), expireTime: 300, }, + logger: logger, + cluster: cluster, } rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Get).Methods("GET", "HEAD") @@ -297,7 +346,7 @@ func MakeRESTRouter(kc *keepclient.KeepClient, timeout time.Duration, mgmtToken rest.HandleFunc(`/`, h.Options).Methods("OPTIONS") rest.Handle("/_health/{check}", &health.Handler{ - Token: mgmtToken, + Token: cluster.ManagementToken, Prefix: "/_health/", }).Methods("GET") @@ -307,9 +356,9 @@ func MakeRESTRouter(kc *keepclient.KeepClient, timeout time.Duration, mgmtToken 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) + h.logger.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 } @@ -335,9 +384,9 @@ func (h *proxyHandler) Options(resp http.ResponseWriter, req *http.Request) { 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}(\\+|$)") @@ -365,8 +414,9 @@ 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 } @@ -379,6 +429,18 @@ func (h *proxyHandler) Get(resp http.ResponseWriter, req *http.Request) { locator = removeHint.ReplaceAllString(locator, "$1") + if locator != "" { + parts := strings.SplitN(locator, "+", 3) + if len(parts) >= 2 { + logger := h.logger + if user != nil { + logger = logger.WithField("user_uuid", user.UUID). + WithField("user_full_name", user.FullName) + } + logger.WithField("locator", fmt.Sprintf("%s+%s", parts[0], parts[1])).Infof("Block download") + } + } + switch req.Method { case "HEAD": expectLength, proxiedURI, err = kc.Ask(locator) @@ -388,7 +450,7 @@ 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 } @@ -406,7 +468,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: @@ -422,8 +484,8 @@ 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 { @@ -460,7 +522,7 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { _, err = fmt.Sscanf(req.Header.Get("Content-Length"), "%d", &expectLength) if err != nil || expectLength < 0 { - err = LengthRequiredError + err = errLengthRequired status = http.StatusLengthRequired return } @@ -471,7 +533,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 } @@ -479,8 +541,9 @@ 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 } @@ -493,7 +556,7 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { // Check if the client specified the number of replicas if req.Header.Get("X-Keep-Desired-Replicas") != "" { var r int - _, err := fmt.Sscanf(req.Header.Get(keepclient.X_Keep_Desired_Replicas), "%d", &r) + _, err := fmt.Sscanf(req.Header.Get(keepclient.XKeepDesiredReplicas), "%d", &r) if err == nil { kc.Want_replicas = r } @@ -512,8 +575,20 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { locatorOut, wroteReplicas, err = kc.PutHR(locatorIn, req.Body, expectLength) } + if locatorOut != "" { + parts := strings.SplitN(locatorOut, "+", 3) + if len(parts) >= 2 { + logger := h.logger + if user != nil { + logger = logger.WithField("user_uuid", user.UUID). + WithField("user_full_name", user.FullName) + } + logger.WithField("locator", fmt.Sprintf("%s+%s", parts[0], parts[1])).Infof("Block upload") + } + } + // 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: @@ -561,9 +636,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 } @@ -574,7 +649,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 }