-
Notifications
You must be signed in to change notification settings - Fork 47
Add native SOCKS4/SOCKS5 support for Squid cache_peer #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
39ff
wants to merge
28
commits into
master
Choose a base branch
from
claude/squid-socks-proxy-support-CqoL5
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
28 commits
Select commit
Hold shift + click to select a range
08f9dfb
Add native SOCKS4/SOCKS5 cache_peer support via Squid patch
claude e4f9f46
Add GitHub Actions workflow for Squid SOCKS patch build and test
claude 679a116
Fix patch_apply.sh python3 heredoc and Dockerfile ARG scoping
claude e2e141e
Address CodeRabbit review: validation, security, and error handling
claude 7ee9761
Fix patch_apply.sh to use correct Squid 6.10 API
claude a961c78
Fix compilation errors verified with local Squid 6.10 build
claude 5bfc1de
Address review: destructor cleanup, originserver validation, ATYP enc…
claude 1cffe57
Address CodeRabbit review: error handling and output fixes
claude 0b05a8a
Fix Docker buildx failure: remove /var/run from install tree
claude 59c2625
Fix CI: use serjs/go-socks5-proxy, remove connectToPeer fallback
claude 89bee4e
Improve E2E tests: local HTTP server, better debugging
claude a39d6c2
CI: add artifact uploads and improve test diagnostics
claude 9c10bd8
CI: replace Docker SOCKS5 images with microsocks built from source
claude a9070db
CI: add Squid startup diagnostic step with -X -d5 debug output
claude 9878ab6
Fix CI: remove diagnostic step (port conflict), show entrypoint errors
claude 8862c83
CI: bypass entrypoint, run Squid directly to isolate crash cause
claude a7b8e18
CI: post Squid container logs as PR comment on failure
claude 8654b32
Fix Squid FATAL crash: use file-based logs, fix ACL syntax
claude 9ec8bd1
Fix PID file permission denied: use squid-writable directory
claude 3e325c7
Address CodeRabbit and Copilot review comments
claude 80cfad5
Add manual GitHub Release and Container Release workflows
claude 02e7f47
Address Copilot review: socket error handling, SOCKS5 method validati…
claude d770435
Security: enforce SOCKS5 auth, validate proxyList.txt entries
claude 56afd4c
Address CodeRabbit: sanitize STDERR logs, drop IPv6 host chars
claude be2343b
Merge pull request #31 from 39ff/claude/security-review-33NY5
39ff 10b34f0
Address review: gate socks auth to socks5, disable pconn for SOCKS peers
claude 882531d
Address review: validate SOCKS5 credentials with !== '' and reject pa…
claude 2c1f95d
Merge pull request #32 from 39ff/claude/address-review-comments-uEXNB
39ff File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,393 @@ | ||
| name: Squid SOCKS Patch Build & Test | ||
|
|
||
| on: | ||
| push: | ||
| paths: | ||
| - 'squid_patch/**' | ||
| - 'setup/**' | ||
| - 'template/**' | ||
| - '.github/workflows/squid-build-test.yml' | ||
| pull_request: | ||
| paths: | ||
| - 'squid_patch/**' | ||
| - 'setup/**' | ||
| - 'template/**' | ||
| - '.github/workflows/squid-build-test.yml' | ||
| workflow_dispatch: | ||
|
|
||
| env: | ||
| SQUID_IMAGE: squid-socks:6.10 | ||
|
|
||
| jobs: | ||
| # ------------------------------------------------------------------ | ||
| # 1. Build the custom Squid image with SOCKS patch | ||
| # ------------------------------------------------------------------ | ||
| build: | ||
| name: Build Squid 6.10 + SOCKS Patch | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 30 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Docker Buildx | ||
| uses: docker/setup-buildx-action@v3 | ||
|
|
||
| - name: Build Squid image | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| context: ./squid_patch | ||
| file: ./squid_patch/Dockerfile | ||
| tags: ${{ env.SQUID_IMAGE }} | ||
| load: true | ||
| cache-from: type=gha | ||
| cache-to: type=gha,mode=max | ||
|
|
||
| - name: Verify Squid binary | ||
| run: | | ||
| docker run --rm ${{ env.SQUID_IMAGE }} squid -v | ||
| echo "--- Squid binary OK ---" | ||
|
|
||
| - name: Save image for test jobs | ||
| run: docker save ${{ env.SQUID_IMAGE }} -o /tmp/squid-image.tar | ||
|
|
||
| - name: Upload image artifact | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: squid-image | ||
| path: /tmp/squid-image.tar | ||
| retention-days: 1 | ||
|
|
||
| # ------------------------------------------------------------------ | ||
| # 2. Test: Squid config parsing (socks4/socks5 options) | ||
| # ------------------------------------------------------------------ | ||
| test-config: | ||
| name: Test Squid Config Parsing | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 5 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Download image artifact | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: squid-image | ||
| path: /tmp | ||
|
|
||
| - name: Load image | ||
| run: docker load -i /tmp/squid-image.tar | ||
|
|
||
| - name: Test SOCKS5 cache_peer config parsing | ||
| run: | | ||
| cat > /tmp/squid-socks5.conf <<'CONF' | ||
| http_port 3128 | ||
| acl all src 0.0.0.0/0 | ||
| http_access allow all | ||
| never_direct allow all | ||
| cache_peer 127.0.0.1 parent 1080 0 no-query no-digest round-robin proxy-only originserver name=test_socks5 socks5 socks-user=testuser socks-pass=testpass | ||
| CONF | ||
|
|
||
| docker run --rm \ | ||
| -v /tmp/squid-socks5.conf:/etc/squid/conf.d/squid.conf:ro \ | ||
| ${{ env.SQUID_IMAGE }} \ | ||
| squid -k parse -f /etc/squid/conf.d/squid.conf 2>&1 | tee /tmp/parse-output.txt | ||
|
|
||
| echo "--- SOCKS5 config parse OK ---" | ||
|
|
||
| - name: Test SOCKS4 cache_peer config parsing | ||
| run: | | ||
| cat > /tmp/squid-socks4.conf <<'CONF' | ||
| http_port 3128 | ||
| acl all src 0.0.0.0/0 | ||
| http_access allow all | ||
| never_direct allow all | ||
| cache_peer 127.0.0.1 parent 1080 0 no-query no-digest round-robin proxy-only originserver name=test_socks4 socks4 | ||
| CONF | ||
|
|
||
| docker run --rm \ | ||
| -v /tmp/squid-socks4.conf:/etc/squid/conf.d/squid.conf:ro \ | ||
| ${{ env.SQUID_IMAGE }} \ | ||
| squid -k parse -f /etc/squid/conf.d/squid.conf 2>&1 | tee /tmp/parse-output.txt | ||
|
|
||
| echo "--- SOCKS4 config parse OK ---" | ||
|
|
||
| - name: Test multiple SOCKS peers config | ||
| run: | | ||
| cat > /tmp/squid-multi.conf <<'CONF' | ||
| http_port 3128 | ||
| acl all src 0.0.0.0/0 | ||
| http_access allow all | ||
| never_direct allow all | ||
| cache_peer 10.0.0.1 parent 1080 0 no-query no-digest round-robin proxy-only originserver name=socks1 socks5 socks-user=user1 socks-pass=pass1 | ||
| cache_peer 10.0.0.2 parent 1080 0 no-query no-digest round-robin proxy-only originserver name=socks2 socks5 socks-user=user2 socks-pass=pass2 | ||
| cache_peer 10.0.0.3 parent 1081 0 no-query no-digest round-robin proxy-only originserver name=socks3 socks4 | ||
| CONF | ||
|
|
||
| docker run --rm \ | ||
| -v /tmp/squid-multi.conf:/etc/squid/conf.d/squid.conf:ro \ | ||
| ${{ env.SQUID_IMAGE }} \ | ||
| squid -k parse -f /etc/squid/conf.d/squid.conf 2>&1 | ||
|
|
||
| echo "--- Multiple SOCKS peers config OK ---" | ||
|
|
||
| # ------------------------------------------------------------------ | ||
| # 3. Test: SOCKS5 proxy end-to-end via Squid | ||
| # ------------------------------------------------------------------ | ||
| test-socks5-e2e: | ||
| name: Test SOCKS5 End-to-End | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Download image artifact | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: squid-image | ||
| path: /tmp | ||
|
|
||
| - name: Load image | ||
| run: docker load -i /tmp/squid-image.tar | ||
|
|
||
| - name: Start SOCKS5 test server (microsocks) | ||
| run: | | ||
| docker run -d --name socks5-server --network host \ | ||
| ghcr.io/rofl0r/microsocks:latest -p 11080 | ||
| sleep 2 | ||
| docker logs socks5-server | ||
|
|
||
| - name: Create Squid config for SOCKS5 peer | ||
| run: | | ||
| mkdir -p /tmp/squid-conf | ||
| cat > /tmp/squid-conf/squid.conf <<'CONF' | ||
| http_port 3128 | ||
| acl all src 0.0.0.0/0 | ||
| http_access allow all | ||
| never_direct allow all | ||
| server_persistent_connections off | ||
| client_persistent_connections off | ||
| cache_peer 127.0.0.1 parent 11080 0 no-query no-digest connect-fail-limit=2 connect-timeout=8 round-robin proxy-only originserver name=socks_test socks5 | ||
| visible_hostname test | ||
| access_log stdio:/proc/self/fd/1 combined | ||
| CONF | ||
|
|
||
| cat > /tmp/squid-conf/allowed_ip.txt <<'ALLOW' | ||
| 0.0.0.0/0 | ||
| ALLOW | ||
|
|
||
| - name: Start Squid with SOCKS5 peer | ||
| run: | | ||
| docker run -d --name squid-test --network host \ | ||
| -v /tmp/squid-conf:/etc/squid/conf.d:ro \ | ||
| -e SQUID_CONFIG_FILE=/etc/squid/conf.d/squid.conf \ | ||
| ${{ env.SQUID_IMAGE }} | ||
| echo "Waiting for Squid to start..." | ||
| READY=0 | ||
| for i in $(seq 1 30); do | ||
| if curl -sf -x http://127.0.0.1:3128 -o /dev/null http://httpbin.org/ip 2>/dev/null; then | ||
| echo "Squid is ready after ${i}s" | ||
| READY=1 | ||
| break | ||
| fi | ||
| sleep 1 | ||
| done | ||
| if [ "$READY" -eq 0 ]; then | ||
| echo "ERROR: Squid failed to start within 30 seconds" | ||
| docker logs squid-test 2>&1 || true | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Test HTTP request through SOCKS5 peer | ||
| run: | | ||
| RESPONSE=$(curl -sf -x http://127.0.0.1:3128 http://httpbin.org/ip) | ||
| echo "Response: ${RESPONSE}" | ||
| echo "${RESPONSE}" | grep -q "origin" || { echo "FAIL: unexpected response"; exit 1; } | ||
| echo "--- HTTP via SOCKS5 OK ---" | ||
|
|
||
| - name: Test HTTPS request through SOCKS5 peer | ||
| run: | | ||
| RESPONSE=$(curl -sf -x http://127.0.0.1:3128 https://httpbin.org/ip) | ||
| echo "Response: ${RESPONSE}" | ||
| echo "${RESPONSE}" | grep -q "origin" || { echo "FAIL: unexpected response"; exit 1; } | ||
| echo "--- HTTPS via SOCKS5 OK ---" | ||
|
|
||
| - name: Show Squid logs on failure | ||
| if: failure() | ||
| run: | | ||
| echo "=== Squid logs ===" | ||
| docker logs squid-test 2>&1 || true | ||
| echo "=== SOCKS5 server logs ===" | ||
| docker logs socks5-server 2>&1 || true | ||
|
|
||
| - name: Cleanup | ||
| if: always() | ||
| run: | | ||
| docker rm -f squid-test socks5-server 2>/dev/null || true | ||
|
|
||
| # ------------------------------------------------------------------ | ||
| # 4. Test: SOCKS5 with authentication | ||
| # ------------------------------------------------------------------ | ||
| test-socks5-auth: | ||
| name: Test SOCKS5 with Auth | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Download image artifact | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: squid-image | ||
| path: /tmp | ||
|
|
||
| - name: Load image | ||
| run: docker load -i /tmp/squid-image.tar | ||
|
|
||
| - name: Start SOCKS5 server with auth (microsocks) | ||
| run: | | ||
| docker run -d --name socks5-auth --network host \ | ||
| ghcr.io/rofl0r/microsocks:latest -u testuser -P testpass -p 11081 | ||
| sleep 2 | ||
|
|
||
| - name: Create Squid config with SOCKS5 auth | ||
| run: | | ||
| mkdir -p /tmp/squid-conf-auth | ||
| cat > /tmp/squid-conf-auth/squid.conf <<'CONF' | ||
| http_port 3128 | ||
| acl all src 0.0.0.0/0 | ||
| http_access allow all | ||
| never_direct allow all | ||
| server_persistent_connections off | ||
| client_persistent_connections off | ||
| cache_peer 127.0.0.1 parent 11081 0 no-query no-digest connect-fail-limit=2 connect-timeout=8 round-robin proxy-only originserver name=socks_auth socks5 socks-user=testuser socks-pass=testpass | ||
| visible_hostname test | ||
| access_log stdio:/proc/self/fd/1 combined | ||
| CONF | ||
|
|
||
| cat > /tmp/squid-conf-auth/allowed_ip.txt <<'ALLOW' | ||
| 0.0.0.0/0 | ||
| ALLOW | ||
|
|
||
| - name: Start Squid with SOCKS5 auth peer | ||
| run: | | ||
| docker run -d --name squid-auth --network host \ | ||
| -v /tmp/squid-conf-auth:/etc/squid/conf.d:ro \ | ||
| -e SQUID_CONFIG_FILE=/etc/squid/conf.d/squid.conf \ | ||
| ${{ env.SQUID_IMAGE }} | ||
| READY=0 | ||
| for i in $(seq 1 30); do | ||
| if curl -sf -x http://127.0.0.1:3128 -o /dev/null http://httpbin.org/ip 2>/dev/null; then | ||
| echo "Squid ready after ${i}s" | ||
| READY=1 | ||
| break | ||
| fi | ||
| sleep 1 | ||
| done | ||
| if [ "$READY" -eq 0 ]; then | ||
| echo "ERROR: Squid failed to start within 30 seconds" | ||
| docker logs squid-auth 2>&1 || true | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Test HTTP through authenticated SOCKS5 | ||
| run: | | ||
| RESPONSE=$(curl -sf -x http://127.0.0.1:3128 http://httpbin.org/ip) | ||
| echo "Response: ${RESPONSE}" | ||
| echo "${RESPONSE}" | grep -q "origin" || { echo "FAIL"; exit 1; } | ||
| echo "--- HTTP via SOCKS5 auth OK ---" | ||
|
|
||
| - name: Test HTTPS through authenticated SOCKS5 | ||
| run: | | ||
| RESPONSE=$(curl -sf -x http://127.0.0.1:3128 https://httpbin.org/ip) | ||
| echo "Response: ${RESPONSE}" | ||
| echo "${RESPONSE}" | grep -q "origin" || { echo "FAIL"; exit 1; } | ||
| echo "--- HTTPS via SOCKS5 auth OK ---" | ||
|
|
||
| - name: Show logs on failure | ||
| if: failure() | ||
| run: | | ||
| echo "=== Squid logs ===" | ||
| docker logs squid-auth 2>&1 || true | ||
| echo "=== SOCKS5 auth server logs ===" | ||
| docker logs socks5-auth 2>&1 || true | ||
|
|
||
| - name: Cleanup | ||
| if: always() | ||
| run: | | ||
| docker rm -f squid-auth socks5-auth 2>/dev/null || true | ||
|
|
||
| # ------------------------------------------------------------------ | ||
| # 5. Test: generate.php produces correct config | ||
| # ------------------------------------------------------------------ | ||
| test-generate: | ||
| name: Test Config Generator | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 5 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Install PHP dependencies | ||
| run: | | ||
| docker run --rm -v "$(pwd)/setup:/app" -w /app composer:2 install --no-interaction --quiet | ||
|
|
||
| - name: Run generate.php with SOCKS proxy list | ||
| run: | | ||
| cat > proxyList.txt <<'LIST' | ||
| 10.0.0.1:1080:socks5:user1:pass1 | ||
| 10.0.0.2:1080:socks5:user2:pass2 | ||
| 10.0.0.3:1081:socks4:: | ||
| 192.168.1.1:8080 | ||
| 10.0.0.4:3128:httpsquid:admin:secret | ||
| 10.0.0.5:8080:http:user:pass | ||
| LIST | ||
|
|
||
| docker run --rm -v "$(pwd):/app" php:8.2-cli php /app/setup/generate.php | ||
|
|
||
| - name: Verify generated squid.conf has SOCKS peers | ||
| run: | | ||
| echo "=== Generated squid.conf ===" | ||
| cat config/squid.conf | ||
| echo "" | ||
|
|
||
| # Check socks5 peers use native SOCKS options | ||
| grep -q 'socks5' config/squid.conf || { echo "FAIL: socks5 option not found"; exit 1; } | ||
| grep -q 'socks-user=user1' config/squid.conf || { echo "FAIL: socks-user not found"; exit 1; } | ||
| grep -q 'socks-pass=pass1' config/squid.conf || { echo "FAIL: socks-pass not found"; exit 1; } | ||
| grep -q 'originserver' config/squid.conf || { echo "FAIL: originserver not found"; exit 1; } | ||
|
|
||
| # Check socks4 peer | ||
| grep -q 'socks4' config/squid.conf || { echo "FAIL: socks4 option not found"; exit 1; } | ||
|
|
||
| # Check open proxy (no socks, no gost) | ||
| grep -q 'name=public' config/squid.conf || { echo "FAIL: open proxy not found"; exit 1; } | ||
|
|
||
| # Check httpsquid peer | ||
| grep -q 'name=private' config/squid.conf || { echo "FAIL: httpsquid peer not found"; exit 1; } | ||
|
|
||
| echo "--- squid.conf generation OK ---" | ||
|
|
||
| - name: Verify generated docker-compose.yml | ||
| run: | | ||
| echo "=== Generated docker-compose.yml ===" | ||
| cat docker-compose.yml | ||
| echo "" | ||
|
|
||
| # Gost container should only exist for http type (not for socks4/socks5) | ||
| # We have 1 http proxy -> 1 gost container | ||
| GOST_COUNT=$(grep -c 'ginuerzh/gost' docker-compose.yml || true) | ||
| echo "Gost containers: ${GOST_COUNT}" | ||
| [ "${GOST_COUNT}" -eq 1 ] || { echo "FAIL: expected 1 gost container, got ${GOST_COUNT}"; exit 1; } | ||
|
|
||
| echo "--- docker-compose.yml generation OK ---" | ||
|
|
||
| - name: Verify no Gost for SOCKS proxies | ||
| run: | | ||
| # socks5/socks4 should NOT create gost containers | ||
| # Only 'http' type should use gost | ||
| if grep -q 'dockergost_1\|dockergost_2\|dockergost_3' docker-compose.yml; then | ||
| echo "FAIL: SOCKS proxies should not create Gost containers" | ||
| exit 1 | ||
| fi | ||
| echo "--- No Gost for SOCKS proxies OK ---" | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.