Updated readme.md (#743)
* Simplified CrowdSec process A basic, visual, explanation of how CrowdSec works.
This commit is contained in:
parent
2679867061
commit
a47dab73e3
2 changed files with 30 additions and 25 deletions
55
README.md
55
README.md
|
@ -1,11 +1,7 @@
|
|||
|
||||
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/assets/images/crowdsec_logo.png" alt="CrowdSec" title="CrowdSec" width="400" height="240"/>
|
||||
<img src="https://raw.githubusercontent.com/crowdsecurity/crowdsec/master/docs/assets/images/crowdsec_logo.png" alt="CrowdSec" title="CrowdSec" width="400" height="260"/>
|
||||
</p>
|
||||
|
||||
</br>
|
||||
</br>
|
||||
</br>
|
||||
|
@ -20,40 +16,51 @@
|
|||
|
||||
<p align="center">
|
||||
:books: <a href="https://doc.crowdsec.net">Documentation</a>
|
||||
:diamond_shape_with_a_dot_inside: <a href="https://hub.crowdsec.net">Hub</a>
|
||||
:speech_balloon: <a href="https://discourse.crowdsec.net">Discourse Forum</a>
|
||||
:speech_balloon: <a href="https://gitter.im/crowdsec-project/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link">Gitter Chat</a>
|
||||
:diamond_shape_with_a_dot_inside: <a href="https://hub.crowdsec.net">Configuration Hub</a>
|
||||
:speech_balloon: <a href="https://discourse.crowdsec.net">Discourse (Forum)</a>
|
||||
:speech_balloon: <a href="https://gitter.im/crowdsec-project/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link">Gitter (Live chat)</a>
|
||||
</p>
|
||||
|
||||
|
||||
If you want to be notified of software **updates**, <a href="https://docs.google.com/forms/d/e/1FAIpQLSdirOC4OMYtR-HG2c54T8Ubwrq8oPLZ5k-VHOjrANip-O_KfA/viewform">click here</a>
|
||||
:dancer: This is a community driven project, <a href="https://forms.gle/ZQBQcptG2wYGajRX8">we need your feedback</a>.
|
||||
|
||||
## <TL;DR>
|
||||
|
||||
A modern behavior detection system, written in Go. It stacks on Fail2ban's philosophy, but uses Grok patterns & YAML grammar to analyse logs. It exposes an api, allowing to decouple detection and remediation for Cloud/Containers/VM based infrastructures. Once detected you respond to threats with various bouncers (firewall block, nginx http 403, Captchas, etc.) and blocked IPs are shared among all users to further improve their security. See [FAQ](https://doc.crowdsec.net/faq/) or read bellow for more.
|
||||
CrowdSec is a free, modern & collaborative behavior detection engine, coupled with a global IP reputation network. It stacks on fail2ban's philosophy but is IPV6 compatible and 60x faster (Go vs Python), uses Grok patterns to parse logs and YAML scenario to identify behaviors. CrowdSec is engineered for modern Cloud / Containers / VM based infrastructures (by decoupling detection and remediation). Once detected you can remedy threats with various bouncers (firewall block, nginx http 403, Captchas, etc.) while the aggressive IP can be sent to CrowdSec for curation before being shared among all users to further improve everyone's security. See [FAQ](https://doc.crowdsec.net/faq/) or read bellow for more.
|
||||
|
||||
## 2 mins install
|
||||
|
||||
Installing it through the [Package system](https://doc.crowdsec.net/Crowdsec/v1/getting_started/installation/) of your OS is the easiest way to proceed.
|
||||
Otherwise, to install from source, in a shell:
|
||||
|
||||
```console
|
||||
git clone https://github.com/crowdsecurity/crowdsec.git
|
||||
cd crowdsec && ./wizard.sh -i
|
||||
```
|
||||
|
||||
## :information_source: About the CrowdSec project
|
||||
|
||||
Crowdsec is an open-source, lightweight software, detecting peers with aggressive behaviors to prevent them from accessing your systems. Its user friendly design and assistance offers a low technical barrier of entry and nevertheless a high security gain.
|
||||
|
||||
Processing is done in 5 steps:
|
||||
1. Read Data sources (log files, streams, trails, messages ...), normalize and enrich signals
|
||||
2. Matching those signals to behavior patterns, aka scenarios (*)
|
||||
3. If an unwanted behavior is detected, deal with it through a [bouncer](https://hub.crowdsec.net/browse/#bouncers) : a software component integrated into your applicative stack that supports various remediations such as block, return 403, and soon captcha, 2FA, etc.
|
||||
4. The aggressive IP, the scenario name triggered and a timestamp is sent to our curation platform (to avoid poisoning & false positives)
|
||||
5. If verified, this IP is then integrated to the block list continuously distributed to all CrowdSec users (based on the scenarios installed)
|
||||
Processing is done in 4 steps:
|
||||
|
||||
By detecting, blocking & sharing the threat they faced, all clients are reinforcing each-others (hence the name Crowd-Security). Crowdsec is designed for modern infrastructures, with its "*Detect Here, Remedy There*" approach, letting you analyse logs coming from several sources in one place and block threats at various levels (applicative, system, infrastructural) of your stack.
|
||||
<p align="center">
|
||||
<img src="docs/assets/images/CS-simplified-treatment.png" alt="CrowdSec" title="CrowdSec" width="844" height="341"/>
|
||||
</p>
|
||||
|
||||
(*) CrowdSec ships by default with scenarios (brute force, port scan, web scan, etc.) adapted for most context, but you can easily extend it by picking more of them from the [hub](https://hub.crowdsec.net). It is also easy to adapt an existing one or create one yourself.
|
||||
Once an unwanted behavior is detected, deal with it through a [bouncer](https://hub.crowdsec.net/browse/#bouncers). The aggressive IP, scenario triggered and timestamp are sent for curation, to avoid poisoning & false positives. (This can be disabled). If verified, this IP is then redistributed to all CrowdSec users running the same scenario.
|
||||
|
||||
## Outnumbering hackers all together
|
||||
|
||||
By sharing the threat they faced, all users are protecting each-others (hence the name Crowd-Security). Crowdsec is designed for modern infrastructures, with its "*Detect Here, Remedy There*" approach, letting you analyse logs coming from several sources in one place and block threats at various levels (applicative, system, infrastructural) of your stack.
|
||||
|
||||
CrowdSec ships by default with scenarios (brute force, port scan, web scan, etc.) adapted for most context, but you can easily extend it by picking more of them from the **[HUB](https://hub.crowdsec.net)**. It is also easy to adapt an existing one or create one yourself.
|
||||
|
||||
## :point_right: What it is not
|
||||
|
||||
CrowdSec is not a SIEM, storing your logs (neither locally nor remotely).
|
||||
CrowdSec is not a SIEM, storing your logs (neither locally nor remotely). Your data are analyzed locally and forgotten.
|
||||
|
||||
Your data stay in your premises and are only analyzed and forgotten.
|
||||
|
||||
Signals sent to the curation platform are extremely limited (IP, Scenario, Timestamp), and are only there to allow the system to rule out false positives or poisoning attempts.
|
||||
Signals sent to the curation platform are limited to the very strict minimum: IP, Scenario, Timestamp. They are only used to allow the system to spot new rogue IPs, rule out false positives or poisoning attempts.
|
||||
|
||||
## :arrow_down: Install it !
|
||||
|
||||
|
@ -67,7 +74,7 @@ Crowdsec is available for various platforms :
|
|||
|
||||
Or look directly at [installation documentation](https://doc.crowdsec.net/Crowdsec/v1/getting_started/installation/) for other methods.
|
||||
|
||||
## :tada: Key points
|
||||
## :tada: Key benefits
|
||||
|
||||
### Fast assisted installation, no technical barrier
|
||||
|
||||
|
@ -110,5 +117,3 @@ Or look directly at [installation documentation](https://doc.crowdsec.net/Crowds
|
|||
This repository contains the code for the two main components of crowdsec :
|
||||
- `crowdsec` : the daemon a-la-fail2ban that can read, parse, enrich and apply heuristics to logs. This is the component in charge of "detecting" the attacks
|
||||
- `cscli` : the cli tool mainly used to interact with crowdsec : ban/unban/view current bans, enable/disable parsers and scenarios.
|
||||
|
||||
|
||||
|
|
BIN
docs/assets/images/CS-simplified-treatment.png
Normal file
BIN
docs/assets/images/CS-simplified-treatment.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 164 KiB |
Loading…
Reference in a new issue