Skip to content

Commit 7472fd1

Browse files
authored
Merge branch 'main' into values/parameters
2 parents 183ddcc + 2edd20b commit 7472fd1

653 files changed

Lines changed: 10692 additions & 55799 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
103 KB
Binary file not shown.
111 KB
Binary file not shown.
140 KB
Binary file not shown.

crowdsec-docs/docs/appsec/advanced_deployments.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
id: advanced_deployments
3-
title: Advanced WAF Deployments
3+
title: WAF Deployment Strategies
44
sidebar_position: 6
55
---
66

7-
# Advanced WAF Deployments
7+
# WAF Deployment Strategies
88

99
This guide covers advanced CrowdSec WAF deployment strategies for organizations looking to gradually enhance their web application security posture. Learn how to progressively improve your WAF configuration from basic virtual patching to comprehensive multi-layer protection.
1010

@@ -259,7 +259,7 @@ In-band CRS blocking provides maximum protection but requires:
259259

260260
Once you've implemented advanced deployments:
261261

262-
- Configure [Custom Rules](/appsec/create_rules.md) for application-specific protection
263-
- Set up [Hooks](/appsec/hooks.md) for custom response actions
264-
- Explore [Configuration Options](/appsec/configuration.md) for fine-tuning
265-
- Review [Troubleshooting Guide](/appsec/troubleshooting.md) for operational issues
262+
- Configure [Custom Rules](create_rules.md) for application-specific protection
263+
- Set up [Hooks](hooks.md) for custom response actions
264+
- Explore [Configuration Options](configuration.md) for fine-tuning
265+
- Review [Troubleshooting Guide](troubleshooting.md) for operational issues

crowdsec-docs/docs/appsec/alerts_and_scenarios.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 5
66

77
## Generated Events Layout
88

9-
HTTP requests that trigger _In-Band_ or _Out-Of-Band_ AppSec/WAF rules generate events. These events can trigger scenarios that react by banning or alerting when rules are matched.
9+
HTTP requests that trigger _In-Band_ or _Out-Of-Band_ AppSec/WAF rules generate events. These events can trigger scenarios that ban or alert when rules are matched.
1010

1111
The [`crowdsecurity/appsec-logs` parser](https://app.crowdsec.net/hub/author/crowdsecurity/configurations/appsec-logs) is designed as a general-purpose tool to convert events into a format that is easier to process with scenarios.
1212

@@ -21,7 +21,7 @@ The generated event looks like this:
2121
- `evt.Meta.target_host` is set to the FQDN if present (`Host` header in the HTTP request)
2222
- `evt.Meta.target_uri` is set to the complete URI of the HTTP request
2323
- `evt.Meta.rule_name` is set to the name of the triggered rule
24-
- `evt.Meta.remediation_cmpt_ip` is set to the IP of the Remediation Component (Bouncer) that sent the HTTP request.
24+
- `evt.Meta.remediation_cmpt_ip` is set to the IP of the Remediation Component (bouncer) that sent the HTTP request.
2525

2626
:::info
2727
The [`crowdsecurity/appsec-logs` parser](https://app.crowdsec.net/hub/author/crowdsecurity/configurations/appsec-logs) is already part of the generic AppSec/WAF collections and doesn't have to be manually installed.
@@ -56,7 +56,7 @@ Let's try to solve an imaginary scenario:
5656
> We aim to prevent users from enumerating certain URLs (specifically, those that begin with `/foobar/*`) when a particular HTTP header is present (`something: *test*`). However, we want to impose this restriction only on users attempting to access two or more distinct `/foobar/*` URLs while this header is set.
5757
5858
:::info
59-
Keep in mind that _Out-Of-Band_ rules will generate an event instead of blocking the HTTP Request.
59+
Keep in mind that _Out-Of-Band_ rules generate an event instead of blocking the HTTP request.
6060
:::
6161

6262
#### The AppSec/WAF Rule
@@ -85,7 +85,7 @@ rules:
8585
value: test
8686
```
8787
88-
Let ensure it's loaded as an _Out-Of-Band_ rule, first by creating a new appsec-config:
88+
Let's ensure it's loaded as an _Out-Of-Band_ rule by creating a new AppSec config:
8989
9090
```yaml title="/etc/crowdsec/appsec-configs/appsec-oob.yaml"
9191
name: crowdsecurity/appsec-oob
@@ -109,7 +109,7 @@ source: appsec
109109
110110
#### The Scenario
111111
112-
We can now create a scenario that will trigger when a single IPs triggers this rule on distinct URLs:
112+
We can now create a scenario that will trigger when a single IP triggers this rule on distinct URLs:
113113
114114
```yaml title="/etc/crowdsec/scenarios/foobar-enum.yaml"
115115
type: leaky

crowdsec-docs/docs/appsec/benchmark.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ sidebar_position: 80
1717

1818
# Basic Benchmark
1919

20-
The Application Security Component benchmarks have been run on a AWS EC2 Instance `t2.medium` (2vCPU/4GiB RAM).
20+
The Application Security Component benchmarks were run on an AWS EC2 instance `t2.medium` (2vCPU/4GiB RAM).
2121

22-
All the benchmarks have been run with only one `routine` configured for the Application Security Component.
22+
All benchmarks were run with a single `routine` configured for the Application Security Component.
2323

2424
The benchmarks cover the following tests:
2525

@@ -32,11 +32,11 @@ The benchmarks cover the following tests:
3232
- 15 concurrent connections / 1000 requests
3333
-->
3434

35-
Each test has been run with multiple cases:
35+
Each test was run with multiple cases:
3636

3737
- Application Security Component enabled but without any rules
38-
- Application Security Component enabled with 100 vpatch rules (in in-band)
39-
- Application Security Component enabled with all the CRS (in in-band)
38+
- Application Security Component enabled with 100 vpatch rules (in-band)
39+
- Application Security Component enabled with all the CRS (in-band)
4040

4141
On the system, we deployed:
4242

@@ -76,9 +76,9 @@ Tested versions are:
7676
- CrowdSec `v1.7.0`
7777
- cs-openresty-bouncer `v1.1.2`
7878

79-
Openresty was configured to not log anything and forward requests to a Go backend that always return 200, in order to improve raw throughput and not be limited by disk access.
79+
Openresty was configured to not log anything and forward requests to a Go backend that always returns 200, to improve raw throughput and avoid disk access limits.
8080

81-
Crowdsec WAF was configured with 16 routines to make use of as much CPU as possible.
81+
CrowdSec WAF was configured with 16 routines to make use of as much CPU as possible.
8282

8383
All tests were simulating 400 concurrent users, making requests as quickly as possible during 1 minute.
8484

0 commit comments

Comments
 (0)