-
Notifications
You must be signed in to change notification settings - Fork 2
/
osecure.go
476 lines (394 loc) · 12.8 KB
/
osecure.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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
// Package osecure provides simple login service based on OAuth client.
package osecure
import (
"context"
"encoding/base64"
"encoding/gob"
"errors"
"golang.org/x/oauth2"
"net/http"
"sort"
"strings"
"time"
"github.com/gorilla/securecookie"
"github.com/gorilla/sessions"
)
var (
ErrorInvalidSession = errors.New("invalid session")
ErrorInvalidAuthorizationHeaderFormat = errors.New("invalid authorization header format")
ErrorUnsupportedAuthorizationType = errors.New("unsupported authorization type")
ErrorInvalidClientID = errors.New("invalid client ID (audience of token)")
ErrorInvalidUserID = errors.New("invalid user ID (subject of token)")
)
var (
SessionExpireTime = 86400
PermissionExpireTime = 600
)
type contextKey int
const (
contextKeySessionData = contextKey(1)
)
type set map[string]struct{}
func (s set) add(x string) {
s[x] = struct{}{}
}
func (s set) contain(x string) bool {
_, ok := s[x]
return ok
}
func init() {
//gob.Register(&time.Time{})
gob.Register(&AuthSessionCookieData{})
}
type AuthSessionData struct {
UserID string //
ClientID string //
*AuthSessionCookieData
}
type AuthSessionCookieData struct {
//UserID string
//ClientID string
Token *oauth2.Token
Permissions []string
PermissionsExpireAt time.Time
}
//func newAuthSessionCookieData(userID string, clientID string, token *oauth2.Token) *AuthSessionCookieData {
func newAuthSessionCookieData(token *oauth2.Token) *AuthSessionCookieData {
if token.Expiry.IsZero() {
token.Expiry = time.Now().Add(time.Duration(SessionExpireTime) * time.Second)
}
return &AuthSessionCookieData{
//UserID: userID,
//ClientID: clientID,
Token: token,
Permissions: []string{},
PermissionsExpireAt: time.Time{}, // Zero time
}
}
func (cookieData *AuthSessionCookieData) isTokenExpired() bool {
return cookieData.Token.Expiry.Before(time.Now())
}
func (cookieData *AuthSessionCookieData) isPermissionsExpired() bool {
return cookieData.PermissionsExpireAt.Before(time.Now())
}
// CookieConfig is a config of github.com/gorilla/securecookie. Recommended
// configurations are base64 of 64 bytes key for SigningKey, and base64 of 32
// bytes key for EncryptionKey.
type CookieConfig struct {
SigningKey string `yaml:"signing_key" env:"skey"`
EncryptionKey string `yaml:"encryption_key" env:"ekey"`
}
// OAuthConfig is a config of osecure.
type OAuthConfig struct {
ClientID string `yaml:"client_id" env:"client_id"`
ClientSecret string `yaml:"client_secret" env:"client_secret"`
Scopes []string `yaml:"scopes" env:"scopes"`
AuthURL string `yaml:"auth_url" env:"auth_url"`
TokenURL string `yaml:"token_url" env:"token_url"`
AppIDList []string `yaml:"app_id_list" env:"app_id_list"`
}
type OAuthSession struct {
name string
cookieStore *sessions.CookieStore
client *oauth2.Config
appIDSet set
tokenVerifier *TokenVerifier
}
// NewOAuthSession creates osecure session.
func NewOAuthSession(name string, cookieConf *CookieConfig, oauthConf *OAuthConfig, tokenVerifier *TokenVerifier, callbackURL string) *OAuthSession {
client := &oauth2.Config{
ClientID: oauthConf.ClientID,
ClientSecret: oauthConf.ClientSecret,
Scopes: oauthConf.Scopes,
Endpoint: oauth2.Endpoint{
AuthURL: oauthConf.AuthURL,
TokenURL: oauthConf.TokenURL,
},
RedirectURL: callbackURL,
}
appIDSet := make(set)
for _, appID := range oauthConf.AppIDList {
appIDSet.add(appID)
}
return &OAuthSession{
name: name,
cookieStore: newCookieStore(cookieConf),
client: client,
appIDSet: appIDSet,
tokenVerifier: tokenVerifier,
}
}
// SecuredH is a http middleware for http.Handler to check if the current user has logged in.
func (s *OAuthSession) SecuredH(h http.Handler) http.Handler {
return s.SecuredF(h.ServeHTTP)
}
// SecuredF is a http middleware for http.HandlerFunc to check if the current user has logged in.
func (s *OAuthSession) SecuredF(h http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
sessionData, err := s.Authorize(w, r)
if err != nil {
s.StartOAuth(w, r)
} else {
requestInner := AttachRequestWithSessionData(r, sessionData)
h(w, requestInner)
}
}
}
// ExpireSession is a http function to log out the user.
func (s *OAuthSession) ExpireSession(redirect string) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
s.expireAuthCookie(w, r)
http.Redirect(w, r, redirect, 303)
}
}
// AttachRequestWithSessionData append session data into request context
func AttachRequestWithSessionData(r *http.Request, sessionData *AuthSessionData) *http.Request {
contextWithSessionData := context.WithValue(r.Context(), contextKeySessionData, sessionData)
return r.WithContext(contextWithSessionData)
}
// GetRequestSessionData get session data from request context
func GetRequestSessionData(r *http.Request) (*AuthSessionData, bool) {
sessionData, ok := r.Context().Value(contextKeySessionData).(*AuthSessionData)
return sessionData, ok
}
// HasPermission checks if the current user has such permission.
func (data *AuthSessionData) HasPermission(permission string) bool {
perms := data.GetPermissions()
id := sort.SearchStrings(perms, permission)
result := id < len(perms) && perms[id] == permission
return result
}
// GetPermissions lists the permissions of the current user and client.
func (data *AuthSessionData) GetPermissions() []string {
return data.Permissions
}
// GetUserID get user ID of the current user session.
func (data *AuthSessionData) GetUserID() string {
return data.UserID
}
// GetClientID get client ID of the current user session.
func (data *AuthSessionData) GetClientID() string {
return data.ClientID
}
// Authorize authorize user by verifying cookie or bearer token.
// if user is authorized, return session data. else, return error.
func (s *OAuthSession) Authorize(w http.ResponseWriter, r *http.Request) (*AuthSessionData, error) {
data, isTokenFromAuthorizationHeader, err := s.getAuthSessionDataFromRequest(r)
if err != nil {
return nil, err
}
if data == nil || data.isTokenExpired() {
return nil, ErrorInvalidSession
}
isPermissionUpdated, err := s.ensurePermUpdated(data)
if err != nil {
return nil, err
}
if isTokenFromAuthorizationHeader || isPermissionUpdated {
err = s.issueAuthCookie(w, r, data.AuthSessionCookieData)
if err != nil {
return nil, err
}
}
return data, nil
}
func (s *OAuthSession) ensurePermUpdated(data *AuthSessionData) (bool, error) {
if !data.isPermissionsExpired() {
return false, nil
}
permissions, err := s.tokenVerifier.GetPermissionsFunc(data.UserID, data.ClientID, data.Token)
if err != nil {
return false, err
}
data.Permissions = permissions
data.PermissionsExpireAt = time.Now().Add(time.Duration(PermissionExpireTime) * time.Second)
// Sort the string, as sort.SearchStrings needs sorted []string.
sort.Strings(data.Permissions)
return true, nil
}
func (s *OAuthSession) getAuthSessionDataFromRequest(r *http.Request) (*AuthSessionData, bool, error) {
var accessToken string
var isTokenFromAuthorizationHeader bool
cookieData := s.retrieveAuthCookie(r)
if cookieData == nil || cookieData.isTokenExpired() {
var err error
accessToken, err = s.getBearerToken(r)
if err != nil {
return nil, false, err
}
isTokenFromAuthorizationHeader = true
} else {
accessToken = cookieData.Token.AccessToken
isTokenFromAuthorizationHeader = false
}
userID, clientID, expireAt, extra, err := s.tokenVerifier.IntrospectTokenFunc(accessToken)
if err != nil {
return nil, false, err
}
// restore token extra data whenever token is new or retrieved from cookie
var token *oauth2.Token
if isTokenFromAuthorizationHeader {
token = makeBearerToken(accessToken, expireAt)
} else {
token = cookieData.Token
}
token = token.WithExtra(extra)
if isTokenFromAuthorizationHeader {
cookieData = newAuthSessionCookieData(token)
} else {
cookieData.Token = token
}
data := &AuthSessionData{
UserID: userID,
ClientID: clientID,
AuthSessionCookieData: cookieData,
}
if !s.isValidClientID(data.ClientID) {
return nil, false, ErrorInvalidClientID
}
return data, isTokenFromAuthorizationHeader, nil
}
/*
func (s *OAuthSession) getAuthSessionDataFromRequest(r *http.Request) (*AuthSessionData, bool, error) {
var isTokenFromAuthorizationHeader bool
cookieData := s.retrieveAuthCookie(r)
if cookieData == nil || cookieData.isTokenExpired() {
userID, clientID, token, err := s.getAndIntrospectBearerToken(r)
if err != nil {
return nil, false, err
}
cookieData = newAuthSessionCookieData(userID, clientID, token)
isTokenFromAuthorizationHeader = true
} else {
isTokenFromAuthorizationHeader = false
}
data := &AuthSessionData{
AuthSessionCookieData: cookieData,
}
if !s.isValidClientID(data.ClientID) {
return nil, false, ErrorInvalidClientID
}
return data, isTokenFromAuthorizationHeader, nil
}
func (s *OAuthSession) getAndIntrospectBearerToken(r *http.Request) (userID string, clientID string, token *oauth2.Token, err error) {
var bearerToken string
bearerToken, err = s.getBearerToken(r)
if err != nil {
return
}
var expireAt int64
var extra map[string]interface{}
userID, clientID, expireAt, extra, err = s.tokenVerifier.IntrospectTokenFunc(bearerToken)
if err != nil {
return
}
token = makeBearerToken(bearerToken, expireAt).WithExtra(extra)
return
}
*/
func (s *OAuthSession) isValidClientID(clientID string) bool {
return clientID == s.client.ClientID || s.appIDSet.contain(clientID)
}
// StartOAuth redirect to endpoint of OAuth service provider for OAuth flow.
func (s *OAuthSession) StartOAuth(w http.ResponseWriter, r *http.Request) {
http.Redirect(w, r, s.client.AuthCodeURL(r.RequestURI), 303)
}
// CallbackView is a http handler for the authentication redirection of the
// auth server.
func (s *OAuthSession) CallbackView(w http.ResponseWriter, r *http.Request) {
q := r.URL.Query()
code := q.Get("code")
cont := q.Get("state")
token, err := s.client.Exchange(oauth2.NoContext, code)
if err != nil {
http.Error(w, err.Error(), 400)
return
}
// TODO: how to get subject (account ID) when using exchange code only?
/*userID, clientID, _, _, err := s.tokenVerifier.IntrospectTokenFunc(token.AccessToken)
if err != nil {
http.Error(w, err.Error(), 500)
return
}*/
//err = s.issueAuthCookie(w, r, newAuthSessionCookieData(userID, clientID, token))
err = s.issueAuthCookie(w, r, newAuthSessionCookieData(token))
if err != nil {
http.Error(w, err.Error(), 500)
return
}
http.Redirect(w, r, cont, 303)
}
func makeToken(tokenType string, accessToken string, expireAt int64) *oauth2.Token {
return &oauth2.Token{
AccessToken: accessToken,
TokenType: tokenType,
Expiry: time.Unix(expireAt, 0),
}
}
func makeBearerToken(accessToken string, expireAt int64) *oauth2.Token {
return makeToken("Bearer", accessToken, expireAt)
}
func (s *OAuthSession) getBearerToken(r *http.Request) (string, error) {
authorizationHeaderValue := r.Header.Get("Authorization")
authorizationData := strings.SplitN(authorizationHeaderValue, " ", 2)
if len(authorizationData) != 2 {
return "", ErrorInvalidAuthorizationHeaderFormat
}
tokenType := authorizationData[0]
if !strings.EqualFold(tokenType, "bearer") {
return "", ErrorUnsupportedAuthorizationType
}
bearerToken := authorizationData[1]
return bearerToken, nil
}
func (s *OAuthSession) retrieveAuthCookie(r *http.Request) *AuthSessionCookieData {
session, err := s.cookieStore.Get(r, s.name)
if err != nil {
return nil
}
v, found := session.Values["data"]
if !found {
return nil
}
cookieData, ok := v.(*AuthSessionCookieData)
if !ok {
return nil
}
return cookieData
}
func (s *OAuthSession) issueAuthCookie(w http.ResponseWriter, r *http.Request, cookieData *AuthSessionCookieData) error {
session, err := s.cookieStore.New(r, s.name)
if err != nil {
return err
}
session.Values["data"] = cookieData
err = session.Save(r, w)
return err
}
func (s *OAuthSession) expireAuthCookie(w http.ResponseWriter, r *http.Request) {
session, err := s.cookieStore.Get(r, s.name)
if err != nil {
panic(err)
}
delete(session.Values, "data")
session.Options.MaxAge = -1
session.Save(r, w)
}
func newCookieStore(conf *CookieConfig) *sessions.CookieStore {
var signingKey, encryptionKey []byte
var err error
if conf != nil {
signingKey, err = base64.StdEncoding.DecodeString(conf.SigningKey)
if err != nil {
panic(err)
}
encryptionKey, err = base64.StdEncoding.DecodeString(conf.EncryptionKey)
if err != nil {
panic(err)
}
} else {
signingKey = securecookie.GenerateRandomKey(64)
encryptionKey = securecookie.GenerateRandomKey(32)
}
return sessions.NewCookieStore(signingKey, encryptionKey)
}