Merge branch '8784-dir-listings'
[arvados.git] / services / ws / permission.go
index b2b962c7ce4f1662bace01daac24cb1035fc772f..b40c1fa1863219048a2ba70f8b2afb1ffc394391 100644 (file)
@@ -1,3 +1,7 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
 package main
 
 import (
@@ -18,50 +22,82 @@ type permChecker interface {
        Check(uuid string) (bool, error)
 }
 
-func NewPermChecker(ac arvados.Client) permChecker {
+func newPermChecker(ac arvados.Client) permChecker {
        ac.AuthToken = ""
        return &cachingPermChecker{
                Client:     &ac,
-               cache:      make(map[string]time.Time),
+               cache:      make(map[string]cacheEnt),
                maxCurrent: 16,
        }
 }
 
+type cacheEnt struct {
+       time.Time
+       allowed bool
+}
+
 type cachingPermChecker struct {
        *arvados.Client
-       cache      map[string]time.Time
+       cache      map[string]cacheEnt
        maxCurrent int
+
+       nChecks  uint64
+       nMisses  uint64
+       nInvalid uint64
 }
 
 func (pc *cachingPermChecker) SetToken(token string) {
+       if pc.Client.AuthToken == token {
+               return
+       }
        pc.Client.AuthToken = token
+       pc.cache = make(map[string]cacheEnt)
 }
 
 func (pc *cachingPermChecker) Check(uuid string) (bool, error) {
+       pc.nChecks++
+       logger := logger(nil).
+               WithField("token", pc.Client.AuthToken).
+               WithField("uuid", uuid)
        pc.tidy()
-       if t, ok := pc.cache[uuid]; ok && time.Now().Sub(t) < maxPermCacheAge {
-               debugLogf("perm ok (cached): %+q %+q", pc.Client.AuthToken, uuid)
-               return true, nil
+       now := time.Now()
+       if perm, ok := pc.cache[uuid]; ok && now.Sub(perm.Time) < maxPermCacheAge {
+               logger.WithField("allowed", perm.allowed).Debug("cache hit")
+               return perm.allowed, nil
        }
        var buf map[string]interface{}
        path, err := pc.PathForUUID("get", uuid)
        if err != nil {
+               pc.nInvalid++
                return false, err
        }
+
+       pc.nMisses++
        err = pc.RequestAndDecode(&buf, "GET", path, nil, url.Values{
                "select": {`["uuid"]`},
        })
-       if err, ok := err.(arvados.TransactionError); ok && err.StatusCode == http.StatusNotFound {
-               debugLogf("perm err: %+q %+q: %s", pc.Client.AuthToken, uuid, err)
-               return false, nil
-       }
-       if err != nil {
-               debugLogf("perm !ok: %+q %+q", pc.Client.AuthToken, uuid)
+
+       var allowed bool
+       if err == nil {
+               allowed = true
+       } else if txErr, ok := err.(*arvados.TransactionError); ok && pc.isNotAllowed(txErr.StatusCode) {
+               allowed = false
+       } else {
+               logger.WithError(err).Error("lookup error")
                return false, err
        }
-       debugLogf("perm ok: %+q %+q", pc.Client.AuthToken, uuid)
-       pc.cache[uuid] = time.Now()
-       return true, nil
+       logger.WithField("allowed", allowed).Debug("cache miss")
+       pc.cache[uuid] = cacheEnt{Time: now, allowed: allowed}
+       return allowed, nil
+}
+
+func (pc *cachingPermChecker) isNotAllowed(status int) bool {
+       switch status {
+       case http.StatusForbidden, http.StatusUnauthorized, http.StatusNotFound:
+               return true
+       default:
+               return false
+       }
 }
 
 func (pc *cachingPermChecker) tidy() {