mirror of
https://github.com/netbirdio/netbird.git
synced 2026-04-18 16:26:38 +00:00
Compare commits
185 Commits
feature/fl
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8ae8f2098f | ||
|
|
a39787d679 | ||
|
|
53b04e512a | ||
|
|
633dde8d1f | ||
|
|
7e4542adde | ||
|
|
d4c61ed38b | ||
|
|
6b540d145c | ||
|
|
08f624507d | ||
|
|
95bc01e48f | ||
|
|
0d86de47df | ||
|
|
e804a705b7 | ||
|
|
46fc8c9f65 | ||
|
|
d7ad908962 | ||
|
|
c5623307cc | ||
|
|
7f666b8022 | ||
|
|
0a30b9b275 | ||
|
|
4eed459f27 | ||
|
|
13539543af | ||
|
|
7483fec048 | ||
|
|
5259e5df51 | ||
|
|
ebd78e0122 | ||
|
|
cf86b9a528 | ||
|
|
ee588e1536 | ||
|
|
2a8aacc5c9 | ||
|
|
15709bc666 | ||
|
|
789b4113fe | ||
|
|
d2cdc0efec | ||
|
|
ee343d5d77 | ||
|
|
099c493b18 | ||
|
|
c1d1229ae0 | ||
|
|
94a36cb53e | ||
|
|
c7ba931466 | ||
|
|
413d95b740 | ||
|
|
332c624c55 | ||
|
|
dc160aff36 | ||
|
|
96806bf55f | ||
|
|
d33cd4c95b | ||
|
|
e2c2f64be7 | ||
|
|
cb73b94ffb | ||
|
|
1d920d700c | ||
|
|
bb85eee40a | ||
|
|
aba5d6f0d2 | ||
|
|
0588d2dbe1 | ||
|
|
14b3b77bda | ||
|
|
6da34e483c | ||
|
|
0efef671d7 | ||
|
|
435203b13b | ||
|
|
decb5dd3af | ||
|
|
28fbf96b2a | ||
|
|
9d1a37c644 | ||
|
|
5bf2372c4d | ||
|
|
c2c6396a04 | ||
|
|
aaf813fc0c | ||
|
|
d97fe84296 | ||
|
|
81f45dab21 | ||
|
|
d670e7382a | ||
|
|
cd8c686339 | ||
|
|
f5c41e3018 | ||
|
|
2477f99d89 | ||
|
|
940f530ac2 | ||
|
|
4d3e2f8ad3 | ||
|
|
5ae986e1c4 | ||
|
|
e5914e4e8b | ||
|
|
c238f5425f | ||
|
|
3c3097ea74 | ||
|
|
405c3f4003 | ||
|
|
6553ce4cea | ||
|
|
a62d472bc4 | ||
|
|
434ac7f0f5 | ||
|
|
7bbe71c3ac | ||
|
|
04dcaadabf | ||
|
|
c522506849 | ||
|
|
0765352c99 | ||
|
|
13807f1b3d | ||
|
|
c919ea149e | ||
|
|
be6fd119d8 | ||
|
|
7abf730d77 | ||
|
|
ec96c5ecaf | ||
|
|
7e1cce4b9f | ||
|
|
7be8752a00 | ||
|
|
145d82f322 | ||
|
|
a8b9570700 | ||
|
|
6ff6d84646 | ||
|
|
9aaa05e8ea | ||
|
|
0af5a0441f | ||
|
|
0fc63ea0ba | ||
|
|
0b329f7881 | ||
|
|
5b85edb753 | ||
|
|
17cfa5fe1e | ||
|
|
2313494e0e | ||
|
|
fd9d430334 | ||
|
|
91f0d5cefd | ||
|
|
82762280ee | ||
|
|
b550a2face | ||
|
|
ab77508950 | ||
|
|
b9462f5c6b | ||
|
|
5ffaa5cdd6 | ||
|
|
a1858a9cb7 | ||
|
|
212b34f639 | ||
|
|
af8eaa23e2 | ||
|
|
f0eed50678 | ||
|
|
19d94c6158 | ||
|
|
628eb56073 | ||
|
|
a590c38d8b | ||
|
|
4e149c9222 | ||
|
|
59f5b34280 | ||
|
|
dff06d0898 | ||
|
|
80a8816b1d | ||
|
|
387e374e4b | ||
|
|
3e6baea405 | ||
|
|
fe9b844511 | ||
|
|
2e1aa497d2 | ||
|
|
529c0314f8 | ||
|
|
d86875aeac | ||
|
|
f80fe506d5 | ||
|
|
967c6f3cd3 | ||
|
|
e50e124e70 | ||
|
|
c545689448 | ||
|
|
8f389fef19 | ||
|
|
d3d6a327e0 | ||
|
|
b5489d4986 | ||
|
|
7a23c57cf8 | ||
|
|
11f891220e | ||
|
|
5585adce18 | ||
|
|
f884299823 | ||
|
|
15aa6bae1b | ||
|
|
11eb725ac8 | ||
|
|
30c02ab78c | ||
|
|
3acd86e346 | ||
|
|
5c20f13c48 | ||
|
|
e6587b071d | ||
|
|
85451ab4cd | ||
|
|
a7f3ba03eb | ||
|
|
4f0a3a77ad | ||
|
|
44655ca9b5 | ||
|
|
e601278117 | ||
|
|
8e7b016be2 | ||
|
|
9e01ea7aae | ||
|
|
cfc7ec8bb9 | ||
|
|
b3bbc0e5c6 | ||
|
|
d7c8e37ff4 | ||
|
|
05b66e73bc | ||
|
|
01ceedac89 | ||
|
|
403babd433 | ||
|
|
47133031e5 | ||
|
|
82da606886 | ||
|
|
bbe5ae2145 | ||
|
|
0b21498b39 | ||
|
|
0ca59535f1 | ||
|
|
59c77d0658 | ||
|
|
333e045099 | ||
|
|
c2c4d9d336 | ||
|
|
9a6a72e88e | ||
|
|
afe6d9fca4 | ||
|
|
ef82905526 | ||
|
|
d18747e846 | ||
|
|
f341d69314 | ||
|
|
327142837c | ||
|
|
f8c0321aee | ||
|
|
89115ff76a | ||
|
|
63c83aa8d2 | ||
|
|
37f025c966 | ||
|
|
4a54f0d670 | ||
|
|
98890a29e3 | ||
|
|
9d123ec059 | ||
|
|
5d171f181a | ||
|
|
22f878b3b7 | ||
|
|
44ef1a18dd | ||
|
|
2b98dc4e52 | ||
|
|
2a26cb4567 | ||
|
|
5ca1b64328 | ||
|
|
36752a8cbb | ||
|
|
f117fc7509 | ||
|
|
fc6b93ae59 | ||
|
|
564fa4ab04 | ||
|
|
a6db88fbd2 | ||
|
|
4b5294e596 | ||
|
|
a322dce42a | ||
|
|
d1ead2265b | ||
|
|
bbca74476e | ||
|
|
318cf59d66 | ||
|
|
e9b2a6e808 | ||
|
|
2dbdb5c1a7 | ||
|
|
2cdab6d7b7 | ||
|
|
e49c0e8862 |
14
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
14
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: Community Support
|
||||||
|
url: https://forum.netbird.io/
|
||||||
|
about: Community support forum
|
||||||
|
- name: Cloud Support
|
||||||
|
url: https://docs.netbird.io/help/report-bug-issues
|
||||||
|
about: Contact us for support
|
||||||
|
- name: Client/Connection Troubleshooting
|
||||||
|
url: https://docs.netbird.io/help/troubleshooting-client
|
||||||
|
about: See our client troubleshooting guide for help addressing common issues
|
||||||
|
- name: Self-host Troubleshooting
|
||||||
|
url: https://docs.netbird.io/selfhosted/troubleshooting
|
||||||
|
about: See our self-host troubleshooting guide for help addressing common issues
|
||||||
@@ -31,7 +31,7 @@ jobs:
|
|||||||
while IFS= read -r dir; do
|
while IFS= read -r dir; do
|
||||||
echo "=== Checking $dir ==="
|
echo "=== Checking $dir ==="
|
||||||
# Search for problematic imports, excluding test files
|
# Search for problematic imports, excluding test files
|
||||||
RESULTS=$(grep -r "github.com/netbirdio/netbird/\(management\|signal\|relay\|proxy\)" "$dir" --include="*.go" 2>/dev/null | grep -v "_test.go" | grep -v "test_" | grep -v "/test/" || true)
|
RESULTS=$(grep -r "github.com/netbirdio/netbird/\(management\|signal\|relay\|proxy\)" "$dir" --include="*.go" 2>/dev/null | grep -v "_test.go" | grep -v "test_" | grep -v "/test/" | grep -v "tools/idp-migrate/" || true)
|
||||||
if [ -n "$RESULTS" ]; then
|
if [ -n "$RESULTS" ]; then
|
||||||
echo "❌ Found problematic dependencies:"
|
echo "❌ Found problematic dependencies:"
|
||||||
echo "$RESULTS"
|
echo "$RESULTS"
|
||||||
@@ -88,7 +88,7 @@ jobs:
|
|||||||
IMPORTERS=$(go list -json -deps ./... 2>/dev/null | jq -r "select(.Imports[]? == \"$package\") | .ImportPath")
|
IMPORTERS=$(go list -json -deps ./... 2>/dev/null | jq -r "select(.Imports[]? == \"$package\") | .ImportPath")
|
||||||
|
|
||||||
# Check if any importer is NOT in management/signal/relay
|
# Check if any importer is NOT in management/signal/relay
|
||||||
BSD_IMPORTER=$(echo "$IMPORTERS" | grep -v "github.com/netbirdio/netbird/\(management\|signal\|relay\|proxy\|combined\)" | head -1)
|
BSD_IMPORTER=$(echo "$IMPORTERS" | grep -v "github.com/netbirdio/netbird/\(management\|signal\|relay\|proxy\|combined\|tools/idp-migrate\)" | head -1)
|
||||||
|
|
||||||
if [ -n "$BSD_IMPORTER" ]; then
|
if [ -n "$BSD_IMPORTER" ]; then
|
||||||
echo "❌ $package ($license) is imported by BSD-licensed code: $BSD_IMPORTER"
|
echo "❌ $package ($license) is imported by BSD-licensed code: $BSD_IMPORTER"
|
||||||
|
|||||||
37
.github/workflows/golang-test-linux.yml
vendored
37
.github/workflows/golang-test-linux.yml
vendored
@@ -409,12 +409,19 @@ jobs:
|
|||||||
run: git --no-pager diff --exit-code
|
run: git --no-pager diff --exit-code
|
||||||
|
|
||||||
- name: Login to Docker hub
|
- name: Login to Docker hub
|
||||||
if: matrix.store == 'mysql' && (github.repository == github.head.repo.full_name || !github.head_ref)
|
if: github.event.pull_request && github.event.pull_request.head.repo && github.event.pull_request.head.repo.full_name == '' || github.repository == github.event.pull_request.head.repo.full_name || !github.head_ref
|
||||||
uses: docker/login-action@v1
|
uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.DOCKER_USER }}
|
username: ${{ secrets.DOCKER_USER }}
|
||||||
password: ${{ secrets.DOCKER_TOKEN }}
|
password: ${{ secrets.DOCKER_TOKEN }}
|
||||||
|
|
||||||
|
- name: docker login for root user
|
||||||
|
if: github.event.pull_request && github.event.pull_request.head.repo && github.event.pull_request.head.repo.full_name == '' || github.repository == github.event.pull_request.head.repo.full_name || !github.head_ref
|
||||||
|
env:
|
||||||
|
DOCKER_USER: ${{ secrets.DOCKER_USER }}
|
||||||
|
DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
|
||||||
|
run: echo "$DOCKER_TOKEN" | sudo docker login --username "$DOCKER_USER" --password-stdin
|
||||||
|
|
||||||
- name: download mysql image
|
- name: download mysql image
|
||||||
if: matrix.store == 'mysql'
|
if: matrix.store == 'mysql'
|
||||||
run: docker pull mlsmaycon/warmed-mysql:8
|
run: docker pull mlsmaycon/warmed-mysql:8
|
||||||
@@ -497,15 +504,18 @@ jobs:
|
|||||||
run: git --no-pager diff --exit-code
|
run: git --no-pager diff --exit-code
|
||||||
|
|
||||||
- name: Login to Docker hub
|
- name: Login to Docker hub
|
||||||
if: matrix.store == 'mysql' && (github.repository == github.head.repo.full_name || !github.head_ref)
|
if: github.event.pull_request && github.event.pull_request.head.repo && github.event.pull_request.head.repo.full_name == '' || github.repository == github.event.pull_request.head.repo.full_name || !github.head_ref
|
||||||
uses: docker/login-action@v1
|
uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.DOCKER_USER }}
|
username: ${{ secrets.DOCKER_USER }}
|
||||||
password: ${{ secrets.DOCKER_TOKEN }}
|
password: ${{ secrets.DOCKER_TOKEN }}
|
||||||
|
|
||||||
- name: download mysql image
|
- name: docker login for root user
|
||||||
if: matrix.store == 'mysql'
|
if: github.event.pull_request && github.event.pull_request.head.repo && github.event.pull_request.head.repo.full_name == '' || github.repository == github.event.pull_request.head.repo.full_name || !github.head_ref
|
||||||
run: docker pull mlsmaycon/warmed-mysql:8
|
env:
|
||||||
|
DOCKER_USER: ${{ secrets.DOCKER_USER }}
|
||||||
|
DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
|
||||||
|
run: echo "$DOCKER_TOKEN" | sudo docker login --username "$DOCKER_USER" --password-stdin
|
||||||
|
|
||||||
- name: Test
|
- name: Test
|
||||||
run: |
|
run: |
|
||||||
@@ -586,15 +596,18 @@ jobs:
|
|||||||
run: git --no-pager diff --exit-code
|
run: git --no-pager diff --exit-code
|
||||||
|
|
||||||
- name: Login to Docker hub
|
- name: Login to Docker hub
|
||||||
if: matrix.store == 'mysql' && (github.repository == github.head.repo.full_name || !github.head_ref)
|
if: github.event.pull_request && github.event.pull_request.head.repo && github.event.pull_request.head.repo.full_name == '' || github.repository == github.event.pull_request.head.repo.full_name || !github.head_ref
|
||||||
uses: docker/login-action@v1
|
uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.DOCKER_USER }}
|
username: ${{ secrets.DOCKER_USER }}
|
||||||
password: ${{ secrets.DOCKER_TOKEN }}
|
password: ${{ secrets.DOCKER_TOKEN }}
|
||||||
|
|
||||||
- name: download mysql image
|
- name: docker login for root user
|
||||||
if: matrix.store == 'mysql'
|
if: github.event.pull_request && github.event.pull_request.head.repo && github.event.pull_request.head.repo.full_name == '' || github.repository == github.event.pull_request.head.repo.full_name || !github.head_ref
|
||||||
run: docker pull mlsmaycon/warmed-mysql:8
|
env:
|
||||||
|
DOCKER_USER: ${{ secrets.DOCKER_USER }}
|
||||||
|
DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
|
||||||
|
run: echo "$DOCKER_TOKEN" | sudo docker login --username "$DOCKER_USER" --password-stdin
|
||||||
|
|
||||||
- name: Test
|
- name: Test
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
9
.github/workflows/golang-test-windows.yml
vendored
9
.github/workflows/golang-test-windows.yml
vendored
@@ -63,10 +63,15 @@ jobs:
|
|||||||
- run: PsExec64 -s -w ${{ github.workspace }} C:\hostedtoolcache\windows\go\${{ steps.go.outputs.go-version }}\x64\bin\go.exe env -w GOMODCACHE=${{ env.cache }}
|
- run: PsExec64 -s -w ${{ github.workspace }} C:\hostedtoolcache\windows\go\${{ steps.go.outputs.go-version }}\x64\bin\go.exe env -w GOMODCACHE=${{ env.cache }}
|
||||||
- run: PsExec64 -s -w ${{ github.workspace }} C:\hostedtoolcache\windows\go\${{ steps.go.outputs.go-version }}\x64\bin\go.exe env -w GOCACHE=${{ env.modcache }}
|
- run: PsExec64 -s -w ${{ github.workspace }} C:\hostedtoolcache\windows\go\${{ steps.go.outputs.go-version }}\x64\bin\go.exe env -w GOCACHE=${{ env.modcache }}
|
||||||
- run: PsExec64 -s -w ${{ github.workspace }} C:\hostedtoolcache\windows\go\${{ steps.go.outputs.go-version }}\x64\bin\go.exe mod tidy
|
- run: PsExec64 -s -w ${{ github.workspace }} C:\hostedtoolcache\windows\go\${{ steps.go.outputs.go-version }}\x64\bin\go.exe mod tidy
|
||||||
- run: echo "files=$(go list ./... | ForEach-Object { $_ } | Where-Object { $_ -notmatch '/management' } | Where-Object { $_ -notmatch '/relay' } | Where-Object { $_ -notmatch '/signal' } | Where-Object { $_ -notmatch '/proxy' } | Where-Object { $_ -notmatch '/combined' })" >> $env:GITHUB_ENV
|
- name: Generate test script
|
||||||
|
run: |
|
||||||
|
$packages = go list ./... | Where-Object { $_ -notmatch '/management' } | Where-Object { $_ -notmatch '/relay' } | Where-Object { $_ -notmatch '/signal' } | Where-Object { $_ -notmatch '/proxy' } | Where-Object { $_ -notmatch '/combined' }
|
||||||
|
$goExe = "C:\hostedtoolcache\windows\go\${{ steps.go.outputs.go-version }}\x64\bin\go.exe"
|
||||||
|
$cmd = "$goExe test -tags=devcert -timeout 10m -p 1 $($packages -join ' ') > test-out.txt 2>&1"
|
||||||
|
Set-Content -Path "${{ github.workspace }}\run-tests.cmd" -Value $cmd
|
||||||
|
|
||||||
- name: test
|
- name: test
|
||||||
run: PsExec64 -s -w ${{ github.workspace }} cmd.exe /c "C:\hostedtoolcache\windows\go\${{ steps.go.outputs.go-version }}\x64\bin\go.exe test -tags=devcert -timeout 10m -p 1 ${{ env.files }} > test-out.txt 2>&1"
|
run: PsExec64 -s -w ${{ github.workspace }} cmd.exe /c "${{ github.workspace }}\run-tests.cmd"
|
||||||
- name: test output
|
- name: test output
|
||||||
if: ${{ always() }}
|
if: ${{ always() }}
|
||||||
run: Get-Content test-out.txt
|
run: Get-Content test-out.txt
|
||||||
|
|||||||
2
.github/workflows/golangci-lint.yml
vendored
2
.github/workflows/golangci-lint.yml
vendored
@@ -19,7 +19,7 @@ jobs:
|
|||||||
- name: codespell
|
- name: codespell
|
||||||
uses: codespell-project/actions-codespell@v2
|
uses: codespell-project/actions-codespell@v2
|
||||||
with:
|
with:
|
||||||
ignore_words_list: erro,clienta,hastable,iif,groupd,testin,groupe,cros,ans,deriver
|
ignore_words_list: erro,clienta,hastable,iif,groupd,testin,groupe,cros,ans,deriver,te,userA
|
||||||
skip: go.mod,go.sum,**/proxy/web/**
|
skip: go.mod,go.sum,**/proxy/web/**
|
||||||
golangci:
|
golangci:
|
||||||
strategy:
|
strategy:
|
||||||
|
|||||||
51
.github/workflows/pr-title-check.yml
vendored
Normal file
51
.github/workflows/pr-title-check.yml
vendored
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
name: PR Title Check
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types: [opened, edited, synchronize, reopened]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check-title:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Validate PR title prefix
|
||||||
|
uses: actions/github-script@v7
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const title = context.payload.pull_request.title;
|
||||||
|
const allowedTags = [
|
||||||
|
'management',
|
||||||
|
'client',
|
||||||
|
'signal',
|
||||||
|
'proxy',
|
||||||
|
'relay',
|
||||||
|
'misc',
|
||||||
|
'infrastructure',
|
||||||
|
'self-hosted',
|
||||||
|
'doc',
|
||||||
|
];
|
||||||
|
|
||||||
|
const pattern = /^\[([^\]]+)\]\s+.+/;
|
||||||
|
const match = title.match(pattern);
|
||||||
|
|
||||||
|
if (!match) {
|
||||||
|
core.setFailed(
|
||||||
|
`PR title must start with a tag in brackets.\n` +
|
||||||
|
`Example: [client] fix something\n` +
|
||||||
|
`Allowed tags: ${allowedTags.join(', ')}`
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const tags = match[1].split(',').map(t => t.trim().toLowerCase());
|
||||||
|
|
||||||
|
const invalid = tags.filter(t => !allowedTags.includes(t));
|
||||||
|
if (invalid.length > 0) {
|
||||||
|
core.setFailed(
|
||||||
|
`Invalid tag(s): ${invalid.join(', ')}\n` +
|
||||||
|
`Allowed tags: ${allowedTags.join(', ')}`
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`Valid PR title tags: [${tags.join(', ')}]`);
|
||||||
62
.github/workflows/proto-version-check.yml
vendored
Normal file
62
.github/workflows/proto-version-check.yml
vendored
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
name: Proto Version Check
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- "**/*.pb.go"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check-proto-versions:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Check for proto tool version changes
|
||||||
|
uses: actions/github-script@v7
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const files = await github.paginate(github.rest.pulls.listFiles, {
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
pull_number: context.issue.number,
|
||||||
|
per_page: 100,
|
||||||
|
});
|
||||||
|
|
||||||
|
const pbFiles = files.filter(f => f.filename.endsWith('.pb.go'));
|
||||||
|
const missingPatch = pbFiles.filter(f => !f.patch).map(f => f.filename);
|
||||||
|
if (missingPatch.length > 0) {
|
||||||
|
core.setFailed(
|
||||||
|
`Cannot inspect patch data for:\n` +
|
||||||
|
missingPatch.map(f => `- ${f}`).join('\n') +
|
||||||
|
`\nThis can happen with very large PRs. Verify proto versions manually.`
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const versionPattern = /^[+-]\s*\/\/\s+protoc(?:-gen-go)?\s+v[\d.]+/;
|
||||||
|
const violations = [];
|
||||||
|
|
||||||
|
for (const file of pbFiles) {
|
||||||
|
const changed = file.patch
|
||||||
|
.split('\n')
|
||||||
|
.filter(line => versionPattern.test(line));
|
||||||
|
if (changed.length > 0) {
|
||||||
|
violations.push({
|
||||||
|
file: file.filename,
|
||||||
|
lines: changed,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (violations.length > 0) {
|
||||||
|
const details = violations.map(v =>
|
||||||
|
`${v.file}:\n${v.lines.map(l => ' ' + l).join('\n')}`
|
||||||
|
).join('\n\n');
|
||||||
|
|
||||||
|
core.setFailed(
|
||||||
|
`Proto version strings changed in generated files.\n` +
|
||||||
|
`This usually means the wrong protoc or protoc-gen-go version was used.\n` +
|
||||||
|
`Regenerate with the matching tool versions.\n\n` +
|
||||||
|
details
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log('No proto version string changes detected');
|
||||||
90
.github/workflows/release.yml
vendored
90
.github/workflows/release.yml
vendored
@@ -9,8 +9,8 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
env:
|
env:
|
||||||
SIGN_PIPE_VER: "v0.1.1"
|
SIGN_PIPE_VER: "v0.1.2"
|
||||||
GORELEASER_VER: "v2.3.2"
|
GORELEASER_VER: "v2.14.3"
|
||||||
PRODUCT_NAME: "NetBird"
|
PRODUCT_NAME: "NetBird"
|
||||||
COPYRIGHT: "NetBird GmbH"
|
COPYRIGHT: "NetBird GmbH"
|
||||||
|
|
||||||
@@ -169,6 +169,14 @@ jobs:
|
|||||||
- name: Install OS build dependencies
|
- name: Install OS build dependencies
|
||||||
run: sudo apt update && sudo apt install -y -q gcc-arm-linux-gnueabihf gcc-aarch64-linux-gnu
|
run: sudo apt update && sudo apt install -y -q gcc-arm-linux-gnueabihf gcc-aarch64-linux-gnu
|
||||||
|
|
||||||
|
- name: Decode GPG signing key
|
||||||
|
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
|
||||||
|
env:
|
||||||
|
GPG_RPM_PRIVATE_KEY: ${{ secrets.GPG_RPM_PRIVATE_KEY }}
|
||||||
|
run: |
|
||||||
|
echo "$GPG_RPM_PRIVATE_KEY" | base64 -d > /tmp/gpg-rpm-signing-key.asc
|
||||||
|
echo "GPG_RPM_KEY_FILE=/tmp/gpg-rpm-signing-key.asc" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Install goversioninfo
|
- name: Install goversioninfo
|
||||||
run: go install github.com/josephspurrier/goversioninfo/cmd/goversioninfo@233067e
|
run: go install github.com/josephspurrier/goversioninfo/cmd/goversioninfo@233067e
|
||||||
- name: Generate windows syso amd64
|
- name: Generate windows syso amd64
|
||||||
@@ -186,18 +194,54 @@ jobs:
|
|||||||
HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }}
|
HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }}
|
||||||
UPLOAD_DEBIAN_SECRET: ${{ secrets.PKG_UPLOAD_SECRET }}
|
UPLOAD_DEBIAN_SECRET: ${{ secrets.PKG_UPLOAD_SECRET }}
|
||||||
UPLOAD_YUM_SECRET: ${{ secrets.PKG_UPLOAD_SECRET }}
|
UPLOAD_YUM_SECRET: ${{ secrets.PKG_UPLOAD_SECRET }}
|
||||||
- name: Tag and push PR images (amd64 only)
|
GPG_RPM_KEY_FILE: ${{ env.GPG_RPM_KEY_FILE }}
|
||||||
if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
|
NFPM_NETBIRD_RPM_PASSPHRASE: ${{ secrets.GPG_RPM_PASSPHRASE }}
|
||||||
|
- name: Verify RPM signatures
|
||||||
run: |
|
run: |
|
||||||
PR_TAG="pr-${{ github.event.pull_request.number }}"
|
docker run --rm -v $(pwd)/dist:/dist fedora:41 bash -c '
|
||||||
|
dnf install -y -q rpm-sign curl >/dev/null 2>&1
|
||||||
|
curl -sSL https://pkgs.netbird.io/yum/repodata/repomd.xml.key -o /tmp/rpm-pub.key
|
||||||
|
rpm --import /tmp/rpm-pub.key
|
||||||
|
echo "=== Verifying RPM signatures ==="
|
||||||
|
for rpm_file in /dist/*amd64*.rpm; do
|
||||||
|
[ -f "$rpm_file" ] || continue
|
||||||
|
echo "--- $(basename $rpm_file) ---"
|
||||||
|
rpm -K "$rpm_file"
|
||||||
|
done
|
||||||
|
'
|
||||||
|
- name: Clean up GPG key
|
||||||
|
if: always()
|
||||||
|
run: rm -f /tmp/gpg-rpm-signing-key.asc
|
||||||
|
- name: Tag and push images (amd64 only)
|
||||||
|
if: |
|
||||||
|
(github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) ||
|
||||||
|
(github.event_name == 'push' && github.ref == 'refs/heads/main')
|
||||||
|
run: |
|
||||||
|
resolve_tags() {
|
||||||
|
if [[ "${{ github.event_name }}" == "pull_request" ]]; then
|
||||||
|
echo "pr-${{ github.event.pull_request.number }}"
|
||||||
|
else
|
||||||
|
echo "main sha-$(git rev-parse --short HEAD)"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
tag_and_push() {
|
||||||
|
local src="$1" img_name tag dst
|
||||||
|
img_name="${src%%:*}"
|
||||||
|
for tag in $(resolve_tags); do
|
||||||
|
dst="${img_name}:${tag}"
|
||||||
|
echo "Tagging ${src} -> ${dst}"
|
||||||
|
docker tag "$src" "$dst"
|
||||||
|
docker push "$dst"
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
export -f tag_and_push resolve_tags
|
||||||
|
|
||||||
echo '${{ steps.goreleaser.outputs.artifacts }}' | \
|
echo '${{ steps.goreleaser.outputs.artifacts }}' | \
|
||||||
jq -r '.[] | select(.type == "Docker Image") | select(.goarch == "amd64") | .name' | \
|
jq -r '.[] | select(.type == "Docker Image") | select(.goarch == "amd64") | .name' | \
|
||||||
grep '^ghcr.io/' | while read -r SRC; do
|
grep '^ghcr.io/' | while read -r SRC; do
|
||||||
IMG_NAME="${SRC%%:*}"
|
tag_and_push "$SRC"
|
||||||
DST="${IMG_NAME}:${PR_TAG}"
|
|
||||||
echo "Tagging ${SRC} -> ${DST}"
|
|
||||||
docker tag "$SRC" "$DST"
|
|
||||||
docker push "$DST"
|
|
||||||
done
|
done
|
||||||
- name: upload non tags for debug purposes
|
- name: upload non tags for debug purposes
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@v4
|
||||||
@@ -265,6 +309,14 @@ jobs:
|
|||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: sudo apt update && sudo apt install -y -q libappindicator3-dev gir1.2-appindicator3-0.1 libxxf86vm-dev gcc-mingw-w64-x86-64
|
run: sudo apt update && sudo apt install -y -q libappindicator3-dev gir1.2-appindicator3-0.1 libxxf86vm-dev gcc-mingw-w64-x86-64
|
||||||
|
|
||||||
|
- name: Decode GPG signing key
|
||||||
|
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
|
||||||
|
env:
|
||||||
|
GPG_RPM_PRIVATE_KEY: ${{ secrets.GPG_RPM_PRIVATE_KEY }}
|
||||||
|
run: |
|
||||||
|
echo "$GPG_RPM_PRIVATE_KEY" | base64 -d > /tmp/gpg-rpm-signing-key.asc
|
||||||
|
echo "GPG_RPM_KEY_FILE=/tmp/gpg-rpm-signing-key.asc" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Install LLVM-MinGW for ARM64 cross-compilation
|
- name: Install LLVM-MinGW for ARM64 cross-compilation
|
||||||
run: |
|
run: |
|
||||||
cd /tmp
|
cd /tmp
|
||||||
@@ -289,6 +341,24 @@ jobs:
|
|||||||
HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }}
|
HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }}
|
||||||
UPLOAD_DEBIAN_SECRET: ${{ secrets.PKG_UPLOAD_SECRET }}
|
UPLOAD_DEBIAN_SECRET: ${{ secrets.PKG_UPLOAD_SECRET }}
|
||||||
UPLOAD_YUM_SECRET: ${{ secrets.PKG_UPLOAD_SECRET }}
|
UPLOAD_YUM_SECRET: ${{ secrets.PKG_UPLOAD_SECRET }}
|
||||||
|
GPG_RPM_KEY_FILE: ${{ env.GPG_RPM_KEY_FILE }}
|
||||||
|
NFPM_NETBIRD_UI_RPM_PASSPHRASE: ${{ secrets.GPG_RPM_PASSPHRASE }}
|
||||||
|
- name: Verify RPM signatures
|
||||||
|
run: |
|
||||||
|
docker run --rm -v $(pwd)/dist:/dist fedora:41 bash -c '
|
||||||
|
dnf install -y -q rpm-sign curl >/dev/null 2>&1
|
||||||
|
curl -sSL https://pkgs.netbird.io/yum/repodata/repomd.xml.key -o /tmp/rpm-pub.key
|
||||||
|
rpm --import /tmp/rpm-pub.key
|
||||||
|
echo "=== Verifying RPM signatures ==="
|
||||||
|
for rpm_file in /dist/*.rpm; do
|
||||||
|
[ -f "$rpm_file" ] || continue
|
||||||
|
echo "--- $(basename $rpm_file) ---"
|
||||||
|
rpm -K "$rpm_file"
|
||||||
|
done
|
||||||
|
'
|
||||||
|
- name: Clean up GPG key
|
||||||
|
if: always()
|
||||||
|
run: rm -f /tmp/gpg-rpm-signing-key.asc
|
||||||
- name: upload non tags for debug purposes
|
- name: upload non tags for debug purposes
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
|
|||||||
4
.github/workflows/wasm-build-validation.yml
vendored
4
.github/workflows/wasm-build-validation.yml
vendored
@@ -61,8 +61,8 @@ jobs:
|
|||||||
|
|
||||||
echo "Size: ${SIZE} bytes (${SIZE_MB} MB)"
|
echo "Size: ${SIZE} bytes (${SIZE_MB} MB)"
|
||||||
|
|
||||||
if [ ${SIZE} -gt 57671680 ]; then
|
if [ ${SIZE} -gt 58720256 ]; then
|
||||||
echo "Wasm binary size (${SIZE_MB}MB) exceeds 55MB limit!"
|
echo "Wasm binary size (${SIZE_MB}MB) exceeds 56MB limit!"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|||||||
@@ -154,6 +154,26 @@ builds:
|
|||||||
- -s -w -X main.Version={{.Version}} -X main.Commit={{.Commit}} -X main.BuildDate={{.CommitDate}}
|
- -s -w -X main.Version={{.Version}} -X main.Commit={{.Commit}} -X main.BuildDate={{.CommitDate}}
|
||||||
mod_timestamp: "{{ .CommitTimestamp }}"
|
mod_timestamp: "{{ .CommitTimestamp }}"
|
||||||
|
|
||||||
|
- id: netbird-idp-migrate
|
||||||
|
dir: tools/idp-migrate
|
||||||
|
env:
|
||||||
|
- CGO_ENABLED=1
|
||||||
|
- >-
|
||||||
|
{{- if eq .Runtime.Goos "linux" }}
|
||||||
|
{{- if eq .Arch "arm64"}}CC=aarch64-linux-gnu-gcc{{- end }}
|
||||||
|
{{- if eq .Arch "arm"}}CC=arm-linux-gnueabihf-gcc{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
binary: netbird-idp-migrate
|
||||||
|
goos:
|
||||||
|
- linux
|
||||||
|
goarch:
|
||||||
|
- amd64
|
||||||
|
- arm64
|
||||||
|
- arm
|
||||||
|
ldflags:
|
||||||
|
- -s -w -X github.com/netbirdio/netbird/version.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.CommitDate}} -X main.builtBy=goreleaser
|
||||||
|
mod_timestamp: "{{ .CommitTimestamp }}"
|
||||||
|
|
||||||
universal_binaries:
|
universal_binaries:
|
||||||
- id: netbird
|
- id: netbird
|
||||||
|
|
||||||
@@ -166,18 +186,22 @@ archives:
|
|||||||
- netbird-wasm
|
- netbird-wasm
|
||||||
name_template: "{{ .ProjectName }}_{{ .Version }}"
|
name_template: "{{ .ProjectName }}_{{ .Version }}"
|
||||||
format: binary
|
format: binary
|
||||||
|
- id: netbird-idp-migrate
|
||||||
|
builds:
|
||||||
|
- netbird-idp-migrate
|
||||||
|
name_template: "netbird-idp-migrate_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
|
||||||
|
|
||||||
nfpms:
|
nfpms:
|
||||||
- maintainer: Netbird <dev@netbird.io>
|
- maintainer: Netbird <dev@netbird.io>
|
||||||
description: Netbird client.
|
description: Netbird client.
|
||||||
homepage: https://netbird.io/
|
homepage: https://netbird.io/
|
||||||
id: netbird-deb
|
license: BSD-3-Clause
|
||||||
|
id: netbird_deb
|
||||||
bindir: /usr/bin
|
bindir: /usr/bin
|
||||||
builds:
|
builds:
|
||||||
- netbird
|
- netbird
|
||||||
formats:
|
formats:
|
||||||
- deb
|
- deb
|
||||||
|
|
||||||
scripts:
|
scripts:
|
||||||
postinstall: "release_files/post_install.sh"
|
postinstall: "release_files/post_install.sh"
|
||||||
preremove: "release_files/pre_remove.sh"
|
preremove: "release_files/pre_remove.sh"
|
||||||
@@ -185,16 +209,19 @@ nfpms:
|
|||||||
- maintainer: Netbird <dev@netbird.io>
|
- maintainer: Netbird <dev@netbird.io>
|
||||||
description: Netbird client.
|
description: Netbird client.
|
||||||
homepage: https://netbird.io/
|
homepage: https://netbird.io/
|
||||||
id: netbird-rpm
|
license: BSD-3-Clause
|
||||||
|
id: netbird_rpm
|
||||||
bindir: /usr/bin
|
bindir: /usr/bin
|
||||||
builds:
|
builds:
|
||||||
- netbird
|
- netbird
|
||||||
formats:
|
formats:
|
||||||
- rpm
|
- rpm
|
||||||
|
|
||||||
scripts:
|
scripts:
|
||||||
postinstall: "release_files/post_install.sh"
|
postinstall: "release_files/post_install.sh"
|
||||||
preremove: "release_files/pre_remove.sh"
|
preremove: "release_files/pre_remove.sh"
|
||||||
|
rpm:
|
||||||
|
signature:
|
||||||
|
key_file: '{{ if index .Env "GPG_RPM_KEY_FILE" }}{{ .Env.GPG_RPM_KEY_FILE }}{{ end }}'
|
||||||
dockers:
|
dockers:
|
||||||
- image_templates:
|
- image_templates:
|
||||||
- netbirdio/netbird:{{ .Version }}-amd64
|
- netbirdio/netbird:{{ .Version }}-amd64
|
||||||
@@ -876,7 +903,7 @@ brews:
|
|||||||
uploads:
|
uploads:
|
||||||
- name: debian
|
- name: debian
|
||||||
ids:
|
ids:
|
||||||
- netbird-deb
|
- netbird_deb
|
||||||
mode: archive
|
mode: archive
|
||||||
target: https://pkgs.wiretrustee.com/debian/pool/{{ .ArtifactName }};deb.distribution=stable;deb.component=main;deb.architecture={{ if .Arm }}armhf{{ else }}{{ .Arch }}{{ end }};deb.package=
|
target: https://pkgs.wiretrustee.com/debian/pool/{{ .ArtifactName }};deb.distribution=stable;deb.component=main;deb.architecture={{ if .Arm }}armhf{{ else }}{{ .Arch }}{{ end }};deb.package=
|
||||||
username: dev@wiretrustee.com
|
username: dev@wiretrustee.com
|
||||||
@@ -884,7 +911,7 @@ uploads:
|
|||||||
|
|
||||||
- name: yum
|
- name: yum
|
||||||
ids:
|
ids:
|
||||||
- netbird-rpm
|
- netbird_rpm
|
||||||
mode: archive
|
mode: archive
|
||||||
target: https://pkgs.wiretrustee.com/yum/{{ .Arch }}{{ if .Arm }}{{ .Arm }}{{ end }}
|
target: https://pkgs.wiretrustee.com/yum/{{ .Arch }}{{ if .Arm }}{{ .Arm }}{{ end }}
|
||||||
username: dev@wiretrustee.com
|
username: dev@wiretrustee.com
|
||||||
|
|||||||
@@ -61,7 +61,7 @@ nfpms:
|
|||||||
- maintainer: Netbird <dev@netbird.io>
|
- maintainer: Netbird <dev@netbird.io>
|
||||||
description: Netbird client UI.
|
description: Netbird client UI.
|
||||||
homepage: https://netbird.io/
|
homepage: https://netbird.io/
|
||||||
id: netbird-ui-deb
|
id: netbird_ui_deb
|
||||||
package_name: netbird-ui
|
package_name: netbird-ui
|
||||||
builds:
|
builds:
|
||||||
- netbird-ui
|
- netbird-ui
|
||||||
@@ -80,7 +80,7 @@ nfpms:
|
|||||||
- maintainer: Netbird <dev@netbird.io>
|
- maintainer: Netbird <dev@netbird.io>
|
||||||
description: Netbird client UI.
|
description: Netbird client UI.
|
||||||
homepage: https://netbird.io/
|
homepage: https://netbird.io/
|
||||||
id: netbird-ui-rpm
|
id: netbird_ui_rpm
|
||||||
package_name: netbird-ui
|
package_name: netbird-ui
|
||||||
builds:
|
builds:
|
||||||
- netbird-ui
|
- netbird-ui
|
||||||
@@ -95,11 +95,14 @@ nfpms:
|
|||||||
dst: /usr/share/pixmaps/netbird.png
|
dst: /usr/share/pixmaps/netbird.png
|
||||||
dependencies:
|
dependencies:
|
||||||
- netbird
|
- netbird
|
||||||
|
rpm:
|
||||||
|
signature:
|
||||||
|
key_file: '{{ if index .Env "GPG_RPM_KEY_FILE" }}{{ .Env.GPG_RPM_KEY_FILE }}{{ end }}'
|
||||||
|
|
||||||
uploads:
|
uploads:
|
||||||
- name: debian
|
- name: debian
|
||||||
ids:
|
ids:
|
||||||
- netbird-ui-deb
|
- netbird_ui_deb
|
||||||
mode: archive
|
mode: archive
|
||||||
target: https://pkgs.wiretrustee.com/debian/pool/{{ .ArtifactName }};deb.distribution=stable;deb.component=main;deb.architecture={{ if .Arm }}armhf{{ else }}{{ .Arch }}{{ end }};deb.package=
|
target: https://pkgs.wiretrustee.com/debian/pool/{{ .ArtifactName }};deb.distribution=stable;deb.component=main;deb.architecture={{ if .Arm }}armhf{{ else }}{{ .Arch }}{{ end }};deb.package=
|
||||||
username: dev@wiretrustee.com
|
username: dev@wiretrustee.com
|
||||||
@@ -107,7 +110,7 @@ uploads:
|
|||||||
|
|
||||||
- name: yum
|
- name: yum
|
||||||
ids:
|
ids:
|
||||||
- netbird-ui-rpm
|
- netbird_ui_rpm
|
||||||
mode: archive
|
mode: archive
|
||||||
target: https://pkgs.wiretrustee.com/yum/{{ .Arch }}{{ if .Arm }}{{ .Arm }}{{ end }}
|
target: https://pkgs.wiretrustee.com/yum/{{ .Arch }}{{ if .Arm }}{{ .Arm }}{{ end }}
|
||||||
username: dev@wiretrustee.com
|
username: dev@wiretrustee.com
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
## Contributor License Agreement
|
## Contributor License Agreement
|
||||||
|
|
||||||
This Contributor License Agreement (referred to as the "Agreement") is entered into by the individual
|
This Contributor License Agreement (referred to as the "Agreement") is entered into by the individual
|
||||||
submitting this Agreement and NetBird GmbH, c/o Max-Beer-Straße 2-4 Münzstraße 12 10178 Berlin, Germany,
|
submitting this Agreement and NetBird GmbH, Brunnenstraße 196, 10119 Berlin, Germany,
|
||||||
referred to as "NetBird" (collectively, the "Parties"). The Agreement outlines the terms and conditions
|
referred to as "NetBird" (collectively, the "Parties"). The Agreement outlines the terms and conditions
|
||||||
under which NetBird may utilize software contributions provided by the Contributor for inclusion in
|
under which NetBird may utilize software contributions provided by the Contributor for inclusion in
|
||||||
its software development projects. By submitting this Agreement, the Contributor confirms their acceptance
|
its software development projects. By submitting this Agreement, the Contributor confirms their acceptance
|
||||||
|
|||||||
@@ -126,6 +126,7 @@ See a complete [architecture overview](https://docs.netbird.io/about-netbird/how
|
|||||||
### Community projects
|
### Community projects
|
||||||
- [NetBird installer script](https://github.com/physk/netbird-installer)
|
- [NetBird installer script](https://github.com/physk/netbird-installer)
|
||||||
- [NetBird ansible collection by Dominion Solutions](https://galaxy.ansible.com/ui/repo/published/dominion_solutions/netbird/)
|
- [NetBird ansible collection by Dominion Solutions](https://galaxy.ansible.com/ui/repo/published/dominion_solutions/netbird/)
|
||||||
|
- [netbird-tui](https://github.com/n0pashkov/netbird-tui) — terminal UI for managing NetBird peers, routes, and settings
|
||||||
|
|
||||||
**Note**: The `main` branch may be in an *unstable or even broken state* during development.
|
**Note**: The `main` branch may be in an *unstable or even broken state* during development.
|
||||||
For stable versions, see [releases](https://github.com/netbirdio/netbird/releases).
|
For stable versions, see [releases](https://github.com/netbirdio/netbird/releases).
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
# sudo podman build -t localhost/netbird:latest -f client/Dockerfile --ignorefile .dockerignore-client .
|
# sudo podman build -t localhost/netbird:latest -f client/Dockerfile --ignorefile .dockerignore-client .
|
||||||
# sudo podman run --rm -it --cap-add={BPF,NET_ADMIN,NET_RAW} localhost/netbird:latest
|
# sudo podman run --rm -it --cap-add={BPF,NET_ADMIN,NET_RAW} localhost/netbird:latest
|
||||||
|
|
||||||
FROM alpine:3.23.2
|
FROM alpine:3.23.3
|
||||||
# iproute2: busybox doesn't display ip rules properly
|
# iproute2: busybox doesn't display ip rules properly
|
||||||
RUN apk add --no-cache \
|
RUN apk add --no-cache \
|
||||||
bash \
|
bash \
|
||||||
@@ -17,8 +17,7 @@ ENV \
|
|||||||
NETBIRD_BIN="/usr/local/bin/netbird" \
|
NETBIRD_BIN="/usr/local/bin/netbird" \
|
||||||
NB_LOG_FILE="console,/var/log/netbird/client.log" \
|
NB_LOG_FILE="console,/var/log/netbird/client.log" \
|
||||||
NB_DAEMON_ADDR="unix:///var/run/netbird.sock" \
|
NB_DAEMON_ADDR="unix:///var/run/netbird.sock" \
|
||||||
NB_ENTRYPOINT_SERVICE_TIMEOUT="5" \
|
NB_ENTRYPOINT_SERVICE_TIMEOUT="30"
|
||||||
NB_ENTRYPOINT_LOGIN_TIMEOUT="5"
|
|
||||||
|
|
||||||
ENTRYPOINT [ "/usr/local/bin/netbird-entrypoint.sh" ]
|
ENTRYPOINT [ "/usr/local/bin/netbird-entrypoint.sh" ]
|
||||||
|
|
||||||
|
|||||||
@@ -23,8 +23,7 @@ ENV \
|
|||||||
NB_DAEMON_ADDR="unix:///var/lib/netbird/netbird.sock" \
|
NB_DAEMON_ADDR="unix:///var/lib/netbird/netbird.sock" \
|
||||||
NB_LOG_FILE="console,/var/lib/netbird/client.log" \
|
NB_LOG_FILE="console,/var/lib/netbird/client.log" \
|
||||||
NB_DISABLE_DNS="true" \
|
NB_DISABLE_DNS="true" \
|
||||||
NB_ENTRYPOINT_SERVICE_TIMEOUT="5" \
|
NB_ENTRYPOINT_SERVICE_TIMEOUT="30"
|
||||||
NB_ENTRYPOINT_LOGIN_TIMEOUT="1"
|
|
||||||
|
|
||||||
ENTRYPOINT [ "/usr/local/bin/netbird-entrypoint.sh" ]
|
ENTRYPOINT [ "/usr/local/bin/netbird-entrypoint.sh" ]
|
||||||
|
|
||||||
|
|||||||
@@ -124,7 +124,7 @@ func (c *Client) Run(platformFiles PlatformFiles, urlOpener URLOpener, isAndroid
|
|||||||
|
|
||||||
// todo do not throw error in case of cancelled context
|
// todo do not throw error in case of cancelled context
|
||||||
ctx = internal.CtxInitState(ctx)
|
ctx = internal.CtxInitState(ctx)
|
||||||
c.connectClient = internal.NewConnectClient(ctx, cfg, c.recorder, false)
|
c.connectClient = internal.NewConnectClient(ctx, cfg, c.recorder)
|
||||||
return c.connectClient.RunOnAndroid(c.tunAdapter, c.iFaceDiscover, c.networkChangeListener, slices.Clone(dns.items), dnsReadyListener, stateFile)
|
return c.connectClient.RunOnAndroid(c.tunAdapter, c.iFaceDiscover, c.networkChangeListener, slices.Clone(dns.items), dnsReadyListener, stateFile)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -157,7 +157,7 @@ func (c *Client) RunWithoutLogin(platformFiles PlatformFiles, dns *DNSList, dnsR
|
|||||||
|
|
||||||
// todo do not throw error in case of cancelled context
|
// todo do not throw error in case of cancelled context
|
||||||
ctx = internal.CtxInitState(ctx)
|
ctx = internal.CtxInitState(ctx)
|
||||||
c.connectClient = internal.NewConnectClient(ctx, cfg, c.recorder, false)
|
c.connectClient = internal.NewConnectClient(ctx, cfg, c.recorder)
|
||||||
return c.connectClient.RunOnAndroid(c.tunAdapter, c.iFaceDiscover, c.networkChangeListener, slices.Clone(dns.items), dnsReadyListener, stateFile)
|
return c.connectClient.RunOnAndroid(c.tunAdapter, c.iFaceDiscover, c.networkChangeListener, slices.Clone(dns.items), dnsReadyListener, stateFile)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -205,7 +205,7 @@ func (c *Client) PeersList() *PeerInfoArray {
|
|||||||
pi := PeerInfo{
|
pi := PeerInfo{
|
||||||
p.IP,
|
p.IP,
|
||||||
p.FQDN,
|
p.FQDN,
|
||||||
p.ConnStatus.String(),
|
int(p.ConnStatus),
|
||||||
PeerRoutes{routes: maps.Keys(p.GetRoutes())},
|
PeerRoutes{routes: maps.Keys(p.GetRoutes())},
|
||||||
}
|
}
|
||||||
peerInfos[n] = pi
|
peerInfos[n] = pi
|
||||||
|
|||||||
@@ -2,11 +2,20 @@
|
|||||||
|
|
||||||
package android
|
package android
|
||||||
|
|
||||||
|
import "github.com/netbirdio/netbird/client/internal/peer"
|
||||||
|
|
||||||
|
// Connection status constants exported via gomobile.
|
||||||
|
const (
|
||||||
|
ConnStatusIdle = int(peer.StatusIdle)
|
||||||
|
ConnStatusConnecting = int(peer.StatusConnecting)
|
||||||
|
ConnStatusConnected = int(peer.StatusConnected)
|
||||||
|
)
|
||||||
|
|
||||||
// PeerInfo describe information about the peers. It designed for the UI usage
|
// PeerInfo describe information about the peers. It designed for the UI usage
|
||||||
type PeerInfo struct {
|
type PeerInfo struct {
|
||||||
IP string
|
IP string
|
||||||
FQDN string
|
FQDN string
|
||||||
ConnStatus string // Todo replace to enum
|
ConnStatus int
|
||||||
Routes PeerRoutes
|
Routes PeerRoutes
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -181,10 +181,11 @@ func runForDuration(cmd *cobra.Command, args []string) error {
|
|||||||
|
|
||||||
if stateWasDown {
|
if stateWasDown {
|
||||||
if _, err := client.Up(cmd.Context(), &proto.UpRequest{}); err != nil {
|
if _, err := client.Up(cmd.Context(), &proto.UpRequest{}); err != nil {
|
||||||
return fmt.Errorf("failed to up: %v", status.Convert(err).Message())
|
cmd.PrintErrf("Failed to bring service up: %v\n", status.Convert(err).Message())
|
||||||
|
} else {
|
||||||
|
cmd.Println("netbird up")
|
||||||
|
time.Sleep(time.Second * 10)
|
||||||
}
|
}
|
||||||
cmd.Println("netbird up")
|
|
||||||
time.Sleep(time.Second * 10)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
initialLevelTrace := initialLogLevel.GetLevel() >= proto.LogLevel_TRACE
|
initialLevelTrace := initialLogLevel.GetLevel() >= proto.LogLevel_TRACE
|
||||||
@@ -198,10 +199,13 @@ func runForDuration(cmd *cobra.Command, args []string) error {
|
|||||||
cmd.Println("Log level set to trace.")
|
cmd.Println("Log level set to trace.")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
needsRestoreUp := false
|
||||||
if _, err := client.Down(cmd.Context(), &proto.DownRequest{}); err != nil {
|
if _, err := client.Down(cmd.Context(), &proto.DownRequest{}); err != nil {
|
||||||
return fmt.Errorf("failed to down: %v", status.Convert(err).Message())
|
cmd.PrintErrf("Failed to bring service down: %v\n", status.Convert(err).Message())
|
||||||
|
} else {
|
||||||
|
needsRestoreUp = !stateWasDown
|
||||||
|
cmd.Println("netbird down")
|
||||||
}
|
}
|
||||||
cmd.Println("netbird down")
|
|
||||||
|
|
||||||
time.Sleep(1 * time.Second)
|
time.Sleep(1 * time.Second)
|
||||||
|
|
||||||
@@ -209,13 +213,15 @@ func runForDuration(cmd *cobra.Command, args []string) error {
|
|||||||
if _, err := client.SetSyncResponsePersistence(cmd.Context(), &proto.SetSyncResponsePersistenceRequest{
|
if _, err := client.SetSyncResponsePersistence(cmd.Context(), &proto.SetSyncResponsePersistenceRequest{
|
||||||
Enabled: true,
|
Enabled: true,
|
||||||
}); err != nil {
|
}); err != nil {
|
||||||
return fmt.Errorf("failed to enable sync response persistence: %v", status.Convert(err).Message())
|
cmd.PrintErrf("Failed to enable sync response persistence: %v\n", status.Convert(err).Message())
|
||||||
}
|
}
|
||||||
|
|
||||||
if _, err := client.Up(cmd.Context(), &proto.UpRequest{}); err != nil {
|
if _, err := client.Up(cmd.Context(), &proto.UpRequest{}); err != nil {
|
||||||
return fmt.Errorf("failed to up: %v", status.Convert(err).Message())
|
cmd.PrintErrf("Failed to bring service up: %v\n", status.Convert(err).Message())
|
||||||
|
} else {
|
||||||
|
needsRestoreUp = false
|
||||||
|
cmd.Println("netbird up")
|
||||||
}
|
}
|
||||||
cmd.Println("netbird up")
|
|
||||||
|
|
||||||
time.Sleep(3 * time.Second)
|
time.Sleep(3 * time.Second)
|
||||||
|
|
||||||
@@ -261,18 +267,28 @@ func runForDuration(cmd *cobra.Command, args []string) error {
|
|||||||
return fmt.Errorf("failed to bundle debug: %v", status.Convert(err).Message())
|
return fmt.Errorf("failed to bundle debug: %v", status.Convert(err).Message())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if needsRestoreUp {
|
||||||
|
if _, err := client.Up(cmd.Context(), &proto.UpRequest{}); err != nil {
|
||||||
|
cmd.PrintErrf("Failed to restore service up state: %v\n", status.Convert(err).Message())
|
||||||
|
} else {
|
||||||
|
cmd.Println("netbird up (restored)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if stateWasDown {
|
if stateWasDown {
|
||||||
if _, err := client.Down(cmd.Context(), &proto.DownRequest{}); err != nil {
|
if _, err := client.Down(cmd.Context(), &proto.DownRequest{}); err != nil {
|
||||||
return fmt.Errorf("failed to down: %v", status.Convert(err).Message())
|
cmd.PrintErrf("Failed to restore service down state: %v\n", status.Convert(err).Message())
|
||||||
|
} else {
|
||||||
|
cmd.Println("netbird down")
|
||||||
}
|
}
|
||||||
cmd.Println("netbird down")
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if !initialLevelTrace {
|
if !initialLevelTrace {
|
||||||
if _, err := client.SetLogLevel(cmd.Context(), &proto.SetLogLevelRequest{Level: initialLogLevel.GetLevel()}); err != nil {
|
if _, err := client.SetLogLevel(cmd.Context(), &proto.SetLogLevelRequest{Level: initialLogLevel.GetLevel()}); err != nil {
|
||||||
return fmt.Errorf("failed to restore log level: %v", status.Convert(err).Message())
|
cmd.PrintErrf("Failed to restore log level: %v\n", status.Convert(err).Message())
|
||||||
|
} else {
|
||||||
|
cmd.Println("Log level restored to", initialLogLevel.GetLevel())
|
||||||
}
|
}
|
||||||
cmd.Println("Log level restored to", initialLogLevel.GetLevel())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd.Printf("Local file:\n%s\n", resp.GetPath())
|
cmd.Printf("Local file:\n%s\n", resp.GetPath())
|
||||||
|
|||||||
287
client/cmd/expose.go
Normal file
287
client/cmd/expose.go
Normal file
@@ -0,0 +1,287 @@
|
|||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"os/signal"
|
||||||
|
"regexp"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"syscall"
|
||||||
|
|
||||||
|
log "github.com/sirupsen/logrus"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
"google.golang.org/grpc/status"
|
||||||
|
|
||||||
|
"github.com/netbirdio/netbird/client/internal/expose"
|
||||||
|
"github.com/netbirdio/netbird/client/proto"
|
||||||
|
"github.com/netbirdio/netbird/util"
|
||||||
|
)
|
||||||
|
|
||||||
|
var pinRegexp = regexp.MustCompile(`^\d{6}$`)
|
||||||
|
|
||||||
|
var (
|
||||||
|
exposePin string
|
||||||
|
exposePassword string
|
||||||
|
exposeUserGroups []string
|
||||||
|
exposeDomain string
|
||||||
|
exposeNamePrefix string
|
||||||
|
exposeProtocol string
|
||||||
|
exposeExternalPort uint16
|
||||||
|
)
|
||||||
|
|
||||||
|
var exposeCmd = &cobra.Command{
|
||||||
|
Use: "expose <port>",
|
||||||
|
Short: "Expose a local port via the NetBird reverse proxy",
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
Example: ` netbird expose --with-password safe-pass 8080
|
||||||
|
netbird expose --protocol tcp 5432
|
||||||
|
netbird expose --protocol tcp --with-external-port 5433 5432
|
||||||
|
netbird expose --protocol tls --with-custom-domain tls.example.com 4443`,
|
||||||
|
RunE: exposeFn,
|
||||||
|
}
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
exposeCmd.Flags().StringVar(&exposePin, "with-pin", "", "Protect the exposed service with a 6-digit PIN (e.g. --with-pin 123456)")
|
||||||
|
exposeCmd.Flags().StringVar(&exposePassword, "with-password", "", "Protect the exposed service with a password (e.g. --with-password my-secret)")
|
||||||
|
exposeCmd.Flags().StringSliceVar(&exposeUserGroups, "with-user-groups", nil, "Restrict access to specific user groups with SSO (e.g. --with-user-groups devops,Backend)")
|
||||||
|
exposeCmd.Flags().StringVar(&exposeDomain, "with-custom-domain", "", "Custom domain for the exposed service, must be configured to your account (e.g. --with-custom-domain myapp.example.com)")
|
||||||
|
exposeCmd.Flags().StringVar(&exposeNamePrefix, "with-name-prefix", "", "Prefix for the generated service name (e.g. --with-name-prefix my-app)")
|
||||||
|
exposeCmd.Flags().StringVar(&exposeProtocol, "protocol", "http", "Protocol to use: http, https, tcp, udp, or tls (e.g. --protocol tcp)")
|
||||||
|
exposeCmd.Flags().Uint16Var(&exposeExternalPort, "with-external-port", 0, "Public-facing external port on the proxy cluster (defaults to the target port for L4)")
|
||||||
|
}
|
||||||
|
|
||||||
|
// isClusterProtocol returns true for L4/TLS protocols that reject HTTP-style auth flags.
|
||||||
|
func isClusterProtocol(protocol string) bool {
|
||||||
|
switch strings.ToLower(protocol) {
|
||||||
|
case "tcp", "udp", "tls":
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// isPortBasedProtocol returns true for pure port-based protocols (TCP/UDP)
|
||||||
|
// where domain display doesn't apply. TLS uses SNI so it has a domain.
|
||||||
|
func isPortBasedProtocol(protocol string) bool {
|
||||||
|
switch strings.ToLower(protocol) {
|
||||||
|
case "tcp", "udp":
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// extractPort returns the port portion of a URL like "tcp://host:12345", or
|
||||||
|
// falls back to the given default formatted as a string.
|
||||||
|
func extractPort(serviceURL string, fallback uint16) string {
|
||||||
|
u := serviceURL
|
||||||
|
if idx := strings.Index(u, "://"); idx != -1 {
|
||||||
|
u = u[idx+3:]
|
||||||
|
}
|
||||||
|
if i := strings.LastIndex(u, ":"); i != -1 {
|
||||||
|
if p := u[i+1:]; p != "" {
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return strconv.FormatUint(uint64(fallback), 10)
|
||||||
|
}
|
||||||
|
|
||||||
|
// resolveExternalPort returns the effective external port, defaulting to the target port.
|
||||||
|
func resolveExternalPort(targetPort uint64) uint16 {
|
||||||
|
if exposeExternalPort != 0 {
|
||||||
|
return exposeExternalPort
|
||||||
|
}
|
||||||
|
return uint16(targetPort)
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateExposeFlags(cmd *cobra.Command, portStr string) (uint64, error) {
|
||||||
|
port, err := strconv.ParseUint(portStr, 10, 32)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("invalid port number: %s", portStr)
|
||||||
|
}
|
||||||
|
if port == 0 || port > 65535 {
|
||||||
|
return 0, fmt.Errorf("invalid port number: must be between 1 and 65535")
|
||||||
|
}
|
||||||
|
|
||||||
|
if !isProtocolValid(exposeProtocol) {
|
||||||
|
return 0, fmt.Errorf("unsupported protocol %q: must be http, https, tcp, udp, or tls", exposeProtocol)
|
||||||
|
}
|
||||||
|
|
||||||
|
if isClusterProtocol(exposeProtocol) {
|
||||||
|
if exposePin != "" || exposePassword != "" || len(exposeUserGroups) > 0 {
|
||||||
|
return 0, fmt.Errorf("auth flags (--with-pin, --with-password, --with-user-groups) are not supported for %s protocol", exposeProtocol)
|
||||||
|
}
|
||||||
|
} else if cmd.Flags().Changed("with-external-port") {
|
||||||
|
return 0, fmt.Errorf("--with-external-port is not supported for %s protocol", exposeProtocol)
|
||||||
|
}
|
||||||
|
|
||||||
|
if exposePin != "" && !pinRegexp.MatchString(exposePin) {
|
||||||
|
return 0, fmt.Errorf("invalid pin: must be exactly 6 digits")
|
||||||
|
}
|
||||||
|
|
||||||
|
if cmd.Flags().Changed("with-password") && exposePassword == "" {
|
||||||
|
return 0, fmt.Errorf("password cannot be empty")
|
||||||
|
}
|
||||||
|
|
||||||
|
if cmd.Flags().Changed("with-user-groups") && len(exposeUserGroups) == 0 {
|
||||||
|
return 0, fmt.Errorf("user groups cannot be empty")
|
||||||
|
}
|
||||||
|
|
||||||
|
return port, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func isProtocolValid(exposeProtocol string) bool {
|
||||||
|
switch strings.ToLower(exposeProtocol) {
|
||||||
|
case "http", "https", "tcp", "udp", "tls":
|
||||||
|
return true
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func exposeFn(cmd *cobra.Command, args []string) error {
|
||||||
|
SetFlagsFromEnvVars(rootCmd)
|
||||||
|
|
||||||
|
if err := util.InitLog(logLevel, util.LogConsole); err != nil {
|
||||||
|
log.Errorf("failed initializing log %v", err)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd.Root().SilenceUsage = false
|
||||||
|
|
||||||
|
port, err := validateExposeFlags(cmd, args[0])
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd.Root().SilenceUsage = true
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(cmd.Context())
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
sigCh := make(chan os.Signal, 1)
|
||||||
|
signal.Notify(sigCh, syscall.SIGINT, syscall.SIGTERM)
|
||||||
|
go func() {
|
||||||
|
<-sigCh
|
||||||
|
cancel()
|
||||||
|
}()
|
||||||
|
|
||||||
|
conn, err := DialClientGRPCServer(ctx, daemonAddr)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("connect to daemon: %w", err)
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
if err := conn.Close(); err != nil {
|
||||||
|
log.Debugf("failed to close daemon connection: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
client := proto.NewDaemonServiceClient(conn)
|
||||||
|
|
||||||
|
protocol, err := toExposeProtocol(exposeProtocol)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
req := &proto.ExposeServiceRequest{
|
||||||
|
Port: uint32(port),
|
||||||
|
Protocol: protocol,
|
||||||
|
Pin: exposePin,
|
||||||
|
Password: exposePassword,
|
||||||
|
UserGroups: exposeUserGroups,
|
||||||
|
Domain: exposeDomain,
|
||||||
|
NamePrefix: exposeNamePrefix,
|
||||||
|
}
|
||||||
|
if isClusterProtocol(exposeProtocol) {
|
||||||
|
req.ListenPort = uint32(resolveExternalPort(port))
|
||||||
|
}
|
||||||
|
|
||||||
|
stream, err := client.ExposeService(ctx, req)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("expose service: %v", status.Convert(err).Message())
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := handleExposeReady(cmd, stream, port); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return waitForExposeEvents(cmd, ctx, stream)
|
||||||
|
}
|
||||||
|
|
||||||
|
func toExposeProtocol(exposeProtocol string) (proto.ExposeProtocol, error) {
|
||||||
|
p, err := expose.ParseProtocolType(exposeProtocol)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("invalid protocol: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
switch p {
|
||||||
|
case expose.ProtocolHTTP:
|
||||||
|
return proto.ExposeProtocol_EXPOSE_HTTP, nil
|
||||||
|
case expose.ProtocolHTTPS:
|
||||||
|
return proto.ExposeProtocol_EXPOSE_HTTPS, nil
|
||||||
|
case expose.ProtocolTCP:
|
||||||
|
return proto.ExposeProtocol_EXPOSE_TCP, nil
|
||||||
|
case expose.ProtocolUDP:
|
||||||
|
return proto.ExposeProtocol_EXPOSE_UDP, nil
|
||||||
|
case expose.ProtocolTLS:
|
||||||
|
return proto.ExposeProtocol_EXPOSE_TLS, nil
|
||||||
|
default:
|
||||||
|
return 0, fmt.Errorf("unhandled protocol type: %d", p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleExposeReady(cmd *cobra.Command, stream proto.DaemonService_ExposeServiceClient, port uint64) error {
|
||||||
|
event, err := stream.Recv()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("receive expose event: %v", status.Convert(err).Message())
|
||||||
|
}
|
||||||
|
|
||||||
|
ready, ok := event.Event.(*proto.ExposeServiceEvent_Ready)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("unexpected expose event: %T", event.Event)
|
||||||
|
}
|
||||||
|
printExposeReady(cmd, ready.Ready, port)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func printExposeReady(cmd *cobra.Command, r *proto.ExposeServiceReady, port uint64) {
|
||||||
|
cmd.Println("Service exposed successfully!")
|
||||||
|
cmd.Printf(" Name: %s\n", r.ServiceName)
|
||||||
|
if r.ServiceUrl != "" {
|
||||||
|
cmd.Printf(" URL: %s\n", r.ServiceUrl)
|
||||||
|
}
|
||||||
|
if r.Domain != "" && !isPortBasedProtocol(exposeProtocol) {
|
||||||
|
cmd.Printf(" Domain: %s\n", r.Domain)
|
||||||
|
}
|
||||||
|
cmd.Printf(" Protocol: %s\n", exposeProtocol)
|
||||||
|
cmd.Printf(" Internal: %d\n", port)
|
||||||
|
if isClusterProtocol(exposeProtocol) {
|
||||||
|
cmd.Printf(" External: %s\n", extractPort(r.ServiceUrl, resolveExternalPort(port)))
|
||||||
|
}
|
||||||
|
if r.PortAutoAssigned && exposeExternalPort != 0 {
|
||||||
|
cmd.Printf("\n Note: requested port %d was reassigned\n", exposeExternalPort)
|
||||||
|
}
|
||||||
|
cmd.Println()
|
||||||
|
cmd.Println("Press Ctrl+C to stop exposing.")
|
||||||
|
}
|
||||||
|
|
||||||
|
func waitForExposeEvents(cmd *cobra.Command, ctx context.Context, stream proto.DaemonService_ExposeServiceClient) error {
|
||||||
|
for {
|
||||||
|
_, err := stream.Recv()
|
||||||
|
if err != nil {
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
cmd.Println("\nService stopped.")
|
||||||
|
//nolint:nilerr
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if errors.Is(err, io.EOF) {
|
||||||
|
return fmt.Errorf("connection to daemon closed unexpectedly")
|
||||||
|
}
|
||||||
|
return fmt.Errorf("stream error: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -22,6 +22,7 @@ import (
|
|||||||
"google.golang.org/grpc"
|
"google.golang.org/grpc"
|
||||||
"google.golang.org/grpc/credentials/insecure"
|
"google.golang.org/grpc/credentials/insecure"
|
||||||
|
|
||||||
|
daddr "github.com/netbirdio/netbird/client/internal/daemonaddr"
|
||||||
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -74,12 +75,22 @@ var (
|
|||||||
mtu uint16
|
mtu uint16
|
||||||
profilesDisabled bool
|
profilesDisabled bool
|
||||||
updateSettingsDisabled bool
|
updateSettingsDisabled bool
|
||||||
|
networksDisabled bool
|
||||||
|
|
||||||
rootCmd = &cobra.Command{
|
rootCmd = &cobra.Command{
|
||||||
Use: "netbird",
|
Use: "netbird",
|
||||||
Short: "",
|
Short: "",
|
||||||
Long: "",
|
Long: "",
|
||||||
SilenceUsage: true,
|
SilenceUsage: true,
|
||||||
|
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
SetFlagsFromEnvVars(cmd.Root())
|
||||||
|
|
||||||
|
// Don't resolve for service commands — they create the socket, not connect to it.
|
||||||
|
if !isServiceCmd(cmd) {
|
||||||
|
daemonAddr = daddr.ResolveUnixDaemonAddr(daemonAddr)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
},
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -144,6 +155,7 @@ func init() {
|
|||||||
rootCmd.AddCommand(forwardingRulesCmd)
|
rootCmd.AddCommand(forwardingRulesCmd)
|
||||||
rootCmd.AddCommand(debugCmd)
|
rootCmd.AddCommand(debugCmd)
|
||||||
rootCmd.AddCommand(profileCmd)
|
rootCmd.AddCommand(profileCmd)
|
||||||
|
rootCmd.AddCommand(exposeCmd)
|
||||||
|
|
||||||
networksCMD.AddCommand(routesListCmd)
|
networksCMD.AddCommand(routesListCmd)
|
||||||
networksCMD.AddCommand(routesSelectCmd, routesDeselectCmd)
|
networksCMD.AddCommand(routesSelectCmd, routesDeselectCmd)
|
||||||
@@ -385,7 +397,6 @@ func migrateToNetbird(oldPath, newPath string) bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func getClient(cmd *cobra.Command) (*grpc.ClientConn, error) {
|
func getClient(cmd *cobra.Command) (*grpc.ClientConn, error) {
|
||||||
SetFlagsFromEnvVars(rootCmd)
|
|
||||||
cmd.SetOut(cmd.OutOrStdout())
|
cmd.SetOut(cmd.OutOrStdout())
|
||||||
|
|
||||||
conn, err := DialClientGRPCServer(cmd.Context(), daemonAddr)
|
conn, err := DialClientGRPCServer(cmd.Context(), daemonAddr)
|
||||||
@@ -398,3 +409,13 @@ func getClient(cmd *cobra.Command) (*grpc.ClientConn, error) {
|
|||||||
|
|
||||||
return conn, nil
|
return conn, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// isServiceCmd returns true if cmd is the "service" command or a child of it.
|
||||||
|
func isServiceCmd(cmd *cobra.Command) bool {
|
||||||
|
for c := cmd; c != nil; c = c.Parent() {
|
||||||
|
if c.Name() == "service" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|||||||
@@ -41,13 +41,16 @@ func init() {
|
|||||||
defaultServiceName = "Netbird"
|
defaultServiceName = "Netbird"
|
||||||
}
|
}
|
||||||
|
|
||||||
serviceCmd.AddCommand(runCmd, startCmd, stopCmd, restartCmd, svcStatusCmd, installCmd, uninstallCmd, reconfigureCmd)
|
serviceCmd.AddCommand(runCmd, startCmd, stopCmd, restartCmd, svcStatusCmd, installCmd, uninstallCmd, reconfigureCmd, resetParamsCmd)
|
||||||
serviceCmd.PersistentFlags().BoolVar(&profilesDisabled, "disable-profiles", false, "Disables profiles feature. If enabled, the client will not be able to change or edit any profile. To persist this setting, use: netbird service install --disable-profiles")
|
serviceCmd.PersistentFlags().BoolVar(&profilesDisabled, "disable-profiles", false, "Disables profiles feature. If enabled, the client will not be able to change or edit any profile. To persist this setting, use: netbird service install --disable-profiles")
|
||||||
serviceCmd.PersistentFlags().BoolVar(&updateSettingsDisabled, "disable-update-settings", false, "Disables update settings feature. If enabled, the client will not be able to change or edit any settings. To persist this setting, use: netbird service install --disable-update-settings")
|
serviceCmd.PersistentFlags().BoolVar(&updateSettingsDisabled, "disable-update-settings", false, "Disables update settings feature. If enabled, the client will not be able to change or edit any settings. To persist this setting, use: netbird service install --disable-update-settings")
|
||||||
|
serviceCmd.PersistentFlags().BoolVar(&networksDisabled, "disable-networks", false, "Disables network selection. If enabled, the client will not allow listing, selecting, or deselecting networks. To persist, use: netbird service install --disable-networks")
|
||||||
|
|
||||||
rootCmd.PersistentFlags().StringVarP(&serviceName, "service", "s", defaultServiceName, "Netbird system service name")
|
rootCmd.PersistentFlags().StringVarP(&serviceName, "service", "s", defaultServiceName, "Netbird system service name")
|
||||||
serviceEnvDesc := `Sets extra environment variables for the service. ` +
|
serviceEnvDesc := `Sets extra environment variables for the service. ` +
|
||||||
`You can specify a comma-separated list of KEY=VALUE pairs. ` +
|
`You can specify a comma-separated list of KEY=VALUE pairs. ` +
|
||||||
|
`New keys are merged with previously saved env vars; existing keys are overwritten. ` +
|
||||||
|
`Use --service-env "" to clear all saved env vars. ` +
|
||||||
`E.g. --service-env NB_LOG_LEVEL=debug,CUSTOM_VAR=value`
|
`E.g. --service-env NB_LOG_LEVEL=debug,CUSTOM_VAR=value`
|
||||||
|
|
||||||
installCmd.Flags().StringSliceVar(&serviceEnvVars, "service-env", nil, serviceEnvDesc)
|
installCmd.Flags().StringSliceVar(&serviceEnvVars, "service-env", nil, serviceEnvDesc)
|
||||||
|
|||||||
@@ -61,7 +61,7 @@ func (p *program) Start(svc service.Service) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
serverInstance := server.New(p.ctx, util.FindFirstLogPath(logFiles), configPath, profilesDisabled, updateSettingsDisabled)
|
serverInstance := server.New(p.ctx, util.FindFirstLogPath(logFiles), configPath, profilesDisabled, updateSettingsDisabled, networksDisabled)
|
||||||
if err := serverInstance.Start(); err != nil {
|
if err := serverInstance.Start(); err != nil {
|
||||||
log.Fatalf("failed to start daemon: %v", err)
|
log.Fatalf("failed to start daemon: %v", err)
|
||||||
}
|
}
|
||||||
@@ -103,7 +103,7 @@ func (p *program) Stop(srv service.Service) error {
|
|||||||
|
|
||||||
// Common setup for service control commands
|
// Common setup for service control commands
|
||||||
func setupServiceControlCommand(cmd *cobra.Command, ctx context.Context, cancel context.CancelFunc) (service.Service, error) {
|
func setupServiceControlCommand(cmd *cobra.Command, ctx context.Context, cancel context.CancelFunc) (service.Service, error) {
|
||||||
SetFlagsFromEnvVars(rootCmd)
|
// rootCmd env vars are already applied by PersistentPreRunE.
|
||||||
SetFlagsFromEnvVars(serviceCmd)
|
SetFlagsFromEnvVars(serviceCmd)
|
||||||
|
|
||||||
cmd.SetOut(cmd.OutOrStdout())
|
cmd.SetOut(cmd.OutOrStdout())
|
||||||
|
|||||||
@@ -59,6 +59,10 @@ func buildServiceArguments() []string {
|
|||||||
args = append(args, "--disable-update-settings")
|
args = append(args, "--disable-update-settings")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if networksDisabled {
|
||||||
|
args = append(args, "--disable-networks")
|
||||||
|
}
|
||||||
|
|
||||||
return args
|
return args
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -119,6 +123,10 @@ var installCmd = &cobra.Command{
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := loadAndApplyServiceParams(cmd); err != nil {
|
||||||
|
cmd.PrintErrf("Warning: failed to load saved service params: %v\n", err)
|
||||||
|
}
|
||||||
|
|
||||||
svcConfig, err := createServiceConfigForInstall()
|
svcConfig, err := createServiceConfigForInstall()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -136,6 +144,10 @@ var installCmd = &cobra.Command{
|
|||||||
return fmt.Errorf("install service: %w", err)
|
return fmt.Errorf("install service: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := saveServiceParams(currentServiceParams()); err != nil {
|
||||||
|
cmd.PrintErrf("Warning: failed to save service params: %v\n", err)
|
||||||
|
}
|
||||||
|
|
||||||
cmd.Println("NetBird service has been installed")
|
cmd.Println("NetBird service has been installed")
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
@@ -187,6 +199,10 @@ This command will temporarily stop the service, update its configuration, and re
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := loadAndApplyServiceParams(cmd); err != nil {
|
||||||
|
cmd.PrintErrf("Warning: failed to load saved service params: %v\n", err)
|
||||||
|
}
|
||||||
|
|
||||||
wasRunning, err := isServiceRunning()
|
wasRunning, err := isServiceRunning()
|
||||||
if err != nil && !errors.Is(err, ErrGetServiceStatus) {
|
if err != nil && !errors.Is(err, ErrGetServiceStatus) {
|
||||||
return fmt.Errorf("check service status: %w", err)
|
return fmt.Errorf("check service status: %w", err)
|
||||||
@@ -222,6 +238,10 @@ This command will temporarily stop the service, update its configuration, and re
|
|||||||
return fmt.Errorf("install service with new config: %w", err)
|
return fmt.Errorf("install service with new config: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := saveServiceParams(currentServiceParams()); err != nil {
|
||||||
|
cmd.PrintErrf("Warning: failed to save service params: %v\n", err)
|
||||||
|
}
|
||||||
|
|
||||||
if wasRunning {
|
if wasRunning {
|
||||||
cmd.Println("Starting NetBird service...")
|
cmd.Println("Starting NetBird service...")
|
||||||
if err := s.Start(); err != nil {
|
if err := s.Start(); err != nil {
|
||||||
|
|||||||
218
client/cmd/service_params.go
Normal file
218
client/cmd/service_params.go
Normal file
@@ -0,0 +1,218 @@
|
|||||||
|
//go:build !ios && !android
|
||||||
|
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"maps"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"github.com/netbirdio/netbird/client/configs"
|
||||||
|
"github.com/netbirdio/netbird/util"
|
||||||
|
)
|
||||||
|
|
||||||
|
const serviceParamsFile = "service.json"
|
||||||
|
|
||||||
|
// serviceParams holds install-time service parameters that persist across
|
||||||
|
// uninstall/reinstall cycles. Saved to <stateDir>/service.json.
|
||||||
|
type serviceParams struct {
|
||||||
|
LogLevel string `json:"log_level"`
|
||||||
|
DaemonAddr string `json:"daemon_addr"`
|
||||||
|
ManagementURL string `json:"management_url,omitempty"`
|
||||||
|
ConfigPath string `json:"config_path,omitempty"`
|
||||||
|
LogFiles []string `json:"log_files,omitempty"`
|
||||||
|
DisableProfiles bool `json:"disable_profiles,omitempty"`
|
||||||
|
DisableUpdateSettings bool `json:"disable_update_settings,omitempty"`
|
||||||
|
DisableNetworks bool `json:"disable_networks,omitempty"`
|
||||||
|
ServiceEnvVars map[string]string `json:"service_env_vars,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// serviceParamsPath returns the path to the service params file.
|
||||||
|
func serviceParamsPath() string {
|
||||||
|
return filepath.Join(configs.StateDir, serviceParamsFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
// loadServiceParams reads saved service parameters from disk.
|
||||||
|
// Returns nil with no error if the file does not exist.
|
||||||
|
func loadServiceParams() (*serviceParams, error) {
|
||||||
|
path := serviceParamsPath()
|
||||||
|
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return nil, nil //nolint:nilnil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("read service params %s: %w", path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var params serviceParams
|
||||||
|
if err := json.Unmarshal(data, ¶ms); err != nil {
|
||||||
|
return nil, fmt.Errorf("parse service params %s: %w", path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return ¶ms, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// saveServiceParams writes current service parameters to disk atomically
|
||||||
|
// with restricted permissions.
|
||||||
|
func saveServiceParams(params *serviceParams) error {
|
||||||
|
path := serviceParamsPath()
|
||||||
|
if err := util.WriteJsonWithRestrictedPermission(context.Background(), path, params); err != nil {
|
||||||
|
return fmt.Errorf("save service params: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// currentServiceParams captures the current state of all package-level
|
||||||
|
// variables into a serviceParams struct.
|
||||||
|
func currentServiceParams() *serviceParams {
|
||||||
|
params := &serviceParams{
|
||||||
|
LogLevel: logLevel,
|
||||||
|
DaemonAddr: daemonAddr,
|
||||||
|
ManagementURL: managementURL,
|
||||||
|
ConfigPath: configPath,
|
||||||
|
LogFiles: logFiles,
|
||||||
|
DisableProfiles: profilesDisabled,
|
||||||
|
DisableUpdateSettings: updateSettingsDisabled,
|
||||||
|
DisableNetworks: networksDisabled,
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(serviceEnvVars) > 0 {
|
||||||
|
parsed, err := parseServiceEnvVars(serviceEnvVars)
|
||||||
|
if err == nil {
|
||||||
|
params.ServiceEnvVars = parsed
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return params
|
||||||
|
}
|
||||||
|
|
||||||
|
// loadAndApplyServiceParams loads saved params from disk and applies them
|
||||||
|
// to any flags that were not explicitly set.
|
||||||
|
func loadAndApplyServiceParams(cmd *cobra.Command) error {
|
||||||
|
params, err := loadServiceParams()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
applyServiceParams(cmd, params)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// applyServiceParams merges saved parameters into package-level variables
|
||||||
|
// for any flag that was not explicitly set by the user (via CLI or env var).
|
||||||
|
// Flags that were Changed() are left untouched.
|
||||||
|
func applyServiceParams(cmd *cobra.Command, params *serviceParams) {
|
||||||
|
if params == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// For fields with non-empty defaults (log-level, daemon-addr), keep the
|
||||||
|
// != "" guard so that an older service.json missing the field doesn't
|
||||||
|
// clobber the default with an empty string.
|
||||||
|
if !rootCmd.PersistentFlags().Changed("log-level") && params.LogLevel != "" {
|
||||||
|
logLevel = params.LogLevel
|
||||||
|
}
|
||||||
|
|
||||||
|
if !rootCmd.PersistentFlags().Changed("daemon-addr") && params.DaemonAddr != "" {
|
||||||
|
daemonAddr = params.DaemonAddr
|
||||||
|
}
|
||||||
|
|
||||||
|
// For optional fields where empty means "use default", always apply so
|
||||||
|
// that an explicit clear (--management-url "") persists across reinstalls.
|
||||||
|
if !rootCmd.PersistentFlags().Changed("management-url") {
|
||||||
|
managementURL = params.ManagementURL
|
||||||
|
}
|
||||||
|
|
||||||
|
if !rootCmd.PersistentFlags().Changed("config") {
|
||||||
|
configPath = params.ConfigPath
|
||||||
|
}
|
||||||
|
|
||||||
|
if !rootCmd.PersistentFlags().Changed("log-file") {
|
||||||
|
logFiles = params.LogFiles
|
||||||
|
}
|
||||||
|
|
||||||
|
if !serviceCmd.PersistentFlags().Changed("disable-profiles") {
|
||||||
|
profilesDisabled = params.DisableProfiles
|
||||||
|
}
|
||||||
|
|
||||||
|
if !serviceCmd.PersistentFlags().Changed("disable-update-settings") {
|
||||||
|
updateSettingsDisabled = params.DisableUpdateSettings
|
||||||
|
}
|
||||||
|
|
||||||
|
if !serviceCmd.PersistentFlags().Changed("disable-networks") {
|
||||||
|
networksDisabled = params.DisableNetworks
|
||||||
|
}
|
||||||
|
|
||||||
|
applyServiceEnvParams(cmd, params)
|
||||||
|
}
|
||||||
|
|
||||||
|
// applyServiceEnvParams merges saved service environment variables.
|
||||||
|
// If --service-env was explicitly set with values, explicit values win on key
|
||||||
|
// conflict but saved keys not in the explicit set are carried over.
|
||||||
|
// If --service-env was explicitly set to empty, all saved env vars are cleared.
|
||||||
|
// If --service-env was not set, saved env vars are used entirely.
|
||||||
|
func applyServiceEnvParams(cmd *cobra.Command, params *serviceParams) {
|
||||||
|
if !cmd.Flags().Changed("service-env") {
|
||||||
|
if len(params.ServiceEnvVars) > 0 {
|
||||||
|
// No explicit env vars: rebuild serviceEnvVars from saved params.
|
||||||
|
serviceEnvVars = envMapToSlice(params.ServiceEnvVars)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Flag was explicitly set: parse what the user provided.
|
||||||
|
explicit, err := parseServiceEnvVars(serviceEnvVars)
|
||||||
|
if err != nil {
|
||||||
|
cmd.PrintErrf("Warning: parse explicit service env vars for merge: %v\n", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the user passed an empty value (e.g. --service-env ""), clear all
|
||||||
|
// saved env vars rather than merging.
|
||||||
|
if len(explicit) == 0 {
|
||||||
|
serviceEnvVars = nil
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(params.ServiceEnvVars) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Merge saved values underneath explicit ones.
|
||||||
|
merged := make(map[string]string, len(params.ServiceEnvVars)+len(explicit))
|
||||||
|
maps.Copy(merged, params.ServiceEnvVars)
|
||||||
|
maps.Copy(merged, explicit) // explicit wins on conflict
|
||||||
|
serviceEnvVars = envMapToSlice(merged)
|
||||||
|
}
|
||||||
|
|
||||||
|
var resetParamsCmd = &cobra.Command{
|
||||||
|
Use: "reset-params",
|
||||||
|
Short: "Remove saved service install parameters",
|
||||||
|
Long: "Removes the saved service.json file so the next install uses default parameters.",
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
path := serviceParamsPath()
|
||||||
|
if err := os.Remove(path); err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
cmd.Println("No saved service parameters found")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("remove service params: %w", err)
|
||||||
|
}
|
||||||
|
cmd.Printf("Removed saved service parameters (%s)\n", path)
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
// envMapToSlice converts a map of env vars to a KEY=VALUE slice.
|
||||||
|
func envMapToSlice(m map[string]string) []string {
|
||||||
|
s := make([]string, 0, len(m))
|
||||||
|
for k, v := range m {
|
||||||
|
s = append(s, k+"="+v)
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
559
client/cmd/service_params_test.go
Normal file
559
client/cmd/service_params_test.go
Normal file
@@ -0,0 +1,559 @@
|
|||||||
|
//go:build !ios && !android
|
||||||
|
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"go/ast"
|
||||||
|
"go/parser"
|
||||||
|
"go/token"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
"github.com/spf13/pflag"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/netbirdio/netbird/client/configs"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestServiceParamsPath(t *testing.T) {
|
||||||
|
original := configs.StateDir
|
||||||
|
t.Cleanup(func() { configs.StateDir = original })
|
||||||
|
|
||||||
|
configs.StateDir = "/var/lib/netbird"
|
||||||
|
assert.Equal(t, filepath.Join("/var/lib/netbird", "service.json"), serviceParamsPath())
|
||||||
|
|
||||||
|
configs.StateDir = "/custom/state"
|
||||||
|
assert.Equal(t, filepath.Join("/custom/state", "service.json"), serviceParamsPath())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSaveAndLoadServiceParams(t *testing.T) {
|
||||||
|
tmpDir := t.TempDir()
|
||||||
|
|
||||||
|
original := configs.StateDir
|
||||||
|
t.Cleanup(func() { configs.StateDir = original })
|
||||||
|
configs.StateDir = tmpDir
|
||||||
|
|
||||||
|
params := &serviceParams{
|
||||||
|
LogLevel: "debug",
|
||||||
|
DaemonAddr: "unix:///var/run/netbird.sock",
|
||||||
|
ManagementURL: "https://my.server.com",
|
||||||
|
ConfigPath: "/etc/netbird/config.json",
|
||||||
|
LogFiles: []string{"/var/log/netbird/client.log", "console"},
|
||||||
|
DisableProfiles: true,
|
||||||
|
DisableUpdateSettings: false,
|
||||||
|
ServiceEnvVars: map[string]string{"NB_LOG_FORMAT": "json", "CUSTOM": "val"},
|
||||||
|
}
|
||||||
|
|
||||||
|
err := saveServiceParams(params)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Verify the file exists and is valid JSON.
|
||||||
|
data, err := os.ReadFile(filepath.Join(tmpDir, "service.json"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.True(t, json.Valid(data))
|
||||||
|
|
||||||
|
loaded, err := loadServiceParams()
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotNil(t, loaded)
|
||||||
|
|
||||||
|
assert.Equal(t, params.LogLevel, loaded.LogLevel)
|
||||||
|
assert.Equal(t, params.DaemonAddr, loaded.DaemonAddr)
|
||||||
|
assert.Equal(t, params.ManagementURL, loaded.ManagementURL)
|
||||||
|
assert.Equal(t, params.ConfigPath, loaded.ConfigPath)
|
||||||
|
assert.Equal(t, params.LogFiles, loaded.LogFiles)
|
||||||
|
assert.Equal(t, params.DisableProfiles, loaded.DisableProfiles)
|
||||||
|
assert.Equal(t, params.DisableUpdateSettings, loaded.DisableUpdateSettings)
|
||||||
|
assert.Equal(t, params.ServiceEnvVars, loaded.ServiceEnvVars)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadServiceParams_FileNotExists(t *testing.T) {
|
||||||
|
tmpDir := t.TempDir()
|
||||||
|
|
||||||
|
original := configs.StateDir
|
||||||
|
t.Cleanup(func() { configs.StateDir = original })
|
||||||
|
configs.StateDir = tmpDir
|
||||||
|
|
||||||
|
params, err := loadServiceParams()
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Nil(t, params)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadServiceParams_InvalidJSON(t *testing.T) {
|
||||||
|
tmpDir := t.TempDir()
|
||||||
|
|
||||||
|
original := configs.StateDir
|
||||||
|
t.Cleanup(func() { configs.StateDir = original })
|
||||||
|
configs.StateDir = tmpDir
|
||||||
|
|
||||||
|
err := os.WriteFile(filepath.Join(tmpDir, "service.json"), []byte("not json"), 0600)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
params, err := loadServiceParams()
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.Nil(t, params)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCurrentServiceParams(t *testing.T) {
|
||||||
|
origLogLevel := logLevel
|
||||||
|
origDaemonAddr := daemonAddr
|
||||||
|
origManagementURL := managementURL
|
||||||
|
origConfigPath := configPath
|
||||||
|
origLogFiles := logFiles
|
||||||
|
origProfilesDisabled := profilesDisabled
|
||||||
|
origUpdateSettingsDisabled := updateSettingsDisabled
|
||||||
|
origServiceEnvVars := serviceEnvVars
|
||||||
|
t.Cleanup(func() {
|
||||||
|
logLevel = origLogLevel
|
||||||
|
daemonAddr = origDaemonAddr
|
||||||
|
managementURL = origManagementURL
|
||||||
|
configPath = origConfigPath
|
||||||
|
logFiles = origLogFiles
|
||||||
|
profilesDisabled = origProfilesDisabled
|
||||||
|
updateSettingsDisabled = origUpdateSettingsDisabled
|
||||||
|
serviceEnvVars = origServiceEnvVars
|
||||||
|
})
|
||||||
|
|
||||||
|
logLevel = "trace"
|
||||||
|
daemonAddr = "tcp://127.0.0.1:9999"
|
||||||
|
managementURL = "https://mgmt.example.com"
|
||||||
|
configPath = "/tmp/test-config.json"
|
||||||
|
logFiles = []string{"/tmp/test.log"}
|
||||||
|
profilesDisabled = true
|
||||||
|
updateSettingsDisabled = true
|
||||||
|
serviceEnvVars = []string{"FOO=bar", "BAZ=qux"}
|
||||||
|
|
||||||
|
params := currentServiceParams()
|
||||||
|
|
||||||
|
assert.Equal(t, "trace", params.LogLevel)
|
||||||
|
assert.Equal(t, "tcp://127.0.0.1:9999", params.DaemonAddr)
|
||||||
|
assert.Equal(t, "https://mgmt.example.com", params.ManagementURL)
|
||||||
|
assert.Equal(t, "/tmp/test-config.json", params.ConfigPath)
|
||||||
|
assert.Equal(t, []string{"/tmp/test.log"}, params.LogFiles)
|
||||||
|
assert.True(t, params.DisableProfiles)
|
||||||
|
assert.True(t, params.DisableUpdateSettings)
|
||||||
|
assert.Equal(t, map[string]string{"FOO": "bar", "BAZ": "qux"}, params.ServiceEnvVars)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyServiceParams_OnlyUnchangedFlags(t *testing.T) {
|
||||||
|
origLogLevel := logLevel
|
||||||
|
origDaemonAddr := daemonAddr
|
||||||
|
origManagementURL := managementURL
|
||||||
|
origConfigPath := configPath
|
||||||
|
origLogFiles := logFiles
|
||||||
|
origProfilesDisabled := profilesDisabled
|
||||||
|
origUpdateSettingsDisabled := updateSettingsDisabled
|
||||||
|
origServiceEnvVars := serviceEnvVars
|
||||||
|
t.Cleanup(func() {
|
||||||
|
logLevel = origLogLevel
|
||||||
|
daemonAddr = origDaemonAddr
|
||||||
|
managementURL = origManagementURL
|
||||||
|
configPath = origConfigPath
|
||||||
|
logFiles = origLogFiles
|
||||||
|
profilesDisabled = origProfilesDisabled
|
||||||
|
updateSettingsDisabled = origUpdateSettingsDisabled
|
||||||
|
serviceEnvVars = origServiceEnvVars
|
||||||
|
})
|
||||||
|
|
||||||
|
// Reset all flags to defaults.
|
||||||
|
logLevel = "info"
|
||||||
|
daemonAddr = "unix:///var/run/netbird.sock"
|
||||||
|
managementURL = ""
|
||||||
|
configPath = "/etc/netbird/config.json"
|
||||||
|
logFiles = []string{"/var/log/netbird/client.log"}
|
||||||
|
profilesDisabled = false
|
||||||
|
updateSettingsDisabled = false
|
||||||
|
serviceEnvVars = nil
|
||||||
|
|
||||||
|
// Reset Changed state on all relevant flags.
|
||||||
|
rootCmd.PersistentFlags().VisitAll(func(f *pflag.Flag) {
|
||||||
|
f.Changed = false
|
||||||
|
})
|
||||||
|
serviceCmd.PersistentFlags().VisitAll(func(f *pflag.Flag) {
|
||||||
|
f.Changed = false
|
||||||
|
})
|
||||||
|
|
||||||
|
// Simulate user explicitly setting --log-level via CLI.
|
||||||
|
logLevel = "warn"
|
||||||
|
require.NoError(t, rootCmd.PersistentFlags().Set("log-level", "warn"))
|
||||||
|
|
||||||
|
saved := &serviceParams{
|
||||||
|
LogLevel: "debug",
|
||||||
|
DaemonAddr: "tcp://127.0.0.1:5555",
|
||||||
|
ManagementURL: "https://saved.example.com",
|
||||||
|
ConfigPath: "/saved/config.json",
|
||||||
|
LogFiles: []string{"/saved/client.log"},
|
||||||
|
DisableProfiles: true,
|
||||||
|
DisableUpdateSettings: true,
|
||||||
|
ServiceEnvVars: map[string]string{"SAVED_KEY": "saved_val"},
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd := &cobra.Command{}
|
||||||
|
cmd.Flags().StringSlice("service-env", nil, "")
|
||||||
|
applyServiceParams(cmd, saved)
|
||||||
|
|
||||||
|
// log-level was Changed, so it should keep "warn", not use saved "debug".
|
||||||
|
assert.Equal(t, "warn", logLevel)
|
||||||
|
|
||||||
|
// All other fields were not Changed, so they should use saved values.
|
||||||
|
assert.Equal(t, "tcp://127.0.0.1:5555", daemonAddr)
|
||||||
|
assert.Equal(t, "https://saved.example.com", managementURL)
|
||||||
|
assert.Equal(t, "/saved/config.json", configPath)
|
||||||
|
assert.Equal(t, []string{"/saved/client.log"}, logFiles)
|
||||||
|
assert.True(t, profilesDisabled)
|
||||||
|
assert.True(t, updateSettingsDisabled)
|
||||||
|
assert.Equal(t, []string{"SAVED_KEY=saved_val"}, serviceEnvVars)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyServiceParams_BooleanRevertToFalse(t *testing.T) {
|
||||||
|
origProfilesDisabled := profilesDisabled
|
||||||
|
origUpdateSettingsDisabled := updateSettingsDisabled
|
||||||
|
t.Cleanup(func() {
|
||||||
|
profilesDisabled = origProfilesDisabled
|
||||||
|
updateSettingsDisabled = origUpdateSettingsDisabled
|
||||||
|
})
|
||||||
|
|
||||||
|
// Simulate current state where booleans are true (e.g. set by previous install).
|
||||||
|
profilesDisabled = true
|
||||||
|
updateSettingsDisabled = true
|
||||||
|
|
||||||
|
// Reset Changed state so flags appear unset.
|
||||||
|
serviceCmd.PersistentFlags().VisitAll(func(f *pflag.Flag) {
|
||||||
|
f.Changed = false
|
||||||
|
})
|
||||||
|
|
||||||
|
// Saved params have both as false.
|
||||||
|
saved := &serviceParams{
|
||||||
|
DisableProfiles: false,
|
||||||
|
DisableUpdateSettings: false,
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd := &cobra.Command{}
|
||||||
|
cmd.Flags().StringSlice("service-env", nil, "")
|
||||||
|
applyServiceParams(cmd, saved)
|
||||||
|
|
||||||
|
assert.False(t, profilesDisabled, "saved false should override current true")
|
||||||
|
assert.False(t, updateSettingsDisabled, "saved false should override current true")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyServiceParams_ClearManagementURL(t *testing.T) {
|
||||||
|
origManagementURL := managementURL
|
||||||
|
t.Cleanup(func() { managementURL = origManagementURL })
|
||||||
|
|
||||||
|
managementURL = "https://leftover.example.com"
|
||||||
|
|
||||||
|
// Simulate saved params where management URL was explicitly cleared.
|
||||||
|
saved := &serviceParams{
|
||||||
|
LogLevel: "info",
|
||||||
|
DaemonAddr: "unix:///var/run/netbird.sock",
|
||||||
|
// ManagementURL intentionally empty: was cleared with --management-url "".
|
||||||
|
}
|
||||||
|
|
||||||
|
rootCmd.PersistentFlags().VisitAll(func(f *pflag.Flag) {
|
||||||
|
f.Changed = false
|
||||||
|
})
|
||||||
|
|
||||||
|
cmd := &cobra.Command{}
|
||||||
|
cmd.Flags().StringSlice("service-env", nil, "")
|
||||||
|
applyServiceParams(cmd, saved)
|
||||||
|
|
||||||
|
assert.Equal(t, "", managementURL, "saved empty management URL should clear the current value")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyServiceParams_NilParams(t *testing.T) {
|
||||||
|
origLogLevel := logLevel
|
||||||
|
t.Cleanup(func() { logLevel = origLogLevel })
|
||||||
|
|
||||||
|
logLevel = "info"
|
||||||
|
cmd := &cobra.Command{}
|
||||||
|
cmd.Flags().StringSlice("service-env", nil, "")
|
||||||
|
|
||||||
|
// Should be a no-op.
|
||||||
|
applyServiceParams(cmd, nil)
|
||||||
|
assert.Equal(t, "info", logLevel)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyServiceEnvParams_MergeExplicitAndSaved(t *testing.T) {
|
||||||
|
origServiceEnvVars := serviceEnvVars
|
||||||
|
t.Cleanup(func() { serviceEnvVars = origServiceEnvVars })
|
||||||
|
|
||||||
|
// Set up a command with --service-env marked as Changed.
|
||||||
|
cmd := &cobra.Command{}
|
||||||
|
cmd.Flags().StringSlice("service-env", nil, "")
|
||||||
|
require.NoError(t, cmd.Flags().Set("service-env", "EXPLICIT=yes,OVERLAP=explicit"))
|
||||||
|
|
||||||
|
serviceEnvVars = []string{"EXPLICIT=yes", "OVERLAP=explicit"}
|
||||||
|
|
||||||
|
saved := &serviceParams{
|
||||||
|
ServiceEnvVars: map[string]string{
|
||||||
|
"SAVED": "val",
|
||||||
|
"OVERLAP": "saved",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
applyServiceEnvParams(cmd, saved)
|
||||||
|
|
||||||
|
// Parse result for easier assertion.
|
||||||
|
result, err := parseServiceEnvVars(serviceEnvVars)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
assert.Equal(t, "yes", result["EXPLICIT"])
|
||||||
|
assert.Equal(t, "val", result["SAVED"])
|
||||||
|
// Explicit wins on conflict.
|
||||||
|
assert.Equal(t, "explicit", result["OVERLAP"])
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyServiceEnvParams_NotChanged(t *testing.T) {
|
||||||
|
origServiceEnvVars := serviceEnvVars
|
||||||
|
t.Cleanup(func() { serviceEnvVars = origServiceEnvVars })
|
||||||
|
|
||||||
|
serviceEnvVars = nil
|
||||||
|
|
||||||
|
cmd := &cobra.Command{}
|
||||||
|
cmd.Flags().StringSlice("service-env", nil, "")
|
||||||
|
|
||||||
|
saved := &serviceParams{
|
||||||
|
ServiceEnvVars: map[string]string{"FROM_SAVED": "val"},
|
||||||
|
}
|
||||||
|
|
||||||
|
applyServiceEnvParams(cmd, saved)
|
||||||
|
|
||||||
|
result, err := parseServiceEnvVars(serviceEnvVars)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, map[string]string{"FROM_SAVED": "val"}, result)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyServiceEnvParams_ExplicitEmptyClears(t *testing.T) {
|
||||||
|
origServiceEnvVars := serviceEnvVars
|
||||||
|
t.Cleanup(func() { serviceEnvVars = origServiceEnvVars })
|
||||||
|
|
||||||
|
// Simulate --service-env "" which produces [""] in the slice.
|
||||||
|
serviceEnvVars = []string{""}
|
||||||
|
|
||||||
|
cmd := &cobra.Command{}
|
||||||
|
cmd.Flags().StringSlice("service-env", nil, "")
|
||||||
|
require.NoError(t, cmd.Flags().Set("service-env", ""))
|
||||||
|
|
||||||
|
saved := &serviceParams{
|
||||||
|
ServiceEnvVars: map[string]string{"OLD_VAR": "should_be_cleared"},
|
||||||
|
}
|
||||||
|
|
||||||
|
applyServiceEnvParams(cmd, saved)
|
||||||
|
|
||||||
|
assert.Nil(t, serviceEnvVars, "explicit empty --service-env should clear all saved env vars")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCurrentServiceParams_EmptyEnvVarsAfterParse(t *testing.T) {
|
||||||
|
origServiceEnvVars := serviceEnvVars
|
||||||
|
t.Cleanup(func() { serviceEnvVars = origServiceEnvVars })
|
||||||
|
|
||||||
|
// Simulate --service-env "" which produces [""] in the slice.
|
||||||
|
serviceEnvVars = []string{""}
|
||||||
|
|
||||||
|
params := currentServiceParams()
|
||||||
|
|
||||||
|
// After parsing, the empty string is skipped, resulting in an empty map.
|
||||||
|
// The map should still be set (not nil) so it overwrites saved values.
|
||||||
|
assert.NotNil(t, params.ServiceEnvVars, "empty env vars should produce empty map, not nil")
|
||||||
|
assert.Empty(t, params.ServiceEnvVars, "no valid env vars should be parsed from empty string")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestServiceParams_FieldsCoveredInFunctions ensures that all serviceParams fields are
|
||||||
|
// referenced in both currentServiceParams() and applyServiceParams(). If a new field is
|
||||||
|
// added to serviceParams but not wired into these functions, this test fails.
|
||||||
|
func TestServiceParams_FieldsCoveredInFunctions(t *testing.T) {
|
||||||
|
fset := token.NewFileSet()
|
||||||
|
file, err := parser.ParseFile(fset, "service_params.go", nil, 0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Collect all JSON field names from the serviceParams struct.
|
||||||
|
structFields := extractStructJSONFields(t, file, "serviceParams")
|
||||||
|
require.NotEmpty(t, structFields, "failed to find serviceParams struct fields")
|
||||||
|
|
||||||
|
// Collect field names referenced in currentServiceParams and applyServiceParams.
|
||||||
|
currentFields := extractFuncFieldRefs(t, file, "currentServiceParams", structFields)
|
||||||
|
applyFields := extractFuncFieldRefs(t, file, "applyServiceParams", structFields)
|
||||||
|
// applyServiceEnvParams handles ServiceEnvVars indirectly.
|
||||||
|
applyEnvFields := extractFuncFieldRefs(t, file, "applyServiceEnvParams", structFields)
|
||||||
|
for k, v := range applyEnvFields {
|
||||||
|
applyFields[k] = v
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, field := range structFields {
|
||||||
|
assert.Contains(t, currentFields, field,
|
||||||
|
"serviceParams field %q is not captured in currentServiceParams()", field)
|
||||||
|
assert.Contains(t, applyFields, field,
|
||||||
|
"serviceParams field %q is not restored in applyServiceParams()/applyServiceEnvParams()", field)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestServiceParams_BuildArgsCoversAllFlags ensures that buildServiceArguments references
|
||||||
|
// all serviceParams fields that should become CLI args. ServiceEnvVars is excluded because
|
||||||
|
// it flows through newSVCConfig() EnvVars, not CLI args.
|
||||||
|
func TestServiceParams_BuildArgsCoversAllFlags(t *testing.T) {
|
||||||
|
fset := token.NewFileSet()
|
||||||
|
file, err := parser.ParseFile(fset, "service_params.go", nil, 0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
structFields := extractStructJSONFields(t, file, "serviceParams")
|
||||||
|
require.NotEmpty(t, structFields)
|
||||||
|
|
||||||
|
installerFile, err := parser.ParseFile(fset, "service_installer.go", nil, 0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
// Fields that are handled outside of buildServiceArguments (env vars go through newSVCConfig).
|
||||||
|
fieldsNotInArgs := map[string]bool{
|
||||||
|
"ServiceEnvVars": true,
|
||||||
|
}
|
||||||
|
|
||||||
|
buildFields := extractFuncGlobalRefs(t, installerFile, "buildServiceArguments")
|
||||||
|
|
||||||
|
// Forward: every struct field must appear in buildServiceArguments.
|
||||||
|
for _, field := range structFields {
|
||||||
|
if fieldsNotInArgs[field] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
globalVar := fieldToGlobalVar(field)
|
||||||
|
assert.Contains(t, buildFields, globalVar,
|
||||||
|
"serviceParams field %q (global %q) is not referenced in buildServiceArguments()", field, globalVar)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reverse: every service-related global used in buildServiceArguments must
|
||||||
|
// have a corresponding serviceParams field. This catches a developer adding
|
||||||
|
// a new flag to buildServiceArguments without adding it to the struct.
|
||||||
|
globalToField := make(map[string]string, len(structFields))
|
||||||
|
for _, field := range structFields {
|
||||||
|
globalToField[fieldToGlobalVar(field)] = field
|
||||||
|
}
|
||||||
|
// Identifiers in buildServiceArguments that are not service params
|
||||||
|
// (builtins, boilerplate, loop variables).
|
||||||
|
nonParamGlobals := map[string]bool{
|
||||||
|
"args": true, "append": true, "string": true, "_": true,
|
||||||
|
"logFile": true, // range variable over logFiles
|
||||||
|
}
|
||||||
|
for ref := range buildFields {
|
||||||
|
if nonParamGlobals[ref] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
_, inStruct := globalToField[ref]
|
||||||
|
assert.True(t, inStruct,
|
||||||
|
"buildServiceArguments() references global %q which has no corresponding serviceParams field", ref)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// extractStructJSONFields returns field names from a named struct type.
|
||||||
|
func extractStructJSONFields(t *testing.T, file *ast.File, structName string) []string {
|
||||||
|
t.Helper()
|
||||||
|
var fields []string
|
||||||
|
ast.Inspect(file, func(n ast.Node) bool {
|
||||||
|
ts, ok := n.(*ast.TypeSpec)
|
||||||
|
if !ok || ts.Name.Name != structName {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
st, ok := ts.Type.(*ast.StructType)
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, f := range st.Fields.List {
|
||||||
|
if len(f.Names) > 0 {
|
||||||
|
fields = append(fields, f.Names[0].Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
})
|
||||||
|
return fields
|
||||||
|
}
|
||||||
|
|
||||||
|
// extractFuncFieldRefs returns which of the given field names appear inside the
|
||||||
|
// named function, either as selector expressions (params.FieldName) or as
|
||||||
|
// composite literal keys (&serviceParams{FieldName: ...}).
|
||||||
|
func extractFuncFieldRefs(t *testing.T, file *ast.File, funcName string, fields []string) map[string]bool {
|
||||||
|
t.Helper()
|
||||||
|
fieldSet := make(map[string]bool, len(fields))
|
||||||
|
for _, f := range fields {
|
||||||
|
fieldSet[f] = true
|
||||||
|
}
|
||||||
|
|
||||||
|
found := make(map[string]bool)
|
||||||
|
fn := findFuncDecl(file, funcName)
|
||||||
|
require.NotNil(t, fn, "function %s not found", funcName)
|
||||||
|
|
||||||
|
ast.Inspect(fn.Body, func(n ast.Node) bool {
|
||||||
|
switch v := n.(type) {
|
||||||
|
case *ast.SelectorExpr:
|
||||||
|
if fieldSet[v.Sel.Name] {
|
||||||
|
found[v.Sel.Name] = true
|
||||||
|
}
|
||||||
|
case *ast.KeyValueExpr:
|
||||||
|
if ident, ok := v.Key.(*ast.Ident); ok && fieldSet[ident.Name] {
|
||||||
|
found[ident.Name] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
return found
|
||||||
|
}
|
||||||
|
|
||||||
|
// extractFuncGlobalRefs returns all identifier names referenced in the named function body.
|
||||||
|
func extractFuncGlobalRefs(t *testing.T, file *ast.File, funcName string) map[string]bool {
|
||||||
|
t.Helper()
|
||||||
|
fn := findFuncDecl(file, funcName)
|
||||||
|
require.NotNil(t, fn, "function %s not found", funcName)
|
||||||
|
|
||||||
|
refs := make(map[string]bool)
|
||||||
|
ast.Inspect(fn.Body, func(n ast.Node) bool {
|
||||||
|
if ident, ok := n.(*ast.Ident); ok {
|
||||||
|
refs[ident.Name] = true
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
return refs
|
||||||
|
}
|
||||||
|
|
||||||
|
func findFuncDecl(file *ast.File, name string) *ast.FuncDecl {
|
||||||
|
for _, decl := range file.Decls {
|
||||||
|
fn, ok := decl.(*ast.FuncDecl)
|
||||||
|
if ok && fn.Name.Name == name {
|
||||||
|
return fn
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// fieldToGlobalVar maps serviceParams field names to the package-level variable
|
||||||
|
// names used in buildServiceArguments and applyServiceParams.
|
||||||
|
func fieldToGlobalVar(field string) string {
|
||||||
|
m := map[string]string{
|
||||||
|
"LogLevel": "logLevel",
|
||||||
|
"DaemonAddr": "daemonAddr",
|
||||||
|
"ManagementURL": "managementURL",
|
||||||
|
"ConfigPath": "configPath",
|
||||||
|
"LogFiles": "logFiles",
|
||||||
|
"DisableProfiles": "profilesDisabled",
|
||||||
|
"DisableUpdateSettings": "updateSettingsDisabled",
|
||||||
|
"DisableNetworks": "networksDisabled",
|
||||||
|
"ServiceEnvVars": "serviceEnvVars",
|
||||||
|
}
|
||||||
|
if v, ok := m[field]; ok {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
// Default: lowercase first letter.
|
||||||
|
return strings.ToLower(field[:1]) + field[1:]
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEnvMapToSlice(t *testing.T) {
|
||||||
|
m := map[string]string{"A": "1", "B": "2"}
|
||||||
|
s := envMapToSlice(m)
|
||||||
|
assert.Len(t, s, 2)
|
||||||
|
assert.Contains(t, s, "A=1")
|
||||||
|
assert.Contains(t, s, "B=2")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEnvMapToSlice_Empty(t *testing.T) {
|
||||||
|
s := envMapToSlice(map[string]string{})
|
||||||
|
assert.Empty(t, s)
|
||||||
|
}
|
||||||
@@ -4,7 +4,9 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
|
"os/signal"
|
||||||
"runtime"
|
"runtime"
|
||||||
|
"syscall"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -13,6 +15,22 @@ import (
|
|||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// TestMain intercepts when this test binary is run as a daemon subprocess.
|
||||||
|
// On FreeBSD, the rc.d service script runs the binary via daemon(8) -r with
|
||||||
|
// "service run ..." arguments. Since the test binary can't handle cobra CLI
|
||||||
|
// args, it exits immediately, causing daemon -r to respawn rapidly until
|
||||||
|
// hitting the rate limit and exiting. This makes service restart unreliable.
|
||||||
|
// Blocking here keeps the subprocess alive until the init system sends SIGTERM.
|
||||||
|
func TestMain(m *testing.M) {
|
||||||
|
if len(os.Args) > 2 && os.Args[1] == "service" && os.Args[2] == "run" {
|
||||||
|
sig := make(chan os.Signal, 1)
|
||||||
|
signal.Notify(sig, syscall.SIGTERM, os.Interrupt)
|
||||||
|
<-sig
|
||||||
|
return
|
||||||
|
}
|
||||||
|
os.Exit(m.Run())
|
||||||
|
}
|
||||||
|
|
||||||
const (
|
const (
|
||||||
serviceStartTimeout = 10 * time.Second
|
serviceStartTimeout = 10 * time.Second
|
||||||
serviceStopTimeout = 5 * time.Second
|
serviceStopTimeout = 5 * time.Second
|
||||||
@@ -79,6 +97,34 @@ func TestServiceLifecycle(t *testing.T) {
|
|||||||
logLevel = "info"
|
logLevel = "info"
|
||||||
daemonAddr = fmt.Sprintf("unix://%s/netbird-test.sock", tempDir)
|
daemonAddr = fmt.Sprintf("unix://%s/netbird-test.sock", tempDir)
|
||||||
|
|
||||||
|
// Ensure cleanup even if a subtest fails and Stop/Uninstall subtests don't run.
|
||||||
|
t.Cleanup(func() {
|
||||||
|
cfg, err := newSVCConfig()
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("cleanup: create service config: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ctxSvc, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
s, err := newSVC(newProgram(ctxSvc, cancel), cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("cleanup: create service: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the subtests already cleaned up, there's nothing to do.
|
||||||
|
if _, err := s.Status(); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := s.Stop(); err != nil {
|
||||||
|
t.Errorf("cleanup: stop service: %v", err)
|
||||||
|
}
|
||||||
|
if err := s.Uninstall(); err != nil {
|
||||||
|
t.Errorf("cleanup: uninstall service: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
|
|
||||||
t.Run("Install", func(t *testing.T) {
|
t.Run("Install", func(t *testing.T) {
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import (
|
|||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/netbirdio/netbird/client/internal/updatemanager/reposign"
|
"github.com/netbirdio/netbird/client/internal/updater/reposign"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import (
|
|||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/netbirdio/netbird/client/internal/updatemanager/reposign"
|
"github.com/netbirdio/netbird/client/internal/updater/reposign"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import (
|
|||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/netbirdio/netbird/client/internal/updatemanager/reposign"
|
"github.com/netbirdio/netbird/client/internal/updater/reposign"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import (
|
|||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/netbirdio/netbird/client/internal/updatemanager/reposign"
|
"github.com/netbirdio/netbird/client/internal/updater/reposign"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ var (
|
|||||||
ipsFilterMap map[string]struct{}
|
ipsFilterMap map[string]struct{}
|
||||||
prefixNamesFilterMap map[string]struct{}
|
prefixNamesFilterMap map[string]struct{}
|
||||||
connectionTypeFilter string
|
connectionTypeFilter string
|
||||||
|
checkFlag string
|
||||||
)
|
)
|
||||||
|
|
||||||
var statusCmd = &cobra.Command{
|
var statusCmd = &cobra.Command{
|
||||||
@@ -49,6 +50,7 @@ func init() {
|
|||||||
statusCmd.PersistentFlags().StringSliceVar(&prefixNamesFilter, "filter-by-names", []string{}, "filters the detailed output by a list of one or more peer FQDN or hostnames, e.g., --filter-by-names peer-a,peer-b.netbird.cloud")
|
statusCmd.PersistentFlags().StringSliceVar(&prefixNamesFilter, "filter-by-names", []string{}, "filters the detailed output by a list of one or more peer FQDN or hostnames, e.g., --filter-by-names peer-a,peer-b.netbird.cloud")
|
||||||
statusCmd.PersistentFlags().StringVar(&statusFilter, "filter-by-status", "", "filters the detailed output by connection status(idle|connecting|connected), e.g., --filter-by-status connected")
|
statusCmd.PersistentFlags().StringVar(&statusFilter, "filter-by-status", "", "filters the detailed output by connection status(idle|connecting|connected), e.g., --filter-by-status connected")
|
||||||
statusCmd.PersistentFlags().StringVar(&connectionTypeFilter, "filter-by-connection-type", "", "filters the detailed output by connection type (P2P|Relayed), e.g., --filter-by-connection-type P2P")
|
statusCmd.PersistentFlags().StringVar(&connectionTypeFilter, "filter-by-connection-type", "", "filters the detailed output by connection type (P2P|Relayed), e.g., --filter-by-connection-type P2P")
|
||||||
|
statusCmd.PersistentFlags().StringVar(&checkFlag, "check", "", "run a health check and exit with code 0 on success, 1 on failure (live|ready|startup)")
|
||||||
}
|
}
|
||||||
|
|
||||||
func statusFunc(cmd *cobra.Command, args []string) error {
|
func statusFunc(cmd *cobra.Command, args []string) error {
|
||||||
@@ -56,6 +58,10 @@ func statusFunc(cmd *cobra.Command, args []string) error {
|
|||||||
|
|
||||||
cmd.SetOut(cmd.OutOrStdout())
|
cmd.SetOut(cmd.OutOrStdout())
|
||||||
|
|
||||||
|
if checkFlag != "" {
|
||||||
|
return runHealthCheck(cmd)
|
||||||
|
}
|
||||||
|
|
||||||
err := parseFilters()
|
err := parseFilters()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -68,15 +74,17 @@ func statusFunc(cmd *cobra.Command, args []string) error {
|
|||||||
|
|
||||||
ctx := internal.CtxInitState(cmd.Context())
|
ctx := internal.CtxInitState(cmd.Context())
|
||||||
|
|
||||||
resp, err := getStatus(ctx, false)
|
resp, err := getStatus(ctx, true, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
status := resp.GetStatus()
|
status := resp.GetStatus()
|
||||||
|
|
||||||
if status == string(internal.StatusNeedsLogin) || status == string(internal.StatusLoginFailed) ||
|
needsAuth := status == string(internal.StatusNeedsLogin) || status == string(internal.StatusLoginFailed) ||
|
||||||
status == string(internal.StatusSessionExpired) {
|
status == string(internal.StatusSessionExpired)
|
||||||
|
|
||||||
|
if needsAuth && !jsonFlag && !yamlFlag {
|
||||||
cmd.Printf("Daemon status: %s\n\n"+
|
cmd.Printf("Daemon status: %s\n\n"+
|
||||||
"Run UP command to log in with SSO (interactive login):\n\n"+
|
"Run UP command to log in with SSO (interactive login):\n\n"+
|
||||||
" netbird up \n\n"+
|
" netbird up \n\n"+
|
||||||
@@ -99,7 +107,17 @@ func statusFunc(cmd *cobra.Command, args []string) error {
|
|||||||
profName = activeProf.Name
|
profName = activeProf.Name
|
||||||
}
|
}
|
||||||
|
|
||||||
var outputInformationHolder = nbstatus.ConvertToStatusOutputOverview(resp.GetFullStatus(), anonymizeFlag, resp.GetDaemonVersion(), statusFilter, prefixNamesFilter, prefixNamesFilterMap, ipsFilterMap, connectionTypeFilter, profName)
|
var outputInformationHolder = nbstatus.ConvertToStatusOutputOverview(resp.GetFullStatus(), nbstatus.ConvertOptions{
|
||||||
|
Anonymize: anonymizeFlag,
|
||||||
|
DaemonVersion: resp.GetDaemonVersion(),
|
||||||
|
DaemonStatus: nbstatus.ParseDaemonStatus(status),
|
||||||
|
StatusFilter: statusFilter,
|
||||||
|
PrefixNamesFilter: prefixNamesFilter,
|
||||||
|
PrefixNamesFilterMap: prefixNamesFilterMap,
|
||||||
|
IPsFilter: ipsFilterMap,
|
||||||
|
ConnectionTypeFilter: connectionTypeFilter,
|
||||||
|
ProfileName: profName,
|
||||||
|
})
|
||||||
var statusOutputString string
|
var statusOutputString string
|
||||||
switch {
|
switch {
|
||||||
case detailFlag:
|
case detailFlag:
|
||||||
@@ -121,7 +139,7 @@ func statusFunc(cmd *cobra.Command, args []string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func getStatus(ctx context.Context, shouldRunProbes bool) (*proto.StatusResponse, error) {
|
func getStatus(ctx context.Context, fullPeerStatus bool, shouldRunProbes bool) (*proto.StatusResponse, error) {
|
||||||
conn, err := DialClientGRPCServer(ctx, daemonAddr)
|
conn, err := DialClientGRPCServer(ctx, daemonAddr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
//nolint
|
//nolint
|
||||||
@@ -131,7 +149,7 @@ func getStatus(ctx context.Context, shouldRunProbes bool) (*proto.StatusResponse
|
|||||||
}
|
}
|
||||||
defer conn.Close()
|
defer conn.Close()
|
||||||
|
|
||||||
resp, err := proto.NewDaemonServiceClient(conn).Status(ctx, &proto.StatusRequest{GetFullPeerStatus: true, ShouldRunProbes: shouldRunProbes})
|
resp, err := proto.NewDaemonServiceClient(conn).Status(ctx, &proto.StatusRequest{GetFullPeerStatus: fullPeerStatus, ShouldRunProbes: shouldRunProbes})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("status failed: %v", status.Convert(err).Message())
|
return nil, fmt.Errorf("status failed: %v", status.Convert(err).Message())
|
||||||
}
|
}
|
||||||
@@ -185,6 +203,83 @@ func enableDetailFlagWhenFilterFlag() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func runHealthCheck(cmd *cobra.Command) error {
|
||||||
|
check := strings.ToLower(checkFlag)
|
||||||
|
switch check {
|
||||||
|
case "live", "ready", "startup":
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("unknown check %q, must be one of: live, ready, startup", checkFlag)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := util.InitLog(logLevel, util.LogConsole); err != nil {
|
||||||
|
return fmt.Errorf("init log: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := internal.CtxInitState(cmd.Context())
|
||||||
|
|
||||||
|
isStartup := check == "startup"
|
||||||
|
resp, err := getStatus(ctx, isStartup, false)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
switch check {
|
||||||
|
case "live":
|
||||||
|
return nil
|
||||||
|
case "ready":
|
||||||
|
return checkReadiness(resp)
|
||||||
|
case "startup":
|
||||||
|
return checkStartup(resp)
|
||||||
|
default:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkReadiness(resp *proto.StatusResponse) error {
|
||||||
|
daemonStatus := internal.StatusType(resp.GetStatus())
|
||||||
|
switch daemonStatus {
|
||||||
|
case internal.StatusIdle, internal.StatusConnecting, internal.StatusConnected:
|
||||||
|
return nil
|
||||||
|
case internal.StatusNeedsLogin, internal.StatusLoginFailed, internal.StatusSessionExpired:
|
||||||
|
return fmt.Errorf("readiness check: daemon status is %s", daemonStatus)
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("readiness check: unexpected daemon status %q", daemonStatus)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkStartup(resp *proto.StatusResponse) error {
|
||||||
|
fullStatus := resp.GetFullStatus()
|
||||||
|
if fullStatus == nil {
|
||||||
|
return fmt.Errorf("startup check: no full status available")
|
||||||
|
}
|
||||||
|
|
||||||
|
if !fullStatus.GetManagementState().GetConnected() {
|
||||||
|
return fmt.Errorf("startup check: management not connected")
|
||||||
|
}
|
||||||
|
|
||||||
|
if !fullStatus.GetSignalState().GetConnected() {
|
||||||
|
return fmt.Errorf("startup check: signal not connected")
|
||||||
|
}
|
||||||
|
|
||||||
|
var relayCount, relaysConnected int
|
||||||
|
for _, r := range fullStatus.GetRelays() {
|
||||||
|
uri := r.GetURI()
|
||||||
|
if !strings.HasPrefix(uri, "rel://") && !strings.HasPrefix(uri, "rels://") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
relayCount++
|
||||||
|
if r.GetAvailable() {
|
||||||
|
relaysConnected++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if relayCount > 0 && relaysConnected == 0 {
|
||||||
|
return fmt.Errorf("startup check: no relay servers available (0/%d connected)", relayCount)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func parseInterfaceIP(interfaceIP string) string {
|
func parseInterfaceIP(interfaceIP string) string {
|
||||||
ip, _, err := net.ParseCIDR(interfaceIP)
|
ip, _, err := net.ParseCIDR(interfaceIP)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -13,6 +13,8 @@ import (
|
|||||||
|
|
||||||
"github.com/netbirdio/management-integrations/integrations"
|
"github.com/netbirdio/management-integrations/integrations"
|
||||||
|
|
||||||
|
nbcache "github.com/netbirdio/netbird/management/server/cache"
|
||||||
|
|
||||||
"github.com/netbirdio/netbird/management/internals/controllers/network_map/controller"
|
"github.com/netbirdio/netbird/management/internals/controllers/network_map/controller"
|
||||||
"github.com/netbirdio/netbird/management/internals/controllers/network_map/update_channel"
|
"github.com/netbirdio/netbird/management/internals/controllers/network_map/update_channel"
|
||||||
"github.com/netbirdio/netbird/management/internals/modules/peers"
|
"github.com/netbirdio/netbird/management/internals/modules/peers"
|
||||||
@@ -100,9 +102,16 @@ func startManagement(t *testing.T, config *config.Config, testFile string) (*grp
|
|||||||
|
|
||||||
jobManager := job.NewJobManager(nil, store, peersmanager)
|
jobManager := job.NewJobManager(nil, store, peersmanager)
|
||||||
|
|
||||||
iv, _ := integrations.NewIntegratedValidator(context.Background(), peersmanager, settingsManagerMock, eventStore)
|
ctx := context.Background()
|
||||||
|
|
||||||
metrics, err := telemetry.NewDefaultAppMetrics(context.Background())
|
cacheStore, err := nbcache.NewStore(ctx, 100*time.Millisecond, 300*time.Millisecond, 100)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
iv, _ := integrations.NewIntegratedValidator(ctx, peersmanager, settingsManagerMock, eventStore, cacheStore)
|
||||||
|
|
||||||
|
metrics, err := telemetry.NewDefaultAppMetrics(ctx)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
settingsMockManager := settings.NewMockManager(ctrl)
|
settingsMockManager := settings.NewMockManager(ctrl)
|
||||||
@@ -113,12 +122,11 @@ func startManagement(t *testing.T, config *config.Config, testFile string) (*grp
|
|||||||
Return(&types.Settings{}, nil).
|
Return(&types.Settings{}, nil).
|
||||||
AnyTimes()
|
AnyTimes()
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
updateManager := update_channel.NewPeersUpdateManager(metrics)
|
updateManager := update_channel.NewPeersUpdateManager(metrics)
|
||||||
requestBuffer := mgmt.NewAccountRequestBuffer(ctx, store)
|
requestBuffer := mgmt.NewAccountRequestBuffer(ctx, store)
|
||||||
networkMapController := controller.NewController(ctx, store, metrics, updateManager, requestBuffer, mgmt.MockIntegratedValidator{}, settingsMockManager, "netbird.cloud", port_forwarding.NewControllerMock(), manager.NewEphemeralManager(store, peersmanager), config)
|
networkMapController := controller.NewController(ctx, store, metrics, updateManager, requestBuffer, mgmt.MockIntegratedValidator{}, settingsMockManager, "netbird.cloud", port_forwarding.NewControllerMock(), manager.NewEphemeralManager(store, peersmanager), config)
|
||||||
|
|
||||||
accountManager, err := mgmt.BuildManager(context.Background(), config, store, networkMapController, jobManager, nil, "", eventStore, nil, false, iv, metrics, port_forwarding.NewControllerMock(), settingsMockManager, permissionsManagerMock, false)
|
accountManager, err := mgmt.BuildManager(ctx, config, store, networkMapController, jobManager, nil, "", eventStore, nil, false, iv, metrics, port_forwarding.NewControllerMock(), settingsMockManager, permissionsManagerMock, false, cacheStore)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -152,7 +160,7 @@ func startClientDaemon(
|
|||||||
s := grpc.NewServer()
|
s := grpc.NewServer()
|
||||||
|
|
||||||
server := client.New(ctx,
|
server := client.New(ctx,
|
||||||
"", "", false, false)
|
"", "", false, false, false)
|
||||||
if err := server.Start(); err != nil {
|
if err := server.Start(); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -197,7 +197,7 @@ func runInForegroundMode(ctx context.Context, cmd *cobra.Command, activeProf *pr
|
|||||||
r := peer.NewRecorder(config.ManagementURL.String())
|
r := peer.NewRecorder(config.ManagementURL.String())
|
||||||
r.GetFullStatus()
|
r.GetFullStatus()
|
||||||
|
|
||||||
connectClient := internal.NewConnectClient(ctx, config, r, false)
|
connectClient := internal.NewConnectClient(ctx, config, r)
|
||||||
SetupDebugHandler(ctx, config, r, connectClient, "")
|
SetupDebugHandler(ctx, config, r, connectClient, "")
|
||||||
|
|
||||||
return connectClient.Run(nil, util.FindFirstLogPath(logFiles))
|
return connectClient.Run(nil, util.FindFirstLogPath(logFiles))
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ import (
|
|||||||
log "github.com/sirupsen/logrus"
|
log "github.com/sirupsen/logrus"
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/netbirdio/netbird/client/internal/updatemanager/installer"
|
"github.com/netbirdio/netbird/client/internal/updater/installer"
|
||||||
"github.com/netbirdio/netbird/util"
|
"github.com/netbirdio/netbird/util"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ import (
|
|||||||
"github.com/sirupsen/logrus"
|
"github.com/sirupsen/logrus"
|
||||||
wgnetstack "golang.zx2c4.com/wireguard/tun/netstack"
|
wgnetstack "golang.zx2c4.com/wireguard/tun/netstack"
|
||||||
|
|
||||||
|
"github.com/netbirdio/netbird/client/iface"
|
||||||
"github.com/netbirdio/netbird/client/iface/netstack"
|
"github.com/netbirdio/netbird/client/iface/netstack"
|
||||||
"github.com/netbirdio/netbird/client/internal"
|
"github.com/netbirdio/netbird/client/internal"
|
||||||
"github.com/netbirdio/netbird/client/internal/auth"
|
"github.com/netbirdio/netbird/client/internal/auth"
|
||||||
@@ -21,6 +22,7 @@ import (
|
|||||||
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
||||||
sshcommon "github.com/netbirdio/netbird/client/ssh"
|
sshcommon "github.com/netbirdio/netbird/client/ssh"
|
||||||
"github.com/netbirdio/netbird/client/system"
|
"github.com/netbirdio/netbird/client/system"
|
||||||
|
"github.com/netbirdio/netbird/shared/management/domain"
|
||||||
mgmProto "github.com/netbirdio/netbird/shared/management/proto"
|
mgmProto "github.com/netbirdio/netbird/shared/management/proto"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -31,14 +33,14 @@ var (
|
|||||||
ErrConfigNotInitialized = errors.New("config not initialized")
|
ErrConfigNotInitialized = errors.New("config not initialized")
|
||||||
)
|
)
|
||||||
|
|
||||||
// PeerConnStatus is a peer's connection status.
|
|
||||||
type PeerConnStatus = peer.ConnStatus
|
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// PeerStatusConnected indicates the peer is in connected state.
|
// PeerStatusConnected indicates the peer is in connected state.
|
||||||
PeerStatusConnected = peer.StatusConnected
|
PeerStatusConnected = peer.StatusConnected
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// PeerConnStatus is a peer's connection status.
|
||||||
|
type PeerConnStatus = peer.ConnStatus
|
||||||
|
|
||||||
// Client manages a netbird embedded client instance.
|
// Client manages a netbird embedded client instance.
|
||||||
type Client struct {
|
type Client struct {
|
||||||
deviceName string
|
deviceName string
|
||||||
@@ -81,6 +83,14 @@ type Options struct {
|
|||||||
BlockInbound bool
|
BlockInbound bool
|
||||||
// WireguardPort is the port for the WireGuard interface. Use 0 for a random port.
|
// WireguardPort is the port for the WireGuard interface. Use 0 for a random port.
|
||||||
WireguardPort *int
|
WireguardPort *int
|
||||||
|
// MTU is the MTU for the WireGuard interface.
|
||||||
|
// Valid values are in the range 576..8192 bytes.
|
||||||
|
// If non-nil, this value overrides any value stored in the config file.
|
||||||
|
// If nil, the existing config MTU (if non-zero) is preserved; otherwise it defaults to 1280.
|
||||||
|
// Set to a higher value (e.g. 1400) if carrying QUIC or other protocols that require larger datagrams.
|
||||||
|
MTU *uint16
|
||||||
|
// DNSLabels defines additional DNS labels configured in the peer.
|
||||||
|
DNSLabels []string
|
||||||
}
|
}
|
||||||
|
|
||||||
// validateCredentials checks that exactly one credential type is provided
|
// validateCredentials checks that exactly one credential type is provided
|
||||||
@@ -112,6 +122,12 @@ func New(opts Options) (*Client, error) {
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if opts.MTU != nil {
|
||||||
|
if err := iface.ValidateMTU(*opts.MTU); err != nil {
|
||||||
|
return nil, fmt.Errorf("invalid MTU: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if opts.LogOutput != nil {
|
if opts.LogOutput != nil {
|
||||||
logrus.SetOutput(opts.LogOutput)
|
logrus.SetOutput(opts.LogOutput)
|
||||||
}
|
}
|
||||||
@@ -140,9 +156,14 @@ func New(opts Options) (*Client, error) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var err error
|
||||||
|
var parsedLabels domain.List
|
||||||
|
if parsedLabels, err = domain.FromStringList(opts.DNSLabels); err != nil {
|
||||||
|
return nil, fmt.Errorf("invalid dns labels: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
t := true
|
t := true
|
||||||
var config *profilemanager.Config
|
var config *profilemanager.Config
|
||||||
var err error
|
|
||||||
input := profilemanager.ConfigInput{
|
input := profilemanager.ConfigInput{
|
||||||
ConfigPath: opts.ConfigPath,
|
ConfigPath: opts.ConfigPath,
|
||||||
ManagementURL: opts.ManagementURL,
|
ManagementURL: opts.ManagementURL,
|
||||||
@@ -151,6 +172,8 @@ func New(opts Options) (*Client, error) {
|
|||||||
DisableClientRoutes: &opts.DisableClientRoutes,
|
DisableClientRoutes: &opts.DisableClientRoutes,
|
||||||
BlockInbound: &opts.BlockInbound,
|
BlockInbound: &opts.BlockInbound,
|
||||||
WireguardPort: opts.WireguardPort,
|
WireguardPort: opts.WireguardPort,
|
||||||
|
MTU: opts.MTU,
|
||||||
|
DNSLabels: parsedLabels,
|
||||||
}
|
}
|
||||||
if opts.ConfigPath != "" {
|
if opts.ConfigPath != "" {
|
||||||
config, err = profilemanager.UpdateOrCreateConfig(input)
|
config, err = profilemanager.UpdateOrCreateConfig(input)
|
||||||
@@ -202,7 +225,7 @@ func (c *Client) Start(startCtx context.Context) error {
|
|||||||
if err, _ := authClient.Login(ctx, c.setupKey, c.jwtToken); err != nil {
|
if err, _ := authClient.Login(ctx, c.setupKey, c.jwtToken); err != nil {
|
||||||
return fmt.Errorf("login: %w", err)
|
return fmt.Errorf("login: %w", err)
|
||||||
}
|
}
|
||||||
client := internal.NewConnectClient(ctx, c.config, c.recorder, false)
|
client := internal.NewConnectClient(ctx, c.config, c.recorder)
|
||||||
client.SetSyncResponsePersistence(true)
|
client.SetSyncResponsePersistence(true)
|
||||||
|
|
||||||
// either startup error (permanent backoff err) or nil err (successful engine up)
|
// either startup error (permanent backoff err) or nil err (successful engine up)
|
||||||
@@ -352,6 +375,32 @@ func (c *Client) NewHTTPClient() *http.Client {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Expose exposes a local service via the NetBird reverse proxy, making it accessible through a public URL.
|
||||||
|
// It returns an ExposeSession. Call Wait on the session to keep it alive.
|
||||||
|
func (c *Client) Expose(ctx context.Context, req ExposeRequest) (*ExposeSession, error) {
|
||||||
|
engine, err := c.getEngine()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
mgr := engine.GetExposeManager()
|
||||||
|
if mgr == nil {
|
||||||
|
return nil, fmt.Errorf("expose manager not available")
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := mgr.Expose(ctx, req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("expose: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return &ExposeSession{
|
||||||
|
Domain: resp.Domain,
|
||||||
|
ServiceName: resp.ServiceName,
|
||||||
|
ServiceURL: resp.ServiceURL,
|
||||||
|
mgr: mgr,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
// Status returns the current status of the client.
|
// Status returns the current status of the client.
|
||||||
func (c *Client) Status() (peer.FullStatus, error) {
|
func (c *Client) Status() (peer.FullStatus, error) {
|
||||||
c.mu.Lock()
|
c.mu.Lock()
|
||||||
|
|||||||
45
client/embed/expose.go
Normal file
45
client/embed/expose.go
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
package embed
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
|
||||||
|
"github.com/netbirdio/netbird/client/internal/expose"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ExposeProtocolHTTP exposes the service as HTTP.
|
||||||
|
ExposeProtocolHTTP = expose.ProtocolHTTP
|
||||||
|
// ExposeProtocolHTTPS exposes the service as HTTPS.
|
||||||
|
ExposeProtocolHTTPS = expose.ProtocolHTTPS
|
||||||
|
// ExposeProtocolTCP exposes the service as TCP.
|
||||||
|
ExposeProtocolTCP = expose.ProtocolTCP
|
||||||
|
// ExposeProtocolUDP exposes the service as UDP.
|
||||||
|
ExposeProtocolUDP = expose.ProtocolUDP
|
||||||
|
// ExposeProtocolTLS exposes the service as TLS.
|
||||||
|
ExposeProtocolTLS = expose.ProtocolTLS
|
||||||
|
)
|
||||||
|
|
||||||
|
// ExposeRequest is a request to expose a local service via the NetBird reverse proxy.
|
||||||
|
type ExposeRequest = expose.Request
|
||||||
|
|
||||||
|
// ExposeProtocolType represents the protocol used for exposing a service.
|
||||||
|
type ExposeProtocolType = expose.ProtocolType
|
||||||
|
|
||||||
|
// ExposeSession represents an active expose session. Use Wait to block until the session ends.
|
||||||
|
type ExposeSession struct {
|
||||||
|
Domain string
|
||||||
|
ServiceName string
|
||||||
|
ServiceURL string
|
||||||
|
|
||||||
|
mgr *expose.Manager
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wait blocks while keeping the expose session alive.
|
||||||
|
// It returns when ctx is cancelled or a keep-alive error occurs, then terminates the session.
|
||||||
|
func (s *ExposeSession) Wait(ctx context.Context) error {
|
||||||
|
if s == nil || s.mgr == nil {
|
||||||
|
return errors.New("expose session is not initialized")
|
||||||
|
}
|
||||||
|
return s.mgr.KeepAlive(ctx, s.Domain)
|
||||||
|
}
|
||||||
@@ -6,6 +6,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
"github.com/coreos/go-iptables/iptables"
|
"github.com/coreos/go-iptables/iptables"
|
||||||
"github.com/google/nftables"
|
"github.com/google/nftables"
|
||||||
@@ -35,20 +36,34 @@ const SKIP_NFTABLES_ENV = "NB_SKIP_NFTABLES_CHECK"
|
|||||||
type FWType int
|
type FWType int
|
||||||
|
|
||||||
func NewFirewall(iface IFaceMapper, stateManager *statemanager.Manager, flowLogger nftypes.FlowLogger, disableServerRoutes bool, mtu uint16) (firewall.Manager, error) {
|
func NewFirewall(iface IFaceMapper, stateManager *statemanager.Manager, flowLogger nftypes.FlowLogger, disableServerRoutes bool, mtu uint16) (firewall.Manager, error) {
|
||||||
// on the linux system we try to user nftables or iptables
|
// We run in userspace mode and force userspace firewall was requested. We don't attempt native firewall.
|
||||||
// in any case, because we need to allow netbird interface traffic
|
if iface.IsUserspaceBind() && forceUserspaceFirewall() {
|
||||||
// so we use AllowNetbird traffic from these firewall managers
|
log.Info("forcing userspace firewall")
|
||||||
// for the userspace packet filtering firewall
|
return createUserspaceFirewall(iface, nil, disableServerRoutes, flowLogger, mtu)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use native firewall for either kernel or userspace, the interface appears identical to netfilter
|
||||||
fm, err := createNativeFirewall(iface, stateManager, disableServerRoutes, mtu)
|
fm, err := createNativeFirewall(iface, stateManager, disableServerRoutes, mtu)
|
||||||
|
|
||||||
|
// Kernel cannot fall back to anything else, need to return error
|
||||||
if !iface.IsUserspaceBind() {
|
if !iface.IsUserspaceBind() {
|
||||||
return fm, err
|
return fm, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Fall back to the userspace packet filter if native is unavailable
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Warnf("failed to create native firewall: %v. Proceeding with userspace", err)
|
log.Warnf("failed to create native firewall: %v. Proceeding with userspace", err)
|
||||||
|
return createUserspaceFirewall(iface, nil, disableServerRoutes, flowLogger, mtu)
|
||||||
}
|
}
|
||||||
return createUserspaceFirewall(iface, fm, disableServerRoutes, flowLogger, mtu)
|
|
||||||
|
// Native firewall handles packet filtering, but the userspace WireGuard bind
|
||||||
|
// needs a device filter for DNS interception hooks. Install a minimal
|
||||||
|
// hooks-only filter that passes all traffic through to the kernel firewall.
|
||||||
|
if err := iface.SetFilter(&uspfilter.HooksFilter{}); err != nil {
|
||||||
|
log.Warnf("failed to set hooks filter, DNS via memory hooks will not work: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return fm, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func createNativeFirewall(iface IFaceMapper, stateManager *statemanager.Manager, routes bool, mtu uint16) (firewall.Manager, error) {
|
func createNativeFirewall(iface IFaceMapper, stateManager *statemanager.Manager, routes bool, mtu uint16) (firewall.Manager, error) {
|
||||||
@@ -160,3 +175,17 @@ func isIptablesClientAvailable(client *iptables.IPTables) bool {
|
|||||||
_, err := client.ListChains("filter")
|
_, err := client.ListChains("filter")
|
||||||
return err == nil
|
return err == nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func forceUserspaceFirewall() bool {
|
||||||
|
val := os.Getenv(EnvForceUserspaceFirewall)
|
||||||
|
if val == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
force, err := strconv.ParseBool(val)
|
||||||
|
if err != nil {
|
||||||
|
log.Warnf("failed to parse %s: %v", EnvForceUserspaceFirewall, err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return force
|
||||||
|
}
|
||||||
|
|||||||
@@ -7,6 +7,12 @@ import (
|
|||||||
"github.com/netbirdio/netbird/client/iface/wgaddr"
|
"github.com/netbirdio/netbird/client/iface/wgaddr"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// EnvForceUserspaceFirewall forces the use of the userspace packet filter even when
|
||||||
|
// native iptables/nftables is available. This only applies when the WireGuard interface
|
||||||
|
// runs in userspace mode. When set, peer ACLs are handled by USPFilter instead of
|
||||||
|
// kernel netfilter rules.
|
||||||
|
const EnvForceUserspaceFirewall = "NB_FORCE_USERSPACE_FIREWALL"
|
||||||
|
|
||||||
// IFaceMapper defines subset methods of interface required for manager
|
// IFaceMapper defines subset methods of interface required for manager
|
||||||
type IFaceMapper interface {
|
type IFaceMapper interface {
|
||||||
Name() string
|
Name() string
|
||||||
|
|||||||
@@ -21,6 +21,10 @@ const (
|
|||||||
|
|
||||||
// rules chains contains the effective ACL rules
|
// rules chains contains the effective ACL rules
|
||||||
chainNameInputRules = "NETBIRD-ACL-INPUT"
|
chainNameInputRules = "NETBIRD-ACL-INPUT"
|
||||||
|
|
||||||
|
// mangleFwdKey is the entries map key for mangle FORWARD guard rules that prevent
|
||||||
|
// external DNAT from bypassing ACL rules.
|
||||||
|
mangleFwdKey = "MANGLE-FORWARD"
|
||||||
)
|
)
|
||||||
|
|
||||||
type aclEntries map[string][][]string
|
type aclEntries map[string][][]string
|
||||||
@@ -274,6 +278,12 @@ func (m *aclManager) cleanChains() error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
for _, rule := range m.entries[mangleFwdKey] {
|
||||||
|
if err := m.iptablesClient.DeleteIfExists(tableMangle, chainFORWARD, rule...); err != nil {
|
||||||
|
log.Errorf("failed to delete mangle FORWARD guard rule: %v, %s", rule, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
for _, ipsetName := range m.ipsetStore.ipsetNames() {
|
for _, ipsetName := range m.ipsetStore.ipsetNames() {
|
||||||
if err := m.flushIPSet(ipsetName); err != nil {
|
if err := m.flushIPSet(ipsetName); err != nil {
|
||||||
if errors.Is(err, ipset.ErrSetNotExist) {
|
if errors.Is(err, ipset.ErrSetNotExist) {
|
||||||
@@ -303,6 +313,10 @@ func (m *aclManager) createDefaultChains() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for chainName, rules := range m.entries {
|
for chainName, rules := range m.entries {
|
||||||
|
// mangle FORWARD guard rules are handled separately below
|
||||||
|
if chainName == mangleFwdKey {
|
||||||
|
continue
|
||||||
|
}
|
||||||
for _, rule := range rules {
|
for _, rule := range rules {
|
||||||
if err := m.iptablesClient.InsertUnique(tableName, chainName, 1, rule...); err != nil {
|
if err := m.iptablesClient.InsertUnique(tableName, chainName, 1, rule...); err != nil {
|
||||||
log.Debugf("failed to create input chain jump rule: %s", err)
|
log.Debugf("failed to create input chain jump rule: %s", err)
|
||||||
@@ -322,6 +336,13 @@ func (m *aclManager) createDefaultChains() error {
|
|||||||
}
|
}
|
||||||
clear(m.optionalEntries)
|
clear(m.optionalEntries)
|
||||||
|
|
||||||
|
// Insert mangle FORWARD guard rules to prevent external DNAT bypass.
|
||||||
|
for _, rule := range m.entries[mangleFwdKey] {
|
||||||
|
if err := m.iptablesClient.AppendUnique(tableMangle, chainFORWARD, rule...); err != nil {
|
||||||
|
log.Errorf("failed to add mangle FORWARD guard rule: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -343,6 +364,22 @@ func (m *aclManager) seedInitialEntries() {
|
|||||||
|
|
||||||
m.appendToEntries("FORWARD", []string{"-o", m.wgIface.Name(), "-j", chainRTFWDOUT})
|
m.appendToEntries("FORWARD", []string{"-o", m.wgIface.Name(), "-j", chainRTFWDOUT})
|
||||||
m.appendToEntries("FORWARD", []string{"-i", m.wgIface.Name(), "-j", chainRTFWDIN})
|
m.appendToEntries("FORWARD", []string{"-i", m.wgIface.Name(), "-j", chainRTFWDIN})
|
||||||
|
|
||||||
|
// Mangle FORWARD guard: when external DNAT redirects traffic from the wg interface, it
|
||||||
|
// traverses FORWARD instead of INPUT, bypassing ACL rules. ACCEPT rules in filter FORWARD
|
||||||
|
// can be inserted above ours. Mangle runs before filter, so these guard rules enforce the
|
||||||
|
// ACL mark check where it cannot be overridden.
|
||||||
|
m.appendToEntries(mangleFwdKey, []string{
|
||||||
|
"-i", m.wgIface.Name(),
|
||||||
|
"-m", "conntrack", "--ctstate", "RELATED,ESTABLISHED",
|
||||||
|
"-j", "ACCEPT",
|
||||||
|
})
|
||||||
|
m.appendToEntries(mangleFwdKey, []string{
|
||||||
|
"-i", m.wgIface.Name(),
|
||||||
|
"-m", "conntrack", "--ctstate", "DNAT",
|
||||||
|
"-m", "mark", "!", "--mark", fmt.Sprintf("%#x", nbnet.PreroutingFwmarkRedirected),
|
||||||
|
"-j", "DROP",
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *aclManager) seedInitialOptionalEntries() {
|
func (m *aclManager) seedInitialOptionalEntries() {
|
||||||
|
|||||||
@@ -23,16 +23,16 @@ type Manager struct {
|
|||||||
|
|
||||||
wgIface iFaceMapper
|
wgIface iFaceMapper
|
||||||
|
|
||||||
ipv4Client *iptables.IPTables
|
ipv4Client *iptables.IPTables
|
||||||
aclMgr *aclManager
|
aclMgr *aclManager
|
||||||
router *router
|
router *router
|
||||||
|
rawSupported bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// iFaceMapper defines subset methods of interface required for manager
|
// iFaceMapper defines subset methods of interface required for manager
|
||||||
type iFaceMapper interface {
|
type iFaceMapper interface {
|
||||||
Name() string
|
Name() string
|
||||||
Address() wgaddr.Address
|
Address() wgaddr.Address
|
||||||
IsUserspaceBind() bool
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create iptables firewall manager
|
// Create iptables firewall manager
|
||||||
@@ -63,10 +63,9 @@ func Create(wgIface iFaceMapper, mtu uint16) (*Manager, error) {
|
|||||||
func (m *Manager) Init(stateManager *statemanager.Manager) error {
|
func (m *Manager) Init(stateManager *statemanager.Manager) error {
|
||||||
state := &ShutdownState{
|
state := &ShutdownState{
|
||||||
InterfaceState: &InterfaceState{
|
InterfaceState: &InterfaceState{
|
||||||
NameStr: m.wgIface.Name(),
|
NameStr: m.wgIface.Name(),
|
||||||
WGAddress: m.wgIface.Address(),
|
WGAddress: m.wgIface.Address(),
|
||||||
UserspaceBind: m.wgIface.IsUserspaceBind(),
|
MTU: m.router.mtu,
|
||||||
MTU: m.router.mtu,
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
stateManager.RegisterState(state)
|
stateManager.RegisterState(state)
|
||||||
@@ -84,7 +83,7 @@ func (m *Manager) Init(stateManager *statemanager.Manager) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err := m.initNoTrackChain(); err != nil {
|
if err := m.initNoTrackChain(); err != nil {
|
||||||
return fmt.Errorf("init notrack chain: %w", err)
|
log.Warnf("raw table not available, notrack rules will be disabled: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// persist early to ensure cleanup of chains
|
// persist early to ensure cleanup of chains
|
||||||
@@ -202,12 +201,10 @@ func (m *Manager) Close(stateManager *statemanager.Manager) error {
|
|||||||
return nberrors.FormatErrorOrNil(merr)
|
return nberrors.FormatErrorOrNil(merr)
|
||||||
}
|
}
|
||||||
|
|
||||||
// AllowNetbird allows netbird interface traffic
|
// AllowNetbird allows netbird interface traffic.
|
||||||
|
// This is called when USPFilter wraps the native firewall, adding blanket accept
|
||||||
|
// rules so that packet filtering is handled in userspace instead of by netfilter.
|
||||||
func (m *Manager) AllowNetbird() error {
|
func (m *Manager) AllowNetbird() error {
|
||||||
if !m.wgIface.IsUserspaceBind() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := m.AddPeerFiltering(
|
_, err := m.AddPeerFiltering(
|
||||||
nil,
|
nil,
|
||||||
net.IP{0, 0, 0, 0},
|
net.IP{0, 0, 0, 0},
|
||||||
@@ -285,6 +282,22 @@ func (m *Manager) RemoveInboundDNAT(localAddr netip.Addr, protocol firewall.Prot
|
|||||||
return m.router.RemoveInboundDNAT(localAddr, protocol, sourcePort, targetPort)
|
return m.router.RemoveInboundDNAT(localAddr, protocol, sourcePort, targetPort)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AddOutputDNAT adds an OUTPUT chain DNAT rule for locally-generated traffic.
|
||||||
|
func (m *Manager) AddOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
m.mutex.Lock()
|
||||||
|
defer m.mutex.Unlock()
|
||||||
|
|
||||||
|
return m.router.AddOutputDNAT(localAddr, protocol, sourcePort, targetPort)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveOutputDNAT removes an OUTPUT chain DNAT rule.
|
||||||
|
func (m *Manager) RemoveOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
m.mutex.Lock()
|
||||||
|
defer m.mutex.Unlock()
|
||||||
|
|
||||||
|
return m.router.RemoveOutputDNAT(localAddr, protocol, sourcePort, targetPort)
|
||||||
|
}
|
||||||
|
|
||||||
const (
|
const (
|
||||||
chainNameRaw = "NETBIRD-RAW"
|
chainNameRaw = "NETBIRD-RAW"
|
||||||
chainOUTPUT = "OUTPUT"
|
chainOUTPUT = "OUTPUT"
|
||||||
@@ -318,6 +331,10 @@ func (m *Manager) SetupEBPFProxyNoTrack(proxyPort, wgPort uint16) error {
|
|||||||
m.mutex.Lock()
|
m.mutex.Lock()
|
||||||
defer m.mutex.Unlock()
|
defer m.mutex.Unlock()
|
||||||
|
|
||||||
|
if !m.rawSupported {
|
||||||
|
return fmt.Errorf("raw table not available")
|
||||||
|
}
|
||||||
|
|
||||||
wgPortStr := fmt.Sprintf("%d", wgPort)
|
wgPortStr := fmt.Sprintf("%d", wgPort)
|
||||||
proxyPortStr := fmt.Sprintf("%d", proxyPort)
|
proxyPortStr := fmt.Sprintf("%d", proxyPort)
|
||||||
|
|
||||||
@@ -375,12 +392,16 @@ func (m *Manager) initNoTrackChain() error {
|
|||||||
return fmt.Errorf("add prerouting jump rule: %w", err)
|
return fmt.Errorf("add prerouting jump rule: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
m.rawSupported = true
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *Manager) cleanupNoTrackChain() error {
|
func (m *Manager) cleanupNoTrackChain() error {
|
||||||
exists, err := m.ipv4Client.ChainExists(tableRaw, chainNameRaw)
|
exists, err := m.ipv4Client.ChainExists(tableRaw, chainNameRaw)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
if !m.rawSupported {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
return fmt.Errorf("check chain exists: %w", err)
|
return fmt.Errorf("check chain exists: %w", err)
|
||||||
}
|
}
|
||||||
if !exists {
|
if !exists {
|
||||||
@@ -401,6 +422,7 @@ func (m *Manager) cleanupNoTrackChain() error {
|
|||||||
return fmt.Errorf("clear and delete chain: %w", err)
|
return fmt.Errorf("clear and delete chain: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
m.rawSupported = false
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -47,8 +47,6 @@ func (i *iFaceMock) Address() wgaddr.Address {
|
|||||||
panic("AddressFunc is not set")
|
panic("AddressFunc is not set")
|
||||||
}
|
}
|
||||||
|
|
||||||
func (i *iFaceMock) IsUserspaceBind() bool { return false }
|
|
||||||
|
|
||||||
func TestIptablesManager(t *testing.T) {
|
func TestIptablesManager(t *testing.T) {
|
||||||
ipv4Client, err := iptables.NewWithProtocol(iptables.ProtocolIPv4)
|
ipv4Client, err := iptables.NewWithProtocol(iptables.ProtocolIPv4)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|||||||
@@ -36,6 +36,7 @@ const (
|
|||||||
chainRTFWDOUT = "NETBIRD-RT-FWD-OUT"
|
chainRTFWDOUT = "NETBIRD-RT-FWD-OUT"
|
||||||
chainRTPRE = "NETBIRD-RT-PRE"
|
chainRTPRE = "NETBIRD-RT-PRE"
|
||||||
chainRTRDR = "NETBIRD-RT-RDR"
|
chainRTRDR = "NETBIRD-RT-RDR"
|
||||||
|
chainNATOutput = "NETBIRD-NAT-OUTPUT"
|
||||||
chainRTMSSCLAMP = "NETBIRD-RT-MSSCLAMP"
|
chainRTMSSCLAMP = "NETBIRD-RT-MSSCLAMP"
|
||||||
routingFinalForwardJump = "ACCEPT"
|
routingFinalForwardJump = "ACCEPT"
|
||||||
routingFinalNatJump = "MASQUERADE"
|
routingFinalNatJump = "MASQUERADE"
|
||||||
@@ -43,6 +44,7 @@ const (
|
|||||||
jumpManglePre = "jump-mangle-pre"
|
jumpManglePre = "jump-mangle-pre"
|
||||||
jumpNatPre = "jump-nat-pre"
|
jumpNatPre = "jump-nat-pre"
|
||||||
jumpNatPost = "jump-nat-post"
|
jumpNatPost = "jump-nat-post"
|
||||||
|
jumpNatOutput = "jump-nat-output"
|
||||||
jumpMSSClamp = "jump-mss-clamp"
|
jumpMSSClamp = "jump-mss-clamp"
|
||||||
markManglePre = "mark-mangle-pre"
|
markManglePre = "mark-mangle-pre"
|
||||||
markManglePost = "mark-mangle-post"
|
markManglePost = "mark-mangle-post"
|
||||||
@@ -387,6 +389,14 @@ func (r *router) cleanUpDefaultForwardRules() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
log.Debug("flushing routing related tables")
|
log.Debug("flushing routing related tables")
|
||||||
|
|
||||||
|
// Remove jump rules from built-in chains before deleting custom chains,
|
||||||
|
// otherwise the chain deletion fails with "device or resource busy".
|
||||||
|
jumpRule := []string{"-j", chainNATOutput}
|
||||||
|
if err := r.iptablesClient.Delete(tableNat, "OUTPUT", jumpRule...); err != nil {
|
||||||
|
log.Debugf("clean OUTPUT jump rule: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
for _, chainInfo := range []struct {
|
for _, chainInfo := range []struct {
|
||||||
chain string
|
chain string
|
||||||
table string
|
table string
|
||||||
@@ -396,6 +406,7 @@ func (r *router) cleanUpDefaultForwardRules() error {
|
|||||||
{chainRTPRE, tableMangle},
|
{chainRTPRE, tableMangle},
|
||||||
{chainRTNAT, tableNat},
|
{chainRTNAT, tableNat},
|
||||||
{chainRTRDR, tableNat},
|
{chainRTRDR, tableNat},
|
||||||
|
{chainNATOutput, tableNat},
|
||||||
{chainRTMSSCLAMP, tableMangle},
|
{chainRTMSSCLAMP, tableMangle},
|
||||||
} {
|
} {
|
||||||
ok, err := r.iptablesClient.ChainExists(chainInfo.table, chainInfo.chain)
|
ok, err := r.iptablesClient.ChainExists(chainInfo.table, chainInfo.chain)
|
||||||
@@ -970,6 +981,81 @@ func (r *router) RemoveInboundDNAT(localAddr netip.Addr, protocol firewall.Proto
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ensureNATOutputChain lazily creates the OUTPUT NAT chain and jump rule on first use.
|
||||||
|
func (r *router) ensureNATOutputChain() error {
|
||||||
|
if _, exists := r.rules[jumpNatOutput]; exists {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
chainExists, err := r.iptablesClient.ChainExists(tableNat, chainNATOutput)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("check chain %s: %w", chainNATOutput, err)
|
||||||
|
}
|
||||||
|
if !chainExists {
|
||||||
|
if err := r.iptablesClient.NewChain(tableNat, chainNATOutput); err != nil {
|
||||||
|
return fmt.Errorf("create chain %s: %w", chainNATOutput, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
jumpRule := []string{"-j", chainNATOutput}
|
||||||
|
if err := r.iptablesClient.Insert(tableNat, "OUTPUT", 1, jumpRule...); err != nil {
|
||||||
|
if !chainExists {
|
||||||
|
if delErr := r.iptablesClient.ClearAndDeleteChain(tableNat, chainNATOutput); delErr != nil {
|
||||||
|
log.Warnf("failed to rollback chain %s: %v", chainNATOutput, delErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return fmt.Errorf("add OUTPUT jump rule: %w", err)
|
||||||
|
}
|
||||||
|
r.rules[jumpNatOutput] = jumpRule
|
||||||
|
|
||||||
|
r.updateState()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddOutputDNAT adds an OUTPUT chain DNAT rule for locally-generated traffic.
|
||||||
|
func (r *router) AddOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
ruleID := fmt.Sprintf("output-dnat-%s-%s-%d-%d", localAddr.String(), protocol, sourcePort, targetPort)
|
||||||
|
|
||||||
|
if _, exists := r.rules[ruleID]; exists {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := r.ensureNATOutputChain(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
dnatRule := []string{
|
||||||
|
"-p", strings.ToLower(string(protocol)),
|
||||||
|
"--dport", strconv.Itoa(int(sourcePort)),
|
||||||
|
"-d", localAddr.String(),
|
||||||
|
"-j", "DNAT",
|
||||||
|
"--to-destination", ":" + strconv.Itoa(int(targetPort)),
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := r.iptablesClient.Append(tableNat, chainNATOutput, dnatRule...); err != nil {
|
||||||
|
return fmt.Errorf("add output DNAT rule: %w", err)
|
||||||
|
}
|
||||||
|
r.rules[ruleID] = dnatRule
|
||||||
|
|
||||||
|
r.updateState()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveOutputDNAT removes an OUTPUT chain DNAT rule.
|
||||||
|
func (r *router) RemoveOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
ruleID := fmt.Sprintf("output-dnat-%s-%s-%d-%d", localAddr.String(), protocol, sourcePort, targetPort)
|
||||||
|
|
||||||
|
if dnatRule, exists := r.rules[ruleID]; exists {
|
||||||
|
if err := r.iptablesClient.Delete(tableNat, chainNATOutput, dnatRule...); err != nil {
|
||||||
|
return fmt.Errorf("delete output DNAT rule: %w", err)
|
||||||
|
}
|
||||||
|
delete(r.rules, ruleID)
|
||||||
|
}
|
||||||
|
|
||||||
|
r.updateState()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func applyPort(flag string, port *firewall.Port) []string {
|
func applyPort(flag string, port *firewall.Port) []string {
|
||||||
if port == nil {
|
if port == nil {
|
||||||
return nil
|
return nil
|
||||||
|
|||||||
@@ -9,10 +9,9 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type InterfaceState struct {
|
type InterfaceState struct {
|
||||||
NameStr string `json:"name"`
|
NameStr string `json:"name"`
|
||||||
WGAddress wgaddr.Address `json:"wg_address"`
|
WGAddress wgaddr.Address `json:"wg_address"`
|
||||||
UserspaceBind bool `json:"userspace_bind"`
|
MTU uint16 `json:"mtu"`
|
||||||
MTU uint16 `json:"mtu"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (i *InterfaceState) Name() string {
|
func (i *InterfaceState) Name() string {
|
||||||
@@ -23,10 +22,6 @@ func (i *InterfaceState) Address() wgaddr.Address {
|
|||||||
return i.WGAddress
|
return i.WGAddress
|
||||||
}
|
}
|
||||||
|
|
||||||
func (i *InterfaceState) IsUserspaceBind() bool {
|
|
||||||
return i.UserspaceBind
|
|
||||||
}
|
|
||||||
|
|
||||||
type ShutdownState struct {
|
type ShutdownState struct {
|
||||||
sync.Mutex
|
sync.Mutex
|
||||||
|
|
||||||
|
|||||||
@@ -169,6 +169,14 @@ type Manager interface {
|
|||||||
// RemoveInboundDNAT removes inbound DNAT rule
|
// RemoveInboundDNAT removes inbound DNAT rule
|
||||||
RemoveInboundDNAT(localAddr netip.Addr, protocol Protocol, sourcePort, targetPort uint16) error
|
RemoveInboundDNAT(localAddr netip.Addr, protocol Protocol, sourcePort, targetPort uint16) error
|
||||||
|
|
||||||
|
// AddOutputDNAT adds an OUTPUT chain DNAT rule for locally-generated traffic.
|
||||||
|
// localAddr must be IPv4; the underlying iptables/nftables backends are IPv4-only.
|
||||||
|
AddOutputDNAT(localAddr netip.Addr, protocol Protocol, sourcePort, targetPort uint16) error
|
||||||
|
|
||||||
|
// RemoveOutputDNAT removes an OUTPUT chain DNAT rule.
|
||||||
|
// localAddr must be IPv4; the underlying iptables/nftables backends are IPv4-only.
|
||||||
|
RemoveOutputDNAT(localAddr netip.Addr, protocol Protocol, sourcePort, targetPort uint16) error
|
||||||
|
|
||||||
// SetupEBPFProxyNoTrack creates static notrack rules for eBPF proxy loopback traffic.
|
// SetupEBPFProxyNoTrack creates static notrack rules for eBPF proxy loopback traffic.
|
||||||
// This prevents conntrack from interfering with WireGuard proxy communication.
|
// This prevents conntrack from interfering with WireGuard proxy communication.
|
||||||
SetupEBPFProxyNoTrack(proxyPort, wgPort uint16) error
|
SetupEBPFProxyNoTrack(proxyPort, wgPort uint16) error
|
||||||
|
|||||||
@@ -40,7 +40,6 @@ func getTableName() string {
|
|||||||
type iFaceMapper interface {
|
type iFaceMapper interface {
|
||||||
Name() string
|
Name() string
|
||||||
Address() wgaddr.Address
|
Address() wgaddr.Address
|
||||||
IsUserspaceBind() bool
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Manager of iptables firewall
|
// Manager of iptables firewall
|
||||||
@@ -95,7 +94,7 @@ func (m *Manager) Init(stateManager *statemanager.Manager) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err := m.initNoTrackChains(workTable); err != nil {
|
if err := m.initNoTrackChains(workTable); err != nil {
|
||||||
return fmt.Errorf("init notrack chains: %w", err)
|
log.Warnf("raw priority chains not available, notrack rules will be disabled: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
stateManager.RegisterState(&ShutdownState{})
|
stateManager.RegisterState(&ShutdownState{})
|
||||||
@@ -106,10 +105,9 @@ func (m *Manager) Init(stateManager *statemanager.Manager) error {
|
|||||||
// cleanup using Close() without needing to store specific rules.
|
// cleanup using Close() without needing to store specific rules.
|
||||||
if err := stateManager.UpdateState(&ShutdownState{
|
if err := stateManager.UpdateState(&ShutdownState{
|
||||||
InterfaceState: &InterfaceState{
|
InterfaceState: &InterfaceState{
|
||||||
NameStr: m.wgIface.Name(),
|
NameStr: m.wgIface.Name(),
|
||||||
WGAddress: m.wgIface.Address(),
|
WGAddress: m.wgIface.Address(),
|
||||||
UserspaceBind: m.wgIface.IsUserspaceBind(),
|
MTU: m.router.mtu,
|
||||||
MTU: m.router.mtu,
|
|
||||||
},
|
},
|
||||||
}); err != nil {
|
}); err != nil {
|
||||||
log.Errorf("failed to update state: %v", err)
|
log.Errorf("failed to update state: %v", err)
|
||||||
@@ -205,12 +203,10 @@ func (m *Manager) RemoveNatRule(pair firewall.RouterPair) error {
|
|||||||
return m.router.RemoveNatRule(pair)
|
return m.router.RemoveNatRule(pair)
|
||||||
}
|
}
|
||||||
|
|
||||||
// AllowNetbird allows netbird interface traffic
|
// AllowNetbird allows netbird interface traffic.
|
||||||
|
// This is called when USPFilter wraps the native firewall, adding blanket accept
|
||||||
|
// rules so that packet filtering is handled in userspace instead of by netfilter.
|
||||||
func (m *Manager) AllowNetbird() error {
|
func (m *Manager) AllowNetbird() error {
|
||||||
if !m.wgIface.IsUserspaceBind() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
m.mutex.Lock()
|
m.mutex.Lock()
|
||||||
defer m.mutex.Unlock()
|
defer m.mutex.Unlock()
|
||||||
|
|
||||||
@@ -346,6 +342,22 @@ func (m *Manager) RemoveInboundDNAT(localAddr netip.Addr, protocol firewall.Prot
|
|||||||
return m.router.RemoveInboundDNAT(localAddr, protocol, sourcePort, targetPort)
|
return m.router.RemoveInboundDNAT(localAddr, protocol, sourcePort, targetPort)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AddOutputDNAT adds an OUTPUT chain DNAT rule for locally-generated traffic.
|
||||||
|
func (m *Manager) AddOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
m.mutex.Lock()
|
||||||
|
defer m.mutex.Unlock()
|
||||||
|
|
||||||
|
return m.router.AddOutputDNAT(localAddr, protocol, sourcePort, targetPort)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveOutputDNAT removes an OUTPUT chain DNAT rule.
|
||||||
|
func (m *Manager) RemoveOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
m.mutex.Lock()
|
||||||
|
defer m.mutex.Unlock()
|
||||||
|
|
||||||
|
return m.router.RemoveOutputDNAT(localAddr, protocol, sourcePort, targetPort)
|
||||||
|
}
|
||||||
|
|
||||||
const (
|
const (
|
||||||
chainNameRawOutput = "netbird-raw-out"
|
chainNameRawOutput = "netbird-raw-out"
|
||||||
chainNameRawPrerouting = "netbird-raw-pre"
|
chainNameRawPrerouting = "netbird-raw-pre"
|
||||||
|
|||||||
@@ -52,8 +52,6 @@ func (i *iFaceMock) Address() wgaddr.Address {
|
|||||||
panic("AddressFunc is not set")
|
panic("AddressFunc is not set")
|
||||||
}
|
}
|
||||||
|
|
||||||
func (i *iFaceMock) IsUserspaceBind() bool { return false }
|
|
||||||
|
|
||||||
func TestNftablesManager(t *testing.T) {
|
func TestNftablesManager(t *testing.T) {
|
||||||
|
|
||||||
// just check on the local interface
|
// just check on the local interface
|
||||||
|
|||||||
@@ -36,6 +36,7 @@ const (
|
|||||||
chainNameRoutingFw = "netbird-rt-fwd"
|
chainNameRoutingFw = "netbird-rt-fwd"
|
||||||
chainNameRoutingNat = "netbird-rt-postrouting"
|
chainNameRoutingNat = "netbird-rt-postrouting"
|
||||||
chainNameRoutingRdr = "netbird-rt-redirect"
|
chainNameRoutingRdr = "netbird-rt-redirect"
|
||||||
|
chainNameNATOutput = "netbird-nat-output"
|
||||||
chainNameForward = "FORWARD"
|
chainNameForward = "FORWARD"
|
||||||
chainNameMangleForward = "netbird-mangle-forward"
|
chainNameMangleForward = "netbird-mangle-forward"
|
||||||
|
|
||||||
@@ -1853,6 +1854,130 @@ func (r *router) RemoveInboundDNAT(localAddr netip.Addr, protocol firewall.Proto
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ensureNATOutputChain lazily creates the OUTPUT NAT chain on first use.
|
||||||
|
func (r *router) ensureNATOutputChain() error {
|
||||||
|
if _, exists := r.chains[chainNameNATOutput]; exists {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
r.chains[chainNameNATOutput] = r.conn.AddChain(&nftables.Chain{
|
||||||
|
Name: chainNameNATOutput,
|
||||||
|
Table: r.workTable,
|
||||||
|
Hooknum: nftables.ChainHookOutput,
|
||||||
|
Priority: nftables.ChainPriorityNATDest,
|
||||||
|
Type: nftables.ChainTypeNAT,
|
||||||
|
})
|
||||||
|
|
||||||
|
if err := r.conn.Flush(); err != nil {
|
||||||
|
delete(r.chains, chainNameNATOutput)
|
||||||
|
return fmt.Errorf("create NAT output chain: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddOutputDNAT adds an OUTPUT chain DNAT rule for locally-generated traffic.
|
||||||
|
func (r *router) AddOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
ruleID := fmt.Sprintf("output-dnat-%s-%s-%d-%d", localAddr.String(), protocol, sourcePort, targetPort)
|
||||||
|
|
||||||
|
if _, exists := r.rules[ruleID]; exists {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := r.ensureNATOutputChain(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
protoNum, err := protoToInt(protocol)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("convert protocol to number: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
exprs := []expr.Any{
|
||||||
|
&expr.Meta{Key: expr.MetaKeyL4PROTO, Register: 1},
|
||||||
|
&expr.Cmp{
|
||||||
|
Op: expr.CmpOpEq,
|
||||||
|
Register: 1,
|
||||||
|
Data: []byte{protoNum},
|
||||||
|
},
|
||||||
|
&expr.Payload{
|
||||||
|
DestRegister: 2,
|
||||||
|
Base: expr.PayloadBaseTransportHeader,
|
||||||
|
Offset: 2,
|
||||||
|
Len: 2,
|
||||||
|
},
|
||||||
|
&expr.Cmp{
|
||||||
|
Op: expr.CmpOpEq,
|
||||||
|
Register: 2,
|
||||||
|
Data: binaryutil.BigEndian.PutUint16(sourcePort),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
exprs = append(exprs, applyPrefix(netip.PrefixFrom(localAddr, 32), false)...)
|
||||||
|
|
||||||
|
exprs = append(exprs,
|
||||||
|
&expr.Immediate{
|
||||||
|
Register: 1,
|
||||||
|
Data: localAddr.AsSlice(),
|
||||||
|
},
|
||||||
|
&expr.Immediate{
|
||||||
|
Register: 2,
|
||||||
|
Data: binaryutil.BigEndian.PutUint16(targetPort),
|
||||||
|
},
|
||||||
|
&expr.NAT{
|
||||||
|
Type: expr.NATTypeDestNAT,
|
||||||
|
Family: uint32(nftables.TableFamilyIPv4),
|
||||||
|
RegAddrMin: 1,
|
||||||
|
RegProtoMin: 2,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
dnatRule := &nftables.Rule{
|
||||||
|
Table: r.workTable,
|
||||||
|
Chain: r.chains[chainNameNATOutput],
|
||||||
|
Exprs: exprs,
|
||||||
|
UserData: []byte(ruleID),
|
||||||
|
}
|
||||||
|
r.conn.AddRule(dnatRule)
|
||||||
|
|
||||||
|
if err := r.conn.Flush(); err != nil {
|
||||||
|
return fmt.Errorf("add output DNAT rule: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
r.rules[ruleID] = dnatRule
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveOutputDNAT removes an OUTPUT chain DNAT rule.
|
||||||
|
func (r *router) RemoveOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
if err := r.refreshRulesMap(); err != nil {
|
||||||
|
return fmt.Errorf(refreshRulesMapError, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
ruleID := fmt.Sprintf("output-dnat-%s-%s-%d-%d", localAddr.String(), protocol, sourcePort, targetPort)
|
||||||
|
|
||||||
|
rule, exists := r.rules[ruleID]
|
||||||
|
if !exists {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if rule.Handle == 0 {
|
||||||
|
log.Warnf("output DNAT rule %s has no handle, removing stale entry", ruleID)
|
||||||
|
delete(r.rules, ruleID)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := r.conn.DelRule(rule); err != nil {
|
||||||
|
return fmt.Errorf("delete output DNAT rule %s: %w", ruleID, err)
|
||||||
|
}
|
||||||
|
if err := r.conn.Flush(); err != nil {
|
||||||
|
return fmt.Errorf("flush delete output DNAT rule: %w", err)
|
||||||
|
}
|
||||||
|
delete(r.rules, ruleID)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// applyNetwork generates nftables expressions for networks (CIDR) or sets
|
// applyNetwork generates nftables expressions for networks (CIDR) or sets
|
||||||
func (r *router) applyNetwork(
|
func (r *router) applyNetwork(
|
||||||
network firewall.Network,
|
network firewall.Network,
|
||||||
|
|||||||
@@ -8,10 +8,9 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type InterfaceState struct {
|
type InterfaceState struct {
|
||||||
NameStr string `json:"name"`
|
NameStr string `json:"name"`
|
||||||
WGAddress wgaddr.Address `json:"wg_address"`
|
WGAddress wgaddr.Address `json:"wg_address"`
|
||||||
UserspaceBind bool `json:"userspace_bind"`
|
MTU uint16 `json:"mtu"`
|
||||||
MTU uint16 `json:"mtu"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (i *InterfaceState) Name() string {
|
func (i *InterfaceState) Name() string {
|
||||||
@@ -22,10 +21,6 @@ func (i *InterfaceState) Address() wgaddr.Address {
|
|||||||
return i.WGAddress
|
return i.WGAddress
|
||||||
}
|
}
|
||||||
|
|
||||||
func (i *InterfaceState) IsUserspaceBind() bool {
|
|
||||||
return i.UserspaceBind
|
|
||||||
}
|
|
||||||
|
|
||||||
type ShutdownState struct {
|
type ShutdownState struct {
|
||||||
InterfaceState *InterfaceState `json:"interface_state,omitempty"`
|
InterfaceState *InterfaceState `json:"interface_state,omitempty"`
|
||||||
}
|
}
|
||||||
|
|||||||
37
client/firewall/uspfilter/common/hooks.go
Normal file
37
client/firewall/uspfilter/common/hooks.go
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
package common
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/netip"
|
||||||
|
"sync/atomic"
|
||||||
|
)
|
||||||
|
|
||||||
|
// PacketHook stores a registered hook for a specific IP:port.
|
||||||
|
type PacketHook struct {
|
||||||
|
IP netip.Addr
|
||||||
|
Port uint16
|
||||||
|
Fn func([]byte) bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// HookMatches checks if a packet's destination matches the hook and invokes it.
|
||||||
|
func HookMatches(h *PacketHook, dstIP netip.Addr, dport uint16, packetData []byte) bool {
|
||||||
|
if h == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if h.IP == dstIP && h.Port == dport {
|
||||||
|
return h.Fn(packetData)
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetHook atomically stores a hook, handling nil removal.
|
||||||
|
func SetHook(ptr *atomic.Pointer[PacketHook], ip netip.Addr, dPort uint16, hook func([]byte) bool) {
|
||||||
|
if hook == nil {
|
||||||
|
ptr.Store(nil)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ptr.Store(&PacketHook{
|
||||||
|
IP: ip,
|
||||||
|
Port: dPort,
|
||||||
|
Fn: hook,
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -140,6 +140,10 @@ type Manager struct {
|
|||||||
mtu uint16
|
mtu uint16
|
||||||
mssClampValue uint16
|
mssClampValue uint16
|
||||||
mssClampEnabled bool
|
mssClampEnabled bool
|
||||||
|
|
||||||
|
// Only one hook per protocol is supported. Outbound direction only.
|
||||||
|
udpHookOut atomic.Pointer[common.PacketHook]
|
||||||
|
tcpHookOut atomic.Pointer[common.PacketHook]
|
||||||
}
|
}
|
||||||
|
|
||||||
// decoder for packages
|
// decoder for packages
|
||||||
@@ -594,6 +598,8 @@ func (m *Manager) resetState() {
|
|||||||
maps.Clear(m.incomingRules)
|
maps.Clear(m.incomingRules)
|
||||||
maps.Clear(m.routeRulesMap)
|
maps.Clear(m.routeRulesMap)
|
||||||
m.routeRules = m.routeRules[:0]
|
m.routeRules = m.routeRules[:0]
|
||||||
|
m.udpHookOut.Store(nil)
|
||||||
|
m.tcpHookOut.Store(nil)
|
||||||
|
|
||||||
if m.udpTracker != nil {
|
if m.udpTracker != nil {
|
||||||
m.udpTracker.Close()
|
m.udpTracker.Close()
|
||||||
@@ -713,6 +719,9 @@ func (m *Manager) filterOutbound(packetData []byte, size int) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
case layers.LayerTypeTCP:
|
case layers.LayerTypeTCP:
|
||||||
|
if m.tcpHooksDrop(uint16(d.tcp.DstPort), dstIP, packetData) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
// Clamp MSS on all TCP SYN packets, including those from local IPs.
|
// Clamp MSS on all TCP SYN packets, including those from local IPs.
|
||||||
// SNATed routed traffic may appear as local IP but still requires clamping.
|
// SNATed routed traffic may appear as local IP but still requires clamping.
|
||||||
if m.mssClampEnabled {
|
if m.mssClampEnabled {
|
||||||
@@ -895,39 +904,12 @@ func (m *Manager) trackInbound(d *decoder, srcIP, dstIP netip.Addr, ruleID []byt
|
|||||||
d.dnatOrigPort = 0
|
d.dnatOrigPort = 0
|
||||||
}
|
}
|
||||||
|
|
||||||
// udpHooksDrop checks if any UDP hooks should drop the packet
|
|
||||||
func (m *Manager) udpHooksDrop(dport uint16, dstIP netip.Addr, packetData []byte) bool {
|
func (m *Manager) udpHooksDrop(dport uint16, dstIP netip.Addr, packetData []byte) bool {
|
||||||
m.mutex.RLock()
|
return common.HookMatches(m.udpHookOut.Load(), dstIP, dport, packetData)
|
||||||
defer m.mutex.RUnlock()
|
}
|
||||||
|
|
||||||
// Check specific destination IP first
|
func (m *Manager) tcpHooksDrop(dport uint16, dstIP netip.Addr, packetData []byte) bool {
|
||||||
if rules, exists := m.outgoingRules[dstIP]; exists {
|
return common.HookMatches(m.tcpHookOut.Load(), dstIP, dport, packetData)
|
||||||
for _, rule := range rules {
|
|
||||||
if rule.udpHook != nil && portsMatch(rule.dPort, dport) {
|
|
||||||
return rule.udpHook(packetData)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check IPv4 unspecified address
|
|
||||||
if rules, exists := m.outgoingRules[netip.IPv4Unspecified()]; exists {
|
|
||||||
for _, rule := range rules {
|
|
||||||
if rule.udpHook != nil && portsMatch(rule.dPort, dport) {
|
|
||||||
return rule.udpHook(packetData)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check IPv6 unspecified address
|
|
||||||
if rules, exists := m.outgoingRules[netip.IPv6Unspecified()]; exists {
|
|
||||||
for _, rule := range rules {
|
|
||||||
if rule.udpHook != nil && portsMatch(rule.dPort, dport) {
|
|
||||||
return rule.udpHook(packetData)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// filterInbound implements filtering logic for incoming packets.
|
// filterInbound implements filtering logic for incoming packets.
|
||||||
@@ -1278,12 +1260,6 @@ func validateRule(ip netip.Addr, packetData []byte, rules map[string]PeerRule, d
|
|||||||
return rule.mgmtId, rule.drop, true
|
return rule.mgmtId, rule.drop, true
|
||||||
}
|
}
|
||||||
case layers.LayerTypeUDP:
|
case layers.LayerTypeUDP:
|
||||||
// if rule has UDP hook (and if we are here we match this rule)
|
|
||||||
// we ignore rule.drop and call this hook
|
|
||||||
if rule.udpHook != nil {
|
|
||||||
return rule.mgmtId, rule.udpHook(packetData), true
|
|
||||||
}
|
|
||||||
|
|
||||||
if portsMatch(rule.sPort, uint16(d.udp.SrcPort)) && portsMatch(rule.dPort, uint16(d.udp.DstPort)) {
|
if portsMatch(rule.sPort, uint16(d.udp.SrcPort)) && portsMatch(rule.dPort, uint16(d.udp.DstPort)) {
|
||||||
return rule.mgmtId, rule.drop, true
|
return rule.mgmtId, rule.drop, true
|
||||||
}
|
}
|
||||||
@@ -1342,65 +1318,14 @@ func (m *Manager) ruleMatches(rule *RouteRule, srcAddr, dstAddr netip.Addr, prot
|
|||||||
return sourceMatched
|
return sourceMatched
|
||||||
}
|
}
|
||||||
|
|
||||||
// AddUDPPacketHook calls hook when UDP packet from given direction matched
|
// SetUDPPacketHook sets the outbound UDP packet hook. Pass nil hook to remove.
|
||||||
//
|
func (m *Manager) SetUDPPacketHook(ip netip.Addr, dPort uint16, hook func(packet []byte) bool) {
|
||||||
// Hook function returns flag which indicates should be the matched package dropped or not
|
common.SetHook(&m.udpHookOut, ip, dPort, hook)
|
||||||
func (m *Manager) AddUDPPacketHook(in bool, ip netip.Addr, dPort uint16, hook func(packet []byte) bool) string {
|
|
||||||
r := PeerRule{
|
|
||||||
id: uuid.New().String(),
|
|
||||||
ip: ip,
|
|
||||||
protoLayer: layers.LayerTypeUDP,
|
|
||||||
dPort: &firewall.Port{Values: []uint16{dPort}},
|
|
||||||
ipLayer: layers.LayerTypeIPv6,
|
|
||||||
udpHook: hook,
|
|
||||||
}
|
|
||||||
|
|
||||||
if ip.Is4() {
|
|
||||||
r.ipLayer = layers.LayerTypeIPv4
|
|
||||||
}
|
|
||||||
|
|
||||||
m.mutex.Lock()
|
|
||||||
if in {
|
|
||||||
// Incoming UDP hooks are stored in allow rules map
|
|
||||||
if _, ok := m.incomingRules[r.ip]; !ok {
|
|
||||||
m.incomingRules[r.ip] = make(map[string]PeerRule)
|
|
||||||
}
|
|
||||||
m.incomingRules[r.ip][r.id] = r
|
|
||||||
} else {
|
|
||||||
if _, ok := m.outgoingRules[r.ip]; !ok {
|
|
||||||
m.outgoingRules[r.ip] = make(map[string]PeerRule)
|
|
||||||
}
|
|
||||||
m.outgoingRules[r.ip][r.id] = r
|
|
||||||
}
|
|
||||||
m.mutex.Unlock()
|
|
||||||
|
|
||||||
return r.id
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemovePacketHook removes packet hook by given ID
|
// SetTCPPacketHook sets the outbound TCP packet hook. Pass nil hook to remove.
|
||||||
func (m *Manager) RemovePacketHook(hookID string) error {
|
func (m *Manager) SetTCPPacketHook(ip netip.Addr, dPort uint16, hook func(packet []byte) bool) {
|
||||||
m.mutex.Lock()
|
common.SetHook(&m.tcpHookOut, ip, dPort, hook)
|
||||||
defer m.mutex.Unlock()
|
|
||||||
|
|
||||||
// Check incoming hooks (stored in allow rules)
|
|
||||||
for _, arr := range m.incomingRules {
|
|
||||||
for _, r := range arr {
|
|
||||||
if r.id == hookID {
|
|
||||||
delete(arr, r.id)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Check outgoing hooks
|
|
||||||
for _, arr := range m.outgoingRules {
|
|
||||||
for _, r := range arr {
|
|
||||||
if r.id == hookID {
|
|
||||||
delete(arr, r.id)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return fmt.Errorf("hook with given id not found")
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetLogLevel sets the log level for the firewall manager
|
// SetLogLevel sets the log level for the firewall manager
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ import (
|
|||||||
"github.com/google/gopacket"
|
"github.com/google/gopacket"
|
||||||
"github.com/google/gopacket/layers"
|
"github.com/google/gopacket/layers"
|
||||||
"github.com/sirupsen/logrus"
|
"github.com/sirupsen/logrus"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
wgdevice "golang.zx2c4.com/wireguard/device"
|
wgdevice "golang.zx2c4.com/wireguard/device"
|
||||||
|
|
||||||
@@ -186,81 +187,52 @@ func TestManagerDeleteRule(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestAddUDPPacketHook(t *testing.T) {
|
func TestSetUDPPacketHook(t *testing.T) {
|
||||||
tests := []struct {
|
manager, err := Create(&IFaceMock{
|
||||||
name string
|
SetFilterFunc: func(device.PacketFilter) error { return nil },
|
||||||
in bool
|
}, false, flowLogger, nbiface.DefaultMTU)
|
||||||
expDir fw.RuleDirection
|
require.NoError(t, err)
|
||||||
ip netip.Addr
|
t.Cleanup(func() { require.NoError(t, manager.Close(nil)) })
|
||||||
dPort uint16
|
|
||||||
hook func([]byte) bool
|
|
||||||
expectedID string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "Test Outgoing UDP Packet Hook",
|
|
||||||
in: false,
|
|
||||||
expDir: fw.RuleDirectionOUT,
|
|
||||||
ip: netip.MustParseAddr("10.168.0.1"),
|
|
||||||
dPort: 8000,
|
|
||||||
hook: func([]byte) bool { return true },
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "Test Incoming UDP Packet Hook",
|
|
||||||
in: true,
|
|
||||||
expDir: fw.RuleDirectionIN,
|
|
||||||
ip: netip.MustParseAddr("::1"),
|
|
||||||
dPort: 9000,
|
|
||||||
hook: func([]byte) bool { return false },
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
var called bool
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
manager.SetUDPPacketHook(netip.MustParseAddr("10.168.0.1"), 8000, func([]byte) bool {
|
||||||
manager, err := Create(&IFaceMock{
|
called = true
|
||||||
SetFilterFunc: func(device.PacketFilter) error { return nil },
|
return true
|
||||||
}, false, flowLogger, nbiface.DefaultMTU)
|
})
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
manager.AddUDPPacketHook(tt.in, tt.ip, tt.dPort, tt.hook)
|
h := manager.udpHookOut.Load()
|
||||||
|
require.NotNil(t, h)
|
||||||
|
assert.Equal(t, netip.MustParseAddr("10.168.0.1"), h.IP)
|
||||||
|
assert.Equal(t, uint16(8000), h.Port)
|
||||||
|
assert.True(t, h.Fn(nil))
|
||||||
|
assert.True(t, called)
|
||||||
|
|
||||||
var addedRule PeerRule
|
manager.SetUDPPacketHook(netip.MustParseAddr("10.168.0.1"), 8000, nil)
|
||||||
if tt.in {
|
assert.Nil(t, manager.udpHookOut.Load())
|
||||||
// Incoming UDP hooks are stored in allow rules map
|
}
|
||||||
if len(manager.incomingRules[tt.ip]) != 1 {
|
|
||||||
t.Errorf("expected 1 incoming rule, got %d", len(manager.incomingRules[tt.ip]))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
for _, rule := range manager.incomingRules[tt.ip] {
|
|
||||||
addedRule = rule
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if len(manager.outgoingRules[tt.ip]) != 1 {
|
|
||||||
t.Errorf("expected 1 outgoing rule, got %d", len(manager.outgoingRules[tt.ip]))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
for _, rule := range manager.outgoingRules[tt.ip] {
|
|
||||||
addedRule = rule
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if tt.ip.Compare(addedRule.ip) != 0 {
|
func TestSetTCPPacketHook(t *testing.T) {
|
||||||
t.Errorf("expected ip %s, got %s", tt.ip, addedRule.ip)
|
manager, err := Create(&IFaceMock{
|
||||||
return
|
SetFilterFunc: func(device.PacketFilter) error { return nil },
|
||||||
}
|
}, false, flowLogger, nbiface.DefaultMTU)
|
||||||
if tt.dPort != addedRule.dPort.Values[0] {
|
require.NoError(t, err)
|
||||||
t.Errorf("expected dPort %d, got %d", tt.dPort, addedRule.dPort.Values[0])
|
t.Cleanup(func() { require.NoError(t, manager.Close(nil)) })
|
||||||
return
|
|
||||||
}
|
var called bool
|
||||||
if layers.LayerTypeUDP != addedRule.protoLayer {
|
manager.SetTCPPacketHook(netip.MustParseAddr("10.168.0.1"), 53, func([]byte) bool {
|
||||||
t.Errorf("expected protoLayer %s, got %s", layers.LayerTypeUDP, addedRule.protoLayer)
|
called = true
|
||||||
return
|
return true
|
||||||
}
|
})
|
||||||
if addedRule.udpHook == nil {
|
|
||||||
t.Errorf("expected udpHook to be set")
|
h := manager.tcpHookOut.Load()
|
||||||
return
|
require.NotNil(t, h)
|
||||||
}
|
assert.Equal(t, netip.MustParseAddr("10.168.0.1"), h.IP)
|
||||||
})
|
assert.Equal(t, uint16(53), h.Port)
|
||||||
}
|
assert.True(t, h.Fn(nil))
|
||||||
|
assert.True(t, called)
|
||||||
|
|
||||||
|
manager.SetTCPPacketHook(netip.MustParseAddr("10.168.0.1"), 53, nil)
|
||||||
|
assert.Nil(t, manager.tcpHookOut.Load())
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestPeerRuleLifecycleDenyRules verifies that deny rules are correctly added
|
// TestPeerRuleLifecycleDenyRules verifies that deny rules are correctly added
|
||||||
@@ -530,39 +502,12 @@ func TestRemovePacketHook(t *testing.T) {
|
|||||||
require.NoError(t, manager.Close(nil))
|
require.NoError(t, manager.Close(nil))
|
||||||
}()
|
}()
|
||||||
|
|
||||||
// Add a UDP packet hook
|
manager.SetUDPPacketHook(netip.MustParseAddr("192.168.0.1"), 8080, func([]byte) bool { return true })
|
||||||
hookFunc := func(data []byte) bool { return true }
|
|
||||||
hookID := manager.AddUDPPacketHook(false, netip.MustParseAddr("192.168.0.1"), 8080, hookFunc)
|
|
||||||
|
|
||||||
// Assert the hook is added by finding it in the manager's outgoing rules
|
require.NotNil(t, manager.udpHookOut.Load(), "hook should be registered")
|
||||||
found := false
|
|
||||||
for _, arr := range manager.outgoingRules {
|
|
||||||
for _, rule := range arr {
|
|
||||||
if rule.id == hookID {
|
|
||||||
found = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if !found {
|
manager.SetUDPPacketHook(netip.MustParseAddr("192.168.0.1"), 8080, nil)
|
||||||
t.Fatalf("The hook was not added properly.")
|
assert.Nil(t, manager.udpHookOut.Load(), "hook should be removed")
|
||||||
}
|
|
||||||
|
|
||||||
// Now remove the packet hook
|
|
||||||
err = manager.RemovePacketHook(hookID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to remove hook: %s", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Assert the hook is removed by checking it in the manager's outgoing rules
|
|
||||||
for _, arr := range manager.outgoingRules {
|
|
||||||
for _, rule := range arr {
|
|
||||||
if rule.id == hookID {
|
|
||||||
t.Fatalf("The hook was not removed properly.")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestProcessOutgoingHooks(t *testing.T) {
|
func TestProcessOutgoingHooks(t *testing.T) {
|
||||||
@@ -592,8 +537,7 @@ func TestProcessOutgoingHooks(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
hookCalled := false
|
hookCalled := false
|
||||||
hookID := manager.AddUDPPacketHook(
|
manager.SetUDPPacketHook(
|
||||||
false,
|
|
||||||
netip.MustParseAddr("100.10.0.100"),
|
netip.MustParseAddr("100.10.0.100"),
|
||||||
53,
|
53,
|
||||||
func([]byte) bool {
|
func([]byte) bool {
|
||||||
@@ -601,7 +545,6 @@ func TestProcessOutgoingHooks(t *testing.T) {
|
|||||||
return true
|
return true
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
require.NotEmpty(t, hookID)
|
|
||||||
|
|
||||||
// Create test UDP packet
|
// Create test UDP packet
|
||||||
ipv4 := &layers.IPv4{
|
ipv4 := &layers.IPv4{
|
||||||
|
|||||||
90
client/firewall/uspfilter/hooks_filter.go
Normal file
90
client/firewall/uspfilter/hooks_filter.go
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
package uspfilter
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/binary"
|
||||||
|
"net/netip"
|
||||||
|
"sync/atomic"
|
||||||
|
|
||||||
|
"github.com/netbirdio/netbird/client/firewall/uspfilter/common"
|
||||||
|
"github.com/netbirdio/netbird/client/iface/device"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
ipv4HeaderMinLen = 20
|
||||||
|
ipv4ProtoOffset = 9
|
||||||
|
ipv4FlagsOffset = 6
|
||||||
|
ipv4DstOffset = 16
|
||||||
|
ipProtoUDP = 17
|
||||||
|
ipProtoTCP = 6
|
||||||
|
ipv4FragOffMask = 0x1fff
|
||||||
|
// dstPortOffset is the offset of the destination port within a UDP or TCP header.
|
||||||
|
dstPortOffset = 2
|
||||||
|
)
|
||||||
|
|
||||||
|
// HooksFilter is a minimal packet filter that only handles outbound DNS hooks.
|
||||||
|
// It is installed on the WireGuard interface when the userspace bind is active
|
||||||
|
// but a full firewall filter (Manager) is not needed because a native kernel
|
||||||
|
// firewall (nftables/iptables) handles packet filtering.
|
||||||
|
type HooksFilter struct {
|
||||||
|
udpHook atomic.Pointer[common.PacketHook]
|
||||||
|
tcpHook atomic.Pointer[common.PacketHook]
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ device.PacketFilter = (*HooksFilter)(nil)
|
||||||
|
|
||||||
|
// FilterOutbound checks outbound packets for DNS hook matches.
|
||||||
|
// Only IPv4 packets matching the registered hook IP:port are intercepted.
|
||||||
|
// IPv6 and non-IP packets pass through unconditionally.
|
||||||
|
func (f *HooksFilter) FilterOutbound(packetData []byte, _ int) bool {
|
||||||
|
if len(packetData) < ipv4HeaderMinLen {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only process IPv4 packets, let everything else pass through.
|
||||||
|
if packetData[0]>>4 != 4 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
ihl := int(packetData[0]&0x0f) * 4
|
||||||
|
if ihl < ipv4HeaderMinLen || len(packetData) < ihl+4 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Skip non-first fragments: they don't carry L4 headers.
|
||||||
|
flagsAndOffset := binary.BigEndian.Uint16(packetData[ipv4FlagsOffset : ipv4FlagsOffset+2])
|
||||||
|
if flagsAndOffset&ipv4FragOffMask != 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
dstIP, ok := netip.AddrFromSlice(packetData[ipv4DstOffset : ipv4DstOffset+4])
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
proto := packetData[ipv4ProtoOffset]
|
||||||
|
dstPort := binary.BigEndian.Uint16(packetData[ihl+dstPortOffset : ihl+dstPortOffset+2])
|
||||||
|
|
||||||
|
switch proto {
|
||||||
|
case ipProtoUDP:
|
||||||
|
return common.HookMatches(f.udpHook.Load(), dstIP, dstPort, packetData)
|
||||||
|
case ipProtoTCP:
|
||||||
|
return common.HookMatches(f.tcpHook.Load(), dstIP, dstPort, packetData)
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// FilterInbound allows all inbound packets (native firewall handles filtering).
|
||||||
|
func (f *HooksFilter) FilterInbound([]byte, int) bool {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUDPPacketHook registers the UDP packet hook.
|
||||||
|
func (f *HooksFilter) SetUDPPacketHook(ip netip.Addr, dPort uint16, hook func([]byte) bool) {
|
||||||
|
common.SetHook(&f.udpHook, ip, dPort, hook)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetTCPPacketHook registers the TCP packet hook.
|
||||||
|
func (f *HooksFilter) SetTCPPacketHook(ip netip.Addr, dPort uint16, hook func([]byte) bool) {
|
||||||
|
common.SetHook(&f.tcpHook, ip, dPort, hook)
|
||||||
|
}
|
||||||
@@ -144,6 +144,8 @@ func (m *localIPManager) UpdateLocalIPs(iface common.IFaceMapper) (err error) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
log.Warnf("failed to get interfaces: %v", err)
|
log.Warnf("failed to get interfaces: %v", err)
|
||||||
} else {
|
} else {
|
||||||
|
// TODO: filter out down interfaces (net.FlagUp). Also handle the reverse
|
||||||
|
// case where an interface comes up between refreshes.
|
||||||
for _, intf := range interfaces {
|
for _, intf := range interfaces {
|
||||||
m.processInterface(intf, &newIPv4Bitmap, ipv4Set, &ipv4Addresses)
|
m.processInterface(intf, &newIPv4Bitmap, ipv4Set, &ipv4Addresses)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -421,6 +421,7 @@ func (m *Manager) addPortRedirection(targetIP netip.Addr, protocol gopacket.Laye
|
|||||||
}
|
}
|
||||||
|
|
||||||
// AddInboundDNAT adds an inbound DNAT rule redirecting traffic from NetBird peers to local services.
|
// AddInboundDNAT adds an inbound DNAT rule redirecting traffic from NetBird peers to local services.
|
||||||
|
// TODO: also delegate to nativeFirewall when available for kernel WG mode
|
||||||
func (m *Manager) AddInboundDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
func (m *Manager) AddInboundDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
var layerType gopacket.LayerType
|
var layerType gopacket.LayerType
|
||||||
switch protocol {
|
switch protocol {
|
||||||
@@ -466,6 +467,22 @@ func (m *Manager) RemoveInboundDNAT(localAddr netip.Addr, protocol firewall.Prot
|
|||||||
return m.removePortRedirection(localAddr, layerType, sourcePort, targetPort)
|
return m.removePortRedirection(localAddr, layerType, sourcePort, targetPort)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AddOutputDNAT delegates to the native firewall if available.
|
||||||
|
func (m *Manager) AddOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
if m.nativeFirewall == nil {
|
||||||
|
return fmt.Errorf("output DNAT not supported without native firewall")
|
||||||
|
}
|
||||||
|
return m.nativeFirewall.AddOutputDNAT(localAddr, protocol, sourcePort, targetPort)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveOutputDNAT delegates to the native firewall if available.
|
||||||
|
func (m *Manager) RemoveOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error {
|
||||||
|
if m.nativeFirewall == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return m.nativeFirewall.RemoveOutputDNAT(localAddr, protocol, sourcePort, targetPort)
|
||||||
|
}
|
||||||
|
|
||||||
// translateInboundPortDNAT applies port-specific DNAT translation to inbound packets.
|
// translateInboundPortDNAT applies port-specific DNAT translation to inbound packets.
|
||||||
func (m *Manager) translateInboundPortDNAT(packetData []byte, d *decoder, srcIP, dstIP netip.Addr) bool {
|
func (m *Manager) translateInboundPortDNAT(packetData []byte, d *decoder, srcIP, dstIP netip.Addr) bool {
|
||||||
if !m.portDNATEnabled.Load() {
|
if !m.portDNATEnabled.Load() {
|
||||||
|
|||||||
@@ -18,9 +18,7 @@ type PeerRule struct {
|
|||||||
protoLayer gopacket.LayerType
|
protoLayer gopacket.LayerType
|
||||||
sPort *firewall.Port
|
sPort *firewall.Port
|
||||||
dPort *firewall.Port
|
dPort *firewall.Port
|
||||||
drop bool
|
drop bool
|
||||||
|
|
||||||
udpHook func([]byte) bool
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ID returns the rule id
|
// ID returns the rule id
|
||||||
|
|||||||
@@ -399,21 +399,17 @@ func TestTracePacket(t *testing.T) {
|
|||||||
{
|
{
|
||||||
name: "UDPTraffic_WithHook",
|
name: "UDPTraffic_WithHook",
|
||||||
setup: func(m *Manager) {
|
setup: func(m *Manager) {
|
||||||
hookFunc := func([]byte) bool {
|
m.SetUDPPacketHook(netip.MustParseAddr("100.10.255.254"), 53, func([]byte) bool {
|
||||||
return true
|
return true // drop (intercepted by hook)
|
||||||
}
|
})
|
||||||
m.AddUDPPacketHook(true, netip.MustParseAddr("1.1.1.1"), 53, hookFunc)
|
|
||||||
},
|
},
|
||||||
packetBuilder: func() *PacketBuilder {
|
packetBuilder: func() *PacketBuilder {
|
||||||
return createPacketBuilder("1.1.1.1", "100.10.0.100", "udp", 12345, 53, fw.RuleDirectionIN)
|
return createPacketBuilder("100.10.0.100", "100.10.255.254", "udp", 12345, 53, fw.RuleDirectionOUT)
|
||||||
},
|
},
|
||||||
expectedStages: []PacketStage{
|
expectedStages: []PacketStage{
|
||||||
StageReceived,
|
StageReceived,
|
||||||
StageInboundPortDNAT,
|
StageOutbound1to1NAT,
|
||||||
StageInbound1to1NAT,
|
StageOutboundPortReverse,
|
||||||
StageConntrack,
|
|
||||||
StageRouting,
|
|
||||||
StagePeerACL,
|
|
||||||
StageCompleted,
|
StageCompleted,
|
||||||
},
|
},
|
||||||
expectedAllow: false,
|
expectedAllow: false,
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ func Backoff(ctx context.Context) backoff.BackOff {
|
|||||||
|
|
||||||
// CreateConnection creates a gRPC client connection with the appropriate transport options.
|
// CreateConnection creates a gRPC client connection with the appropriate transport options.
|
||||||
// The component parameter specifies the WebSocket proxy component path (e.g., "/management", "/signal").
|
// The component parameter specifies the WebSocket proxy component path (e.g., "/management", "/signal").
|
||||||
func CreateConnection(ctx context.Context, addr string, tlsEnabled bool, component string) (*grpc.ClientConn, error) {
|
func CreateConnection(ctx context.Context, addr string, tlsEnabled bool, component string, extraOpts ...grpc.DialOption) (*grpc.ClientConn, error) {
|
||||||
transportOption := grpc.WithTransportCredentials(insecure.NewCredentials())
|
transportOption := grpc.WithTransportCredentials(insecure.NewCredentials())
|
||||||
// for js, the outer websocket layer takes care of tls
|
// for js, the outer websocket layer takes care of tls
|
||||||
if tlsEnabled && runtime.GOOS != "js" {
|
if tlsEnabled && runtime.GOOS != "js" {
|
||||||
@@ -46,9 +46,7 @@ func CreateConnection(ctx context.Context, addr string, tlsEnabled bool, compone
|
|||||||
connCtx, cancel := context.WithTimeout(ctx, 30*time.Second)
|
connCtx, cancel := context.WithTimeout(ctx, 30*time.Second)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
conn, err := grpc.DialContext(
|
opts := []grpc.DialOption{
|
||||||
connCtx,
|
|
||||||
addr,
|
|
||||||
transportOption,
|
transportOption,
|
||||||
WithCustomDialer(tlsEnabled, component),
|
WithCustomDialer(tlsEnabled, component),
|
||||||
grpc.WithBlock(),
|
grpc.WithBlock(),
|
||||||
@@ -56,7 +54,10 @@ func CreateConnection(ctx context.Context, addr string, tlsEnabled bool, compone
|
|||||||
Time: 30 * time.Second,
|
Time: 30 * time.Second,
|
||||||
Timeout: 10 * time.Second,
|
Timeout: 10 * time.Second,
|
||||||
}),
|
}),
|
||||||
)
|
}
|
||||||
|
opts = append(opts, extraOpts...)
|
||||||
|
|
||||||
|
conn, err := grpc.DialContext(connCtx, addr, opts...)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("dial context: %w", err)
|
return nil, fmt.Errorf("dial context: %w", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,20 +5,18 @@ package configurer
|
|||||||
import (
|
import (
|
||||||
"net"
|
"net"
|
||||||
|
|
||||||
log "github.com/sirupsen/logrus"
|
|
||||||
"golang.zx2c4.com/wireguard/ipc"
|
"golang.zx2c4.com/wireguard/ipc"
|
||||||
)
|
)
|
||||||
|
|
||||||
func openUAPI(deviceName string) (net.Listener, error) {
|
func openUAPI(deviceName string) (net.Listener, error) {
|
||||||
uapiSock, err := ipc.UAPIOpen(deviceName)
|
uapiSock, err := ipc.UAPIOpen(deviceName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Errorf("failed to open uapi socket: %v", err)
|
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
listener, err := ipc.UAPIListen(deviceName, uapiSock)
|
listener, err := ipc.UAPIListen(deviceName, uapiSock)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Errorf("failed to listen on uapi socket: %v", err)
|
_ = uapiSock.Close()
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -54,6 +54,14 @@ func NewUSPConfigurer(device *device.Device, deviceName string, activityRecorder
|
|||||||
return wgCfg
|
return wgCfg
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func NewUSPConfigurerNoUAPI(device *device.Device, deviceName string, activityRecorder *bind.ActivityRecorder) *WGUSPConfigurer {
|
||||||
|
return &WGUSPConfigurer{
|
||||||
|
device: device,
|
||||||
|
deviceName: deviceName,
|
||||||
|
activityRecorder: activityRecorder,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func (c *WGUSPConfigurer) ConfigureInterface(privateKey string, port int) error {
|
func (c *WGUSPConfigurer) ConfigureInterface(privateKey string, port int) error {
|
||||||
log.Debugf("adding Wireguard private key")
|
log.Debugf("adding Wireguard private key")
|
||||||
key, err := wgtypes.ParseKey(privateKey)
|
key, err := wgtypes.ParseKey(privateKey)
|
||||||
|
|||||||
@@ -15,14 +15,17 @@ type PacketFilter interface {
|
|||||||
// FilterInbound filter incoming packets from external sources to host
|
// FilterInbound filter incoming packets from external sources to host
|
||||||
FilterInbound(packetData []byte, size int) bool
|
FilterInbound(packetData []byte, size int) bool
|
||||||
|
|
||||||
// AddUDPPacketHook calls hook when UDP packet from given direction matched
|
// SetUDPPacketHook registers a hook for outbound UDP packets matching the given IP and port.
|
||||||
//
|
// Hook function returns true if the packet should be dropped.
|
||||||
// Hook function returns flag which indicates should be the matched package dropped or not.
|
// Only one UDP hook is supported; calling again replaces the previous hook.
|
||||||
// Hook function receives raw network packet data as argument.
|
// Pass nil hook to remove.
|
||||||
AddUDPPacketHook(in bool, ip netip.Addr, dPort uint16, hook func(packet []byte) bool) string
|
SetUDPPacketHook(ip netip.Addr, dPort uint16, hook func(packet []byte) bool)
|
||||||
|
|
||||||
// RemovePacketHook removes hook by ID
|
// SetTCPPacketHook registers a hook for outbound TCP packets matching the given IP and port.
|
||||||
RemovePacketHook(hookID string) error
|
// Hook function returns true if the packet should be dropped.
|
||||||
|
// Only one TCP hook is supported; calling again replaces the previous hook.
|
||||||
|
// Pass nil hook to remove.
|
||||||
|
SetTCPPacketHook(ip netip.Addr, dPort uint16, hook func(packet []byte) bool)
|
||||||
}
|
}
|
||||||
|
|
||||||
// FilteredDevice to override Read or Write of packets
|
// FilteredDevice to override Read or Write of packets
|
||||||
|
|||||||
@@ -79,7 +79,7 @@ func (t *TunNetstackDevice) create() (WGConfigurer, error) {
|
|||||||
device.NewLogger(wgLogLevel(), "[netbird] "),
|
device.NewLogger(wgLogLevel(), "[netbird] "),
|
||||||
)
|
)
|
||||||
|
|
||||||
t.configurer = configurer.NewUSPConfigurer(t.device, t.name, t.bind.ActivityRecorder())
|
t.configurer = configurer.NewUSPConfigurerNoUAPI(t.device, t.name, t.bind.ActivityRecorder())
|
||||||
err = t.configurer.ConfigureInterface(t.key, t.port)
|
err = t.configurer.ConfigureInterface(t.key, t.port)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if cErr := tunIface.Close(); cErr != nil {
|
if cErr := tunIface.Close(); cErr != nil {
|
||||||
|
|||||||
@@ -34,18 +34,28 @@ func (m *MockPacketFilter) EXPECT() *MockPacketFilterMockRecorder {
|
|||||||
return m.recorder
|
return m.recorder
|
||||||
}
|
}
|
||||||
|
|
||||||
// AddUDPPacketHook mocks base method.
|
// SetUDPPacketHook mocks base method.
|
||||||
func (m *MockPacketFilter) AddUDPPacketHook(arg0 bool, arg1 netip.Addr, arg2 uint16, arg3 func([]byte) bool) string {
|
func (m *MockPacketFilter) SetUDPPacketHook(arg0 netip.Addr, arg1 uint16, arg2 func([]byte) bool) {
|
||||||
m.ctrl.T.Helper()
|
m.ctrl.T.Helper()
|
||||||
ret := m.ctrl.Call(m, "AddUDPPacketHook", arg0, arg1, arg2, arg3)
|
m.ctrl.Call(m, "SetUDPPacketHook", arg0, arg1, arg2)
|
||||||
ret0, _ := ret[0].(string)
|
|
||||||
return ret0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// AddUDPPacketHook indicates an expected call of AddUDPPacketHook.
|
// SetUDPPacketHook indicates an expected call of SetUDPPacketHook.
|
||||||
func (mr *MockPacketFilterMockRecorder) AddUDPPacketHook(arg0, arg1, arg2, arg3 interface{}) *gomock.Call {
|
func (mr *MockPacketFilterMockRecorder) SetUDPPacketHook(arg0, arg1, arg2 interface{}) *gomock.Call {
|
||||||
mr.mock.ctrl.T.Helper()
|
mr.mock.ctrl.T.Helper()
|
||||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddUDPPacketHook", reflect.TypeOf((*MockPacketFilter)(nil).AddUDPPacketHook), arg0, arg1, arg2, arg3)
|
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SetUDPPacketHook", reflect.TypeOf((*MockPacketFilter)(nil).SetUDPPacketHook), arg0, arg1, arg2)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetTCPPacketHook mocks base method.
|
||||||
|
func (m *MockPacketFilter) SetTCPPacketHook(arg0 netip.Addr, arg1 uint16, arg2 func([]byte) bool) {
|
||||||
|
m.ctrl.T.Helper()
|
||||||
|
m.ctrl.Call(m, "SetTCPPacketHook", arg0, arg1, arg2)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetTCPPacketHook indicates an expected call of SetTCPPacketHook.
|
||||||
|
func (mr *MockPacketFilterMockRecorder) SetTCPPacketHook(arg0, arg1, arg2 interface{}) *gomock.Call {
|
||||||
|
mr.mock.ctrl.T.Helper()
|
||||||
|
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SetTCPPacketHook", reflect.TypeOf((*MockPacketFilter)(nil).SetTCPPacketHook), arg0, arg1, arg2)
|
||||||
}
|
}
|
||||||
|
|
||||||
// FilterInbound mocks base method.
|
// FilterInbound mocks base method.
|
||||||
@@ -75,17 +85,3 @@ func (mr *MockPacketFilterMockRecorder) FilterOutbound(arg0 interface{}, arg1 an
|
|||||||
mr.mock.ctrl.T.Helper()
|
mr.mock.ctrl.T.Helper()
|
||||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "FilterOutbound", reflect.TypeOf((*MockPacketFilter)(nil).FilterOutbound), arg0, arg1)
|
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "FilterOutbound", reflect.TypeOf((*MockPacketFilter)(nil).FilterOutbound), arg0, arg1)
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemovePacketHook mocks base method.
|
|
||||||
func (m *MockPacketFilter) RemovePacketHook(arg0 string) error {
|
|
||||||
m.ctrl.T.Helper()
|
|
||||||
ret := m.ctrl.Call(m, "RemovePacketHook", arg0)
|
|
||||||
ret0, _ := ret[0].(error)
|
|
||||||
return ret0
|
|
||||||
}
|
|
||||||
|
|
||||||
// RemovePacketHook indicates an expected call of RemovePacketHook.
|
|
||||||
func (mr *MockPacketFilterMockRecorder) RemovePacketHook(arg0 interface{}) *gomock.Call {
|
|
||||||
mr.mock.ctrl.T.Helper()
|
|
||||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RemovePacketHook", reflect.TypeOf((*MockPacketFilter)(nil).RemovePacketHook), arg0)
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,87 +0,0 @@
|
|||||||
// Code generated by MockGen. DO NOT EDIT.
|
|
||||||
// Source: github.com/netbirdio/netbird/client/iface (interfaces: PacketFilter)
|
|
||||||
|
|
||||||
// Package mocks is a generated GoMock package.
|
|
||||||
package mocks
|
|
||||||
|
|
||||||
import (
|
|
||||||
net "net"
|
|
||||||
reflect "reflect"
|
|
||||||
|
|
||||||
gomock "github.com/golang/mock/gomock"
|
|
||||||
)
|
|
||||||
|
|
||||||
// MockPacketFilter is a mock of PacketFilter interface.
|
|
||||||
type MockPacketFilter struct {
|
|
||||||
ctrl *gomock.Controller
|
|
||||||
recorder *MockPacketFilterMockRecorder
|
|
||||||
}
|
|
||||||
|
|
||||||
// MockPacketFilterMockRecorder is the mock recorder for MockPacketFilter.
|
|
||||||
type MockPacketFilterMockRecorder struct {
|
|
||||||
mock *MockPacketFilter
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewMockPacketFilter creates a new mock instance.
|
|
||||||
func NewMockPacketFilter(ctrl *gomock.Controller) *MockPacketFilter {
|
|
||||||
mock := &MockPacketFilter{ctrl: ctrl}
|
|
||||||
mock.recorder = &MockPacketFilterMockRecorder{mock}
|
|
||||||
return mock
|
|
||||||
}
|
|
||||||
|
|
||||||
// EXPECT returns an object that allows the caller to indicate expected use.
|
|
||||||
func (m *MockPacketFilter) EXPECT() *MockPacketFilterMockRecorder {
|
|
||||||
return m.recorder
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddUDPPacketHook mocks base method.
|
|
||||||
func (m *MockPacketFilter) AddUDPPacketHook(arg0 bool, arg1 net.IP, arg2 uint16, arg3 func(*net.UDPAddr, []byte) bool) {
|
|
||||||
m.ctrl.T.Helper()
|
|
||||||
m.ctrl.Call(m, "AddUDPPacketHook", arg0, arg1, arg2, arg3)
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddUDPPacketHook indicates an expected call of AddUDPPacketHook.
|
|
||||||
func (mr *MockPacketFilterMockRecorder) AddUDPPacketHook(arg0, arg1, arg2, arg3 interface{}) *gomock.Call {
|
|
||||||
mr.mock.ctrl.T.Helper()
|
|
||||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddUDPPacketHook", reflect.TypeOf((*MockPacketFilter)(nil).AddUDPPacketHook), arg0, arg1, arg2, arg3)
|
|
||||||
}
|
|
||||||
|
|
||||||
// FilterInbound mocks base method.
|
|
||||||
func (m *MockPacketFilter) FilterInbound(arg0 []byte) bool {
|
|
||||||
m.ctrl.T.Helper()
|
|
||||||
ret := m.ctrl.Call(m, "FilterInbound", arg0)
|
|
||||||
ret0, _ := ret[0].(bool)
|
|
||||||
return ret0
|
|
||||||
}
|
|
||||||
|
|
||||||
// FilterInbound indicates an expected call of FilterInbound.
|
|
||||||
func (mr *MockPacketFilterMockRecorder) FilterInbound(arg0 interface{}) *gomock.Call {
|
|
||||||
mr.mock.ctrl.T.Helper()
|
|
||||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "FilterInbound", reflect.TypeOf((*MockPacketFilter)(nil).FilterInbound), arg0)
|
|
||||||
}
|
|
||||||
|
|
||||||
// FilterOutbound mocks base method.
|
|
||||||
func (m *MockPacketFilter) FilterOutbound(arg0 []byte) bool {
|
|
||||||
m.ctrl.T.Helper()
|
|
||||||
ret := m.ctrl.Call(m, "FilterOutbound", arg0)
|
|
||||||
ret0, _ := ret[0].(bool)
|
|
||||||
return ret0
|
|
||||||
}
|
|
||||||
|
|
||||||
// FilterOutbound indicates an expected call of FilterOutbound.
|
|
||||||
func (mr *MockPacketFilterMockRecorder) FilterOutbound(arg0 interface{}) *gomock.Call {
|
|
||||||
mr.mock.ctrl.T.Helper()
|
|
||||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "FilterOutbound", reflect.TypeOf((*MockPacketFilter)(nil).FilterOutbound), arg0)
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetNetwork mocks base method.
|
|
||||||
func (m *MockPacketFilter) SetNetwork(arg0 *net.IPNet) {
|
|
||||||
m.ctrl.T.Helper()
|
|
||||||
m.ctrl.Call(m, "SetNetwork", arg0)
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetNetwork indicates an expected call of SetNetwork.
|
|
||||||
func (mr *MockPacketFilterMockRecorder) SetNetwork(arg0 interface{}) *gomock.Call {
|
|
||||||
mr.mock.ctrl.T.Helper()
|
|
||||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SetNetwork", reflect.TypeOf((*MockPacketFilter)(nil).SetNetwork), arg0)
|
|
||||||
}
|
|
||||||
@@ -19,6 +19,9 @@ import (
|
|||||||
var flowLogger = netflow.NewManager(nil, []byte{}, nil).GetLogger()
|
var flowLogger = netflow.NewManager(nil, []byte{}, nil).GetLogger()
|
||||||
|
|
||||||
func TestDefaultManager(t *testing.T) {
|
func TestDefaultManager(t *testing.T) {
|
||||||
|
t.Setenv("NB_WG_KERNEL_DISABLED", "true")
|
||||||
|
t.Setenv(firewall.EnvForceUserspaceFirewall, "true")
|
||||||
|
|
||||||
networkMap := &mgmProto.NetworkMap{
|
networkMap := &mgmProto.NetworkMap{
|
||||||
FirewallRules: []*mgmProto.FirewallRule{
|
FirewallRules: []*mgmProto.FirewallRule{
|
||||||
{
|
{
|
||||||
@@ -135,6 +138,7 @@ func TestDefaultManager(t *testing.T) {
|
|||||||
func TestDefaultManagerStateless(t *testing.T) {
|
func TestDefaultManagerStateless(t *testing.T) {
|
||||||
// stateless currently only in userspace, so we have to disable kernel
|
// stateless currently only in userspace, so we have to disable kernel
|
||||||
t.Setenv("NB_WG_KERNEL_DISABLED", "true")
|
t.Setenv("NB_WG_KERNEL_DISABLED", "true")
|
||||||
|
t.Setenv(firewall.EnvForceUserspaceFirewall, "true")
|
||||||
t.Setenv("NB_DISABLE_CONNTRACK", "true")
|
t.Setenv("NB_DISABLE_CONNTRACK", "true")
|
||||||
|
|
||||||
networkMap := &mgmProto.NetworkMap{
|
networkMap := &mgmProto.NetworkMap{
|
||||||
@@ -194,6 +198,7 @@ func TestDefaultManagerStateless(t *testing.T) {
|
|||||||
// This tests the full ACL manager -> uspfilter integration.
|
// This tests the full ACL manager -> uspfilter integration.
|
||||||
func TestDenyRulesNotAccumulatedOnRepeatedApply(t *testing.T) {
|
func TestDenyRulesNotAccumulatedOnRepeatedApply(t *testing.T) {
|
||||||
t.Setenv("NB_WG_KERNEL_DISABLED", "true")
|
t.Setenv("NB_WG_KERNEL_DISABLED", "true")
|
||||||
|
t.Setenv(firewall.EnvForceUserspaceFirewall, "true")
|
||||||
|
|
||||||
networkMap := &mgmProto.NetworkMap{
|
networkMap := &mgmProto.NetworkMap{
|
||||||
FirewallRules: []*mgmProto.FirewallRule{
|
FirewallRules: []*mgmProto.FirewallRule{
|
||||||
@@ -258,6 +263,7 @@ func TestDenyRulesNotAccumulatedOnRepeatedApply(t *testing.T) {
|
|||||||
// up when they're removed from the network map in a subsequent update.
|
// up when they're removed from the network map in a subsequent update.
|
||||||
func TestDenyRulesCleanedUpOnRemoval(t *testing.T) {
|
func TestDenyRulesCleanedUpOnRemoval(t *testing.T) {
|
||||||
t.Setenv("NB_WG_KERNEL_DISABLED", "true")
|
t.Setenv("NB_WG_KERNEL_DISABLED", "true")
|
||||||
|
t.Setenv(firewall.EnvForceUserspaceFirewall, "true")
|
||||||
|
|
||||||
ctrl := gomock.NewController(t)
|
ctrl := gomock.NewController(t)
|
||||||
defer ctrl.Finish()
|
defer ctrl.Finish()
|
||||||
@@ -339,6 +345,7 @@ func TestDenyRulesCleanedUpOnRemoval(t *testing.T) {
|
|||||||
// one added without leaking.
|
// one added without leaking.
|
||||||
func TestRuleUpdateChangingAction(t *testing.T) {
|
func TestRuleUpdateChangingAction(t *testing.T) {
|
||||||
t.Setenv("NB_WG_KERNEL_DISABLED", "true")
|
t.Setenv("NB_WG_KERNEL_DISABLED", "true")
|
||||||
|
t.Setenv(firewall.EnvForceUserspaceFirewall, "true")
|
||||||
|
|
||||||
ctrl := gomock.NewController(t)
|
ctrl := gomock.NewController(t)
|
||||||
defer ctrl.Finish()
|
defer ctrl.Finish()
|
||||||
|
|||||||
@@ -155,7 +155,7 @@ func (a *Auth) IsLoginRequired(ctx context.Context) (bool, error) {
|
|||||||
var needsLogin bool
|
var needsLogin bool
|
||||||
|
|
||||||
err = a.withRetry(ctx, func(client *mgm.GrpcClient) error {
|
err = a.withRetry(ctx, func(client *mgm.GrpcClient) error {
|
||||||
_, _, err := a.doMgmLogin(client, ctx, pubSSHKey)
|
err := a.doMgmLogin(client, ctx, pubSSHKey)
|
||||||
if isLoginNeeded(err) {
|
if isLoginNeeded(err) {
|
||||||
needsLogin = true
|
needsLogin = true
|
||||||
return nil
|
return nil
|
||||||
@@ -179,8 +179,8 @@ func (a *Auth) Login(ctx context.Context, setupKey string, jwtToken string) (err
|
|||||||
var isAuthError bool
|
var isAuthError bool
|
||||||
|
|
||||||
err = a.withRetry(ctx, func(client *mgm.GrpcClient) error {
|
err = a.withRetry(ctx, func(client *mgm.GrpcClient) error {
|
||||||
serverKey, _, err := a.doMgmLogin(client, ctx, pubSSHKey)
|
err := a.doMgmLogin(client, ctx, pubSSHKey)
|
||||||
if serverKey != nil && isRegistrationNeeded(err) {
|
if isRegistrationNeeded(err) {
|
||||||
log.Debugf("peer registration required")
|
log.Debugf("peer registration required")
|
||||||
_, err = a.registerPeer(client, ctx, setupKey, jwtToken, pubSSHKey)
|
_, err = a.registerPeer(client, ctx, setupKey, jwtToken, pubSSHKey)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -201,13 +201,7 @@ func (a *Auth) Login(ctx context.Context, setupKey string, jwtToken string) (err
|
|||||||
|
|
||||||
// getPKCEFlow retrieves PKCE authorization flow configuration and creates a flow instance
|
// getPKCEFlow retrieves PKCE authorization flow configuration and creates a flow instance
|
||||||
func (a *Auth) getPKCEFlow(client *mgm.GrpcClient) (*PKCEAuthorizationFlow, error) {
|
func (a *Auth) getPKCEFlow(client *mgm.GrpcClient) (*PKCEAuthorizationFlow, error) {
|
||||||
serverKey, err := client.GetServerPublicKey()
|
protoFlow, err := client.GetPKCEAuthorizationFlow()
|
||||||
if err != nil {
|
|
||||||
log.Errorf("failed while getting Management Service public key: %v", err)
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
protoFlow, err := client.GetPKCEAuthorizationFlow(*serverKey)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if s, ok := status.FromError(err); ok && s.Code() == codes.NotFound {
|
if s, ok := status.FromError(err); ok && s.Code() == codes.NotFound {
|
||||||
log.Warnf("server couldn't find pkce flow, contact admin: %v", err)
|
log.Warnf("server couldn't find pkce flow, contact admin: %v", err)
|
||||||
@@ -221,7 +215,7 @@ func (a *Auth) getPKCEFlow(client *mgm.GrpcClient) (*PKCEAuthorizationFlow, erro
|
|||||||
config := &PKCEAuthProviderConfig{
|
config := &PKCEAuthProviderConfig{
|
||||||
Audience: protoConfig.GetAudience(),
|
Audience: protoConfig.GetAudience(),
|
||||||
ClientID: protoConfig.GetClientID(),
|
ClientID: protoConfig.GetClientID(),
|
||||||
ClientSecret: protoConfig.GetClientSecret(),
|
ClientSecret: protoConfig.GetClientSecret(), //nolint:staticcheck
|
||||||
TokenEndpoint: protoConfig.GetTokenEndpoint(),
|
TokenEndpoint: protoConfig.GetTokenEndpoint(),
|
||||||
AuthorizationEndpoint: protoConfig.GetAuthorizationEndpoint(),
|
AuthorizationEndpoint: protoConfig.GetAuthorizationEndpoint(),
|
||||||
Scope: protoConfig.GetScope(),
|
Scope: protoConfig.GetScope(),
|
||||||
@@ -246,13 +240,7 @@ func (a *Auth) getPKCEFlow(client *mgm.GrpcClient) (*PKCEAuthorizationFlow, erro
|
|||||||
|
|
||||||
// getDeviceFlow retrieves device authorization flow configuration and creates a flow instance
|
// getDeviceFlow retrieves device authorization flow configuration and creates a flow instance
|
||||||
func (a *Auth) getDeviceFlow(client *mgm.GrpcClient) (*DeviceAuthorizationFlow, error) {
|
func (a *Auth) getDeviceFlow(client *mgm.GrpcClient) (*DeviceAuthorizationFlow, error) {
|
||||||
serverKey, err := client.GetServerPublicKey()
|
protoFlow, err := client.GetDeviceAuthorizationFlow()
|
||||||
if err != nil {
|
|
||||||
log.Errorf("failed while getting Management Service public key: %v", err)
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
protoFlow, err := client.GetDeviceAuthorizationFlow(*serverKey)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if s, ok := status.FromError(err); ok && s.Code() == codes.NotFound {
|
if s, ok := status.FromError(err); ok && s.Code() == codes.NotFound {
|
||||||
log.Warnf("server couldn't find device flow, contact admin: %v", err)
|
log.Warnf("server couldn't find device flow, contact admin: %v", err)
|
||||||
@@ -266,7 +254,7 @@ func (a *Auth) getDeviceFlow(client *mgm.GrpcClient) (*DeviceAuthorizationFlow,
|
|||||||
config := &DeviceAuthProviderConfig{
|
config := &DeviceAuthProviderConfig{
|
||||||
Audience: protoConfig.GetAudience(),
|
Audience: protoConfig.GetAudience(),
|
||||||
ClientID: protoConfig.GetClientID(),
|
ClientID: protoConfig.GetClientID(),
|
||||||
ClientSecret: protoConfig.GetClientSecret(),
|
ClientSecret: protoConfig.GetClientSecret(), //nolint:staticcheck
|
||||||
Domain: protoConfig.Domain,
|
Domain: protoConfig.Domain,
|
||||||
TokenEndpoint: protoConfig.GetTokenEndpoint(),
|
TokenEndpoint: protoConfig.GetTokenEndpoint(),
|
||||||
DeviceAuthEndpoint: protoConfig.GetDeviceAuthEndpoint(),
|
DeviceAuthEndpoint: protoConfig.GetDeviceAuthEndpoint(),
|
||||||
@@ -292,28 +280,16 @@ func (a *Auth) getDeviceFlow(client *mgm.GrpcClient) (*DeviceAuthorizationFlow,
|
|||||||
}
|
}
|
||||||
|
|
||||||
// doMgmLogin performs the actual login operation with the management service
|
// doMgmLogin performs the actual login operation with the management service
|
||||||
func (a *Auth) doMgmLogin(client *mgm.GrpcClient, ctx context.Context, pubSSHKey []byte) (*wgtypes.Key, *mgmProto.LoginResponse, error) {
|
func (a *Auth) doMgmLogin(client *mgm.GrpcClient, ctx context.Context, pubSSHKey []byte) error {
|
||||||
serverKey, err := client.GetServerPublicKey()
|
|
||||||
if err != nil {
|
|
||||||
log.Errorf("failed while getting Management Service public key: %v", err)
|
|
||||||
return nil, nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
sysInfo := system.GetInfo(ctx)
|
sysInfo := system.GetInfo(ctx)
|
||||||
a.setSystemInfoFlags(sysInfo)
|
a.setSystemInfoFlags(sysInfo)
|
||||||
loginResp, err := client.Login(*serverKey, sysInfo, pubSSHKey, a.config.DNSLabels)
|
_, err := client.Login(sysInfo, pubSSHKey, a.config.DNSLabels)
|
||||||
return serverKey, loginResp, err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// registerPeer checks whether setupKey was provided via cmd line and if not then it prompts user to enter a key.
|
// registerPeer checks whether setupKey was provided via cmd line and if not then it prompts user to enter a key.
|
||||||
// Otherwise tries to register with the provided setupKey via command line.
|
// Otherwise tries to register with the provided setupKey via command line.
|
||||||
func (a *Auth) registerPeer(client *mgm.GrpcClient, ctx context.Context, setupKey string, jwtToken string, pubSSHKey []byte) (*mgmProto.LoginResponse, error) {
|
func (a *Auth) registerPeer(client *mgm.GrpcClient, ctx context.Context, setupKey string, jwtToken string, pubSSHKey []byte) (*mgmProto.LoginResponse, error) {
|
||||||
serverPublicKey, err := client.GetServerPublicKey()
|
|
||||||
if err != nil {
|
|
||||||
log.Errorf("failed while getting Management Service public key: %v", err)
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
validSetupKey, err := uuid.Parse(setupKey)
|
validSetupKey, err := uuid.Parse(setupKey)
|
||||||
if err != nil && jwtToken == "" {
|
if err != nil && jwtToken == "" {
|
||||||
return nil, status.Errorf(codes.InvalidArgument, "invalid setup-key or no sso information provided, err: %v", err)
|
return nil, status.Errorf(codes.InvalidArgument, "invalid setup-key or no sso information provided, err: %v", err)
|
||||||
@@ -322,7 +298,7 @@ func (a *Auth) registerPeer(client *mgm.GrpcClient, ctx context.Context, setupKe
|
|||||||
log.Debugf("sending peer registration request to Management Service")
|
log.Debugf("sending peer registration request to Management Service")
|
||||||
info := system.GetInfo(ctx)
|
info := system.GetInfo(ctx)
|
||||||
a.setSystemInfoFlags(info)
|
a.setSystemInfoFlags(info)
|
||||||
loginResp, err := client.Register(*serverPublicKey, validSetupKey.String(), jwtToken, info, pubSSHKey, a.config.DNSLabels)
|
loginResp, err := client.Register(validSetupKey.String(), jwtToken, info, pubSSHKey, a.config.DNSLabels)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Errorf("failed registering peer %v", err)
|
log.Errorf("failed registering peer %v", err)
|
||||||
return nil, err
|
return nil, err
|
||||||
|
|||||||
@@ -23,12 +23,13 @@ import (
|
|||||||
"github.com/netbirdio/netbird/client/iface/netstack"
|
"github.com/netbirdio/netbird/client/iface/netstack"
|
||||||
"github.com/netbirdio/netbird/client/internal/dns"
|
"github.com/netbirdio/netbird/client/internal/dns"
|
||||||
"github.com/netbirdio/netbird/client/internal/listener"
|
"github.com/netbirdio/netbird/client/internal/listener"
|
||||||
|
"github.com/netbirdio/netbird/client/internal/metrics"
|
||||||
"github.com/netbirdio/netbird/client/internal/peer"
|
"github.com/netbirdio/netbird/client/internal/peer"
|
||||||
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
||||||
"github.com/netbirdio/netbird/client/internal/statemanager"
|
"github.com/netbirdio/netbird/client/internal/statemanager"
|
||||||
"github.com/netbirdio/netbird/client/internal/stdnet"
|
"github.com/netbirdio/netbird/client/internal/stdnet"
|
||||||
"github.com/netbirdio/netbird/client/internal/updatemanager"
|
"github.com/netbirdio/netbird/client/internal/updater"
|
||||||
"github.com/netbirdio/netbird/client/internal/updatemanager/installer"
|
"github.com/netbirdio/netbird/client/internal/updater/installer"
|
||||||
nbnet "github.com/netbirdio/netbird/client/net"
|
nbnet "github.com/netbirdio/netbird/client/net"
|
||||||
cProto "github.com/netbirdio/netbird/client/proto"
|
cProto "github.com/netbirdio/netbird/client/proto"
|
||||||
"github.com/netbirdio/netbird/client/ssh"
|
"github.com/netbirdio/netbird/client/ssh"
|
||||||
@@ -43,14 +44,19 @@ import (
|
|||||||
"github.com/netbirdio/netbird/version"
|
"github.com/netbirdio/netbird/version"
|
||||||
)
|
)
|
||||||
|
|
||||||
type ConnectClient struct {
|
// androidRunOverride is set on Android to inject mobile dependencies
|
||||||
ctx context.Context
|
// when using embed.Client (which calls Run() with empty MobileDependency).
|
||||||
config *profilemanager.Config
|
var androidRunOverride func(c *ConnectClient, runningChan chan struct{}, logPath string) error
|
||||||
statusRecorder *peer.Status
|
|
||||||
doInitialAutoUpdate bool
|
|
||||||
|
|
||||||
engine *Engine
|
type ConnectClient struct {
|
||||||
engineMutex sync.Mutex
|
ctx context.Context
|
||||||
|
config *profilemanager.Config
|
||||||
|
statusRecorder *peer.Status
|
||||||
|
|
||||||
|
engine *Engine
|
||||||
|
engineMutex sync.Mutex
|
||||||
|
clientMetrics *metrics.ClientMetrics
|
||||||
|
updateManager *updater.Manager
|
||||||
|
|
||||||
persistSyncResponse bool
|
persistSyncResponse bool
|
||||||
}
|
}
|
||||||
@@ -59,19 +65,24 @@ func NewConnectClient(
|
|||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
config *profilemanager.Config,
|
config *profilemanager.Config,
|
||||||
statusRecorder *peer.Status,
|
statusRecorder *peer.Status,
|
||||||
doInitalAutoUpdate bool,
|
|
||||||
) *ConnectClient {
|
) *ConnectClient {
|
||||||
return &ConnectClient{
|
return &ConnectClient{
|
||||||
ctx: ctx,
|
ctx: ctx,
|
||||||
config: config,
|
config: config,
|
||||||
statusRecorder: statusRecorder,
|
statusRecorder: statusRecorder,
|
||||||
doInitialAutoUpdate: doInitalAutoUpdate,
|
engineMutex: sync.Mutex{},
|
||||||
engineMutex: sync.Mutex{},
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (c *ConnectClient) SetUpdateManager(um *updater.Manager) {
|
||||||
|
c.updateManager = um
|
||||||
|
}
|
||||||
|
|
||||||
// Run with main logic.
|
// Run with main logic.
|
||||||
func (c *ConnectClient) Run(runningChan chan struct{}, logPath string) error {
|
func (c *ConnectClient) Run(runningChan chan struct{}, logPath string) error {
|
||||||
|
if androidRunOverride != nil {
|
||||||
|
return androidRunOverride(c, runningChan, logPath)
|
||||||
|
}
|
||||||
return c.run(MobileDependency{}, runningChan, logPath)
|
return c.run(MobileDependency{}, runningChan, logPath)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -100,6 +111,7 @@ func (c *ConnectClient) RunOniOS(
|
|||||||
fileDescriptor int32,
|
fileDescriptor int32,
|
||||||
networkChangeListener listener.NetworkChangeListener,
|
networkChangeListener listener.NetworkChangeListener,
|
||||||
dnsManager dns.IosDnsManager,
|
dnsManager dns.IosDnsManager,
|
||||||
|
dnsAddresses []netip.AddrPort,
|
||||||
stateFilePath string,
|
stateFilePath string,
|
||||||
) error {
|
) error {
|
||||||
// Set GC percent to 5% to reduce memory usage as iOS only allows 50MB of memory for the extension.
|
// Set GC percent to 5% to reduce memory usage as iOS only allows 50MB of memory for the extension.
|
||||||
@@ -109,6 +121,7 @@ func (c *ConnectClient) RunOniOS(
|
|||||||
FileDescriptor: fileDescriptor,
|
FileDescriptor: fileDescriptor,
|
||||||
NetworkChangeListener: networkChangeListener,
|
NetworkChangeListener: networkChangeListener,
|
||||||
DnsManager: dnsManager,
|
DnsManager: dnsManager,
|
||||||
|
HostDNSAddresses: dnsAddresses,
|
||||||
StateFilePath: stateFilePath,
|
StateFilePath: stateFilePath,
|
||||||
}
|
}
|
||||||
return c.run(mobileDependency, nil, "")
|
return c.run(mobileDependency, nil, "")
|
||||||
@@ -131,10 +144,34 @@ func (c *ConnectClient) run(mobileDependency MobileDependency, runningChan chan
|
|||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
|
// Stop metrics push on exit
|
||||||
|
defer func() {
|
||||||
|
if c.clientMetrics != nil {
|
||||||
|
c.clientMetrics.StopPush()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
log.Infof("starting NetBird client version %s on %s/%s", version.NetbirdVersion(), runtime.GOOS, runtime.GOARCH)
|
log.Infof("starting NetBird client version %s on %s/%s", version.NetbirdVersion(), runtime.GOOS, runtime.GOARCH)
|
||||||
|
|
||||||
nbnet.Init()
|
nbnet.Init()
|
||||||
|
|
||||||
|
// Initialize metrics once at startup (always active for debug bundles)
|
||||||
|
if c.clientMetrics == nil {
|
||||||
|
agentInfo := metrics.AgentInfo{
|
||||||
|
DeploymentType: metrics.DeploymentTypeUnknown,
|
||||||
|
Version: version.NetbirdVersion(),
|
||||||
|
OS: runtime.GOOS,
|
||||||
|
Arch: runtime.GOARCH,
|
||||||
|
}
|
||||||
|
c.clientMetrics = metrics.NewClientMetrics(agentInfo)
|
||||||
|
log.Debugf("initialized client metrics")
|
||||||
|
|
||||||
|
// Start metrics push if enabled (uses daemon context, persists across engine restarts)
|
||||||
|
if metrics.IsMetricsPushEnabled() {
|
||||||
|
c.clientMetrics.StartPush(c.ctx, metrics.PushConfigFromEnv())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
backOff := &backoff.ExponentialBackOff{
|
backOff := &backoff.ExponentialBackOff{
|
||||||
InitialInterval: time.Second,
|
InitialInterval: time.Second,
|
||||||
RandomizationFactor: 1,
|
RandomizationFactor: 1,
|
||||||
@@ -187,14 +224,13 @@ func (c *ConnectClient) run(mobileDependency MobileDependency, runningChan chan
|
|||||||
stateManager := statemanager.New(path)
|
stateManager := statemanager.New(path)
|
||||||
stateManager.RegisterState(&sshconfig.ShutdownState{})
|
stateManager.RegisterState(&sshconfig.ShutdownState{})
|
||||||
|
|
||||||
updateManager, err := updatemanager.NewManager(c.statusRecorder, stateManager)
|
if c.updateManager != nil {
|
||||||
if err == nil {
|
c.updateManager.CheckUpdateSuccess(c.ctx)
|
||||||
updateManager.CheckUpdateSuccess(c.ctx)
|
}
|
||||||
|
|
||||||
inst := installer.New()
|
inst := installer.New()
|
||||||
if err := inst.CleanUpInstallerFiles(); err != nil {
|
if err := inst.CleanUpInstallerFiles(); err != nil {
|
||||||
log.Errorf("failed to clean up temporary installer file: %v", err)
|
log.Errorf("failed to clean up temporary installer file: %v", err)
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
defer c.statusRecorder.ClientStop()
|
defer c.statusRecorder.ClientStop()
|
||||||
@@ -222,6 +258,16 @@ func (c *ConnectClient) run(mobileDependency MobileDependency, runningChan chan
|
|||||||
mgmNotifier := statusRecorderToMgmConnStateNotifier(c.statusRecorder)
|
mgmNotifier := statusRecorderToMgmConnStateNotifier(c.statusRecorder)
|
||||||
mgmClient.SetConnStateListener(mgmNotifier)
|
mgmClient.SetConnStateListener(mgmNotifier)
|
||||||
|
|
||||||
|
// Update metrics with actual deployment type after connection
|
||||||
|
deploymentType := metrics.DetermineDeploymentType(mgmClient.GetServerURL())
|
||||||
|
agentInfo := metrics.AgentInfo{
|
||||||
|
DeploymentType: deploymentType,
|
||||||
|
Version: version.NetbirdVersion(),
|
||||||
|
OS: runtime.GOOS,
|
||||||
|
Arch: runtime.GOARCH,
|
||||||
|
}
|
||||||
|
c.clientMetrics.UpdateAgentInfo(agentInfo, myPrivateKey.PublicKey().String())
|
||||||
|
|
||||||
log.Debugf("connected to the Management service %s", c.config.ManagementURL.Host)
|
log.Debugf("connected to the Management service %s", c.config.ManagementURL.Host)
|
||||||
defer func() {
|
defer func() {
|
||||||
if err = mgmClient.Close(); err != nil {
|
if err = mgmClient.Close(); err != nil {
|
||||||
@@ -230,8 +276,10 @@ func (c *ConnectClient) run(mobileDependency MobileDependency, runningChan chan
|
|||||||
}()
|
}()
|
||||||
|
|
||||||
// connect (just a connection, no stream yet) and login to Management Service to get an initial global Netbird config
|
// connect (just a connection, no stream yet) and login to Management Service to get an initial global Netbird config
|
||||||
|
loginStarted := time.Now()
|
||||||
loginResp, err := loginToManagement(engineCtx, mgmClient, publicSSHKey, c.config)
|
loginResp, err := loginToManagement(engineCtx, mgmClient, publicSSHKey, c.config)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
c.clientMetrics.RecordLoginDuration(engineCtx, time.Since(loginStarted), false)
|
||||||
log.Debug(err)
|
log.Debug(err)
|
||||||
if s, ok := gstatus.FromError(err); ok && (s.Code() == codes.PermissionDenied) {
|
if s, ok := gstatus.FromError(err); ok && (s.Code() == codes.PermissionDenied) {
|
||||||
state.Set(StatusNeedsLogin)
|
state.Set(StatusNeedsLogin)
|
||||||
@@ -240,6 +288,7 @@ func (c *ConnectClient) run(mobileDependency MobileDependency, runningChan chan
|
|||||||
}
|
}
|
||||||
return wrapErr(err)
|
return wrapErr(err)
|
||||||
}
|
}
|
||||||
|
c.clientMetrics.RecordLoginDuration(engineCtx, time.Since(loginStarted), true)
|
||||||
c.statusRecorder.MarkManagementConnected()
|
c.statusRecorder.MarkManagementConnected()
|
||||||
|
|
||||||
localPeerState := peer.LocalPeerState{
|
localPeerState := peer.LocalPeerState{
|
||||||
@@ -308,7 +357,16 @@ func (c *ConnectClient) run(mobileDependency MobileDependency, runningChan chan
|
|||||||
checks := loginResp.GetChecks()
|
checks := loginResp.GetChecks()
|
||||||
|
|
||||||
c.engineMutex.Lock()
|
c.engineMutex.Lock()
|
||||||
engine := NewEngine(engineCtx, cancel, signalClient, mgmClient, relayManager, engineConfig, mobileDependency, c.statusRecorder, checks, stateManager)
|
engine := NewEngine(engineCtx, cancel, engineConfig, EngineServices{
|
||||||
|
SignalClient: signalClient,
|
||||||
|
MgmClient: mgmClient,
|
||||||
|
RelayManager: relayManager,
|
||||||
|
StatusRecorder: c.statusRecorder,
|
||||||
|
Checks: checks,
|
||||||
|
StateManager: stateManager,
|
||||||
|
UpdateManager: c.updateManager,
|
||||||
|
ClientMetrics: c.clientMetrics,
|
||||||
|
}, mobileDependency)
|
||||||
engine.SetSyncResponsePersistence(c.persistSyncResponse)
|
engine.SetSyncResponsePersistence(c.persistSyncResponse)
|
||||||
c.engine = engine
|
c.engine = engine
|
||||||
c.engineMutex.Unlock()
|
c.engineMutex.Unlock()
|
||||||
@@ -318,21 +376,15 @@ func (c *ConnectClient) run(mobileDependency MobileDependency, runningChan chan
|
|||||||
return wrapErr(err)
|
return wrapErr(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if loginResp.PeerConfig != nil && loginResp.PeerConfig.AutoUpdate != nil {
|
|
||||||
// AutoUpdate will be true when the user click on "Connect" menu on the UI
|
|
||||||
if c.doInitialAutoUpdate {
|
|
||||||
log.Infof("start engine by ui, run auto-update check")
|
|
||||||
c.engine.InitialUpdateHandling(loginResp.PeerConfig.AutoUpdate)
|
|
||||||
c.doInitialAutoUpdate = false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
log.Infof("Netbird engine started, the IP is: %s", peerConfig.GetAddress())
|
log.Infof("Netbird engine started, the IP is: %s", peerConfig.GetAddress())
|
||||||
state.Set(StatusConnected)
|
state.Set(StatusConnected)
|
||||||
|
|
||||||
if runningChan != nil {
|
if runningChan != nil {
|
||||||
close(runningChan)
|
select {
|
||||||
runningChan = nil
|
case <-runningChan:
|
||||||
|
default:
|
||||||
|
close(runningChan)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
<-engineCtx.Done()
|
<-engineCtx.Done()
|
||||||
@@ -567,12 +619,6 @@ func connectToSignal(ctx context.Context, wtConfig *mgmProto.NetbirdConfig, ourP
|
|||||||
|
|
||||||
// loginToManagement creates Management ServiceDependencies client, establishes a connection, logs-in and gets a global Netbird config (signal, turn, stun hosts, etc)
|
// loginToManagement creates Management ServiceDependencies client, establishes a connection, logs-in and gets a global Netbird config (signal, turn, stun hosts, etc)
|
||||||
func loginToManagement(ctx context.Context, client mgm.Client, pubSSHKey []byte, config *profilemanager.Config) (*mgmProto.LoginResponse, error) {
|
func loginToManagement(ctx context.Context, client mgm.Client, pubSSHKey []byte, config *profilemanager.Config) (*mgmProto.LoginResponse, error) {
|
||||||
|
|
||||||
serverPublicKey, err := client.GetServerPublicKey()
|
|
||||||
if err != nil {
|
|
||||||
return nil, gstatus.Errorf(codes.FailedPrecondition, "failed while getting Management Service public key: %s", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
sysInfo := system.GetInfo(ctx)
|
sysInfo := system.GetInfo(ctx)
|
||||||
sysInfo.SetFlags(
|
sysInfo.SetFlags(
|
||||||
config.RosenpassEnabled,
|
config.RosenpassEnabled,
|
||||||
@@ -591,12 +637,7 @@ func loginToManagement(ctx context.Context, client mgm.Client, pubSSHKey []byte,
|
|||||||
config.EnableSSHRemotePortForwarding,
|
config.EnableSSHRemotePortForwarding,
|
||||||
config.DisableSSHAuth,
|
config.DisableSSHAuth,
|
||||||
)
|
)
|
||||||
loginResp, err := client.Login(*serverPublicKey, sysInfo, pubSSHKey, config.DNSLabels)
|
return client.Login(sysInfo, pubSSHKey, config.DNSLabels)
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return loginResp, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func statusRecorderToMgmConnStateNotifier(statusRecorder *peer.Status) mgm.ConnStateNotifier {
|
func statusRecorderToMgmConnStateNotifier(statusRecorder *peer.Status) mgm.ConnStateNotifier {
|
||||||
|
|||||||
73
client/internal/connect_android_default.go
Normal file
73
client/internal/connect_android_default.go
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
//go:build android
|
||||||
|
|
||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/netip"
|
||||||
|
|
||||||
|
"github.com/netbirdio/netbird/client/internal/dns"
|
||||||
|
"github.com/netbirdio/netbird/client/internal/listener"
|
||||||
|
"github.com/netbirdio/netbird/client/internal/stdnet"
|
||||||
|
)
|
||||||
|
|
||||||
|
// noopIFaceDiscover is a stub ExternalIFaceDiscover for embed.Client on Android.
|
||||||
|
// It returns an empty interface list, which means ICE P2P candidates won't be
|
||||||
|
// discovered — connections will fall back to relay. Applications that need P2P
|
||||||
|
// should provide a real implementation via runOnAndroidEmbed that uses
|
||||||
|
// Android's ConnectivityManager to enumerate network interfaces.
|
||||||
|
type noopIFaceDiscover struct{}
|
||||||
|
|
||||||
|
func (noopIFaceDiscover) IFaces() (string, error) {
|
||||||
|
// Return empty JSON array — no local interfaces advertised for ICE.
|
||||||
|
// This is intentional: without Android's ConnectivityManager, we cannot
|
||||||
|
// reliably enumerate interfaces (netlink is restricted on Android 11+).
|
||||||
|
// Relay connections still work; only P2P hole-punching is disabled.
|
||||||
|
return "[]", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// noopNetworkChangeListener is a stub for embed.Client on Android.
|
||||||
|
// Network change events are ignored since the embed client manages its own
|
||||||
|
// reconnection logic via the engine's built-in retry mechanism.
|
||||||
|
type noopNetworkChangeListener struct{}
|
||||||
|
|
||||||
|
func (noopNetworkChangeListener) OnNetworkChanged(string) {
|
||||||
|
// No-op: embed.Client relies on the engine's internal reconnection
|
||||||
|
// logic rather than OS-level network change notifications.
|
||||||
|
}
|
||||||
|
|
||||||
|
func (noopNetworkChangeListener) SetInterfaceIP(string) {
|
||||||
|
// No-op: in netstack mode, the overlay IP is managed by the userspace
|
||||||
|
// network stack, not by OS-level interface configuration.
|
||||||
|
}
|
||||||
|
|
||||||
|
// noopDnsReadyListener is a stub for embed.Client on Android.
|
||||||
|
// DNS readiness notifications are not needed in netstack/embed mode
|
||||||
|
// since system DNS is disabled and DNS resolution happens externally.
|
||||||
|
type noopDnsReadyListener struct{}
|
||||||
|
|
||||||
|
func (noopDnsReadyListener) OnReady() {
|
||||||
|
// No-op: embed.Client does not need DNS readiness notifications.
|
||||||
|
// System DNS is disabled in netstack mode.
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ stdnet.ExternalIFaceDiscover = noopIFaceDiscover{}
|
||||||
|
var _ listener.NetworkChangeListener = noopNetworkChangeListener{}
|
||||||
|
var _ dns.ReadyListener = noopDnsReadyListener{}
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
// Wire up the default override so embed.Client.Start() works on Android
|
||||||
|
// with netstack mode. Provides complete no-op stubs for all mobile
|
||||||
|
// dependencies so the engine's existing Android code paths work unchanged.
|
||||||
|
// Applications that need P2P ICE or real DNS should replace this by
|
||||||
|
// setting androidRunOverride before calling Start().
|
||||||
|
androidRunOverride = func(c *ConnectClient, runningChan chan struct{}, logPath string) error {
|
||||||
|
return c.runOnAndroidEmbed(
|
||||||
|
noopIFaceDiscover{},
|
||||||
|
noopNetworkChangeListener{},
|
||||||
|
[]netip.AddrPort{},
|
||||||
|
noopDnsReadyListener{},
|
||||||
|
runningChan,
|
||||||
|
logPath,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
32
client/internal/connect_android_embed.go
Normal file
32
client/internal/connect_android_embed.go
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
//go:build android
|
||||||
|
|
||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/netip"
|
||||||
|
|
||||||
|
"github.com/netbirdio/netbird/client/internal/dns"
|
||||||
|
"github.com/netbirdio/netbird/client/internal/listener"
|
||||||
|
"github.com/netbirdio/netbird/client/internal/stdnet"
|
||||||
|
)
|
||||||
|
|
||||||
|
// runOnAndroidEmbed is like RunOnAndroid but accepts a runningChan
|
||||||
|
// so embed.Client.Start() can detect when the engine is ready.
|
||||||
|
// It provides complete MobileDependency so the engine's existing
|
||||||
|
// Android code paths work unchanged.
|
||||||
|
func (c *ConnectClient) runOnAndroidEmbed(
|
||||||
|
iFaceDiscover stdnet.ExternalIFaceDiscover,
|
||||||
|
networkChangeListener listener.NetworkChangeListener,
|
||||||
|
dnsAddresses []netip.AddrPort,
|
||||||
|
dnsReadyListener dns.ReadyListener,
|
||||||
|
runningChan chan struct{},
|
||||||
|
logPath string,
|
||||||
|
) error {
|
||||||
|
mobileDependency := MobileDependency{
|
||||||
|
IFaceDiscover: iFaceDiscover,
|
||||||
|
NetworkChangeListener: networkChangeListener,
|
||||||
|
HostDNSAddresses: dnsAddresses,
|
||||||
|
DnsReadyListener: dnsReadyListener,
|
||||||
|
}
|
||||||
|
return c.run(mobileDependency, runningChan, logPath)
|
||||||
|
}
|
||||||
60
client/internal/daemonaddr/resolve.go
Normal file
60
client/internal/daemonaddr/resolve.go
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
//go:build !windows && !ios && !android
|
||||||
|
|
||||||
|
package daemonaddr
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
log "github.com/sirupsen/logrus"
|
||||||
|
)
|
||||||
|
|
||||||
|
var scanDir = "/var/run/netbird"
|
||||||
|
|
||||||
|
// setScanDir overrides the scan directory (used by tests).
|
||||||
|
func setScanDir(dir string) {
|
||||||
|
scanDir = dir
|
||||||
|
}
|
||||||
|
|
||||||
|
// ResolveUnixDaemonAddr checks whether the default Unix socket exists and, if not,
|
||||||
|
// scans /var/run/netbird/ for a single .sock file to use instead. This handles the
|
||||||
|
// mismatch between the netbird@.service template (which places the socket under
|
||||||
|
// /var/run/netbird/<instance>.sock) and the CLI default (/var/run/netbird.sock).
|
||||||
|
func ResolveUnixDaemonAddr(addr string) string {
|
||||||
|
if !strings.HasPrefix(addr, "unix://") {
|
||||||
|
return addr
|
||||||
|
}
|
||||||
|
|
||||||
|
sockPath := strings.TrimPrefix(addr, "unix://")
|
||||||
|
if _, err := os.Stat(sockPath); err == nil {
|
||||||
|
return addr
|
||||||
|
}
|
||||||
|
|
||||||
|
entries, err := os.ReadDir(scanDir)
|
||||||
|
if err != nil {
|
||||||
|
return addr
|
||||||
|
}
|
||||||
|
|
||||||
|
var found []string
|
||||||
|
for _, e := range entries {
|
||||||
|
if e.IsDir() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if strings.HasSuffix(e.Name(), ".sock") {
|
||||||
|
found = append(found, filepath.Join(scanDir, e.Name()))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
switch len(found) {
|
||||||
|
case 1:
|
||||||
|
resolved := "unix://" + found[0]
|
||||||
|
log.Debugf("Default daemon socket not found, using discovered socket: %s", resolved)
|
||||||
|
return resolved
|
||||||
|
case 0:
|
||||||
|
return addr
|
||||||
|
default:
|
||||||
|
log.Warnf("Default daemon socket not found and multiple sockets discovered in %s; pass --daemon-addr explicitly", scanDir)
|
||||||
|
return addr
|
||||||
|
}
|
||||||
|
}
|
||||||
8
client/internal/daemonaddr/resolve_stub.go
Normal file
8
client/internal/daemonaddr/resolve_stub.go
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
//go:build windows || ios || android
|
||||||
|
|
||||||
|
package daemonaddr
|
||||||
|
|
||||||
|
// ResolveUnixDaemonAddr is a no-op on platforms that don't use Unix sockets.
|
||||||
|
func ResolveUnixDaemonAddr(addr string) string {
|
||||||
|
return addr
|
||||||
|
}
|
||||||
121
client/internal/daemonaddr/resolve_test.go
Normal file
121
client/internal/daemonaddr/resolve_test.go
Normal file
@@ -0,0 +1,121 @@
|
|||||||
|
//go:build !windows && !ios && !android
|
||||||
|
|
||||||
|
package daemonaddr
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// createSockFile creates a regular file with a .sock extension.
|
||||||
|
// ResolveUnixDaemonAddr uses os.Stat (not net.Dial), so a regular file is
|
||||||
|
// sufficient and avoids Unix socket path-length limits on macOS.
|
||||||
|
func createSockFile(t *testing.T, path string) {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.WriteFile(path, nil, 0o600); err != nil {
|
||||||
|
t.Fatalf("failed to create test sock file at %s: %v", path, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveUnixDaemonAddr_DefaultExists(t *testing.T) {
|
||||||
|
tmp := t.TempDir()
|
||||||
|
sock := filepath.Join(tmp, "netbird.sock")
|
||||||
|
createSockFile(t, sock)
|
||||||
|
|
||||||
|
addr := "unix://" + sock
|
||||||
|
got := ResolveUnixDaemonAddr(addr)
|
||||||
|
if got != addr {
|
||||||
|
t.Errorf("expected %s, got %s", addr, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveUnixDaemonAddr_SingleDiscovered(t *testing.T) {
|
||||||
|
tmp := t.TempDir()
|
||||||
|
|
||||||
|
// Default socket does not exist
|
||||||
|
defaultAddr := "unix://" + filepath.Join(tmp, "netbird.sock")
|
||||||
|
|
||||||
|
// Create a scan dir with one socket
|
||||||
|
sd := filepath.Join(tmp, "netbird")
|
||||||
|
if err := os.MkdirAll(sd, 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
instanceSock := filepath.Join(sd, "main.sock")
|
||||||
|
createSockFile(t, instanceSock)
|
||||||
|
|
||||||
|
origScanDir := scanDir
|
||||||
|
setScanDir(sd)
|
||||||
|
t.Cleanup(func() { setScanDir(origScanDir) })
|
||||||
|
|
||||||
|
got := ResolveUnixDaemonAddr(defaultAddr)
|
||||||
|
expected := "unix://" + instanceSock
|
||||||
|
if got != expected {
|
||||||
|
t.Errorf("expected %s, got %s", expected, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveUnixDaemonAddr_MultipleDiscovered(t *testing.T) {
|
||||||
|
tmp := t.TempDir()
|
||||||
|
|
||||||
|
defaultAddr := "unix://" + filepath.Join(tmp, "netbird.sock")
|
||||||
|
|
||||||
|
sd := filepath.Join(tmp, "netbird")
|
||||||
|
if err := os.MkdirAll(sd, 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
createSockFile(t, filepath.Join(sd, "main.sock"))
|
||||||
|
createSockFile(t, filepath.Join(sd, "other.sock"))
|
||||||
|
|
||||||
|
origScanDir := scanDir
|
||||||
|
setScanDir(sd)
|
||||||
|
t.Cleanup(func() { setScanDir(origScanDir) })
|
||||||
|
|
||||||
|
got := ResolveUnixDaemonAddr(defaultAddr)
|
||||||
|
if got != defaultAddr {
|
||||||
|
t.Errorf("expected original %s, got %s", defaultAddr, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveUnixDaemonAddr_NoSocketsFound(t *testing.T) {
|
||||||
|
tmp := t.TempDir()
|
||||||
|
|
||||||
|
defaultAddr := "unix://" + filepath.Join(tmp, "netbird.sock")
|
||||||
|
|
||||||
|
sd := filepath.Join(tmp, "netbird")
|
||||||
|
if err := os.MkdirAll(sd, 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
origScanDir := scanDir
|
||||||
|
setScanDir(sd)
|
||||||
|
t.Cleanup(func() { setScanDir(origScanDir) })
|
||||||
|
|
||||||
|
got := ResolveUnixDaemonAddr(defaultAddr)
|
||||||
|
if got != defaultAddr {
|
||||||
|
t.Errorf("expected original %s, got %s", defaultAddr, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveUnixDaemonAddr_NonUnixAddr(t *testing.T) {
|
||||||
|
addr := "tcp://127.0.0.1:41731"
|
||||||
|
got := ResolveUnixDaemonAddr(addr)
|
||||||
|
if got != addr {
|
||||||
|
t.Errorf("expected %s, got %s", addr, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveUnixDaemonAddr_ScanDirMissing(t *testing.T) {
|
||||||
|
tmp := t.TempDir()
|
||||||
|
|
||||||
|
defaultAddr := "unix://" + filepath.Join(tmp, "netbird.sock")
|
||||||
|
|
||||||
|
origScanDir := scanDir
|
||||||
|
setScanDir(filepath.Join(tmp, "nonexistent"))
|
||||||
|
t.Cleanup(func() { setScanDir(origScanDir) })
|
||||||
|
|
||||||
|
got := ResolveUnixDaemonAddr(defaultAddr)
|
||||||
|
if got != defaultAddr {
|
||||||
|
t.Errorf("expected original %s, got %s", defaultAddr, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -25,13 +25,13 @@ import (
|
|||||||
"google.golang.org/protobuf/encoding/protojson"
|
"google.golang.org/protobuf/encoding/protojson"
|
||||||
|
|
||||||
"github.com/netbirdio/netbird/client/anonymize"
|
"github.com/netbirdio/netbird/client/anonymize"
|
||||||
|
"github.com/netbirdio/netbird/client/configs"
|
||||||
"github.com/netbirdio/netbird/client/internal/peer"
|
"github.com/netbirdio/netbird/client/internal/peer"
|
||||||
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
||||||
"github.com/netbirdio/netbird/client/internal/updatemanager/installer"
|
"github.com/netbirdio/netbird/client/internal/updater/installer"
|
||||||
nbstatus "github.com/netbirdio/netbird/client/status"
|
nbstatus "github.com/netbirdio/netbird/client/status"
|
||||||
mgmProto "github.com/netbirdio/netbird/shared/management/proto"
|
mgmProto "github.com/netbirdio/netbird/shared/management/proto"
|
||||||
"github.com/netbirdio/netbird/util"
|
"github.com/netbirdio/netbird/util"
|
||||||
"github.com/netbirdio/netbird/version"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const readmeContent = `Netbird debug bundle
|
const readmeContent = `Netbird debug bundle
|
||||||
@@ -53,6 +53,8 @@ resolved_domains.txt: Anonymized resolved domain IP addresses from the status re
|
|||||||
config.txt: Anonymized configuration information of the NetBird client.
|
config.txt: Anonymized configuration information of the NetBird client.
|
||||||
network_map.json: Anonymized sync response containing peer configurations, routes, DNS settings, and firewall rules.
|
network_map.json: Anonymized sync response containing peer configurations, routes, DNS settings, and firewall rules.
|
||||||
state.json: Anonymized client state dump containing netbird states for the active profile.
|
state.json: Anonymized client state dump containing netbird states for the active profile.
|
||||||
|
service_params.json: Sanitized service install parameters (service.json). Sensitive environment variable values are masked. Only present when service.json exists.
|
||||||
|
metrics.txt: Buffered client metrics in InfluxDB line protocol format. Only present when metrics collection is enabled. Peer identifiers are anonymized.
|
||||||
mutex.prof: Mutex profiling information.
|
mutex.prof: Mutex profiling information.
|
||||||
goroutine.prof: Goroutine profiling information.
|
goroutine.prof: Goroutine profiling information.
|
||||||
block.prof: Block profiling information.
|
block.prof: Block profiling information.
|
||||||
@@ -219,6 +221,11 @@ const (
|
|||||||
darwinStdoutLogPath = "/var/log/netbird.err.log"
|
darwinStdoutLogPath = "/var/log/netbird.err.log"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// MetricsExporter is an interface for exporting metrics
|
||||||
|
type MetricsExporter interface {
|
||||||
|
Export(w io.Writer) error
|
||||||
|
}
|
||||||
|
|
||||||
type BundleGenerator struct {
|
type BundleGenerator struct {
|
||||||
anonymizer *anonymize.Anonymizer
|
anonymizer *anonymize.Anonymizer
|
||||||
|
|
||||||
@@ -229,6 +236,7 @@ type BundleGenerator struct {
|
|||||||
logPath string
|
logPath string
|
||||||
cpuProfile []byte
|
cpuProfile []byte
|
||||||
refreshStatus func() // Optional callback to refresh status before bundle generation
|
refreshStatus func() // Optional callback to refresh status before bundle generation
|
||||||
|
clientMetrics MetricsExporter
|
||||||
|
|
||||||
anonymize bool
|
anonymize bool
|
||||||
includeSystemInfo bool
|
includeSystemInfo bool
|
||||||
@@ -250,6 +258,7 @@ type GeneratorDependencies struct {
|
|||||||
LogPath string
|
LogPath string
|
||||||
CPUProfile []byte
|
CPUProfile []byte
|
||||||
RefreshStatus func() // Optional callback to refresh status before bundle generation
|
RefreshStatus func() // Optional callback to refresh status before bundle generation
|
||||||
|
ClientMetrics MetricsExporter
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewBundleGenerator(deps GeneratorDependencies, cfg BundleConfig) *BundleGenerator {
|
func NewBundleGenerator(deps GeneratorDependencies, cfg BundleConfig) *BundleGenerator {
|
||||||
@@ -268,6 +277,7 @@ func NewBundleGenerator(deps GeneratorDependencies, cfg BundleConfig) *BundleGen
|
|||||||
logPath: deps.LogPath,
|
logPath: deps.LogPath,
|
||||||
cpuProfile: deps.CPUProfile,
|
cpuProfile: deps.CPUProfile,
|
||||||
refreshStatus: deps.RefreshStatus,
|
refreshStatus: deps.RefreshStatus,
|
||||||
|
clientMetrics: deps.ClientMetrics,
|
||||||
|
|
||||||
anonymize: cfg.Anonymize,
|
anonymize: cfg.Anonymize,
|
||||||
includeSystemInfo: cfg.IncludeSystemInfo,
|
includeSystemInfo: cfg.IncludeSystemInfo,
|
||||||
@@ -351,6 +361,14 @@ func (g *BundleGenerator) createArchive() error {
|
|||||||
log.Errorf("failed to add corrupted state files to debug bundle: %v", err)
|
log.Errorf("failed to add corrupted state files to debug bundle: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := g.addServiceParams(); err != nil {
|
||||||
|
log.Errorf("failed to add service params to debug bundle: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := g.addMetrics(); err != nil {
|
||||||
|
log.Errorf("failed to add metrics to debug bundle: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
if err := g.addWgShow(); err != nil {
|
if err := g.addWgShow(); err != nil {
|
||||||
log.Errorf("failed to add wg show output: %v", err)
|
log.Errorf("failed to add wg show output: %v", err)
|
||||||
}
|
}
|
||||||
@@ -418,7 +436,10 @@ func (g *BundleGenerator) addStatus() error {
|
|||||||
fullStatus := g.statusRecorder.GetFullStatus()
|
fullStatus := g.statusRecorder.GetFullStatus()
|
||||||
protoFullStatus := nbstatus.ToProtoFullStatus(fullStatus)
|
protoFullStatus := nbstatus.ToProtoFullStatus(fullStatus)
|
||||||
protoFullStatus.Events = g.statusRecorder.GetEventHistory()
|
protoFullStatus.Events = g.statusRecorder.GetEventHistory()
|
||||||
overview := nbstatus.ConvertToStatusOutputOverview(protoFullStatus, g.anonymize, version.NetbirdVersion(), "", nil, nil, nil, "", profName)
|
overview := nbstatus.ConvertToStatusOutputOverview(protoFullStatus, nbstatus.ConvertOptions{
|
||||||
|
Anonymize: g.anonymize,
|
||||||
|
ProfileName: profName,
|
||||||
|
})
|
||||||
statusOutput := overview.FullDetailSummary()
|
statusOutput := overview.FullDetailSummary()
|
||||||
|
|
||||||
statusReader := strings.NewReader(statusOutput)
|
statusReader := strings.NewReader(statusOutput)
|
||||||
@@ -473,6 +494,90 @@ func (g *BundleGenerator) addConfig() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
serviceParamsFile = "service.json"
|
||||||
|
serviceParamsBundle = "service_params.json"
|
||||||
|
maskedValue = "***"
|
||||||
|
envVarPrefix = "NB_"
|
||||||
|
jsonKeyManagementURL = "management_url"
|
||||||
|
jsonKeyServiceEnv = "service_env_vars"
|
||||||
|
)
|
||||||
|
|
||||||
|
var sensitiveEnvSubstrings = []string{"key", "token", "secret", "password", "credential"}
|
||||||
|
|
||||||
|
// addServiceParams reads the service.json file and adds a sanitized version to the bundle.
|
||||||
|
// Non-NB_ env vars and vars with sensitive names are masked. Other NB_ values are anonymized.
|
||||||
|
func (g *BundleGenerator) addServiceParams() error {
|
||||||
|
path := filepath.Join(configs.StateDir, serviceParamsFile)
|
||||||
|
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("read service params: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var params map[string]any
|
||||||
|
if err := json.Unmarshal(data, ¶ms); err != nil {
|
||||||
|
return fmt.Errorf("parse service params: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if g.anonymize {
|
||||||
|
if mgmtURL, ok := params[jsonKeyManagementURL].(string); ok && mgmtURL != "" {
|
||||||
|
params[jsonKeyManagementURL] = g.anonymizer.AnonymizeURI(mgmtURL)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
g.sanitizeServiceEnvVars(params)
|
||||||
|
|
||||||
|
sanitizedData, err := json.MarshalIndent(params, "", " ")
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("marshal sanitized service params: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := g.addFileToZip(bytes.NewReader(sanitizedData), serviceParamsBundle); err != nil {
|
||||||
|
return fmt.Errorf("add service params to zip: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// sanitizeServiceEnvVars masks or anonymizes env var values in service params.
|
||||||
|
// Non-NB_ vars and vars with sensitive names (key, token, etc.) are fully masked.
|
||||||
|
// Other NB_ var values are passed through the anonymizer when anonymization is enabled.
|
||||||
|
func (g *BundleGenerator) sanitizeServiceEnvVars(params map[string]any) {
|
||||||
|
envVars, ok := params[jsonKeyServiceEnv].(map[string]any)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
sanitized := make(map[string]any, len(envVars))
|
||||||
|
for k, v := range envVars {
|
||||||
|
val, _ := v.(string)
|
||||||
|
switch {
|
||||||
|
case !strings.HasPrefix(k, envVarPrefix) || isSensitiveEnvVar(k):
|
||||||
|
sanitized[k] = maskedValue
|
||||||
|
case g.anonymize:
|
||||||
|
sanitized[k] = g.anonymizer.AnonymizeString(val)
|
||||||
|
default:
|
||||||
|
sanitized[k] = val
|
||||||
|
}
|
||||||
|
}
|
||||||
|
params[jsonKeyServiceEnv] = sanitized
|
||||||
|
}
|
||||||
|
|
||||||
|
// isSensitiveEnvVar returns true for env var names that may contain secrets.
|
||||||
|
func isSensitiveEnvVar(key string) bool {
|
||||||
|
lower := strings.ToLower(key)
|
||||||
|
for _, s := range sensitiveEnvSubstrings {
|
||||||
|
if strings.Contains(lower, s) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
func (g *BundleGenerator) addCommonConfigFields(configContent *strings.Builder) {
|
func (g *BundleGenerator) addCommonConfigFields(configContent *strings.Builder) {
|
||||||
configContent.WriteString("NetBird Client Configuration:\n\n")
|
configContent.WriteString("NetBird Client Configuration:\n\n")
|
||||||
|
|
||||||
@@ -744,6 +849,30 @@ func (g *BundleGenerator) addCorruptedStateFiles() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (g *BundleGenerator) addMetrics() error {
|
||||||
|
if g.clientMetrics == nil {
|
||||||
|
log.Debugf("skipping metrics in debug bundle: no metrics collector")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
if err := g.clientMetrics.Export(&buf); err != nil {
|
||||||
|
return fmt.Errorf("export metrics: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if buf.Len() == 0 {
|
||||||
|
log.Debugf("skipping metrics.txt in debug bundle: no metrics data")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := g.addFileToZip(&buf, "metrics.txt"); err != nil {
|
||||||
|
return fmt.Errorf("add metrics file to zip: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Debugf("added metrics to debug bundle")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func (g *BundleGenerator) addLogfile() error {
|
func (g *BundleGenerator) addLogfile() error {
|
||||||
if g.logPath == "" {
|
if g.logPath == "" {
|
||||||
log.Debugf("skipping empty log file in debug bundle")
|
log.Debugf("skipping empty log file in debug bundle")
|
||||||
|
|||||||
@@ -1,8 +1,12 @@
|
|||||||
package debug
|
package debug
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"archive/zip"
|
||||||
|
"bytes"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"net"
|
"net"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
@@ -10,6 +14,7 @@ import (
|
|||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
"github.com/netbirdio/netbird/client/anonymize"
|
"github.com/netbirdio/netbird/client/anonymize"
|
||||||
|
"github.com/netbirdio/netbird/client/configs"
|
||||||
mgmProto "github.com/netbirdio/netbird/shared/management/proto"
|
mgmProto "github.com/netbirdio/netbird/shared/management/proto"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -420,6 +425,226 @@ func TestAnonymizeNetworkMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestIsSensitiveEnvVar(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
key string
|
||||||
|
sensitive bool
|
||||||
|
}{
|
||||||
|
{"NB_SETUP_KEY", true},
|
||||||
|
{"NB_API_TOKEN", true},
|
||||||
|
{"NB_CLIENT_SECRET", true},
|
||||||
|
{"NB_PASSWORD", true},
|
||||||
|
{"NB_CREDENTIAL", true},
|
||||||
|
{"NB_LOG_LEVEL", false},
|
||||||
|
{"NB_MANAGEMENT_URL", false},
|
||||||
|
{"NB_HOSTNAME", false},
|
||||||
|
{"HOME", false},
|
||||||
|
{"PATH", false},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.key, func(t *testing.T) {
|
||||||
|
assert.Equal(t, tt.sensitive, isSensitiveEnvVar(tt.key))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSanitizeServiceEnvVars(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
anonymize bool
|
||||||
|
input map[string]any
|
||||||
|
check func(t *testing.T, params map[string]any)
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "no env vars key",
|
||||||
|
anonymize: false,
|
||||||
|
input: map[string]any{"management_url": "https://mgmt.example.com"},
|
||||||
|
check: func(t *testing.T, params map[string]any) {
|
||||||
|
t.Helper()
|
||||||
|
assert.Equal(t, "https://mgmt.example.com", params["management_url"], "non-env fields should be untouched")
|
||||||
|
_, ok := params[jsonKeyServiceEnv]
|
||||||
|
assert.False(t, ok, "service_env_vars should not be added")
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "non-NB vars are masked",
|
||||||
|
anonymize: false,
|
||||||
|
input: map[string]any{
|
||||||
|
jsonKeyServiceEnv: map[string]any{
|
||||||
|
"HOME": "/root",
|
||||||
|
"PATH": "/usr/bin",
|
||||||
|
"NB_LOG_LEVEL": "debug",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
check: func(t *testing.T, params map[string]any) {
|
||||||
|
t.Helper()
|
||||||
|
env := params[jsonKeyServiceEnv].(map[string]any)
|
||||||
|
assert.Equal(t, maskedValue, env["HOME"], "non-NB_ var should be masked")
|
||||||
|
assert.Equal(t, maskedValue, env["PATH"], "non-NB_ var should be masked")
|
||||||
|
assert.Equal(t, "debug", env["NB_LOG_LEVEL"], "safe NB_ var should pass through")
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "sensitive NB vars are masked",
|
||||||
|
anonymize: false,
|
||||||
|
input: map[string]any{
|
||||||
|
jsonKeyServiceEnv: map[string]any{
|
||||||
|
"NB_SETUP_KEY": "abc123",
|
||||||
|
"NB_API_TOKEN": "tok_xyz",
|
||||||
|
"NB_LOG_LEVEL": "info",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
check: func(t *testing.T, params map[string]any) {
|
||||||
|
t.Helper()
|
||||||
|
env := params[jsonKeyServiceEnv].(map[string]any)
|
||||||
|
assert.Equal(t, maskedValue, env["NB_SETUP_KEY"], "sensitive NB_ var should be masked")
|
||||||
|
assert.Equal(t, maskedValue, env["NB_API_TOKEN"], "sensitive NB_ var should be masked")
|
||||||
|
assert.Equal(t, "info", env["NB_LOG_LEVEL"], "safe NB_ var should pass through")
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "safe NB vars anonymized when anonymize is true",
|
||||||
|
anonymize: true,
|
||||||
|
input: map[string]any{
|
||||||
|
jsonKeyServiceEnv: map[string]any{
|
||||||
|
"NB_MANAGEMENT_URL": "https://mgmt.example.com:443",
|
||||||
|
"NB_LOG_LEVEL": "debug",
|
||||||
|
"NB_SETUP_KEY": "secret",
|
||||||
|
"SOME_OTHER": "val",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
check: func(t *testing.T, params map[string]any) {
|
||||||
|
t.Helper()
|
||||||
|
env := params[jsonKeyServiceEnv].(map[string]any)
|
||||||
|
// Safe NB_ values should be anonymized (not the original, not masked)
|
||||||
|
mgmtVal := env["NB_MANAGEMENT_URL"].(string)
|
||||||
|
assert.NotEqual(t, "https://mgmt.example.com:443", mgmtVal, "should be anonymized")
|
||||||
|
assert.NotEqual(t, maskedValue, mgmtVal, "should not be masked")
|
||||||
|
|
||||||
|
logVal := env["NB_LOG_LEVEL"].(string)
|
||||||
|
assert.NotEqual(t, maskedValue, logVal, "safe NB_ var should not be masked")
|
||||||
|
|
||||||
|
// Sensitive and non-NB_ still masked
|
||||||
|
assert.Equal(t, maskedValue, env["NB_SETUP_KEY"])
|
||||||
|
assert.Equal(t, maskedValue, env["SOME_OTHER"])
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
anonymizer := anonymize.NewAnonymizer(anonymize.DefaultAddresses())
|
||||||
|
g := &BundleGenerator{
|
||||||
|
anonymize: tt.anonymize,
|
||||||
|
anonymizer: anonymizer,
|
||||||
|
}
|
||||||
|
g.sanitizeServiceEnvVars(tt.input)
|
||||||
|
tt.check(t, tt.input)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddServiceParams(t *testing.T) {
|
||||||
|
t.Run("missing service.json returns nil", func(t *testing.T) {
|
||||||
|
g := &BundleGenerator{
|
||||||
|
anonymizer: anonymize.NewAnonymizer(anonymize.DefaultAddresses()),
|
||||||
|
}
|
||||||
|
|
||||||
|
origStateDir := configs.StateDir
|
||||||
|
configs.StateDir = t.TempDir()
|
||||||
|
t.Cleanup(func() { configs.StateDir = origStateDir })
|
||||||
|
|
||||||
|
err := g.addServiceParams()
|
||||||
|
assert.NoError(t, err)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("management_url anonymized when anonymize is true", func(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
origStateDir := configs.StateDir
|
||||||
|
configs.StateDir = dir
|
||||||
|
t.Cleanup(func() { configs.StateDir = origStateDir })
|
||||||
|
|
||||||
|
input := map[string]any{
|
||||||
|
jsonKeyManagementURL: "https://api.example.com:443",
|
||||||
|
jsonKeyServiceEnv: map[string]any{
|
||||||
|
"NB_LOG_LEVEL": "trace",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
data, err := json.Marshal(input)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, serviceParamsFile), data, 0600))
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
zw := zip.NewWriter(&buf)
|
||||||
|
|
||||||
|
g := &BundleGenerator{
|
||||||
|
anonymize: true,
|
||||||
|
anonymizer: anonymize.NewAnonymizer(anonymize.DefaultAddresses()),
|
||||||
|
archive: zw,
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, g.addServiceParams())
|
||||||
|
require.NoError(t, zw.Close())
|
||||||
|
|
||||||
|
zr, err := zip.NewReader(bytes.NewReader(buf.Bytes()), int64(buf.Len()))
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Len(t, zr.File, 1)
|
||||||
|
assert.Equal(t, serviceParamsBundle, zr.File[0].Name)
|
||||||
|
|
||||||
|
rc, err := zr.File[0].Open()
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer rc.Close()
|
||||||
|
|
||||||
|
var result map[string]any
|
||||||
|
require.NoError(t, json.NewDecoder(rc).Decode(&result))
|
||||||
|
|
||||||
|
mgmt := result[jsonKeyManagementURL].(string)
|
||||||
|
assert.NotEqual(t, "https://api.example.com:443", mgmt, "management_url should be anonymized")
|
||||||
|
assert.NotEmpty(t, mgmt)
|
||||||
|
|
||||||
|
env := result[jsonKeyServiceEnv].(map[string]any)
|
||||||
|
assert.NotEqual(t, maskedValue, env["NB_LOG_LEVEL"], "safe NB_ var should not be masked")
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("management_url preserved when anonymize is false", func(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
origStateDir := configs.StateDir
|
||||||
|
configs.StateDir = dir
|
||||||
|
t.Cleanup(func() { configs.StateDir = origStateDir })
|
||||||
|
|
||||||
|
input := map[string]any{
|
||||||
|
jsonKeyManagementURL: "https://api.example.com:443",
|
||||||
|
}
|
||||||
|
data, err := json.Marshal(input)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, serviceParamsFile), data, 0600))
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
zw := zip.NewWriter(&buf)
|
||||||
|
|
||||||
|
g := &BundleGenerator{
|
||||||
|
anonymize: false,
|
||||||
|
anonymizer: anonymize.NewAnonymizer(anonymize.DefaultAddresses()),
|
||||||
|
archive: zw,
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, g.addServiceParams())
|
||||||
|
require.NoError(t, zw.Close())
|
||||||
|
|
||||||
|
zr, err := zip.NewReader(bytes.NewReader(buf.Bytes()), int64(buf.Len()))
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
rc, err := zr.File[0].Open()
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer rc.Close()
|
||||||
|
|
||||||
|
var result map[string]any
|
||||||
|
require.NoError(t, json.NewDecoder(rc).Decode(&result))
|
||||||
|
|
||||||
|
assert.Equal(t, "https://api.example.com:443", result[jsonKeyManagementURL], "management_url should be preserved")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
// Helper function to check if IP is in CGNAT range
|
// Helper function to check if IP is in CGNAT range
|
||||||
func isInCGNATRange(ip net.IP) bool {
|
func isInCGNATRange(ip net.IP) bool {
|
||||||
cgnat := net.IPNet{
|
cgnat := net.IPNet{
|
||||||
|
|||||||
@@ -73,6 +73,9 @@ func (w *ResponseWriterChain) WriteMsg(m *dns.Msg) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
w.response = m
|
w.response = m
|
||||||
|
if m.MsgHdr.Truncated {
|
||||||
|
w.SetMeta("truncated", "true")
|
||||||
|
}
|
||||||
return w.ResponseWriter.WriteMsg(m)
|
return w.ResponseWriter.WriteMsg(m)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -195,10 +198,14 @@ func (c *HandlerChain) ServeDNS(w dns.ResponseWriter, r *dns.Msg) {
|
|||||||
|
|
||||||
startTime := time.Now()
|
startTime := time.Now()
|
||||||
requestID := resutil.GenerateRequestID()
|
requestID := resutil.GenerateRequestID()
|
||||||
logger := log.WithFields(log.Fields{
|
fields := log.Fields{
|
||||||
"request_id": requestID,
|
"request_id": requestID,
|
||||||
"dns_id": fmt.Sprintf("%04x", r.Id),
|
"dns_id": fmt.Sprintf("%04x", r.Id),
|
||||||
})
|
}
|
||||||
|
if addr := w.RemoteAddr(); addr != nil {
|
||||||
|
fields["client"] = addr.String()
|
||||||
|
}
|
||||||
|
logger := log.WithFields(fields)
|
||||||
|
|
||||||
question := r.Question[0]
|
question := r.Question[0]
|
||||||
qname := strings.ToLower(question.Name)
|
qname := strings.ToLower(question.Name)
|
||||||
@@ -261,9 +268,9 @@ func (c *HandlerChain) logResponse(logger *log.Entry, cw *ResponseWriterChain, q
|
|||||||
meta += " " + k + "=" + v
|
meta += " " + k + "=" + v
|
||||||
}
|
}
|
||||||
|
|
||||||
logger.Tracef("response: domain=%s rcode=%s answers=%s%s took=%s",
|
logger.Tracef("response: domain=%s rcode=%s answers=%s size=%dB%s took=%s",
|
||||||
qname, dns.RcodeToString[cw.response.Rcode], resutil.FormatAnswers(cw.response.Answer),
|
qname, dns.RcodeToString[cw.response.Rcode], resutil.FormatAnswers(cw.response.Answer),
|
||||||
meta, time.Since(startTime))
|
cw.response.Len(), meta, time.Since(startTime))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *HandlerChain) isHandlerMatch(qname string, entry HandlerEntry) bool {
|
func (c *HandlerChain) isHandlerMatch(qname string, entry HandlerEntry) bool {
|
||||||
|
|||||||
@@ -14,6 +14,8 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
|
"github.com/hashicorp/go-multierror"
|
||||||
|
nberrors "github.com/netbirdio/netbird/client/errors"
|
||||||
log "github.com/sirupsen/logrus"
|
log "github.com/sirupsen/logrus"
|
||||||
"golang.org/x/exp/maps"
|
"golang.org/x/exp/maps"
|
||||||
|
|
||||||
@@ -22,6 +24,7 @@ import (
|
|||||||
|
|
||||||
const (
|
const (
|
||||||
netbirdDNSStateKeyFormat = "State:/Network/Service/NetBird-%s/DNS"
|
netbirdDNSStateKeyFormat = "State:/Network/Service/NetBird-%s/DNS"
|
||||||
|
netbirdDNSStateKeyIndexedFormat = "State:/Network/Service/NetBird-%s-%d/DNS"
|
||||||
globalIPv4State = "State:/Network/Global/IPv4"
|
globalIPv4State = "State:/Network/Global/IPv4"
|
||||||
primaryServiceStateKeyFormat = "State:/Network/Service/%s/DNS"
|
primaryServiceStateKeyFormat = "State:/Network/Service/%s/DNS"
|
||||||
keySupplementalMatchDomains = "SupplementalMatchDomains"
|
keySupplementalMatchDomains = "SupplementalMatchDomains"
|
||||||
@@ -35,6 +38,14 @@ const (
|
|||||||
searchSuffix = "Search"
|
searchSuffix = "Search"
|
||||||
matchSuffix = "Match"
|
matchSuffix = "Match"
|
||||||
localSuffix = "Local"
|
localSuffix = "Local"
|
||||||
|
|
||||||
|
// maxDomainsPerResolverEntry is the max number of domains per scutil resolver key.
|
||||||
|
// scutil's d.add has maxArgs=101 (key + * + 99 values), so 99 is the hard cap.
|
||||||
|
maxDomainsPerResolverEntry = 50
|
||||||
|
|
||||||
|
// maxDomainBytesPerResolverEntry is the max total bytes of domain strings per key.
|
||||||
|
// scutil has an undocumented ~2048 byte value buffer; we stay well under it.
|
||||||
|
maxDomainBytesPerResolverEntry = 1500
|
||||||
)
|
)
|
||||||
|
|
||||||
type systemConfigurator struct {
|
type systemConfigurator struct {
|
||||||
@@ -84,28 +95,23 @@ func (s *systemConfigurator) applyDNSConfig(config HostDNSConfig, stateManager *
|
|||||||
searchDomains = append(searchDomains, strings.TrimSuffix(""+dConf.Domain, "."))
|
searchDomains = append(searchDomains, strings.TrimSuffix(""+dConf.Domain, "."))
|
||||||
}
|
}
|
||||||
|
|
||||||
matchKey := getKeyWithInput(netbirdDNSStateKeyFormat, matchSuffix)
|
if err := s.removeKeysContaining(matchSuffix); err != nil {
|
||||||
var err error
|
log.Warnf("failed to remove old match keys: %v", err)
|
||||||
if len(matchDomains) != 0 {
|
|
||||||
err = s.addMatchDomains(matchKey, strings.Join(matchDomains, " "), config.ServerIP, config.ServerPort)
|
|
||||||
} else {
|
|
||||||
log.Infof("removing match domains from the system")
|
|
||||||
err = s.removeKeyFromSystemConfig(matchKey)
|
|
||||||
}
|
}
|
||||||
if err != nil {
|
if len(matchDomains) != 0 {
|
||||||
return fmt.Errorf("add match domains: %w", err)
|
if err := s.addBatchedDomains(matchSuffix, matchDomains, config.ServerIP, config.ServerPort, false); err != nil {
|
||||||
|
return fmt.Errorf("add match domains: %w", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
s.updateState(stateManager)
|
s.updateState(stateManager)
|
||||||
|
|
||||||
searchKey := getKeyWithInput(netbirdDNSStateKeyFormat, searchSuffix)
|
if err := s.removeKeysContaining(searchSuffix); err != nil {
|
||||||
if len(searchDomains) != 0 {
|
log.Warnf("failed to remove old search keys: %v", err)
|
||||||
err = s.addSearchDomains(searchKey, strings.Join(searchDomains, " "), config.ServerIP, config.ServerPort)
|
|
||||||
} else {
|
|
||||||
log.Infof("removing search domains from the system")
|
|
||||||
err = s.removeKeyFromSystemConfig(searchKey)
|
|
||||||
}
|
}
|
||||||
if err != nil {
|
if len(searchDomains) != 0 {
|
||||||
return fmt.Errorf("add search domains: %w", err)
|
if err := s.addBatchedDomains(searchSuffix, searchDomains, config.ServerIP, config.ServerPort, true); err != nil {
|
||||||
|
return fmt.Errorf("add search domains: %w", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
s.updateState(stateManager)
|
s.updateState(stateManager)
|
||||||
|
|
||||||
@@ -149,8 +155,7 @@ func (s *systemConfigurator) restoreHostDNS() error {
|
|||||||
|
|
||||||
func (s *systemConfigurator) getRemovableKeysWithDefaults() []string {
|
func (s *systemConfigurator) getRemovableKeysWithDefaults() []string {
|
||||||
if len(s.createdKeys) == 0 {
|
if len(s.createdKeys) == 0 {
|
||||||
// return defaults for startup calls
|
return s.discoverExistingKeys()
|
||||||
return []string{getKeyWithInput(netbirdDNSStateKeyFormat, searchSuffix), getKeyWithInput(netbirdDNSStateKeyFormat, matchSuffix)}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
keys := make([]string, 0, len(s.createdKeys))
|
keys := make([]string, 0, len(s.createdKeys))
|
||||||
@@ -160,6 +165,47 @@ func (s *systemConfigurator) getRemovableKeysWithDefaults() []string {
|
|||||||
return keys
|
return keys
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// discoverExistingKeys probes scutil for all NetBird DNS keys that may exist.
|
||||||
|
// This handles the case where createdKeys is empty (e.g., state file lost after unclean shutdown).
|
||||||
|
func (s *systemConfigurator) discoverExistingKeys() []string {
|
||||||
|
dnsKeys, err := getSystemDNSKeys()
|
||||||
|
if err != nil {
|
||||||
|
log.Errorf("failed to get system DNS keys: %v", err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var keys []string
|
||||||
|
|
||||||
|
for _, suffix := range []string{searchSuffix, matchSuffix, localSuffix} {
|
||||||
|
key := getKeyWithInput(netbirdDNSStateKeyFormat, suffix)
|
||||||
|
if strings.Contains(dnsKeys, key) {
|
||||||
|
keys = append(keys, key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, suffix := range []string{searchSuffix, matchSuffix} {
|
||||||
|
for i := 0; ; i++ {
|
||||||
|
key := fmt.Sprintf(netbirdDNSStateKeyIndexedFormat, suffix, i)
|
||||||
|
if !strings.Contains(dnsKeys, key) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
keys = append(keys, key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return keys
|
||||||
|
}
|
||||||
|
|
||||||
|
// getSystemDNSKeys gets all DNS keys
|
||||||
|
func getSystemDNSKeys() (string, error) {
|
||||||
|
command := "list .*DNS\nquit\n"
|
||||||
|
out, err := runSystemConfigCommand(command)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return string(out), nil
|
||||||
|
}
|
||||||
|
|
||||||
func (s *systemConfigurator) removeKeyFromSystemConfig(key string) error {
|
func (s *systemConfigurator) removeKeyFromSystemConfig(key string) error {
|
||||||
line := buildRemoveKeyOperation(key)
|
line := buildRemoveKeyOperation(key)
|
||||||
_, err := runSystemConfigCommand(wrapCommand(line))
|
_, err := runSystemConfigCommand(wrapCommand(line))
|
||||||
@@ -184,12 +230,11 @@ func (s *systemConfigurator) addLocalDNS() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := s.addSearchDomains(
|
domainsStr := strings.Join(s.systemDNSSettings.Domains, " ")
|
||||||
localKey,
|
if err := s.addDNSState(localKey, domainsStr, s.systemDNSSettings.ServerIP, s.systemDNSSettings.ServerPort, true); err != nil {
|
||||||
strings.Join(s.systemDNSSettings.Domains, " "), s.systemDNSSettings.ServerIP, s.systemDNSSettings.ServerPort,
|
return fmt.Errorf("add local dns state: %w", err)
|
||||||
); err != nil {
|
|
||||||
return fmt.Errorf("add search domains: %w", err)
|
|
||||||
}
|
}
|
||||||
|
s.createdKeys[localKey] = struct{}{}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -280,28 +325,77 @@ func (s *systemConfigurator) getOriginalNameservers() []netip.Addr {
|
|||||||
return slices.Clone(s.origNameservers)
|
return slices.Clone(s.origNameservers)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *systemConfigurator) addSearchDomains(key, domains string, ip netip.Addr, port int) error {
|
// splitDomainsIntoBatches splits domains into batches respecting both element count and byte size limits.
|
||||||
err := s.addDNSState(key, domains, ip, port, true)
|
func splitDomainsIntoBatches(domains []string) [][]string {
|
||||||
if err != nil {
|
if len(domains) == 0 {
|
||||||
return fmt.Errorf("add dns state: %w", err)
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Infof("added %d search domains to the state. Domain list: %s", len(strings.Split(domains, " ")), domains)
|
var batches [][]string
|
||||||
|
var current []string
|
||||||
|
currentBytes := 0
|
||||||
|
|
||||||
s.createdKeys[key] = struct{}{}
|
for _, d := range domains {
|
||||||
|
domainLen := len(d)
|
||||||
|
newBytes := currentBytes + domainLen
|
||||||
|
if currentBytes > 0 {
|
||||||
|
newBytes++ // space separator
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
if len(current) > 0 && (len(current) >= maxDomainsPerResolverEntry || newBytes > maxDomainBytesPerResolverEntry) {
|
||||||
|
batches = append(batches, current)
|
||||||
|
current = nil
|
||||||
|
currentBytes = 0
|
||||||
|
}
|
||||||
|
|
||||||
|
current = append(current, d)
|
||||||
|
if currentBytes > 0 {
|
||||||
|
currentBytes += 1 + domainLen
|
||||||
|
} else {
|
||||||
|
currentBytes = domainLen
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(current) > 0 {
|
||||||
|
batches = append(batches, current)
|
||||||
|
}
|
||||||
|
|
||||||
|
return batches
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *systemConfigurator) addMatchDomains(key, domains string, dnsServer netip.Addr, port int) error {
|
// removeKeysContaining removes all created keys that contain the given substring.
|
||||||
err := s.addDNSState(key, domains, dnsServer, port, false)
|
func (s *systemConfigurator) removeKeysContaining(suffix string) error {
|
||||||
if err != nil {
|
var toRemove []string
|
||||||
return fmt.Errorf("add dns state: %w", err)
|
for key := range s.createdKeys {
|
||||||
|
if strings.Contains(key, suffix) {
|
||||||
|
toRemove = append(toRemove, key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var multiErr *multierror.Error
|
||||||
|
for _, key := range toRemove {
|
||||||
|
if err := s.removeKeyFromSystemConfig(key); err != nil {
|
||||||
|
multiErr = multierror.Append(multiErr, fmt.Errorf("couldn't remove key %s: %w", key, err))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nberrors.FormatErrorOrNil(multiErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
// addBatchedDomains splits domains into batches and creates indexed scutil keys for each batch.
|
||||||
|
func (s *systemConfigurator) addBatchedDomains(suffix string, domains []string, ip netip.Addr, port int, enableSearch bool) error {
|
||||||
|
batches := splitDomainsIntoBatches(domains)
|
||||||
|
|
||||||
|
for i, batch := range batches {
|
||||||
|
key := fmt.Sprintf(netbirdDNSStateKeyIndexedFormat, suffix, i)
|
||||||
|
domainsStr := strings.Join(batch, " ")
|
||||||
|
|
||||||
|
if err := s.addDNSState(key, domainsStr, ip, port, enableSearch); err != nil {
|
||||||
|
return fmt.Errorf("add dns state for batch %d: %w", i, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
s.createdKeys[key] = struct{}{}
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Infof("added %d match domains to the state. Domain list: %s", len(strings.Split(domains, " ")), domains)
|
log.Infof("added %d %s domains across %d resolver entries", len(domains), suffix, len(batches))
|
||||||
|
|
||||||
s.createdKeys[key] = struct{}{}
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -364,7 +458,6 @@ func (s *systemConfigurator) flushDNSCache() error {
|
|||||||
if out, err := cmd.CombinedOutput(); err != nil {
|
if out, err := cmd.CombinedOutput(); err != nil {
|
||||||
return fmt.Errorf("restart mDNSResponder: %w, output: %s", err, out)
|
return fmt.Errorf("restart mDNSResponder: %w, output: %s", err, out)
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Info("flushed DNS cache")
|
log.Info("flushed DNS cache")
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,10 @@
|
|||||||
package dns
|
package dns
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bufio"
|
||||||
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
|
"fmt"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -49,17 +52,22 @@ func TestDarwinDNSUncleanShutdownCleanup(t *testing.T) {
|
|||||||
|
|
||||||
require.NoError(t, sm.PersistState(context.Background()))
|
require.NoError(t, sm.PersistState(context.Background()))
|
||||||
|
|
||||||
searchKey := getKeyWithInput(netbirdDNSStateKeyFormat, searchSuffix)
|
|
||||||
matchKey := getKeyWithInput(netbirdDNSStateKeyFormat, matchSuffix)
|
|
||||||
localKey := getKeyWithInput(netbirdDNSStateKeyFormat, localSuffix)
|
localKey := getKeyWithInput(netbirdDNSStateKeyFormat, localSuffix)
|
||||||
|
|
||||||
|
// Collect all created keys for cleanup verification
|
||||||
|
createdKeys := make([]string, 0, len(configurator.createdKeys))
|
||||||
|
for key := range configurator.createdKeys {
|
||||||
|
createdKeys = append(createdKeys, key)
|
||||||
|
}
|
||||||
|
|
||||||
defer func() {
|
defer func() {
|
||||||
for _, key := range []string{searchKey, matchKey, localKey} {
|
for _, key := range createdKeys {
|
||||||
_ = removeTestDNSKey(key)
|
_ = removeTestDNSKey(key)
|
||||||
}
|
}
|
||||||
|
_ = removeTestDNSKey(localKey)
|
||||||
}()
|
}()
|
||||||
|
|
||||||
for _, key := range []string{searchKey, matchKey, localKey} {
|
for _, key := range createdKeys {
|
||||||
exists, err := checkDNSKeyExists(key)
|
exists, err := checkDNSKeyExists(key)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
if exists {
|
if exists {
|
||||||
@@ -83,13 +91,223 @@ func TestDarwinDNSUncleanShutdownCleanup(t *testing.T) {
|
|||||||
err = shutdownState.Cleanup()
|
err = shutdownState.Cleanup()
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
for _, key := range []string{searchKey, matchKey, localKey} {
|
for _, key := range createdKeys {
|
||||||
exists, err := checkDNSKeyExists(key)
|
exists, err := checkDNSKeyExists(key)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.False(t, exists, "Key %s should NOT exist after cleanup", key)
|
assert.False(t, exists, "Key %s should NOT exist after cleanup", key)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// generateShortDomains generates domains like a.com, b.com, ..., aa.com, ab.com, etc.
|
||||||
|
func generateShortDomains(count int) []string {
|
||||||
|
domains := make([]string, 0, count)
|
||||||
|
for i := range count {
|
||||||
|
label := ""
|
||||||
|
n := i
|
||||||
|
for {
|
||||||
|
label = string(rune('a'+n%26)) + label
|
||||||
|
n = n/26 - 1
|
||||||
|
if n < 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
domains = append(domains, label+".com")
|
||||||
|
}
|
||||||
|
return domains
|
||||||
|
}
|
||||||
|
|
||||||
|
// generateLongDomains generates domains like subdomain-000.department.organization-name.example.com
|
||||||
|
func generateLongDomains(count int) []string {
|
||||||
|
domains := make([]string, 0, count)
|
||||||
|
for i := range count {
|
||||||
|
domains = append(domains, fmt.Sprintf("subdomain-%03d.department.organization-name.example.com", i))
|
||||||
|
}
|
||||||
|
return domains
|
||||||
|
}
|
||||||
|
|
||||||
|
// readDomainsFromKey reads the SupplementalMatchDomains array back from scutil for a given key.
|
||||||
|
func readDomainsFromKey(t *testing.T, key string) []string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
cmd := exec.Command(scutilPath)
|
||||||
|
cmd.Stdin = strings.NewReader(fmt.Sprintf("open\nshow %s\nquit\n", key))
|
||||||
|
out, err := cmd.Output()
|
||||||
|
require.NoError(t, err, "scutil show should succeed")
|
||||||
|
|
||||||
|
var domains []string
|
||||||
|
inArray := false
|
||||||
|
scanner := bufio.NewScanner(bytes.NewReader(out))
|
||||||
|
for scanner.Scan() {
|
||||||
|
line := strings.TrimSpace(scanner.Text())
|
||||||
|
if strings.HasPrefix(line, "SupplementalMatchDomains") && strings.Contains(line, "<array>") {
|
||||||
|
inArray = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if inArray {
|
||||||
|
if line == "}" {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
// lines look like: "0 : a.com"
|
||||||
|
parts := strings.SplitN(line, " : ", 2)
|
||||||
|
if len(parts) == 2 {
|
||||||
|
domains = append(domains, parts[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
require.NoError(t, scanner.Err())
|
||||||
|
return domains
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSplitDomainsIntoBatches(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
domains []string
|
||||||
|
expectedCount int
|
||||||
|
checkAllPresent bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "empty",
|
||||||
|
domains: nil,
|
||||||
|
expectedCount: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "under_limit",
|
||||||
|
domains: generateShortDomains(10),
|
||||||
|
expectedCount: 1,
|
||||||
|
checkAllPresent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "at_element_limit",
|
||||||
|
domains: generateShortDomains(50),
|
||||||
|
expectedCount: 1,
|
||||||
|
checkAllPresent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "over_element_limit",
|
||||||
|
domains: generateShortDomains(51),
|
||||||
|
expectedCount: 2,
|
||||||
|
checkAllPresent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "triple_element_limit",
|
||||||
|
domains: generateShortDomains(150),
|
||||||
|
expectedCount: 3,
|
||||||
|
checkAllPresent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "long_domains_hit_byte_limit",
|
||||||
|
domains: generateLongDomains(50),
|
||||||
|
checkAllPresent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "500_short_domains",
|
||||||
|
domains: generateShortDomains(500),
|
||||||
|
expectedCount: 10,
|
||||||
|
checkAllPresent: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "500_long_domains",
|
||||||
|
domains: generateLongDomains(500),
|
||||||
|
checkAllPresent: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
batches := splitDomainsIntoBatches(tc.domains)
|
||||||
|
|
||||||
|
if tc.expectedCount > 0 {
|
||||||
|
assert.Len(t, batches, tc.expectedCount, "expected %d batches", tc.expectedCount)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify each batch respects limits
|
||||||
|
for i, batch := range batches {
|
||||||
|
assert.LessOrEqual(t, len(batch), maxDomainsPerResolverEntry,
|
||||||
|
"batch %d exceeds element limit", i)
|
||||||
|
|
||||||
|
totalBytes := 0
|
||||||
|
for j, d := range batch {
|
||||||
|
if j > 0 {
|
||||||
|
totalBytes++
|
||||||
|
}
|
||||||
|
totalBytes += len(d)
|
||||||
|
}
|
||||||
|
assert.LessOrEqual(t, totalBytes, maxDomainBytesPerResolverEntry,
|
||||||
|
"batch %d exceeds byte limit (%d bytes)", i, totalBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
if tc.checkAllPresent {
|
||||||
|
var all []string
|
||||||
|
for _, batch := range batches {
|
||||||
|
all = append(all, batch...)
|
||||||
|
}
|
||||||
|
assert.Equal(t, tc.domains, all, "all domains should be present in order")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestMatchDomainBatching writes increasing numbers of domains via the batching mechanism
|
||||||
|
// and verifies all domains are readable across multiple scutil keys.
|
||||||
|
func TestMatchDomainBatching(t *testing.T) {
|
||||||
|
if testing.Short() {
|
||||||
|
t.Skip("skipping scutil integration test in short mode")
|
||||||
|
}
|
||||||
|
|
||||||
|
testCases := []struct {
|
||||||
|
name string
|
||||||
|
count int
|
||||||
|
generator func(int) []string
|
||||||
|
}{
|
||||||
|
{"short_10", 10, generateShortDomains},
|
||||||
|
{"short_50", 50, generateShortDomains},
|
||||||
|
{"short_100", 100, generateShortDomains},
|
||||||
|
{"short_200", 200, generateShortDomains},
|
||||||
|
{"short_500", 500, generateShortDomains},
|
||||||
|
{"long_10", 10, generateLongDomains},
|
||||||
|
{"long_50", 50, generateLongDomains},
|
||||||
|
{"long_100", 100, generateLongDomains},
|
||||||
|
{"long_200", 200, generateLongDomains},
|
||||||
|
{"long_500", 500, generateLongDomains},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range testCases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
configurator := &systemConfigurator{
|
||||||
|
createdKeys: make(map[string]struct{}),
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() {
|
||||||
|
for key := range configurator.createdKeys {
|
||||||
|
_ = removeTestDNSKey(key)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
domains := tc.generator(tc.count)
|
||||||
|
err := configurator.addBatchedDomains(matchSuffix, domains, netip.MustParseAddr("100.64.0.1"), 53, false)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
batches := splitDomainsIntoBatches(domains)
|
||||||
|
t.Logf("wrote %d domains across %d batched keys", tc.count, len(batches))
|
||||||
|
|
||||||
|
// Read back all domains from all batched keys
|
||||||
|
var got []string
|
||||||
|
for i := range batches {
|
||||||
|
key := fmt.Sprintf(netbirdDNSStateKeyIndexedFormat, matchSuffix, i)
|
||||||
|
exists, err := checkDNSKeyExists(key)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.True(t, exists, "key %s should exist", key)
|
||||||
|
|
||||||
|
got = append(got, readDomainsFromKey(t, key)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Logf("read back %d/%d domains from %d keys", len(got), tc.count, len(batches))
|
||||||
|
assert.Equal(t, tc.count, len(got), "all domains should be readable")
|
||||||
|
assert.Equal(t, domains, got, "domains should match in order")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func checkDNSKeyExists(key string) (bool, error) {
|
func checkDNSKeyExists(key string) (bool, error) {
|
||||||
cmd := exec.Command(scutilPath)
|
cmd := exec.Command(scutilPath)
|
||||||
cmd.Stdin = strings.NewReader("show " + key + "\nquit\n")
|
cmd.Stdin = strings.NewReader("show " + key + "\nquit\n")
|
||||||
@@ -158,15 +376,15 @@ func setupTestConfigurator(t *testing.T) (*systemConfigurator, *statemanager.Man
|
|||||||
createdKeys: make(map[string]struct{}),
|
createdKeys: make(map[string]struct{}),
|
||||||
}
|
}
|
||||||
|
|
||||||
searchKey := getKeyWithInput(netbirdDNSStateKeyFormat, searchSuffix)
|
|
||||||
matchKey := getKeyWithInput(netbirdDNSStateKeyFormat, matchSuffix)
|
|
||||||
localKey := getKeyWithInput(netbirdDNSStateKeyFormat, localSuffix)
|
|
||||||
|
|
||||||
cleanup := func() {
|
cleanup := func() {
|
||||||
_ = sm.Stop(context.Background())
|
_ = sm.Stop(context.Background())
|
||||||
for _, key := range []string{searchKey, matchKey, localKey} {
|
for key := range configurator.createdKeys {
|
||||||
_ = removeTestDNSKey(key)
|
_ = removeTestDNSKey(key)
|
||||||
}
|
}
|
||||||
|
// Also clean up old-format keys and local key in case they exist
|
||||||
|
_ = removeTestDNSKey(getKeyWithInput(netbirdDNSStateKeyFormat, searchSuffix))
|
||||||
|
_ = removeTestDNSKey(getKeyWithInput(netbirdDNSStateKeyFormat, matchSuffix))
|
||||||
|
_ = removeTestDNSKey(getKeyWithInput(netbirdDNSStateKeyFormat, localSuffix))
|
||||||
}
|
}
|
||||||
|
|
||||||
return configurator, sm, cleanup
|
return configurator, sm, cleanup
|
||||||
|
|||||||
@@ -277,7 +277,7 @@ func (r *registryConfigurator) addDNSMatchPolicy(domains []string, ip netip.Addr
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Infof("added %d NRPT rules for %d domains. Domain list: %v", ruleIndex, len(domains), domains)
|
log.Infof("added %d NRPT rules for %d domains", ruleIndex, len(domains))
|
||||||
return ruleIndex, nil
|
return ruleIndex, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ func (d *Resolver) ID() types.HandlerID {
|
|||||||
return "local-resolver"
|
return "local-resolver"
|
||||||
}
|
}
|
||||||
|
|
||||||
func (d *Resolver) ProbeAvailability() {}
|
func (d *Resolver) ProbeAvailability(context.Context) {}
|
||||||
|
|
||||||
// ServeDNS handles a DNS request
|
// ServeDNS handles a DNS request
|
||||||
func (d *Resolver) ServeDNS(w dns.ResponseWriter, r *dns.Msg) {
|
func (d *Resolver) ServeDNS(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
|||||||
@@ -1263,9 +1263,9 @@ func TestLocalResolver_AuthoritativeFlag(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestLocalResolver_Stop tests cleanup on Stop
|
// TestLocalResolver_Stop tests cleanup on GracefullyStop
|
||||||
func TestLocalResolver_Stop(t *testing.T) {
|
func TestLocalResolver_Stop(t *testing.T) {
|
||||||
t.Run("Stop clears all state", func(t *testing.T) {
|
t.Run("GracefullyStop clears all state", func(t *testing.T) {
|
||||||
resolver := NewResolver()
|
resolver := NewResolver()
|
||||||
resolver.Update([]nbdns.CustomZone{{
|
resolver.Update([]nbdns.CustomZone{{
|
||||||
Domain: "example.com.",
|
Domain: "example.com.",
|
||||||
@@ -1285,7 +1285,7 @@ func TestLocalResolver_Stop(t *testing.T) {
|
|||||||
assert.False(t, resolver.isInManagedZone("host.example.com."))
|
assert.False(t, resolver.isInManagedZone("host.example.com."))
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("Stop is safe to call multiple times", func(t *testing.T) {
|
t.Run("GracefullyStop is safe to call multiple times", func(t *testing.T) {
|
||||||
resolver := NewResolver()
|
resolver := NewResolver()
|
||||||
resolver.Update([]nbdns.CustomZone{{
|
resolver.Update([]nbdns.CustomZone{{
|
||||||
Domain: "example.com.",
|
Domain: "example.com.",
|
||||||
@@ -1299,7 +1299,7 @@ func TestLocalResolver_Stop(t *testing.T) {
|
|||||||
resolver.Stop()
|
resolver.Stop()
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("Stop cancels in-flight external resolution", func(t *testing.T) {
|
t.Run("GracefullyStop cancels in-flight external resolution", func(t *testing.T) {
|
||||||
resolver := NewResolver()
|
resolver := NewResolver()
|
||||||
|
|
||||||
lookupStarted := make(chan struct{})
|
lookupStarted := make(chan struct{})
|
||||||
|
|||||||
@@ -376,9 +376,9 @@ func (m *Resolver) extractDomainsFromServerDomains(serverDomains dnsconfig.Serve
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if serverDomains.Flow != "" {
|
// Flow receiver domain is intentionally excluded from caching.
|
||||||
domains = append(domains, serverDomains.Flow)
|
// Cloud providers may rotate the IP behind this domain; a stale cached record
|
||||||
}
|
// causes TLS certificate verification failures on reconnect.
|
||||||
|
|
||||||
for _, stun := range serverDomains.Stuns {
|
for _, stun := range serverDomains.Stuns {
|
||||||
if stun != "" {
|
if stun != "" {
|
||||||
|
|||||||
@@ -391,7 +391,8 @@ func TestResolver_PartialUpdateAddsNewTypePreservesExisting(t *testing.T) {
|
|||||||
}
|
}
|
||||||
assert.Len(t, resolver.GetCachedDomains(), 3)
|
assert.Len(t, resolver.GetCachedDomains(), 3)
|
||||||
|
|
||||||
// Update with partial ServerDomains (only flow domain - new type, should preserve all existing)
|
// Update with partial ServerDomains (only flow domain - flow is intentionally excluded from
|
||||||
|
// caching to prevent TLS failures from stale records, so all existing domains are preserved)
|
||||||
partialDomains := dnsconfig.ServerDomains{
|
partialDomains := dnsconfig.ServerDomains{
|
||||||
Flow: "github.com",
|
Flow: "github.com",
|
||||||
}
|
}
|
||||||
@@ -400,10 +401,10 @@ func TestResolver_PartialUpdateAddsNewTypePreservesExisting(t *testing.T) {
|
|||||||
t.Skipf("Skipping test due to DNS resolution failure: %v", err)
|
t.Skipf("Skipping test due to DNS resolution failure: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
assert.Len(t, removedDomains, 0, "Should not remove any domains when adding new type")
|
assert.Len(t, removedDomains, 0, "Should not remove any domains when only flow domain is provided")
|
||||||
|
|
||||||
finalDomains := resolver.GetCachedDomains()
|
finalDomains := resolver.GetCachedDomains()
|
||||||
assert.Len(t, finalDomains, 4, "Should have all original domains plus new flow domain")
|
assert.Len(t, finalDomains, 3, "Flow domain is not cached; all original domains should be preserved")
|
||||||
|
|
||||||
domainStrings := make([]string, len(finalDomains))
|
domainStrings := make([]string, len(finalDomains))
|
||||||
for i, d := range finalDomains {
|
for i, d := range finalDomains {
|
||||||
@@ -412,5 +413,5 @@ func TestResolver_PartialUpdateAddsNewTypePreservesExisting(t *testing.T) {
|
|||||||
assert.Contains(t, domainStrings, "example.org")
|
assert.Contains(t, domainStrings, "example.org")
|
||||||
assert.Contains(t, domainStrings, "google.com")
|
assert.Contains(t, domainStrings, "google.com")
|
||||||
assert.Contains(t, domainStrings, "cloudflare.com")
|
assert.Contains(t, domainStrings, "cloudflare.com")
|
||||||
assert.Contains(t, domainStrings, "github.com")
|
assert.NotContains(t, domainStrings, "github.com")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -85,6 +85,16 @@ func (m *MockServer) PopulateManagementDomain(mgmtURL *url.URL) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetRouteChecker mock implementation of SetRouteChecker from Server interface
|
||||||
|
func (m *MockServer) SetRouteChecker(func(netip.Addr) bool) {
|
||||||
|
// Mock implementation - no-op
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetFirewall mock implementation of SetFirewall from Server interface
|
||||||
|
func (m *MockServer) SetFirewall(Firewall) {
|
||||||
|
// Mock implementation - no-op
|
||||||
|
}
|
||||||
|
|
||||||
// BeginBatch mock implementation of BeginBatch from Server interface
|
// BeginBatch mock implementation of BeginBatch from Server interface
|
||||||
func (m *MockServer) BeginBatch() {
|
func (m *MockServer) BeginBatch() {
|
||||||
// Mock implementation - no-op
|
// Mock implementation - no-op
|
||||||
|
|||||||
@@ -104,3 +104,23 @@ func (r *responseWriter) TsigTimersOnly(bool) {
|
|||||||
// After a call to Hijack(), the DNS package will not do anything with the connection.
|
// After a call to Hijack(), the DNS package will not do anything with the connection.
|
||||||
func (r *responseWriter) Hijack() {
|
func (r *responseWriter) Hijack() {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// remoteAddrFromPacket extracts the source IP:port from a decoded packet for logging.
|
||||||
|
func remoteAddrFromPacket(packet gopacket.Packet) *net.UDPAddr {
|
||||||
|
var srcIP net.IP
|
||||||
|
if ipv4 := packet.Layer(layers.LayerTypeIPv4); ipv4 != nil {
|
||||||
|
srcIP = ipv4.(*layers.IPv4).SrcIP
|
||||||
|
} else if ipv6 := packet.Layer(layers.LayerTypeIPv6); ipv6 != nil {
|
||||||
|
srcIP = ipv6.(*layers.IPv6).SrcIP
|
||||||
|
}
|
||||||
|
|
||||||
|
var srcPort int
|
||||||
|
if udp := packet.Layer(layers.LayerTypeUDP); udp != nil {
|
||||||
|
srcPort = int(udp.(*layers.UDP).SrcPort)
|
||||||
|
}
|
||||||
|
|
||||||
|
if srcIP == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &net.UDPAddr{IP: srcIP, Port: srcPort}
|
||||||
|
}
|
||||||
|
|||||||
@@ -57,6 +57,8 @@ type Server interface {
|
|||||||
ProbeAvailability()
|
ProbeAvailability()
|
||||||
UpdateServerConfig(domains dnsconfig.ServerDomains) error
|
UpdateServerConfig(domains dnsconfig.ServerDomains) error
|
||||||
PopulateManagementDomain(mgmtURL *url.URL) error
|
PopulateManagementDomain(mgmtURL *url.URL) error
|
||||||
|
SetRouteChecker(func(netip.Addr) bool)
|
||||||
|
SetFirewall(Firewall)
|
||||||
}
|
}
|
||||||
|
|
||||||
type nsGroupsByDomain struct {
|
type nsGroupsByDomain struct {
|
||||||
@@ -104,12 +106,17 @@ type DefaultServer struct {
|
|||||||
|
|
||||||
statusRecorder *peer.Status
|
statusRecorder *peer.Status
|
||||||
stateManager *statemanager.Manager
|
stateManager *statemanager.Manager
|
||||||
|
routeMatch func(netip.Addr) bool
|
||||||
|
|
||||||
|
probeMu sync.Mutex
|
||||||
|
probeCancel context.CancelFunc
|
||||||
|
probeWg sync.WaitGroup
|
||||||
}
|
}
|
||||||
|
|
||||||
type handlerWithStop interface {
|
type handlerWithStop interface {
|
||||||
dns.Handler
|
dns.Handler
|
||||||
Stop()
|
Stop()
|
||||||
ProbeAvailability()
|
ProbeAvailability(context.Context)
|
||||||
ID() types.HandlerID
|
ID() types.HandlerID
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -145,7 +152,7 @@ func NewDefaultServer(ctx context.Context, config DefaultServerConfig) (*Default
|
|||||||
if config.WgInterface.IsUserspaceBind() {
|
if config.WgInterface.IsUserspaceBind() {
|
||||||
dnsService = NewServiceViaMemory(config.WgInterface)
|
dnsService = NewServiceViaMemory(config.WgInterface)
|
||||||
} else {
|
} else {
|
||||||
dnsService = newServiceViaListener(config.WgInterface, addrPort)
|
dnsService = newServiceViaListener(config.WgInterface, addrPort, nil)
|
||||||
}
|
}
|
||||||
|
|
||||||
server := newDefaultServer(ctx, config.WgInterface, dnsService, config.StatusRecorder, config.StateManager, config.DisableSys)
|
server := newDefaultServer(ctx, config.WgInterface, dnsService, config.StatusRecorder, config.StateManager, config.DisableSys)
|
||||||
@@ -180,11 +187,16 @@ func NewDefaultServerIos(
|
|||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
wgInterface WGIface,
|
wgInterface WGIface,
|
||||||
iosDnsManager IosDnsManager,
|
iosDnsManager IosDnsManager,
|
||||||
|
hostsDnsList []netip.AddrPort,
|
||||||
statusRecorder *peer.Status,
|
statusRecorder *peer.Status,
|
||||||
disableSys bool,
|
disableSys bool,
|
||||||
) *DefaultServer {
|
) *DefaultServer {
|
||||||
|
log.Debugf("iOS host dns address list is: %v", hostsDnsList)
|
||||||
ds := newDefaultServer(ctx, wgInterface, NewServiceViaMemory(wgInterface), statusRecorder, nil, disableSys)
|
ds := newDefaultServer(ctx, wgInterface, NewServiceViaMemory(wgInterface), statusRecorder, nil, disableSys)
|
||||||
ds.iosDnsManager = iosDnsManager
|
ds.iosDnsManager = iosDnsManager
|
||||||
|
ds.hostsDNSHolder.set(hostsDnsList)
|
||||||
|
ds.permanent = true
|
||||||
|
ds.addHostRootZone()
|
||||||
return ds
|
return ds
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -225,6 +237,14 @@ func newDefaultServer(
|
|||||||
return defaultServer
|
return defaultServer
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetRouteChecker sets the function used by upstream resolvers to determine
|
||||||
|
// whether an IP is routed through the tunnel.
|
||||||
|
func (s *DefaultServer) SetRouteChecker(f func(netip.Addr) bool) {
|
||||||
|
s.mux.Lock()
|
||||||
|
defer s.mux.Unlock()
|
||||||
|
s.routeMatch = f
|
||||||
|
}
|
||||||
|
|
||||||
// RegisterHandler registers a handler for the given domains with the given priority.
|
// RegisterHandler registers a handler for the given domains with the given priority.
|
||||||
// Any previously registered handler for the same domain and priority will be replaced.
|
// Any previously registered handler for the same domain and priority will be replaced.
|
||||||
func (s *DefaultServer) RegisterHandler(domains domain.List, handler dns.Handler, priority int) {
|
func (s *DefaultServer) RegisterHandler(domains domain.List, handler dns.Handler, priority int) {
|
||||||
@@ -360,9 +380,26 @@ func (s *DefaultServer) DnsIP() netip.Addr {
|
|||||||
return s.service.RuntimeIP()
|
return s.service.RuntimeIP()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetFirewall sets the firewall used for DNS port DNAT rules.
|
||||||
|
// This must be called before Initialize when using the listener-based service,
|
||||||
|
// because the firewall is typically not available at construction time.
|
||||||
|
func (s *DefaultServer) SetFirewall(fw Firewall) {
|
||||||
|
if svc, ok := s.service.(*serviceViaListener); ok {
|
||||||
|
svc.listenerFlagLock.Lock()
|
||||||
|
svc.firewall = fw
|
||||||
|
svc.listenerFlagLock.Unlock()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Stop stops the server
|
// Stop stops the server
|
||||||
func (s *DefaultServer) Stop() {
|
func (s *DefaultServer) Stop() {
|
||||||
|
s.probeMu.Lock()
|
||||||
|
if s.probeCancel != nil {
|
||||||
|
s.probeCancel()
|
||||||
|
}
|
||||||
s.ctxCancel()
|
s.ctxCancel()
|
||||||
|
s.probeMu.Unlock()
|
||||||
|
s.probeWg.Wait()
|
||||||
s.shutdownWg.Wait()
|
s.shutdownWg.Wait()
|
||||||
|
|
||||||
s.mux.Lock()
|
s.mux.Lock()
|
||||||
@@ -375,8 +412,12 @@ func (s *DefaultServer) Stop() {
|
|||||||
maps.Clear(s.extraDomains)
|
maps.Clear(s.extraDomains)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *DefaultServer) disableDNS() error {
|
func (s *DefaultServer) disableDNS() (retErr error) {
|
||||||
defer s.service.Stop()
|
defer func() {
|
||||||
|
if err := s.service.Stop(); err != nil {
|
||||||
|
retErr = errors.Join(retErr, fmt.Errorf("stop DNS service: %w", err))
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
if s.isUsingNoopHostManager() {
|
if s.isUsingNoopHostManager() {
|
||||||
return nil
|
return nil
|
||||||
@@ -479,7 +520,8 @@ func (s *DefaultServer) SearchDomains() []string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ProbeAvailability tests each upstream group's servers for availability
|
// ProbeAvailability tests each upstream group's servers for availability
|
||||||
// and deactivates the group if no server responds
|
// and deactivates the group if no server responds.
|
||||||
|
// If a previous probe is still running, it will be cancelled before starting a new one.
|
||||||
func (s *DefaultServer) ProbeAvailability() {
|
func (s *DefaultServer) ProbeAvailability() {
|
||||||
if val := os.Getenv(envSkipDNSProbe); val != "" {
|
if val := os.Getenv(envSkipDNSProbe); val != "" {
|
||||||
skipProbe, err := strconv.ParseBool(val)
|
skipProbe, err := strconv.ParseBool(val)
|
||||||
@@ -492,15 +534,52 @@ func (s *DefaultServer) ProbeAvailability() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
var wg sync.WaitGroup
|
s.probeMu.Lock()
|
||||||
for _, mux := range s.dnsMuxMap {
|
|
||||||
wg.Add(1)
|
// don't start probes on a stopped server
|
||||||
go func(mux handlerWithStop) {
|
if s.ctx.Err() != nil {
|
||||||
defer wg.Done()
|
s.probeMu.Unlock()
|
||||||
mux.ProbeAvailability()
|
return
|
||||||
}(mux.handler)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// cancel any running probe
|
||||||
|
if s.probeCancel != nil {
|
||||||
|
s.probeCancel()
|
||||||
|
s.probeCancel = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// wait for the previous probe goroutines to finish while holding
|
||||||
|
// the mutex so no other caller can start a new probe concurrently
|
||||||
|
s.probeWg.Wait()
|
||||||
|
|
||||||
|
// start a new probe
|
||||||
|
probeCtx, probeCancel := context.WithCancel(s.ctx)
|
||||||
|
s.probeCancel = probeCancel
|
||||||
|
|
||||||
|
s.probeWg.Add(1)
|
||||||
|
defer s.probeWg.Done()
|
||||||
|
|
||||||
|
// Snapshot handlers under s.mux to avoid racing with updateMux/dnsMuxMap writers.
|
||||||
|
s.mux.Lock()
|
||||||
|
handlers := make([]handlerWithStop, 0, len(s.dnsMuxMap))
|
||||||
|
for _, mux := range s.dnsMuxMap {
|
||||||
|
handlers = append(handlers, mux.handler)
|
||||||
|
}
|
||||||
|
s.mux.Unlock()
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
for _, handler := range handlers {
|
||||||
|
wg.Add(1)
|
||||||
|
go func(h handlerWithStop) {
|
||||||
|
defer wg.Done()
|
||||||
|
h.ProbeAvailability(probeCtx)
|
||||||
|
}(handler)
|
||||||
|
}
|
||||||
|
|
||||||
|
s.probeMu.Unlock()
|
||||||
|
|
||||||
wg.Wait()
|
wg.Wait()
|
||||||
|
probeCancel()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *DefaultServer) UpdateServerConfig(domains dnsconfig.ServerDomains) error {
|
func (s *DefaultServer) UpdateServerConfig(domains dnsconfig.ServerDomains) error {
|
||||||
@@ -695,6 +774,7 @@ func (s *DefaultServer) registerFallback(config HostDNSConfig) {
|
|||||||
log.Errorf("failed to create upstream resolver for original nameservers: %v", err)
|
log.Errorf("failed to create upstream resolver for original nameservers: %v", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
handler.routeMatch = s.routeMatch
|
||||||
|
|
||||||
for _, ns := range originalNameservers {
|
for _, ns := range originalNameservers {
|
||||||
if ns == config.ServerIP {
|
if ns == config.ServerIP {
|
||||||
@@ -804,6 +884,7 @@ func (s *DefaultServer) createHandlersForDomainGroup(domainGroup nsGroupsByDomai
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("create upstream resolver: %v", err)
|
return nil, fmt.Errorf("create upstream resolver: %v", err)
|
||||||
}
|
}
|
||||||
|
handler.routeMatch = s.routeMatch
|
||||||
|
|
||||||
for _, ns := range nsGroup.NameServers {
|
for _, ns := range nsGroup.NameServers {
|
||||||
if ns.NSType != nbdns.UDPNameServerType {
|
if ns.NSType != nbdns.UDPNameServerType {
|
||||||
@@ -988,6 +1069,7 @@ func (s *DefaultServer) addHostRootZone() {
|
|||||||
log.Errorf("unable to create a new upstream resolver, error: %v", err)
|
log.Errorf("unable to create a new upstream resolver, error: %v", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
handler.routeMatch = s.routeMatch
|
||||||
|
|
||||||
handler.upstreamServers = maps.Keys(hostDNSServers)
|
handler.upstreamServers = maps.Keys(hostDNSServers)
|
||||||
handler.deactivate = func(error) {}
|
handler.deactivate = func(error) {}
|
||||||
|
|||||||
@@ -476,8 +476,8 @@ func TestDNSFakeResolverHandleUpdates(t *testing.T) {
|
|||||||
|
|
||||||
packetfilter := pfmock.NewMockPacketFilter(ctrl)
|
packetfilter := pfmock.NewMockPacketFilter(ctrl)
|
||||||
packetfilter.EXPECT().FilterOutbound(gomock.Any(), gomock.Any()).AnyTimes()
|
packetfilter.EXPECT().FilterOutbound(gomock.Any(), gomock.Any()).AnyTimes()
|
||||||
packetfilter.EXPECT().AddUDPPacketHook(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any())
|
packetfilter.EXPECT().SetUDPPacketHook(gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes()
|
||||||
packetfilter.EXPECT().RemovePacketHook(gomock.Any())
|
packetfilter.EXPECT().SetTCPPacketHook(gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes()
|
||||||
|
|
||||||
if err := wgIface.SetFilter(packetfilter); err != nil {
|
if err := wgIface.SetFilter(packetfilter); err != nil {
|
||||||
t.Errorf("set packet filter: %v", err)
|
t.Errorf("set packet filter: %v", err)
|
||||||
@@ -1065,13 +1065,13 @@ type mockHandler struct {
|
|||||||
|
|
||||||
func (m *mockHandler) ServeDNS(dns.ResponseWriter, *dns.Msg) {}
|
func (m *mockHandler) ServeDNS(dns.ResponseWriter, *dns.Msg) {}
|
||||||
func (m *mockHandler) Stop() {}
|
func (m *mockHandler) Stop() {}
|
||||||
func (m *mockHandler) ProbeAvailability() {}
|
func (m *mockHandler) ProbeAvailability(context.Context) {}
|
||||||
func (m *mockHandler) ID() types.HandlerID { return types.HandlerID(m.Id) }
|
func (m *mockHandler) ID() types.HandlerID { return types.HandlerID(m.Id) }
|
||||||
|
|
||||||
type mockService struct{}
|
type mockService struct{}
|
||||||
|
|
||||||
func (m *mockService) Listen() error { return nil }
|
func (m *mockService) Listen() error { return nil }
|
||||||
func (m *mockService) Stop() {}
|
func (m *mockService) Stop() error { return nil }
|
||||||
func (m *mockService) RuntimeIP() netip.Addr { return netip.MustParseAddr("127.0.0.1") }
|
func (m *mockService) RuntimeIP() netip.Addr { return netip.MustParseAddr("127.0.0.1") }
|
||||||
func (m *mockService) RuntimePort() int { return 53 }
|
func (m *mockService) RuntimePort() int { return 53 }
|
||||||
func (m *mockService) RegisterMux(string, dns.Handler) {}
|
func (m *mockService) RegisterMux(string, dns.Handler) {}
|
||||||
|
|||||||
@@ -4,15 +4,25 @@ import (
|
|||||||
"net/netip"
|
"net/netip"
|
||||||
|
|
||||||
"github.com/miekg/dns"
|
"github.com/miekg/dns"
|
||||||
|
|
||||||
|
firewall "github.com/netbirdio/netbird/client/firewall/manager"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
DefaultPort = 53
|
DefaultPort = 53
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Firewall provides DNAT capabilities for DNS port redirection.
|
||||||
|
// This is used when the DNS server cannot bind port 53 directly
|
||||||
|
// and needs firewall rules to redirect traffic.
|
||||||
|
type Firewall interface {
|
||||||
|
AddOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error
|
||||||
|
RemoveOutputDNAT(localAddr netip.Addr, protocol firewall.Protocol, sourcePort, targetPort uint16) error
|
||||||
|
}
|
||||||
|
|
||||||
type service interface {
|
type service interface {
|
||||||
Listen() error
|
Listen() error
|
||||||
Stop()
|
Stop() error
|
||||||
RegisterMux(domain string, handler dns.Handler)
|
RegisterMux(domain string, handler dns.Handler)
|
||||||
DeregisterMux(key string)
|
DeregisterMux(key string)
|
||||||
RuntimePort() int
|
RuntimePort() int
|
||||||
|
|||||||
@@ -6,12 +6,17 @@ import (
|
|||||||
"net"
|
"net"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"runtime"
|
"runtime"
|
||||||
|
"strconv"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/hashicorp/go-multierror"
|
||||||
"github.com/miekg/dns"
|
"github.com/miekg/dns"
|
||||||
log "github.com/sirupsen/logrus"
|
log "github.com/sirupsen/logrus"
|
||||||
|
|
||||||
|
nberrors "github.com/netbirdio/netbird/client/errors"
|
||||||
|
|
||||||
|
firewall "github.com/netbirdio/netbird/client/firewall/manager"
|
||||||
"github.com/netbirdio/netbird/client/internal/ebpf"
|
"github.com/netbirdio/netbird/client/internal/ebpf"
|
||||||
ebpfMgr "github.com/netbirdio/netbird/client/internal/ebpf/manager"
|
ebpfMgr "github.com/netbirdio/netbird/client/internal/ebpf/manager"
|
||||||
)
|
)
|
||||||
@@ -30,25 +35,33 @@ type serviceViaListener struct {
|
|||||||
dnsMux *dns.ServeMux
|
dnsMux *dns.ServeMux
|
||||||
customAddr *netip.AddrPort
|
customAddr *netip.AddrPort
|
||||||
server *dns.Server
|
server *dns.Server
|
||||||
|
tcpServer *dns.Server
|
||||||
listenIP netip.Addr
|
listenIP netip.Addr
|
||||||
listenPort uint16
|
listenPort uint16
|
||||||
listenerIsRunning bool
|
listenerIsRunning bool
|
||||||
listenerFlagLock sync.Mutex
|
listenerFlagLock sync.Mutex
|
||||||
ebpfService ebpfMgr.Manager
|
ebpfService ebpfMgr.Manager
|
||||||
|
firewall Firewall
|
||||||
|
tcpDNATConfigured bool
|
||||||
}
|
}
|
||||||
|
|
||||||
func newServiceViaListener(wgIface WGIface, customAddr *netip.AddrPort) *serviceViaListener {
|
func newServiceViaListener(wgIface WGIface, customAddr *netip.AddrPort, fw Firewall) *serviceViaListener {
|
||||||
mux := dns.NewServeMux()
|
mux := dns.NewServeMux()
|
||||||
|
|
||||||
s := &serviceViaListener{
|
s := &serviceViaListener{
|
||||||
wgInterface: wgIface,
|
wgInterface: wgIface,
|
||||||
dnsMux: mux,
|
dnsMux: mux,
|
||||||
customAddr: customAddr,
|
customAddr: customAddr,
|
||||||
|
firewall: fw,
|
||||||
server: &dns.Server{
|
server: &dns.Server{
|
||||||
Net: "udp",
|
Net: "udp",
|
||||||
Handler: mux,
|
Handler: mux,
|
||||||
UDPSize: 65535,
|
UDPSize: 65535,
|
||||||
},
|
},
|
||||||
|
tcpServer: &dns.Server{
|
||||||
|
Net: "tcp",
|
||||||
|
Handler: mux,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
return s
|
return s
|
||||||
@@ -69,43 +82,86 @@ func (s *serviceViaListener) Listen() error {
|
|||||||
return fmt.Errorf("eval listen address: %w", err)
|
return fmt.Errorf("eval listen address: %w", err)
|
||||||
}
|
}
|
||||||
s.listenIP = s.listenIP.Unmap()
|
s.listenIP = s.listenIP.Unmap()
|
||||||
s.server.Addr = fmt.Sprintf("%s:%d", s.listenIP, s.listenPort)
|
addr := net.JoinHostPort(s.listenIP.String(), strconv.Itoa(int(s.listenPort)))
|
||||||
log.Debugf("starting dns on %s", s.server.Addr)
|
s.server.Addr = addr
|
||||||
go func() {
|
s.tcpServer.Addr = addr
|
||||||
s.setListenerStatus(true)
|
|
||||||
defer s.setListenerStatus(false)
|
|
||||||
|
|
||||||
err := s.server.ListenAndServe()
|
log.Debugf("starting dns on %s (UDP + TCP)", addr)
|
||||||
if err != nil {
|
s.listenerIsRunning = true
|
||||||
log.Errorf("dns server running with %d port returned an error: %v. Will not retry", s.listenPort, err)
|
|
||||||
|
go func() {
|
||||||
|
if err := s.server.ListenAndServe(); err != nil {
|
||||||
|
log.Errorf("failed to run DNS UDP server on port %d: %v", s.listenPort, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
s.listenerFlagLock.Lock()
|
||||||
|
unexpected := s.listenerIsRunning
|
||||||
|
s.listenerIsRunning = false
|
||||||
|
s.listenerFlagLock.Unlock()
|
||||||
|
|
||||||
|
if unexpected {
|
||||||
|
if err := s.tcpServer.Shutdown(); err != nil {
|
||||||
|
log.Debugf("failed to shutdown DNS TCP server: %v", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
if err := s.tcpServer.ListenAndServe(); err != nil {
|
||||||
|
log.Errorf("failed to run DNS TCP server on port %d: %v", s.listenPort, err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
// When eBPF redirects UDP port 53 to our listen port, TCP still needs
|
||||||
|
// a DNAT rule because eBPF only handles UDP.
|
||||||
|
if s.ebpfService != nil && s.firewall != nil && s.listenPort != DefaultPort {
|
||||||
|
if err := s.firewall.AddOutputDNAT(s.listenIP, firewall.ProtocolTCP, DefaultPort, s.listenPort); err != nil {
|
||||||
|
log.Warnf("failed to add DNS TCP DNAT rule, TCP DNS on port 53 will not work: %v", err)
|
||||||
|
} else {
|
||||||
|
s.tcpDNATConfigured = true
|
||||||
|
log.Infof("added DNS TCP DNAT rule: %s:%d -> %s:%d", s.listenIP, DefaultPort, s.listenIP, s.listenPort)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *serviceViaListener) Stop() {
|
func (s *serviceViaListener) Stop() error {
|
||||||
s.listenerFlagLock.Lock()
|
s.listenerFlagLock.Lock()
|
||||||
defer s.listenerFlagLock.Unlock()
|
defer s.listenerFlagLock.Unlock()
|
||||||
|
|
||||||
if !s.listenerIsRunning {
|
if !s.listenerIsRunning {
|
||||||
return
|
return nil
|
||||||
}
|
}
|
||||||
|
s.listenerIsRunning = false
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
err := s.server.ShutdownContext(ctx)
|
var merr *multierror.Error
|
||||||
if err != nil {
|
|
||||||
log.Errorf("stopping dns server listener returned an error: %v", err)
|
if err := s.server.ShutdownContext(ctx); err != nil {
|
||||||
|
merr = multierror.Append(merr, fmt.Errorf("stop DNS UDP server: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := s.tcpServer.ShutdownContext(ctx); err != nil {
|
||||||
|
merr = multierror.Append(merr, fmt.Errorf("stop DNS TCP server: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
if s.tcpDNATConfigured && s.firewall != nil {
|
||||||
|
if err := s.firewall.RemoveOutputDNAT(s.listenIP, firewall.ProtocolTCP, DefaultPort, s.listenPort); err != nil {
|
||||||
|
merr = multierror.Append(merr, fmt.Errorf("remove DNS TCP DNAT rule: %w", err))
|
||||||
|
}
|
||||||
|
s.tcpDNATConfigured = false
|
||||||
}
|
}
|
||||||
|
|
||||||
if s.ebpfService != nil {
|
if s.ebpfService != nil {
|
||||||
err = s.ebpfService.FreeDNSFwd()
|
if err := s.ebpfService.FreeDNSFwd(); err != nil {
|
||||||
if err != nil {
|
merr = multierror.Append(merr, fmt.Errorf("stop traffic forwarder: %w", err))
|
||||||
log.Errorf("stopping traffic forwarder returned an error: %v", err)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return nberrors.FormatErrorOrNil(merr)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *serviceViaListener) RegisterMux(pattern string, handler dns.Handler) {
|
func (s *serviceViaListener) RegisterMux(pattern string, handler dns.Handler) {
|
||||||
@@ -132,12 +188,6 @@ func (s *serviceViaListener) RuntimeIP() netip.Addr {
|
|||||||
return s.listenIP
|
return s.listenIP
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *serviceViaListener) setListenerStatus(running bool) {
|
|
||||||
s.listenerFlagLock.Lock()
|
|
||||||
defer s.listenerFlagLock.Unlock()
|
|
||||||
|
|
||||||
s.listenerIsRunning = running
|
|
||||||
}
|
|
||||||
|
|
||||||
// evalListenAddress figure out the listen address for the DNS server
|
// evalListenAddress figure out the listen address for the DNS server
|
||||||
// first check the 53 port availability on WG interface or lo, if not success
|
// first check the 53 port availability on WG interface or lo, if not success
|
||||||
@@ -186,18 +236,28 @@ func (s *serviceViaListener) testFreePort(port int) (netip.Addr, bool) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *serviceViaListener) tryToBind(ip netip.Addr, port int) bool {
|
func (s *serviceViaListener) tryToBind(ip netip.Addr, port int) bool {
|
||||||
addrString := fmt.Sprintf("%s:%d", ip, port)
|
addrPort := netip.AddrPortFrom(ip, uint16(port))
|
||||||
udpAddr := net.UDPAddrFromAddrPort(netip.MustParseAddrPort(addrString))
|
|
||||||
probeListener, err := net.ListenUDP("udp", udpAddr)
|
udpAddr := net.UDPAddrFromAddrPort(addrPort)
|
||||||
|
udpLn, err := net.ListenUDP("udp", udpAddr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Warnf("binding dns on %s is not available, error: %s", addrString, err)
|
log.Warnf("binding dns UDP on %s is not available: %s", addrPort, err)
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
if err := udpLn.Close(); err != nil {
|
||||||
err = probeListener.Close()
|
log.Debugf("close UDP probe listener: %s", err)
|
||||||
if err != nil {
|
|
||||||
log.Errorf("got an error closing the probe listener, error: %s", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
tcpAddr := net.TCPAddrFromAddrPort(addrPort)
|
||||||
|
tcpLn, err := net.ListenTCP("tcp", tcpAddr)
|
||||||
|
if err != nil {
|
||||||
|
log.Warnf("binding dns TCP on %s is not available: %s", addrPort, err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if err := tcpLn.Close(); err != nil {
|
||||||
|
log.Debugf("close TCP probe listener: %s", err)
|
||||||
|
}
|
||||||
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
86
client/internal/dns/service_listener_test.go
Normal file
86
client/internal/dns/service_listener_test.go
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
package dns
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"net/netip"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/miekg/dns"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestServiceViaListener_TCPAndUDP(t *testing.T) {
|
||||||
|
handler := dns.HandlerFunc(func(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
m.Answer = append(m.Answer, &dns.A{
|
||||||
|
Hdr: dns.RR_Header{Name: r.Question[0].Name, Rrtype: dns.TypeA, Class: dns.ClassINET, Ttl: 60},
|
||||||
|
A: net.ParseIP("192.0.2.1"),
|
||||||
|
})
|
||||||
|
if err := w.WriteMsg(m); err != nil {
|
||||||
|
t.Logf("write msg: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// Create a service using a custom address to avoid needing root
|
||||||
|
svc := newServiceViaListener(nil, nil, nil)
|
||||||
|
svc.dnsMux.Handle(".", handler)
|
||||||
|
|
||||||
|
// Bind both transports up front to avoid TOCTOU races.
|
||||||
|
udpAddr := net.UDPAddrFromAddrPort(netip.AddrPortFrom(customIP, 0))
|
||||||
|
udpConn, err := net.ListenUDP("udp", udpAddr)
|
||||||
|
if err != nil {
|
||||||
|
t.Skip("cannot bind to 127.0.0.153, skipping")
|
||||||
|
}
|
||||||
|
port := uint16(udpConn.LocalAddr().(*net.UDPAddr).Port)
|
||||||
|
|
||||||
|
tcpAddr := net.TCPAddrFromAddrPort(netip.AddrPortFrom(customIP, port))
|
||||||
|
tcpLn, err := net.ListenTCP("tcp", tcpAddr)
|
||||||
|
if err != nil {
|
||||||
|
udpConn.Close()
|
||||||
|
t.Skip("cannot bind TCP on same port, skipping")
|
||||||
|
}
|
||||||
|
|
||||||
|
addr := fmt.Sprintf("%s:%d", customIP, port)
|
||||||
|
svc.server.PacketConn = udpConn
|
||||||
|
svc.tcpServer.Listener = tcpLn
|
||||||
|
svc.listenIP = customIP
|
||||||
|
svc.listenPort = port
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
if err := svc.server.ActivateAndServe(); err != nil {
|
||||||
|
t.Logf("udp server: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
go func() {
|
||||||
|
if err := svc.tcpServer.ActivateAndServe(); err != nil {
|
||||||
|
t.Logf("tcp server: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
svc.listenerIsRunning = true
|
||||||
|
|
||||||
|
defer func() {
|
||||||
|
require.NoError(t, svc.Stop())
|
||||||
|
}()
|
||||||
|
|
||||||
|
q := new(dns.Msg).SetQuestion("example.com.", dns.TypeA)
|
||||||
|
|
||||||
|
// Test UDP query
|
||||||
|
udpClient := &dns.Client{Net: "udp", Timeout: 2 * time.Second}
|
||||||
|
udpResp, _, err := udpClient.Exchange(q, addr)
|
||||||
|
require.NoError(t, err, "UDP query should succeed")
|
||||||
|
require.NotNil(t, udpResp)
|
||||||
|
require.NotEmpty(t, udpResp.Answer)
|
||||||
|
assert.Contains(t, udpResp.Answer[0].String(), "192.0.2.1", "UDP response should contain expected IP")
|
||||||
|
|
||||||
|
// Test TCP query
|
||||||
|
tcpClient := &dns.Client{Net: "tcp", Timeout: 2 * time.Second}
|
||||||
|
tcpResp, _, err := tcpClient.Exchange(q, addr)
|
||||||
|
require.NoError(t, err, "TCP query should succeed")
|
||||||
|
require.NotNil(t, tcpResp)
|
||||||
|
require.NotEmpty(t, tcpResp.Answer)
|
||||||
|
assert.Contains(t, tcpResp.Answer[0].String(), "192.0.2.1", "TCP response should contain expected IP")
|
||||||
|
}
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
package dns
|
package dns
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"sync"
|
"sync"
|
||||||
@@ -10,6 +11,7 @@ import (
|
|||||||
"github.com/miekg/dns"
|
"github.com/miekg/dns"
|
||||||
log "github.com/sirupsen/logrus"
|
log "github.com/sirupsen/logrus"
|
||||||
|
|
||||||
|
"github.com/netbirdio/netbird/client/iface"
|
||||||
nbnet "github.com/netbirdio/netbird/client/net"
|
nbnet "github.com/netbirdio/netbird/client/net"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -18,7 +20,8 @@ type ServiceViaMemory struct {
|
|||||||
dnsMux *dns.ServeMux
|
dnsMux *dns.ServeMux
|
||||||
runtimeIP netip.Addr
|
runtimeIP netip.Addr
|
||||||
runtimePort int
|
runtimePort int
|
||||||
udpFilterHookID string
|
tcpDNS *tcpDNSServer
|
||||||
|
tcpHookSet bool
|
||||||
listenerIsRunning bool
|
listenerIsRunning bool
|
||||||
listenerFlagLock sync.Mutex
|
listenerFlagLock sync.Mutex
|
||||||
}
|
}
|
||||||
@@ -28,14 +31,13 @@ func NewServiceViaMemory(wgIface WGIface) *ServiceViaMemory {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
log.Errorf("get last ip from network: %v", err)
|
log.Errorf("get last ip from network: %v", err)
|
||||||
}
|
}
|
||||||
s := &ServiceViaMemory{
|
|
||||||
|
return &ServiceViaMemory{
|
||||||
wgInterface: wgIface,
|
wgInterface: wgIface,
|
||||||
dnsMux: dns.NewServeMux(),
|
dnsMux: dns.NewServeMux(),
|
||||||
|
|
||||||
runtimeIP: lastIP,
|
runtimeIP: lastIP,
|
||||||
runtimePort: DefaultPort,
|
runtimePort: DefaultPort,
|
||||||
}
|
}
|
||||||
return s
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *ServiceViaMemory) Listen() error {
|
func (s *ServiceViaMemory) Listen() error {
|
||||||
@@ -46,10 +48,8 @@ func (s *ServiceViaMemory) Listen() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
var err error
|
if err := s.filterDNSTraffic(); err != nil {
|
||||||
s.udpFilterHookID, err = s.filterDNSTraffic()
|
return fmt.Errorf("filter dns traffic: %w", err)
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("filter dns traffice: %w", err)
|
|
||||||
}
|
}
|
||||||
s.listenerIsRunning = true
|
s.listenerIsRunning = true
|
||||||
|
|
||||||
@@ -57,19 +57,29 @@ func (s *ServiceViaMemory) Listen() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *ServiceViaMemory) Stop() {
|
func (s *ServiceViaMemory) Stop() error {
|
||||||
s.listenerFlagLock.Lock()
|
s.listenerFlagLock.Lock()
|
||||||
defer s.listenerFlagLock.Unlock()
|
defer s.listenerFlagLock.Unlock()
|
||||||
|
|
||||||
if !s.listenerIsRunning {
|
if !s.listenerIsRunning {
|
||||||
return
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := s.wgInterface.GetFilter().RemovePacketHook(s.udpFilterHookID); err != nil {
|
filter := s.wgInterface.GetFilter()
|
||||||
log.Errorf("unable to remove DNS packet hook: %s", err)
|
if filter != nil {
|
||||||
|
filter.SetUDPPacketHook(s.runtimeIP, uint16(s.runtimePort), nil)
|
||||||
|
if s.tcpHookSet {
|
||||||
|
filter.SetTCPPacketHook(s.runtimeIP, uint16(s.runtimePort), nil)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if s.tcpDNS != nil {
|
||||||
|
s.tcpDNS.Stop()
|
||||||
}
|
}
|
||||||
|
|
||||||
s.listenerIsRunning = false
|
s.listenerIsRunning = false
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *ServiceViaMemory) RegisterMux(pattern string, handler dns.Handler) {
|
func (s *ServiceViaMemory) RegisterMux(pattern string, handler dns.Handler) {
|
||||||
@@ -88,10 +98,18 @@ func (s *ServiceViaMemory) RuntimeIP() netip.Addr {
|
|||||||
return s.runtimeIP
|
return s.runtimeIP
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *ServiceViaMemory) filterDNSTraffic() (string, error) {
|
func (s *ServiceViaMemory) filterDNSTraffic() error {
|
||||||
filter := s.wgInterface.GetFilter()
|
filter := s.wgInterface.GetFilter()
|
||||||
if filter == nil {
|
if filter == nil {
|
||||||
return "", fmt.Errorf("can't set DNS filter, filter not initialized")
|
return errors.New("DNS filter not initialized")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create TCP DNS server lazily here since the device may not exist at construction time.
|
||||||
|
if s.tcpDNS == nil {
|
||||||
|
if dev := s.wgInterface.GetDevice(); dev != nil {
|
||||||
|
// MTU only affects TCP segment sizing; DNS messages are small so this has no practical impact.
|
||||||
|
s.tcpDNS = newTCPDNSServer(s.dnsMux, dev.Device, s.runtimeIP, uint16(s.runtimePort), iface.DefaultMTU)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
firstLayerDecoder := layers.LayerTypeIPv4
|
firstLayerDecoder := layers.LayerTypeIPv4
|
||||||
@@ -100,12 +118,16 @@ func (s *ServiceViaMemory) filterDNSTraffic() (string, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
hook := func(packetData []byte) bool {
|
hook := func(packetData []byte) bool {
|
||||||
// Decode the packet
|
|
||||||
packet := gopacket.NewPacket(packetData, firstLayerDecoder, gopacket.Default)
|
packet := gopacket.NewPacket(packetData, firstLayerDecoder, gopacket.Default)
|
||||||
|
|
||||||
// Get the UDP layer
|
|
||||||
udpLayer := packet.Layer(layers.LayerTypeUDP)
|
udpLayer := packet.Layer(layers.LayerTypeUDP)
|
||||||
udp := udpLayer.(*layers.UDP)
|
if udpLayer == nil {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
udp, ok := udpLayer.(*layers.UDP)
|
||||||
|
if !ok {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
msg := new(dns.Msg)
|
msg := new(dns.Msg)
|
||||||
if err := msg.Unpack(udp.Payload); err != nil {
|
if err := msg.Unpack(udp.Payload); err != nil {
|
||||||
@@ -113,13 +135,30 @@ func (s *ServiceViaMemory) filterDNSTraffic() (string, error) {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
writer := responseWriter{
|
dev := s.wgInterface.GetDevice()
|
||||||
packet: packet,
|
if dev == nil {
|
||||||
device: s.wgInterface.GetDevice().Device,
|
return true
|
||||||
}
|
}
|
||||||
go s.dnsMux.ServeDNS(&writer, msg)
|
|
||||||
|
writer := &responseWriter{
|
||||||
|
remote: remoteAddrFromPacket(packet),
|
||||||
|
packet: packet,
|
||||||
|
device: dev.Device,
|
||||||
|
}
|
||||||
|
go s.dnsMux.ServeDNS(writer, msg)
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
return filter.AddUDPPacketHook(false, s.runtimeIP, uint16(s.runtimePort), hook), nil
|
filter.SetUDPPacketHook(s.runtimeIP, uint16(s.runtimePort), hook)
|
||||||
|
|
||||||
|
if s.tcpDNS != nil {
|
||||||
|
tcpHook := func(packetData []byte) bool {
|
||||||
|
s.tcpDNS.InjectPacket(packetData)
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
filter.SetTCPPacketHook(s.runtimeIP, uint16(s.runtimePort), tcpHook)
|
||||||
|
s.tcpHookSet = true
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
444
client/internal/dns/tcpstack.go
Normal file
444
client/internal/dns/tcpstack.go
Normal file
@@ -0,0 +1,444 @@
|
|||||||
|
package dns
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net"
|
||||||
|
"net/netip"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/miekg/dns"
|
||||||
|
log "github.com/sirupsen/logrus"
|
||||||
|
"golang.zx2c4.com/wireguard/tun"
|
||||||
|
"gvisor.dev/gvisor/pkg/buffer"
|
||||||
|
"gvisor.dev/gvisor/pkg/tcpip"
|
||||||
|
"gvisor.dev/gvisor/pkg/tcpip/adapters/gonet"
|
||||||
|
"gvisor.dev/gvisor/pkg/tcpip/header"
|
||||||
|
"gvisor.dev/gvisor/pkg/tcpip/network/ipv4"
|
||||||
|
"gvisor.dev/gvisor/pkg/tcpip/stack"
|
||||||
|
"gvisor.dev/gvisor/pkg/tcpip/transport/tcp"
|
||||||
|
"gvisor.dev/gvisor/pkg/waiter"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
dnsTCPReceiveWindow = 8192
|
||||||
|
dnsTCPMaxInFlight = 16
|
||||||
|
dnsTCPIdleTimeout = 30 * time.Second
|
||||||
|
dnsTCPReadTimeout = 5 * time.Second
|
||||||
|
)
|
||||||
|
|
||||||
|
// tcpDNSServer is an on-demand TCP DNS server backed by a minimal gvisor stack.
|
||||||
|
// It is started lazily when a truncated DNS response is detected and shuts down
|
||||||
|
// after a period of inactivity to conserve resources.
|
||||||
|
type tcpDNSServer struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
s *stack.Stack
|
||||||
|
ep *dnsEndpoint
|
||||||
|
mux *dns.ServeMux
|
||||||
|
tunDev tun.Device
|
||||||
|
ip netip.Addr
|
||||||
|
port uint16
|
||||||
|
mtu uint16
|
||||||
|
|
||||||
|
running bool
|
||||||
|
closed bool
|
||||||
|
timerID uint64
|
||||||
|
timer *time.Timer
|
||||||
|
}
|
||||||
|
|
||||||
|
func newTCPDNSServer(mux *dns.ServeMux, tunDev tun.Device, ip netip.Addr, port uint16, mtu uint16) *tcpDNSServer {
|
||||||
|
return &tcpDNSServer{
|
||||||
|
mux: mux,
|
||||||
|
tunDev: tunDev,
|
||||||
|
ip: ip,
|
||||||
|
port: port,
|
||||||
|
mtu: mtu,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// InjectPacket ensures the stack is running and delivers a raw IP packet into
|
||||||
|
// the gvisor stack for TCP processing. Combining both operations under a single
|
||||||
|
// lock prevents a race where the idle timer could stop the stack between
|
||||||
|
// start and delivery.
|
||||||
|
func (t *tcpDNSServer) InjectPacket(payload []byte) {
|
||||||
|
t.mu.Lock()
|
||||||
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
|
if t.closed {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if !t.running {
|
||||||
|
if err := t.startLocked(); err != nil {
|
||||||
|
log.Errorf("failed to start TCP DNS stack: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
t.running = true
|
||||||
|
log.Debugf("TCP DNS stack started on %s:%d (triggered by %s)", t.ip, t.port, srcAddrFromPacket(payload))
|
||||||
|
}
|
||||||
|
t.resetTimerLocked()
|
||||||
|
|
||||||
|
ep := t.ep
|
||||||
|
if ep == nil || ep.dispatcher == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
pkt := stack.NewPacketBuffer(stack.PacketBufferOptions{
|
||||||
|
Payload: buffer.MakeWithData(payload),
|
||||||
|
})
|
||||||
|
// DeliverNetworkPacket takes ownership of the packet buffer; do not DecRef.
|
||||||
|
ep.dispatcher.DeliverNetworkPacket(ipv4.ProtocolNumber, pkt)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stop tears down the gvisor stack and releases resources permanently.
|
||||||
|
// After Stop, InjectPacket becomes a no-op.
|
||||||
|
func (t *tcpDNSServer) Stop() {
|
||||||
|
t.mu.Lock()
|
||||||
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
|
t.stopLocked()
|
||||||
|
t.closed = true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *tcpDNSServer) startLocked() error {
|
||||||
|
// TODO: add ipv6.NewProtocol when IPv6 overlay support lands.
|
||||||
|
s := stack.New(stack.Options{
|
||||||
|
NetworkProtocols: []stack.NetworkProtocolFactory{ipv4.NewProtocol},
|
||||||
|
TransportProtocols: []stack.TransportProtocolFactory{tcp.NewProtocol},
|
||||||
|
HandleLocal: false,
|
||||||
|
})
|
||||||
|
|
||||||
|
nicID := tcpip.NICID(1)
|
||||||
|
ep := &dnsEndpoint{
|
||||||
|
tunDev: t.tunDev,
|
||||||
|
}
|
||||||
|
ep.mtu.Store(uint32(t.mtu))
|
||||||
|
|
||||||
|
if err := s.CreateNIC(nicID, ep); err != nil {
|
||||||
|
s.Close()
|
||||||
|
s.Wait()
|
||||||
|
return fmt.Errorf("create NIC: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
protoAddr := tcpip.ProtocolAddress{
|
||||||
|
Protocol: ipv4.ProtocolNumber,
|
||||||
|
AddressWithPrefix: tcpip.AddressWithPrefix{
|
||||||
|
Address: tcpip.AddrFromSlice(t.ip.AsSlice()),
|
||||||
|
PrefixLen: 32,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
if err := s.AddProtocolAddress(nicID, protoAddr, stack.AddressProperties{}); err != nil {
|
||||||
|
s.Close()
|
||||||
|
s.Wait()
|
||||||
|
return fmt.Errorf("add protocol address: %s", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := s.SetPromiscuousMode(nicID, true); err != nil {
|
||||||
|
s.Close()
|
||||||
|
s.Wait()
|
||||||
|
return fmt.Errorf("set promiscuous mode: %s", err)
|
||||||
|
}
|
||||||
|
if err := s.SetSpoofing(nicID, true); err != nil {
|
||||||
|
s.Close()
|
||||||
|
s.Wait()
|
||||||
|
return fmt.Errorf("set spoofing: %s", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
defaultSubnet, err := tcpip.NewSubnet(
|
||||||
|
tcpip.AddrFrom4([4]byte{0, 0, 0, 0}),
|
||||||
|
tcpip.MaskFromBytes([]byte{0, 0, 0, 0}),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
s.Close()
|
||||||
|
s.Wait()
|
||||||
|
return fmt.Errorf("create default subnet: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
s.SetRouteTable([]tcpip.Route{
|
||||||
|
{Destination: defaultSubnet, NIC: nicID},
|
||||||
|
})
|
||||||
|
|
||||||
|
tcpFwd := tcp.NewForwarder(s, dnsTCPReceiveWindow, dnsTCPMaxInFlight, func(r *tcp.ForwarderRequest) {
|
||||||
|
t.handleTCPDNS(r)
|
||||||
|
})
|
||||||
|
s.SetTransportProtocolHandler(tcp.ProtocolNumber, tcpFwd.HandlePacket)
|
||||||
|
|
||||||
|
t.s = s
|
||||||
|
t.ep = ep
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *tcpDNSServer) stopLocked() {
|
||||||
|
if !t.running {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if t.timer != nil {
|
||||||
|
t.timer.Stop()
|
||||||
|
t.timer = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if t.s != nil {
|
||||||
|
t.s.Close()
|
||||||
|
t.s.Wait()
|
||||||
|
t.s = nil
|
||||||
|
}
|
||||||
|
t.ep = nil
|
||||||
|
t.running = false
|
||||||
|
|
||||||
|
log.Debugf("TCP DNS stack stopped")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *tcpDNSServer) resetTimerLocked() {
|
||||||
|
if t.timer != nil {
|
||||||
|
t.timer.Stop()
|
||||||
|
}
|
||||||
|
t.timerID++
|
||||||
|
id := t.timerID
|
||||||
|
t.timer = time.AfterFunc(dnsTCPIdleTimeout, func() {
|
||||||
|
t.mu.Lock()
|
||||||
|
defer t.mu.Unlock()
|
||||||
|
|
||||||
|
// Only stop if this timer is still the active one.
|
||||||
|
// A racing InjectPacket may have replaced it.
|
||||||
|
if t.timerID != id {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
t.stopLocked()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *tcpDNSServer) handleTCPDNS(r *tcp.ForwarderRequest) {
|
||||||
|
id := r.ID()
|
||||||
|
|
||||||
|
wq := waiter.Queue{}
|
||||||
|
ep, epErr := r.CreateEndpoint(&wq)
|
||||||
|
if epErr != nil {
|
||||||
|
log.Debugf("TCP DNS: failed to create endpoint: %v", epErr)
|
||||||
|
r.Complete(true)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
r.Complete(false)
|
||||||
|
|
||||||
|
conn := gonet.NewTCPConn(&wq, ep)
|
||||||
|
defer func() {
|
||||||
|
if err := conn.Close(); err != nil {
|
||||||
|
log.Tracef("TCP DNS: close conn: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
// Reset idle timer on activity
|
||||||
|
t.mu.Lock()
|
||||||
|
t.resetTimerLocked()
|
||||||
|
t.mu.Unlock()
|
||||||
|
|
||||||
|
localAddr := &net.TCPAddr{
|
||||||
|
IP: id.LocalAddress.AsSlice(),
|
||||||
|
Port: int(id.LocalPort),
|
||||||
|
}
|
||||||
|
remoteAddr := &net.TCPAddr{
|
||||||
|
IP: id.RemoteAddress.AsSlice(),
|
||||||
|
Port: int(id.RemotePort),
|
||||||
|
}
|
||||||
|
|
||||||
|
for {
|
||||||
|
if err := conn.SetReadDeadline(time.Now().Add(dnsTCPReadTimeout)); err != nil {
|
||||||
|
log.Debugf("TCP DNS: set deadline for %s: %v", remoteAddr, err)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
msg, err := readTCPDNSMessage(conn)
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, io.EOF) && !errors.Is(err, io.ErrUnexpectedEOF) {
|
||||||
|
log.Debugf("TCP DNS: read from %s: %v", remoteAddr, err)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
writer := &tcpResponseWriter{
|
||||||
|
conn: conn,
|
||||||
|
localAddr: localAddr,
|
||||||
|
remoteAddr: remoteAddr,
|
||||||
|
}
|
||||||
|
t.mux.ServeDNS(writer, msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// dnsEndpoint implements stack.LinkEndpoint for writing packets back via the tun device.
|
||||||
|
type dnsEndpoint struct {
|
||||||
|
dispatcher stack.NetworkDispatcher
|
||||||
|
tunDev tun.Device
|
||||||
|
mtu atomic.Uint32
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *dnsEndpoint) Attach(dispatcher stack.NetworkDispatcher) { e.dispatcher = dispatcher }
|
||||||
|
func (e *dnsEndpoint) IsAttached() bool { return e.dispatcher != nil }
|
||||||
|
func (e *dnsEndpoint) MTU() uint32 { return e.mtu.Load() }
|
||||||
|
func (e *dnsEndpoint) Capabilities() stack.LinkEndpointCapabilities { return stack.CapabilityNone }
|
||||||
|
func (e *dnsEndpoint) MaxHeaderLength() uint16 { return 0 }
|
||||||
|
func (e *dnsEndpoint) LinkAddress() tcpip.LinkAddress { return "" }
|
||||||
|
func (e *dnsEndpoint) Wait() { /* no async work */ }
|
||||||
|
func (e *dnsEndpoint) ARPHardwareType() header.ARPHardwareType { return header.ARPHardwareNone }
|
||||||
|
func (e *dnsEndpoint) AddHeader(*stack.PacketBuffer) { /* IP-level endpoint, no link header */ }
|
||||||
|
func (e *dnsEndpoint) ParseHeader(*stack.PacketBuffer) bool { return true }
|
||||||
|
func (e *dnsEndpoint) Close() { /* lifecycle managed by tcpDNSServer */ }
|
||||||
|
func (e *dnsEndpoint) SetLinkAddress(tcpip.LinkAddress) { /* no link address for tun */ }
|
||||||
|
func (e *dnsEndpoint) SetMTU(mtu uint32) { e.mtu.Store(mtu) }
|
||||||
|
func (e *dnsEndpoint) SetOnCloseAction(func()) { /* not needed */ }
|
||||||
|
|
||||||
|
const tunPacketOffset = 40
|
||||||
|
|
||||||
|
func (e *dnsEndpoint) WritePackets(pkts stack.PacketBufferList) (int, tcpip.Error) {
|
||||||
|
var written int
|
||||||
|
for _, pkt := range pkts.AsSlice() {
|
||||||
|
data := stack.PayloadSince(pkt.NetworkHeader())
|
||||||
|
if data == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
raw := data.AsSlice()
|
||||||
|
buf := make([]byte, tunPacketOffset, tunPacketOffset+len(raw))
|
||||||
|
buf = append(buf, raw...)
|
||||||
|
data.Release()
|
||||||
|
|
||||||
|
if _, err := e.tunDev.Write([][]byte{buf}, tunPacketOffset); err != nil {
|
||||||
|
log.Tracef("TCP DNS endpoint: failed to write packet: %v", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
written++
|
||||||
|
}
|
||||||
|
return written, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// tcpResponseWriter implements dns.ResponseWriter for TCP DNS connections.
|
||||||
|
type tcpResponseWriter struct {
|
||||||
|
conn *gonet.TCPConn
|
||||||
|
localAddr net.Addr
|
||||||
|
remoteAddr net.Addr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *tcpResponseWriter) LocalAddr() net.Addr {
|
||||||
|
return w.localAddr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *tcpResponseWriter) RemoteAddr() net.Addr {
|
||||||
|
return w.remoteAddr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *tcpResponseWriter) WriteMsg(msg *dns.Msg) error {
|
||||||
|
data, err := msg.Pack()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("pack: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DNS TCP: 2-byte length prefix + message
|
||||||
|
buf := make([]byte, 2+len(data))
|
||||||
|
buf[0] = byte(len(data) >> 8)
|
||||||
|
buf[1] = byte(len(data))
|
||||||
|
copy(buf[2:], data)
|
||||||
|
|
||||||
|
if _, err = w.conn.Write(buf); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *tcpResponseWriter) Write(data []byte) (int, error) {
|
||||||
|
buf := make([]byte, 2+len(data))
|
||||||
|
buf[0] = byte(len(data) >> 8)
|
||||||
|
buf[1] = byte(len(data))
|
||||||
|
copy(buf[2:], data)
|
||||||
|
if _, err := w.conn.Write(buf); err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return len(data), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *tcpResponseWriter) Close() error {
|
||||||
|
return w.conn.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *tcpResponseWriter) TsigStatus() error { return nil }
|
||||||
|
func (w *tcpResponseWriter) TsigTimersOnly(bool) { /* TSIG not supported */ }
|
||||||
|
func (w *tcpResponseWriter) Hijack() { /* not supported */ }
|
||||||
|
|
||||||
|
// readTCPDNSMessage reads a single DNS message from a TCP connection (length-prefixed).
|
||||||
|
func readTCPDNSMessage(conn *gonet.TCPConn) (*dns.Msg, error) {
|
||||||
|
// DNS over TCP uses a 2-byte length prefix
|
||||||
|
lenBuf := make([]byte, 2)
|
||||||
|
if _, err := io.ReadFull(conn, lenBuf); err != nil {
|
||||||
|
return nil, fmt.Errorf("read length: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
msgLen := int(lenBuf[0])<<8 | int(lenBuf[1])
|
||||||
|
if msgLen == 0 || msgLen > 65535 {
|
||||||
|
return nil, fmt.Errorf("invalid message length: %d", msgLen)
|
||||||
|
}
|
||||||
|
|
||||||
|
msgBuf := make([]byte, msgLen)
|
||||||
|
if _, err := io.ReadFull(conn, msgBuf); err != nil {
|
||||||
|
return nil, fmt.Errorf("read message: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
msg := new(dns.Msg)
|
||||||
|
if err := msg.Unpack(msgBuf); err != nil {
|
||||||
|
return nil, fmt.Errorf("unpack: %w", err)
|
||||||
|
}
|
||||||
|
return msg, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// srcAddrFromPacket extracts the source IP:port from a raw IP+TCP packet for logging.
|
||||||
|
// Supports both IPv4 and IPv6.
|
||||||
|
func srcAddrFromPacket(pkt []byte) netip.AddrPort {
|
||||||
|
if len(pkt) == 0 {
|
||||||
|
return netip.AddrPort{}
|
||||||
|
}
|
||||||
|
|
||||||
|
srcIP, transportOffset := srcIPFromPacket(pkt)
|
||||||
|
if !srcIP.IsValid() || len(pkt) < transportOffset+2 {
|
||||||
|
return netip.AddrPort{}
|
||||||
|
}
|
||||||
|
|
||||||
|
srcPort := uint16(pkt[transportOffset])<<8 | uint16(pkt[transportOffset+1])
|
||||||
|
return netip.AddrPortFrom(srcIP.Unmap(), srcPort)
|
||||||
|
}
|
||||||
|
|
||||||
|
func srcIPFromPacket(pkt []byte) (netip.Addr, int) {
|
||||||
|
switch header.IPVersion(pkt) {
|
||||||
|
case 4:
|
||||||
|
return srcIPv4(pkt)
|
||||||
|
case 6:
|
||||||
|
return srcIPv6(pkt)
|
||||||
|
default:
|
||||||
|
return netip.Addr{}, 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func srcIPv4(pkt []byte) (netip.Addr, int) {
|
||||||
|
if len(pkt) < header.IPv4MinimumSize {
|
||||||
|
return netip.Addr{}, 0
|
||||||
|
}
|
||||||
|
hdr := header.IPv4(pkt)
|
||||||
|
src := hdr.SourceAddress()
|
||||||
|
ip, ok := netip.AddrFromSlice(src.AsSlice())
|
||||||
|
if !ok {
|
||||||
|
return netip.Addr{}, 0
|
||||||
|
}
|
||||||
|
return ip, int(hdr.HeaderLength())
|
||||||
|
}
|
||||||
|
|
||||||
|
func srcIPv6(pkt []byte) (netip.Addr, int) {
|
||||||
|
if len(pkt) < header.IPv6MinimumSize {
|
||||||
|
return netip.Addr{}, 0
|
||||||
|
}
|
||||||
|
hdr := header.IPv6(pkt)
|
||||||
|
src := hdr.SourceAddress()
|
||||||
|
ip, ok := netip.AddrFromSlice(src.AsSlice())
|
||||||
|
if !ok {
|
||||||
|
return netip.Addr{}, 0
|
||||||
|
}
|
||||||
|
return ip, header.IPv6MinimumSize
|
||||||
|
}
|
||||||
@@ -41,10 +41,61 @@ const (
|
|||||||
|
|
||||||
reactivatePeriod = 30 * time.Second
|
reactivatePeriod = 30 * time.Second
|
||||||
probeTimeout = 2 * time.Second
|
probeTimeout = 2 * time.Second
|
||||||
|
|
||||||
|
// ipv6HeaderSize + udpHeaderSize, used to derive the maximum DNS UDP
|
||||||
|
// payload from the tunnel MTU.
|
||||||
|
ipUDPHeaderSize = 60 + 8
|
||||||
)
|
)
|
||||||
|
|
||||||
const testRecord = "com."
|
const testRecord = "com."
|
||||||
|
|
||||||
|
const (
|
||||||
|
protoUDP = "udp"
|
||||||
|
protoTCP = "tcp"
|
||||||
|
)
|
||||||
|
|
||||||
|
type dnsProtocolKey struct{}
|
||||||
|
|
||||||
|
// contextWithDNSProtocol stores the inbound DNS protocol ("udp" or "tcp") in context.
|
||||||
|
func contextWithDNSProtocol(ctx context.Context, network string) context.Context {
|
||||||
|
return context.WithValue(ctx, dnsProtocolKey{}, network)
|
||||||
|
}
|
||||||
|
|
||||||
|
// dnsProtocolFromContext retrieves the inbound DNS protocol from context.
|
||||||
|
func dnsProtocolFromContext(ctx context.Context) string {
|
||||||
|
if ctx == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
if v, ok := ctx.Value(dnsProtocolKey{}).(string); ok {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
type upstreamProtocolKey struct{}
|
||||||
|
|
||||||
|
// upstreamProtocolResult holds the protocol used for the upstream exchange.
|
||||||
|
// Stored as a pointer in context so the exchange function can set it.
|
||||||
|
type upstreamProtocolResult struct {
|
||||||
|
protocol string
|
||||||
|
}
|
||||||
|
|
||||||
|
// contextWithupstreamProtocolResult stores a mutable result holder in the context.
|
||||||
|
func contextWithupstreamProtocolResult(ctx context.Context) (context.Context, *upstreamProtocolResult) {
|
||||||
|
r := &upstreamProtocolResult{}
|
||||||
|
return context.WithValue(ctx, upstreamProtocolKey{}, r), r
|
||||||
|
}
|
||||||
|
|
||||||
|
// setUpstreamProtocol sets the upstream protocol on the result holder in context, if present.
|
||||||
|
func setUpstreamProtocol(ctx context.Context, protocol string) {
|
||||||
|
if ctx == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if r, ok := ctx.Value(upstreamProtocolKey{}).(*upstreamProtocolResult); ok && r != nil {
|
||||||
|
r.protocol = protocol
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
type upstreamClient interface {
|
type upstreamClient interface {
|
||||||
exchange(ctx context.Context, upstream string, r *dns.Msg) (*dns.Msg, time.Duration, error)
|
exchange(ctx context.Context, upstream string, r *dns.Msg) (*dns.Msg, time.Duration, error)
|
||||||
}
|
}
|
||||||
@@ -65,10 +116,12 @@ type upstreamResolverBase struct {
|
|||||||
mutex sync.Mutex
|
mutex sync.Mutex
|
||||||
reactivatePeriod time.Duration
|
reactivatePeriod time.Duration
|
||||||
upstreamTimeout time.Duration
|
upstreamTimeout time.Duration
|
||||||
|
wg sync.WaitGroup
|
||||||
|
|
||||||
deactivate func(error)
|
deactivate func(error)
|
||||||
reactivate func()
|
reactivate func()
|
||||||
statusRecorder *peer.Status
|
statusRecorder *peer.Status
|
||||||
|
routeMatch func(netip.Addr) bool
|
||||||
}
|
}
|
||||||
|
|
||||||
type upstreamFailure struct {
|
type upstreamFailure struct {
|
||||||
@@ -115,6 +168,11 @@ func (u *upstreamResolverBase) MatchSubdomains() bool {
|
|||||||
func (u *upstreamResolverBase) Stop() {
|
func (u *upstreamResolverBase) Stop() {
|
||||||
log.Debugf("stopping serving DNS for upstreams %s", u.upstreamServers)
|
log.Debugf("stopping serving DNS for upstreams %s", u.upstreamServers)
|
||||||
u.cancel()
|
u.cancel()
|
||||||
|
|
||||||
|
u.mutex.Lock()
|
||||||
|
u.wg.Wait()
|
||||||
|
u.mutex.Unlock()
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ServeDNS handles a DNS request
|
// ServeDNS handles a DNS request
|
||||||
@@ -131,7 +189,16 @@ func (u *upstreamResolverBase) ServeDNS(w dns.ResponseWriter, r *dns.Msg) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
ok, failures := u.tryUpstreamServers(w, r, logger)
|
// Propagate inbound protocol so upstream exchange can use TCP directly
|
||||||
|
// when the request came in over TCP.
|
||||||
|
ctx := u.ctx
|
||||||
|
if addr := w.RemoteAddr(); addr != nil {
|
||||||
|
network := addr.Network()
|
||||||
|
ctx = contextWithDNSProtocol(ctx, network)
|
||||||
|
resutil.SetMeta(w, "protocol", network)
|
||||||
|
}
|
||||||
|
|
||||||
|
ok, failures := u.tryUpstreamServers(ctx, w, r, logger)
|
||||||
if len(failures) > 0 {
|
if len(failures) > 0 {
|
||||||
u.logUpstreamFailures(r.Question[0].Name, failures, ok, logger)
|
u.logUpstreamFailures(r.Question[0].Name, failures, ok, logger)
|
||||||
}
|
}
|
||||||
@@ -146,7 +213,7 @@ func (u *upstreamResolverBase) prepareRequest(r *dns.Msg) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *upstreamResolverBase) tryUpstreamServers(w dns.ResponseWriter, r *dns.Msg, logger *log.Entry) (bool, []upstreamFailure) {
|
func (u *upstreamResolverBase) tryUpstreamServers(ctx context.Context, w dns.ResponseWriter, r *dns.Msg, logger *log.Entry) (bool, []upstreamFailure) {
|
||||||
timeout := u.upstreamTimeout
|
timeout := u.upstreamTimeout
|
||||||
if len(u.upstreamServers) > 1 {
|
if len(u.upstreamServers) > 1 {
|
||||||
maxTotal := 5 * time.Second
|
maxTotal := 5 * time.Second
|
||||||
@@ -161,7 +228,7 @@ func (u *upstreamResolverBase) tryUpstreamServers(w dns.ResponseWriter, r *dns.M
|
|||||||
|
|
||||||
var failures []upstreamFailure
|
var failures []upstreamFailure
|
||||||
for _, upstream := range u.upstreamServers {
|
for _, upstream := range u.upstreamServers {
|
||||||
if failure := u.queryUpstream(w, r, upstream, timeout, logger); failure != nil {
|
if failure := u.queryUpstream(ctx, w, r, upstream, timeout, logger); failure != nil {
|
||||||
failures = append(failures, *failure)
|
failures = append(failures, *failure)
|
||||||
} else {
|
} else {
|
||||||
return true, failures
|
return true, failures
|
||||||
@@ -171,15 +238,17 @@ func (u *upstreamResolverBase) tryUpstreamServers(w dns.ResponseWriter, r *dns.M
|
|||||||
}
|
}
|
||||||
|
|
||||||
// queryUpstream queries a single upstream server. Returns nil on success, or failure info to try next upstream.
|
// queryUpstream queries a single upstream server. Returns nil on success, or failure info to try next upstream.
|
||||||
func (u *upstreamResolverBase) queryUpstream(w dns.ResponseWriter, r *dns.Msg, upstream netip.AddrPort, timeout time.Duration, logger *log.Entry) *upstreamFailure {
|
func (u *upstreamResolverBase) queryUpstream(parentCtx context.Context, w dns.ResponseWriter, r *dns.Msg, upstream netip.AddrPort, timeout time.Duration, logger *log.Entry) *upstreamFailure {
|
||||||
var rm *dns.Msg
|
var rm *dns.Msg
|
||||||
var t time.Duration
|
var t time.Duration
|
||||||
var err error
|
var err error
|
||||||
|
|
||||||
var startTime time.Time
|
var startTime time.Time
|
||||||
|
var upstreamProto *upstreamProtocolResult
|
||||||
func() {
|
func() {
|
||||||
ctx, cancel := context.WithTimeout(u.ctx, timeout)
|
ctx, cancel := context.WithTimeout(parentCtx, timeout)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
ctx, upstreamProto = contextWithupstreamProtocolResult(ctx)
|
||||||
startTime = time.Now()
|
startTime = time.Now()
|
||||||
rm, t, err = u.upstreamClient.exchange(ctx, upstream.String(), r)
|
rm, t, err = u.upstreamClient.exchange(ctx, upstream.String(), r)
|
||||||
}()
|
}()
|
||||||
@@ -196,7 +265,7 @@ func (u *upstreamResolverBase) queryUpstream(w dns.ResponseWriter, r *dns.Msg, u
|
|||||||
return &upstreamFailure{upstream: upstream, reason: dns.RcodeToString[rm.Rcode]}
|
return &upstreamFailure{upstream: upstream, reason: dns.RcodeToString[rm.Rcode]}
|
||||||
}
|
}
|
||||||
|
|
||||||
u.writeSuccessResponse(w, rm, upstream, r.Question[0].Name, t, logger)
|
u.writeSuccessResponse(w, rm, upstream, r.Question[0].Name, t, upstreamProto, logger)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -213,10 +282,13 @@ func (u *upstreamResolverBase) handleUpstreamError(err error, upstream netip.Add
|
|||||||
return &upstreamFailure{upstream: upstream, reason: reason}
|
return &upstreamFailure{upstream: upstream, reason: reason}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *upstreamResolverBase) writeSuccessResponse(w dns.ResponseWriter, rm *dns.Msg, upstream netip.AddrPort, domain string, t time.Duration, logger *log.Entry) bool {
|
func (u *upstreamResolverBase) writeSuccessResponse(w dns.ResponseWriter, rm *dns.Msg, upstream netip.AddrPort, domain string, t time.Duration, upstreamProto *upstreamProtocolResult, logger *log.Entry) bool {
|
||||||
u.successCount.Add(1)
|
u.successCount.Add(1)
|
||||||
|
|
||||||
resutil.SetMeta(w, "upstream", upstream.String())
|
resutil.SetMeta(w, "upstream", upstream.String())
|
||||||
|
if upstreamProto != nil && upstreamProto.protocol != "" {
|
||||||
|
resutil.SetMeta(w, "upstream_protocol", upstreamProto.protocol)
|
||||||
|
}
|
||||||
|
|
||||||
// Clear Zero bit from external responses to prevent upstream servers from
|
// Clear Zero bit from external responses to prevent upstream servers from
|
||||||
// manipulating our internal fallthrough signaling mechanism
|
// manipulating our internal fallthrough signaling mechanism
|
||||||
@@ -260,16 +332,10 @@ func formatFailures(failures []upstreamFailure) string {
|
|||||||
|
|
||||||
// ProbeAvailability tests all upstream servers simultaneously and
|
// ProbeAvailability tests all upstream servers simultaneously and
|
||||||
// disables the resolver if none work
|
// disables the resolver if none work
|
||||||
func (u *upstreamResolverBase) ProbeAvailability() {
|
func (u *upstreamResolverBase) ProbeAvailability(ctx context.Context) {
|
||||||
u.mutex.Lock()
|
u.mutex.Lock()
|
||||||
defer u.mutex.Unlock()
|
defer u.mutex.Unlock()
|
||||||
|
|
||||||
select {
|
|
||||||
case <-u.ctx.Done():
|
|
||||||
return
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
// avoid probe if upstreams could resolve at least one query
|
// avoid probe if upstreams could resolve at least one query
|
||||||
if u.successCount.Load() > 0 {
|
if u.successCount.Load() > 0 {
|
||||||
return
|
return
|
||||||
@@ -279,31 +345,39 @@ func (u *upstreamResolverBase) ProbeAvailability() {
|
|||||||
var mu sync.Mutex
|
var mu sync.Mutex
|
||||||
var wg sync.WaitGroup
|
var wg sync.WaitGroup
|
||||||
|
|
||||||
var errors *multierror.Error
|
var errs *multierror.Error
|
||||||
for _, upstream := range u.upstreamServers {
|
for _, upstream := range u.upstreamServers {
|
||||||
upstream := upstream
|
|
||||||
|
|
||||||
wg.Add(1)
|
wg.Add(1)
|
||||||
go func() {
|
go func(upstream netip.AddrPort) {
|
||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
err := u.testNameserver(upstream, 500*time.Millisecond)
|
err := u.testNameserver(u.ctx, ctx, upstream, 500*time.Millisecond)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
errors = multierror.Append(errors, err)
|
mu.Lock()
|
||||||
|
errs = multierror.Append(errs, err)
|
||||||
|
mu.Unlock()
|
||||||
log.Warnf("probing upstream nameserver %s: %s", upstream, err)
|
log.Warnf("probing upstream nameserver %s: %s", upstream, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
mu.Lock()
|
mu.Lock()
|
||||||
defer mu.Unlock()
|
|
||||||
success = true
|
success = true
|
||||||
}()
|
mu.Unlock()
|
||||||
|
}(upstream)
|
||||||
}
|
}
|
||||||
|
|
||||||
wg.Wait()
|
wg.Wait()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-u.ctx.Done():
|
||||||
|
return
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
// didn't find a working upstream server, let's disable and try later
|
// didn't find a working upstream server, let's disable and try later
|
||||||
if !success {
|
if !success {
|
||||||
u.disable(errors.ErrorOrNil())
|
u.disable(errs.ErrorOrNil())
|
||||||
|
|
||||||
if u.statusRecorder == nil {
|
if u.statusRecorder == nil {
|
||||||
return
|
return
|
||||||
@@ -339,7 +413,7 @@ func (u *upstreamResolverBase) waitUntilResponse() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for _, upstream := range u.upstreamServers {
|
for _, upstream := range u.upstreamServers {
|
||||||
if err := u.testNameserver(upstream, probeTimeout); err != nil {
|
if err := u.testNameserver(u.ctx, nil, upstream, probeTimeout); err != nil {
|
||||||
log.Tracef("upstream check for %s: %s", upstream, err)
|
log.Tracef("upstream check for %s: %s", upstream, err)
|
||||||
} else {
|
} else {
|
||||||
// at least one upstream server is available, stop probing
|
// at least one upstream server is available, stop probing
|
||||||
@@ -351,16 +425,22 @@ func (u *upstreamResolverBase) waitUntilResponse() {
|
|||||||
return fmt.Errorf("upstream check call error")
|
return fmt.Errorf("upstream check call error")
|
||||||
}
|
}
|
||||||
|
|
||||||
err := backoff.Retry(operation, exponentialBackOff)
|
err := backoff.Retry(operation, backoff.WithContext(exponentialBackOff, u.ctx))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Warn(err)
|
if errors.Is(err, context.Canceled) {
|
||||||
|
log.Debugf("upstream retry loop exited for upstreams %s", u.upstreamServersString())
|
||||||
|
} else {
|
||||||
|
log.Warnf("upstream retry loop exited for upstreams %s: %v", u.upstreamServersString(), err)
|
||||||
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Infof("upstreams %s are responsive again. Adding them back to system", u.upstreamServersString())
|
log.Infof("upstreams %s are responsive again. Adding them back to system", u.upstreamServersString())
|
||||||
u.successCount.Add(1)
|
u.successCount.Add(1)
|
||||||
u.reactivate()
|
u.reactivate()
|
||||||
|
u.mutex.Lock()
|
||||||
u.disabled = false
|
u.disabled = false
|
||||||
|
u.mutex.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
// isTimeout returns true if the given error is a network timeout error.
|
// isTimeout returns true if the given error is a network timeout error.
|
||||||
@@ -383,7 +463,11 @@ func (u *upstreamResolverBase) disable(err error) {
|
|||||||
u.successCount.Store(0)
|
u.successCount.Store(0)
|
||||||
u.deactivate(err)
|
u.deactivate(err)
|
||||||
u.disabled = true
|
u.disabled = true
|
||||||
go u.waitUntilResponse()
|
u.wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer u.wg.Done()
|
||||||
|
u.waitUntilResponse()
|
||||||
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *upstreamResolverBase) upstreamServersString() string {
|
func (u *upstreamResolverBase) upstreamServersString() string {
|
||||||
@@ -394,23 +478,57 @@ func (u *upstreamResolverBase) upstreamServersString() string {
|
|||||||
return strings.Join(servers, ", ")
|
return strings.Join(servers, ", ")
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *upstreamResolverBase) testNameserver(server netip.AddrPort, timeout time.Duration) error {
|
func (u *upstreamResolverBase) testNameserver(baseCtx context.Context, externalCtx context.Context, server netip.AddrPort, timeout time.Duration) error {
|
||||||
ctx, cancel := context.WithTimeout(u.ctx, timeout)
|
mergedCtx, cancel := context.WithTimeout(baseCtx, timeout)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
|
if externalCtx != nil {
|
||||||
|
stop2 := context.AfterFunc(externalCtx, cancel)
|
||||||
|
defer stop2()
|
||||||
|
}
|
||||||
|
|
||||||
r := new(dns.Msg).SetQuestion(testRecord, dns.TypeSOA)
|
r := new(dns.Msg).SetQuestion(testRecord, dns.TypeSOA)
|
||||||
|
|
||||||
_, _, err := u.upstreamClient.exchange(ctx, server.String(), r)
|
_, _, err := u.upstreamClient.exchange(mergedCtx, server.String(), r)
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// clientUDPMaxSize returns the maximum UDP response size the client accepts.
|
||||||
|
func clientUDPMaxSize(r *dns.Msg) int {
|
||||||
|
if opt := r.IsEdns0(); opt != nil {
|
||||||
|
return int(opt.UDPSize())
|
||||||
|
}
|
||||||
|
return dns.MinMsgSize
|
||||||
|
}
|
||||||
|
|
||||||
// ExchangeWithFallback exchanges a DNS message with the upstream server.
|
// ExchangeWithFallback exchanges a DNS message with the upstream server.
|
||||||
// It first tries to use UDP, and if it is truncated, it falls back to TCP.
|
// It first tries to use UDP, and if it is truncated, it falls back to TCP.
|
||||||
|
// If the inbound request came over TCP (via context), it skips the UDP attempt.
|
||||||
// If the passed context is nil, this will use Exchange instead of ExchangeContext.
|
// If the passed context is nil, this will use Exchange instead of ExchangeContext.
|
||||||
func ExchangeWithFallback(ctx context.Context, client *dns.Client, r *dns.Msg, upstream string) (*dns.Msg, time.Duration, error) {
|
func ExchangeWithFallback(ctx context.Context, client *dns.Client, r *dns.Msg, upstream string) (*dns.Msg, time.Duration, error) {
|
||||||
// MTU - ip + udp headers
|
// If the request came in over TCP, go straight to TCP upstream.
|
||||||
// Note: this could be sent out on an interface that is not ours, but higher MTU settings could break truncation handling.
|
if dnsProtocolFromContext(ctx) == protoTCP {
|
||||||
client.UDPSize = uint16(currentMTU - (60 + 8))
|
tcpClient := *client
|
||||||
|
tcpClient.Net = protoTCP
|
||||||
|
rm, t, err := tcpClient.ExchangeContext(ctx, r, upstream)
|
||||||
|
if err != nil {
|
||||||
|
return nil, t, fmt.Errorf("with tcp: %w", err)
|
||||||
|
}
|
||||||
|
setUpstreamProtocol(ctx, protoTCP)
|
||||||
|
return rm, t, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
clientMaxSize := clientUDPMaxSize(r)
|
||||||
|
|
||||||
|
// Cap EDNS0 to our tunnel MTU so the upstream doesn't send a
|
||||||
|
// response larger than our read buffer.
|
||||||
|
// Note: the query could be sent out on an interface that is not ours,
|
||||||
|
// but higher MTU settings could break truncation handling.
|
||||||
|
maxUDPPayload := uint16(currentMTU - ipUDPHeaderSize)
|
||||||
|
client.UDPSize = maxUDPPayload
|
||||||
|
if opt := r.IsEdns0(); opt != nil && opt.UDPSize() > maxUDPPayload {
|
||||||
|
opt.SetUDPSize(maxUDPPayload)
|
||||||
|
}
|
||||||
|
|
||||||
var (
|
var (
|
||||||
rm *dns.Msg
|
rm *dns.Msg
|
||||||
@@ -429,25 +547,32 @@ func ExchangeWithFallback(ctx context.Context, client *dns.Client, r *dns.Msg, u
|
|||||||
}
|
}
|
||||||
|
|
||||||
if rm == nil || !rm.MsgHdr.Truncated {
|
if rm == nil || !rm.MsgHdr.Truncated {
|
||||||
|
setUpstreamProtocol(ctx, protoUDP)
|
||||||
return rm, t, nil
|
return rm, t, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Tracef("udp response for domain=%s type=%v class=%v is truncated, trying TCP.",
|
// TODO: if the upstream's truncated UDP response already contains more
|
||||||
r.Question[0].Name, r.Question[0].Qtype, r.Question[0].Qclass)
|
// data than the client's buffer, we could truncate locally and skip
|
||||||
|
// the TCP retry.
|
||||||
|
|
||||||
client.Net = "tcp"
|
tcpClient := *client
|
||||||
|
tcpClient.Net = protoTCP
|
||||||
|
|
||||||
if ctx == nil {
|
if ctx == nil {
|
||||||
rm, t, err = client.Exchange(r, upstream)
|
rm, t, err = tcpClient.Exchange(r, upstream)
|
||||||
} else {
|
} else {
|
||||||
rm, t, err = client.ExchangeContext(ctx, r, upstream)
|
rm, t, err = tcpClient.ExchangeContext(ctx, r, upstream)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, t, fmt.Errorf("with tcp: %w", err)
|
return nil, t, fmt.Errorf("with tcp: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO: once TCP is implemented, rm.Truncate() if the request came in over UDP
|
setUpstreamProtocol(ctx, protoTCP)
|
||||||
|
|
||||||
|
if rm.Len() > clientMaxSize {
|
||||||
|
rm.Truncate(clientMaxSize)
|
||||||
|
}
|
||||||
|
|
||||||
return rm, t, nil
|
return rm, t, nil
|
||||||
}
|
}
|
||||||
@@ -455,18 +580,46 @@ func ExchangeWithFallback(ctx context.Context, client *dns.Client, r *dns.Msg, u
|
|||||||
// ExchangeWithNetstack performs a DNS exchange using netstack for dialing.
|
// ExchangeWithNetstack performs a DNS exchange using netstack for dialing.
|
||||||
// This is needed when netstack is enabled to reach peer IPs through the tunnel.
|
// This is needed when netstack is enabled to reach peer IPs through the tunnel.
|
||||||
func ExchangeWithNetstack(ctx context.Context, nsNet *netstack.Net, r *dns.Msg, upstream string) (*dns.Msg, error) {
|
func ExchangeWithNetstack(ctx context.Context, nsNet *netstack.Net, r *dns.Msg, upstream string) (*dns.Msg, error) {
|
||||||
reply, err := netstackExchange(ctx, nsNet, r, upstream, "udp")
|
// If request came in over TCP, go straight to TCP upstream
|
||||||
|
if dnsProtocolFromContext(ctx) == protoTCP {
|
||||||
|
rm, err := netstackExchange(ctx, nsNet, r, upstream, protoTCP)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
setUpstreamProtocol(ctx, protoTCP)
|
||||||
|
return rm, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
clientMaxSize := clientUDPMaxSize(r)
|
||||||
|
|
||||||
|
// Cap EDNS0 to our tunnel MTU so the upstream doesn't send a
|
||||||
|
// response larger than what we can read over UDP.
|
||||||
|
maxUDPPayload := uint16(currentMTU - ipUDPHeaderSize)
|
||||||
|
if opt := r.IsEdns0(); opt != nil && opt.UDPSize() > maxUDPPayload {
|
||||||
|
opt.SetUDPSize(maxUDPPayload)
|
||||||
|
}
|
||||||
|
|
||||||
|
reply, err := netstackExchange(ctx, nsNet, r, upstream, protoUDP)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// If response is truncated, retry with TCP
|
|
||||||
if reply != nil && reply.MsgHdr.Truncated {
|
if reply != nil && reply.MsgHdr.Truncated {
|
||||||
log.Tracef("udp response for domain=%s type=%v class=%v is truncated, trying TCP",
|
rm, err := netstackExchange(ctx, nsNet, r, upstream, protoTCP)
|
||||||
r.Question[0].Name, r.Question[0].Qtype, r.Question[0].Qclass)
|
if err != nil {
|
||||||
return netstackExchange(ctx, nsNet, r, upstream, "tcp")
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
setUpstreamProtocol(ctx, protoTCP)
|
||||||
|
if rm.Len() > clientMaxSize {
|
||||||
|
rm.Truncate(clientMaxSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
return rm, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
setUpstreamProtocol(ctx, protoUDP)
|
||||||
|
|
||||||
return reply, nil
|
return reply, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -487,7 +640,7 @@ func netstackExchange(ctx context.Context, nsNet *netstack.Net, r *dns.Msg, upst
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
dnsConn := &dns.Conn{Conn: conn}
|
dnsConn := &dns.Conn{Conn: conn, UDPSize: uint16(currentMTU - ipUDPHeaderSize)}
|
||||||
|
|
||||||
if err := dnsConn.WriteMsg(r); err != nil {
|
if err := dnsConn.WriteMsg(r); err != nil {
|
||||||
return nil, fmt.Errorf("write %s message: %w", network, err)
|
return nil, fmt.Errorf("write %s message: %w", network, err)
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ func (u *upstreamResolver) exchangeWithinVPN(ctx context.Context, upstream strin
|
|||||||
upstreamExchangeClient := &dns.Client{
|
upstreamExchangeClient := &dns.Client{
|
||||||
Timeout: ClientTimeout,
|
Timeout: ClientTimeout,
|
||||||
}
|
}
|
||||||
return upstreamExchangeClient.ExchangeContext(ctx, r, upstream)
|
return ExchangeWithFallback(ctx, upstreamExchangeClient, r, upstream)
|
||||||
}
|
}
|
||||||
|
|
||||||
// exchangeWithoutVPN protect the UDP socket by Android SDK to avoid to goes through the VPN
|
// exchangeWithoutVPN protect the UDP socket by Android SDK to avoid to goes through the VPN
|
||||||
@@ -76,7 +76,7 @@ func (u *upstreamResolver) exchangeWithoutVPN(ctx context.Context, upstream stri
|
|||||||
Timeout: timeout,
|
Timeout: timeout,
|
||||||
}
|
}
|
||||||
|
|
||||||
return upstreamExchangeClient.ExchangeContext(ctx, r, upstream)
|
return ExchangeWithFallback(ctx, upstreamExchangeClient, r, upstream)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (u *upstreamResolver) isLocalResolver(upstream string) bool {
|
func (u *upstreamResolver) isLocalResolver(upstream string) bool {
|
||||||
|
|||||||
@@ -65,11 +65,13 @@ func (u *upstreamResolverIOS) exchange(ctx context.Context, upstream string, r *
|
|||||||
} else {
|
} else {
|
||||||
upstreamIP = upstreamIP.Unmap()
|
upstreamIP = upstreamIP.Unmap()
|
||||||
}
|
}
|
||||||
if u.lNet.Contains(upstreamIP) || upstreamIP.IsPrivate() {
|
needsPrivate := u.lNet.Contains(upstreamIP) ||
|
||||||
log.Debugf("using private client to query upstream: %s", upstream)
|
(u.routeMatch != nil && u.routeMatch(upstreamIP))
|
||||||
|
if needsPrivate {
|
||||||
|
log.Debugf("using private client to query %s via upstream %s", r.Question[0].Name, upstream)
|
||||||
client, err = GetClientPrivate(u.lIP, u.interfaceName, timeout)
|
client, err = GetClientPrivate(u.lIP, u.interfaceName, timeout)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, 0, fmt.Errorf("error while creating private client: %s", err)
|
return nil, 0, fmt.Errorf("create private client: %s", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -188,7 +188,7 @@ func TestUpstreamResolver_DeactivationReactivation(t *testing.T) {
|
|||||||
reactivated = true
|
reactivated = true
|
||||||
}
|
}
|
||||||
|
|
||||||
resolver.ProbeAvailability()
|
resolver.ProbeAvailability(context.TODO())
|
||||||
|
|
||||||
if !failed {
|
if !failed {
|
||||||
t.Errorf("expected that resolving was deactivated")
|
t.Errorf("expected that resolving was deactivated")
|
||||||
@@ -475,3 +475,298 @@ func TestFormatFailures(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestDNSProtocolContext(t *testing.T) {
|
||||||
|
t.Run("roundtrip udp", func(t *testing.T) {
|
||||||
|
ctx := contextWithDNSProtocol(context.Background(), protoUDP)
|
||||||
|
assert.Equal(t, protoUDP, dnsProtocolFromContext(ctx))
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("roundtrip tcp", func(t *testing.T) {
|
||||||
|
ctx := contextWithDNSProtocol(context.Background(), protoTCP)
|
||||||
|
assert.Equal(t, protoTCP, dnsProtocolFromContext(ctx))
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("missing returns empty", func(t *testing.T) {
|
||||||
|
assert.Equal(t, "", dnsProtocolFromContext(context.Background()))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExchangeWithFallback_TCPContext(t *testing.T) {
|
||||||
|
// Start a local DNS server that responds on TCP only
|
||||||
|
tcpHandler := dns.HandlerFunc(func(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
m.Answer = append(m.Answer, &dns.A{
|
||||||
|
Hdr: dns.RR_Header{Name: r.Question[0].Name, Rrtype: dns.TypeA, Class: dns.ClassINET, Ttl: 60},
|
||||||
|
A: net.ParseIP("10.0.0.1"),
|
||||||
|
})
|
||||||
|
if err := w.WriteMsg(m); err != nil {
|
||||||
|
t.Logf("write msg: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
tcpServer := &dns.Server{
|
||||||
|
Addr: "127.0.0.1:0",
|
||||||
|
Net: "tcp",
|
||||||
|
Handler: tcpHandler,
|
||||||
|
}
|
||||||
|
|
||||||
|
tcpLn, err := net.Listen("tcp", "127.0.0.1:0")
|
||||||
|
require.NoError(t, err)
|
||||||
|
tcpServer.Listener = tcpLn
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
if err := tcpServer.ActivateAndServe(); err != nil {
|
||||||
|
t.Logf("tcp server: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
defer func() {
|
||||||
|
_ = tcpServer.Shutdown()
|
||||||
|
}()
|
||||||
|
|
||||||
|
upstream := tcpLn.Addr().String()
|
||||||
|
|
||||||
|
// With TCP context, should connect directly via TCP without trying UDP
|
||||||
|
ctx := contextWithDNSProtocol(context.Background(), protoTCP)
|
||||||
|
client := &dns.Client{Timeout: 2 * time.Second}
|
||||||
|
r := new(dns.Msg).SetQuestion("example.com.", dns.TypeA)
|
||||||
|
|
||||||
|
rm, _, err := ExchangeWithFallback(ctx, client, r, upstream)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotNil(t, rm)
|
||||||
|
require.NotEmpty(t, rm.Answer)
|
||||||
|
assert.Contains(t, rm.Answer[0].String(), "10.0.0.1")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExchangeWithFallback_UDPFallbackToTCP(t *testing.T) {
|
||||||
|
// UDP handler returns a truncated response to trigger TCP retry.
|
||||||
|
udpHandler := dns.HandlerFunc(func(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
m.Truncated = true
|
||||||
|
if err := w.WriteMsg(m); err != nil {
|
||||||
|
t.Logf("write msg: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// TCP handler returns the full answer.
|
||||||
|
tcpHandler := dns.HandlerFunc(func(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
m.Answer = append(m.Answer, &dns.A{
|
||||||
|
Hdr: dns.RR_Header{Name: r.Question[0].Name, Rrtype: dns.TypeA, Class: dns.ClassINET, Ttl: 60},
|
||||||
|
A: net.ParseIP("10.0.0.3"),
|
||||||
|
})
|
||||||
|
if err := w.WriteMsg(m); err != nil {
|
||||||
|
t.Logf("write msg: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
udpPC, err := net.ListenPacket("udp", "127.0.0.1:0")
|
||||||
|
require.NoError(t, err)
|
||||||
|
addr := udpPC.LocalAddr().String()
|
||||||
|
|
||||||
|
udpServer := &dns.Server{
|
||||||
|
PacketConn: udpPC,
|
||||||
|
Net: "udp",
|
||||||
|
Handler: udpHandler,
|
||||||
|
}
|
||||||
|
|
||||||
|
tcpLn, err := net.Listen("tcp", addr)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
tcpServer := &dns.Server{
|
||||||
|
Listener: tcpLn,
|
||||||
|
Net: "tcp",
|
||||||
|
Handler: tcpHandler,
|
||||||
|
}
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
if err := udpServer.ActivateAndServe(); err != nil {
|
||||||
|
t.Logf("udp server: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
go func() {
|
||||||
|
if err := tcpServer.ActivateAndServe(); err != nil {
|
||||||
|
t.Logf("tcp server: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
defer func() {
|
||||||
|
_ = udpServer.Shutdown()
|
||||||
|
_ = tcpServer.Shutdown()
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &dns.Client{Timeout: 2 * time.Second}
|
||||||
|
r := new(dns.Msg).SetQuestion("example.com.", dns.TypeA)
|
||||||
|
|
||||||
|
rm, _, err := ExchangeWithFallback(ctx, client, r, addr)
|
||||||
|
require.NoError(t, err, "should fall back to TCP after truncated UDP response")
|
||||||
|
require.NotNil(t, rm)
|
||||||
|
require.NotEmpty(t, rm.Answer, "TCP response should contain the full answer")
|
||||||
|
assert.Contains(t, rm.Answer[0].String(), "10.0.0.3")
|
||||||
|
assert.False(t, rm.Truncated, "TCP response should not be truncated")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExchangeWithFallback_TCPContextSkipsUDP(t *testing.T) {
|
||||||
|
// Start only a TCP server (no UDP). With TCP context it should succeed.
|
||||||
|
tcpHandler := dns.HandlerFunc(func(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
m.Answer = append(m.Answer, &dns.A{
|
||||||
|
Hdr: dns.RR_Header{Name: r.Question[0].Name, Rrtype: dns.TypeA, Class: dns.ClassINET, Ttl: 60},
|
||||||
|
A: net.ParseIP("10.0.0.2"),
|
||||||
|
})
|
||||||
|
if err := w.WriteMsg(m); err != nil {
|
||||||
|
t.Logf("write msg: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
tcpLn, err := net.Listen("tcp", "127.0.0.1:0")
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
tcpServer := &dns.Server{
|
||||||
|
Listener: tcpLn,
|
||||||
|
Net: "tcp",
|
||||||
|
Handler: tcpHandler,
|
||||||
|
}
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
if err := tcpServer.ActivateAndServe(); err != nil {
|
||||||
|
t.Logf("tcp server: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
defer func() {
|
||||||
|
_ = tcpServer.Shutdown()
|
||||||
|
}()
|
||||||
|
|
||||||
|
upstream := tcpLn.Addr().String()
|
||||||
|
|
||||||
|
// TCP context: should skip UDP entirely and go directly to TCP
|
||||||
|
ctx := contextWithDNSProtocol(context.Background(), protoTCP)
|
||||||
|
client := &dns.Client{Timeout: 2 * time.Second}
|
||||||
|
r := new(dns.Msg).SetQuestion("example.com.", dns.TypeA)
|
||||||
|
|
||||||
|
rm, _, err := ExchangeWithFallback(ctx, client, r, upstream)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotNil(t, rm)
|
||||||
|
require.NotEmpty(t, rm.Answer)
|
||||||
|
assert.Contains(t, rm.Answer[0].String(), "10.0.0.2")
|
||||||
|
|
||||||
|
// Without TCP context, trying to reach a TCP-only server via UDP should fail
|
||||||
|
ctx2 := context.Background()
|
||||||
|
client2 := &dns.Client{Timeout: 500 * time.Millisecond}
|
||||||
|
_, _, err = ExchangeWithFallback(ctx2, client2, r, upstream)
|
||||||
|
assert.Error(t, err, "should fail when no UDP server and no TCP context")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExchangeWithFallback_EDNS0Capped(t *testing.T) {
|
||||||
|
// Verify that a client EDNS0 larger than our MTU-derived limit gets
|
||||||
|
// capped in the outgoing request so the upstream doesn't send a
|
||||||
|
// response larger than our read buffer.
|
||||||
|
var receivedUDPSize uint16
|
||||||
|
udpHandler := dns.HandlerFunc(func(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
if opt := r.IsEdns0(); opt != nil {
|
||||||
|
receivedUDPSize = opt.UDPSize()
|
||||||
|
}
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
m.Answer = append(m.Answer, &dns.A{
|
||||||
|
Hdr: dns.RR_Header{Name: r.Question[0].Name, Rrtype: dns.TypeA, Class: dns.ClassINET, Ttl: 60},
|
||||||
|
A: net.ParseIP("10.0.0.1"),
|
||||||
|
})
|
||||||
|
if err := w.WriteMsg(m); err != nil {
|
||||||
|
t.Logf("write msg: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
udpPC, err := net.ListenPacket("udp", "127.0.0.1:0")
|
||||||
|
require.NoError(t, err)
|
||||||
|
addr := udpPC.LocalAddr().String()
|
||||||
|
|
||||||
|
udpServer := &dns.Server{PacketConn: udpPC, Net: "udp", Handler: udpHandler}
|
||||||
|
go func() { _ = udpServer.ActivateAndServe() }()
|
||||||
|
t.Cleanup(func() { _ = udpServer.Shutdown() })
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &dns.Client{Timeout: 2 * time.Second}
|
||||||
|
r := new(dns.Msg).SetQuestion("example.com.", dns.TypeA)
|
||||||
|
r.SetEdns0(4096, false)
|
||||||
|
|
||||||
|
rm, _, err := ExchangeWithFallback(ctx, client, r, addr)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotNil(t, rm)
|
||||||
|
|
||||||
|
expectedMax := uint16(currentMTU - ipUDPHeaderSize)
|
||||||
|
assert.Equal(t, expectedMax, receivedUDPSize,
|
||||||
|
"upstream should see capped EDNS0, not the client's 4096")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExchangeWithFallback_TCPTruncatesToClientSize(t *testing.T) {
|
||||||
|
// When the client advertises a large EDNS0 (4096) and the upstream
|
||||||
|
// truncates, the TCP response should NOT be truncated since the full
|
||||||
|
// answer fits within the client's original buffer.
|
||||||
|
udpHandler := dns.HandlerFunc(func(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
m.Truncated = true
|
||||||
|
if err := w.WriteMsg(m); err != nil {
|
||||||
|
t.Logf("write msg: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
tcpHandler := dns.HandlerFunc(func(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
// Add enough records to exceed MTU but fit within 4096
|
||||||
|
for i := range 20 {
|
||||||
|
m.Answer = append(m.Answer, &dns.TXT{
|
||||||
|
Hdr: dns.RR_Header{Name: r.Question[0].Name, Rrtype: dns.TypeTXT, Class: dns.ClassINET, Ttl: 60},
|
||||||
|
Txt: []string{fmt.Sprintf("record-%d-padding-data-to-make-it-longer", i)},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
if err := w.WriteMsg(m); err != nil {
|
||||||
|
t.Logf("write msg: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
udpPC, err := net.ListenPacket("udp", "127.0.0.1:0")
|
||||||
|
require.NoError(t, err)
|
||||||
|
addr := udpPC.LocalAddr().String()
|
||||||
|
|
||||||
|
udpServer := &dns.Server{PacketConn: udpPC, Net: "udp", Handler: udpHandler}
|
||||||
|
tcpLn, err := net.Listen("tcp", addr)
|
||||||
|
require.NoError(t, err)
|
||||||
|
tcpServer := &dns.Server{Listener: tcpLn, Net: "tcp", Handler: tcpHandler}
|
||||||
|
|
||||||
|
go func() { _ = udpServer.ActivateAndServe() }()
|
||||||
|
go func() { _ = tcpServer.ActivateAndServe() }()
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = udpServer.Shutdown()
|
||||||
|
_ = tcpServer.Shutdown()
|
||||||
|
})
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
client := &dns.Client{Timeout: 2 * time.Second}
|
||||||
|
|
||||||
|
// Client with large buffer: should get all records without truncation
|
||||||
|
r := new(dns.Msg).SetQuestion("example.com.", dns.TypeTXT)
|
||||||
|
r.SetEdns0(4096, false)
|
||||||
|
|
||||||
|
rm, _, err := ExchangeWithFallback(ctx, client, r, addr)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotNil(t, rm)
|
||||||
|
assert.Len(t, rm.Answer, 20, "large EDNS0 client should get all records")
|
||||||
|
assert.False(t, rm.Truncated, "response should not be truncated for large buffer client")
|
||||||
|
|
||||||
|
// Client with small buffer: should get truncated response
|
||||||
|
r2 := new(dns.Msg).SetQuestion("example.com.", dns.TypeTXT)
|
||||||
|
r2.SetEdns0(512, false)
|
||||||
|
|
||||||
|
rm2, _, err := ExchangeWithFallback(ctx, &dns.Client{Timeout: 2 * time.Second}, r2, addr)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NotNil(t, rm2)
|
||||||
|
assert.Less(t, len(rm2.Answer), 20, "small EDNS0 client should get fewer records")
|
||||||
|
assert.True(t, rm2.Truncated, "response should be truncated for small buffer client")
|
||||||
|
}
|
||||||
|
|||||||
@@ -237,8 +237,8 @@ func (f *DNSForwarder) writeResponse(logger *log.Entry, w dns.ResponseWriter, re
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
logger.Tracef("response: domain=%s rcode=%s answers=%s took=%s",
|
logger.Tracef("response: domain=%s rcode=%s answers=%s size=%dB took=%s",
|
||||||
qname, dns.RcodeToString[resp.Rcode], resutil.FormatAnswers(resp.Answer), time.Since(startTime))
|
qname, dns.RcodeToString[resp.Rcode], resutil.FormatAnswers(resp.Answer), resp.Len(), time.Since(startTime))
|
||||||
}
|
}
|
||||||
|
|
||||||
// udpResponseWriter wraps a dns.ResponseWriter to handle UDP-specific truncation.
|
// udpResponseWriter wraps a dns.ResponseWriter to handle UDP-specific truncation.
|
||||||
@@ -263,20 +263,28 @@ func (u *udpResponseWriter) WriteMsg(resp *dns.Msg) error {
|
|||||||
|
|
||||||
func (f *DNSForwarder) handleDNSQueryUDP(w dns.ResponseWriter, query *dns.Msg) {
|
func (f *DNSForwarder) handleDNSQueryUDP(w dns.ResponseWriter, query *dns.Msg) {
|
||||||
startTime := time.Now()
|
startTime := time.Now()
|
||||||
logger := log.WithFields(log.Fields{
|
fields := log.Fields{
|
||||||
"request_id": resutil.GenerateRequestID(),
|
"request_id": resutil.GenerateRequestID(),
|
||||||
"dns_id": fmt.Sprintf("%04x", query.Id),
|
"dns_id": fmt.Sprintf("%04x", query.Id),
|
||||||
})
|
}
|
||||||
|
if addr := w.RemoteAddr(); addr != nil {
|
||||||
|
fields["client"] = addr.String()
|
||||||
|
}
|
||||||
|
logger := log.WithFields(fields)
|
||||||
|
|
||||||
f.handleDNSQuery(logger, &udpResponseWriter{ResponseWriter: w, query: query}, query, startTime)
|
f.handleDNSQuery(logger, &udpResponseWriter{ResponseWriter: w, query: query}, query, startTime)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *DNSForwarder) handleDNSQueryTCP(w dns.ResponseWriter, query *dns.Msg) {
|
func (f *DNSForwarder) handleDNSQueryTCP(w dns.ResponseWriter, query *dns.Msg) {
|
||||||
startTime := time.Now()
|
startTime := time.Now()
|
||||||
logger := log.WithFields(log.Fields{
|
fields := log.Fields{
|
||||||
"request_id": resutil.GenerateRequestID(),
|
"request_id": resutil.GenerateRequestID(),
|
||||||
"dns_id": fmt.Sprintf("%04x", query.Id),
|
"dns_id": fmt.Sprintf("%04x", query.Id),
|
||||||
})
|
}
|
||||||
|
if addr := w.RemoteAddr(); addr != nil {
|
||||||
|
fields["client"] = addr.String()
|
||||||
|
}
|
||||||
|
logger := log.WithFields(fields)
|
||||||
|
|
||||||
f.handleDNSQuery(logger, w, query, startTime)
|
f.handleDNSQuery(logger, w, query, startTime)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -28,15 +28,17 @@ import (
|
|||||||
"github.com/netbirdio/netbird/client/firewall"
|
"github.com/netbirdio/netbird/client/firewall"
|
||||||
firewallManager "github.com/netbirdio/netbird/client/firewall/manager"
|
firewallManager "github.com/netbirdio/netbird/client/firewall/manager"
|
||||||
"github.com/netbirdio/netbird/client/iface"
|
"github.com/netbirdio/netbird/client/iface"
|
||||||
nbnetstack "github.com/netbirdio/netbird/client/iface/netstack"
|
|
||||||
"github.com/netbirdio/netbird/client/iface/device"
|
"github.com/netbirdio/netbird/client/iface/device"
|
||||||
|
nbnetstack "github.com/netbirdio/netbird/client/iface/netstack"
|
||||||
"github.com/netbirdio/netbird/client/iface/udpmux"
|
"github.com/netbirdio/netbird/client/iface/udpmux"
|
||||||
"github.com/netbirdio/netbird/client/internal/acl"
|
"github.com/netbirdio/netbird/client/internal/acl"
|
||||||
"github.com/netbirdio/netbird/client/internal/debug"
|
"github.com/netbirdio/netbird/client/internal/debug"
|
||||||
"github.com/netbirdio/netbird/client/internal/dns"
|
"github.com/netbirdio/netbird/client/internal/dns"
|
||||||
dnsconfig "github.com/netbirdio/netbird/client/internal/dns/config"
|
dnsconfig "github.com/netbirdio/netbird/client/internal/dns/config"
|
||||||
"github.com/netbirdio/netbird/client/internal/dnsfwd"
|
"github.com/netbirdio/netbird/client/internal/dnsfwd"
|
||||||
|
"github.com/netbirdio/netbird/client/internal/expose"
|
||||||
"github.com/netbirdio/netbird/client/internal/ingressgw"
|
"github.com/netbirdio/netbird/client/internal/ingressgw"
|
||||||
|
"github.com/netbirdio/netbird/client/internal/metrics"
|
||||||
"github.com/netbirdio/netbird/client/internal/netflow"
|
"github.com/netbirdio/netbird/client/internal/netflow"
|
||||||
nftypes "github.com/netbirdio/netbird/client/internal/netflow/types"
|
nftypes "github.com/netbirdio/netbird/client/internal/netflow/types"
|
||||||
"github.com/netbirdio/netbird/client/internal/networkmonitor"
|
"github.com/netbirdio/netbird/client/internal/networkmonitor"
|
||||||
@@ -44,22 +46,21 @@ import (
|
|||||||
"github.com/netbirdio/netbird/client/internal/peer/guard"
|
"github.com/netbirdio/netbird/client/internal/peer/guard"
|
||||||
icemaker "github.com/netbirdio/netbird/client/internal/peer/ice"
|
icemaker "github.com/netbirdio/netbird/client/internal/peer/ice"
|
||||||
"github.com/netbirdio/netbird/client/internal/peerstore"
|
"github.com/netbirdio/netbird/client/internal/peerstore"
|
||||||
|
"github.com/netbirdio/netbird/client/internal/portforward"
|
||||||
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
"github.com/netbirdio/netbird/client/internal/profilemanager"
|
||||||
"github.com/netbirdio/netbird/client/internal/relay"
|
"github.com/netbirdio/netbird/client/internal/relay"
|
||||||
"github.com/netbirdio/netbird/client/internal/rosenpass"
|
"github.com/netbirdio/netbird/client/internal/rosenpass"
|
||||||
"github.com/netbirdio/netbird/client/internal/routemanager"
|
"github.com/netbirdio/netbird/client/internal/routemanager"
|
||||||
"github.com/netbirdio/netbird/client/internal/routemanager/systemops"
|
"github.com/netbirdio/netbird/client/internal/routemanager/systemops"
|
||||||
"github.com/netbirdio/netbird/client/internal/statemanager"
|
"github.com/netbirdio/netbird/client/internal/statemanager"
|
||||||
"github.com/netbirdio/netbird/client/internal/updatemanager"
|
"github.com/netbirdio/netbird/client/internal/updater"
|
||||||
"github.com/netbirdio/netbird/client/jobexec"
|
"github.com/netbirdio/netbird/client/jobexec"
|
||||||
cProto "github.com/netbirdio/netbird/client/proto"
|
cProto "github.com/netbirdio/netbird/client/proto"
|
||||||
"github.com/netbirdio/netbird/shared/management/domain"
|
|
||||||
semaphoregroup "github.com/netbirdio/netbird/util/semaphore-group"
|
|
||||||
|
|
||||||
"github.com/netbirdio/netbird/client/system"
|
"github.com/netbirdio/netbird/client/system"
|
||||||
nbdns "github.com/netbirdio/netbird/dns"
|
nbdns "github.com/netbirdio/netbird/dns"
|
||||||
"github.com/netbirdio/netbird/route"
|
"github.com/netbirdio/netbird/route"
|
||||||
mgm "github.com/netbirdio/netbird/shared/management/client"
|
mgm "github.com/netbirdio/netbird/shared/management/client"
|
||||||
|
"github.com/netbirdio/netbird/shared/management/domain"
|
||||||
mgmProto "github.com/netbirdio/netbird/shared/management/proto"
|
mgmProto "github.com/netbirdio/netbird/shared/management/proto"
|
||||||
auth "github.com/netbirdio/netbird/shared/relay/auth/hmac"
|
auth "github.com/netbirdio/netbird/shared/relay/auth/hmac"
|
||||||
relayClient "github.com/netbirdio/netbird/shared/relay/client"
|
relayClient "github.com/netbirdio/netbird/shared/relay/client"
|
||||||
@@ -75,13 +76,11 @@ import (
|
|||||||
const (
|
const (
|
||||||
PeerConnectionTimeoutMax = 45000 // ms
|
PeerConnectionTimeoutMax = 45000 // ms
|
||||||
PeerConnectionTimeoutMin = 30000 // ms
|
PeerConnectionTimeoutMin = 30000 // ms
|
||||||
connInitLimit = 200
|
|
||||||
disableAutoUpdate = "disabled"
|
disableAutoUpdate = "disabled"
|
||||||
)
|
)
|
||||||
|
|
||||||
var ErrResetConnection = fmt.Errorf("reset connection")
|
var ErrResetConnection = fmt.Errorf("reset connection")
|
||||||
|
|
||||||
// EngineConfig is a config for the Engine
|
|
||||||
type EngineConfig struct {
|
type EngineConfig struct {
|
||||||
WgPort int
|
WgPort int
|
||||||
WgIfaceName string
|
WgIfaceName string
|
||||||
@@ -143,6 +142,18 @@ type EngineConfig struct {
|
|||||||
LogPath string
|
LogPath string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// EngineServices holds the external service dependencies required by the Engine.
|
||||||
|
type EngineServices struct {
|
||||||
|
SignalClient signal.Client
|
||||||
|
MgmClient mgm.Client
|
||||||
|
RelayManager *relayClient.Manager
|
||||||
|
StatusRecorder *peer.Status
|
||||||
|
Checks []*mgmProto.Checks
|
||||||
|
StateManager *statemanager.Manager
|
||||||
|
UpdateManager *updater.Manager
|
||||||
|
ClientMetrics *metrics.ClientMetrics
|
||||||
|
}
|
||||||
|
|
||||||
// Engine is a mechanism responsible for reacting on Signal and Management stream events and managing connections to the remote peers.
|
// Engine is a mechanism responsible for reacting on Signal and Management stream events and managing connections to the remote peers.
|
||||||
type Engine struct {
|
type Engine struct {
|
||||||
// signal is a Signal Service client
|
// signal is a Signal Service client
|
||||||
@@ -200,19 +211,19 @@ type Engine struct {
|
|||||||
// checks are the client-applied posture checks that need to be evaluated on the client
|
// checks are the client-applied posture checks that need to be evaluated on the client
|
||||||
checks []*mgmProto.Checks
|
checks []*mgmProto.Checks
|
||||||
|
|
||||||
relayManager *relayClient.Manager
|
relayManager *relayClient.Manager
|
||||||
stateManager *statemanager.Manager
|
stateManager *statemanager.Manager
|
||||||
srWatcher *guard.SRWatcher
|
portForwardManager *portforward.Manager
|
||||||
|
srWatcher *guard.SRWatcher
|
||||||
|
|
||||||
// Sync response persistence (protected by syncRespMux)
|
// Sync response persistence (protected by syncRespMux)
|
||||||
syncRespMux sync.RWMutex
|
syncRespMux sync.RWMutex
|
||||||
persistSyncResponse bool
|
persistSyncResponse bool
|
||||||
latestSyncResponse *mgmProto.SyncResponse
|
latestSyncResponse *mgmProto.SyncResponse
|
||||||
connSemaphore *semaphoregroup.SemaphoreGroup
|
|
||||||
flowManager nftypes.FlowManager
|
flowManager nftypes.FlowManager
|
||||||
|
|
||||||
// auto-update
|
// auto-update
|
||||||
updateManager *updatemanager.Manager
|
updateManager *updater.Manager
|
||||||
|
|
||||||
// WireGuard interface monitor
|
// WireGuard interface monitor
|
||||||
wgIfaceMonitor *WGIfaceMonitor
|
wgIfaceMonitor *WGIfaceMonitor
|
||||||
@@ -222,8 +233,13 @@ type Engine struct {
|
|||||||
|
|
||||||
probeStunTurn *relay.StunTurnProbe
|
probeStunTurn *relay.StunTurnProbe
|
||||||
|
|
||||||
|
// clientMetrics collects and pushes metrics
|
||||||
|
clientMetrics *metrics.ClientMetrics
|
||||||
|
|
||||||
jobExecutor *jobexec.Executor
|
jobExecutor *jobexec.Executor
|
||||||
jobExecutorWG sync.WaitGroup
|
jobExecutorWG sync.WaitGroup
|
||||||
|
|
||||||
|
exposeManager *expose.Manager
|
||||||
}
|
}
|
||||||
|
|
||||||
// Peer is an instance of the Connection Peer
|
// Peer is an instance of the Connection Peer
|
||||||
@@ -240,35 +256,32 @@ type localIpUpdater interface {
|
|||||||
func NewEngine(
|
func NewEngine(
|
||||||
clientCtx context.Context,
|
clientCtx context.Context,
|
||||||
clientCancel context.CancelFunc,
|
clientCancel context.CancelFunc,
|
||||||
signalClient signal.Client,
|
|
||||||
mgmClient mgm.Client,
|
|
||||||
relayManager *relayClient.Manager,
|
|
||||||
config *EngineConfig,
|
config *EngineConfig,
|
||||||
|
services EngineServices,
|
||||||
mobileDep MobileDependency,
|
mobileDep MobileDependency,
|
||||||
statusRecorder *peer.Status,
|
|
||||||
checks []*mgmProto.Checks,
|
|
||||||
stateManager *statemanager.Manager,
|
|
||||||
) *Engine {
|
) *Engine {
|
||||||
engine := &Engine{
|
engine := &Engine{
|
||||||
clientCtx: clientCtx,
|
clientCtx: clientCtx,
|
||||||
clientCancel: clientCancel,
|
clientCancel: clientCancel,
|
||||||
signal: signalClient,
|
signal: services.SignalClient,
|
||||||
signaler: peer.NewSignaler(signalClient, config.WgPrivateKey),
|
signaler: peer.NewSignaler(services.SignalClient, config.WgPrivateKey),
|
||||||
mgmClient: mgmClient,
|
mgmClient: services.MgmClient,
|
||||||
relayManager: relayManager,
|
relayManager: services.RelayManager,
|
||||||
peerStore: peerstore.NewConnStore(),
|
peerStore: peerstore.NewConnStore(),
|
||||||
syncMsgMux: &sync.Mutex{},
|
syncMsgMux: &sync.Mutex{},
|
||||||
config: config,
|
config: config,
|
||||||
mobileDep: mobileDep,
|
mobileDep: mobileDep,
|
||||||
STUNs: []*stun.URI{},
|
STUNs: []*stun.URI{},
|
||||||
TURNs: []*stun.URI{},
|
TURNs: []*stun.URI{},
|
||||||
networkSerial: 0,
|
networkSerial: 0,
|
||||||
statusRecorder: statusRecorder,
|
statusRecorder: services.StatusRecorder,
|
||||||
stateManager: stateManager,
|
stateManager: services.StateManager,
|
||||||
checks: checks,
|
portForwardManager: portforward.NewManager(),
|
||||||
connSemaphore: semaphoregroup.NewSemaphoreGroup(connInitLimit),
|
checks: services.Checks,
|
||||||
probeStunTurn: relay.NewStunTurnProbe(relay.DefaultCacheTTL),
|
probeStunTurn: relay.NewStunTurnProbe(relay.DefaultCacheTTL),
|
||||||
jobExecutor: jobexec.NewExecutor(),
|
jobExecutor: jobexec.NewExecutor(),
|
||||||
|
clientMetrics: services.ClientMetrics,
|
||||||
|
updateManager: services.UpdateManager,
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Infof("I am: %s", config.WgPrivateKey.PublicKey().String())
|
log.Infof("I am: %s", config.WgPrivateKey.PublicKey().String())
|
||||||
@@ -311,7 +324,7 @@ func (e *Engine) Stop() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if e.updateManager != nil {
|
if e.updateManager != nil {
|
||||||
e.updateManager.Stop()
|
e.updateManager.SetDownloadOnly()
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Info("cleaning up status recorder states")
|
log.Info("cleaning up status recorder states")
|
||||||
@@ -419,6 +432,7 @@ func (e *Engine) Start(netbirdConfig *mgmProto.NetbirdConfig, mgmtURL *url.URL)
|
|||||||
e.cancel()
|
e.cancel()
|
||||||
}
|
}
|
||||||
e.ctx, e.cancel = context.WithCancel(e.clientCtx)
|
e.ctx, e.cancel = context.WithCancel(e.clientCtx)
|
||||||
|
e.exposeManager = expose.NewManager(e.ctx, e.mgmClient)
|
||||||
|
|
||||||
wgIface, err := e.newWgIface()
|
wgIface, err := e.newWgIface()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -488,6 +502,17 @@ func (e *Engine) Start(netbirdConfig *mgmProto.NetbirdConfig, mgmtURL *url.URL)
|
|||||||
|
|
||||||
e.routeManager.SetRouteChangeListener(e.mobileDep.NetworkChangeListener)
|
e.routeManager.SetRouteChangeListener(e.mobileDep.NetworkChangeListener)
|
||||||
|
|
||||||
|
e.dnsServer.SetRouteChecker(func(ip netip.Addr) bool {
|
||||||
|
for _, routes := range e.routeManager.GetSelectedClientRoutes() {
|
||||||
|
for _, r := range routes {
|
||||||
|
if r.Network.Contains(ip) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
})
|
||||||
|
|
||||||
if err = e.wgInterfaceCreate(); err != nil {
|
if err = e.wgInterfaceCreate(); err != nil {
|
||||||
log.Errorf("failed creating tunnel interface %s: [%s]", e.config.WgIfaceName, err.Error())
|
log.Errorf("failed creating tunnel interface %s: [%s]", e.config.WgIfaceName, err.Error())
|
||||||
e.close()
|
e.close()
|
||||||
@@ -499,6 +524,11 @@ func (e *Engine) Start(netbirdConfig *mgmProto.NetbirdConfig, mgmtURL *url.URL)
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Inject firewall into DNS server now that it's available.
|
||||||
|
// The DNS server is created before the firewall because the route manager
|
||||||
|
// depends on the DNS server, and the firewall depends on the wg interface.
|
||||||
|
e.dnsServer.SetFirewall(e.firewall)
|
||||||
|
|
||||||
e.udpMux, err = e.wgInterface.Up()
|
e.udpMux, err = e.wgInterface.Up()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Errorf("failed to pull up wgInterface [%s]: %s", e.wgInterface.Name(), err.Error())
|
log.Errorf("failed to pull up wgInterface [%s]: %s", e.wgInterface.Name(), err.Error())
|
||||||
@@ -510,6 +540,13 @@ func (e *Engine) Start(netbirdConfig *mgmProto.NetbirdConfig, mgmtURL *url.URL)
|
|||||||
// conntrack entries from being created before the rules are in place
|
// conntrack entries from being created before the rules are in place
|
||||||
e.setupWGProxyNoTrack()
|
e.setupWGProxyNoTrack()
|
||||||
|
|
||||||
|
// Start after interface is up since port may have been resolved from 0 or changed if occupied
|
||||||
|
e.shutdownWg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer e.shutdownWg.Done()
|
||||||
|
e.portForwardManager.Start(e.ctx, uint16(e.config.WgPort))
|
||||||
|
}()
|
||||||
|
|
||||||
// Set the WireGuard interface for rosenpass after interface is up
|
// Set the WireGuard interface for rosenpass after interface is up
|
||||||
if e.rpManager != nil {
|
if e.rpManager != nil {
|
||||||
e.rpManager.SetInterface(e.wgInterface)
|
e.rpManager.SetInterface(e.wgInterface)
|
||||||
@@ -560,13 +597,6 @@ func (e *Engine) Start(netbirdConfig *mgmProto.NetbirdConfig, mgmtURL *url.URL)
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (e *Engine) InitialUpdateHandling(autoUpdateSettings *mgmProto.AutoUpdateSettings) {
|
|
||||||
e.syncMsgMux.Lock()
|
|
||||||
defer e.syncMsgMux.Unlock()
|
|
||||||
|
|
||||||
e.handleAutoUpdateVersion(autoUpdateSettings, true)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Engine) createFirewall() error {
|
func (e *Engine) createFirewall() error {
|
||||||
if e.config.DisableFirewall {
|
if e.config.DisableFirewall {
|
||||||
log.Infof("firewall is disabled")
|
log.Infof("firewall is disabled")
|
||||||
@@ -794,45 +824,30 @@ func (e *Engine) PopulateNetbirdConfig(netbirdConfig *mgmProto.NetbirdConfig, mg
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (e *Engine) handleAutoUpdateVersion(autoUpdateSettings *mgmProto.AutoUpdateSettings, initialCheck bool) {
|
func (e *Engine) handleAutoUpdateVersion(autoUpdateSettings *mgmProto.AutoUpdateSettings) {
|
||||||
|
if e.updateManager == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
if autoUpdateSettings == nil {
|
if autoUpdateSettings == nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
disabled := autoUpdateSettings.Version == disableAutoUpdate
|
if autoUpdateSettings.Version == disableAutoUpdate {
|
||||||
|
log.Infof("auto-update is disabled")
|
||||||
// Stop and cleanup if disabled
|
e.updateManager.SetDownloadOnly()
|
||||||
if e.updateManager != nil && disabled {
|
|
||||||
log.Infof("auto-update is disabled, stopping update manager")
|
|
||||||
e.updateManager.Stop()
|
|
||||||
e.updateManager = nil
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Skip check unless AlwaysUpdate is enabled or this is the initial check at startup
|
e.updateManager.SetVersion(autoUpdateSettings.Version, autoUpdateSettings.AlwaysUpdate)
|
||||||
if !autoUpdateSettings.AlwaysUpdate && !initialCheck {
|
|
||||||
log.Debugf("skipping auto-update check, AlwaysUpdate is false and this is not the initial check")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Start manager if needed
|
|
||||||
if e.updateManager == nil {
|
|
||||||
log.Infof("starting auto-update manager")
|
|
||||||
updateManager, err := updatemanager.NewManager(e.statusRecorder, e.stateManager)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
e.updateManager = updateManager
|
|
||||||
e.updateManager.Start(e.ctx)
|
|
||||||
}
|
|
||||||
log.Infof("handling auto-update version: %s", autoUpdateSettings.Version)
|
|
||||||
e.updateManager.SetVersion(autoUpdateSettings.Version)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (e *Engine) handleSync(update *mgmProto.SyncResponse) error {
|
func (e *Engine) handleSync(update *mgmProto.SyncResponse) error {
|
||||||
started := time.Now()
|
started := time.Now()
|
||||||
defer func() {
|
defer func() {
|
||||||
log.Infof("sync finished in %s", time.Since(started))
|
duration := time.Since(started)
|
||||||
|
log.Infof("sync finished in %s", duration)
|
||||||
|
e.clientMetrics.RecordSyncDuration(e.ctx, duration)
|
||||||
}()
|
}()
|
||||||
e.syncMsgMux.Lock()
|
e.syncMsgMux.Lock()
|
||||||
defer e.syncMsgMux.Unlock()
|
defer e.syncMsgMux.Unlock()
|
||||||
@@ -843,7 +858,7 @@ func (e *Engine) handleSync(update *mgmProto.SyncResponse) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if update.NetworkMap != nil && update.NetworkMap.PeerConfig != nil {
|
if update.NetworkMap != nil && update.NetworkMap.PeerConfig != nil {
|
||||||
e.handleAutoUpdateVersion(update.NetworkMap.PeerConfig.AutoUpdate, false)
|
e.handleAutoUpdateVersion(update.NetworkMap.PeerConfig.AutoUpdate)
|
||||||
}
|
}
|
||||||
|
|
||||||
if update.GetNetbirdConfig() != nil {
|
if update.GetNetbirdConfig() != nil {
|
||||||
@@ -1008,10 +1023,11 @@ func (e *Engine) updateConfig(conf *mgmProto.PeerConfig) error {
|
|||||||
return errors.New("wireguard interface is not initialized")
|
return errors.New("wireguard interface is not initialized")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Cannot update the IP address without restarting the engine because
|
|
||||||
// the firewall, route manager, and other components cache the old address
|
|
||||||
if e.wgInterface.Address().String() != conf.Address {
|
if e.wgInterface.Address().String() != conf.Address {
|
||||||
log.Infof("peer IP address has changed from %s to %s", e.wgInterface.Address().String(), conf.Address)
|
log.Infof("peer IP address changed from %s to %s, restarting client", e.wgInterface.Address().String(), conf.Address)
|
||||||
|
_ = CtxGetState(e.ctx).Wrap(ErrResetConnection)
|
||||||
|
e.clientCancel()
|
||||||
|
return ErrResetConnection
|
||||||
}
|
}
|
||||||
|
|
||||||
if conf.GetSshConfig() != nil {
|
if conf.GetSshConfig() != nil {
|
||||||
@@ -1079,6 +1095,7 @@ func (e *Engine) handleBundle(params *mgmProto.BundleParameters) (*mgmProto.JobR
|
|||||||
StatusRecorder: e.statusRecorder,
|
StatusRecorder: e.statusRecorder,
|
||||||
SyncResponse: syncResponse,
|
SyncResponse: syncResponse,
|
||||||
LogPath: e.config.LogPath,
|
LogPath: e.config.LogPath,
|
||||||
|
ClientMetrics: e.clientMetrics,
|
||||||
RefreshStatus: func() {
|
RefreshStatus: func() {
|
||||||
e.RunHealthProbes(true)
|
e.RunHealthProbes(true)
|
||||||
},
|
},
|
||||||
@@ -1316,8 +1333,7 @@ func (e *Engine) updateNetworkMap(networkMap *mgmProto.NetworkMap) error {
|
|||||||
|
|
||||||
// Test received (upstream) servers for availability right away instead of upon usage.
|
// Test received (upstream) servers for availability right away instead of upon usage.
|
||||||
// If no server of a server group responds this will disable the respective handler and retry later.
|
// If no server of a server group responds this will disable the respective handler and retry later.
|
||||||
e.dnsServer.ProbeAvailability()
|
go e.dnsServer.ProbeAvailability()
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1534,12 +1550,13 @@ func (e *Engine) createPeerConn(pubKey string, allowedIPs []netip.Prefix, agentV
|
|||||||
}
|
}
|
||||||
|
|
||||||
serviceDependencies := peer.ServiceDependencies{
|
serviceDependencies := peer.ServiceDependencies{
|
||||||
StatusRecorder: e.statusRecorder,
|
StatusRecorder: e.statusRecorder,
|
||||||
Signaler: e.signaler,
|
Signaler: e.signaler,
|
||||||
IFaceDiscover: e.mobileDep.IFaceDiscover,
|
IFaceDiscover: e.mobileDep.IFaceDiscover,
|
||||||
RelayManager: e.relayManager,
|
RelayManager: e.relayManager,
|
||||||
SrWatcher: e.srWatcher,
|
SrWatcher: e.srWatcher,
|
||||||
Semaphore: e.connSemaphore,
|
PortForwardManager: e.portForwardManager,
|
||||||
|
MetricsRecorder: e.clientMetrics,
|
||||||
}
|
}
|
||||||
peerConn, err := peer.NewConn(config, serviceDependencies)
|
peerConn, err := peer.NewConn(config, serviceDependencies)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -1562,8 +1579,10 @@ func (e *Engine) receiveSignalEvents() {
|
|||||||
defer e.shutdownWg.Done()
|
defer e.shutdownWg.Done()
|
||||||
// connect to a stream of messages coming from the signal server
|
// connect to a stream of messages coming from the signal server
|
||||||
err := e.signal.Receive(e.ctx, func(msg *sProto.Message) error {
|
err := e.signal.Receive(e.ctx, func(msg *sProto.Message) error {
|
||||||
|
start := time.Now()
|
||||||
e.syncMsgMux.Lock()
|
e.syncMsgMux.Lock()
|
||||||
defer e.syncMsgMux.Unlock()
|
defer e.syncMsgMux.Unlock()
|
||||||
|
gotLock := time.Since(start)
|
||||||
|
|
||||||
// Check context INSIDE lock to ensure atomicity with shutdown
|
// Check context INSIDE lock to ensure atomicity with shutdown
|
||||||
if e.ctx.Err() != nil {
|
if e.ctx.Err() != nil {
|
||||||
@@ -1587,6 +1606,8 @@ func (e *Engine) receiveSignalEvents() {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
log.Debugf("receiveMSG: took %s to get lock for peer %s with session id %s", gotLock, msg.Key, offerAnswer.SessionID)
|
||||||
|
|
||||||
if msg.Body.Type == sProto.Body_OFFER {
|
if msg.Body.Type == sProto.Body_OFFER {
|
||||||
conn.OnRemoteOffer(*offerAnswer)
|
conn.OnRemoteOffer(*offerAnswer)
|
||||||
} else {
|
} else {
|
||||||
@@ -1692,6 +1713,12 @@ func (e *Engine) close() {
|
|||||||
if e.rpManager != nil {
|
if e.rpManager != nil {
|
||||||
_ = e.rpManager.Close()
|
_ = e.rpManager.Close()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
if err := e.portForwardManager.GracefullyStop(ctx); err != nil {
|
||||||
|
log.Warnf("failed to gracefully stop port forwarding manager: %s", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (e *Engine) readInitialSettings() ([]*route.Route, *nbdns.Config, bool, error) {
|
func (e *Engine) readInitialSettings() ([]*route.Route, *nbdns.Config, bool, error) {
|
||||||
@@ -1795,7 +1822,7 @@ func (e *Engine) newDnsServer(dnsConfig *nbdns.Config) (dns.Server, error) {
|
|||||||
return dnsServer, nil
|
return dnsServer, nil
|
||||||
|
|
||||||
case "ios":
|
case "ios":
|
||||||
dnsServer := dns.NewDefaultServerIos(e.ctx, e.wgInterface, e.mobileDep.DnsManager, e.statusRecorder, e.config.DisableDNS)
|
dnsServer := dns.NewDefaultServerIos(e.ctx, e.wgInterface, e.mobileDep.DnsManager, e.mobileDep.HostDNSAddresses, e.statusRecorder, e.config.DisableDNS)
|
||||||
return dnsServer, nil
|
return dnsServer, nil
|
||||||
|
|
||||||
default:
|
default:
|
||||||
@@ -1820,11 +1847,28 @@ func (e *Engine) GetRouteManager() routemanager.Manager {
|
|||||||
return e.routeManager
|
return e.routeManager
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetFirewallManager returns the firewall manager
|
// GetFirewallManager returns the firewall manager.
|
||||||
func (e *Engine) GetFirewallManager() firewallManager.Manager {
|
func (e *Engine) GetFirewallManager() firewallManager.Manager {
|
||||||
return e.firewall
|
return e.firewall
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetExposeManager returns the expose session manager.
|
||||||
|
func (e *Engine) GetExposeManager() *expose.Manager {
|
||||||
|
e.syncMsgMux.Lock()
|
||||||
|
defer e.syncMsgMux.Unlock()
|
||||||
|
return e.exposeManager
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsBlockInbound returns whether inbound connections are blocked.
|
||||||
|
func (e *Engine) IsBlockInbound() bool {
|
||||||
|
return e.config.BlockInbound
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetClientMetrics returns the client metrics
|
||||||
|
func (e *Engine) GetClientMetrics() *metrics.ClientMetrics {
|
||||||
|
return e.clientMetrics
|
||||||
|
}
|
||||||
|
|
||||||
func findIPFromInterfaceName(ifaceName string) (net.IP, error) {
|
func findIPFromInterfaceName(ifaceName string) (net.IP, error) {
|
||||||
iface, err := net.InterfaceByName(ifaceName)
|
iface, err := net.InterfaceByName(ifaceName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -55,6 +55,7 @@ import (
|
|||||||
nbdns "github.com/netbirdio/netbird/dns"
|
nbdns "github.com/netbirdio/netbird/dns"
|
||||||
"github.com/netbirdio/netbird/management/server"
|
"github.com/netbirdio/netbird/management/server"
|
||||||
"github.com/netbirdio/netbird/management/server/activity"
|
"github.com/netbirdio/netbird/management/server/activity"
|
||||||
|
nbcache "github.com/netbirdio/netbird/management/server/cache"
|
||||||
"github.com/netbirdio/netbird/management/server/integrations/port_forwarding"
|
"github.com/netbirdio/netbird/management/server/integrations/port_forwarding"
|
||||||
"github.com/netbirdio/netbird/management/server/permissions"
|
"github.com/netbirdio/netbird/management/server/permissions"
|
||||||
"github.com/netbirdio/netbird/management/server/settings"
|
"github.com/netbirdio/netbird/management/server/settings"
|
||||||
@@ -251,9 +252,6 @@ func TestEngine_SSH(t *testing.T) {
|
|||||||
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
||||||
engine := NewEngine(
|
engine := NewEngine(
|
||||||
ctx, cancel,
|
ctx, cancel,
|
||||||
&signal.MockClient{},
|
|
||||||
&mgmt.MockClient{},
|
|
||||||
relayMgr,
|
|
||||||
&EngineConfig{
|
&EngineConfig{
|
||||||
WgIfaceName: "utun101",
|
WgIfaceName: "utun101",
|
||||||
WgAddr: "100.64.0.1/24",
|
WgAddr: "100.64.0.1/24",
|
||||||
@@ -263,10 +261,13 @@ func TestEngine_SSH(t *testing.T) {
|
|||||||
MTU: iface.DefaultMTU,
|
MTU: iface.DefaultMTU,
|
||||||
SSHKey: sshKey,
|
SSHKey: sshKey,
|
||||||
},
|
},
|
||||||
|
EngineServices{
|
||||||
|
SignalClient: &signal.MockClient{},
|
||||||
|
MgmClient: &mgmt.MockClient{},
|
||||||
|
RelayManager: relayMgr,
|
||||||
|
StatusRecorder: peer.NewRecorder("https://mgm"),
|
||||||
|
},
|
||||||
MobileDependency{},
|
MobileDependency{},
|
||||||
peer.NewRecorder("https://mgm"),
|
|
||||||
nil,
|
|
||||||
nil,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
engine.dnsServer = &dns.MockServer{
|
engine.dnsServer = &dns.MockServer{
|
||||||
@@ -428,13 +429,18 @@ func TestEngine_UpdateNetworkMap(t *testing.T) {
|
|||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
||||||
engine := NewEngine(ctx, cancel, &signal.MockClient{}, &mgmt.MockClient{}, relayMgr, &EngineConfig{
|
engine := NewEngine(ctx, cancel, &EngineConfig{
|
||||||
WgIfaceName: "utun102",
|
WgIfaceName: "utun102",
|
||||||
WgAddr: "100.64.0.1/24",
|
WgAddr: "100.64.0.1/24",
|
||||||
WgPrivateKey: key,
|
WgPrivateKey: key,
|
||||||
WgPort: 33100,
|
WgPort: 33100,
|
||||||
MTU: iface.DefaultMTU,
|
MTU: iface.DefaultMTU,
|
||||||
}, MobileDependency{}, peer.NewRecorder("https://mgm"), nil, nil)
|
}, EngineServices{
|
||||||
|
SignalClient: &signal.MockClient{},
|
||||||
|
MgmClient: &mgmt.MockClient{},
|
||||||
|
RelayManager: relayMgr,
|
||||||
|
StatusRecorder: peer.NewRecorder("https://mgm"),
|
||||||
|
}, MobileDependency{})
|
||||||
|
|
||||||
wgIface := &MockWGIface{
|
wgIface := &MockWGIface{
|
||||||
NameFunc: func() string { return "utun102" },
|
NameFunc: func() string { return "utun102" },
|
||||||
@@ -647,13 +653,18 @@ func TestEngine_Sync(t *testing.T) {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
||||||
engine := NewEngine(ctx, cancel, &signal.MockClient{}, &mgmt.MockClient{SyncFunc: syncFunc}, relayMgr, &EngineConfig{
|
engine := NewEngine(ctx, cancel, &EngineConfig{
|
||||||
WgIfaceName: "utun103",
|
WgIfaceName: "utun103",
|
||||||
WgAddr: "100.64.0.1/24",
|
WgAddr: "100.64.0.1/24",
|
||||||
WgPrivateKey: key,
|
WgPrivateKey: key,
|
||||||
WgPort: 33100,
|
WgPort: 33100,
|
||||||
MTU: iface.DefaultMTU,
|
MTU: iface.DefaultMTU,
|
||||||
}, MobileDependency{}, peer.NewRecorder("https://mgm"), nil, nil)
|
}, EngineServices{
|
||||||
|
SignalClient: &signal.MockClient{},
|
||||||
|
MgmClient: &mgmt.MockClient{SyncFunc: syncFunc},
|
||||||
|
RelayManager: relayMgr,
|
||||||
|
StatusRecorder: peer.NewRecorder("https://mgm"),
|
||||||
|
}, MobileDependency{})
|
||||||
engine.ctx = ctx
|
engine.ctx = ctx
|
||||||
|
|
||||||
engine.dnsServer = &dns.MockServer{
|
engine.dnsServer = &dns.MockServer{
|
||||||
@@ -812,13 +823,18 @@ func TestEngine_UpdateNetworkMapWithRoutes(t *testing.T) {
|
|||||||
wgAddr := fmt.Sprintf("100.66.%d.1/24", n)
|
wgAddr := fmt.Sprintf("100.66.%d.1/24", n)
|
||||||
|
|
||||||
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
||||||
engine := NewEngine(ctx, cancel, &signal.MockClient{}, &mgmt.MockClient{}, relayMgr, &EngineConfig{
|
engine := NewEngine(ctx, cancel, &EngineConfig{
|
||||||
WgIfaceName: wgIfaceName,
|
WgIfaceName: wgIfaceName,
|
||||||
WgAddr: wgAddr,
|
WgAddr: wgAddr,
|
||||||
WgPrivateKey: key,
|
WgPrivateKey: key,
|
||||||
WgPort: 33100,
|
WgPort: 33100,
|
||||||
MTU: iface.DefaultMTU,
|
MTU: iface.DefaultMTU,
|
||||||
}, MobileDependency{}, peer.NewRecorder("https://mgm"), nil, nil)
|
}, EngineServices{
|
||||||
|
SignalClient: &signal.MockClient{},
|
||||||
|
MgmClient: &mgmt.MockClient{},
|
||||||
|
RelayManager: relayMgr,
|
||||||
|
StatusRecorder: peer.NewRecorder("https://mgm"),
|
||||||
|
}, MobileDependency{})
|
||||||
engine.ctx = ctx
|
engine.ctx = ctx
|
||||||
newNet, err := stdnet.NewNet(context.Background(), nil)
|
newNet, err := stdnet.NewNet(context.Background(), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -1014,13 +1030,18 @@ func TestEngine_UpdateNetworkMapWithDNSUpdate(t *testing.T) {
|
|||||||
wgAddr := fmt.Sprintf("100.66.%d.1/24", n)
|
wgAddr := fmt.Sprintf("100.66.%d.1/24", n)
|
||||||
|
|
||||||
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
||||||
engine := NewEngine(ctx, cancel, &signal.MockClient{}, &mgmt.MockClient{}, relayMgr, &EngineConfig{
|
engine := NewEngine(ctx, cancel, &EngineConfig{
|
||||||
WgIfaceName: wgIfaceName,
|
WgIfaceName: wgIfaceName,
|
||||||
WgAddr: wgAddr,
|
WgAddr: wgAddr,
|
||||||
WgPrivateKey: key,
|
WgPrivateKey: key,
|
||||||
WgPort: 33100,
|
WgPort: 33100,
|
||||||
MTU: iface.DefaultMTU,
|
MTU: iface.DefaultMTU,
|
||||||
}, MobileDependency{}, peer.NewRecorder("https://mgm"), nil, nil)
|
}, EngineServices{
|
||||||
|
SignalClient: &signal.MockClient{},
|
||||||
|
MgmClient: &mgmt.MockClient{},
|
||||||
|
RelayManager: relayMgr,
|
||||||
|
StatusRecorder: peer.NewRecorder("https://mgm"),
|
||||||
|
}, MobileDependency{})
|
||||||
engine.ctx = ctx
|
engine.ctx = ctx
|
||||||
|
|
||||||
newNet, err := stdnet.NewNet(context.Background(), nil)
|
newNet, err := stdnet.NewNet(context.Background(), nil)
|
||||||
@@ -1518,13 +1539,8 @@ func createEngine(ctx context.Context, cancel context.CancelFunc, setupKey strin
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
publicKey, err := mgmtClient.GetServerPublicKey()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
info := system.GetInfo(ctx)
|
info := system.GetInfo(ctx)
|
||||||
resp, err := mgmtClient.Register(*publicKey, setupKey, "", info, nil, nil)
|
resp, err := mgmtClient.Register(setupKey, "", info, nil, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -1546,7 +1562,12 @@ func createEngine(ctx context.Context, cancel context.CancelFunc, setupKey strin
|
|||||||
}
|
}
|
||||||
|
|
||||||
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
relayMgr := relayClient.NewManager(ctx, nil, key.PublicKey().String(), iface.DefaultMTU)
|
||||||
e, err := NewEngine(ctx, cancel, signalClient, mgmtClient, relayMgr, conf, MobileDependency{}, peer.NewRecorder("https://mgm"), nil, nil), nil
|
e, err := NewEngine(ctx, cancel, conf, EngineServices{
|
||||||
|
SignalClient: signalClient,
|
||||||
|
MgmClient: mgmtClient,
|
||||||
|
RelayManager: relayMgr,
|
||||||
|
StatusRecorder: peer.NewRecorder("https://mgm"),
|
||||||
|
}, MobileDependency{}), nil
|
||||||
e.ctx = ctx
|
e.ctx = ctx
|
||||||
return e, err
|
return e, err
|
||||||
}
|
}
|
||||||
@@ -1614,7 +1635,12 @@ func startManagement(t *testing.T, dataDir, testFile string) (*grpc.Server, stri
|
|||||||
peersManager := peers.NewManager(store, permissionsManager)
|
peersManager := peers.NewManager(store, permissionsManager)
|
||||||
jobManager := job.NewJobManager(nil, store, peersManager)
|
jobManager := job.NewJobManager(nil, store, peersManager)
|
||||||
|
|
||||||
ia, _ := integrations.NewIntegratedValidator(context.Background(), peersManager, nil, eventStore)
|
cacheStore, err := nbcache.NewStore(context.Background(), 100*time.Millisecond, 300*time.Millisecond, 100)
|
||||||
|
if err != nil {
|
||||||
|
return nil, "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
ia, _ := integrations.NewIntegratedValidator(context.Background(), peersManager, nil, eventStore, cacheStore)
|
||||||
|
|
||||||
metrics, err := telemetry.NewDefaultAppMetrics(context.Background())
|
metrics, err := telemetry.NewDefaultAppMetrics(context.Background())
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
@@ -1636,7 +1662,7 @@ func startManagement(t *testing.T, dataDir, testFile string) (*grpc.Server, stri
|
|||||||
updateManager := update_channel.NewPeersUpdateManager(metrics)
|
updateManager := update_channel.NewPeersUpdateManager(metrics)
|
||||||
requestBuffer := server.NewAccountRequestBuffer(context.Background(), store)
|
requestBuffer := server.NewAccountRequestBuffer(context.Background(), store)
|
||||||
networkMapController := controller.NewController(context.Background(), store, metrics, updateManager, requestBuffer, server.MockIntegratedValidator{}, settingsMockManager, "netbird.selfhosted", port_forwarding.NewControllerMock(), manager.NewEphemeralManager(store, peersManager), config)
|
networkMapController := controller.NewController(context.Background(), store, metrics, updateManager, requestBuffer, server.MockIntegratedValidator{}, settingsMockManager, "netbird.selfhosted", port_forwarding.NewControllerMock(), manager.NewEphemeralManager(store, peersManager), config)
|
||||||
accountManager, err := server.BuildManager(context.Background(), config, store, networkMapController, jobManager, nil, "", eventStore, nil, false, ia, metrics, port_forwarding.NewControllerMock(), settingsMockManager, permissionsManager, false)
|
accountManager, err := server.BuildManager(context.Background(), config, store, networkMapController, jobManager, nil, "", eventStore, nil, false, ia, metrics, port_forwarding.NewControllerMock(), settingsMockManager, permissionsManager, false, cacheStore)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, "", err
|
return nil, "", err
|
||||||
}
|
}
|
||||||
|
|||||||
104
client/internal/expose/manager.go
Normal file
104
client/internal/expose/manager.go
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
package expose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
log "github.com/sirupsen/logrus"
|
||||||
|
|
||||||
|
mgm "github.com/netbirdio/netbird/shared/management/client"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
renewTimeout = 10 * time.Second
|
||||||
|
)
|
||||||
|
|
||||||
|
// Response holds the response from exposing a service.
|
||||||
|
type Response struct {
|
||||||
|
ServiceName string
|
||||||
|
ServiceURL string
|
||||||
|
Domain string
|
||||||
|
PortAutoAssigned bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Request holds the parameters for exposing a local service via the management server.
|
||||||
|
// It is part of the embed API surface and exposed via a type alias.
|
||||||
|
type Request struct {
|
||||||
|
NamePrefix string
|
||||||
|
Domain string
|
||||||
|
Port uint16
|
||||||
|
Protocol ProtocolType
|
||||||
|
Pin string
|
||||||
|
Password string
|
||||||
|
UserGroups []string
|
||||||
|
ListenPort uint16
|
||||||
|
}
|
||||||
|
|
||||||
|
type ManagementClient interface {
|
||||||
|
CreateExpose(ctx context.Context, req mgm.ExposeRequest) (*mgm.ExposeResponse, error)
|
||||||
|
RenewExpose(ctx context.Context, domain string) error
|
||||||
|
StopExpose(ctx context.Context, domain string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// Manager handles expose session lifecycle via the management client.
|
||||||
|
type Manager struct {
|
||||||
|
mgmClient ManagementClient
|
||||||
|
ctx context.Context
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewManager creates a new expose Manager using the given management client.
|
||||||
|
func NewManager(ctx context.Context, mgmClient ManagementClient) *Manager {
|
||||||
|
return &Manager{mgmClient: mgmClient, ctx: ctx}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Expose creates a new expose session via the management server.
|
||||||
|
func (m *Manager) Expose(ctx context.Context, req Request) (*Response, error) {
|
||||||
|
log.Infof("exposing service on port %d", req.Port)
|
||||||
|
resp, err := m.mgmClient.CreateExpose(ctx, toClientExposeRequest(req))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Infof("expose session created for %s", resp.Domain)
|
||||||
|
|
||||||
|
return fromClientExposeResponse(resp), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeepAlive periodically renews the expose session for the given domain until the context is canceled or an error occurs.
|
||||||
|
// It is part of the embed API surface and exposed via a type alias.
|
||||||
|
func (m *Manager) KeepAlive(ctx context.Context, domain string) error {
|
||||||
|
ticker := time.NewTicker(30 * time.Second)
|
||||||
|
defer ticker.Stop()
|
||||||
|
defer m.stop(domain)
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
log.Infof("context canceled, stopping keep alive for %s", domain)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
case <-ticker.C:
|
||||||
|
if err := m.renew(ctx, domain); err != nil {
|
||||||
|
log.Errorf("renewing expose session for %s: %v", domain, err)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// renew extends the TTL of an active expose session.
|
||||||
|
func (m *Manager) renew(ctx context.Context, domain string) error {
|
||||||
|
renewCtx, cancel := context.WithTimeout(ctx, renewTimeout)
|
||||||
|
defer cancel()
|
||||||
|
return m.mgmClient.RenewExpose(renewCtx, domain)
|
||||||
|
}
|
||||||
|
|
||||||
|
// stop terminates an active expose session.
|
||||||
|
func (m *Manager) stop(domain string) {
|
||||||
|
stopCtx, cancel := context.WithTimeout(m.ctx, renewTimeout)
|
||||||
|
defer cancel()
|
||||||
|
err := m.mgmClient.StopExpose(stopCtx, domain)
|
||||||
|
if err != nil {
|
||||||
|
log.Warnf("Failed stopping expose session for %s: %v", domain, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
95
client/internal/expose/manager_test.go
Normal file
95
client/internal/expose/manager_test.go
Normal file
@@ -0,0 +1,95 @@
|
|||||||
|
package expose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
daemonProto "github.com/netbirdio/netbird/client/proto"
|
||||||
|
mgm "github.com/netbirdio/netbird/shared/management/client"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestManager_Expose_Success(t *testing.T) {
|
||||||
|
mock := &mgm.MockClient{
|
||||||
|
CreateExposeFunc: func(ctx context.Context, req mgm.ExposeRequest) (*mgm.ExposeResponse, error) {
|
||||||
|
return &mgm.ExposeResponse{
|
||||||
|
ServiceName: "my-service",
|
||||||
|
ServiceURL: "https://my-service.example.com",
|
||||||
|
Domain: "my-service.example.com",
|
||||||
|
}, nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
m := NewManager(context.Background(), mock)
|
||||||
|
result, err := m.Expose(context.Background(), Request{Port: 8080})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "my-service", result.ServiceName, "service name should match")
|
||||||
|
assert.Equal(t, "https://my-service.example.com", result.ServiceURL, "service URL should match")
|
||||||
|
assert.Equal(t, "my-service.example.com", result.Domain, "domain should match")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestManager_Expose_Error(t *testing.T) {
|
||||||
|
mock := &mgm.MockClient{
|
||||||
|
CreateExposeFunc: func(ctx context.Context, req mgm.ExposeRequest) (*mgm.ExposeResponse, error) {
|
||||||
|
return nil, errors.New("permission denied")
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
m := NewManager(context.Background(), mock)
|
||||||
|
_, err := m.Expose(context.Background(), Request{Port: 8080})
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "permission denied", "error should propagate")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestManager_Renew_Success(t *testing.T) {
|
||||||
|
mock := &mgm.MockClient{
|
||||||
|
RenewExposeFunc: func(ctx context.Context, domain string) error {
|
||||||
|
assert.Equal(t, "my-service.example.com", domain, "domain should be passed through")
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
m := NewManager(context.Background(), mock)
|
||||||
|
err := m.renew(context.Background(), "my-service.example.com")
|
||||||
|
require.NoError(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestManager_Renew_Timeout(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
mock := &mgm.MockClient{
|
||||||
|
RenewExposeFunc: func(ctx context.Context, domain string) error {
|
||||||
|
return ctx.Err()
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
m := NewManager(ctx, mock)
|
||||||
|
err := m.renew(ctx, "my-service.example.com")
|
||||||
|
require.Error(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewRequest(t *testing.T) {
|
||||||
|
req := &daemonProto.ExposeServiceRequest{
|
||||||
|
Port: 8080,
|
||||||
|
Protocol: daemonProto.ExposeProtocol_EXPOSE_HTTPS,
|
||||||
|
Pin: "123456",
|
||||||
|
Password: "secret",
|
||||||
|
UserGroups: []string{"group1", "group2"},
|
||||||
|
Domain: "custom.example.com",
|
||||||
|
NamePrefix: "my-prefix",
|
||||||
|
}
|
||||||
|
|
||||||
|
exposeReq := NewRequest(req)
|
||||||
|
|
||||||
|
assert.Equal(t, uint16(8080), exposeReq.Port, "port should match")
|
||||||
|
assert.Equal(t, ProtocolType(daemonProto.ExposeProtocol_EXPOSE_HTTPS), exposeReq.Protocol, "protocol should match")
|
||||||
|
assert.Equal(t, "123456", exposeReq.Pin, "pin should match")
|
||||||
|
assert.Equal(t, "secret", exposeReq.Password, "password should match")
|
||||||
|
assert.Equal(t, []string{"group1", "group2"}, exposeReq.UserGroups, "user groups should match")
|
||||||
|
assert.Equal(t, "custom.example.com", exposeReq.Domain, "domain should match")
|
||||||
|
assert.Equal(t, "my-prefix", exposeReq.NamePrefix, "name prefix should match")
|
||||||
|
}
|
||||||
40
client/internal/expose/protocol.go
Normal file
40
client/internal/expose/protocol.go
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
package expose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ProtocolType represents the protocol used for exposing a service.
|
||||||
|
type ProtocolType int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ProtocolHTTP exposes the service as HTTP.
|
||||||
|
ProtocolHTTP ProtocolType = 0
|
||||||
|
// ProtocolHTTPS exposes the service as HTTPS.
|
||||||
|
ProtocolHTTPS ProtocolType = 1
|
||||||
|
// ProtocolTCP exposes the service as TCP.
|
||||||
|
ProtocolTCP ProtocolType = 2
|
||||||
|
// ProtocolUDP exposes the service as UDP.
|
||||||
|
ProtocolUDP ProtocolType = 3
|
||||||
|
// ProtocolTLS exposes the service as TLS.
|
||||||
|
ProtocolTLS ProtocolType = 4
|
||||||
|
)
|
||||||
|
|
||||||
|
// ParseProtocolType parses a protocol string into a ProtocolType.
|
||||||
|
func ParseProtocolType(s string) (ProtocolType, error) {
|
||||||
|
switch strings.ToLower(s) {
|
||||||
|
case "http":
|
||||||
|
return ProtocolHTTP, nil
|
||||||
|
case "https":
|
||||||
|
return ProtocolHTTPS, nil
|
||||||
|
case "tcp":
|
||||||
|
return ProtocolTCP, nil
|
||||||
|
case "udp":
|
||||||
|
return ProtocolUDP, nil
|
||||||
|
case "tls":
|
||||||
|
return ProtocolTLS, nil
|
||||||
|
default:
|
||||||
|
return 0, fmt.Errorf("unsupported protocol %q: must be http, https, tcp, udp, or tls", s)
|
||||||
|
}
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user