Skip to content

Commit c07a7fd

Browse files
Add valid signal criteria to community blocklist documentation
- Clarify what signals count toward community contribution - Explain hash verification process for scenario validation - Document exclusion of custom and modified scenarios - Provide guidance on ensuring signals are counted - Add practical example of modified scenario impact - Update both main docs and v1.7 versioned docs
1 parent c939261 commit c07a7fd

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

crowdsec-docs/docs/central_api/blocklist.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,30 @@ The content of the blocklist is unique to each Security Engine, as it mirrors th
2929

3030
The *Community Blocklist* contains 15 thousand malicious IP's based on your reported scenarios.
3131

32+
### What Counts as a Valid Signal?
33+
34+
For your signals to be counted toward community contribution, they must meet specific criteria:
35+
36+
#### What We Count
37+
38+
- **Signals generated by official CrowdSec scenarios from the Hub, unmodified**
39+
- We verify this by comparing the scenario's content hash we publish with the hash your engine reports
40+
41+
#### What We Do Not Count
42+
43+
- **Custom scenarios you write yourself**
44+
- **Tainted or modified scenarios** (even small edits). We cannot reliably vet behavior once a scenario is changed, so the consensus engine ignores those signals
45+
46+
#### Example
47+
48+
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.
49+
50+
#### How to Make Sure Your Signals Count
51+
52+
- **Use the scenario straight from the Hub without edits**
53+
- **Keep auto-updates on** so hashes stay in sync
54+
- **If you need custom behavior**, copy to a local scenario and use it, but understand those signals will be excluded from consensus
55+
3256
## Community Blocklist (Premium)
3357

3458
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: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,30 @@ The content of the blocklist is unique to each Security Engine, as it mirrors th
2929

3030
The *Community Blocklist* contains 15 thousand malicious IP's based on your reported scenarios.
3131

32+
### What Counts as a Valid Signal?
33+
34+
For your signals to be counted toward community contribution, they must meet specific criteria:
35+
36+
#### What We Count
37+
38+
- **Signals generated by official CrowdSec scenarios from the Hub, unmodified**
39+
- We verify this by comparing the scenario's content hash we publish with the hash your engine reports
40+
41+
#### What We Do Not Count
42+
43+
- **Custom scenarios you write yourself**
44+
- **Tainted or modified scenarios** (even small edits). We cannot reliably vet behavior once a scenario is changed, so the consensus engine ignores those signals
45+
46+
#### Example
47+
48+
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.
49+
50+
#### How to Make Sure Your Signals Count
51+
52+
- **Use the scenario straight from the Hub without edits**
53+
- **Keep auto-updates on** so hashes stay in sync
54+
- **If you need custom behavior**, copy to a local scenario and use it, but understand those signals will be excluded from consensus
55+
3256
## Community Blocklist (Premium)
3357

3458
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)