Skip to main content
Version: v1.3.4

Windows Firewall Bouncer

CrowdSec

📚 Documentation💠 Hub💬 Discourse

Overview#

The windows firewall bouncer interacts with the Windows Firewall to block IPs banned by CrowdSec.

It will create multiple rules in the firewall (one rule will contains 1000 IPs) and will manage their lifecycle.

The rules are created on startup and automatically deleted when the bouncer stops.

Installation#

warning

The .NET 6 runtime is required for the bouncer to work !

You can download either a MSI (containing only the bouncer) or a setup bundle (containing the bouncer and the .NET 6 runtime) from the github releases: https://github.com/crowdsecurity/cs-windows-firewall-bouncer/releases

You can also install the bouncer with Chocolatey (this will automatically install the .NET runtime):

choco install crowdsec-windows-firewall-bouncer

Configuration#

The configuration is stored in C:\Program Files\CrowdSec\bouncers\cs-windows-firewall-bouncer\cs-windows-firewall-bouncer.yaml

Example configuration#

api_key: <your-api-key>api_url: http://127.0.0.1:8080log_level: infoupdate_frequency: 10slog_media: filelog_dir: C:\ProgramData\CrowdSec\log\fw_profiles: - domain

api_key#

API key to use for communication with LAPI.

api_url#

URL of LAPI.

update_frequency#

How often the bouncer will contact LAPI to update its content in seconds.

Defaults to 10.

log_media#

Wether to log to file or to the console.

Defaults to file when running as service and console when running in interactive mode.

log_dir#

Location of the log file.

Defaults to C:\ProgramData\CrowdSec\log\.

log_level#

Log level.

Can be one of:

  • trace
  • debug
  • info
  • warn
  • error
  • fatal

Defaults to info.

fw_profiles#

The firewall profile the rules will be associated with.

The bouncer automatically select the current profile, but you can override this behaviour with this parameter.

Allowed values are:

  • domain
  • private
  • public