-
Notifications
You must be signed in to change notification settings - Fork 3
/
claims_jwt.go
260 lines (224 loc) · 6.09 KB
/
claims_jwt.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
// Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package jwt
import (
"strings"
"time"
"github.com/google/uuid"
"authelia.com/provider/oauth2/internal/consts"
)
// Enum for different types of scope encoding.
type JWTScopeFieldEnum int
const (
JWTScopeFieldUnset JWTScopeFieldEnum = iota
JWTScopeFieldList
JWTScopeFieldString
JWTScopeFieldBoth
)
type JWTClaimsDefaults struct {
ExpiresAt time.Time
IssuedAt time.Time
Issuer string
Scope []string
}
type JWTClaimsContainer interface {
// Sanitize should clear the IssuedAt and NotBefore values.
Sanitize() JWTClaimsContainer
// With returns a copy of itself with expiresAt, scope, audience set to the given values.
With(expiry time.Time, scope, audience []string) JWTClaimsContainer
// WithDefaults returns a copy of itself with issuedAt and issuer set to the given default values. If those
// values are already set in the claims, they will not be updated.
WithDefaults(iat, nbf time.Time, issuer string) JWTClaimsContainer
// WithScopeField configures how a scope field should be represented in JWT.
WithScopeField(scopeField JWTScopeFieldEnum) JWTClaimsContainer
// ToMapClaims returns the claims as a github.com/dgrijalva/jwt-go.MapClaims type.
ToMapClaims() MapClaims
}
// JWTClaims represent a token's claims.
type JWTClaims struct {
Subject string
Issuer string
Audience []string
JTI string
IssuedAt time.Time
NotBefore time.Time
ExpiresAt time.Time
Scope []string
Extra map[string]any
ScopeField JWTScopeFieldEnum
}
func (c *JWTClaims) With(expiry time.Time, scope, audience []string) JWTClaimsContainer {
c.ExpiresAt = expiry
c.Scope = scope
c.Audience = audience
return c
}
func (c *JWTClaims) Sanitize() JWTClaimsContainer {
c.IssuedAt = time.Time{}
c.NotBefore = time.Time{}
return c
}
func (c *JWTClaims) WithDefaults(iat, nbf time.Time, issuer string) JWTClaimsContainer {
if c.IssuedAt.IsZero() {
c.IssuedAt = iat
}
if c.NotBefore.IsZero() {
c.NotBefore = nbf
}
if c.Issuer == "" {
c.Issuer = issuer
}
return c
}
func (c *JWTClaims) WithScopeField(scopeField JWTScopeFieldEnum) JWTClaimsContainer {
c.ScopeField = scopeField
return c
}
// ToMap will transform the headers to a map structure
func (c *JWTClaims) ToMap() map[string]any {
var ret = Copy(c.Extra)
if c.Subject != "" {
ret[consts.ClaimSubject] = c.Subject
} else {
delete(ret, consts.ClaimSubject)
}
if c.Issuer != "" {
ret[consts.ClaimIssuer] = c.Issuer
} else {
delete(ret, consts.ClaimIssuer)
}
if c.JTI != "" {
ret[consts.ClaimJWTID] = c.JTI
} else {
ret[consts.ClaimJWTID] = uuid.New().String()
}
if len(c.Audience) > 0 {
ret[consts.ClaimAudience] = c.Audience
} else {
ret[consts.ClaimAudience] = []string{}
}
if !c.IssuedAt.IsZero() {
ret[consts.ClaimIssuedAt] = c.IssuedAt.Unix()
} else {
delete(ret, consts.ClaimIssuedAt)
}
if !c.NotBefore.IsZero() {
ret[consts.ClaimNotBefore] = c.NotBefore.Unix()
} else {
delete(ret, consts.ClaimNotBefore)
}
if !c.ExpiresAt.IsZero() {
ret[consts.ClaimExpirationTime] = c.ExpiresAt.Unix()
} else {
delete(ret, consts.ClaimExpirationTime)
}
if c.Scope != nil {
// ScopeField default (when value is JWTScopeFieldUnset) is the list for backwards compatibility with old versions of oauth2.
if c.ScopeField == JWTScopeFieldUnset || c.ScopeField == JWTScopeFieldList || c.ScopeField == JWTScopeFieldBoth {
ret[consts.ClaimScopeNonStandard] = c.Scope
}
if c.ScopeField == JWTScopeFieldString || c.ScopeField == JWTScopeFieldBoth {
ret[consts.ClaimScope] = strings.Join(c.Scope, " ")
}
} else {
delete(ret, consts.ClaimScopeNonStandard)
delete(ret, consts.ClaimScope)
}
return ret
}
// FromMap will set the claims based on a mapping.
//
// TODO: Refactor time permitting.
//
//nolint:gocyclo
func (c *JWTClaims) FromMap(m map[string]any) {
c.Extra = make(map[string]any)
for k, v := range m {
switch k {
case consts.ClaimJWTID:
if s, ok := v.(string); ok {
c.JTI = s
}
case consts.ClaimSubject:
if s, ok := v.(string); ok {
c.Subject = s
}
case consts.ClaimIssuer:
if s, ok := v.(string); ok {
c.Issuer = s
}
case consts.ClaimAudience:
if aud, ok := StringSliceFromMap(v); ok {
c.Audience = aud
}
case consts.ClaimIssuedAt:
c.IssuedAt = toTime(v, c.IssuedAt)
case consts.ClaimNotBefore:
c.NotBefore = toTime(v, c.NotBefore)
case consts.ClaimExpirationTime:
c.ExpiresAt = toTime(v, c.ExpiresAt)
case consts.ClaimScopeNonStandard:
switch s := v.(type) {
case []string:
c.Scope = s
if c.ScopeField == JWTScopeFieldString {
c.ScopeField = JWTScopeFieldBoth
} else if c.ScopeField == JWTScopeFieldUnset {
c.ScopeField = JWTScopeFieldList
}
case []any:
c.Scope = make([]string, len(s))
for i, vi := range s {
if s, ok := vi.(string); ok {
c.Scope[i] = s
}
}
if c.ScopeField == JWTScopeFieldString {
c.ScopeField = JWTScopeFieldBoth
} else if c.ScopeField == JWTScopeFieldUnset {
c.ScopeField = JWTScopeFieldList
}
}
case consts.ClaimScope:
if s, ok := v.(string); ok {
c.Scope = strings.Split(s, " ")
if c.ScopeField == JWTScopeFieldList {
c.ScopeField = JWTScopeFieldBoth
} else if c.ScopeField == JWTScopeFieldUnset {
c.ScopeField = JWTScopeFieldString
}
}
default:
c.Extra[k] = v
}
}
}
func toTime(v any, def time.Time) (t time.Time) {
t = def
switch a := v.(type) {
case float64:
t = time.Unix(int64(a), 0).UTC()
case int64:
t = time.Unix(a, 0).UTC()
}
return
}
// Add will add a key-value pair to the extra field
func (c *JWTClaims) Add(key string, value any) {
if c.Extra == nil {
c.Extra = make(map[string]any)
}
c.Extra[key] = value
}
// Get will get a value from the extra field based on a given key
func (c JWTClaims) Get(key string) any {
return c.ToMap()[key]
}
// ToMapClaims will return a jwt-go MapClaims representation
func (c JWTClaims) ToMapClaims() MapClaims {
return c.ToMap()
}
// FromMapClaims will populate claims from a jwt-go MapClaims representation
func (c *JWTClaims) FromMapClaims(mc MapClaims) {
c.FromMap(mc)
}