-
Notifications
You must be signed in to change notification settings - Fork 1
/
genericOidc.go
170 lines (141 loc) · 4.4 KB
/
genericOidc.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
package security
import (
"context"
"errors"
"net/http"
"time"
"golang.org/x/oauth2"
"github.com/coreos/go-oidc/v3/oidc"
"github.com/go-jose/go-jose/v4/jwt"
)
// GenericOIDCClaims
// https://openid.net/specs/openid-connect-core-1_0.html
// Audience(s) that this ID Token is intended for. It MUST contain the OAuth 2.0 client_id of the Relying Party as an audience value. It MAY also contain identifiers for other audiences. In the general case, the aud value is an array of case sensitive strings. In the common special case when there is one audience, the aud value MAY be a single case sensitive string.
type GenericOIDCClaims struct {
jwt.Claims
Name string `json:"name"`
PreferredUsername string `json:"preferred_username"`
EMail string `json:"email"`
Roles []string `json:"roles"`
}
func (g *GenericOIDCClaims) Username() string {
if g.PreferredUsername != "" {
return g.PreferredUsername
}
return g.Name
}
// GenericOIDC is Token Validator and UserGetter for Tokens issued by generic OIDC-Providers.
type GenericOIDC struct {
issuerConfig *IssuerConfig
userExtractorFn GenericUserExtractorFn
provider *oidc.Provider
verifier *oidc.IDTokenVerifier
}
// GenericOIDCCfg properties that can be modified by Options
type GenericOIDCCfg struct {
SupportedSigningAlgs []string
Timeout time.Duration
UserExtractorFn GenericUserExtractorFn
}
// NewGenericOIDC creates a new GenericOIDC.
func NewGenericOIDC(ic *IssuerConfig, opts ...GenericOIDCOption) (*GenericOIDC, error) {
cfg := &GenericOIDCCfg{
UserExtractorFn: DefaultGenericUserExtractor,
Timeout: 10 * time.Second,
SupportedSigningAlgs: []string{"RS256", "RS384", "RS512"},
}
for _, opt := range opts {
opt(cfg)
}
client := &http.Client{
Transport: &http.Transport{
DisableKeepAlives: true,
},
Timeout: cfg.Timeout,
}
ctx := context.Background()
ctx = context.WithValue(ctx, oauth2.HTTPClient, client)
provider, err := oidc.NewProvider(ctx, ic.Issuer)
if err != nil {
return nil, err
}
verifier := provider.Verifier(&oidc.Config{
ClientID: ic.ClientID,
SupportedSigningAlgs: cfg.SupportedSigningAlgs,
SkipClientIDCheck: false,
SkipExpiryCheck: false,
SkipIssuerCheck: false,
Now: nil,
})
g := &GenericOIDC{
issuerConfig: ic,
userExtractorFn: cfg.UserExtractorFn,
provider: provider,
verifier: verifier,
}
return g, nil
}
// User implements the UserGetter to get a user from the request.
func (o *GenericOIDC) User(rq *http.Request) (*User, error) {
ctx := context.Background()
rawIDToken, err := ExtractBearer(rq)
if err != nil {
return nil, err
}
// Parse and verify ID Token payload.
idToken, err := o.verifier.Verify(ctx, rawIDToken)
if err != nil {
return nil, err
}
// Extract custom claims
var claims GenericOIDCClaims
if err := idToken.Claims(&claims); err != nil {
return nil, err
}
u, err := o.userExtractorFn(o.issuerConfig, &claims)
if err != nil {
return nil, err
}
return u, nil
}
// GenericOIDCOption provides means to configure GenericOIDC
type GenericOIDCOption func(oidc *GenericOIDCCfg)
// AllowedSignAlgs configures the allowed SigningAlgorithms, e.g. RS256, RS512,...
func AllowedSignAlgs(algs []string) GenericOIDCOption {
return func(o *GenericOIDCCfg) {
o.SupportedSigningAlgs = algs
}
}
func Timeout(timeout time.Duration) GenericOIDCOption {
return func(o *GenericOIDCCfg) {
o.Timeout = timeout
}
}
// GenericUserExtractorFn extracts the User and Claims
type GenericUserExtractorFn func(ic *IssuerConfig, claims *GenericOIDCClaims) (*User, error)
// GenericUserExtractor configures the GenericUserExtractorFn to extract the User from a token
func GenericUserExtractor(fn GenericUserExtractorFn) GenericOIDCOption {
return func(o *GenericOIDCCfg) {
o.UserExtractorFn = fn
}
}
// DefaultGenericUserExtractor is the default implementation of how to extract
// the User from the token.
func DefaultGenericUserExtractor(ic *IssuerConfig, claims *GenericOIDCClaims) (*User, error) {
if claims == nil {
return nil, errors.New("claims is nil")
}
var grps []ResourceAccess
for _, g := range claims.Roles {
grps = append(grps, ResourceAccess(g))
}
usr := User{
Issuer: claims.Issuer,
Subject: claims.Subject,
Name: claims.Username(),
EMail: claims.EMail,
Groups: grps,
Tenant: ic.Tenant,
}
return &usr, nil
}