Skip to content

Commit 9dc7893

Browse files
rr404Julien Loizelet and jdv
andauthored
Adding Bouncers specs (base+appsec & metrics) in contribute (#817)
* Adding Bouncer specifications mentionning basic funcitnonalities as well as AppSec capabilities and Metrics Co-authored-by: Julien Loizelet and jdv <[email protected]>
1 parent 7c3b445 commit 9dc7893

File tree

4 files changed

+962
-1
lines changed

4 files changed

+962
-1
lines changed

crowdsec-docs/docs/contributing/bouncers.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,32 @@ Sharing on the hub allows other users to find and use it. While increasing your
1414

1515
### How ?
1616

17+
#### Specs
18+
19+
Remediation components have mandatory and optional features, they are described in the following sub pages:
20+
- [Specifications for Remediation Component and AppSec Capabilities](/contributing/specs/bouncer_appsec_specs)
21+
- [Remediation Component Metrics](/contributing/specs/bouncer_metrics_specs)
22+
23+
*Don't hesitate to get in touch with us via discord if anything is unclear to you*
24+
25+
Those specs describe how the Remediation component interacts with the Security Engine Local API as well as how each feature should behave.
26+
27+
Main features are:
28+
- **Mode**: How the bouncer retrieves decisions
29+
- **Stream**: Pulls them periodically and stores them locally (preferred for low latency remediation)
30+
- **Live**: Queries the LAPI upon request reception (easier to implement)
31+
- Both available ideally, but **Stream** preferred in most cases
32+
- **AppSec**: Ability to forward requests to the Security Engine to eval appsec rules
33+
- Optional but if the remediation component has access to the request this features is a big plus
34+
- **Metrics**: Keep track of what was remediated
35+
- Optional but very useful for the users to be able to evaluate the efficiency of the protection
36+
- Ideally with details on the source of the decision (blocklist, manual block, a scenario triggering a decision 'crowdsec'...)
37+
38+
Other optional features are:
39+
- **MTLS** support
40+
- Exposing metrics to **Prometheus**
41+
42+
#### Publish on Github
1743

1844
To have it published on the hub, please simply [open a new issue on the hub](https://github.com/crowdsecurity/hub/issues/new), requesting "remediation component inclusion". The remediation component will then be reviewed by the team, and published directly on the hub, for everyone to find & use it!
1945

0 commit comments

Comments
 (0)