-
Notifications
You must be signed in to change notification settings - Fork 0
/
middleware.go
115 lines (99 loc) · 4.14 KB
/
middleware.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
package jwt_flow
import (
"context"
"fmt"
"net/http"
"regexp"
"github.com/taliesins/traefik-plugin-oidc/log"
"github.com/taliesins/traefik-plugin-oidc/log/encoder"
)
// ContextKey is the key used in the request
// context where the information from a
// validated JWT will be stored.
type ContextKey struct{}
type JWTMiddleware struct {
validateToken ValidateToken
errorHandler ErrorHandler
successHandler SuccessHandler
tokenExtractor TokenExtractor
credentialsOptional bool
validateOnOptions bool
ignorePathRegex *regexp.Regexp
}
// ValidateToken takes in a string JWT and makes sure it is valid and
// returns the valid token. If it is not valid it will return nil and
// an error message describing why validation failed.
// Inside ValidateToken things like key and alg checking can happen.
// In the default implementation we can add safe defaults for those.
type ValidateToken func(logger *log.Logger, context context.Context, token string) (interface{}, error)
// New constructs a new JWTMiddleware instance with the supplied options.
// It requires a ValidateToken function to be passed in, so it can
// properly validate tokens.
func New(validateToken ValidateToken, opts ...Option) *JWTMiddleware {
m := &JWTMiddleware{
validateToken: validateToken,
errorHandler: DefaultErrorHandler,
successHandler: DefaultSuccessHandler,
credentialsOptional: false,
tokenExtractor: AuthHeaderTokenExtractor,
validateOnOptions: true,
ignorePathRegex: nil,
}
for _, opt := range opts {
opt(m)
}
return m
}
// Flow is the orchestration flow that is used
type Flow func(logger *log.Logger, w http.ResponseWriter, r *http.Request)
// DefaultFlow is jwt token extraction, jwt token validation and then either success or failure handlers
func (m *JWTMiddleware) DefaultFlow(next http.Handler) Flow {
return func(logger *log.Logger, w http.ResponseWriter, r *http.Request) {
// If we don't validate on OPTIONS and this is OPTIONS
// then continue onto next without validating.
if !m.validateOnOptions && r.Method == http.MethodOptions {
logger.Debug("Skipping validation as its an options request", []encoder.Field{encoder.String("requestMethod", r.Method)})
m.successHandler(logger, next, w, r, "")
return
}
if m.ignorePathRegex != nil && m.ignorePathRegex.MatchString(r.URL.Path) {
logger.Debug("Skipping validation as request matches ignore regex path", []encoder.Field{encoder.String("requestUrlPath", r.URL.Path)})
m.successHandler(logger, next, w, r, "")
return
}
token, err := m.tokenExtractor(logger, r)
if err != nil {
// This is not ErrJWTMissing because an error here means that the
// tokenExtractor had an error and _not_ that the token was missing.
logger.Debug("Was not able to extract token", []encoder.Field{encoder.Error(err), encoder.String("requestUrlPath", r.URL.Path)})
m.errorHandler(logger, w, r, fmt.Errorf("error extracting token: %w", err))
return
}
if token == "" {
// If credentials are optional continue
// onto next without validating.
if m.credentialsOptional {
logger.Debug("Credentials have not been supplied but they are optional", []encoder.Field{encoder.String("requestUrlPath", r.URL.Path)})
m.successHandler(logger, next, w, r, "")
return
}
// Credentials were not optional so we error.
logger.Debug("Token is empty and it is not optional", []encoder.Field{encoder.Error(err), encoder.String("requestUrlPath", r.URL.Path)})
m.errorHandler(logger, w, r, ErrJWTMissing)
return
}
// Validate the token using the token validator.
validToken, err := m.validateToken(logger, r.Context(), token)
if err != nil {
logger.Debug("Not able to validate token", []encoder.Field{encoder.Error(err), encoder.String("token", token)})
m.errorHandler(logger, w, r, &invalidError{details: err})
return
}
// No err means we have a valid token, so set
// it into the context and continue onto next.
r = r.Clone(context.WithValue(r.Context(), ContextKey{}, validToken))
logger.Debug("Valid token", []encoder.Field{encoder.String("token", token)})
m.successHandler(logger, next, w, r, token)
return
}
}