-
Notifications
You must be signed in to change notification settings - Fork 1
/
protection_settings.go
147 lines (121 loc) · 9.1 KB
/
protection_settings.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
// Copyright (c) 2016, 2018, 2021, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
// Web Application Acceleration and Security Services API
//
// OCI Web Application Acceleration and Security Services
//
package waas
import (
"github.com/erikcai/oci-go-sdk/v33/common"
)
// ProtectionSettings The settings used for protection rules.
type ProtectionSettings struct {
// If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`.
BlockAction ProtectionSettingsBlockActionEnum `mandatory:"false" json:"blockAction,omitempty"`
// The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`.
BlockResponseCode *int `mandatory:"false" json:"blockResponseCode"`
// The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.'
BlockErrorPageMessage *string `mandatory:"false" json:"blockErrorPageMessage"`
// The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`.
BlockErrorPageCode *string `mandatory:"false" json:"blockErrorPageCode"`
// The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.`
BlockErrorPageDescription *string `mandatory:"false" json:"blockErrorPageDescription"`
// The maximum number of arguments allowed to be passed to your application before an action is taken. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `255`. This setting only applies if a corresponding protection rule is enabled, such as the "Number of Arguments Limits" rule (key: 960335).
// Example: If `maxArgumentCount` to `2` for the Max Number of Arguments protection rule (key: 960335), the following requests would be blocked:
// `GET /myapp/path?query=one&query=two&query=three`
// `POST /myapp/path` with Body `{"argument1":"one","argument2":"two","argument3":"three"}`
MaxArgumentCount *int `mandatory:"false" json:"maxArgumentCount"`
// The maximum length allowed for each argument name, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `400`. This setting only applies if a corresponding protection rule is enabled, such as the "Values Limits" rule (key: 960208).
MaxNameLengthPerArgument *int `mandatory:"false" json:"maxNameLengthPerArgument"`
// The maximum length allowed for the sum of the argument name and value, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `64000`. This setting only applies if a corresponding protection rule is enabled, such as the "Total Arguments Limits" rule (key: 960341).
MaxTotalNameLengthOfArguments *int `mandatory:"false" json:"maxTotalNameLengthOfArguments"`
// The length of time to analyze traffic traffic, in days. After the analysis period, `WafRecommendations` will be populated. If unspecified, defaults to `10`.
// Use `GET /waasPolicies/{waasPolicyId}/wafRecommendations` to view WAF recommendations.
RecommendationsPeriodInDays *int `mandatory:"false" json:"recommendationsPeriodInDays"`
// Inspects the response body of origin responses. Can be used to detect leakage of sensitive data. If unspecified, defaults to `false`.
// **Note:** Only origin responses with a Content-Type matching a value in `mediaTypes` will be inspected.
IsResponseInspected *bool `mandatory:"false" json:"isResponseInspected"`
// The maximum response size to be fully inspected, in binary kilobytes (KiB). Anything over this limit will be partially inspected. If unspecified, defaults to `1024`.
MaxResponseSizeInKiB *int `mandatory:"false" json:"maxResponseSizeInKiB"`
// The list of allowed HTTP methods. If unspecified, default to `[OPTIONS, GET, HEAD, POST]`. This setting only applies if a corresponding protection rule is enabled, such as the "Restrict HTTP Request Methods" rule (key: 911100).
AllowedHttpMethods []ProtectionSettingsAllowedHttpMethodsEnum `mandatory:"false" json:"allowedHttpMethods,omitempty"`
// The list of media types to allow for inspection, if `isResponseInspected` is enabled. Only responses with MIME types in this list will be inspected. If unspecified, defaults to `["text/html", "text/plain", "text/xml"]`.
// Supported MIME types include:
// - text/html
// - text/plain
// - text/asp
// - text/css
// - text/x-script
// - application/json
// - text/webviewhtml
// - text/x-java-source
// - application/x-javascript
// - application/javascript
// - application/ecmascript
// - text/javascript
// - text/ecmascript
// - text/x-script.perl
// - text/x-script.phyton
// - application/plain
// - application/xml
// - text/xml
MediaTypes []string `mandatory:"false" json:"mediaTypes"`
}
func (m ProtectionSettings) String() string {
return common.PointerString(m)
}
// ProtectionSettingsBlockActionEnum Enum with underlying type: string
type ProtectionSettingsBlockActionEnum string
// Set of constants representing the allowable values for ProtectionSettingsBlockActionEnum
const (
ProtectionSettingsBlockActionShowErrorPage ProtectionSettingsBlockActionEnum = "SHOW_ERROR_PAGE"
ProtectionSettingsBlockActionSetResponseCode ProtectionSettingsBlockActionEnum = "SET_RESPONSE_CODE"
)
var mappingProtectionSettingsBlockAction = map[string]ProtectionSettingsBlockActionEnum{
"SHOW_ERROR_PAGE": ProtectionSettingsBlockActionShowErrorPage,
"SET_RESPONSE_CODE": ProtectionSettingsBlockActionSetResponseCode,
}
// GetProtectionSettingsBlockActionEnumValues Enumerates the set of values for ProtectionSettingsBlockActionEnum
func GetProtectionSettingsBlockActionEnumValues() []ProtectionSettingsBlockActionEnum {
values := make([]ProtectionSettingsBlockActionEnum, 0)
for _, v := range mappingProtectionSettingsBlockAction {
values = append(values, v)
}
return values
}
// ProtectionSettingsAllowedHttpMethodsEnum Enum with underlying type: string
type ProtectionSettingsAllowedHttpMethodsEnum string
// Set of constants representing the allowable values for ProtectionSettingsAllowedHttpMethodsEnum
const (
ProtectionSettingsAllowedHttpMethodsOptions ProtectionSettingsAllowedHttpMethodsEnum = "OPTIONS"
ProtectionSettingsAllowedHttpMethodsGet ProtectionSettingsAllowedHttpMethodsEnum = "GET"
ProtectionSettingsAllowedHttpMethodsHead ProtectionSettingsAllowedHttpMethodsEnum = "HEAD"
ProtectionSettingsAllowedHttpMethodsPost ProtectionSettingsAllowedHttpMethodsEnum = "POST"
ProtectionSettingsAllowedHttpMethodsPut ProtectionSettingsAllowedHttpMethodsEnum = "PUT"
ProtectionSettingsAllowedHttpMethodsDelete ProtectionSettingsAllowedHttpMethodsEnum = "DELETE"
ProtectionSettingsAllowedHttpMethodsTrace ProtectionSettingsAllowedHttpMethodsEnum = "TRACE"
ProtectionSettingsAllowedHttpMethodsConnect ProtectionSettingsAllowedHttpMethodsEnum = "CONNECT"
ProtectionSettingsAllowedHttpMethodsPatch ProtectionSettingsAllowedHttpMethodsEnum = "PATCH"
ProtectionSettingsAllowedHttpMethodsPropfind ProtectionSettingsAllowedHttpMethodsEnum = "PROPFIND"
)
var mappingProtectionSettingsAllowedHttpMethods = map[string]ProtectionSettingsAllowedHttpMethodsEnum{
"OPTIONS": ProtectionSettingsAllowedHttpMethodsOptions,
"GET": ProtectionSettingsAllowedHttpMethodsGet,
"HEAD": ProtectionSettingsAllowedHttpMethodsHead,
"POST": ProtectionSettingsAllowedHttpMethodsPost,
"PUT": ProtectionSettingsAllowedHttpMethodsPut,
"DELETE": ProtectionSettingsAllowedHttpMethodsDelete,
"TRACE": ProtectionSettingsAllowedHttpMethodsTrace,
"CONNECT": ProtectionSettingsAllowedHttpMethodsConnect,
"PATCH": ProtectionSettingsAllowedHttpMethodsPatch,
"PROPFIND": ProtectionSettingsAllowedHttpMethodsPropfind,
}
// GetProtectionSettingsAllowedHttpMethodsEnumValues Enumerates the set of values for ProtectionSettingsAllowedHttpMethodsEnum
func GetProtectionSettingsAllowedHttpMethodsEnumValues() []ProtectionSettingsAllowedHttpMethodsEnum {
values := make([]ProtectionSettingsAllowedHttpMethodsEnum, 0)
for _, v := range mappingProtectionSettingsAllowedHttpMethods {
values = append(values, v)
}
return values
}