mirror of
https://github.com/goharbor/harbor.git
synced 2024-11-05 01:59:44 +01:00
Merge pull request #12496 from reasonerjt/secret-mgr-proxycache
Provide secret manager for proxy cache project
This commit is contained in:
commit
4170b267a1
153
src/pkg/proxy/secret/manager.go
Normal file
153
src/pkg/proxy/secret/manager.go
Normal file
@ -0,0 +1,153 @@
|
||||
package secret
|
||||
|
||||
import (
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
|
||||
"github.com/goharbor/harbor/src/common/utils"
|
||||
"github.com/goharbor/harbor/src/lib/log"
|
||||
)
|
||||
|
||||
const (
|
||||
defaultExpiration = 15 * time.Second
|
||||
defaultGCInterval = 10 * time.Second
|
||||
defaultCap uint64 = 1024 * 1024
|
||||
)
|
||||
|
||||
type targetRepository struct {
|
||||
name string
|
||||
expiresAt time.Time
|
||||
}
|
||||
|
||||
// Manager generates and verifies the secret for repositories under proxy project
|
||||
// The secret normally is used for authorizing a request trying to push artifact to a project
|
||||
// A secret can be used only once and expires in a short period of time.
|
||||
// As the request will be sent to 127.0.0.1 so the secret will live in one process.
|
||||
type Manager interface {
|
||||
// Generate generates a secret for the given repository, sample value for repository: "library/ubuntu"
|
||||
Generate(repository string) string
|
||||
// Verify verifies the secret against repo name, after the verification the secret should be invalid
|
||||
Verify(secret, repository string) bool
|
||||
}
|
||||
|
||||
type flag struct {
|
||||
v uint32
|
||||
}
|
||||
|
||||
func (f *flag) grab() bool {
|
||||
return atomic.CompareAndSwapUint32(&f.v, 0, 1)
|
||||
}
|
||||
|
||||
func (f *flag) release() {
|
||||
atomic.StoreUint32(&f.v, 0)
|
||||
}
|
||||
|
||||
type mgr struct {
|
||||
gcFlag *flag
|
||||
gcScheduleFlag *flag
|
||||
// the minimal interval for gc
|
||||
gcInterval time.Duration
|
||||
lastGC time.Time
|
||||
// the size of the map, it must be read and write via atomic
|
||||
size uint64
|
||||
// the capacity of the map, if the size is above the cap the gc will be triggered
|
||||
cap uint64
|
||||
m *sync.Map
|
||||
lock sync.Mutex
|
||||
exp time.Duration
|
||||
}
|
||||
|
||||
func (man *mgr) Generate(rn string) string {
|
||||
if atomic.LoadUint64(&man.size) > man.cap {
|
||||
man.gc()
|
||||
}
|
||||
s := utils.GenerateRandomStringWithLen(8)
|
||||
man.m.Store(s, targetRepository{name: rn, expiresAt: time.Now().Add(man.exp)})
|
||||
atomic.AddUint64(&man.size, 1)
|
||||
return s
|
||||
}
|
||||
|
||||
func (man *mgr) Verify(sec, rn string) bool {
|
||||
v, ok := man.m.Load(sec)
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
p, ok := v.(targetRepository)
|
||||
if ok && p.name == rn {
|
||||
defer man.delete(sec)
|
||||
return p.expiresAt.After(time.Now())
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func (man *mgr) delete(sec string) {
|
||||
if _, ok := man.m.Load(sec); ok {
|
||||
man.lock.Lock()
|
||||
defer man.lock.Unlock()
|
||||
if _, ok := man.m.Load(sec); ok {
|
||||
man.m.Delete(sec)
|
||||
atomic.AddUint64(&man.size, ^uint64(0))
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
// gc removes the expired entries so it's possible that after running gc the size is still larger than cap
|
||||
// If that happens it will try to start a go routine to run another gc
|
||||
func (man *mgr) gc() {
|
||||
if !man.gcFlag.grab() {
|
||||
log.Debugf("There is GC in progress, skip")
|
||||
return
|
||||
}
|
||||
defer func() {
|
||||
if atomic.LoadUint64(&man.size) > man.cap && man.gcScheduleFlag.grab() {
|
||||
log.Debugf("Size is still larger than cap, schedule a gc in next cycle")
|
||||
go func() {
|
||||
time.Sleep(man.gcInterval)
|
||||
man.gcScheduleFlag.release()
|
||||
man.gc()
|
||||
}()
|
||||
}
|
||||
man.gcFlag.release()
|
||||
}()
|
||||
if time.Now().Before(man.lastGC.Add(man.gcInterval)) {
|
||||
log.Debugf("Skip too frequent GC, last one: %v, ", man.lastGC)
|
||||
return
|
||||
}
|
||||
log.Debugf("Running GC on secret map...")
|
||||
man.m.Range(func(k, v interface{}) bool {
|
||||
repoV, ok := v.(targetRepository)
|
||||
if ok && repoV.expiresAt.Before(time.Now()) {
|
||||
log.Debugf("Removed expire secret: %s, repo: %s", k, repoV.name)
|
||||
man.delete(k.(string))
|
||||
}
|
||||
return true
|
||||
})
|
||||
man.lastGC = time.Now()
|
||||
log.Debugf("GC on secret map finished.")
|
||||
}
|
||||
|
||||
var (
|
||||
defaultManager Manager
|
||||
once sync.Once
|
||||
)
|
||||
|
||||
// GetManager returns the default manager which is a singleton in the package
|
||||
func GetManager() Manager {
|
||||
once.Do(func() {
|
||||
defaultManager = createManager(defaultExpiration, defaultCap, defaultGCInterval)
|
||||
})
|
||||
return defaultManager
|
||||
}
|
||||
|
||||
func createManager(d time.Duration, c uint64, interval time.Duration) Manager {
|
||||
return &mgr{
|
||||
m: &sync.Map{},
|
||||
exp: d,
|
||||
cap: c,
|
||||
gcInterval: interval,
|
||||
gcFlag: &flag{},
|
||||
gcScheduleFlag: &flag{},
|
||||
}
|
||||
}
|
53
src/pkg/proxy/secret/manager_test.go
Normal file
53
src/pkg/proxy/secret/manager_test.go
Normal file
@ -0,0 +1,53 @@
|
||||
package secret
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestManger(t *testing.T) {
|
||||
manager := GetManager()
|
||||
rn1 := "project1/golang"
|
||||
assert.False(t, manager.Verify("whatever", rn1))
|
||||
s1 := manager.Generate(rn1)
|
||||
s2 := manager.Generate(rn1)
|
||||
assert.False(t, s1 == s2)
|
||||
|
||||
assert.False(t, manager.Verify(s1, "project1/donotexist"))
|
||||
assert.True(t, manager.Verify(s1, rn1))
|
||||
// A secret can be used only once.
|
||||
assert.False(t, manager.Verify(s1, rn1))
|
||||
manager2 := GetManager()
|
||||
assert.Equal(t, manager2, manager)
|
||||
}
|
||||
|
||||
func TestExpiration(t *testing.T) {
|
||||
manager := createManager(1*time.Second, defaultCap, defaultGCInterval)
|
||||
rn1 := "project1/golang"
|
||||
s := manager.Generate(rn1)
|
||||
// Sleep till the secret expires
|
||||
time.Sleep(2 * time.Second)
|
||||
assert.False(t, manager.Verify(s, rn1))
|
||||
}
|
||||
|
||||
func TestGC(t *testing.T) {
|
||||
manager := createManager(1*time.Second, 10, 1*time.Second).(*mgr)
|
||||
for i := 0; i < 10; i++ {
|
||||
rn := fmt.Sprintf("project%d/golang", i)
|
||||
manager.Generate(rn)
|
||||
}
|
||||
time.Sleep(2 * time.Second)
|
||||
assert.Equal(t, uint64(10), manager.size)
|
||||
for i := 0; i < 1000; i++ {
|
||||
rn := fmt.Sprintf("project%d/redis", i)
|
||||
manager.Generate(rn)
|
||||
}
|
||||
assert.Equal(t, uint64(1000), atomic.LoadUint64(&manager.size))
|
||||
time.Sleep(4 * time.Second)
|
||||
assert.Equal(t, uint64(0), atomic.LoadUint64(&manager.size))
|
||||
|
||||
}
|
Loading…
Reference in New Issue
Block a user