-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
session.go
217 lines (188 loc) · 5.6 KB
/
session.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
// Copyright Project Harbor Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package session
import (
"context"
"errors"
"net/http"
"sync"
"time"
"github.com/beego/beego/v2/server/web/session"
"github.com/goharbor/harbor/src/lib/cache"
"github.com/goharbor/harbor/src/lib/cache/redis"
"github.com/goharbor/harbor/src/lib/config"
"github.com/goharbor/harbor/src/lib/log"
)
const (
// HarborProviderName is the harbor session provider name
HarborProviderName = "harbor"
)
var harborpder = &Provider{}
// Store redis session store
type Store struct {
c cache.Cache
sid string
lock sync.RWMutex
values map[interface{}]interface{}
maxlifetime int64
}
// Set value in redis session
func (rs *Store) Set(_ context.Context, key, value interface{}) error {
rs.lock.Lock()
defer rs.lock.Unlock()
rs.values[key] = value
return nil
}
// Get value in redis session
func (rs *Store) Get(_ context.Context, key interface{}) interface{} {
rs.lock.RLock()
defer rs.lock.RUnlock()
if v, ok := rs.values[key]; ok {
return v
}
return nil
}
// Delete value in redis session
func (rs *Store) Delete(_ context.Context, key interface{}) error {
rs.lock.Lock()
defer rs.lock.Unlock()
delete(rs.values, key)
return nil
}
// Flush clear all values in redis session
func (rs *Store) Flush(_ context.Context) error {
rs.lock.Lock()
defer rs.lock.Unlock()
rs.values = make(map[interface{}]interface{})
return nil
}
// SessionID get redis session id
func (rs *Store) SessionID(_ context.Context) string {
return rs.sid
}
// SessionRelease save session values to redis
func (rs *Store) SessionRelease(ctx context.Context, _ http.ResponseWriter) {
b, err := session.EncodeGob(rs.values)
if err != nil {
return
}
if ctx == nil {
ctx = context.TODO()
}
maxlifetime := time.Duration(systemSessionTimeout(ctx, rs.maxlifetime))
if rdb, ok := rs.c.(*redis.Cache); ok {
cmd := rdb.Client.Set(ctx, rs.sid, string(b), maxlifetime)
if cmd.Err() != nil {
log.Debugf("release session error: %v", err)
}
}
}
// Provider redis session provider
type Provider struct {
maxlifetime int64
c cache.Cache
}
// SessionInit init redis session
func (rp *Provider) SessionInit(ctx context.Context, maxlifetime int64, url string) (err error) {
rp.maxlifetime = maxlifetime * int64(time.Second)
rp.c, err = redis.New(cache.Options{Address: url, Codec: codec})
if err != nil {
return err
}
if ctx == nil {
ctx = context.TODO()
}
return rp.c.Ping(ctx)
}
// SessionRead read redis session by sid
func (rp *Provider) SessionRead(ctx context.Context, sid string) (session.Store, error) {
kv := make(map[interface{}]interface{})
if ctx == nil {
ctx = context.TODO()
}
err := rp.c.Fetch(ctx, sid, &kv)
if err != nil && !errors.Is(err, cache.ErrNotFound) {
return nil, err
}
rs := &Store{c: rp.c, sid: sid, values: kv, maxlifetime: rp.maxlifetime}
return rs, nil
}
// SessionExist check redis session exist by sid
func (rp *Provider) SessionExist(ctx context.Context, sid string) (bool, error) {
if ctx == nil {
ctx = context.TODO()
}
return rp.c.Contains(ctx, sid), nil
}
// SessionRegenerate generate new sid for redis session
func (rp *Provider) SessionRegenerate(ctx context.Context, oldsid, sid string) (session.Store, error) {
if ctx == nil {
ctx = context.TODO()
}
maxlifetime := time.Duration(systemSessionTimeout(ctx, rp.maxlifetime))
if isExist, _ := rp.SessionExist(ctx, oldsid); !isExist {
err := rp.c.Save(ctx, sid, "", time.Duration(rp.maxlifetime))
if err != nil {
log.Debugf("failed to save sid=%s, where oldsid=%s, error: %s", sid, oldsid, err)
}
} else {
if rdb, ok := rp.c.(*redis.Cache); ok {
// redis has rename command
rdb.Rename(ctx, oldsid, sid)
rdb.Expire(ctx, sid, maxlifetime)
} else {
kv := make(map[interface{}]interface{})
err := rp.c.Fetch(ctx, sid, &kv)
if err != nil && !errors.Is(err, cache.ErrNotFound) {
return nil, err
}
err = rp.c.Delete(ctx, oldsid)
if err != nil {
log.Debugf("failed to delete oldsid=%s, error: %s", oldsid, err)
}
err = rp.c.Save(ctx, sid, kv, maxlifetime)
if err != nil {
log.Debugf("failed to save sid=%s, error: %s", sid, err)
}
}
}
return rp.SessionRead(ctx, sid)
}
// SessionDestroy delete redis session by id
func (rp *Provider) SessionDestroy(ctx context.Context, sid string) error {
if ctx == nil {
ctx = context.TODO()
}
return rp.c.Delete(ctx, sid)
}
// SessionGC Implement method, no used.
func (rp *Provider) SessionGC(_ context.Context) {
}
// SessionAll return all activeSession
func (rp *Provider) SessionAll(_ context.Context) int {
return 0
}
// systemSessionTimeout return the system session timeout set by user.
func systemSessionTimeout(ctx context.Context, beegoTimeout int64) int64 {
// read from system config if it is meaningful to support change session timeout in runtime for user.
// otherwise, use parameters beegoTimeout which set from beego.
timeout := beegoTimeout
if sysTimeout := config.SessionTimeout(ctx); sysTimeout > 0 {
timeout = sysTimeout * int64(time.Minute)
}
return timeout
}
func init() {
session.Register(HarborProviderName, harborpder)
}