Skip to content

Commit 4e0caef

Browse files
committed
up
1 parent cb4d18b commit 4e0caef

File tree

3 files changed

+15
-10
lines changed

3 files changed

+15
-10
lines changed

crowdsec-docs/docs/appsec/intro.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,33 @@ This component capitalizes on existing remediation functions in web servers (suc
2323

2424
![appsec-global](/img/appsec-global.png)
2525

26-
## Request inspection
26+
1) The Web Server receives the HTTP request
27+
2) The HTTP Request is intercepted and passed to the Crowdsec Security Engine via [the HTTP API](/appsec/protocol.md)
28+
3) The Security Engine answers to the Web Server once the Appsec inband rules have been processed.
29+
4) Based on the [Security Engine answer](/appsec/protocol#response-code), the Web Server either blocks the HTTP Request or processes it as usual
2730

28-
Examining Three Key Layers of the AppSec Component's Request Inspection
31+
## Inband Rules and Out-Of-Band Rules
2932

30-
### 1 Remediation component: request relaying
33+
The AppSec component relies on rules to inspect HTTP Requests:
34+
- Inband rules are meant to interrupt request processing
35+
- Out-Of-Band rules are non-blocking and are evaluated asynchronously
3136

32-
If the AppSec capability is activated on the remediation component, the incoming requests will be channeled to the CrowdSec Security engine.
33-
34-
### 2 Security Engine: inband rule processing
37+
### Inband rule processing
3538

3639
The security engine first evaluates the inband rules, designed to identify and block specific requests.
3740
Once these rules are evaluated, a response is relayed to the remediation component.
3841

3942
This leads to two possible outcomes:
4043

41-
1. If no inband rule is triggered, the processing of the request will continue on the web-server side as usual
42-
2. If an inband rule is triggered, the remediation component will answer with a 403 or a captcha request to the user of the incriminated request, stopping the request processing.
44+
1. If an inband rule is triggered, the remediation component will answer with a 403 or a captcha request to the user of the incriminated request, stopping the request processing.
45+
2. Otherwise, the request will be normally processed
4346

44-
### 3 Security Engine: out-of-band rules processing
47+
### Out-of-band rules processing
4548

4649
In the background, the security engine will then evaluate the out-of-band rules. These rules do not impact performance or response time, as they are evaluated after the AppSec Component instructs the webserver to continue or stop processing the request.
4750

51+
They are usually meant to detect unwanted behaviors that exhibit a repetitive aspect (ie. Applicative Spam, Resource enumeration, Scalping etc.). When those rules trigger, they emit an event is processed by the Security Engine in the same way a log line is.
52+
4853
## Post processing
4954

5055
When a request triggers one or more rules, either in the inband section (blocking) or out-of-band (non-blocking), several things happen:

crowdsec-docs/docs/intro.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Distributed architecture example:
8282

8383
<div style={{display: 'flex'}}>
8484
<div style={{textAlign: 'center', flex: '1'}}>
85-
<img src={useBaseUrl('/img/distributed_SE_setup.png.png')}></img>
85+
<img src={useBaseUrl('/img/distributed_SE_setup.png')}></img>
8686
</div>
8787
</div>
8888

272 KB
Loading

0 commit comments

Comments
 (0)