DYNR/netbird
2
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-08-05 00:15:26 -04:00
Code Issues 23.5k Packages Projects Releases 10 Wiki Activity

[PR #5722] [management, proxy] Add CrowdSec IP reputation integration for reverse proxy #28421

New Issue
Closed
opened 2026-08-05 08:06:20 -04:00 by saavagebueno · 0 comments
saavagebueno commented 2026-08-05 08:06:20 -04:00
Owner
Copy Link

Original Pull Request: https://github.com/netbirdio/netbird/pull/5722

State: closed
Merged: Yes

Describe your changes

Add CrowdSec IP reputation checking to the reverse proxy, controlled per-service (off/enforce/observe) via the management API.

  • Add stream bouncer with local decision cache and refcounted lifecycle (starts on first service, stops on last)
  • Extend restrict.Filter with CrowdSec verdicts and observe mode support
  • Proxy reports supports_crowdsec capability so dashboard/API can gate the feature
  • Access log carries CrowdSec metadata for both enforce and observe hits
  • Configured via --crowdsec-api-url / --crowdsec-api-key flags or NB_PROXY_CROWDSEC_API_URL / NB_PROXY_CROWDSEC_API_KEY env vars

Restriction evaluation order

Access restrictions are evaluated as a pipeline: CIDR, country, then CrowdSec. Each layer can only further restrict. A denial at any layer is final and short-circuits later layers.

Layer What it does Deny behavior
1. CIDR Allowlist narrows to specific ranges; blocklist removes specific ranges Deny stops here, CrowdSec never runs
2. Country Allowlist/blocklist by geolocation Deny stops here, CrowdSec never runs
3. CrowdSec IP reputation check against LAPI decision cache Can block IPs that passed layers 1 and 2

Examples:

Config Client IP CIDR Country CrowdSec Result
allow 10.0.0.0/8 + enforce 10.1.2.3 (banned) pass skip ban crowdsec_ban
allow 10.0.0.0/8 + enforce 10.2.3.4 (clean) pass skip clean allow
allow 10.0.0.0/8 + enforce 192.168.1.1 deny skip skip ip_restricted
block 10.1.0.0/16 + enforce 10.1.2.3 (banned) deny skip skip ip_restricted
allow country US + enforce 1.2.3.4 US (banned) skip pass ban crowdsec_ban
allow country US + enforce 5.6.7.8 CN skip deny skip country_restricted
allow 10.0.0.0/8 + block country CN + enforce 10.1.2.3 US (banned) pass pass ban crowdsec_ban
allow 10.0.0.0/8 + observe 10.1.2.3 (banned) pass skip ban (logged) allow (observe)

CrowdSec can never relax a CIDR or country denial. Observe mode returns the verdict for logging but does not block.

Issue ticket number and link

Stack

Checklist

  • Is it a bug fix
  • Is a typo/documentation fix
  • Is a feature enhancement
  • It is a refactor
  • Created tests that fail without the change (if possible)

By submitting this pull request, you confirm that you have read and agree to the terms of the Contributor License Agreement.

Documentation

Select exactly one:

  • I added/updated documentation for this change
  • Documentation is not needed for this change (explain why)

Docs PR URL (required if "docs added" is checked)

Paste the PR link from https://github.com/netbirdio/docs here:

https://github.com/netbirdio/docs/pull/__

Summary by CodeRabbit

  • New Features

    • CrowdSec integration: runtime bouncer + shared registry with enforce/observe modes (observe logs but doesn't block).
    • Server accepts CrowdSec API URL/key, advertises cluster CrowdSec capability, and exposes per-domain CrowdSec support.
    • Access restrictions gain crowdsec_mode with stricter validation; access logs and API now include optional per-request metadata.

  • Chores

    • Updated Go module dependency versions and added CrowdSec client libraries.
**Original Pull Request:** https://github.com/netbirdio/netbird/pull/5722 **State:** closed **Merged:** Yes --- ## Describe your changes Add CrowdSec IP reputation checking to the reverse proxy, controlled per-service (off/enforce/observe) via the management API. - Add stream bouncer with local decision cache and refcounted lifecycle (starts on first service, stops on last) - Extend restrict.Filter with CrowdSec verdicts and observe mode support - Proxy reports `supports_crowdsec` capability so dashboard/API can gate the feature - Access log carries CrowdSec metadata for both enforce and observe hits - Configured via `--crowdsec-api-url` / `--crowdsec-api-key` flags or `NB_PROXY_CROWDSEC_API_URL` / `NB_PROXY_CROWDSEC_API_KEY` env vars ### Restriction evaluation order Access restrictions are evaluated as a pipeline: CIDR, country, then CrowdSec. Each layer can only further restrict. A denial at any layer is final and short-circuits later layers. | Layer | What it does | Deny behavior | |---|---|---| | 1. CIDR | Allowlist narrows to specific ranges; blocklist removes specific ranges | Deny stops here, CrowdSec never runs | | 2. Country | Allowlist/blocklist by geolocation | Deny stops here, CrowdSec never runs | | 3. CrowdSec | IP reputation check against LAPI decision cache | Can block IPs that passed layers 1 and 2 | Examples: | Config | Client IP | CIDR | Country | CrowdSec | Result | |---|---|---|---|---|---| | allow `10.0.0.0/8` + enforce | `10.1.2.3` (banned) | pass | skip | **ban** | `crowdsec_ban` | | allow `10.0.0.0/8` + enforce | `10.2.3.4` (clean) | pass | skip | clean | `allow` | | allow `10.0.0.0/8` + enforce | `192.168.1.1` | **deny** | skip | skip | `ip_restricted` | | block `10.1.0.0/16` + enforce | `10.1.2.3` (banned) | **deny** | skip | skip | `ip_restricted` | | allow country US + enforce | `1.2.3.4` US (banned) | skip | pass | **ban** | `crowdsec_ban` | | allow country US + enforce | `5.6.7.8` CN | skip | **deny** | skip | `country_restricted` | | allow `10.0.0.0/8` + block country CN + enforce | `10.1.2.3` US (banned) | pass | pass | **ban** | `crowdsec_ban` | | allow `10.0.0.0/8` + observe | `10.1.2.3` (banned) | pass | skip | ban (logged) | `allow` (observe) | CrowdSec can never relax a CIDR or country denial. Observe mode returns the verdict for logging but does not block. ## Issue ticket number and link ## Stack <!-- branch-stack --> ### Checklist - [ ] Is it a bug fix - [ ] Is a typo/documentation fix - [x] Is a feature enhancement - [ ] It is a refactor - [x] Created tests that fail without the change (if possible) > By submitting this pull request, you confirm that you have read and agree to the terms of the [Contributor License Agreement](https://github.com/netbirdio/netbird/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT.md). ## Documentation Select exactly one: - [ ] I added/updated documentation for this change - [x] Documentation is **not needed** for this change (explain why) ### Docs PR URL (required if "docs added" is checked) Paste the PR link from https://github.com/netbirdio/docs here: https://github.com/netbirdio/docs/pull/__ <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * CrowdSec integration: runtime bouncer + shared registry with enforce/observe modes (observe logs but doesn't block). * Server accepts CrowdSec API URL/key, advertises cluster CrowdSec capability, and exposes per-domain CrowdSec support. * Access restrictions gain crowdsec_mode with stricter validation; access logs and API now include optional per-request metadata. * **Chores** * Updated Go module dependency versions and added CrowdSec client libraries. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
saavagebueno added the pull-request label 2026-08-05 08:06:20 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2021 Q4
2021 Q4
2022 Q1
2022 Q1
2022 Q1
2022 Q1
2022 Q1
2022 Q1
accessibility
accessibility
accessibility
acl
acl
acl
agent
agent
agent
agent
agent
agent
Android
Android
Android
Android
Android
Android
api
api
api
authentik
authentik
authentik
automation
automation
automation
azure
azure
azure
battery-usage
battery-usage
battery-usage
bug
cache
cache
cache
client
client
client
client-ui
client-ui
client-ui
cloud
cloud
cloud
cloud-only
cloud-only
cloud-only
cloudflare
cloudflare
cloudflare
community
community
community
compatibility
compatibility
compatibility
config-idp
config-idp
config-idp
config-issue
config-issue
config-issue
connection
connection
connection
contribution
contribution
contribution
coturn
coturn
coturn
cross-vpn
cross-vpn
cross-vpn
dashboard
dashboard
dashboard
data-usage
data-usage
data-usage
distribution
distribution
distribution
dns
dns
dns
docker
docker
docker
documentation
documentation
documentation
duplicate
duplicate
duplicate
enhancement
enhancement
event-stream
event-stream
event-stream
feature-request
feature-request
feature-request
freebsd
freebsd
freebsd
getting-started
getting-started
getting-started
go
go
go
good first issue
good first issue
good first issue
gui
gui
gui
help wanted
help wanted
help wanted
home-assistant
home-assistant
home-assistant
idp
idp
idp
inconsistency
inconsistency
inconsistency
integration
integration
integration
integrations
integrations
integrations
ios
ios
ios
ipv6
ipv6
ipv6
jwt
jwt
jwt
k8s
k8s
k8s
keycloak
keycloak
keycloak
linux
linux
linux
login
login
login
macos
macos
macos
management-service
management-service
management-service
Medium
Medium
Medium
missing-docs
missing-docs
missing-docs
mobile
mobile
mobile
moved-internal
moved-internal
moved-internal
needs-review
needs-review
needs-review
netbird-ui
netbird-ui
netbird-ui
networking
networking
networking
new-platform
new-platform
new-platform
nginx
nginx
nginx
notification
notification
notification
okta
okta
okta
openwrt
openwrt
openwrt
P2
P2
P2
packaging
packaging
packaging
peer-management
peer-management
peer-management
peer-management
peer-management
peer-management
peer-management
peer-management
peer-management
performance
performance
performance
postgres
postgres
postgres
posture-checks
posture-checks
posture-checks
psk
psk
psk
pull-request
Mirrored from GitHub Pull Request
 question
question
question
refactor
refactor
refactor
relay
relay
relay
release
release
release
rfc
rfc
rfc
routes
routes
routes
security
security
security
security-improvement
security-improvement
security-improvement
security-related
security-related
security-related
self-hosting
self-hosting
self-hosting
server
server
server
signal
signal
signal
sleep-issue
sleep-issue
sleep-issue
ssh
ssh
ssh
ssl
ssl
ssl
status
status
status
store
store
store
synology
synology
synology
system-compatibility-issue
system-compatibility-issue
system-compatibility-issue
test-suite
test-suite
test-suite
third-party-integration
third-party-integration
third-party-integration
triage
triage
triage
triage
triage
triage
triage-needed
triage-needed
triage-needed
troubleshooting
troubleshooting
troubleshooting
UX
UX
UX
waiting-feedback
waiting-feedback
waiting-feedback
windows
windows
windows
wontfix
wontfix
wontfix
zitadel
zitadel
zitadel
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
dynr-servers saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: DYNR/netbird#28421
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?