upgrade tor package from v0.4.8.18-r2 to v0.4.8.19-r0

https://web.archive.org/web/20251011051716/https://gitlab.torproject.org/tpo/core/tor/-/raw/release-0.4.8/ReleaseNotes

.github/dependabot.yml

@@ -1,3 +1,5 @@
+# sync with https://github.com/fphammerle/docker-onion-service/blob/master/.github/dependabot.yml
+
 version: 2
 
 updates:
@@ -6,5 +8,11 @@ updates:
   schedule:
     interval: weekly
     day: friday
+- package-ecosystem: github-actions
+  directory: /
+  # > YAML aliases are not supported
+  schedule:
+    interval: weekly
+    day: friday
 
 # https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates

.github/workflows/container-image.yml

@@ -0,0 +1,56 @@
+---
+name: container image
+
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: '0 20 * * 5'
+
+jobs:
+  docker-build:
+    runs-on: ubuntu-24.04
+    permissions: {packages: write}
+    steps:
+    - id: meta
+      # > "automatic" tag management and OCI Image Format Spec… for labels
+      # https://web.archive.org/web/20250103123053/https://docs.docker.com/build/ci/github-actions/manage-tags-labels/
+      uses: docker/metadata-action@v5
+      with:
+        # see comment on `push: true` below
+        images: ghcr.io/${{ github.repository_owner }}/tor-proxy
+        # https://web.archive.org/web/20250103130404/https://github.com/docker/metadata-action?tab=readme-ov-file#tags-input
+        tags: |
+          type=ref,event=branch
+          type=ref,event=pr
+          type=sha,format=long
+          type=raw,value=latest,enable=false
+    - uses: docker/setup-qemu-action@v3.6.0
+    - uses: docker/login-action@v3
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    - uses: docker/setup-buildx-action@v3.11.1
+    # > By default, this action uses the Git context so you don't need to use
+    # > the actions/checkout action to checkout the repository because this
+    # > will be done directly by buildkit. [...]
+    # > any file mutation in the steps that precede [...] will be ignored,
+    # > including processing of the .dockerignore file
+    # https://github.com/marketplace/actions/build-and-push-docker-images
+    # > The commit history is not preserved.
+    # https://docs.docker.com/engine/reference/commandline/build/#git-repositories
+    - uses: docker/build-push-action@v6.18.0
+      with:
+        platforms: |
+          linux/amd64
+          linux/arm/v6
+          linux/arm/v7
+          linux/arm64
+        # > Require approval for all external contributors
+        # > All users that are not a member or owner of this repository will
+        # > require approval to run workflows.
+        # https://github.com/fphammerle/docker-tor-proxy/settings/actions
+        push: true
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}

CHANGELOG.md

@@ -5,6 +5,39 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- support for enabling `SafeSocks` option by assigning `1` to environment
+  variable `SAFE_SOCKS` (instructs tor to block socks connections when provided
+  with remote ip address instead of domain name to detect dns leaks due to
+  applications resolving domain names without tor)
+
+## [4.5.1] - 2022-02-27
+### Fixed
+- "sed: write error" for large values of `EXIT_NODES` and `EXCLUDE_EXIT_NODES`
+
+## [4.5.0] - 2021-09-06
+### Added
+- added ability to select exit nodes explicitly via `EXIT_NODES` environment variable
+
+## [4.4.0] - 2021-07-07
+### Added
+- added ability to exclude exit nodes via `EXCLUDE_EXIT_NODES` environment variable
+
+## [4.3.1] - 2021-05-15
+### Fixed
+- create prerouting chain if not already created by container runtime
+  (fixes dns proxy with direct routing & transparent proxy on some hosts)
+
+## [4.3.0] - 2021-05-07
+### Added
+- when running entrypoint as `uid=0`:
+  add `nftables` rule forwarding udp dns requests (port 53) to tor
+  (alternative for less flexible `docker run --publish 53:9053 …`)
+
+## [4.2.0] - 2021-04-30
+### Added
+- when running entrypoint as `uid=0`:
+  add `nftables` rule redirecting `tcp` traffic to transparent proxy
 
 ## [4.1.0] - 2021-03-03
 ### Added
@@ -63,7 +96,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - tor socks5 & DNS proxy
 
-[Unreleased]: https://github.com/fphammerle/docker-tor-proxy/compare/v4.1.0...HEAD
+[Unreleased]: https://github.com/fphammerle/docker-tor-proxy/compare/v4.5.1...HEAD
+[4.5.1]: https://github.com/fphammerle/docker-tor-proxy/compare/v4.5.0...v4.5.1
+[4.5.0]: https://github.com/fphammerle/docker-tor-proxy/compare/v4.4.0...v4.5.0
+[4.4.0]: https://github.com/fphammerle/docker-tor-proxy/compare/v4.3.1...v4.4.0
+[4.3.1]: https://github.com/fphammerle/docker-tor-proxy/compare/v4.3.0...v4.3.1
+[4.3.0]: https://github.com/fphammerle/docker-tor-proxy/compare/v4.2.0...v4.3.0
+[4.2.0]: https://github.com/fphammerle/docker-tor-proxy/compare/v4.1.0...v4.2.0
 [4.1.0]: https://github.com/fphammerle/docker-tor-proxy/compare/v4.0.0...v4.1.0
 [4.0.0]: https://github.com/fphammerle/docker-tor-proxy/compare/v3.0.0...v4.0.0
 [3.0.0]: https://github.com/fphammerle/docker-tor-proxy/compare/v2.1.0...v3.0.0

Dockerfile

@@ -1,12 +1,22 @@
-FROM docker.io/alpine:3.13.4
+FROM docker.io/alpine:3.22.1
 
-ARG TOR_PACKAGE_VERSION=0.4.4.8-r0
-RUN apk add --no-cache tor=$TOR_PACKAGE_VERSION
+# https://gitweb.torproject.org/tor.git/plain/ChangeLog
+# https://gitlab.torproject.org/tpo/core/tor/-/raw/release-0.4.8/ReleaseNotes
+# https://git.alpinelinux.org/aports/log/community/tor?h=3.22-stable
+ARG TOR_PACKAGE_VERSION=0.4.8.19-r0
+# nftables + dependencies add 2.3MB to image
+# https://www.netfilter.org/projects/nftables/downloads.html
+# https://git.alpinelinux.org/aports/log/main/nftables?h=3.22-stable
+ARG NFTABLES_PACKAGE_VERSION=1.1.3-r0
+RUN apk add --no-cache \
+        nftables=$NFTABLES_PACKAGE_VERSION \
+        tor=$TOR_PACKAGE_VERSION
 VOLUME /var/lib/tor
 
 #RUN apk add --no-cache \
 #        less \
 #        man-db \
+#        strace \
 #        tor-doc=$TOR_PACKAGE_VERSION
 #ENV PAGER=less
 
@@ -14,10 +24,14 @@ EXPOSE 9050/tcp
 EXPOSE 9053/udp
 COPY torrc.template entrypoint.sh /
 RUN chmod -c a+rX /torrc.template /entrypoint.sh
-ENV SOCKS_TIMEOUT_SECONDS=
+ENV SOCKS_TIMEOUT_SECONDS= \
+    SAFE_SOCKS=0 \
+    EXIT_NODES= \
+    EXCLUDE_EXIT_NODES=
 ENTRYPOINT ["/entrypoint.sh"]
 
-USER tor
+# entrypoint.sh drops privileges after configuring nftables for transparent proxy
+#USER tor
 CMD ["tor", "-f", "/tmp/torrc"]
 
 # keeping dns requests as network-liveness is too optimistic

Makefile

@@ -1,32 +0,0 @@
-IMAGE_NAME := docker.io/fphammerle/tor-proxy
-PROJECT_VERSION = $(shell git describe --match=v* --abbrev=0 --dirty | sed -e 's/^v//')
-TOR_PACKAGE_VERSION = $(shell grep -Po 'TOR_PACKAGE_VERSION=\K.+' Dockerfile | tr -d -)
-ARCH = $(shell arch)
-# architecture[arm_variant]
-# https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md#image-index-property-descriptions
-IMAGE_TAG_ARCH_aarch64 = arm64
-IMAGE_TAG_ARCH_armv6l = armv6
-IMAGE_TAG_ARCH_armv7l = armv7
-IMAGE_TAG_ARCH_x86_64 = amd64
-IMAGE_TAG_ARCH = ${IMAGE_TAG_ARCH_${ARCH}}
-IMAGE_TAG = ${PROJECT_VERSION}-tor${TOR_PACKAGE_VERSION}-${IMAGE_TAG_ARCH}
-BUILD_PARAMS = --tag="${IMAGE_NAME}:${IMAGE_TAG}" \
-	--build-arg=REVISION="$(shell git rev-parse HEAD)"
-
-.PHONY: worktree-clean docker-build podman-build docker-push
-
-worktree-clean:
-	git diff --exit-code
-	git diff --staged --exit-code
-
-docker-build: worktree-clean
-	sudo docker build ${BUILD_PARAMS} .
-
-podman-build: worktree-clean
-	# --format=oci (default) not fully supported by hub.docker.com
-	# https://github.com/docker/hub-feedback/issues/1871#issuecomment-748924149
-	podman build --format=docker ${BUILD_PARAMS} .
-
-docker-push: docker-build
-	sudo docker push "${IMAGE_NAME}:${IMAGE_TAG}"
-	@echo git tag --sign --message '$(shell sudo docker image inspect --format '{{join .RepoDigests "\n"}}' "${IMAGE_NAME}:${IMAGE_TAG}")' docker/${IMAGE_TAG} $(shell git rev-parse HEAD)

README.md

@@ -48,6 +48,18 @@ sudo iptables -A OUTPUT ! -o lo -j REJECT --reject-with icmp-admin-prohibited
 $ sudo docker run -e SOCKS_TIMEOUT_SECONDS=60 …
 ```
 
+### Select Exit Nodes
+
+```sh
+$ sudo docker run -e EXIT_NODES=1.2.3.4,1.2.3.5,{at} …
+```
+
+### Exclude Exit Nodes
+
+```sh
+$ sudo docker run -e EXCLUDE_EXIT_NODES=1.2.3.4,1.2.3.5 …
+```
+
 ### Show Circuits
 
 ```sh

docker-compose.yml

@@ -8,7 +8,10 @@ services:
     build: .
     image: fphammerle/tor-proxy
     environment:
+      #SAFE_SOCKS: 1
       SOCKS_TIMEOUT_SECONDS: 30
+      #EXIT_NODES: '1.2.3.4,1.2.3.5,{at}'
+      #EXCLUDE_EXIT_NODES: '{xx},{yy},1.2.3.4,128.0.0.0/1'
     volumes:
     - type: volume
       source: data
@@ -19,13 +22,14 @@ services:
       tmpfs:
         # nosuid,nodev,noexec added by default
         mode: '1777'
-        size: 4k
+        size: 5k
     read_only: yes
     ports:
     - '127.0.0.1:9050:9050/tcp'
     - '127.0.0.1:53:9053/udp'
     cap_drop: [ALL]
-    #cap_add: [SYS_PTRACE]
+    # entrypoint.sh drops privileges after configuring nftables for transparent proxy
+    cap_add: [NET_ADMIN, SETUID, SETGID]
     security_opt: [no-new-privileges]
     cpus: 0.5
     mem_limit: 128m

entrypoint.sh

@@ -2,12 +2,33 @@
 
 set -e
 
+if [ "$(id -u)" -eq 0 ]; then
+    nft add chain ip nat PREROUTING { type nat hook prerouting priority dstnat \; } || true
+    nft add rule ip nat PREROUTING ip protocol tcp fib daddr type != local counter redirect to :9040 \
+        || echo 'warning: failed to configure nftables for transparent proxy (missing CAP_NET_ADMIN?)'
+    nft add rule ip nat PREROUTING fib daddr type local udp dport 53 counter redirect to :9053 \
+        || echo 'warning: failed to configure nftables for DNS proxy' \
+                '(alternative for less flexible `docker run --publish 53:9053 ...`)'
+    exec su -s /bin/sh tor -- "$0" "$@"
+fi
+
+sed -e "s/{safe_socks}/$SAFE_SOCKS/" /torrc.template > /tmp/torrc
 # default: 120 sec
 # https://github.com/torproject/tor/blob/tor-0.4.1.7/src/core/or/connection_edge.c#L1099
 if [ -z "$SOCKS_TIMEOUT_SECONDS" ]; then
-    sed -e '/{socks_timeout_seconds}/d' /torrc.template > /tmp/torrc
+    sed -ie '/{socks_timeout_seconds}/d' /tmp/torrc
 else
-    sed -e "s/{socks_timeout_seconds}/$SOCKS_TIMEOUT_SECONDS/" /torrc.template > /tmp/torrc
+    sed -ie "s/{socks_timeout_seconds}/$SOCKS_TIMEOUT_SECONDS/" /tmp/torrc
+fi
+
+# > list of identity fingerprints, country codes, and address patterns
+if [ ! -z "$EXIT_NODES" ]; then
+    echo -n 'ExitNodes ' >> /tmp/torrc
+    printenv EXIT_NODES >> /tmp/torrc
+fi
+if [ ! -z "$EXCLUDE_EXIT_NODES" ]; then
+    echo -n 'ExcludeExitNodes ' >> /tmp/torrc
+    printenv EXCLUDE_EXIT_NODES >> /tmp/torrc
 fi
 
 exec "$@"

nftables-changelog.url

@@ -0,0 +1 @@
+https://www.netfilter.org/projects/nftables/downloads.html

nftables-package-log.url

@@ -0,0 +1 @@
+https://git.alpinelinux.org/aports/log/main/nftables?h=3.18-stable

tor-changelog.url

@@ -1 +0,0 @@
-https://gitweb.torproject.org/tor.git/plain/ChangeLog

torrc.template

@@ -13,7 +13,27 @@ ControlPort localhost:9051
 
 DNSPort 0.0.0.0:9053
 
-SocksPort 0.0.0.0:9050
+# IsolateClientAddr & IsolateSOCKSAuth enabled by default
+# https://web.archive.org/web/20230113155700/https://gitweb.torproject.org/tor.git/tree/doc/man/tor.1.txt?h=tor-0.4.7.13&id=7c1601fb6edd780ffef386936217ede9531c26e6#n1483
+SocksPort 0.0.0.0:9050 IsolateClientAddr IsolateSOCKSAuth
+# > reject application connections [...] that only provide an IP address [...]
+# > not doing remote DNS
+# with `SafeSocks 1`:
+# $ for p in socks4 socks4a socks5 socks5h; do \
+#   echo -n "$p: ";
+#   curl -o /dev/null --no-progress-meter -x $p://127.0.0.1:9050 https://ipinfo.tw
+#     && echo success;
+#   done
+# > socks4: curl: (97) Can't complete SOCKS4 connection to 0.0.0.0:0. (91), request rejected or failed.
+# > socks4a: success
+# > socks5: curl: (97) Can't complete SOCKS5 connection to ipinfo.tw. (2)
+# > socks5h: success
+# log:
+# > [warn] {APP} Your application (using socks4 to port 443) is giving Tor only
+# . an IP address. Applications that do DNS resolves themselves may leak
+# . information. Consider using Socks4A [...]
+# > [warn] {APP} Your application (using socks5 to port 443) is giving Tor [...]
+SafeSocks {safe_socks}
 SocksTimeout {socks_timeout_seconds}
 
 # requires netfilter rules