-
Notifications
You must be signed in to change notification settings - Fork 11
/
dex.go
306 lines (268 loc) · 9.02 KB
/
dex.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
/*This file is part of kuberpult.
Kuberpult is free software: you can redistribute it and/or modify
it under the terms of the Expat(MIT) License as published by
the Free Software Foundation.
Kuberpult is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
MIT License for more details.
You should have received a copy of the MIT License
along with kuberpult. If not, see <https://directory.fsf.org/wiki/License:Expat>.
Copyright freiheit.com*/
package auth
import (
"bytes"
"context"
"fmt"
"html"
"io"
"net/http"
"net/http/httputil"
"net/url"
"time"
"github.com/coreos/go-oidc/v3/oidc"
"github.com/freiheit-com/kuberpult/pkg/logger"
"github.com/golang-jwt/jwt/v4"
"golang.org/x/oauth2"
)
// Extracted information from JWT/Cookie.
type DexAuthContext struct {
// The user role extracted from the Cookie.
Role string
}
// Dex App Client.
type DexAppClient struct {
// The Dex issuer URL. Needs to be match the dex issuer helm config.
IssuerURL string
// The host Kuberpult is running on.
BaseURL string
// The Kuberpult client ID. Needs to match the dex staticClients.id helm configuration.
ClientID string
// The Kuberpult client secret. Needs to match the dex staticClients.secret helm configuration.
ClientSecret string
// The Dex redirect callback. Needs to match the dex staticClients.redirectURIs helm configuration.
RedirectURI string
// The available scopes.
Scopes []string
// The http client used.
Client *http.Client
}
const (
// Dex service internal URL. Used to connect to dex internally in the cluster.
dexServiceURL = "http://kuberpult-dex:5556"
// Dex issuer path. Needs to be match the dex issuer helm config.
issuerPATH = "/dex"
// Dex callback path. Needs to be match the dex staticClients.redirectURIs helm config.
callbackPATH = "/callback"
// Kuberpult login path.
LoginPATH = "/login"
// Dex OAUTH token name.
dexOAUTHTokenName = "kuberpult.oauth"
// Default value for the number of days the token is valid for.
expirationDays = 1
)
// NewDexAppClient a Dex Client.
func NewDexAppClient(clientID, clientSecret, baseURL string, scopes []string) (*DexAppClient, error) {
a := DexAppClient{
Client: nil,
ClientID: clientID,
ClientSecret: clientSecret,
Scopes: scopes,
BaseURL: baseURL,
RedirectURI: baseURL + callbackPATH,
IssuerURL: baseURL + issuerPATH,
}
//exhaustruct:ignore
transport := &http.Transport{
Proxy: http.ProxyFromEnvironment,
}
//exhaustruct:ignore
a.Client = &http.Client{
Transport: transport,
}
// Creates a transport layer to map all requests to dex internally
dexURL, _ := url.Parse(dexServiceURL)
a.Client.Transport = DexRewriteURLRoundTripper{
DexURL: dexURL,
T: a.Client.Transport,
}
// Register Dex handlers.
a.registerDexHandlers()
return &a, nil
}
// DexRewriteURLRoundTripper creates a new DexRewriteURLRoundTripper.
// The round tripper is configured to avoid exposing the dex server via a virtual service. Since Kuberpult and dex
// are running on the same cluster, a reverse proxy is configured to redirect all dex calls internally.
type DexRewriteURLRoundTripper struct {
DexURL *url.URL
T http.RoundTripper
}
func (s DexRewriteURLRoundTripper) RoundTrip(r *http.Request) (*http.Response, error) {
r.URL.Host = s.DexURL.Host
r.URL.Scheme = s.DexURL.Scheme
r.Host = s.DexURL.Host
return s.T.RoundTrip(r)
}
// Registers dex handlers for login
func (a *DexAppClient) registerDexHandlers() {
// Handles calls to the Dex server. Calls are redirected internally using a reverse proxy.
http.HandleFunc(issuerPATH+"/", NewDexReverseProxy(dexServiceURL))
// Handles the login callback to redirect to dex page.
http.HandleFunc(LoginPATH, a.handleDexLogin)
// Call back to the current app once the login is finished
http.HandleFunc(callbackPATH, a.handleCallback)
}
// NewDexReverseProxy returns a reverse proxy to the Dex server.
func NewDexReverseProxy(serverAddr string) func(writer http.ResponseWriter, request *http.Request) {
target, err := url.Parse(serverAddr)
if err != nil {
logger.FromContext(context.Background()).Error(fmt.Sprintf("Could not parse server URL with error: %s", err))
return nil
}
proxy := httputil.NewSingleHostReverseProxy(target)
proxy.ModifyResponse = func(resp *http.Response) error {
if resp.StatusCode == http.StatusInternalServerError {
body, err := io.ReadAll(resp.Body)
if err != nil {
return err
}
err = resp.Body.Close()
if err != nil {
return err
}
logger.FromContext(context.Background()).Error(fmt.Sprintf("Could not parse server URL with error: %s", string(body)))
resp.Body = io.NopCloser(bytes.NewReader(make([]byte, 0)))
return nil
}
return nil
}
proxy.Director = decorateDirector(proxy.Director, target)
return func(w http.ResponseWriter, r *http.Request) {
proxy.ServeHTTP(w, r)
}
}
func decorateDirector(director func(req *http.Request), target *url.URL) func(req *http.Request) {
return func(req *http.Request) {
director(req)
req.Host = target.Host
}
}
// Redirects to the Dex login page with the pre configured connector.
func (a *DexAppClient) handleDexLogin(w http.ResponseWriter, r *http.Request) {
oauthConfig, err := a.oauth2Config(a.Scopes)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
// TODO(BB) Set an app state to make the connection more secure
authCodeURL := oauthConfig.AuthCodeURL("APP_STATE")
http.Redirect(w, r, authCodeURL, http.StatusSeeOther)
}
// HandleCallback is the callback handler for an OAuth2 login flow.
func (a *DexAppClient) handleCallback(w http.ResponseWriter, r *http.Request) {
oauth2Config, err := a.oauth2Config(nil)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
if errMsg := r.FormValue("error"); errMsg != "" {
errorDesc := r.FormValue("error_description")
http.Error(w, html.EscapeString(errMsg)+": "+html.EscapeString(errorDesc), http.StatusBadRequest)
return
}
code := r.FormValue("code")
ctx := oidc.ClientContext(r.Context(), a.Client)
token, err := oauth2Config.Exchange(ctx, code)
if err != nil {
http.Error(w, fmt.Sprintf("failed to get token: %v", err), http.StatusInternalServerError)
return
}
idTokenRAW, ok := token.Extra("id_token").(string)
if !ok {
http.Error(w, "no id_token in token response", http.StatusInternalServerError)
return
}
idToken, err := ValidateOIDCToken(ctx, a.IssuerURL, idTokenRAW, a.ClientID)
if err != nil {
http.Error(w, "failed to verify the token", http.StatusInternalServerError)
return
}
var claims jwt.MapClaims
err = idToken.Claims(&claims)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
// Stores the oauth token into the cookie.
if idTokenRAW != "" {
expiration := time.Now().Add(time.Duration(expirationDays) * 24 * time.Hour)
//exhaustruct:ignore
cookie := http.Cookie{
Name: dexOAUTHTokenName,
Value: idTokenRAW,
Expires: expiration,
Path: "/",
}
http.SetCookie(w, &cookie)
}
http.Redirect(w, r, a.BaseURL, http.StatusSeeOther)
}
func ValidateOIDCToken(ctx context.Context, issuerURL, rawToken string, allowedAudience string) (token *oidc.IDToken, err error) {
p, err := oidc.NewProvider(ctx, issuerURL)
if err != nil {
return nil, err
}
// Token must be verified against an allowed audience.
//exhaustruct:ignore
config := oidc.Config{ClientID: allowedAudience}
verifier := p.Verifier(&config)
idToken, err := verifier.Verify(ctx, rawToken)
if err != nil {
return nil, err
}
return idToken, nil
}
func (a *DexAppClient) oauth2Config(scopes []string) (c *oauth2.Config, err error) {
ctx := oidc.ClientContext(context.Background(), a.Client)
p, err := oidc.NewProvider(ctx, a.IssuerURL)
if err != nil {
return nil, err
}
return &oauth2.Config{
ClientID: a.ClientID,
ClientSecret: a.ClientSecret,
Endpoint: p.Endpoint(),
Scopes: scopes,
RedirectURL: a.RedirectURI,
}, nil
}
// Verifies if the user is authenticated.
func VerifyToken(ctx context.Context, r *http.Request, clientID, baseURL string) (jwt.MapClaims, error) {
// Get the token cookie from the request
cookie, err := r.Cookie(dexOAUTHTokenName)
if err != nil {
return nil, fmt.Errorf("%s token not found", dexOAUTHTokenName)
}
tokenString := cookie.Value
// Validates token audience and expiring date.
idToken, err := ValidateOIDCToken(ctx, baseURL+issuerPATH, tokenString, clientID)
if err != nil {
return nil, fmt.Errorf("failed to verify token: %s", err)
}
// Extract token claims and verify the token is not expired.
claims := jwt.MapClaims{
"groups": []string{},
"email": "",
"name": "",
"sub": "",
}
err = idToken.Claims(&claims)
if err != nil {
return nil, fmt.Errorf("could not parse token claims")
}
// check if claims is empty in terms of required fields for identification
if claims["email"].(string) == "" && len(claims["groups"].([]string)) < 1 {
return nil, fmt.Errorf("need required fields to determine group of user")
}
return claims, nil
}