FREQUENTLY ASKED QUESTIONS¶
What is crowdsec-agent ?¶
Crowdsec-agent is a security open-source software. See the overview.
What language is it written in ?¶
Crowdsec-agent is written in Golang.
What licence is crowdsec-agent released under ?¶
Crowdsec-agent is under MIT license.
Which information is sent to the APIs ?¶
Our aim is to build a strong community that can share malevolent attackers IPs, for that we need to collect the bans triggered locally by each user.
The signal sent by your crowdsec-agent to the central API only contains only meta-data about the attack :
- Attacker IP
- Scenario name
- Time of start/end of attack
Your logs are not sent to our central API, only meta-data about blocked attacks will be.
What is the performance impact ?¶
As crowdsec-agent only works on logs, it shouldn't impact your production. When it comes to bouncers, it should perform one request to the database when a new IP is discovered thus have minimal performance impact.
How fast is it ?¶
crowdsec-agent can easily handle several thousands of events per second on a rich pipeline (multiple parsers, geoip enrichment, scenarios and so on). Logs are a good fit for sharding by default, so it is definitely the way to go if you need to handle higher throughput.
If you need help for large scale deployment, please get in touch with us on the CrowdSecurity discourse, we love challenges ;)
What backend database does Crowdsec-agent supports and how to switch ?¶
crowdsec-agent versions (under v0.3.X) supports SQLite (default) and MySQL databases. See backend configuration for relevant configuration. MySQL here is more suitable for distributed architectures where bouncers across the applicative stack need to access a centralized ban database.
crowdsec-agent versions (after v1) supports SQLite (default), MySQL and PostgreSQL databases. See databases configuration for relevant configuration. Thanks to the Local API, distributed architectures are resolved even with sqlite database.
SQLite by default as it's suitable for standalone/single-machine setups.
How to control granularity of actions ? (whitelists, simulation etc.)¶
crowdsec-agent support both [whitelists]((/Crowdsec/v1/write_configurations/whitelist/) and simulation :
- Whitelists allows you to "discard" events or overflows
- Simulation allows you to simply cancel the decision that is going to be taken, but keep track of it
profiles allows you to control which decision will be applied to which alert.
How to add whitelists ?¶
You can follow this guide
How to set up proxy ?¶
Setting up a proxy works out of the box, the net/http golang library can handle those environment variables:
Since cscli uses
sudo, you just this line in
visudo after setting up the previous environment variables:
Defaults env_keep += "HTTP_PROXY HTTPS_PROXY NO_PROXY"
How to report a bug ?¶
To report a bug, please open an issue on the repository.
What about false positives ?¶
Several initiatives have been taken to tackle the false positives approach as early as possible :
- The scenarios published on the hub are tailored to favor low false positive rates
- You can find generic whitelists that should allow to cover most common cases (SEO whitelists, CDN whitelists etc.)
- The simulation configuration allows you to keep a tight control over scenario and their false positives
I need some help¶
Feel free to ask for some help to the CrowdSecurity discourse or directly in the chat.
How to use crowdsec on raspberry pi OS (formerly known as rasbian)¶
Please keep in mind that raspberry pi OS is designed to work on all raspberry pi versions. Even if the port target is known as armhf, it's not exactly the same target as the debian named armhf port.
The best way to have a crowdsec version for such an architecture is to do:
- install golang (all versions from 1.13 will do)
- Update the GOARCH variable in the Makefile to
- install the arm gcc cross compilator (On debian the package is gcc-arm-linux-gnueabihf)
- Compile crowdsec using the usual
How to have a dashboard without docker¶
cscli dashboard rely on
docker to launch the
metabase image. If
docker is not installed on your machine, here are the step to follow to get crowdsec dashboards without docker:
- Download Metabase
jarfile. See metabase documentation.
- Download the
metabase.dbfolder from Crowdsec here.
- Unzip the
- Make crowdsec database reachable from metabase :
sudo mkdir /metabase-data/ sudo ln -s /var/lib/crowdsec/data/crowdsec.db /metabase-data/crowdsec.db
- Launch Metabase:
sudo MB_DB_TYPE=h2 MB_DB_FILE=<absolute-path>/metabase.db/metabase.db java -jar metabase.jar
The default username is
firstname.lastname@example.org and the default password is
!!Cr0wdS3c_M3t4b4s3??. Please update the password when you will connect to metabase for the first time
How to configure crowdsec/cscli to use Tor¶
With tor installed, setting
HTTPS_PROXY environment variables to your socks5 proxy will do the trick.
Running the wizard with tor¶
$ sudo HTTPS_PROXY=socks5://127.0.0.1:9050 HTTP_PROXY=socks5://127.0.0.1:9050 ./wizard.sh --bininstall
Do not use the wizard in interactive (
-i) mode if you're concerned, as it will start the service at the end of the setup, leaking your IP address.
Edit crowdsec systemd unit to push/pull via tor¶
[Service] Environment="HTTPS_PROXY=socks5://127.0.0.1:9050" Environment="HTTP_PROXY=socks5://127.0.0.1:9050" ...
Using cscli via tor¶
$ sudo HTTP_PROXY=socks5://127.0.0.1:9050 HTTPS_PROXY=socks5://127.0.0.1:9050 cscli capi register