diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..4ae4870 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,50 @@ +name: Build Images + +on: + push: + +jobs: + docker: + runs-on: ubuntu-latest + strategy: + matrix: + arch: [amd64, arm64/v8] + variant: + - name: nf_tables + use_iptables_legacy: "false" + - name: legacy + use_iptables_legacy: "true" + steps: + - name: Log into DockerHub + if: github.event_name != 'pull_request' + uses: docker/login-action@v3 + with: + username: ${{ github.actor }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Docker meta + id: meta + uses: docker/metadata-action@v5 + with: + images: ${{ github.actor }}/ufw-docker-agent + tags: | + type=schedule,suffix=-${{ matrix.variant.name }} + type=ref,event=branch,suffix=-${{ matrix.variant.name }} + type=ref,event=pr,suffix=-${{ matrix.variant.name }} + type=semver,pattern={{version}},suffix=-${{ matrix.variant.name }} + + - name: Build and push + uses: docker/build-push-action@v6 + with: + push: ${{ github.event_name != 'pull_request' }} + platforms: linux/${{ matrix.arch }} + build-args: | + use_iptables_legacy=${{ matrix.variant.use_iptables_legacy }} + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} diff --git a/Dockerfile b/Dockerfile index 074a5ff..b63c63e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,7 @@ -FROM ubuntu:20.04 +FROM ubuntu:24.04 -ARG docker_version="20.10.17" +ARG docker_version="27.3.1" +ARG use_iptables_legacy=false ENV DEBIAN_FRONTEND=noninteractive RUN apt-get update \ @@ -12,9 +13,17 @@ RUN apt-get update \ | tee /etc/apt/sources.list.d/docker.list > /dev/null \ && apt-get update \ && apt-get install -y --no-install-recommends locales ufw \ - && ( apt-get install -y --no-install-recommends "docker-ce=5:${docker_version}~*" || \ - apt-get install -y --no-install-recommends "docker-ce=${docker_version}~*" ) \ + && apt-get install -y --no-install-recommends "docker-ce=$(apt-cache madison docker-ce | grep -m1 -F "${docker_version}" | cut -d'|' -f2 | tr -d '[[:blank:]]')" \ && locale-gen en_US.UTF-8 \ + && if "$use_iptables_legacy"; then \ + apt-get -y install arptables ebtables \ + && update-alternatives --install /usr/sbin/arptables arptables /usr/sbin/arptables-legacy 100 \ + && update-alternatives --install /usr/sbin/ebtables ebtables /usr/sbin/ebtables-legacy 100 \ + && update-alternatives --set iptables /usr/sbin/iptables-legacy \ + && update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy \ + && update-alternatives --set arptables /usr/sbin/arptables-legacy \ + && update-alternatives --set ebtables /usr/sbin/ebtables-legacy; \ + fi \ && apt-get clean autoclean \ && apt-get autoremove --yes \ && rm -rf /var/lib/{apt,dpkg,cache,log}/ diff --git a/README.md b/README.md index 75146dc..1d836f1 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ UFW is a popular iptables front end on Ubuntu that makes it easy to manage firew The issue is: 1. UFW is enabled on a server that provides external services, and all incoming connections that are not allowed are blocked by default. -2. Run a Docker container on the server and use the `-p` option to publish ports for that container on all IP addresses. +2. Run a Docker container on the server and use the `-p` option to publish ports for that container on all IP addresses. For example: `docker run -d --name httpd -p 0.0.0.0:8080:80 httpd:alpine`, this command will run an httpd service and publish port 80 of the container to port 8080 of the server. 3. UFW will not block all external requests to visit port 8080. Even the command `ufw deny 8080` will not prevent external access to this port. 4. This problem is actually quite serious, which means that a port that was originally intended to provide services internally is exposed to the public network. @@ -43,7 +43,7 @@ Almost all of these solutions are similar. It requires to disable docker's iptab The solutions that we can find on internet are very similar and not elegant, I hope a new solution can: -- Don't need to disable Docker's iptables and let Docker to manage it's network. +- Don't need to disable Docker's iptables and let Docker to manage it's network. We don't need to manually maintain iptables rules for any new Docker networks, and avoid potential side effects after disabling iptables in Docker. - The public network cannot access ports that published by Docker. Even if the port is published on all IP addresses using an option like `-p 8080:80`. Containers and internal networks can visit each other normally. Although it is possible to have Docker publish a container's port to the server's private IP address, the port will not be accessed on the public network. But, this server may have multiple private IP addresses, and these private IP addresses may also change. @@ -193,6 +193,22 @@ Con: Doesn't support older versions of Ubuntu, and the command is a bit more complicated. But you can use my script. +### IPv6 + +[Enable IPv6 support](https://forums.docker.com/t/docker-user-chain-for-ip6tables/133961/3) in Docker by specifying ULA range (RFC 4193) in `/etc/docker/daemon.json` +```json +{ + "experimental": true, + "ipv6": true, + "ip6tables": true, + "fixed-cidr-v6": "fd00:dead:beef::/48" +} +``` + +Restart Docker +```shell +systemctl restart docker +``` ### Conclusion @@ -220,6 +236,36 @@ This command does the following things: - Back up the file `/etc/ufw/after.rules` - Append the rules of UFW and Docker at the end of the file +#### IPv6 support + +`ufw-docker` also supports IPv6 networks and will update `/etc/ufw/after6.rules` when necessary. + +### Using the `--docker-subnets` option + +You can use the `--docker-subnets` option to customize which subnets will be allowed to communicate with Docker containers. +This option applies to both IPv4 and IPv6 networks. + +* If the option is **not provided**, only standard private LAN subnets will be used + (IPv4: `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`; IPv6: `fd00::/8`) +* If `--docker-subnets` is given **without any arguments**, all Docker network subnets will be detected and used automatically. + **Note:** If you add or remove Docker networks, you need to run `ufw-docker install --docker-subnets` again to update the firewall rules according to the latest network configuration. +* If one or more subnets are specified, only these subnets will be used (you can list multiple subnets, separated by spaces; each should be in CIDR format). + The subnets can include networks not managed by Docker itself. + +#### Examples + + # Use default private LAN subnets (IPv4: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16; IPv6: fd00::/8) + ufw-docker install + + # Auto-detect and use all Docker network subnets (both IPv4 and IPv6) + ufw-docker install --docker-subnets + + # Only allow these specified subnets to communicate with Docker containers + ufw-docker install --docker-subnets 192.168.207.0/24 10.207.0.0/16 fd00:cf::/64 + + +You can use the same options with `ufw-docker check` to preview the changes before applying them. + #### Install for Docker Swarm mode We can only use this script on manager nodes to manage firewall rules when using in Swarm mode. @@ -289,7 +335,7 @@ Remove rules from all nodes related to the service `web` ### Try it out -We use [Vagrant](https://www.vagrantup.com/) to set up a local testing environment. +We use [Vagrant](https://www.vagrantup.com/) to set up a local testing environment. Run the following command to create 1 master node and 2 worker nodes @@ -406,7 +452,7 @@ UFW 是 Ubuntu 上很流行的一个 iptables 前端,可以非常方便的管 COMMIT # END UFW AND DOCKER - + 然后重启 UFW,`sudo systemctl restart ufw`。现在外部就已经无法访问 Docker 发布出来的任何端口了,但是容器内部以及私有网络地址上可以正常互相访问,而且容器也可以正常访问外部的网络。**可能由于某些未知原因,重启 UFW 之后规则也无法生效,请重启服务器。** 如果希望允许外部网络访问 Docker 容器提供的服务,比如有一个容器的服务端口是 `80`。那就可以用以下命令来允许外部网络访问这个服务: @@ -502,6 +548,19 @@ UFW 是 Ubuntu 上很流行的一个 iptables 前端,可以非常方便的管 不支持老版本的 Ubuntu,而且命令的使用上可能也会比较复杂。 +### 支持 IPv6 + +要让 Docker Engine [启用 IPv6 的支持](https://forums.docker.com/t/docker-user-chain-for-ip6tables/133961/3). 你需要在 `/etc/docker/daemon.json` 文件中启用相关设置,并分配一个 ULA(唯一本地地址,RFC 4193)地址段作为 IPv6 网络范围。 + +```json +{ + "experimental": true, + "ipv6": true, + "ip6tables": true, + "fixed-cidr-v6": "fd00:dead:beef::/48" +} +``` + #### 结论 如果我们正在使用老版本的 Ubuntu,我们可以使用 `ufw-user-input`。但是要小心避免把不该暴露的服务暴露出去。 @@ -528,6 +587,33 @@ UFW 是 Ubuntu 上很流行的一个 iptables 前端,可以非常方便的管 - 备份文件 `/etc/ufw/after.rules` - 把 UFW 和 Docker 的相关规则添加到文件 `after.rules` 的末尾 +#### IPv6 支持 + +`ufw-docker` 也支持 IPv6 网络,并会在需要时自动更新 `/etc/ufw/after6.rules` 文件。 + +### 使用 `--docker-subnets` 选项 + +你可以使用 `--docker-subnets` 选项,自定义允许与 Docker 容器通信的子网。 +该选项同时适用于 IPv4 和 IPv6 网络。 + +* 如果**未指定**该选项,只会使用标准的私有局域网子网 + (IPv4:`10.0.0.0/8`、`172.16.0.0/12`、`192.168.0.0/16`;IPv6:`fd00::/8`) +* 如果指定了 `--docker-subnets` 但**未带参数**,会自动检测并使用所有 Docker 网络的子网。 + **注意:** 如果你对 Docker 网络进行了新增或删除操作,需要重新运行 `ufw-docker install --docker-subnets`,以便根据最新的网络配置更新防火墙规则。 +* 如果指定了一个或多个子网,则只会使用这些子网(你可以用空格分隔多个子网,每个子网应为 CIDR 格式)。 + 这些子网可以包括非 Docker 管理的网络。 + +#### 示例 + + # 使用默认的私有局域网子网(IPv4:10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16;IPv6:fd00::/8) + ufw-docker install + + # 自动检测并使用所有 Docker 网络的子网(同时支持 IPv4 和 IPv6) + ufw-docker install --docker-subnets + + # 仅允许这些指定的子网与 Docker 容器通信 + ufw-docker install --docker-subnets 192.168.207.0/24 10.207.0.0/16 fd00:cf::/64 + #### 为 Docker Swarm 环境安装 仅仅可以在管理节点上使用 `ufw-docker` 这个脚本来管理防火墙规则。 diff --git a/Vagrantfile b/Vagrantfile index ced906d..baf5815 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -6,16 +6,15 @@ ENV['VAGRANT_NO_PARALLEL']="true" Vagrant.configure('2') do |config| - - docker_version = "20.10.17" - ubuntu_version = File.readlines("Dockerfile").filter { |line| line.start_with?("FROM ") }.first.match(/\d\d\.\d\d/)[0] - config.vm.box = "chaifeng/ubuntu-#{ubuntu_version}-docker-#{docker_version}#{(`uname -m`.strip == "arm64")?"-arm64":""}" + docker_version = File.readlines("Dockerfile").filter { |line| + line.start_with?("ARG docker_version=") + }.first.match(/"([\d\.]+)"/)[1] - #config.vm.box = "chaifeng/ubuntu-20.04-docker-20.10.17#{(`uname -m`.strip == "arm64")?"-arm64":""}" + config.vm.box = "chaifeng/ubuntu-#{ubuntu_version}-docker-#{docker_version}" config.vm.provider 'virtualbox' do |vb| vb.memory = '1024' @@ -28,14 +27,35 @@ Vagrant.configure('2') do |config| end ip_prefix="192.168.56" + ip6_prefix="fd00:a:b" + worker_count=1 - config.vm.provision 'docker-daemon-config', type: 'shell', inline: <<-SHELL + def env_true?(env_name) + value = ENV[env_name] || 'false' + true_values = %w[true yes on 1] + down = value.strip.downcase + return 'true' if true_values.include?(down) + 'false' + end + + def env_true_str?(env_name) + env_true?(env_name).to_s + end + + config.vm.provision 'setup', preserve_order: true, type: 'shell', privileged: false, inline: <<-SHELL + byobu-ctrl-a screen + SHELL + + config.vm.provision 'docker-daemon-config', type: 'shell', inline: <<-SHELL set -eu - if [[ ! -f /etc/docker/daemon.json ]]; then + [[ -f /etc/profile.d/editor.sh ]] || echo 'export EDITOR=vim' > /etc/profile.d/editor.sh + if [[ "$(hostname)" = @(master|node?) && ! -f /etc/docker/daemon.json ]]; then echo '{' >> /etc/docker/daemon.json echo ' "insecure-registries": ["localhost:5000", "#{ip_prefix}.130:5000"]' >> /etc/docker/daemon.json [[ -n "#{ENV['DOCKER_REGISTRY_MIRROR']}" ]] && echo ' , "registry-mirrors": ["#{ENV['DOCKER_REGISTRY_MIRROR']}"]' >> /etc/docker/daemon.json + #{env_true_str?('ENABLE_DOCKER_IPV6')} && + echo ' ,"ip6tables": true, "ipv6": true, "fixed-cidr-v6": "#{ip6_prefix}:deaf::/64"' >> /etc/docker/daemon.json echo '}' >> /etc/docker/daemon.json if type systemctl &>/dev/null; then systemctl restart docker @@ -45,27 +65,30 @@ Vagrant.configure('2') do |config| fi SHELL - config.vm.provision 'ufw-docker', type: 'shell', inline: <<-SHELL - set -euo pipefail + config.vm.provision 'ufw-docker', preserve_order: true, type: 'shell', inline: <<-SHELL + set -xeuo pipefail export DEBUG=true lsb_release -is | grep -Fi ubuntu - /vagrant/ufw-docker check || { - ufw allow OpenSSH - ufw allow from #{ip_prefix}.128/28 to any - yes | ufw enable || true - ufw status | grep '^Status: active' + declare -a subnets=(--docker-subnets 192.168.56.128/28 10.0.0.0/8 172.16.0.0/12) + #{env_true_str?('ENABLE_DOCKER_IPV6')} && + subnets+=(fd00:a:b:deaf::/64 fd05:8f23:c937:1::/64 fd05:8f23:c937:2::/64 fd05:8f23:c937::/64) + if [[ "$(hostname)" = @(master|node?) ]]; then + /vagrant/ufw-docker check "${subnets[@]-}" >/dev/null 2>&1 || { + ufw allow OpenSSH + ufw allow from #{ip_prefix}.128/28 to any + #{env_true_str?('ENABLE_DOCKER_IPV6')} && + ufw allow from #{ip6_prefix}:0:cafe::/80 to any - /vagrant/ufw-docker install + yes | ufw enable || true + ufw status | grep '^Status: active' - sed -i -e 's,192\.168\.0\.0/16,#{ip_prefix}.128/28,' /etc/ufw/after.rules - - systemctl restart ufw + /vagrant/ufw-docker install "${subnets[@]-}" + systemctl restart ufw + } [[ -L /usr/local/bin/ufw-docker ]] || ln -s /vagrant/ufw-docker /usr/local/bin/ - - iptables -I DOCKER-USER 4 -p udp -j LOG --log-prefix '[UFW DOCKER] ' - } + fi SHELL private_registry="#{ip_prefix}.130:5000" @@ -74,10 +97,14 @@ Vagrant.configure('2') do |config| master_ip_address = "#{ip_prefix}.130" master.vm.hostname = "master" master.vm.network "private_network", ip: "#{master_ip_address}" + if env_true?('ENABLE_DOCKER_IPV6') + master.vm.network "private_network", ip: "#{ip6_prefix}:0:cafe::130", type: "static", netmast: 64, auto_config: true + end - master.vm.provision "unit-testing", preserve_order: true, type: 'shell', inline: <<-SHELL + master.vm.provision "unit-testing", preserve_order: true, type: 'shell', privileged: false, inline: <<-SHELL set -euo pipefail - /vagrant/test.sh + [[ -n "#{ENV['DISABLE_UNIT_TESTING']}" ]] || + /vagrant/test.sh SHELL master.vm.provision "docker-registry", preserve_order: true, type: 'docker' do |d| @@ -88,12 +115,13 @@ Vagrant.configure('2') do |config| daemonize: true end - ufw_docker_agent_image = "#{private_registry}/chaifeng/ufw-docker-agent:test-legacy" + ufw_docker_agent_image = "#{private_registry}/chaifeng/ufw-docker-agent:test" master.vm.provision "docker-build-ufw-docker-agent", preserve_order: true, type: 'shell', inline: <<-SHELL - set -euo pipefail + set -xeuo pipefail suffix="$(iptables --version | grep -o '\\(nf_tables\\|legacy\\)')" - docker build -t "#{ufw_docker_agent_image}-${suffix}" /vagrant + if [[ "$suffix" = legacy ]]; then use_iptables_legacy=true; else use_iptables_legacy=false; fi + docker build --build-arg use_iptables_legacy="${use_iptables_legacy:-false}" -t "#{ufw_docker_agent_image}-${suffix}" /vagrant docker push "#{ufw_docker_agent_image}-${suffix}" echo "export UFW_DOCKER_AGENT_IMAGE=#{ufw_docker_agent_image}-${suffix}" > /etc/profile.d/ufw-docker.sh @@ -103,7 +131,7 @@ Vagrant.configure('2') do |config| echo "Defaults env_keep += DEBUG" >> /etc/sudoers.d/98_ufw-docker SHELL - master.vm.provision "swarm-init", preserve_order: true, type: 'shell', inline: <<-SHELL + master.vm.provision "swarm-init", preserve_order: true, type: 'shell', privileged: false, inline: <<-SHELL set -euo pipefail docker info | fgrep 'Swarm: active' && exit 0 @@ -111,15 +139,15 @@ Vagrant.configure('2') do |config| docker swarm join-token worker --quiet > /vagrant/.vagrant/docker-join-token SHELL - master.vm.provision "build-webapp", preserve_order: true, type: 'shell', inline: <<-SHELL - set -euo pipefail + master.vm.provision "build-webapp", preserve_order: true, type: 'shell', privileged: false, inline: <<-SHELL + set -xeuo pipefail docker build -t #{private_registry}/chaifeng/hostname-webapp - <<\\DOCKERFILE FROM httpd:alpine +RUN printf "Listen %s\\n" 7000 8080 >> /usr/local/apache2/conf/httpd.conf + RUN { echo '#!/bin/sh'; \\ echo 'set -e; (echo -n "${name:-Hi} "; hostname;) > /usr/local/apache2/htdocs/index.html'; \\ - echo 'grep "^Listen 7000" || echo Listen 7000 >> /usr/local/apache2/conf/httpd.conf'; \\ - echo 'grep "^Listen 8080" || echo Listen 8080 >> /usr/local/apache2/conf/httpd.conf'; \\ echo 'exec "$@"'; \\ } > /entrypoint.sh; chmod +x /entrypoint.sh @@ -130,7 +158,7 @@ DOCKERFILE SHELL master.vm.provision "local-webapp", preserve_order: true, type: 'shell', inline: <<-SHELL - set -euo pipefail + set -xeuo pipefail for name in public:18080 local:8000; do webapp="${name%:*}_webapp" port="${name#*:}" @@ -144,12 +172,16 @@ DOCKERFILE SHELL master.vm.provision "multiple-network", preserve_order: true, type: 'shell', inline: <<-SHELL - set -euo pipefail + set -xeuo pipefail + declare -a docker_opts=() + if ! docker network ls | grep -F foo-internal; then - docker network create --internal foo-internal + ! #{env_true_str?('ENABLE_DOCKER_IPV6')} || docker_opts=(--ipv6 --subnet fd05:8f23:c937:1::/64) + docker network create --internal "${docker_opts[@]}" foo-internal fi if ! docker network ls | grep -F bar-external; then - docker network create bar-external + ! #{env_true_str?('ENABLE_DOCKER_IPV6')} || docker_opts=(--ipv6 --subnet fd05:8f23:c937:2::/64) + docker network create "${docker_opts[@]}" bar-external fi for app in internal-multinet-app:7000 public-multinet-app:17070; do @@ -167,32 +199,42 @@ DOCKERFILE SHELL master.vm.provision "swarm-webapp", preserve_order: true, type: 'shell', inline: <<-SHELL - set -euo pipefail + set -xeuo pipefail + declare -a docker_opts=() + if #{env_true_str?('ENABLE_DOCKER_IPV6')}; then + docker inspect ip6net >/dev/null || + docker network create --driver overlay --ipv6 ip6net + docker_opts+=(--network ip6net) + fi for name in public:29090 local:9000; do webapp="${name%:*}_service" port="${name#*:}" if docker service inspect "$webapp" &>/dev/null; then docker service rm "$webapp"; fi - docker service create --name "$webapp" \ - --publish "${port}:80" --env name="$webapp" --replicas 3 #{private_registry}/chaifeng/hostname-webapp + docker service create --name "$webapp" "${docker_opts[@]}" \ + --publish "${port}:80" --env name="$webapp" --replicas #{worker_count} #{private_registry}/chaifeng/hostname-webapp done ufw-docker service allow public_service 80/tcp - docker service create --name "public_multiport" \ - --publish "40080:80" --publish "47000:7000" --publish "48080:8080" \ - --env name="public_multiport" --replicas 3 #{private_registry}/chaifeng/hostname-webapp + docker service inspect "public_multiport" || + docker service create --name "public_multiport" "${docker_opts[@]}" \ + --publish "40080:80" --publish "47000:7000" --publish "48080:8080" \ + --env name="public_multiport" --replicas #{worker_count + 1} #{private_registry}/chaifeng/hostname-webapp ufw-docker service allow public_multiport 80/tcp ufw-docker service allow public_multiport 8080/tcp SHELL end - 1.upto 2 do |ip| + 1.upto worker_count do |ip| config.vm.define "node#{ip}" do | node | node.vm.hostname = "node#{ip}" node.vm.network "private_network", ip: "#{ip_prefix}.#{ 130 + ip }" + if env_true?('ENABLE_DOCKER_IPV6') + node.vm.network "private_network", ip: "#{ip6_prefix}:0:cafe::#{ 130 + ip }", type: "static", netmast: 64, auto_config: true + end - node.vm.provision "swarm-join", preserve_order: true, type: 'shell', inline: <<-SHELL + node.vm.provision "node#{ip}-swarm-join", preserve_order: true, type: 'shell', inline: <<-SHELL set -euo pipefail docker info | fgrep 'Swarm: active' && exit 0 @@ -202,36 +244,92 @@ DOCKERFILE end end + config.vm.define "node-internal" do |node| + node.vm.hostname = "node-internal" + node.vm.network "private_network", ip: "#{ip_prefix}.142" + if env_true?('ENABLE_DOCKER_IPV6') + node.vm.network "private_network", ip: "#{ip6_prefix}:0:cafe::142", type: "static", netmast: 64, auto_config: true + end + end + config.vm.define "external" do |external| external.vm.hostname = "external" external.vm.network "private_network", ip: "#{ip_prefix}.127" + if env_true?('ENABLE_DOCKER_IPV6') + external.vm.network "private_network", ip: "#{ip6_prefix}:0:eeee::127", type: "static", netmast: 64, auto_config: true + end - external.vm.provision "testing", preserve_order: true, type: 'shell', inline: <<-SHELL - set -euo pipefail - set -x - server="http://#{ip_prefix}.130" + external.vm.provision "testing", preserve_order: true, type: 'shell', privileged: false, inline: <<-SHELL + set -xuo pipefail + error_count=0 function test-webapp() { - if timeout 3 curl --silent "$@" - then echo "Success: $*" - else echo "Cannot visit: $*"; return 1 + local actual="" + + if [[ "$#" -eq 2 ]]; then + local expect_fail='!' + url="$2" + else + url="$1" fi + + timeout 3 curl --silent "$url" || actual='!' + + if [[ "${expect_fail:-}" = "${actual}" ]]; then + echo "OK: '$url' is ${expect_fail:+NOT }accessible${expect_fail:+ (should NOT be)}." + else + echo "FAIL: '$url' is ${expect_fail:+}${expect_fail:-NOT }accessible${expect_fail:-}." + (( ++ error_count )) + return 1 + fi + } 2>/dev/null + + function run_tests() { + local server="$1" + test-webapp "$server:18080" + test-webapp ! "$server:8000" + + test-webapp "$server:17070" # multiple networks app + test-webapp ! "$server:7000" # internal multiple networks app + + # Docker Swarm + test-webapp ! "$server:9000" + test-webapp ! "$server:47000" } - test-webapp "$server:18080" - ! test-webapp "$server:8000" + function run_tests_ipv4() { + local server="$1" + # Docker Swarm + test-webapp "$server:29090" - test-webapp "$server:17070" # multiple networks app - ! test-webapp "$server:7000" # internal multiple networks app + test-webapp "$server:40080" + test-webapp "$server:48080" - test-webapp "$server:29090" - ! test-webapp "$server:9000" + } + function run_tests_ipv6() { + local server="$1" - test-webapp "$server:40080" - test-webapp "$server:48080" - ! test-webapp "$server:47000" + echo TODO: It seems that Docker Swarm does not support IPv6 well >&2 + test-webapp ! "$server:29090" # it is accessible via IPv4 + test-webapp ! "$server:40080" # it is accessible via IPv4 + test-webapp ! "$server:48080" # it is accessible via IPv4 + + } + + run_tests "http://#{ip_prefix}.130" + run_tests_ipv4 "http://#{ip_prefix}.130" + + if #{env_true_str?('ENABLE_DOCKER_IPV6')}; then + run_tests "http://[#{ip6_prefix}:0:cafe::130]" + run_tests_ipv6 "http://[#{ip6_prefix}:0:cafe::130]" + fi + { echo "=====================" - echo " TEST DONE " + if [[ "$error_count" -eq 0 ]]; then echo " TEST DONE " + else echo " TESTS FAIL: ${error_count}" + fi echo "=====================" + exit "${error_count}" + } 2>/dev/null SHELL end end diff --git a/test/bach b/test/bach index 447edb6..27885eb 160000 --- a/test/bach +++ b/test/bach @@ -1 +1 @@ -Subproject commit 447edb60db232d3dbc2267f37c49bd7a070cc83d +Subproject commit 27885eb79c11e4652dede994c886ae5f9e30994f diff --git a/test/ufw-docker-service.test.sh b/test/ufw-docker-service.test.sh index dd74bb6..0a9125c 100755 --- a/test/ufw-docker-service.test.sh +++ b/test/ufw-docker-service.test.sh @@ -157,8 +157,7 @@ test-ufw-docker--service-allow-a-service-without-ports-published() { @mocktrue grep -E '^[0-9]+(/(tcp|udp))?$' @mock ufw-docker--get-service-id private-web === @stdout abcd1234 @mock ufw-docker--get-service-name private-web === @stdout private-web - @mock docker service inspect private-web \ - --format '{{range .Endpoint.Spec.Ports}}{{.PublishedPort}} {{.TargetPort}}/{{.Protocol}}{{"\n"}}{{end}}' === @stdout "" + @mock ufw-docker--list-service-ports private-web === @stdout "" load-ufw-docker-function ufw-docker--service-allow ufw-docker--service-allow private-web 80/tcp @@ -173,9 +172,7 @@ test-ufw-docker--service-allow-a-service-while-agent-not-running() { @mocktrue grep -E '^[0-9]+(/(tcp|udp))?$' @mock ufw-docker--get-service-id webapp === @stdout abcd1234 @mock ufw-docker--get-service-name webapp === @stdout webapp - @mock docker service inspect webapp \ - --format '{{range .Endpoint.Spec.Ports}}{{.PublishedPort}} {{.TargetPort}}/{{.Protocol}}{{"\n"}}{{end}}' \ - === @stdout "53 53/udp" "80 80/tcp" "8080 8080/tcp" + @mock ufw-docker--list-service-ports webapp === @stdout "53 53/udp" "80 80/tcp" "8080 8080/tcp" @mockfalse docker service inspect ufw-docker-agent load-ufw-docker-function ufw-docker--service-allow @@ -196,9 +193,7 @@ test-ufw-docker--service-allow-a-service-add-new-env() { @mocktrue grep -E '^[0-9]+(/(tcp|udp))?$' @mock ufw-docker--get-service-id webapp === @stdout abcd1234 @mock ufw-docker--get-service-name webapp === @stdout webapp - @mock docker service inspect webapp \ - --format '{{range .Endpoint.Spec.Ports}}{{.PublishedPort}} {{.TargetPort}}/{{.Protocol}}{{"\n"}}{{end}}' \ - === @stdout "53 53/udp" "80 80/tcp" "8080 8080/tcp" + @mock ufw-docker--list-service-ports webapp === @stdout "53 53/udp" "80 80/tcp" "8080 8080/tcp" @mocktrue docker service inspect ufw-docker-agent @mock ufw-docker--get-env-list === @stdout "abcd1234 webapp/80/tcp" @@ -219,9 +214,7 @@ test-ufw-docker--service-allow-a-service-update-a-env() { @mocktrue grep -E '^[0-9]+(/(tcp|udp))?$' @mock ufw-docker--get-service-id webapp === @stdout abcd1234 @mock ufw-docker--get-service-name webapp === @stdout webapp - @mock docker service inspect webapp \ - --format '{{range .Endpoint.Spec.Ports}}{{.PublishedPort}} {{.TargetPort}}/{{.Protocol}}{{"\n"}}{{end}}' \ - === @stdout "53 53/udp" "80 80/tcp" "8080 8080/tcp" + @mock ufw-docker--list-service-ports webapp === @stdout "53 53/udp" "80 80/tcp" "8080 8080/tcp" @mocktrue docker service inspect ufw-docker-agent @mock ufw-docker--get-env-list === @stdout "a_different_id webapp/80/tcp" @@ -284,6 +277,15 @@ test-ufw-docker--service-delete-matches-assert() { docker service update --update-parallelism=0 \ --env-add ufw_docker_agent_image="${ufw_docker_agent_image}" \ --env-add "ufw_public_abcd1234=webapp/deny" \ + --env-add "DEBUG=false" \ --image "${ufw_docker_agent_image}" \ "${ufw_docker_agent}" } + +test-ufw-docker--list-service-ports() { + load-ufw-docker-function ufw-docker--list-service-ports + ufw-docker--list-service-ports foo +} +test-ufw-docker--list-service-ports-assert() { + docker service inspect foo --format '{{range .Endpoint.Spec.Ports}}{{.PublishedPort}} {{.TargetPort}}/{{.Protocol}}{{"\n"}}{{end}}' +} diff --git a/test/ufw-docker.test.sh b/test/ufw-docker.test.sh index 9d5daa7..52ab301 100755 --- a/test/ufw-docker.test.sh +++ b/test/ufw-docker.test.sh @@ -15,7 +15,10 @@ source "$working_dir"/bach/bach.sh @mock iptables --version @mocktrue grep -F '(legacy)' - @ignore remove_blank_lines + @mocktrue docker -v + @mock docker -v === @stdout Docker version 0.0.0, build dummy + + @mockpipe remove_blank_lines @ignore echo @ignore err @@ -98,6 +101,17 @@ test-ufw-is-disabled-assert() { } +test-docker-is-installed() { + @mockfalse docker -v + + ufw-docker +} +test-docker-is-installed-assert() { + die "Docker executable not found." + ufw-docker--help +} + + test-ufw-docker-status() { ufw-docker status } @@ -114,6 +128,14 @@ test-ufw-docker-install-assert() { } +test-ufw-docker-install--docker-subnets() { + ufw-docker install --docker-subnets +} +test-ufw-docker-install--docker-subnets-assert() { + ufw-docker--install --docker-subnets +} + + test-ufw-docker-check() { ufw-docker check } @@ -122,6 +144,14 @@ test-ufw-docker-check-assert() { } +test-ufw-docker-check--docker-subnets() { + ufw-docker check --docker-subnets +} +test-ufw-docker-check--docker-subnets-assert() { + ufw-docker--check --docker-subnets +} + + test-ufw-docker-service() { ufw-docker service allow httpd } @@ -184,7 +214,7 @@ test-ufw-docker-list-httpd() { ufw-docker list httpd } test-ufw-docker-list-httpd-assert() { - ufw-docker--list httpd-container-name "" tcp "" + ufw-docker--list 'httpd-container-name\(/v6\)\?' "" tcp "" } @@ -232,21 +262,12 @@ test-ASSERT-FAIL-ufw-docker-allow-httpd-INVALID-port() { } -test-ufw-docker-list-httpd() { - @mock ufw-docker--instance-name httpd === @stdout httpd-container-name - ufw-docker list httpd -} -test-ufw-docker-list-httpd-assert() { - ufw-docker--list httpd-container-name "" tcp "" -} - - test-ufw-docker-delete-allow-httpd() { @mock ufw-docker--instance-name httpd === @stdout httpd-container-name ufw-docker delete allow httpd } test-ufw-docker-delete-allow-httpd-assert() { - ufw-docker--delete httpd-container-name "" tcp "" + ufw-docker--delete 'httpd-container-name\(/v6\)\?' "" tcp "" } @@ -263,8 +284,15 @@ function setup-ufw-docker--allow() { load-ufw-docker-function ufw-docker--allow @mocktrue docker inspect instance-name - @mock docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{"\n"}}{{end}}' instance-name === @stdout 172.18.0.3 - @mock docker inspect --format='{{range $k, $v := .NetworkSettings.Networks}}{{printf "%s\n" $k}}{{end}}' instance-name === @stdout default + @mock docker inspect --format '{{range $name, $net := .NetworkSettings.Networks}}{{if $net.IPAddress}}{{$name}} {{$net.IPAddress}}{{"\n"}}{{end}}{{if $net.GlobalIPv6Address}}{{$name}} {{$net.GlobalIPv6Address}}{{"\n"}}{{end}}{{end}}' instance-name === @stdout "default 172.18.0.3" + @mock docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}}{{with $conf}}{{$p}}{{"\n"}}{{end}}{{end}}' instance-name === @stdout 5000/tcp 8080/tcp 5353/udp +} + +function setup-IPv6-ufw-docker--allow() { + load-ufw-docker-function ufw-docker--allow + + @mocktrue docker inspect instance-name + @mock docker inspect --format '{{range $name, $net := .NetworkSettings.Networks}}{{if $net.IPAddress}}{{$name}} {{$net.IPAddress}}{{"\n"}}{{end}}{{if $net.GlobalIPv6Address}}{{$name}} {{$net.GlobalIPv6Address}}{{"\n"}}{{end}}{{end}}' instance-name === @stdout "default 172.18.0.3" "default fd00:cf::42" @mock docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}}{{with $conf}}{{$p}}{{"\n"}}{{end}}{{end}}' instance-name === @stdout 5000/tcp 8080/tcp 5353/udp } @@ -272,8 +300,15 @@ function setup-ufw-docker--allow--multinetwork() { load-ufw-docker-function ufw-docker--allow @mocktrue docker inspect instance-name - @mock docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{"\n"}}{{end}}' instance-name === @stdout 172.18.0.3 172.19.0.7 - @mock docker inspect --format='{{range $k, $v := .NetworkSettings.Networks}}{{printf "%s\n" $k}}{{end}}' instance-name === @stdout default awesomenet + @mock docker inspect --format '{{range $name, $net := .NetworkSettings.Networks}}{{if $net.IPAddress}}{{$name}} {{$net.IPAddress}}{{"\n"}}{{end}}{{if $net.GlobalIPv6Address}}{{$name}} {{$net.GlobalIPv6Address}}{{"\n"}}{{end}}{{end}}' instance-name === @stdout "default 172.18.0.3" "awesomenet 172.19.0.7" + @mock docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}}{{with $conf}}{{$p}}{{"\n"}}{{end}}{{end}}' instance-name === @stdout 5000/tcp 8080/tcp 5353/udp +} + +function setup-IPv6-ufw-docker--allow--multinetwork() { + load-ufw-docker-function ufw-docker--allow + + @mocktrue docker inspect instance-name + @mock docker inspect --format '{{range $name, $net := .NetworkSettings.Networks}}{{if $net.IPAddress}}{{$name}} {{$net.IPAddress}}{{"\n"}}{{end}}{{if $net.GlobalIPv6Address}}{{$name}} {{$net.GlobalIPv6Address}}{{"\n"}}{{end}}{{end}}' instance-name === @stdout "default 172.18.0.3" "default fd00:cf::42" "awesomenet 172.19.0.7" "awesomenet fd00:cf::207" @mock docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}}{{with $conf}}{{$p}}{{"\n"}}{{end}}{{end}}' instance-name === @stdout 5000/tcp 8080/tcp 5353/udp } @@ -373,6 +408,83 @@ test-ufw-docker--allow-instance-all-published-port-multinetwork-select-network-a ufw-docker--add-rule instance-name 172.19.0.7 5353 udp awesomenet } + +test-IPv6-ufw-docker--allow-instance-and-match-the-port() { + setup-IPv6-ufw-docker--allow + + ufw-docker--allow instance-name 5000 tcp +} +test-IPv6-ufw-docker--allow-instance-and-match-the-port-assert() { + ufw-docker--add-rule instance-name 172.18.0.3 5000 tcp default + ufw-docker--add-rule instance-name/v6 fd00:cf::42 5000 tcp default +} + + +test-IPv6-ufw-docker--allow-instance-all-published-port() { + setup-IPv6-ufw-docker--allow + + ufw-docker--allow instance-name "" "" +} +test-IPv6-ufw-docker--allow-instance-all-published-port-assert() { + ufw-docker--add-rule instance-name 172.18.0.3 5000 tcp default + ufw-docker--add-rule instance-name/v6 fd00:cf::42 5000 tcp default + ufw-docker--add-rule instance-name 172.18.0.3 8080 tcp default + ufw-docker--add-rule instance-name/v6 fd00:cf::42 8080 tcp default + ufw-docker--add-rule instance-name 172.18.0.3 5353 udp default + ufw-docker--add-rule instance-name/v6 fd00:cf::42 5353 udp default +} + + +test-IPv6-ufw-docker--allow-instance-all-published-tcp-port() { + setup-IPv6-ufw-docker--allow + + ufw-docker--allow instance-name "" tcp +} +test-IPv6-ufw-docker--allow-instance-all-published-tcp-port-assert() { + ufw-docker--add-rule instance-name 172.18.0.3 5000 tcp default + ufw-docker--add-rule instance-name/v6 fd00:cf::42 5000 tcp default + ufw-docker--add-rule instance-name 172.18.0.3 8080 tcp default + ufw-docker--add-rule instance-name/v6 fd00:cf::42 8080 tcp default + ufw-docker--add-rule instance-name 172.18.0.3 5353 udp default # FIXME + ufw-docker--add-rule instance-name/v6 fd00:cf::42 5353 udp default # FIXME +} + + +test-IPv6-ufw-docker--allow-instance-all-published-port-multinetwork() { + setup-IPv6-ufw-docker--allow--multinetwork + + ufw-docker--allow instance-name "" "" +} +test-IPv6-ufw-docker--allow-instance-all-published-port-multinetwork-assert() { + ufw-docker--add-rule instance-name 172.18.0.3 5000 tcp default + ufw-docker--add-rule instance-name/v6 fd00:cf::42 5000 tcp default + ufw-docker--add-rule instance-name 172.19.0.7 5000 tcp awesomenet + ufw-docker--add-rule instance-name/v6 fd00:cf::207 5000 tcp awesomenet + ufw-docker--add-rule instance-name 172.18.0.3 8080 tcp default + ufw-docker--add-rule instance-name/v6 fd00:cf::42 8080 tcp default + ufw-docker--add-rule instance-name 172.19.0.7 8080 tcp awesomenet + ufw-docker--add-rule instance-name/v6 fd00:cf::207 8080 tcp awesomenet + ufw-docker--add-rule instance-name 172.18.0.3 5353 udp default + ufw-docker--add-rule instance-name/v6 fd00:cf::42 5353 udp default + ufw-docker--add-rule instance-name 172.19.0.7 5353 udp awesomenet + ufw-docker--add-rule instance-name/v6 fd00:cf::207 5353 udp awesomenet +} + +test-IPv6-ufw-docker--allow-instance-all-published-port-multinetwork-select-network() { + setup-IPv6-ufw-docker--allow--multinetwork + + ufw-docker--allow instance-name "" "" awesomenet +} +test-IPv6-ufw-docker--allow-instance-all-published-port-multinetwork-select-network-assert() { + ufw-docker--add-rule instance-name 172.19.0.7 5000 tcp awesomenet + ufw-docker--add-rule instance-name/v6 fd00:cf::207 5000 tcp awesomenet + ufw-docker--add-rule instance-name 172.19.0.7 8080 tcp awesomenet + ufw-docker--add-rule instance-name/v6 fd00:cf::207 8080 tcp awesomenet + ufw-docker--add-rule instance-name 172.19.0.7 5353 udp awesomenet + ufw-docker--add-rule instance-name/v6 fd00:cf::207 5353 udp awesomenet +} + + test-ufw-docker--add-rule-a-non-existing-rule() { @mockfalse ufw-docker--list webapp 5000 tcp "" @@ -396,7 +508,7 @@ test-ufw-docker--add-rule-a-non-existing-rule-with-network-assert() { test-ufw-docker--add-rule-modify-an-existing-rule() { @mocktrue ufw-docker--list webapp 5000 tcp default - @mocktrue ufw --dry-run route allow proto tcp from any to 172.18.0.4 port 5000 comment "allow webapp 5000/tcp default" + @mock ufw --dry-run route allow proto tcp from any to 172.18.0.4 port 5000 comment "allow webapp 5000/tcp default" === @echo @mockfalse grep "^Skipping" load-ufw-docker-function ufw-docker--add-rule @@ -409,6 +521,21 @@ test-ufw-docker--add-rule-modify-an-existing-rule-assert() { } +test-IPv6-ufw-docker--add-rule-modify-an-existing-rule() { + @mocktrue ufw-docker--list webapp/v6 5000 tcp default + @mock ufw --dry-run route allow proto tcp from any to fd00:cf::42 port 5000 comment "allow webapp/v6 5000/tcp default" === @echo + @mockfalse grep "^Skipping" + + load-ufw-docker-function ufw-docker--add-rule + ufw-docker--add-rule webapp/v6 fd00:cf::42 5000 tcp default +} +test-IPv6-ufw-docker--add-rule-modify-an-existing-rule-assert() { + ufw-docker--delete webapp/v6 5000 tcp default + + ufw route allow proto tcp from any to fd00:cf::42 port 5000 comment "allow webapp/v6 5000/tcp default" +} + + test-ufw-docker--add-rule-skip-an-existing-rule() { @mocktrue ufw-docker--list webapp 5000 tcp "" @mocktrue ufw --dry-run route allow proto tcp from any to 172.18.0.4 port 5000 comment "allow webapp 5000/tcp" @@ -424,8 +551,7 @@ test-ufw-docker--add-rule-skip-an-existing-rule-assert() { test-ufw-docker--add-rule-modify-an-existing-rule-without-port() { @mocktrue ufw-docker--list webapp "" tcp "" - - @mocktrue ufw --dry-run route allow proto tcp from any to 172.18.0.4 comment "allow webapp" + @mock ufw --dry-run route allow proto tcp from any to 172.18.0.4 comment "allow webapp" === @echo @mockfalse grep "^Skipping" load-ufw-docker-function ufw-docker--add-rule @@ -451,7 +577,7 @@ test-ufw-docker--instance-name-found-a-name() { } test-ufw-docker--instance-name-found-a-name-assert() { docker inspect --format="{{.Name}}" foo - echo -n foo + @dryrun echo -n foo } @@ -470,11 +596,14 @@ test-ufw-docker--instance-name-found-an-id-assert() { test-ufw-docker--list-name() { @mocktrue ufw status numbered + @mockfalse grep "# allow foo\\( [[:digit:]]\\+\\/\\(tcp\\|udp\\)\\)\\( [[:graph:]]*\\)\$" + @mockfalse grep "# allow foo\\( [[:digit:]]\\+\\/\\(tcp\\|udp\\)\\)\$" + load-ufw-docker-function ufw-docker--list ufw-docker--list foo } test-ufw-docker--list-name-assert() { - grep "# allow foo\\( [[:digit:]]\\+\\/\\(tcp\\|udp\\)\\)\\( [[:graph:]]*\\)\$" + grep "# allow foo\$" } test-ufw-docker--list-name-udp() { @@ -509,24 +638,23 @@ test-ufw-docker--list-name-80-udp-assert() { test-ufw-docker--list-grep-without-network() { @mocktrue ufw status numbered - @mockfalse grep "# allow foo\\( 80\\/udp\\)\\( [[:graph:]]*\\)\$" load-ufw-docker-function ufw-docker--list ufw-docker--list foo 80 udp } test-ufw-docker--list-grep-without-network-assert() { - grep "# allow foo\\( 80\\/udp\\)\$" + grep "# allow foo\\( 80\\/udp\\)\\( [[:graph:]]*\\)\$" } test-ufw-docker--list-grep-without-network-and-port() { @mocktrue ufw status numbered - @mockfalse grep "# allow foo\\( 80\\/udp\\)\\( [[:graph:]]*\\)\$" - @mockfalse grep "# allow foo\\( 80\\/udp\\)\$" + @mockfalse grep "# allow foo\\( 80\\/tcp\\)\\( [[:graph:]]*\\)\$" + load-ufw-docker-function ufw-docker--list - ufw-docker--list foo 80 udp + ufw-docker--list foo 80 } test-ufw-docker--list-grep-without-network-and-port-assert() { - grep "# allow foo\$" + grep "# allow foo\\( 80\\/tcp\\)\$" } @@ -543,7 +671,7 @@ test-ufw-docker--list-number-assert() { test-ufw-docker--delete-empty-result() { @mock ufw-docker--list-number webapp 80 tcp === @stdout "" - @mock sort -rn + @mockpipe sort -rn load-ufw-docker-function ufw-docker--delete ufw-docker--delete webapp 80 tcp @@ -555,7 +683,7 @@ test-ufw-docker--delete-empty-result-assert() { test-ufw-docker--delete-all() { @mock ufw-docker--list-number webapp 80 tcp === @stdout 5 8 9 - @mock sort -rn + @mockpipe sort -rn load-ufw-docker-function ufw-docker--delete ufw-docker--delete webapp 80 tcp diff --git a/ufw-docker b/ufw-docker index dffc501..012c1be 100755 --- a/ufw-docker +++ b/ufw-docker @@ -5,13 +5,13 @@ set -euo pipefail LANG=en_US.UTF-8 LANGUAGE=en_US: LC_ALL=en_US.UTF-8 -PATH="/bin:/usr/bin:/sbin:/usr/sbin" +PATH="/bin:/usr/bin:/sbin:/usr/sbin:/snap/bin/" GREP_REGEXP_INSTANCE_NAME="[-_.[:alnum:]]\\+" DEFAULT_PROTO=tcp ufw_docker_agent=ufw-docker-agent -ufw_docker_agent_image="${UFW_DOCKER_AGENT_IMAGE:-chaifeng/${ufw_docker_agent}:221002-legacy}" +ufw_docker_agent_image="${UFW_DOCKER_AGENT_IMAGE:-chaifeng/${ufw_docker_agent}:250702-nf_tables}" if [[ "${ufw_docker_agent_image}" = *-@(legacy|nf_tables) ]]; then if iptables --version | grep -F '(legacy)' &>/dev/null; then @@ -24,7 +24,7 @@ fi test -n "$ufw_docker_agent_image" function ufw-docker--status() { - ufw-docker--list "$GREP_REGEXP_INSTANCE_NAME" + ufw-docker--list "$GREP_REGEXP_INSTANCE_NAME\(/v6\)\?" } function ufw-docker--list() { @@ -32,6 +32,7 @@ function ufw-docker--list() { local INSTANCE_PORT="${2:-}" local PROTO="${3:-${DEFAULT_PROTO}}" local NETWORK="${4:-}" + local params_count="$#" if [[ -z "$INSTANCE_PORT" ]]; then INSTANCE_PORT="[[:digit:]]\\+" @@ -42,9 +43,12 @@ function ufw-docker--list() { NETWORK="[[:graph:]]*" fi - ufw status numbered | grep "# allow ${INSTANCE_NAME}\\( ${INSTANCE_PORT}\\/${PROTO}\\)\\( ${NETWORK}\\)\$" || \ - ufw status numbered | grep "# allow ${INSTANCE_NAME}\\( ${INSTANCE_PORT}\\/${PROTO}\\)\$" || \ - ufw status numbered | grep "# allow ${INSTANCE_NAME}\$" + local ufw_output + ufw_output="$(ufw status numbered)" + + grep "# allow ${INSTANCE_NAME}\\( ${INSTANCE_PORT}\\/${PROTO}\\)\\( ${NETWORK}\\)\$" <<< "$ufw_output" || + grep "# allow ${INSTANCE_NAME}\\( ${INSTANCE_PORT}\\/${PROTO}\\)\$" <<< "$ufw_output" || + grep "# allow ${INSTANCE_NAME}\$" <<< "$ufw_output" } function ufw-docker--list-number() { @@ -63,15 +67,15 @@ function ufw-docker--allow() { local INSTANCE_PORT="$2" local PROTO="$3" local NETWORK="${4:-}" + local NETWORK_ADDRESSES PORT_PROTO_LIST PROT_PROTO IP SUFFIX docker inspect "$INSTANCE_NAME" &>/dev/null || die "Docker instance \"$INSTANCE_NAME\" doesn't exist." - mapfile -t INSTANCE_IP_ADDRESSES < <(docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{"\n"}}{{end}}' "$INSTANCE_NAME" 2>/dev/null | remove_blank_lines) + mapfile -t NETWORK_ADDRESSES < <(docker inspect --format '{{range $name, $net := .NetworkSettings.Networks}}{{if $net.IPAddress}}{{$name}} {{$net.IPAddress}}{{"\n"}}{{end}}{{if $net.GlobalIPv6Address}}{{$name}} {{$net.GlobalIPv6Address}}{{"\n"}}{{end}}{{end}}' "$INSTANCE_NAME" 2>/dev/null | remove_blank_lines) - [[ -z "${INSTANCE_IP_ADDRESSES:-}" ]] && die "Could not find a running instance \"$INSTANCE_NAME\"." + [[ -z "${NETWORK_ADDRESSES:-}" ]] && die "Could not find a running instance \"$INSTANCE_NAME\"." - mapfile -t INSTANCE_NETWORK_NAMES < <(docker inspect --format='{{range $k, $v := .NetworkSettings.Networks}}{{printf "%s\n" $k}}{{end}}' "$INSTANCE_NAME" 2>/dev/null | remove_blank_lines) mapfile -t PORT_PROTO_LIST < <(docker inspect --format='{{range $p, $conf := .NetworkSettings.Ports}}{{with $conf}}{{$p}}{{"\n"}}{{end}}{{end}}' "$INSTANCE_NAME" | remove_blank_lines) if [[ -z "${PORT_PROTO_LIST:-}" ]]; then @@ -79,25 +83,26 @@ function ufw-docker--allow() { return 1 fi - RETVAL=1 + local count=0 for PORT_PROTO in "${PORT_PROTO_LIST[@]}"; do if [[ -z "$INSTANCE_PORT" || "$PORT_PROTO" = "${INSTANCE_PORT}/${PROTO}" ]]; then - ITER=0 - for IP in "${INSTANCE_IP_ADDRESSES[@]}"; do - INSTANCE_NETWORK="${INSTANCE_NETWORK_NAMES[$ITER]}" - ITER=$((ITER+1)) + for item in "${NETWORK_ADDRESSES[@]}"; do + INSTANCE_NETWORK="${item% *}" + IP="${item#* }" if [[ -n "$NETWORK" ]] && [[ "$NETWORK" != "$INSTANCE_NETWORK" ]]; then continue fi - ufw-docker--add-rule "$INSTANCE_NAME" "$IP" "${PORT_PROTO%/*}" "${PORT_PROTO#*/}" "${INSTANCE_NETWORK}" - RETVAL="$?" + if [[ "$IP" = *:* ]]; then SUFFIX="/v6"; else SUFFIX=""; fi + ufw-docker--add-rule "${INSTANCE_NAME}${SUFFIX}" "$IP" "${PORT_PROTO%/*}" "${PORT_PROTO#*/}" "${INSTANCE_NETWORK}" + (( ++count )) done fi done - if [[ "$RETVAL" -ne 0 ]]; then + if [[ "$count" -eq 0 ]]; then err "Fail to add rule(s), cannot find the published port ${INSTANCE_PORT}/${PROTO} of instance \"${INSTANCE_NAME}\" or cannot update outdated rule(s)." + return 1 fi - return "$RETVAL" + return 0 } function ufw-docker--add-service-rule() { @@ -191,6 +196,12 @@ function ufw-docker--get-service-name() { docker service inspect "${service_name}" --format "{{.Spec.Name}}" } +function ufw-docker--list-service-ports() { + declare service_name="$1" + docker service inspect "$service_name" \ + --format '{{range .Endpoint.Spec.Ports}}{{.PublishedPort}} {{.TargetPort}}/{{.Protocol}}{{"\n"}}{{end}}' +} + function ufw-docker--service-allow() { declare service_name="$1" declare service_port="$2" @@ -213,8 +224,7 @@ function ufw-docker--service-allow() { service_name="$(ufw-docker--get-service-name "${service_name}")" - exec 9< <(docker service inspect "$service_name" \ - --format '{{range .Endpoint.Spec.Ports}}{{.PublishedPort}} {{.TargetPort}}/{{.Protocol}}{{"\n"}}{{end}}') + exec 9< <(ufw-docker--list-service-ports "$service_name") while read -u 9 -r port target_port; do if [[ "$target_port" = "${service_port}/${service_proto}" ]]; then declare service_env="ufw_public_${service_id}=${service_name}/${port}/${service_proto}" @@ -281,6 +291,7 @@ function ufw-docker--service-delete() { docker service update --update-parallelism=0 \ --env-add ufw_docker_agent_image="${ufw_docker_agent_image}" \ --env-add "${service_env}" \ + --env-add DEBUG="${DEBUG-}" \ --image "${ufw_docker_agent_image}" \ "${ufw_docker_agent}" } @@ -290,13 +301,22 @@ function ufw-docker--raw-command() { } after_rules="/etc/ufw/after.rules" +after6_rules="/etc/ufw/after6.rules" function ufw-docker--check() { err "\\n########## iptables -n -L DOCKER-USER ##########" iptables -n -L DOCKER-USER err "\\n\\n########## diff $after_rules ##########" - ufw-docker--check-install && err "\\nCheck done." + ufw-docker--check-install "$@" && err "\\nCheck IPv4 firewall rules done." + + if command -v ip6tables >/dev/null 2>&1; then + err "\\n########## ip6tables -n -L DOCKER-USER ##########" + ip6tables -n -L DOCKER-USER + + err "\\n\\n########## diff $after6_rules ##########" + ufw-docker--check-install_ipv6 "$@" && err "\\nCheck IPv6 firewall rules done." + fi } declare -a files_to_be_deleted @@ -314,12 +334,45 @@ function on-exit() { trap on-exit EXIT INT TERM QUIT ABRT ERR +function ufw-docker--list-docker-subnets() { + local ipversion="$1" + shift || true + if [[ -z "${1-}" ]]; then + docker network ls --format '{{.ID}}' | + while read -r net; do + docker network inspect "$net" --format '{{range .IPAM.Config}}{{.Subnet}}{{"\n"}}{{end}}' + done + else + printf "%s\n" "$@" + fi | + while read -r cidr; do + if [[ "${ipversion}" = "IPv4" && "$cidr" = *.* ]] || [[ "${ipversion}" = "IPv6" && "$cidr" = *:* ]] + then echo "$cidr" + fi + done | + sort +} + function ufw-docker--check-install() { + declare -a cidr_list + declare cidr + if [[ -z "${1-}" ]]; then + cidr_list=(10.0.0.0/8 172.16.0.0/12 192.168.0.0/16) + elif [[ "${1-}" = '--docker-subnets' ]]; then + shift || true + mapfile -t cidr_list < <(ufw-docker--list-docker-subnets IPv4 "$@") + fi + if [[ -z "${cidr_list:-}" ]]; then + err "ERROR: Could not find any IPv4 subnets used by docker engine\n" + exit 1 + fi + after_rules_tmp="${after_rules_tmp:-$(mktemp)}" rm-on-exit "$after_rules_tmp" sed "/^# BEGIN UFW AND DOCKER/,/^# END UFW AND DOCKER/d" "$after_rules" > "$after_rules_tmp" - >> "${after_rules_tmp}" cat <<-\EOF + { + cat <<-\EOF # BEGIN UFW AND DOCKER *filter :ufw-user-forward - [0:0] @@ -327,18 +380,26 @@ function ufw-docker--check-install() { :DOCKER-USER - [0:0] -A DOCKER-USER -j ufw-user-forward - -A DOCKER-USER -j RETURN -s 10.0.0.0/8 - -A DOCKER-USER -j RETURN -s 172.16.0.0/12 - -A DOCKER-USER -j RETURN -s 192.168.0.0/16 + EOF + + for cidr in "${cidr_list[@]}"; do + echo "-A DOCKER-USER -j RETURN -s ${cidr}" + done + + cat <<-\EOF -A DOCKER-USER -p udp -m udp --sport 53 --dport 1024:65535 -j RETURN - -A DOCKER-USER -j ufw-docker-logging-deny -p tcp -m tcp --tcp-flags FIN,SYN,RST,ACK SYN -d 192.168.0.0/16 - -A DOCKER-USER -j ufw-docker-logging-deny -p tcp -m tcp --tcp-flags FIN,SYN,RST,ACK SYN -d 10.0.0.0/8 - -A DOCKER-USER -j ufw-docker-logging-deny -p tcp -m tcp --tcp-flags FIN,SYN,RST,ACK SYN -d 172.16.0.0/12 - -A DOCKER-USER -j ufw-docker-logging-deny -p udp -m udp --dport 0:32767 -d 192.168.0.0/16 - -A DOCKER-USER -j ufw-docker-logging-deny -p udp -m udp --dport 0:32767 -d 10.0.0.0/8 - -A DOCKER-USER -j ufw-docker-logging-deny -p udp -m udp --dport 0:32767 -d 172.16.0.0/12 + EOF + + for cidr in "${cidr_list[@]}"; do + echo "-A DOCKER-USER -j ufw-docker-logging-deny -p tcp -m tcp --tcp-flags FIN,SYN,RST,ACK SYN -d ${cidr}" + done + for cidr in "${cidr_list[@]}"; do + echo "-A DOCKER-USER -j ufw-docker-logging-deny -p udp -m udp --dport 0:32767 -d ${cidr}" + done + + cat <<-\EOF -A DOCKER-USER -j RETURN @@ -348,17 +409,87 @@ function ufw-docker--check-install() { COMMIT # END UFW AND DOCKER EOF - + } >> "${after_rules_tmp}" diff -u --color=auto "$after_rules" "$after_rules_tmp" } +function ufw-docker--check-install_ipv6() { + declare -a cidr6_list + declare cidr + if [[ -z "${1-}" ]]; then + cidr6_list=(fd00::/8) + elif [[ "${1-}" = '--docker-subnets' ]]; then + shift || true + mapfile -t cidr6_list < <(ufw-docker--list-docker-subnets IPv6 "$@") + fi + if [[ -z "${cidr6_list:-}" ]]; then + err "INFO: Could not find any IPv6 subnets used by docker engine, will disable IPv6 support.\n" + return 0 + fi + + after6_rules_tmp="${after6_rules_tmp:-$(mktemp)}" + rm-on-exit "$after6_rules_tmp" + + sed "/^# BEGIN UFW AND DOCKER/,/^# END UFW AND DOCKER/d" "$after6_rules" > "$after6_rules_tmp" + { + cat <<-\EOF + # BEGIN UFW AND DOCKER + *filter + :ufw6-user-forward - [0:0] + :ufw6-docker-logging-deny - [0:0] + :DOCKER-USER - [0:0] + -A DOCKER-USER -j ufw6-user-forward + + EOF + + for cidr in "${cidr6_list[@]}"; do + echo "-A DOCKER-USER -j RETURN -s ${cidr}" + done + + cat <<-\EOF + -A DOCKER-USER -p udp -m udp --sport 53 --dport 1024:65535 -j RETURN + EOF + + for cidr in "${cidr6_list[@]}"; do + echo "-A DOCKER-USER -j ufw6-docker-logging-deny -p tcp -m tcp --tcp-flags FIN,SYN,RST,ACK SYN -d ${cidr}" + echo "-A DOCKER-USER -j ufw6-docker-logging-deny -p udp -m udp --dport 0:32767 -d ${cidr}" + done + + cat <<-\EOF + + -A DOCKER-USER -j RETURN + + -A ufw6-docker-logging-deny -m limit --limit 3/min --limit-burst 10 -j LOG --log-prefix "[UFW DOCKER BLOCK] " + -A ufw6-docker-logging-deny -j DROP + + COMMIT + # END UFW AND DOCKER + EOF + } >> "${after6_rules_tmp}" + diff -u --color=auto "$after6_rules" "$after6_rules_tmp" +} + function ufw-docker--install() { - if ! ufw-docker--check-install; then + local changed=false + if ! ufw-docker--check-install "$@"; then + changed=true local after_rules_bak after_rules_bak="${after_rules}-ufw-docker~$(date '+%Y-%m-%d-%H%M%S')~" err "\\nBacking up $after_rules to $after_rules_bak" cp "$after_rules" "$after_rules_bak" cat "$after_rules_tmp" > "$after_rules" + fi + + if ! ufw-docker--check-install_ipv6 "$@"; then + changed=true + local after6_rules_bak + after6_rules_bak="${after6_rules}-ufw-docker~$(date '+%Y-%m-%d-%H%M%S')~" + err "\\nBacking up $after6_rules to $after6_rules_bak" + cp "$after6_rules" "$after6_rules_bak" + cat "$after6_rules_tmp" > "$after6_rules" + fi + + if "$changed"; then err "Please restart UFW service manually by using the following command:" if type systemctl &>/dev/null; then err " sudo systemctl restart ufw" @@ -368,6 +499,31 @@ function ufw-docker--install() { fi } +function ufw-docker--install--help() { + cat <&2 Usage: @@ -377,19 +533,27 @@ function ufw-docker--help() { ufw-docker service allow >> ufw-docker service delete allow + ufw-docker [--docker-subnets [SUBNET0 SUBNET1 ...]] + ufw-docker Examples: ufw-docker help + ufw-docker check --help + ufw-docker install --help - ufw-docker check # Check the installation of firewall rules - ufw-docker install # Install firewall rules + ufw-docker check # Check the installation of firewall rules + ufw-docker check --docker-subnets # Auto-detect and use all Docker network subnets + ufw-docker check --docker-subnets 192.168.207.0/24 10.207.0.0/16 fd00:cf::/64 + + ufw-docker install # Install firewall rules + ufw-docker install --docker-subnets # Auto-detect and use all Docker network subnets + ufw-docker install --docker-subnets 192.168.207.0/24 10.207.0.0/16 fd00:cf::/64 ufw-docker status ufw-docker list httpd - ufw-docker allow httpd ufw-docker allow httpd 80 ufw-docker allow httpd 80/tcp @@ -424,6 +588,10 @@ if ! ufw status 2>/dev/null | grep -Fq "Status: active" ; then die "UFW is disabled or you are not root user, or mismatched iptables legacy/nf_tables, current $(iptables --version)" fi +if ! docker -v &> /dev/null; then + die "Docker executable not found." +fi + ufw_action="${1:-help}" case "$ufw_action" in @@ -454,14 +622,26 @@ case "$ufw_action" in NETWORK="${1:-}" INSTANCE_PORT="${INSTANCE_PORT%/*}" - + ;;& + delete|list) + "ufw-docker--$ufw_action" "$INSTANCE_NAME\\(/v6\\)\\?" "$INSTANCE_PORT" "$PROTO" "$NETWORK" + ;; + allow) "ufw-docker--$ufw_action" "$INSTANCE_NAME" "$INSTANCE_PORT" "$PROTO" "$NETWORK" ;; service|raw-command|add-service-rule) shift || true "ufw-docker--$ufw_action" "$@" ;; - status|install|check) + install|check) + shift || true + if [[ "${1-}" = @(help|-h|--help) ]]; then + ufw-docker--install--help "$ufw_action" + exit + fi + "ufw-docker--$ufw_action" "$@" + ;; + status) ufw-docker--"$ufw_action" ;; *)