forked from volatiletech/abcweb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sessions.go
401 lines (332 loc) · 11.2 KB
/
sessions.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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
package abcsessions
import (
"encoding/json"
"net/http"
"time"
"github.com/pkg/errors"
)
// session holds the session value and the flash messages key/value mapping
type session struct {
// value is the session value stored as a json encoded string
Value *json.RawMessage
// flash is the key/value storage for flash messages. Depending on whether
// you're calling Get/SetFlash or Get/SetFlashObj it will either store
// a json string or a json object.
Flash map[string]*json.RawMessage
}
// Storer provides methods to retrieve, add and delete sessions.
type Storer interface {
// All returns all keys in the store
All() (keys []string, err error)
Get(key string) (value string, err error)
Set(key, value string) error
Del(key string) error
ResetExpiry(key string) error
}
// Overseer of session cookies
type Overseer interface {
Resetter
// Get the value stored in a session
Get(w http.ResponseWriter, r *http.Request) (value string, err error)
// Set creates or updates a session with value
Set(w http.ResponseWriter, r *http.Request, value string) error
// Delete a session
Del(w http.ResponseWriter, r *http.Request) error
// Regenerate a new session id for your session
Regenerate(w http.ResponseWriter, r *http.Request) error
// SessionID returns the session id for your session
SessionID(w http.ResponseWriter, r *http.Request) (id string, err error)
}
// Resetter has reset functions
type Resetter interface {
// ResetExpiry resets the age of the session to time.Now(), so that
// MaxAge calculations are renewed
ResetExpiry(w http.ResponseWriter, r *http.Request) error
// ResetMiddleware will reset the users session expiry on every request
ResetMiddleware(next http.Handler) http.Handler
// MiddlewareWithReset converts the writer to a sessionsResponseWriter
// and will reset the users session expiry on every request
MiddlewareWithReset(next http.Handler) http.Handler
}
// timer interface is used to mock the test harness for disk and memory storers
type timer interface {
Stop() bool
Reset(time.Duration) bool
}
type noSessionInterface interface {
NoSession()
}
type noMapKeyInterface interface {
NoMapKey()
}
type errNoSession struct{}
type errNoMapKey struct{}
func (errNoSession) NoSession() {}
func (errNoMapKey) NoMapKey() {}
func (errNoSession) Error() string {
return "session does not exist"
}
func (errNoMapKey) Error() string {
return "session map key does not exist"
}
// IsNoSessionError checks an error to see if it means that there was no session
func IsNoSessionError(err error) bool {
_, ok := err.(noSessionInterface)
if ok {
return ok
}
_, ok = errors.Cause(err).(noSessionInterface)
return ok
}
// IsNoMapKeyError checks an error to see if it means that there was
// no session map key
func IsNoMapKeyError(err error) bool {
_, ok := err.(noMapKeyInterface)
if ok {
return ok
}
_, ok = errors.Cause(err).(noMapKeyInterface)
return ok
}
// timerTestHarness allows us to control the timer channels manually in the
// disk and memory storer tests so that we can trigger cleans at will
var timerTestHarness = func(d time.Duration) (timer, <-chan time.Time) {
t := time.NewTimer(d)
return t, t.C
}
// validKey returns true if the session key is a valid UUIDv4 format:
// 8chars-4chars-4chars-4chars-12chars (chars are a-f 0-9)
// Example: a668b3bb-0cf1-4627-8cd4-7f62d09ebad6
func validKey(key string) bool {
// UUIDv4's are 36 chars (16 bytes not including dashes)
if len(key) != 36 {
return false
}
// 0 indexed dash positions
dashPos := []int{8, 13, 18, 23}
for i := 0; i < len(key); i++ {
atDashPos := false
for _, pos := range dashPos {
if i == pos {
atDashPos = true
break
}
}
if atDashPos == true {
if key[i] != '-' {
return false
}
// continue the loop if dash is found
continue
}
// if not a dash, make sure char is a-f or 0-9
// 48 == '0', 57 == '9', 97 == 'a', 102 == 'f'
if key[i] < 48 || (key[i] > 57 && key[i] < 97) || key[i] > 102 {
return false
}
}
return true
}
// Set is a JSON helper used for storing key-value session values.
// Set modifies the marshalled map stored in the session to include the key value pair passed in.
func Set(overseer Overseer, w http.ResponseWriter, r *http.Request, key string, value string) error {
var sess session
sessMap := make(map[string]string)
val, err := overseer.Get(w, r)
if err != nil && !IsNoSessionError(err) {
return errors.Wrap(err, "unable to get session")
}
if !IsNoSessionError(err) {
err = json.Unmarshal([]byte(val), &sess)
if err != nil {
return errors.Wrap(err, "unable to unmarshal session object")
}
if sess.Value != nil {
err = json.Unmarshal(*sess.Value, &sessMap)
if err != nil {
return errors.Wrap(err, "unable to unmarshal session map value")
}
}
}
sessMap[key] = value
mv, err := json.Marshal(sessMap)
if err != nil {
return errors.Wrap(err, "unable to marshal session map value")
}
sess.Value = (*json.RawMessage)(&mv)
ret, err := json.Marshal(sess)
if err != nil {
return errors.Wrap(err, "unable to marshal session object")
}
return overseer.Set(w, r, string(ret))
}
// Get is a JSON helper used for retrieving key-value session values.
// Get returns the value pointed to by the key of the marshalled map stored in the session.
func Get(overseer Overseer, w http.ResponseWriter, r *http.Request, key string) (string, error) {
val, err := overseer.Get(w, r)
if err != nil {
return "", errors.Wrap(err, "unable to get session")
}
var sess session
err = json.Unmarshal([]byte(val), &sess)
if err != nil {
return "", errors.Wrap(err, "unable to unmarshal session object")
}
var sessMap map[string]string
err = json.Unmarshal(*sess.Value, &sessMap)
if err != nil {
return "", errors.Wrap(err, "unable to unmarshal session map value")
}
mapVal, ok := sessMap[key]
if !ok {
return "", errNoMapKey{}
}
return mapVal, nil
}
// Del is a JSON helper used for deleting keys from a key-value session values store.
// Del is a noop on nonexistent keys, but will error if the session does not exist.
func Del(overseer Overseer, w http.ResponseWriter, r *http.Request, key string) error {
val, err := overseer.Get(w, r)
if err != nil {
return errors.Wrap(err, "unable to get session")
}
var sess session
err = json.Unmarshal([]byte(val), &sess)
if err != nil {
return errors.Wrap(err, "unable to unmarshal session object")
}
var sessMap map[string]string
err = json.Unmarshal(*sess.Value, &sessMap)
if err != nil {
return errors.Wrap(err, "unable to unmarshal session map value")
}
delete(sessMap, key)
mv, err := json.Marshal(sessMap)
if err != nil {
return errors.Wrap(err, "unable to marshal session map value")
}
sess.Value = (*json.RawMessage)(&mv)
ret, err := json.Marshal(sess)
if err != nil {
return errors.Wrap(err, "unable to marshal session object")
}
return overseer.Set(w, r, string(ret))
}
// SetObj is a JSON helper used for storing object or variable session values.
// Set stores in the session a marshaled version of the passed in value pointed to by value.
func SetObj(overseer Overseer, w http.ResponseWriter, r *http.Request, value interface{}) error {
val, err := overseer.Get(w, r)
// If it's a no session error because a session hasn't been created yet
// then we can skip this return statement and create a fresh map
if err != nil && !IsNoSessionError(err) {
return errors.Wrap(err, "unable to get session")
}
var sess session
// If there's an existing session then unmarshal it so we can copy over
// the flash messages to the new marshalled session
if !IsNoSessionError(err) {
// json unmarshal the outter session struct
err = json.Unmarshal([]byte(val), &sess)
if err != nil {
return errors.Wrap(err, "unable to unmarshal session object")
}
}
mv, err := json.Marshal(value)
if err != nil {
return errors.Wrap(err, "unable to marshal value")
}
sess.Value = (*json.RawMessage)(&mv)
ret, err := json.Marshal(sess)
if err != nil {
return errors.Wrap(err, "unable to marshal session object")
}
return overseer.Set(w, r, string(ret))
}
// GetObj is a JSON helper used for retrieving object or variable session values.
// GetObj unmarshals the session value into the pointer pointed to by pointer.
func GetObj(overseer Overseer, w http.ResponseWriter, r *http.Request, pointer interface{}) error {
val, err := overseer.Get(w, r)
if err != nil {
return errors.Wrap(err, "unable to get session")
}
var sess session
// json unmarshal the outter session struct
err = json.Unmarshal([]byte(val), &sess)
if err != nil {
return errors.Wrap(err, "unable to unmarshal session object")
}
// json unmarshal the RawMessage value into the users pointer
err = json.Unmarshal(*sess.Value, pointer)
return errors.Wrap(err, "unable to unmarshal session value into pointer")
}
// AddFlash adds a flash message to the session that will be deleted when it is retrieved with GetFlash
func AddFlash(overseer Overseer, w http.ResponseWriter, r *http.Request, key string, value string) error {
var sess session
val, err := overseer.Get(w, r)
if err != nil && !IsNoSessionError(err) {
return errors.Wrap(err, "unable to get session")
} else if !IsNoSessionError(err) {
err = json.Unmarshal([]byte(val), &sess)
if err != nil {
return errors.Wrap(err, "unable to unmarshal session object")
}
}
if sess.Flash == nil {
sess.Flash = make(map[string]*json.RawMessage)
}
mv, err := json.Marshal(value)
if err != nil {
return errors.Wrap(err, "unable to marshal session value")
}
sess.Flash[key] = (*json.RawMessage)(&mv)
ret, err := json.Marshal(sess)
if err != nil {
return errors.Wrap(err, "unable to marshal session object")
}
return overseer.Set(w, r, string(ret))
}
// GetFlash retrieves a flash message from the session then deletes it
func GetFlash(overseer Overseer, w http.ResponseWriter, r *http.Request, key string) (string, error) {
var sess session
val, err := overseer.Get(w, r)
if err != nil {
return "", errors.Wrap(err, "unable to get session")
}
err = json.Unmarshal([]byte(val), &sess)
if err != nil {
return "", errors.Wrap(err, "unable to unmarshal session object")
}
fv, ok := sess.Flash[key]
if !ok {
return "", errNoMapKey{}
}
var ret string
err = json.Unmarshal(*fv, &ret)
if err != nil {
return ret, errors.Wrap(err, "unable to unmarshal flash value")
}
delete(sess.Flash, key)
mv, err := json.Marshal(sess)
if err != nil {
return ret, errors.Wrap(err, "unable to marshal session object")
}
err = overseer.Set(w, r, string(mv))
return ret, errors.Wrap(err, "unable to set flash session object")
}
// AddFlashObj adds a flash message to the session that will be deleted when it is retrieved with GetFlash
func AddFlashObj(overseer Overseer, w http.ResponseWriter, r *http.Request, key string, value interface{}) error {
mv, err := json.Marshal(value)
if err != nil {
return errors.Wrap(err, "unable to marshal flash value")
}
return AddFlash(overseer, w, r, key, string(mv))
}
// GetFlashObj unmarshals a flash message from the session into the users pointer
// then deletes it from the session.
func GetFlashObj(overseer Overseer, w http.ResponseWriter, r *http.Request, key string, pointer interface{}) error {
val, err := GetFlash(overseer, w, r, key)
if err != nil {
return errors.Wrap(err, "unable to get flash object")
}
return json.Unmarshal([]byte(val), pointer)
}