File: middleware.go

package info (click to toggle)
golang-github-mendersoftware-go-lib-micro 0.0~git20211108.4e20429%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, experimental, forky, sid, trixie
  • size: 656 kB
  • sloc: makefile: 5
file content (215 lines) | stat: -rw-r--r-- 5,411 bytes parent folder | download
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
// Copyright 2021 Northern.tech AS
//
//    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 identity

import (
	"net/http"
	"regexp"

	"github.com/ant0ine/go-json-rest/rest"
	"github.com/gin-gonic/gin"

	"github.com/mendersoftware/go-lib-micro/log"
	urest "github.com/mendersoftware/go-lib-micro/rest.utils"
)

type MiddlewareOptions struct {
	// PathRegex sets the regex for the path for which this middleware
	// applies. Defaults to "^/api/management/v[0-9.]{1,6}/.+".
	PathRegex *string

	// UpdateLogger adds the decoded identity to the log context.
	UpdateLogger *bool
}

func NewMiddlewareOptions() *MiddlewareOptions {
	return new(MiddlewareOptions)
}

func (opts *MiddlewareOptions) SetPathRegex(regex string) *MiddlewareOptions {
	opts.PathRegex = &regex
	return opts
}

func (opts *MiddlewareOptions) SetUpdateLogger(updateLogger bool) *MiddlewareOptions {
	opts.UpdateLogger = &updateLogger
	return opts
}

func middlewareWithLogger(c *gin.Context) {
	var (
		err    error
		jwt    string
		idty   Identity
		logCtx = log.Ctx{}
		key    = "sub"
		ctx    = c.Request.Context()
		l      = log.FromContext(ctx)
	)
	jwt, err = ExtractJWTFromHeader(c.Request)
	if err != nil {
		goto exitUnauthorized
	}
	idty, err = ExtractIdentity(jwt)
	if err != nil {
		goto exitUnauthorized
	}
	ctx = WithContext(ctx, &idty)
	if idty.IsDevice {
		key = "device_id"
	} else if idty.IsUser {
		key = "user_id"
	}
	logCtx[key] = idty.Subject
	if idty.Tenant != "" {
		logCtx["tenant_id"] = idty.Tenant
	}
	if idty.Plan != "" {
		logCtx["plan"] = idty.Plan
	}
	ctx = log.WithContext(ctx, l.F(logCtx))

	c.Request = c.Request.WithContext(ctx)
	return
exitUnauthorized:
	c.Header("WWW-Authenticate", `Bearer realm="ManagementJWT"`)
	urest.RenderError(c, http.StatusUnauthorized, err)
	c.Abort()
}

func middlewareBase(c *gin.Context) {
	var (
		err  error
		jwt  string
		idty Identity
		ctx  = c.Request.Context()
	)
	jwt, err = ExtractJWTFromHeader(c.Request)
	if err != nil {
		goto exitUnauthorized
	}
	idty, err = ExtractIdentity(jwt)
	if err != nil {
		goto exitUnauthorized
	}
	ctx = WithContext(ctx, &idty)
	c.Request = c.Request.WithContext(ctx)
	return
exitUnauthorized:
	c.Header("WWW-Authenticate", `Bearer realm="ManagementJWT"`)
	urest.RenderError(c, http.StatusUnauthorized, err)
	c.Abort()
}

func Middleware(opts ...*MiddlewareOptions) gin.HandlerFunc {

	var middleware gin.HandlerFunc

	// Initialize default options
	opt := NewMiddlewareOptions().
		SetUpdateLogger(true)
	for _, o := range opts {
		if o == nil {
			continue
		}
		if o.PathRegex != nil {
			opt.PathRegex = o.PathRegex
		}
		if o.UpdateLogger != nil {
			opt.UpdateLogger = o.UpdateLogger
		}
	}

	if *opt.UpdateLogger {
		middleware = middlewareWithLogger
	} else {
		middleware = middlewareBase
	}

	if opt.PathRegex != nil {
		pathRegex := regexp.MustCompile(*opt.PathRegex)
		return func(c *gin.Context) {
			if !pathRegex.MatchString(c.FullPath()) {
				return
			}
			middleware(c)
		}
	}
	return middleware
}

// IdentityMiddleware adds the identity extracted from JWT token to the request's context.
// IdentityMiddleware does not perform any form of token signature verification.
// If it is not possible to extract identity from header error log will be generated.
// IdentityMiddleware will not stop control propagating through the chain in any case.
// It is recommended to use IdentityMiddleware with RequestLogMiddleware and
// RequestLogMiddleware should be placed before IdentityMiddleware.
// Otherwise, log generated by IdentityMiddleware will not contain "request_id" field.
type IdentityMiddleware struct {
	// If set to true, the middleware will update context logger setting
	// 'user_id' or 'device_id' to the value of subject field, if the token
	// is not a user or a device token, the middelware will add a 'sub'
	// field to the logger
	UpdateLogger bool
}

// MiddlewareFunc makes IdentityMiddleware implement the Middleware interface.
func (mw *IdentityMiddleware) MiddlewareFunc(h rest.HandlerFunc) rest.HandlerFunc {
	return func(w rest.ResponseWriter, r *rest.Request) {
		jwt, err := ExtractJWTFromHeader(r.Request)
		if err != nil {
			h(w, r)
			return
		}

		ctx := r.Context()
		l := log.FromContext(ctx)

		identity, err := ExtractIdentity(jwt)
		if err != nil {
			l.Warnf("Failed to parse extracted JWT: %s",
				err.Error(),
			)
		} else {
			if mw.UpdateLogger {
				logCtx := log.Ctx{}

				key := "sub"
				if identity.IsDevice {
					key = "device_id"
				} else if identity.IsUser {
					key = "user_id"
				}

				logCtx[key] = identity.Subject

				if identity.Tenant != "" {
					logCtx["tenant_id"] = identity.Tenant
				}

				if identity.Plan != "" {
					logCtx["plan"] = identity.Plan
				}

				l = l.F(logCtx)
				ctx = log.WithContext(ctx, l)
			}
			ctx = WithContext(ctx, &identity)
			r.Request = r.WithContext(ctx)
		}

		h(w, r)
	}
}