Skip to content

ekeih/hcloud-firewall-controller

Repository files navigation

hcloud-firewall-controller

hcloud-firewall-controller determines the current public IP and creates or updates a Hetzner Cloud firewall with this IP.

Some internet service providers dynamically change the IP addresses of their customers, especially after router restarts. This makes it hard to use Hetzner Cloud firewalls to limit access to specific ports to your dynamic personal home IP address. This controller periodically determines your current public IP and updates a Hetzner Cloud firewall with this IP. This can be useful for SSH, Kubernetes API servers, other internal APIs or just all non-public services.

Please be aware that IP based firewalling alone is not a sufficient method to secure your infrastructure, especially not with dynamic IP addresses. Connections to all servers should still be encrypted and authenticated to provide proper security. Nevertheless, IP based firewalling can offer a nice additional layer of security by hiding non-public services and blocking bad actors at the edge of your infrastructure.

Usage

By default the controller creates a new firewall hcloud-firewall-controller with the defined rules without applying the firewall to any servers. You can apply the firewall to servers manually or with an infastructure provisioning tool like Terraform based on the firewall ID. The controller prints the firewall ID each reconciliation loop.

Usage: hcloud-firewall-controller [OPTIONS]

Options:
  -1, --run-once
          Run only once and exit, useful if run by cron or other tools [env: HFC_RUN_ONCE=]
  -t, --hcloud-token <HCLOUD_TOKEN>
          Hetzner Cloud API token with read and write permissions, can be specified multiple times or passed as comma separated list to manage several projects [env: HFC_HCLOUD_TOKEN]
  -f, --firewall-name <FIREWALL_NAME>
          Name of the firewall to create [env: HFC_FIREWALL_NAME=] [default: hcloud-firewall-controller]
      --tcp <PORT | PORT RANGE>
          Comma separated list of TCP ports or port ranges to allow traffic for, e.g. '80', '80,443', '80-85' or 80,443-450'. Alternatively the parameter can be specified multiple times. [env: HFC_TCP=]
      --udp <PORT | PORT RANGE>
          Comma separated list of UDP ports or port ranges to allow traffic for, see --tcp for examples. Alternatively the parameter can be specified multiple times. [env: HFC_UDP=]
      --icmp
          Allow ICMP traffic [env: HFC_ICMP=]
      --gre
          Allow GRE traffic [env: HFC_GRE=]
      --esp
          Allow ESP traffic [env: HFC_ESP=]
      --ip <STATIC IP>
          Comma separated list of static IP addresses in CIDR notation to add to all firewall rules in addition to dynamically discovered IP addresses. Alternatively the parameter can be specified multiple times. The Hetzner Cloud API requires that the IP is the network id of the specified network, so 127.0.0.0/24 would work while 127.0.0.1/24 would fail. [env: HFC_IP=]
      --disable-ipv4
          Disable the detection of the public IPv4 address [env: HFC_DISABLE_IPV4=]
      --disable-ipv6
          Disable the detection of the public IPv6 address [env: HFC_DISABLE_IPV6=]
  -r, --reconciliation-interval <RECONCILIATION_INTERVAL>
          Reconciliation interval in seconds [env: HFC_RECONCILIATION_INTERVAL=] [default: 60]
  -i, --ip-endpoint <IP_ENDPOINT>
          Endpoint to query your public IP from [env: HFC_IP_ENDPOINT=] [default: https://ip.fotoallerlei.com]
  -h, --help
          Print help
  -V, --version
          Print version

Planned Features

  • Add IP addresses based on dynamic DNS records
  • Pagination in case there are many firewalls in the Hetzner Cloud project

Disclaimer

I am using this project to learn rust, so naturally the code might be filled with beginners mistakes. Especially in the beginning I will break the config format without any notice.

License

This software is in no way officially associated with Hetzner or Hetzner Cloud.

About

Keep a Hetzner Cloud firewall up to date with your dynamic public IP address.

Topics

Resources

License

Stars

Watchers

Forks