/
claims.go
169 lines (140 loc) · 4.5 KB
/
claims.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
/*
* Copyright 2017-2021 Kopano and its licensors
*
* 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 lico
import (
"errors"
"github.com/golang-jwt/jwt/v4"
"github.com/libregraph/lico/oidc"
"github.com/libregraph/lico/oidc/payload"
)
// Access token claims used.
const (
RefClaim = "lg.r"
IdentityClaim = "lg.i"
IdentityProviderClaim = "lg.p"
ScopesClaim = "scp"
)
// Identifier identity sub claims used.
const (
IdentifiedUserClaim = "us"
IdentifiedUserIDClaim = "id"
IdentifiedUsernameClaim = "un"
IdentifiedDisplayNameClaim = "dn"
IdentifiedData = "da"
IdentifiedUserIsGuest = "gu"
)
// Internal claim names used for special things.
const (
InternalExtraIDTokenClaimsClaim = "$lico.id.extra"
InternalExtraAccessTokenClaimsClaim = "$lico.at.extra"
)
// TokenType defines the token type value.
type TokenTypeValue string
// Is compares the associated TokenTypeValue to the provided one.
func (ttv TokenTypeValue) Is(value TokenTypeValue) bool {
return ttv == value
}
// The known token type values.
const (
TokenTypeIDToken TokenTypeValue = "" // Just a placeholder, not actually set in ID Tokens.
TokenTypeAccessToken TokenTypeValue = "1"
TokenTypeRefreshToken TokenTypeValue = "2"
)
// AccessTokenClaims define the claims found in access tokens issued.
type AccessTokenClaims struct {
jwt.StandardClaims
TokenType TokenTypeValue `json:"lg.t"`
AuthorizedClaimsRequest *payload.ClaimsRequest `json:"lg.acr,omitempty"`
AuthorizedScopesList payload.ScopesValue `json:"scp"`
IdentityClaims jwt.MapClaims `json:"lg.i"`
IdentityProvider string `json:"lg.p,omitempty"`
*oidc.SessionClaims
}
// Valid implements the jwt.Claims interface.
func (c AccessTokenClaims) Valid() error {
if err := c.StandardClaims.Valid(); err != nil {
return err
}
if c.IdentityClaims != nil {
if err := c.IdentityClaims.Valid(); err != nil {
return err
}
}
if c.TokenType.Is(TokenTypeAccessToken) {
return nil
}
return errors.New("not an access token")
}
// AuthorizedScopes returns a map with scope keys and true value of all scopes
// set in the accociated access token.
func (c AccessTokenClaims) AuthorizedScopes() map[string]bool {
authorizedScopes := make(map[string]bool)
for _, scope := range c.AuthorizedScopesList {
authorizedScopes[scope] = true
}
return authorizedScopes
}
// RefreshTokenClaims define the claims used by refresh tokens.
type RefreshTokenClaims struct {
jwt.StandardClaims
TokenType TokenTypeValue `json:"lg.t"`
ApprovedScopesList payload.ScopesValue `json:"scp"`
ApprovedClaimsRequest *payload.ClaimsRequest `json:"lg.acr,omitempty"`
Ref string `json:"lg.r"`
IdentityClaims jwt.MapClaims `json:"lg.i"`
IdentityProvider string `json:"lg.p,omitempty"`
}
// Valid implements the jwt.Claims interface.
func (c RefreshTokenClaims) Valid() error {
if err := c.StandardClaims.Valid(); err != nil {
return err
}
if c.IdentityClaims != nil {
if err := c.IdentityClaims.Valid(); err != nil {
return err
}
}
if c.TokenType.Is(TokenTypeRefreshToken) {
return nil
}
return errors.New("not a refresh token")
}
// NumericIDClaims define the claims used with the konnect/id scope.
type NumericIDClaims struct {
// NOTE(longsleep): Always keep these claims compatible with the GitLab API
// https://docs.gitlab.com/ce/api/users.html#for-user.
NumericID int64 `json:"id,omitempty"`
NumericIDUsername string `json:"username,omitempty"`
}
// Valid implements the jwt.Claims interface.
func (c NumericIDClaims) Valid() error {
if c.NumericIDUsername == "" {
return errors.New("username claim not valid")
}
return nil
}
// UniqueUserIDClaims define the claims used with the konnect/uuid scope.
type UniqueUserIDClaims struct {
UniqueUserID string `json:"lg.uuid,omitempty"`
}
// Valid implements the jwt.Claims interface.
func (c UniqueUserIDClaims) Valid() error {
if c.UniqueUserID == "" {
return errors.New("lg.uuid claim not valid")
}
return nil
}