vaultwarden
/
vaultwarden-alternativa-bitwarden
mirror of https://github.com/dani-garcia/vaultwarden.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Page: Fail2Ban Setup
Pages
Audits Backing up your vault Building binary Building your own docker image Caddy 2.x with Cloudflare DNS Changing persistent data location Changing the API request size limit Changing the number of workers Configuration overview Customize Vaultwarden CSS Deployment examples Differences from the upstream API implementation Disable admin token Disable invitations Disable registration of new users Disabling or overriding the Vault interface hosting Docker Traefik ModSecurity Setup Enable admin page Enabling HTTPS Enabling Mobile Client push notification Enabling U2F (and FIDO2 WebAuthn) authentication Enabling U2F authentication Enabling WebSocket notifications Enabling Yubikey OTP authentication Enabling admin page secure the admin_token Enabling admin page FAQs Fail2Ban Setup General (not docker) Hardening Guide Home Importing data from Keepass or KeepassX Kubernetes deployment Logging Logrotate example Migrating from MariaDB (MySQL) to SQLite Other configuration Password hint display Pre built binaries Private CA and self signed certs that work with Chrome Proxy examples Running a private vaultwarden instance with Let's Encrypt certs Running docker container with non root user Running without WAL enabled SMTP Configuration Setup as a systemd service Starting a Container Supporting upstream Syncing users from LDAP Testing SSO Third party packages Translating the email templates Updating the vaultwarden image Using Docker Compose Using Podman Using an alternate base dir Using the MariaDB (MySQL) Backend Using the MySQL Backend Using the PostgreSQL Backend Which container image to use
51 Fail2Ban Setup
yolylight edited this page 2024-10-13 21:41:12 +08:00
Table of Contents

Setting up Fail2ban will prevent attackers to brute force your vault logins. This is particularly important if your instance is publicly available.

Table of Contents

Pre-requisite

  • Filenames are at the top of each code block.
  • From Release 1.5.0, Vaultwarden supports logging to file. Please set this up : Logging
  • Try to log to web vault with a false account and check the log files for following format
[YYYY-MM-DD hh:mm:ss][vaultwarden::api::identity][ERROR] Username or password is incorrect. Try again. IP: XXX.XXX.XXX.XXX. Username: email@domain.com.

Installation

Debian / Ubuntu / Raspberry Pi OS

sudo apt-get install fail2ban -y

Fedora / Centos

EPEL repository is necessary (CentOS 7)

sudo yum install epel-release
sudo yum install fail2ban -y

Synology DSM

With Synology, a bit more work is needed for various reasons. The full solution is pushed with Docker Compose there. The main issues are:

  1. The embedded IP ban system does not work for Docker's containers
  2. The iptables embedded do no support the REJECT blocktype
  3. The Docker GUI does not allow some advanced settings
  4. Modifying system configuration is not upgrade-proof

Therefore, we will use Fail2ban in a Docker container. Crazy-max/docker-fail2ban provides a good solution and the Synology's Docker GUI will be ignored. From command line through SSH, here the steps. As a convention volumeX is to be adapted to your Synology's config.

  1. Get root
sudo -i
  1. Creating persistent folders
mkdir -p /volumeX/docker/fail2ban/action.d/
mkdir -p /volumeX/docker/fail2ban/jail.d/
mkdir -p /volumeX/docker/fail2ban/filter.d/
  1. Replace REJECT by DROP blocktype
# /volumeX/docker/fail2ban/action.d/iptables.local

[Init]
blocktype = DROP
[Init?family=inet6]
blocktype = DROP
  1. Create docker-compose file
# /volumeX/docker/fail2ban/docker-compose.yml

version: '3'
services:
  fail2ban:
    container_name: fail2ban
    restart: always
    image: crazymax/fail2ban:latest
    environment: 
      - TZ=Europe/Paris
      - F2B_DB_PURGE_AGE=30d
      - F2B_LOG_TARGET=/data/fail2ban.log
      - F2B_LOG_LEVEL=INFO
      - F2B_IPTABLES_CHAIN=INPUT

    volumes:
      - /volumeX/docker/fail2ban:/data
      - /volumeX/docker/vw-data:/vaultwarden:ro

    network_mode: "host"

    privileged: true
    cap_add:
      - NET_ADMIN
      - NET_RAW
  1. Start the container using command line
cd /volumeX/docker/fail2ban
docker-compose up -d

You should see the container running in Synology's Docker GUI. You will have to reload after configuring the filters and jails

Setup for web vault

As a convention, path_f2b means the path needed for Fail2ban to work. This depends on your system. E.g. on Synology, we are talking about /volumeX/docker/fail2ban/ where on some other systems we are talking about /etc/fail2ban/

Filter

Create and fill the following file

# path_f2b/filter.d/vaultwarden.local

[INCLUDES]
before = common.conf

[Definition]
failregex = ^.*?Username or password is incorrect\. Try again\. IP: <ADDR>\. Username:.*$
ignoreregex =

Tip: If you get the following error message in fail2ban.log (CentOS 7, Fail2Ban v0.9.7)
fail2ban.filter [5291]: ERROR No 'host' group in '^.*Username or password is incorrect\. Try again\. IP: <ADDR>\. Username:.*$'
Please Use <HOST> instead of <ADDR> in vaultwarden.local

Tip: Cloudflare users, make sure you set your Client IP header to CF-Connecting-IP in admin panel -> advanced settings -> Client IP header, else the clients real IP will not be logged/banned.

Tip: If you see 127.0.0.1 as the IP address of failed logins in vaultwarden.log, then you're probably using a reverse proxy and fail2ban won't work correctly:

[YYYY-MM-DD hh:mm:ss][vaultwarden::api::identity][ERROR] Username or password is incorrect. Try again. IP: 127.0.0.1. Username: email@example.com.

To remedy this, forward the true remote address to vaultwarden via the X-Real-IP header. How to do this varies depending on the proxy you use. For example, in Caddy 2.x, when you define the reverse-proxy, define header_up X-Real-IP {remote_host}. See Proxy examples for more info.

Jail

Create and fill the following file

# path_f2b/jail.d/vaultwarden.local

[vaultwarden]
enabled = true
port = 80,443,8081
filter = vaultwarden
banaction = %(banaction_allports)s
logpath = /path/to/vaultwarden.log
maxretry = 3
bantime = 14400
findtime = 14400
Note for Docker Users

Docker uses the FORWARD chain instead of the default INPUT chain. If the machine receiving requests is mapping them straight to a Docker container, then chain will need to be set appropriately regardless of what is in the container (reverse proxy, Vaultwarden, etc). The default action is set to action_ (which uses banaction, which we alias to banaction_allports). action_ already takes the chain into account. Thus, simply set the chain. See this similar issue.

chain = FORWARD
Note for Synology DSM Docker Users

Please set the chain to DOCKER-USER

chain = DOCKER-USER
Note for Docker Users with Fail2Ban v1.1.1.dev1 (and possibly newer)

With Fail2Ban v1.1.1.dev1 the default banactions for Debian changed from iptables to nftables (see here). Docker (at least version 25.0.3) on the other hand still uses iptables. Hence, the requests to the Docker containers are not blocked with banaction = %(banaction_allports)s. In this scenario, use

banaction = iptables

Tip: If you are using systemd to manage vaultwarden, you can use systemd-journal for fail2ban:

backend = systemd
filter = vaultwarden[journalmatch='_SYSTEMD_UNIT=your_vaultwarden.service']

Use these instead of logpath = and filter = variables.

NOTE FOR CLOUDFLARE USERS If you use cloudflare proxy, you'll need to add Cloudflare in your actions list, like in this guide

Reload fail2ban for changes to take effect:

sudo systemctl reload fail2ban

Feel free to change the options as you see fit.

Setup for admin page

If you've enabled the admin console by setting the ADMIN_TOKEN environment variable, you can prevent an attacker from brute-forcing the admin token using Fail2Ban. The process is the same as for the web vault.

Filter

Create and fill the following file

# path_f2b/filter.d/vaultwarden-admin.local

[INCLUDES]
before = common.conf

[Definition]
failregex = ^.*Invalid admin token\. IP: <ADDR>.*$
ignoreregex =

Tip: If you get the following error message in fail2ban.log ERROR NOK: ("No 'host' group in '^.*Invalid admin token\\. IP: <ADDR>.*$'")
Please Use <HOST> instead of <ADDR> in vaultwarden-admin.local

Jail

Create and fill the following file

# path_f2b/jail.d/vaultwarden-admin.local

[vaultwarden-admin]
enabled = true
port = 80,443
filter = vaultwarden-admin
banaction = %(banaction_allports)s
logpath = /path/to/vaultwarden.log
maxretry = 3
bantime = 14400
findtime = 14400

Note: Docker uses the FORWARD chain instead of the default INPUT chain. Therefore replace the banaction line with the following action when using Docker:

action = iptables-allports[name=vaultwarden-admin, chain=FORWARD]

Tip: If you are using systemd to manage vaultwarden, you can use systemd-journal for fail2ban here as well:

backend = systemd
filter = vaultwarden-admin[journalmatch='_SYSTEMD_UNIT=your_vaultwarden.service']

Use these instead of logpath = and filter = variables.

NOTE FOR CLOUDFLARE USERS If you use cloudflare proxy, you'll need to add Cloudflare in your actions list, like in this guide

Reload fail2ban for changes to take effect:

sudo systemctl reload fail2ban

Testing Fail2Ban

Now just try to login to vaultwarden using any email (it doesn't have to be a valid email, just an email format) If it works correctly and your IP is banned, you can unban the IP by running:

# With Docker
sudo docker exec -t fail2ban fail2ban-client set vaultwarden unbanip XX.XX.XX.XX
# Without Docker
sudo fail2ban-client set vaultwarden unbanip XX.XX.XX.XX

If Fail2Ban does not appear to be functioning, verify that the path to the Vaultwarden log file is correct. For Docker: If the specified log file is not being generated and/or updated, make sure the EXTENDED_LOGGING env variable is set to true (which is default) and that the path to the log file is the path inside the Docker (when you use /bw-data/:/data/ the log file should be in /data/... to be outside the container).

Also verify that the timezone of the Docker container matches the timezone of the host. Check this by comparing the time shown in the logfile with the host OS time. If they differ, there are various ways to fix this. One option is to start Docker with the option -e "TZ=<timezone>". A list of valid timezones is here (eg. -e "TZ=Australia/Melbourne")

If you are using podman instead of Docker it seems that setting the timezone via -e "TZ=<timezone>" does not work. This can be solved (when using the alpine image) by following this guide: https://wiki.alpinelinux.org/wiki/Setting_the_timezone.

SELinux Problems

When you are using SELinux it is possible that SELinux hinders fail2ban to read the logs. If so, follow these steps: sudo tail /var/log/audit/audit.log. There you should see something along the lines of this (of course the actual audit ID will vary in your case):

type=AVC msg=audit(1571777936.719:2193): avc:  denied  { search } for  pid=5853 comm="fail2ban-server" name="containers" dev="dm-0" ino=1144588 scontext=system_u:system_r:fail2ban_t:s0 tcontext=unconfined_u:object_r:container_var_lib_t:s0 tclass=dir permissive=0

To actually find out the reason you can use grep 'type=AVC msg=audit(1571777936.719:2193)' /var/log/audit/audit.log | audit2why. audit2allow -a will give you specific instructions on how to create a module and allow fail2ban to access these logs. Follow these steps and you're done! fail2ban should now work correctly.

FAQs

  1. FAQs
  2. Audits

Container Image Usage

  1. Which container image to use
  2. Starting a container
  3. Updating the vaultwarden image
  4. Using Docker Compose
  5. Using Podman

Deployment

  1. Building your own docker image
  2. Building binary
  3. Pre-built binaries
  4. Third-party packages
  5. Deployment examples
  6. Proxy examples
  7. Logrotate example

HTTPS

  1. Enabling HTTPS
  2. Running a private vaultwarden instance with Let's Encrypt certs

Configuration

  1. Overview
  2. Disable registration of new users
  3. Disable invitations
  4. Enabling admin page
  5. Disable the admin token
  6. Enabling WebSocket notifications
  7. Enabling Mobile Client push notification
  8. Enabling U2F and FIDO2 WebAuthn authentication
  9. Enabling YubiKey OTP authentication
  10. Changing persistent data location
  11. Changing the API request size limit
  12. Changing the number of workers
  13. SMTP configuration
  14. Translating the email templates
  15. Password hint display
  16. Disabling or overriding the Vault interface hosting
  17. Logging
  18. Creating a systemd service
  19. Syncing users from LDAP
  20. Using an alternate base dir (subdir/subpath)
  21. Other configuration

Database

  1. Using the MariaDB (MySQL) Backend
  2. Using the PostgreSQL Backend
  3. Running without WAL enabled
  4. Migrating from MariaDB (MySQL) to SQLite

Security

  1. Hardening Guide
  2. Fail2Ban Setup
  3. Fail2Ban + ModSecurity + Traefik + Docker

Backup

  1. General (not docker)

Other Information

  1. Importing data from Keepass or KeepassX
  2. Backing up your vault
  3. Differences from the upstream API implementation
  4. Supporting upstream development
  5. Caddy 2.x with Cloudflare DNS