Skip to content

Commit 2102c75

Browse files
Add signal criteria to community blocklist documentation (#886)
* 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 * 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 * Simplify terminology: use 'signal' instead of 'valid signal' - Change 'What Counts as a Valid Signal?' to 'What Counts as a Signal?' - Update 'do not regularly contribute valid signals' to 'do not regularly contribute signals' - Update 'do regularly contribute valid signals' to 'do regularly contribute signals' - Change 'sending valid signals' to 'sending signals' in Community Blocklist description - Maintain same meaning while using simpler terminology as requested by team - Apply changes to both main docs and v1.7 versioned docs * Add clarification about parser modifications - Add info box explaining that modifying parsers or using custom parsers has no impact on signal validity - Clarifies distinction between scenario modifications (which affect signals) and parser modifications (which don't) - Helps users understand they can customize parsers without affecting community contribution - Apply changes to both main docs and v1.7 versioned docs
1 parent c939261 commit 2102c75

File tree

2 files changed

+62
-6
lines changed

2 files changed

+62
-6
lines changed

crowdsec-docs/docs/central_api/blocklist.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,43 @@ 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 signals** get the `Community Blocklist (Lite)`
19+
- Free users that **do regularly contribute 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+
## What Counts as a Signal?
25+
26+
For your signals to be counted toward community contribution, they must meet specific criteria:
27+
28+
### What We Count
29+
30+
- **Signals generated by official CrowdSec scenarios from the Hub, unmodified**
31+
- We verify this by comparing the scenario's content hash we publish with the hash your engine reports
32+
33+
### What We Do Not Count
34+
35+
- **Custom scenarios you write yourself**
36+
- **Tainted or modified scenarios** (even small edits). We cannot reliably vet behavior once a scenario is changed, so the consensus engine ignores those signals
37+
38+
:::info
39+
Modifying a parser or using a custom parser has no impact on signal validity.
40+
:::
41+
42+
### Example
43+
44+
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.
45+
46+
### How to Make Sure Your Signals Count
47+
48+
- **Use the scenario straight from the Hub without edits**
49+
- **Keep auto-updates on** so hashes stay in sync
50+
- **If you need custom behavior**, copy to a local scenario and use it, but understand those signals will be excluded from consensus
51+
2452
## Community Blocklist
2553

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*.
54+
Free users that are actively contributing to the network (sending signals on a regular basis) have their Security Engines automatically subscribed to the *Community Blocklist*.
2755

2856
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.
2957

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

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,43 @@ 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 signals** get the `Community Blocklist (Lite)`
19+
- Free users that **do regularly contribute 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+
## What Counts as a Signal?
25+
26+
For your signals to be counted toward community contribution, they must meet specific criteria:
27+
28+
### What We Count
29+
30+
- **Signals generated by official CrowdSec scenarios from the Hub, unmodified**
31+
- We verify this by comparing the scenario's content hash we publish with the hash your engine reports
32+
33+
### What We Do Not Count
34+
35+
- **Custom scenarios you write yourself**
36+
- **Tainted or modified scenarios** (even small edits). We cannot reliably vet behavior once a scenario is changed, so the consensus engine ignores those signals
37+
38+
:::info
39+
Modifying a parser or using a custom parser has no impact on signal validity.
40+
:::
41+
42+
### Example
43+
44+
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.
45+
46+
### How to Make Sure Your Signals Count
47+
48+
- **Use the scenario straight from the Hub without edits**
49+
- **Keep auto-updates on** so hashes stay in sync
50+
- **If you need custom behavior**, copy to a local scenario and use it, but understand those signals will be excluded from consensus
51+
2452
## Community Blocklist
2553

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*.
54+
Free users that are actively contributing to the network (sending signals on a regular basis) have their Security Engines automatically subscribed to the *Community Blocklist*.
2755

2856
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.
2957

0 commit comments

Comments
 (0)