Skip to content

Commit ecd84c5

Browse files
Improve valid signal documentation structure and wording
- Move 'What Counts as a Valid Signal?' section above Community Blocklist - Update wording to 'do not regularly contribute valid signals' for clarity - Change 'sending signal' to 'sending valid signals' in Community Blocklist description - Improve document flow by explaining valid signals before describing blocklist tiers - Maintain consistency across both main docs and v1.7 versioned docs
1 parent c07a7fd commit ecd84c5

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

crowdsec-docs/docs/central_api/blocklist.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,44 +15,44 @@ The Community Blocklist is **only** available when using the Security Engine. To
1515
:::
1616

1717
The rules are different for free and paying users:
18-
- Free users that **do not regularly** contribute get the `Community Blocklist (Lite)`
19-
- Free users that **do regularly** contribute get access to the `Community Blocklist`
18+
- Free users that **do not regularly contribute valid signals** get the `Community Blocklist (Lite)`
19+
- Free users that **do regularly contribute valid signals** get access to the `Community Blocklist`
2020
- Paying users get access to the `Community Blocklist (Premium)`, even if they don't contribute
2121

2222
Regardless of the blocklist "tier" you have access to (`Lite`, `Community`, `Premium`), each Security Engine gets a tailored blocklist based on the kind of behavior you're trying to detect.
2323

24-
## Community Blocklist
25-
26-
Free users that are actively contributing to the network (sending signal on a regular basis) have their Security Engines automatically subscribed to the *Community Blocklist*.
27-
28-
The content of the blocklist is unique to each Security Engine, as it mirrors the behaviours they report. For example, suppose you're running the Security Engine on a web server with WordPress. In that case, you will receive IPs performing generic attacks against web servers *and* IPs engaging in wordpress-specific attacks.
29-
30-
The *Community Blocklist* contains 15 thousand malicious IP's based on your reported scenarios.
31-
32-
### What Counts as a Valid Signal?
24+
## What Counts as a Valid Signal?
3325

3426
For your signals to be counted toward community contribution, they must meet specific criteria:
3527

36-
#### What We Count
28+
### What We Count
3729

3830
- **Signals generated by official CrowdSec scenarios from the Hub, unmodified**
3931
- We verify this by comparing the scenario's content hash we publish with the hash your engine reports
4032

41-
#### What We Do Not Count
33+
### What We Do Not Count
4234

4335
- **Custom scenarios you write yourself**
4436
- **Tainted or modified scenarios** (even small edits). We cannot reliably vet behavior once a scenario is changed, so the consensus engine ignores those signals
4537

46-
#### Example
38+
### Example
4739

4840
If you only run a honeypot with a scenario you have modified, your local alerts will still fire, but the consensus engine will not use those signals. You can then show up as "not actively contributing," even though you see activity locally.
4941

50-
#### How to Make Sure Your Signals Count
42+
### How to Make Sure Your Signals Count
5143

5244
- **Use the scenario straight from the Hub without edits**
5345
- **Keep auto-updates on** so hashes stay in sync
5446
- **If you need custom behavior**, copy to a local scenario and use it, but understand those signals will be excluded from consensus
5547

48+
## Community Blocklist
49+
50+
Free users that are actively contributing to the network (sending valid signals on a regular basis) have their Security Engines automatically subscribed to the *Community Blocklist*.
51+
52+
The content of the blocklist is unique to each Security Engine, as it mirrors the behaviours they report. For example, suppose you're running the Security Engine on a web server with WordPress. In that case, you will receive IPs performing generic attacks against web servers *and* IPs engaging in wordpress-specific attacks.
53+
54+
The *Community Blocklist* contains 15 thousand malicious IP's based on your reported scenarios.
55+
5656
## Community Blocklist (Premium)
5757

5858
Paying users' Security Engine are automatically subscribed to the *Community Blocklist (Premium)*, which contains IPs that mirror their installed scenarios.

crowdsec-docs/versioned_docs/version-v1.7/central_api/blocklist.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,44 +15,44 @@ The Community Blocklist is **only** available when using the Security Engine. To
1515
:::
1616

1717
The rules are different for free and paying users:
18-
- Free users that **do not regularly** contribute get the `Community Blocklist (Lite)`
19-
- Free users that **do regularly** contribute get access to the `Community Blocklist`
18+
- Free users that **do not regularly contribute valid signals** get the `Community Blocklist (Lite)`
19+
- Free users that **do regularly contribute valid signals** get access to the `Community Blocklist`
2020
- Paying users get access to the `Community Blocklist (Premium)`, even if they don't contribute
2121

2222
Regardless of the blocklist "tier" you have access to (`Lite`, `Community`, `Premium`), each Security Engine gets a tailored blocklist based on the kind of behavior you're trying to detect.
2323

24-
## Community Blocklist
25-
26-
Free users that are actively contributing to the network (sending signal on a regular basis) have their Security Engines automatically subscribed to the *Community Blocklist*.
27-
28-
The content of the blocklist is unique to each Security Engine, as it mirrors the behaviours they report. For example, suppose you're running the Security Engine on a web server with WordPress. In that case, you will receive IPs performing generic attacks against web servers *and* IPs engaging in wordpress-specific attacks.
29-
30-
The *Community Blocklist* contains 15 thousand malicious IP's based on your reported scenarios.
31-
32-
### What Counts as a Valid Signal?
24+
## What Counts as a Valid Signal?
3325

3426
For your signals to be counted toward community contribution, they must meet specific criteria:
3527

36-
#### What We Count
28+
### What We Count
3729

3830
- **Signals generated by official CrowdSec scenarios from the Hub, unmodified**
3931
- We verify this by comparing the scenario's content hash we publish with the hash your engine reports
4032

41-
#### What We Do Not Count
33+
### What We Do Not Count
4234

4335
- **Custom scenarios you write yourself**
4436
- **Tainted or modified scenarios** (even small edits). We cannot reliably vet behavior once a scenario is changed, so the consensus engine ignores those signals
4537

46-
#### Example
38+
### Example
4739

4840
If you only run a honeypot with a scenario you have modified, your local alerts will still fire, but the consensus engine will not use those signals. You can then show up as "not actively contributing," even though you see activity locally.
4941

50-
#### How to Make Sure Your Signals Count
42+
### How to Make Sure Your Signals Count
5143

5244
- **Use the scenario straight from the Hub without edits**
5345
- **Keep auto-updates on** so hashes stay in sync
5446
- **If you need custom behavior**, copy to a local scenario and use it, but understand those signals will be excluded from consensus
5547

48+
## Community Blocklist
49+
50+
Free users that are actively contributing to the network (sending valid signals on a regular basis) have their Security Engines automatically subscribed to the *Community Blocklist*.
51+
52+
The content of the blocklist is unique to each Security Engine, as it mirrors the behaviours they report. For example, suppose you're running the Security Engine on a web server with WordPress. In that case, you will receive IPs performing generic attacks against web servers *and* IPs engaging in wordpress-specific attacks.
53+
54+
The *Community Blocklist* contains 15 thousand malicious IP's based on your reported scenarios.
55+
5656
## Community Blocklist (Premium)
5757

5858
Paying users' Security Engine are automatically subscribed to the *Community Blocklist (Premium)*, which contains IPs that mirror their installed scenarios.

0 commit comments

Comments
 (0)