Skip to content

Commit 654f5cf

Browse files
committed
feat(waf): continue doc
1 parent 53f733b commit 654f5cf

File tree

3 files changed

+103
-13
lines changed

3 files changed

+103
-13
lines changed
5.75 KB
Loading

pages/edge-services/how-to/configure-waf.mdx

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,99 @@ WAF is not available for Object Storage bucket origins.
4848
4. Select a WAF **mode**. Requests judged to be malicious can either be **blocked** and prevented from passing to the Load Balancer origin, or **logged** but allowed to pass.
4949

5050
5. Click **Save**
51+
52+
WAF is enabled and you are returned to your Edge Services pipeline overview. You can disable or edit WAF settings at any time.
53+
54+
## How to set exclusions
55+
56+
Once you have enabled WAF, you can choose to set **exclusions**. Exclusions are a set of filters: requests that match the filters are not evaluated by WAF, and pass directly to your Load Balancer origin.
57+
58+
1. In the Scaleway console, navigate to the Edge Services dashboard for the Load Balancer pipeline on which you want to set WAF exclusions.
59+
60+
2. In the **WAF** panel, click **+ Add exclusions**. WAF goes into Edit mode.
61+
62+
<Message type="note">
63+
You can only add exclusions **after** you have already enabled WAF.
64+
</Message>
65+
66+
The following screen displays:
67+
68+
<Lightbox src="scaleway-add-exclusions.webp" alt="A screenshot of the Add exclusions popup in the Scaleway console, with an 'if' box to set a path regex value, and a 'then' box pre-filled to 'Bypass WAF'" /> TODO CHANGE NEW BUTTON?
69+
70+
3. Set up to two filters for this exclusion. You can add either:
71+
- One ***Path regex** filter, to match paths of requests to exclude. For example, TODO
72+
- One **HTTP method** filter, to match te HTTP methods of requests to exclude. For example, enter one or more of `GET`, `PATCH`, `PUT`, `DELETE` etc. Requests that match any of these methods will be considered to match the HTTP method filter.
73+
- One of each of the above (use the **Add filter** button to add the second filter)
74+
75+
If you include both a path regex and an HTTP method filter in the same exclusion, requests must match both of the filters in order to be excluded.
76+
77+
Currently, the only action possible to set for matching requests is **Bypass WAF** (matching requests will not be evaluated by WAF and will proceed directly to the Load Balancer origin.) In the future, more actions will be added.
78+
79+
4. Click **Add** to add the exclusion.
80+
81+
You are returned to your Edge Services pipeline overview.
82+
83+
5. **Optional** Click **Add exclusions** to add more exclusions, if you wish (maximum 100). Follow steps 3 to 4 each time.
84+
85+
6. Click **Save changes** to exit Edit mode and save all the exclusions you added.
86+
87+
## How to edit exclusions
88+
89+
1. In the Scaleway console, navigate to the Edge Services dashboard for the Load Balancer pipeline on which you want to edit WAF exclusions.
90+
91+
2. In the WAF panel, click <Icon name="edit" /> next to the exclusion you want to edit.
92+
93+
3. Make edits to the filters as required. Remember, you cannot add more than one filter of each type (maximum of one path regex and one HTTP method filter per exclusion).
94+
95+
4. Click **Confirm** when you have finished editing.
96+
97+
You are returned to your Edge Services pipeline overview, but you are still in Edit mode.
98+
99+
5. Continue to edit or delete other exclusions as necessary.
100+
101+
6. Click **Save changes** to exit Edit mode and save all your changes.
102+
103+
## How to delete exclusions
104+
105+
1. In the Scaleway console, navigate to the Edge Services dashboard for the Load Balancer pipeline on which you want to delete WAF exclusions.
106+
107+
2. In the WAF panel, click <Icon name="delete" /> next to the exclusion you want to delete.
108+
109+
WAF goes into Edit mode, and a pop-up displays, asking you to confirm the deletion.
110+
111+
3. Click **Delete**.
112+
113+
You are returned to your Edge Services pipeline overview, but you are still in Edit mode.
114+
115+
4. Continue to edit or delete other exclusions as necessary.
116+
117+
6. Click **Save changes** to exit Edit mode and save all your changes and deletions.
118+
119+
## How to edit WAF configuration
120+
121+
You can edit WAF's paranoia level and mode (log or block) at any time.
122+
123+
1. In the Scaleway console, navigate to the Edge Services dashboard for the Load Balancer pipeline on which you want to edit WAF.
124+
125+
2. In the WAF panel, click <Icon name="edit" />.
126+
127+
3. Edit the paranoia level and mode as required.
128+
129+
4. Click **Save**.
130+
131+
Your edits are saved, and you are returned to teh Edge Services pipeline dashboard.
132+
133+
## How to disable WAF
134+
135+
You can disable WAF at any time.
136+
137+
1. In the Scaleway console, navigate to the Edge Services dashboard for the Load Balancer pipeline on which you want to disable WAF.
138+
139+
2. In the WAF panel, click **Disable WAF**.
140+
141+
A pop-up displays, informing you that WAF will no longer evaluate, block or log requests to your Load Balancer origin.
142+
143+
3. Click **Disable** to confirm.
144+
145+
WAF is disabled and you are returned to your Edge Services' pipeline overview.
146+

pages/edge-services/reference-content/understanding-waf.mdx

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,19 @@ categories:
1313
- network
1414
---
1515

16-
<Message type="note">
17-
WAF is in Public Beta, and currently available only via the [Edge Services API](https://www.scaleway.com/en/developers/api/edge-services/). It will be coming soon to the Scaleway console.
18-
</Message>
19-
20-
If your Edge Services pipeline points towards a Load Balancer origin, you can choose to enable the **W**eb **A**pplication **F**irewall (WAF) feature, for added protection. This documentation page gives a detailed overview of WAF, and the different settings, modes and functionalities available.
16+
You can choose to enable the **W**eb **A**pplication **F**irewall (WAF) feature on your Edge Services pipeline, for added protection. This documentation page gives a detailed overview of WAF, and the different settings, modes and functionalities available.
2117

2218
## WAF overview
2319

24-
When enabled, WAF protects your Load Balancer backend from potential threats.
20+
When enabled, WAF protects your Load Balancer origin or Object Storage bucket from potential threats.
2521

26-
It does so by evaluating each request to your Load Balancer origin, to determine whether it is potentially malicious. Four different rulesets can be used to evaluate requests, each more aggressive than the last. The ruleset to use is determined by the **paranoia level** set by the user.
22+
It does so by evaluating each request to your origin, to determine whether it is potentially malicious. Four different rulesets can be used to evaluate requests, each more aggressive than the last. The ruleset to use is determined by the **paranoia level** set by the user.
2723

28-
For requests judged to be malicious, WAF can either block them from passing to your origin (as shown in the diagram below), or simply log them but allow them to pass, depending on the settings you choose.
24+
For requests judged to be malicious, WAF can either block them from passing to your origin, or simply log them but allow them to pass, depending on the settings you choose.
2925

30-
You can set **exclusions**, so that certain requests are not evaluated by WAF and are allowed to pass directly to your Load Balancer origin. Exclusion filters are based on the request path and/or HTTP request type.
26+
You can set **exclusions**, so that certain requests are not evaluated by WAF and are allowed to pass directly to your origin. Exclusion filters are based on the request path and/or HTTP request type.
3127

32-
<Lightbox src="scaleway-edge-services-waf-diag.webp" alt="A diagram shows how Edge Services WAF deals with three different types of HTTP request. A request meeting the criteria for WAF exclusion is passed directly to the Load Balancer origin. A benign request is first checked by the WAF rules, then allowed to pass to the Load Balancer origin. A malicious request is checked by the rules, and blocked from passing to the Load Balancer origin." />
28+
TODO WAF diagram?
3329

3430
## WAF in an Edge Services pipeline
3531

@@ -91,8 +87,6 @@ Each exclusion can consist of:
9187

9288
## WAF limitations
9389

94-
- WAF is in Public Beta, and currently available only via the [Edge Services API](https://www.scaleway.com/en/developers/api/edge-services/).
95-
- WAF is only compatible with Load Balancer origins. It cannot be enabled for Object Storage bucket origins.
9690
- WAF protects your origin only, and not your cache.
9791
- You can add a maximum of 100 WAF exclusions
98-
- You cannot currently specify exclusions at the individual rule level. Requests matching exclusion filters bypass WAF entirely.
92+
- You cannot currently specify exclusions at the individual rule level. Requests matching exclusion filters bypass WAF entirely.

0 commit comments

Comments
 (0)