-
Notifications
You must be signed in to change notification settings - Fork 52
/
openapi.go
435 lines (386 loc) · 15 KB
/
openapi.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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
package proxy
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"strings"
"github.com/getkin/kin-openapi/openapi3"
"github.com/getkin/kin-openapi/openapi3filter"
"github.com/savsgio/gotils/strconv"
"github.com/sirupsen/logrus"
"github.com/valyala/fasthttp"
"github.com/valyala/fasthttp/fasthttpadaptor"
"github.com/valyala/fastjson"
"github.com/wallarm/api-firewall/internal/config"
"github.com/wallarm/api-firewall/internal/platform/loader"
"github.com/wallarm/api-firewall/internal/platform/oauth2"
"github.com/wallarm/api-firewall/internal/platform/proxy"
"github.com/wallarm/api-firewall/internal/platform/router"
"github.com/wallarm/api-firewall/internal/platform/validator"
"github.com/wallarm/api-firewall/internal/platform/web"
)
type openapiWaf struct {
customRoute *loader.CustomRoute
proxyPool proxy.Pool
logger *logrus.Logger
cfg *config.ProxyMode
parserPool *fastjson.ParserPool
oauthValidator oauth2.OAuth2
}
// EXPERIMENTAL feature
// returns APIFW-Validation-Status header value
func getValidationHeader(ctx *fasthttp.RequestCtx, err error) *string {
var reason = "unknown"
switch err := err.(type) {
case *openapi3filter.ResponseError:
if err.Reason != "" {
reason = err.Reason
}
id := fmt.Sprintf("response-%d-%s", ctx.Response.StatusCode(), strings.Split(strconv.B2S(ctx.Response.Header.ContentType()), ";")[0])
value := fmt.Sprintf("%s:%s:response", id, reason)
return &value
case *openapi3filter.RequestError:
if err.Reason != "" {
reason = err.Reason
}
if err.Parameter != nil {
paramName := "request-parameter"
if err.Reason == "" {
schemaError, ok := err.Err.(*openapi3.SchemaError)
if ok && schemaError.Reason != "" {
reason = schemaError.Reason
}
paramName = err.Parameter.Name
}
value := fmt.Sprintf("request-parameter:%s:%s", reason, paramName)
return &value
}
if err.RequestBody != nil {
id := fmt.Sprintf("request-body-%s", strings.Split(strconv.B2S(ctx.Request.Header.ContentType()), ";")[0])
value := fmt.Sprintf("%s:%s:request-body", id, reason)
return &value
}
case *openapi3filter.SecurityRequirementsError:
secRequirements := err.SecurityRequirements
secSchemeName := ""
for _, scheme := range secRequirements {
for key := range scheme {
secSchemeName += key + ","
}
}
secErrors := ""
for _, secError := range err.Errors {
secErrors += secError.Error() + ","
}
value := fmt.Sprintf("security-requirements-%s:%s:%s", strings.TrimSuffix(secSchemeName, ","), strings.TrimSuffix(secErrors, ","), strings.TrimSuffix(secSchemeName, ","))
return &value
}
return nil
}
func (s *openapiWaf) openapiWafHandler(ctx *fasthttp.RequestCtx) error {
// Pass OPTIONS if the feature is enabled
var isOptionsReq, ok bool
if isOptionsReq, ok = ctx.UserValue(web.PassRequestOPTIONS).(bool); !ok {
isOptionsReq = false
}
// Proxy request if APIFW is disabled
if isOptionsReq == true ||
strings.EqualFold(s.cfg.RequestValidation, web.ValidationDisable) && strings.EqualFold(s.cfg.ResponseValidation, web.ValidationDisable) {
if err := proxy.Perform(ctx, s.proxyPool, s.cfg.Server.RequestHostHeader); err != nil {
s.logger.WithFields(logrus.Fields{
"error": err,
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"method": strconv.B2S(ctx.Request.Header.Method()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Error while proxying request")
}
return nil
}
// If Validation is BLOCK for request and response then respond by CustomBlockStatusCode
if s.customRoute == nil {
// route for the request not found
ctx.SetUserValue(web.RequestProxyNoRoute, true)
if strings.EqualFold(s.cfg.RequestValidation, web.ValidationBlock) || strings.EqualFold(s.cfg.ResponseValidation, web.ValidationBlock) {
if s.cfg.AddValidationStatusHeader {
vh := "request: customRoute not found"
return web.RespondError(ctx, s.cfg.CustomBlockStatusCode, vh)
}
return web.RespondError(ctx, s.cfg.CustomBlockStatusCode, "")
}
if err := proxy.Perform(ctx, s.proxyPool, s.cfg.Server.RequestHostHeader); err != nil {
s.logger.WithFields(logrus.Fields{
"error": err,
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"method": strconv.B2S(ctx.Request.Header.Method()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Error while proxying request")
}
return nil
}
var pathParams map[string]string
if s.customRoute.ParametersNumberInPath > 0 {
pathParams = router.AllURLParams(ctx)
}
// Convert fasthttp request to net/http request
req := http.Request{}
if err := fasthttpadaptor.ConvertRequest(ctx, &req, false); err != nil {
s.logger.WithFields(logrus.Fields{
"error": err,
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"method": strconv.B2S(ctx.Request.Header.Method()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Error while converting http request")
return web.RespondError(ctx, fasthttp.StatusBadRequest, "")
}
// decode request body
requestContentEncoding := strconv.B2S(ctx.Request.Header.ContentEncoding())
if requestContentEncoding != "" {
var err error
req.Body, err = web.GetDecompressedRequestBody(&ctx.Request, requestContentEncoding)
if err != nil {
s.logger.WithFields(logrus.Fields{
"error": err,
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"method": strconv.B2S(ctx.Request.Header.Method()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Request body decompression error")
return err
}
}
// Validate request
requestValidationInput := &openapi3filter.RequestValidationInput{
Request: &req,
PathParams: pathParams,
Route: s.customRoute.Route,
QueryParams: req.URL.Query(),
Options: &openapi3filter.Options{
AuthenticationFunc: func(ctx context.Context, input *openapi3filter.AuthenticationInput) error {
switch input.SecurityScheme.Type {
case "http":
switch input.SecurityScheme.Scheme {
case "basic":
bHeader := input.RequestValidationInput.Request.Header.Get("Authorization")
if bHeader == "" || !strings.HasPrefix(strings.ToLower(bHeader), "basic ") {
return errors.New("missing basic authorization header")
}
case "bearer":
bHeader := input.RequestValidationInput.Request.Header.Get("Authorization")
if bHeader == "" || !strings.HasPrefix(strings.ToLower(bHeader), "bearer ") {
return errors.New("missing bearer authorization header")
}
}
case "oauth2", "openIdConnect":
if s.oauthValidator == nil {
return errors.New("oauth2 validator not configured")
}
if err := s.oauthValidator.Validate(ctx, input.RequestValidationInput.Request.Header.Get("Authorization"), input.Scopes); err != nil {
return fmt.Errorf("oauth2 error: %s", err)
}
case "apiKey":
switch input.SecurityScheme.In {
case "header":
if input.RequestValidationInput.Request.Header.Get(input.SecurityScheme.Name) == "" {
return fmt.Errorf("missing %s header", input.SecurityScheme.Name)
}
case "query":
if input.RequestValidationInput.Request.URL.Query().Get(input.SecurityScheme.Name) == "" {
return fmt.Errorf("missing %s query parameter", input.SecurityScheme.Name)
}
case "cookie":
_, err := input.RequestValidationInput.Request.Cookie(input.SecurityScheme.Name)
if err != nil {
return fmt.Errorf("missing %s cookie", input.SecurityScheme.Name)
}
}
}
return nil
},
},
}
// Get fastjson parser
jsonParser := s.parserPool.Get()
defer s.parserPool.Put(jsonParser)
switch strings.ToLower(s.cfg.RequestValidation) {
case web.ValidationBlock:
if err := validator.ValidateRequest(ctx, requestValidationInput, jsonParser); err != nil {
isRequestBlocked := true
if requestErr, ok := err.(*openapi3filter.RequestError); ok {
// body parser not found
if strings.HasPrefix(requestErr.Error(), "request body has an error: failed to decode request body: unsupported content type") {
s.logger.WithFields(logrus.Fields{
"error": err,
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"method": strconv.B2S(ctx.Request.Header.Method()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Request body parsing error: request passed")
isRequestBlocked = false
}
}
if isRequestBlocked {
// request has been blocked
ctx.SetUserValue(web.RequestBlocked, true)
s.logger.WithFields(logrus.Fields{
"error": strings.ReplaceAll(err.Error(), "\n", " "),
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"method": strconv.B2S(ctx.Request.Header.Method()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Request validation error: request blocked")
if s.cfg.AddValidationStatusHeader {
if vh := getValidationHeader(ctx, err); vh != nil {
s.logger.WithFields(logrus.Fields{
"error": err,
"request_id": ctx.UserValue(web.RequestID),
}).Errorf("add header %s: %s", web.ValidationStatus, *vh)
ctx.Request.Header.Add(web.ValidationStatus, *vh)
return web.RespondError(ctx, s.cfg.CustomBlockStatusCode, *vh)
}
}
return web.RespondError(ctx, s.cfg.CustomBlockStatusCode, "")
}
}
if s.cfg.ShadowAPI.UnknownParametersDetection {
upResults, valUPReqErrors := validator.ValidateUnknownRequestParameters(ctx, requestValidationInput.Route, req.Header, jsonParser)
// log only error and pass request if unknown params module can't parse it
if valUPReqErrors != nil {
s.logger.WithFields(logrus.Fields{
"error": valUPReqErrors,
"request_id": ctx.UserValue(web.RequestID),
}).Warning("Shadow API: searching for undefined parameters")
}
if len(upResults) > 0 {
unknownParameters, _ := json.Marshal(upResults)
s.logger.WithFields(logrus.Fields{
"errors": strconv.B2S(unknownParameters),
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"method": strconv.B2S(ctx.Request.Header.Method()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Shadow API: undefined parameters found")
// request has been blocked
ctx.SetUserValue(web.RequestBlocked, true)
return web.RespondError(ctx, s.cfg.CustomBlockStatusCode, "")
}
}
case web.ValidationLog:
if err := validator.ValidateRequest(ctx, requestValidationInput, jsonParser); err != nil {
s.logger.WithFields(logrus.Fields{
"error": strings.ReplaceAll(err.Error(), "\n", " "),
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"method": strconv.B2S(ctx.Request.Header.Method()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Request validation error")
}
if s.cfg.ShadowAPI.UnknownParametersDetection {
upResults, valUPReqErrors := validator.ValidateUnknownRequestParameters(ctx, requestValidationInput.Route, req.Header, jsonParser)
// log only error and pass request if unknown params module can't parse it
if valUPReqErrors != nil {
s.logger.WithFields(logrus.Fields{
"error": valUPReqErrors,
"request_id": ctx.UserValue(web.RequestID),
}).Warning("Shadow API: searching for undefined parameters")
}
if len(upResults) > 0 {
unknownParameters, _ := json.Marshal(upResults)
s.logger.WithFields(logrus.Fields{
"errors": strconv.B2S(unknownParameters),
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"method": strconv.B2S(ctx.Request.Header.Method()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Shadow API: undefined parameters found")
}
}
}
if err := proxy.Perform(ctx, s.proxyPool, s.cfg.Server.RequestHostHeader); err != nil {
s.logger.WithFields(logrus.Fields{
"error": err,
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Error while proxying request")
return nil
}
// Prepare http response headers
respHeader := http.Header{}
ctx.Response.Header.VisitAll(func(k, v []byte) {
sk := strconv.B2S(k)
sv := strconv.B2S(v)
respHeader.Set(sk, sv)
})
// decode response body
responseBodyReader, err := web.GetDecompressedResponseBody(&ctx.Response, strconv.B2S(ctx.Response.Header.ContentEncoding()))
if err != nil {
s.logger.WithFields(logrus.Fields{
"error": err,
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Response body decompression error")
return err
}
responseValidationInput := &openapi3filter.ResponseValidationInput{
RequestValidationInput: requestValidationInput,
Status: ctx.Response.StatusCode(),
Header: respHeader,
Body: responseBodyReader,
Options: &openapi3filter.Options{
ExcludeRequestBody: false,
ExcludeResponseBody: false,
IncludeResponseStatus: true,
MultiError: false,
AuthenticationFunc: nil,
},
}
// Validate response
switch strings.ToLower(s.cfg.ResponseValidation) {
case web.ValidationBlock:
if err := validator.ValidateResponse(ctx, responseValidationInput, jsonParser); err != nil {
// response has been blocked
ctx.SetUserValue(web.ResponseBlocked, true)
s.logger.WithFields(logrus.Fields{
"error": err,
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Response validation error")
if s.cfg.AddValidationStatusHeader {
if vh := getValidationHeader(ctx, err); vh != nil {
s.logger.WithFields(logrus.Fields{
"error": err,
"request_id": ctx.UserValue(web.RequestID),
}).Errorf("Add header %s: %s", web.ValidationStatus, *vh)
ctx.Response.Header.Add(web.ValidationStatus, *vh)
return web.RespondError(ctx, s.cfg.CustomBlockStatusCode, *vh)
}
}
return web.RespondError(ctx, s.cfg.CustomBlockStatusCode, "")
}
case web.ValidationLog:
if err := validator.ValidateResponse(ctx, responseValidationInput, jsonParser); err != nil {
if respErr, ok := err.(*openapi3filter.ResponseError); ok {
// body parser not found
if respErr.Reason == "status is not supported" {
// received response status was not found in the OpenAPI spec
ctx.SetUserValue(web.ResponseStatusNotFound, true)
}
return nil
}
s.logger.WithFields(logrus.Fields{
"error": err,
"host": strconv.B2S(ctx.Request.Header.Host()),
"path": strconv.B2S(ctx.Path()),
"request_id": ctx.UserValue(web.RequestID),
}).Error("Response validation error")
}
}
return nil
}