mirror of
https://github.com/slackhq/nebula.git
synced 2026-11-16 12:46:52 +01:00
Compare commits
67
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1e5ad19f6d | ||
|
|
fdfcf3bd17 | ||
|
|
c5c826d163 | ||
|
|
660a271466 | ||
|
|
e0dc742e17 | ||
|
|
2f1931dc36 | ||
|
|
f2a8883563 | ||
|
|
aa04cc446a | ||
|
|
3fb29d6444 | ||
|
|
613c7e3061 | ||
|
|
92c67a52b2 | ||
|
|
0f767ce529 | ||
|
|
9a5bdb508e | ||
|
|
48ba879198 | ||
|
|
fb2c153dfa | ||
|
|
f552cebc51 | ||
|
|
b04d71d96a | ||
|
|
cacfa8fac4 | ||
|
|
8a4bd8b10f | ||
|
|
b426843f88 | ||
|
|
cda3710d5a | ||
|
|
c26871fe08 | ||
|
|
7daacc6a48 | ||
|
|
428dad94b3 | ||
|
|
5bf666dd90 | ||
|
|
49207da077 | ||
|
|
bbc49669b7 | ||
|
|
915495d5f4 | ||
|
|
a203d044bb | ||
|
|
316bf87780 | ||
|
|
1a0ac25db0 | ||
|
|
42597dda7d | ||
|
|
afbdc87ed9 | ||
|
|
94372f4f51 | ||
|
|
42280f04ce | ||
|
|
11c1917387 | ||
|
|
5ba7aff4b3 | ||
|
|
8a2de9b1b5 | ||
|
|
a8c52f5c13 | ||
|
|
13af8dd6f3 | ||
|
|
5bb0622192 | ||
|
|
f3705cbb67 | ||
|
|
94be454f4f | ||
|
|
5f26c1a7e5 | ||
|
|
d47c8c71f1 | ||
|
|
f57539a163 | ||
|
|
8d8ae0f744 | ||
|
|
f9b0853476 | ||
|
|
d5062dacf0 | ||
|
|
7cfa47d569 | ||
|
|
e20569ce51 | ||
|
|
9651ffdb0d | ||
|
|
3a45c01656 | ||
|
|
019cc46a7f | ||
|
|
cf3f315cd3 | ||
|
|
3fc627e08d | ||
|
|
abff1a4555 | ||
|
|
227134a1d5 | ||
|
|
232bacfdd0 | ||
|
|
4e1ef9cd73 | ||
|
|
614e0ea3aa | ||
|
|
2999fc0b6a | ||
|
|
f474b534e1 | ||
|
|
0dc8a28d1f | ||
|
|
89178f45ba | ||
|
|
6a72e1c304 | ||
|
|
e50f8128f4 |
No files matched your search
@@ -0,0 +1,2 @@
|
|||||||
|
# Goldens are compared byte for byte, so they must come out of git the way they went in.
|
||||||
|
*.golden -text
|
||||||
Executable
+142
@@ -0,0 +1,142 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
#
|
||||||
|
# Backport a merged PR to a release branch.
|
||||||
|
#
|
||||||
|
# Cherry-picks the merge commit of a merged PR onto release-1.11 and opens a
|
||||||
|
# backport PR, mirroring the shape of #1842.
|
||||||
|
#
|
||||||
|
# Usage: ./backport.sh <pr-number> [target-version] [--continue]
|
||||||
|
# pr-number The merged PR to backport
|
||||||
|
# target-version Release version to target (default: 1.11)
|
||||||
|
# --continue Resume after resolving cherry-pick conflicts: assumes the
|
||||||
|
# fixes are staged, runs `git cherry-pick --continue`, and
|
||||||
|
# proceeds to push and open the backport PR.
|
||||||
|
#
|
||||||
|
# Requires: gh (authenticated), git, jq.
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
PR_NUMBER=${1:?usage: backport.sh <pr-number> [target-version] [--continue]}
|
||||||
|
shift
|
||||||
|
CONTINUE=0
|
||||||
|
TARGET_VERSION=""
|
||||||
|
for arg in "$@"; do
|
||||||
|
case "$arg" in
|
||||||
|
--continue) CONTINUE=1 ;;
|
||||||
|
*) TARGET_VERSION=$arg ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
for cmd in gh git jq; do
|
||||||
|
command -v "$cmd" >/dev/null || { echo "error: $cmd is required" >&2; exit 1; }
|
||||||
|
done
|
||||||
|
|
||||||
|
# Pull the source PR's metadata. Refuse to backport a PR that never merged.
|
||||||
|
pr_json=$(gh pr view "$PR_NUMBER" --json title,body,mergedAt,mergeCommit,milestone)
|
||||||
|
PR_TITLE=$(jq -r '.title' <<<"$pr_json")
|
||||||
|
PR_BODY=$(jq -r '.body' <<<"$pr_json")
|
||||||
|
MERGE_SHA=$(jq -r '.mergeCommit.oid // empty' <<<"$pr_json")
|
||||||
|
PR_MILESTONE=$(jq -r '.milestone.title // empty' <<<"$pr_json")
|
||||||
|
|
||||||
|
if [ "$(jq -r '.mergedAt // empty' <<<"$pr_json")" = "" ] || [ -z "$MERGE_SHA" ]; then
|
||||||
|
echo "error: PR #${PR_NUMBER} is not merged (no merge commit to cherry-pick)" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Default the target to one minor below the PR's milestone: a PR landing in
|
||||||
|
# v1.12.0 backports to release-1.11. An explicit target-version arg overrides.
|
||||||
|
if [ -z "$TARGET_VERSION" ]; then
|
||||||
|
if [[ $PR_MILESTONE =~ ^v?([0-9]+)\.([0-9]+) ]]; then
|
||||||
|
TARGET_VERSION="${BASH_REMATCH[1]}.$(( BASH_REMATCH[2] - 1 ))"
|
||||||
|
else
|
||||||
|
echo "error: PR #${PR_NUMBER} has no v<major>.<minor>.* milestone to infer the target from." >&2
|
||||||
|
echo "Pass the target version explicitly, e.g. $0 ${PR_NUMBER} 1.11" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
TARGET_BRANCH="release-${TARGET_VERSION}"
|
||||||
|
|
||||||
|
# Slug from the PR title: lower-case, non-alphanumerics to dashes, trimmed.
|
||||||
|
slug=$(printf '%s' "$PR_TITLE" \
|
||||||
|
| tr '[:upper:]' '[:lower:]' \
|
||||||
|
| sed -E 's/[^a-z0-9]+/-/g; s/^-+//; s/-+$//' \
|
||||||
|
| cut -c1-50 \
|
||||||
|
| sed -E 's/-+$//')
|
||||||
|
BRANCH="backport-${TARGET_VERSION//./-}-${slug}"
|
||||||
|
|
||||||
|
if [ "$CONTINUE" -eq 1 ]; then
|
||||||
|
# Resuming: the branch already exists and a cherry-pick is mid-conflict.
|
||||||
|
current=$(git rev-parse --abbrev-ref HEAD)
|
||||||
|
if [ "$current" != "$BRANCH" ]; then
|
||||||
|
echo "error: --continue expects to be on ${BRANCH}, but HEAD is ${current}" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "Resuming backport of #${PR_NUMBER} on ${BRANCH}"
|
||||||
|
# Conflicts assumed resolved and staged; core.editor=true keeps the commit message.
|
||||||
|
git -c core.editor=true cherry-pick --continue
|
||||||
|
else
|
||||||
|
# A fresh run switches branches and cherry-picks, so tracked changes must be
|
||||||
|
# clean. Untracked files are fine, and --continue is exempt (its resolved
|
||||||
|
# conflicts are meant to be staged).
|
||||||
|
if [ -n "$(git status --porcelain --untracked-files=no)" ]; then
|
||||||
|
echo "error: working tree has uncommitted changes to tracked files; commit or stash them first." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Backporting #${PR_NUMBER} (${MERGE_SHA}) onto ${TARGET_BRANCH} as ${BRANCH}"
|
||||||
|
|
||||||
|
git fetch origin
|
||||||
|
git checkout -b "$BRANCH" "origin/${TARGET_BRANCH}"
|
||||||
|
|
||||||
|
# -m 1 handles a real merge commit; plain cherry-pick handles a squash merge.
|
||||||
|
if ! { git cherry-pick -x -m 1 "$MERGE_SHA" 2>/dev/null || git cherry-pick -x "$MERGE_SHA"; }; then
|
||||||
|
echo "error: ${MERGE_SHA} did not cherry-pick cleanly onto ${TARGET_BRANCH}." >&2
|
||||||
|
echo "Resolve the conflicts, 'git add' them, then re-run:" >&2
|
||||||
|
echo " $0 ${PR_NUMBER} ${TARGET_VERSION} --continue" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
title="backport v${TARGET_VERSION}: ${PR_TITLE}"
|
||||||
|
body=$(printf 'Backport from #%s to release v%s\n\n---\n\n%s' \
|
||||||
|
"$PR_NUMBER" "$TARGET_VERSION" "$PR_BODY")
|
||||||
|
|
||||||
|
# Highest open milestone matching v<version>.* (e.g. v1.11.1), if any.
|
||||||
|
MILESTONE=$(gh api "repos/{owner}/{repo}/milestones?state=open" \
|
||||||
|
--jq ".[].title | select(startswith(\"v${TARGET_VERSION}.\"))" \
|
||||||
|
| sort -V | tail -n1)
|
||||||
|
milestone_args=()
|
||||||
|
if [ -n "$MILESTONE" ]; then
|
||||||
|
milestone_args=(--milestone "$MILESTONE")
|
||||||
|
else
|
||||||
|
echo "warning: no open milestone matching v${TARGET_VERSION}.* found; PR will have no milestone" >&2
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo "About to run:"
|
||||||
|
printf ' git push -u --force-with-lease origin %q\n' "$BRANCH"
|
||||||
|
printf ' gh pr create --base %q --head %q --title %q --body %q' \
|
||||||
|
"$TARGET_BRANCH" "$BRANCH" "$title" "$body"
|
||||||
|
[ -n "$MILESTONE" ] && printf ' --milestone %q' "$MILESTONE"
|
||||||
|
printf '\n'
|
||||||
|
echo
|
||||||
|
read -r -p "Open this pull request? [y/N] " reply
|
||||||
|
case "$reply" in
|
||||||
|
[yY] | [yY][eE][sS]) ;;
|
||||||
|
*) echo "Aborted. The cherry-pick is on local branch ${BRANCH}; push it manually if desired."; exit 0 ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
git push -u --force-with-lease origin "$BRANCH"
|
||||||
|
|
||||||
|
gh pr create \
|
||||||
|
--base "$TARGET_BRANCH" \
|
||||||
|
--head "$BRANCH" \
|
||||||
|
--title "$title" \
|
||||||
|
--body "$body" \
|
||||||
|
${milestone_args[@]+"${milestone_args[@]}"}
|
||||||
|
|
||||||
|
# The backport now exists, so drop the label that flagged this PR for one.
|
||||||
|
gh pr edit "$PR_NUMBER" --remove-label needs-backport
|
||||||
|
|
||||||
|
# Switch back to the original branch we were on before doing the backport
|
||||||
|
git checkout -
|
||||||
@@ -14,7 +14,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
@@ -40,7 +40,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
@@ -83,7 +83,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
# GitHub holds ARNs, not credentials, and ARNs outlive a rotation
|
# GitHub holds ARNs, not credentials, and ARNs outlive a rotation
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: add hashicorp source
|
- name: add hashicorp source
|
||||||
@@ -66,7 +66,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: add hashicorp source
|
- name: add hashicorp source
|
||||||
@@ -92,13 +92,13 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
# WSL2 + Ubuntu so the smoke can run a real linux peer with its own
|
# WSL2 + Ubuntu so the smoke can run a real linux peer with its own
|
||||||
# netns. iputils-ping is needed for the in-WSL ping check. WSL1 has no
|
# netns. iputils-ping is needed for the in-WSL ping check. WSL1 has no
|
||||||
# real kernel and would lack /dev/net/tun, so we have to force WSL2.
|
# real kernel and would lack /dev/net/tun, so we have to force WSL2.
|
||||||
- uses: Vampire/setup-wsl@v3
|
- uses: Vampire/setup-wsl@v7
|
||||||
with:
|
with:
|
||||||
distribution: Ubuntu-24.04
|
distribution: Ubuntu-24.04
|
||||||
additional-packages: iputils-ping iproute2
|
additional-packages: iputils-ping iproute2
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Smoke Docker
|
- name: Smoke Docker
|
||||||
@@ -51,7 +51,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: build
|
- name: build
|
||||||
|
|||||||
@@ -51,15 +51,19 @@ wsl -d $Distro -- bash -c "rm -rf $WslDir && mkdir -p $WslDir" | Out-Null
|
|||||||
$DevName = 'nebula-smoke'
|
$DevName = 'nebula-smoke'
|
||||||
$Ip1 = '192.168.241.1'
|
$Ip1 = '192.168.241.1'
|
||||||
$Ip2 = '192.168.241.2'
|
$Ip2 = '192.168.241.2'
|
||||||
|
# Dual stack on purpose: a v4-only overlay never exercises the v6 side of tun.mtu.
|
||||||
|
$Ip6_1 = 'fd42:4242:241::1'
|
||||||
|
$Ip6_2 = 'fd42:4242:241::2'
|
||||||
|
$Mtu = 1300
|
||||||
$Port = 4242
|
$Port = 4242
|
||||||
|
|
||||||
& $NebulaCert ca -name 'smoke-ca' -out-crt "$WorkDir\ca.crt" -out-key "$WorkDir\ca.key"
|
& $NebulaCert ca -name 'smoke-ca' -out-crt "$WorkDir\ca.crt" -out-key "$WorkDir\ca.key"
|
||||||
if ($LASTEXITCODE -ne 0) { throw "nebula-cert ca failed (exit $LASTEXITCODE)" }
|
if ($LASTEXITCODE -ne 0) { throw "nebula-cert ca failed (exit $LASTEXITCODE)" }
|
||||||
|
|
||||||
& $NebulaCert sign -name 'lighthouse' -networks "$Ip1/24" -ca-crt "$WorkDir\ca.crt" -ca-key "$WorkDir\ca.key" -out-crt "$WorkDir\lighthouse.crt" -out-key "$WorkDir\lighthouse.key"
|
& $NebulaCert sign -name 'lighthouse' -networks "$Ip1/24,$Ip6_1/64" -ca-crt "$WorkDir\ca.crt" -ca-key "$WorkDir\ca.key" -out-crt "$WorkDir\lighthouse.crt" -out-key "$WorkDir\lighthouse.key"
|
||||||
if ($LASTEXITCODE -ne 0) { throw "nebula-cert sign lighthouse failed (exit $LASTEXITCODE)" }
|
if ($LASTEXITCODE -ne 0) { throw "nebula-cert sign lighthouse failed (exit $LASTEXITCODE)" }
|
||||||
|
|
||||||
& $NebulaCert sign -name 'peer' -networks "$Ip2/24" -ca-crt "$WorkDir\ca.crt" -ca-key "$WorkDir\ca.key" -out-crt "$WorkDir\peer.crt" -out-key "$WorkDir\peer.key"
|
& $NebulaCert sign -name 'peer' -networks "$Ip2/24,$Ip6_2/64" -ca-crt "$WorkDir\ca.crt" -ca-key "$WorkDir\ca.key" -out-crt "$WorkDir\peer.crt" -out-key "$WorkDir\peer.key"
|
||||||
if ($LASTEXITCODE -ne 0) { throw "nebula-cert sign peer failed (exit $LASTEXITCODE)" }
|
if ($LASTEXITCODE -ne 0) { throw "nebula-cert sign peer failed (exit $LASTEXITCODE)" }
|
||||||
|
|
||||||
# Windows lighthouse config.
|
# Windows lighthouse config.
|
||||||
@@ -82,7 +86,7 @@ tun:
|
|||||||
drop_local_broadcast: false
|
drop_local_broadcast: false
|
||||||
drop_multicast: false
|
drop_multicast: false
|
||||||
tx_queue: 500
|
tx_queue: 500
|
||||||
mtu: 1300
|
mtu: $Mtu
|
||||||
network_category: private
|
network_category: private
|
||||||
logging:
|
logging:
|
||||||
level: info
|
level: info
|
||||||
@@ -126,7 +130,7 @@ tun:
|
|||||||
drop_local_broadcast: false
|
drop_local_broadcast: false
|
||||||
drop_multicast: false
|
drop_multicast: false
|
||||||
tx_queue: 500
|
tx_queue: 500
|
||||||
mtu: 1300
|
mtu: $Mtu
|
||||||
logging:
|
logging:
|
||||||
level: info
|
level: info
|
||||||
format: text
|
format: text
|
||||||
@@ -169,7 +173,7 @@ Write-Host '=== WSL diagnostic ==='
|
|||||||
wsl --version 2>&1 | Out-Host
|
wsl --version 2>&1 | Out-Host
|
||||||
wsl --list --verbose 2>&1 | Out-Host
|
wsl --list --verbose 2>&1 | Out-Host
|
||||||
wsl -d $Distro -u root -- uname -a | Out-Host
|
wsl -d $Distro -u root -- uname -a | Out-Host
|
||||||
wsl -d $Distro -u root -- bash -c "modprobe tun 2>&1 || true; mkdir -p /dev/net; [ -c /dev/net/tun ] || mknod /dev/net/tun c 10 200; chmod 600 /dev/net/tun; ls -l /dev/net/tun"
|
wsl -d $Distro -u root -- bash -c "modprobe tun 2>&1 || true; mkdir -p /dev/net; [ -c /dev/net/tun ] || mknod /dev/net/tun c 10 200; chmod 600 /dev/net/tun; { echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6; echo 0 > /proc/sys/net/ipv6/conf/default/disable_ipv6; } 2>/dev/null || true; ls -l /dev/net/tun"
|
||||||
if ($LASTEXITCODE -ne 0) { throw "failed to prepare /dev/net/tun in WSL (TUN support missing?)" }
|
if ($LASTEXITCODE -ne 0) { throw "failed to prepare /dev/net/tun in WSL (TUN support missing?)" }
|
||||||
|
|
||||||
# Deliberately no New-NetFirewallRule calls here -- nebula's windows_bypass_wdf
|
# Deliberately no New-NetFirewallRule calls here -- nebula's windows_bypass_wdf
|
||||||
@@ -214,6 +218,16 @@ try {
|
|||||||
}
|
}
|
||||||
Write-Host "OK: $DevName NetworkCategory=Private"
|
Write-Host "OK: $DevName NetworkCategory=Private"
|
||||||
|
|
||||||
|
# v6 silently kept the adapter default of 65535 while v4 was correct.
|
||||||
|
foreach ($family in @('IPv4', 'IPv6')) {
|
||||||
|
Wait-Until -TimeoutSec 30 -What "$DevName $family NlMtu=$Mtu" -Predicate {
|
||||||
|
if ($lhProc.HasExited) { throw "lighthouse exited (code $($lhProc.ExitCode)) before $family mtu was set" }
|
||||||
|
$rows = @(Get-NetIPInterface -InterfaceAlias $DevName -AddressFamily $family -ErrorAction SilentlyContinue)
|
||||||
|
$rows.Count -gt 0 -and -not ($rows | Where-Object { $_.NlMtu -ne $Mtu })
|
||||||
|
}
|
||||||
|
Write-Host "OK: $DevName $family NlMtu=$Mtu"
|
||||||
|
}
|
||||||
|
|
||||||
Wait-Until -TimeoutSec 30 -What "WSL nebula1 with $Ip2" -Predicate {
|
Wait-Until -TimeoutSec 30 -What "WSL nebula1 with $Ip2" -Predicate {
|
||||||
if ($peerProc.HasExited) { throw "peer exited (code $($peerProc.ExitCode)) before tun was ready" }
|
if ($peerProc.HasExited) { throw "peer exited (code $($peerProc.ExitCode)) before tun was ready" }
|
||||||
$r = wsl -d $Distro -u root -- bash -c "ip -o addr show nebula1 2>/dev/null | grep -q 'inet $Ip2' && echo yes"
|
$r = wsl -d $Distro -u root -- bash -c "ip -o addr show nebula1 2>/dev/null | grep -q 'inet $Ip2' && echo yes"
|
||||||
@@ -221,6 +235,13 @@ try {
|
|||||||
}
|
}
|
||||||
Write-Host "OK: WSL nebula1 has $Ip2"
|
Write-Host "OK: WSL nebula1 has $Ip2"
|
||||||
|
|
||||||
|
Wait-Until -TimeoutSec 30 -What "WSL nebula1 with $Ip6_2" -Predicate {
|
||||||
|
if ($peerProc.HasExited) { throw "peer exited (code $($peerProc.ExitCode)) before the v6 address was up" }
|
||||||
|
$r = wsl -d $Distro -u root -- bash -c "ip -o addr show nebula1 2>/dev/null | grep -q 'inet6 $Ip6_2' && echo yes"
|
||||||
|
("$r").Trim() -eq 'yes'
|
||||||
|
}
|
||||||
|
Write-Host "OK: WSL nebula1 has $Ip6_2"
|
||||||
|
|
||||||
Wait-Until -TimeoutSec 30 -What "ping from WSL peer to windows lighthouse ($Ip1)" -Predicate {
|
Wait-Until -TimeoutSec 30 -What "ping from WSL peer to windows lighthouse ($Ip1)" -Predicate {
|
||||||
if ($peerProc.HasExited) { throw "peer exited (code $($peerProc.ExitCode)) before ping succeeded" }
|
if ($peerProc.HasExited) { throw "peer exited (code $($peerProc.ExitCode)) before ping succeeded" }
|
||||||
$r = wsl -d $Distro -u root -- bash -c "ping -c1 -W1 $Ip1 >/dev/null 2>&1 && echo OK"
|
$r = wsl -d $Distro -u root -- bash -c "ping -c1 -W1 $Ip1 >/dev/null 2>&1 && echo OK"
|
||||||
@@ -234,6 +255,28 @@ try {
|
|||||||
}
|
}
|
||||||
Write-Host "OK: windows lighthouse -> WSL peer"
|
Write-Host "OK: windows lighthouse -> WSL peer"
|
||||||
|
|
||||||
|
# Otherwise the v6 networks only prove the interface exists, not that it forwards.
|
||||||
|
Wait-Until -TimeoutSec 30 -What "v6 ping from WSL peer to windows lighthouse ($Ip6_1)" -Predicate {
|
||||||
|
if ($peerProc.HasExited) { throw "peer exited (code $($peerProc.ExitCode)) before the v6 ping succeeded" }
|
||||||
|
$r = wsl -d $Distro -u root -- bash -c "ping -6 -c1 -W1 $Ip6_1 >/dev/null 2>&1 && echo OK"
|
||||||
|
("$r").Trim() -eq 'OK'
|
||||||
|
}
|
||||||
|
Write-Host "OK: WSL peer -> windows lighthouse over v6"
|
||||||
|
|
||||||
|
# The NlMtu check above proves the value was written, not that windows honors it. A payload this size only
|
||||||
|
# crosses the tunnel as fragments cut at NlMtu on the way out of the adapter. Left at the adapter default it
|
||||||
|
# reaches nebula whole, overflows the udp.MTU (9001) write buffer and is dropped, so the ping never answers.
|
||||||
|
# Anything smaller would ride out as one oversized datagram and survive on IP fragmentation of the underlay.
|
||||||
|
$BigPayload = 9000
|
||||||
|
foreach ($target in @(@{ Family = 'v4'; Ip = $Ip2 }, @{ Family = 'v6'; Ip = $Ip6_2 })) {
|
||||||
|
Wait-Until -TimeoutSec 30 -What "$($target.Family) ping with a $BigPayload byte payload from windows lighthouse to WSL peer ($($target.Ip))" -Predicate {
|
||||||
|
if ($peerProc.HasExited) { throw "peer exited (code $($peerProc.ExitCode)) before the large $($target.Family) ping succeeded" }
|
||||||
|
$null = & ping.exe -n 1 -w 1000 -l $BigPayload $target.Ip
|
||||||
|
$LASTEXITCODE -eq 0
|
||||||
|
}
|
||||||
|
Write-Host "OK: windows lighthouse -> WSL peer, $BigPayload byte $($target.Family) payload"
|
||||||
|
}
|
||||||
|
|
||||||
Write-Host ''
|
Write-Host ''
|
||||||
Write-Host 'All smoke checks passed.'
|
Write-Host 'All smoke checks passed.'
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Install goimports
|
- name: Install goimports
|
||||||
@@ -42,7 +42,7 @@ jobs:
|
|||||||
- name: golangci-lint
|
- name: golangci-lint
|
||||||
uses: golangci/golangci-lint-action@v9
|
uses: golangci/golangci-lint-action@v9
|
||||||
with:
|
with:
|
||||||
version: v2.12
|
version: v2.14
|
||||||
|
|
||||||
test:
|
test:
|
||||||
name: Test ${{ matrix.name }}
|
name: Test ${{ matrix.name }}
|
||||||
@@ -87,7 +87,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
@@ -132,7 +132,7 @@ jobs:
|
|||||||
|
|
||||||
- uses: actions/setup-go@v7
|
- uses: actions/setup-go@v7
|
||||||
with:
|
with:
|
||||||
go-version: '1.26'
|
go-version: '1.27'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
|
|
||||||
- name: Build ${{ matrix.name }}
|
- name: Build ${{ matrix.name }}
|
||||||
|
|||||||
+39
-1
@@ -7,6 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- A control socket that provides access to all of the ssh debug server's commands along with support
|
||||||
|
for running `nebula ctl <command>` as a client from the CLI.
|
||||||
|
- An info socket that provides access to information related to identity: identity, whoami, and print-cert.
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
|
||||||
|
- The SSH debug server's `start-cpu-profile`, `stop-cpu-profile`, `save-heap-profile`, `save-mutex-profile`, and
|
||||||
|
`mutex-profile-fraction` commands, and `sshd.sandbox_dir`, which is now ignored if set.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- A peer whose certificate carries an unsafe network overlapping the overlay could send packets as any node in
|
||||||
|
it: the firewall accepted any source inside the unsafe network. A source address inside this node's own
|
||||||
|
networks must now be the sending peer's own; through an unsafe network it is dropped, counted as a dropped
|
||||||
|
remote address.
|
||||||
|
|
||||||
|
- Signing a v2 certificate with an empty name, a name longer than 253 bytes, or an empty group now fails.
|
||||||
|
These certificates were signed successfully but could not be loaded.
|
||||||
|
- `create-tunnel -address <ip:port>` panicked on a nil RemoteList and, over the ssh debug server, took nebula
|
||||||
|
down with it. A hostinfo returned by StartHandshake had no RemoteList until the handshake loop's first
|
||||||
|
pass attached one, and `create-tunnel -address` set the remote before that. The list is now attached when
|
||||||
|
the handshake starts, so a pending hostinfo never exists without one.
|
||||||
|
|
||||||
|
## [1.11.1] - 2026-08-21
|
||||||
|
|
||||||
|
See the [v1.11.1](https://github.com/slackhq/nebula/milestone/30?closed=1) milestone for a complete list of changes.
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- IPv6 packets whose next header is a protocol Nebula does not parse (SCTP, GRE, IP-in-IP, etc.) are now
|
- IPv6 packets whose next header is a protocol Nebula does not parse (SCTP, GRE, IP-in-IP, etc.) are now
|
||||||
@@ -15,11 +44,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
their true protocol, so only a `proto: any` rule allows them. If you carry one of these protocols over the
|
their true protocol, so only a `proto: any` rule allows them. If you carry one of these protocols over the
|
||||||
overlay, confirm a `proto: any` rule covers it before upgrading, it may have been passing only through this
|
overlay, confirm a `proto: any` rule covers it before upgrading, it may have been passing only through this
|
||||||
bypass. (#1840)
|
bypass. (#1840)
|
||||||
|
- Drop the dependency on `github.com/cyberdelia/go-metrics-graphite`, which has been unmaintained for over ten
|
||||||
|
years, by inlining the small amount of code Nebula used. (#1832)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- The ICMPv6 type was read from the wrong byte when classifying IPv6 packets, so the echo identifier used
|
- The ICMPv6 type was read from the wrong byte when classifying IPv6 packets, so the echo identifier used
|
||||||
for conntrack was never picked up. (#1840)
|
for conntrack was never picked up. (#1840)
|
||||||
|
- Enforce outbound message counter limits so a tunnel is rehandshaked before the counter can wrap, preventing
|
||||||
|
nonce reuse. This is unreachable in practice, but is enforced as a defense-in-depth measure. (#1841)
|
||||||
|
- Prevent `nebula-cert ca` from running out of memory on 32bit systems when generating encrypted private keys. (#1834)
|
||||||
|
- Tolerate `ErrDumpInterrupted` when listing tun addresses on Linux, so a transient interrupted netlink dump
|
||||||
|
no longer aborts startup. (#1835)
|
||||||
|
|
||||||
## [1.11.0] - 2026-07-23
|
## [1.11.0] - 2026-07-23
|
||||||
|
|
||||||
@@ -884,7 +920,9 @@ created.)
|
|||||||
|
|
||||||
- Initial public release.
|
- Initial public release.
|
||||||
|
|
||||||
[Unreleased]: https://github.com/slackhq/nebula/compare/v1.10.3...HEAD
|
[Unreleased]: https://github.com/slackhq/nebula/compare/v1.11.1...HEAD
|
||||||
|
[1.11.1]: https://github.com/slackhq/nebula/releases/tag/v1.11.1
|
||||||
|
[1.11.0]: https://github.com/slackhq/nebula/releases/tag/v1.11.0
|
||||||
[1.10.3]: https://github.com/slackhq/nebula/releases/tag/v1.10.3
|
[1.10.3]: https://github.com/slackhq/nebula/releases/tag/v1.10.3
|
||||||
[1.10.2]: https://github.com/slackhq/nebula/releases/tag/v1.10.2
|
[1.10.2]: https://github.com/slackhq/nebula/releases/tag/v1.10.2
|
||||||
[1.10.1]: https://github.com/slackhq/nebula/releases/tag/v1.10.1
|
[1.10.1]: https://github.com/slackhq/nebula/releases/tag/v1.10.1
|
||||||
|
|||||||
@@ -242,11 +242,14 @@ test-cov-html:
|
|||||||
go test -coverprofile=coverage.out
|
go test -coverprofile=coverage.out
|
||||||
go tool cover -html=coverage.out
|
go tool cover -html=coverage.out
|
||||||
|
|
||||||
|
# The package builds only compile. The final line links an android binary so a linker-only failure
|
||||||
|
# cannot pass CI.
|
||||||
build-test-mobile:
|
build-test-mobile:
|
||||||
GOARCH=amd64 GOOS=ios go build $(shell go list ./... | grep -v '/cmd/\|/examples/')
|
GOARCH=amd64 GOOS=ios go build $(shell go list ./... | grep -v '/cmd/\|/examples/')
|
||||||
GOARCH=arm64 GOOS=ios go build $(shell go list ./... | grep -v '/cmd/\|/examples/')
|
GOARCH=arm64 GOOS=ios go build $(shell go list ./... | grep -v '/cmd/\|/examples/')
|
||||||
GOARCH=amd64 GOOS=android go build $(shell go list ./... | grep -v '/cmd/\|/examples/')
|
GOARCH=amd64 GOOS=android go build $(shell go list ./... | grep -v '/cmd/\|/examples/')
|
||||||
GOARCH=arm64 GOOS=android go build $(shell go list ./... | grep -v '/cmd/\|/examples/')
|
GOARCH=arm64 GOOS=android go build $(shell go list ./... | grep -v '/cmd/\|/examples/')
|
||||||
|
GOARCH=arm64 GOOS=android go build -o /dev/null ${NEBULA_CMD_PATH}
|
||||||
|
|
||||||
bench:
|
bench:
|
||||||
go test -bench=.
|
go test -bench=.
|
||||||
|
|||||||
@@ -79,13 +79,7 @@ func (b *Bits) clearRange(startPos, count uint64) uint64 {
|
|||||||
// handle the potential partial word before pos becomes u64 aligned
|
// handle the potential partial word before pos becomes u64 aligned
|
||||||
word := pos >> 6
|
word := pos >> 6
|
||||||
bit := pos & 63
|
bit := pos & 63
|
||||||
take := uint64(64) - bit
|
take := min(min(uint64(64)-bit, remaining), b.length-pos)
|
||||||
if take > remaining {
|
|
||||||
take = remaining
|
|
||||||
}
|
|
||||||
if take > b.length-pos {
|
|
||||||
take = b.length - pos
|
|
||||||
}
|
|
||||||
var mask uint64
|
var mask uint64
|
||||||
if take == 64 {
|
if take == 64 {
|
||||||
mask = math.MaxUint64
|
mask = math.MaxUint64
|
||||||
@@ -189,10 +183,7 @@ func (b *Bits) Update(l *slog.Logger, i uint64) bool {
|
|||||||
func (b *Bits) updateSlow(l *slog.Logger, i uint64) bool {
|
func (b *Bits) updateSlow(l *slog.Logger, i uint64) bool {
|
||||||
// If i is a jump, adjust the window, record lost, update current, and return true
|
// If i is a jump, adjust the window, record lost, update current, and return true
|
||||||
if i > b.current {
|
if i > b.current {
|
||||||
end := i
|
end := min(i, b.current+b.length)
|
||||||
if end > b.current+b.length {
|
|
||||||
end = b.current + b.length
|
|
||||||
}
|
|
||||||
count := end - b.current
|
count := end - b.current
|
||||||
startPos := (b.current + 1) & b.lengthMask
|
startPos := (b.current + 1) & b.lengthMask
|
||||||
|
|
||||||
|
|||||||
+10
-1
@@ -389,7 +389,16 @@ func (c *certificateV2) fromTBSCertificate(t *TBSCertificate) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (c *certificateV2) validate() error {
|
func (c *certificateV2) validate() error {
|
||||||
// Empty names are allowed
|
// Mirror the name and group rules in unmarshalDetails so signing fails instead of producing an unparseable certificate
|
||||||
|
if c.details.name == "" || len(c.details.name) > MaxNameLength {
|
||||||
|
return NewErrInvalidCertificateProperties("name must be between 1 and %d bytes", MaxNameLength)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, group := range c.details.groups {
|
||||||
|
if group == "" {
|
||||||
|
return NewErrInvalidCertificateProperties("groups may not be empty")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if len(c.publicKey) == 0 {
|
if len(c.publicKey) == 0 {
|
||||||
return ErrInvalidPublicKey
|
return ErrInvalidPublicKey
|
||||||
|
|||||||
+46
-1
@@ -6,6 +6,7 @@ import (
|
|||||||
"crypto/elliptic"
|
"crypto/elliptic"
|
||||||
"crypto/rand"
|
"crypto/rand"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -120,7 +121,7 @@ func TestCertificate_SignP256_AlwaysNormalized(t *testing.T) {
|
|||||||
pub := elliptic.Marshal(elliptic.P256(), priv.PublicKey.X, priv.PublicKey.Y)
|
pub := elliptic.Marshal(elliptic.P256(), priv.PublicKey.X, priv.PublicKey.Y)
|
||||||
rawPriv := priv.D.FillBytes(make([]byte, 32))
|
rawPriv := priv.D.FillBytes(make([]byte, 32))
|
||||||
|
|
||||||
for i := 0; i < 1000; i++ {
|
for i := range 1000 {
|
||||||
if i&1 == 1 {
|
if i&1 == 1 {
|
||||||
tbs.Version = Version1
|
tbs.Version = Version1
|
||||||
} else {
|
} else {
|
||||||
@@ -135,3 +136,47 @@ func TestCertificate_SignP256_AlwaysNormalized(t *testing.T) {
|
|||||||
assert.True(t, normie)
|
assert.True(t, normie)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCertificateV2_SignRejectsUnparseable(t *testing.T) {
|
||||||
|
_, priv, err := ed25519.GenerateKey(rand.Reader)
|
||||||
|
require.NoError(t, err)
|
||||||
|
var invalid *ErrInvalidCertificateProperties
|
||||||
|
|
||||||
|
newTBS := func() TBSCertificate {
|
||||||
|
return TBSCertificate{
|
||||||
|
Version: Version2,
|
||||||
|
Name: "testing",
|
||||||
|
Networks: []netip.Prefix{mustParsePrefixUnmapped("10.1.1.1/24")},
|
||||||
|
Groups: []string{"test-group1"},
|
||||||
|
NotBefore: time.Now().Add(-time.Minute),
|
||||||
|
NotAfter: time.Now().Add(time.Minute),
|
||||||
|
PublicKey: []byte("1234567890abcedfghij1234567890ab"),
|
||||||
|
Curve: Curve_CURVE25519,
|
||||||
|
IsCA: true,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
tbs := newTBS()
|
||||||
|
tbs.Name = strings.Repeat("a", MaxNameLength)
|
||||||
|
c, err := tbs.Sign(nil, Curve_CURVE25519, priv)
|
||||||
|
require.NoError(t, err)
|
||||||
|
b, err := c.Marshal()
|
||||||
|
require.NoError(t, err)
|
||||||
|
_, err = unmarshalCertificateV2(b, nil, Curve_CURVE25519)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
tbs = newTBS()
|
||||||
|
tbs.Name = strings.Repeat("a", MaxNameLength+1)
|
||||||
|
_, err = tbs.Sign(nil, Curve_CURVE25519, priv)
|
||||||
|
require.ErrorAs(t, err, &invalid)
|
||||||
|
|
||||||
|
tbs = newTBS()
|
||||||
|
tbs.Name = ""
|
||||||
|
_, err = tbs.Sign(nil, Curve_CURVE25519, priv)
|
||||||
|
require.ErrorAs(t, err, &invalid)
|
||||||
|
|
||||||
|
tbs = newTBS()
|
||||||
|
tbs.Groups = []string{"test-group1", ""}
|
||||||
|
_, err = tbs.Sign(nil, Curve_CURVE25519, priv)
|
||||||
|
require.ErrorAs(t, err, &invalid)
|
||||||
|
}
|
||||||
@@ -0,0 +1,420 @@
|
|||||||
|
package ctl
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
"github.com/slackhq/nebula/config"
|
||||||
|
"github.com/slackhq/nebula/localapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Word is the argument that selects the control client instead of the daemon.
|
||||||
|
const Word = "ctl"
|
||||||
|
|
||||||
|
// Subcommand handles the one bare word a daemon binary accepts before its flags. `nebula
|
||||||
|
// ctl <command>` runs the client. Any other first argument that is not a flag is a
|
||||||
|
// mistyped subcommand, reported with a usage line: the daemon's flag parser would ignore
|
||||||
|
// the stray word and start nebula, so `nebula clt` would bring up a second daemon
|
||||||
|
// instead of reporting a typo. It returns the exit code and true when the process is
|
||||||
|
// done, and false when argv is the daemon's to parse. Both daemon binaries, cmd/nebula
|
||||||
|
// and cmd/nebula-service, call it before anything else, so each has a nebula ctl and
|
||||||
|
// neither has the hazard. A word that follows the daemon's flags instead is Trailing's.
|
||||||
|
func Subcommand(argv []string) (code int, done bool) {
|
||||||
|
if len(argv) < 2 || strings.HasPrefix(argv[1], "-") {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
if argv[1] == Word {
|
||||||
|
return Run(argv[2:]), true
|
||||||
|
}
|
||||||
|
|
||||||
|
return unknownCommand(argv[1]), true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Trailing handles the words the daemon's flag parser leaves unparsed: flag.Parse stops
|
||||||
|
// at the first argument that is not a flag and hands the rest back. rest is flag.Args()
|
||||||
|
// after the daemon has parsed, and configPath is the config the daemon's -config named,
|
||||||
|
// "" when it did not. Both daemon binaries call it right after flag.Parse, so that
|
||||||
|
// `nebula -config x ctl identity` runs the client and `nebula -config x clt` reports a
|
||||||
|
// typo, as Subcommand does for a word at the front of the line; a daemon that ignored
|
||||||
|
// the words would start in their place.
|
||||||
|
//
|
||||||
|
// A leading ctl word runs the client on what follows, with the daemon's -config carried
|
||||||
|
// over: an operator who typed it meant the daemon running on that config, and the client
|
||||||
|
// derives the same socket from it. Any other word is a mistake, reported as Subcommand
|
||||||
|
// reports one.
|
||||||
|
func Trailing(rest []string, configPath string) (code int, done bool) {
|
||||||
|
if len(rest) == 0 {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
if rest[0] != Word {
|
||||||
|
return unknownCommand(rest[0]), true
|
||||||
|
}
|
||||||
|
|
||||||
|
args := rest[1:]
|
||||||
|
if configPath != "" {
|
||||||
|
// First, so a -config on the ctl side of the line still wins: Parse applies
|
||||||
|
// flags in order and the last value set is the one read.
|
||||||
|
args = append([]string{"-" + commands.FlagConfig, configPath}, args...)
|
||||||
|
}
|
||||||
|
|
||||||
|
return Run(args), true
|
||||||
|
}
|
||||||
|
|
||||||
|
// unknownCommand reports a bare word that is neither a flag nor ctl, with the one usage
|
||||||
|
// line that says what the two forms of the command line are.
|
||||||
|
func unknownCommand(word string) int {
|
||||||
|
fmt.Fprintf(os.Stderr, "nebula: unknown command %q\n\n", word)
|
||||||
|
fmt.Fprintf(os.Stderr, "Run nebula with flags to start it, or `nebula %s <command>` to control one that is already running.\n", Word)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run implements `nebula ctl <command> [args]`
|
||||||
|
//
|
||||||
|
// args is everything after the `ctl` word.
|
||||||
|
func Run(args []string) int {
|
||||||
|
fs := flag.NewFlagSet("nebula ctl", flag.ContinueOnError)
|
||||||
|
fs.SetOutput(os.Stderr)
|
||||||
|
|
||||||
|
configPath := fs.String(commands.FlagConfig, "", "Path to the config of the running nebula, used to locate its control socket")
|
||||||
|
socketPath := fs.String(commands.FlagSocket, "", "Path to the control socket, instead of the one the config implies")
|
||||||
|
fs.Usage = func() {
|
||||||
|
fmt.Fprintf(os.Stderr, "Usage: nebula ctl [flags] <command> [command flags]\n\n")
|
||||||
|
fmt.Fprintf(os.Stderr, "Inspects and controls a nebula already running on this machine.\n")
|
||||||
|
fmt.Fprintf(os.Stderr, "Run it as the user who ran nebula, or as a member of the group %s names.\n\n", localapi.CtlGroupKey)
|
||||||
|
fmt.Fprintf(os.Stderr, "Flags, which may come before or after the command:\n")
|
||||||
|
fs.PrintDefaults()
|
||||||
|
fmt.Fprintf(os.Stderr, "\nRun `nebula ctl help` for the available commands.\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
own, cmdArgs := splitLine(fs, args)
|
||||||
|
if err := fs.Parse(own); err != nil {
|
||||||
|
// fs has already printed the usage, or the problem. Asking for help is not a
|
||||||
|
// failure, and a script that chains on `nebula ctl -h` should not see one.
|
||||||
|
if errors.Is(err, flag.ErrHelp) {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(cmdArgs) == 0 {
|
||||||
|
cmdArgs = []string{"help"}
|
||||||
|
}
|
||||||
|
|
||||||
|
path, err := resolveSocket(*socketPath, *configPath)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "%s\n", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
client := &localapi.Client{Path: path}
|
||||||
|
|
||||||
|
// Ask the daemon what it serves before parsing anything. The flags belong to the
|
||||||
|
// command, which lives over there, so this is what lets the CLI keep its usual shape
|
||||||
|
// while the wire protocol stays a named-parameter API rather than a shipped argv.
|
||||||
|
schema, err := client.Describe()
|
||||||
|
if err != nil {
|
||||||
|
// A daemon that answered was reached, and what it said, or that it could not be
|
||||||
|
// read, is the whole message.
|
||||||
|
var refused *localapi.DaemonError
|
||||||
|
var unread *localapi.ReplyError
|
||||||
|
if errors.As(err, &refused) || errors.As(err, &unread) {
|
||||||
|
fmt.Fprintf(os.Stderr, "nebula: %s\n", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
// Otherwise the operating system said why, and it is passed on as it came: a
|
||||||
|
// permission denied or a missing socket says more about what to do than a
|
||||||
|
// guess at the operator's setup would.
|
||||||
|
fmt.Fprintf(os.Stderr, "nebula: could not reach the control socket at %s: %s\n", path, err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
req, printedHelp, err := parseCommand(schema, cmdArgs)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "%s\n", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if printedHelp {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
res, err := client.Invoke(string(req.name), req.Params, req.Args, wireFormat(req.Format))
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "nebula: %s\n", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
out := output(res, req.Format)
|
||||||
|
if out != "" {
|
||||||
|
fmt.Fprint(os.Stdout, out)
|
||||||
|
if !strings.HasSuffix(out, "\n") {
|
||||||
|
fmt.Fprintln(os.Stdout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error set is the one failure signal, whether the request never ran or the command
|
||||||
|
// ran and refused. A refusal asked for in JSON has already gone to stdout as the
|
||||||
|
// {ok, reason} object, and is not said again on stderr; the exit status carries it.
|
||||||
|
if res.Error == "" {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(res.Result) == 0 && len(res.Text) == 0 {
|
||||||
|
msg := res.Error
|
||||||
|
if !strings.HasSuffix(msg, "\n") {
|
||||||
|
msg += "\n"
|
||||||
|
}
|
||||||
|
fmt.Fprint(os.Stderr, msg)
|
||||||
|
}
|
||||||
|
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
// output renders what the daemon answered for the format the line asked for. A text
|
||||||
|
// request is answered in Text with the bytes the command wrote, printed as they are; a
|
||||||
|
// JSON request is answered in Result with the value itself, printed as it came, since a
|
||||||
|
// value that happens to be a string is still JSON to the script reading it. Indentation
|
||||||
|
// is the client's business: whitespace does not survive a JSON envelope, and the daemon
|
||||||
|
// has no reason to care how its answer is laid out. The bytes are re-indented rather
|
||||||
|
// than decoded and encoded again, which would sort the keys and round the numbers.
|
||||||
|
func output(res *localapi.Response, format commands.Format) string {
|
||||||
|
switch format {
|
||||||
|
case commands.FormatJSON:
|
||||||
|
return string(res.Result)
|
||||||
|
case commands.FormatPrettyJSON:
|
||||||
|
var buf bytes.Buffer
|
||||||
|
if err := json.Indent(&buf, res.Result, "", " "); err != nil {
|
||||||
|
return string(res.Result)
|
||||||
|
}
|
||||||
|
return buf.String()
|
||||||
|
default:
|
||||||
|
return string(res.Text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ctlRequest is one parsed nebula ctl command line: the command's name, which only the
|
||||||
|
// daemon can resolve, and the line as every surface parses it. The Request's Command is
|
||||||
|
// nil here, since the CLI holds a schema rather than the command, and its Format is
|
||||||
|
// FormatUnset when the line named none, which to nebula ctl means text: its default
|
||||||
|
// differs from the API's.
|
||||||
|
type ctlRequest struct {
|
||||||
|
name commands.Name
|
||||||
|
commands.Request
|
||||||
|
}
|
||||||
|
|
||||||
|
// wireFormat is what a request asks the daemon for. Pretty is the client's business,
|
||||||
|
// since whitespace does not survive a JSON envelope, so it travels as json. No
|
||||||
|
// preference is text, nebula ctl's default: a person gets the human rendering wherever
|
||||||
|
// one exists.
|
||||||
|
func wireFormat(f commands.Format) string {
|
||||||
|
switch f {
|
||||||
|
case commands.FormatJSON, commands.FormatPrettyJSON:
|
||||||
|
return "json"
|
||||||
|
default:
|
||||||
|
return "text"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseCommand turns the user's command line into a ctlRequest, using the schema the
|
||||||
|
// daemon supplied. The line is parsed with the same rules the daemon applies to an ssh
|
||||||
|
// line, through ParseArgs, and ParseLine reads what was set into the Request to send, so
|
||||||
|
// a line means the same on both.
|
||||||
|
//
|
||||||
|
// printedHelp reports that help was written for the command instead, and there is
|
||||||
|
// nothing to send.
|
||||||
|
func parseCommand(schema []commands.CommandSchema, argv []string) (req ctlRequest, printedHelp bool, err error) {
|
||||||
|
name := commands.Name(argv[0])
|
||||||
|
|
||||||
|
var found *commands.CommandSchema
|
||||||
|
for i := range schema {
|
||||||
|
if schema[i].Name == name {
|
||||||
|
found = &schema[i]
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if found == nil {
|
||||||
|
// Let the daemon answer. It knows whether this is a typo or a command it holds
|
||||||
|
// back, and its message for the second case is better than anything guessable
|
||||||
|
// from the schema alone.
|
||||||
|
return ctlRequest{name: name, Request: commands.Request{Args: argv[1:]}}, false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// The flag package's own report is a bare message followed by a usage dump in a layout
|
||||||
|
// that does not match WriteCommandHelp, so it is silenced and the error is reported
|
||||||
|
// once, below, with a pointer at the help this command actually prints.
|
||||||
|
fs := flag.NewFlagSet(string(name), flag.ContinueOnError)
|
||||||
|
fs.SetOutput(io.Discard)
|
||||||
|
|
||||||
|
for _, f := range found.Flags {
|
||||||
|
if f.Bool {
|
||||||
|
fs.Bool(f.Name, f.Default == "true", f.Usage)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
fs.String(f.Name, f.Default, f.Usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
operands, err := commands.ParseArgs(fs, argv[1:])
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, flag.ErrHelp) {
|
||||||
|
// The same rendering the daemon uses for `help <command>`, so -h and help agree.
|
||||||
|
_ = commands.WriteCommandHelp(*found, os.Stdout)
|
||||||
|
return ctlRequest{}, true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Say what flag did: an unknown flag, a missing value and a malformed value are
|
||||||
|
// different mistakes, and "does not take" would be wrong for two of them.
|
||||||
|
return ctlRequest{}, false, fmt.Errorf("nebula: %s: %s (see 'nebula ctl %s -h')", name, err, name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only what the user actually set travels. A parameter left alone is the daemon's
|
||||||
|
// default to apply, not the client's to assert, and the presentation flags are the
|
||||||
|
// client's to interpret, never sent.
|
||||||
|
//
|
||||||
|
// Where the command has no human form the daemon says so, and only once the command
|
||||||
|
// has run: a refusal ("No vpn address was provided") always has a human form, so
|
||||||
|
// telling the user to pass -json before finding out whether the command would even
|
||||||
|
// accept the line sends them to fix the wrong thing. That is why the schema does not
|
||||||
|
// say which commands have a human form: nothing should decide on it before running.
|
||||||
|
return ctlRequest{name: name, Request: commands.ParseLine(fs, operands)}, false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// splitLine divides a nebula ctl line into the client's own flags, for fs to parse, and
|
||||||
|
// the command line to send, which begins with the command word. The client's flags may
|
||||||
|
// come before the command or after it: `nebula ctl -config x identity` and
|
||||||
|
// `nebula ctl identity -config x` mean the same, so an operator who has typed a command
|
||||||
|
// and then remembers which daemon they meant does not have to retype the line.
|
||||||
|
//
|
||||||
|
// Before the command word every flag is the client's, whatever it is, so an unknown one
|
||||||
|
// is reported by fs, and -h is the client's usage. After it only the
|
||||||
|
// flags fs defines are lifted out, and only those: the command's own flags are unknown
|
||||||
|
// here, since they come from the daemon the line has yet to name, and -h after the
|
||||||
|
// command asks for that command's help. Which command flags take a value is unknown too,
|
||||||
|
// so the client's names are reserved in the commands package and no command can give
|
||||||
|
// one a value that would be lifted from here. A "--" before the command is consumed, as
|
||||||
|
// fs.Parse would have; one after it belongs to the command line and ends the lifting,
|
||||||
|
// so an operand spelled like a client flag can still be passed.
|
||||||
|
func splitLine(fs *flag.FlagSet, args []string) (own, cmd []string) {
|
||||||
|
seenCommand := false
|
||||||
|
for i := 0; i < len(args); i++ {
|
||||||
|
a := args[i]
|
||||||
|
|
||||||
|
if a == "--" {
|
||||||
|
if seenCommand {
|
||||||
|
return own, append(cmd, args[i:]...)
|
||||||
|
}
|
||||||
|
seenCommand = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !seenCommand {
|
||||||
|
if len(a) < 2 || a[0] != '-' {
|
||||||
|
seenCommand = true
|
||||||
|
cmd = append(cmd, a)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
own = append(own, a)
|
||||||
|
if f, hasValue := commands.LookupArg(fs, a); f != nil && !hasValue && !commands.IsBoolFlag(f) && i+1 < len(args) {
|
||||||
|
i++
|
||||||
|
own = append(own, args[i])
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(a) >= 2 && a[0] == '-' {
|
||||||
|
// The same reading of the argument ParseArgs makes, so a word this lifts as a
|
||||||
|
// client flag's value is one the daemon's parser would have read the same way.
|
||||||
|
if f, hasValue := commands.LookupArg(fs, a); f != nil {
|
||||||
|
own = append(own, a)
|
||||||
|
if !hasValue && !commands.IsBoolFlag(f) && i+1 < len(args) {
|
||||||
|
i++
|
||||||
|
own = append(own, args[i])
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd = append(cmd, a)
|
||||||
|
}
|
||||||
|
|
||||||
|
return own, cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// resolveSocket decides which socket to talk to. It never searches: the answer is the
|
||||||
|
// socket the operator named, or the one the config implies, and nothing else.
|
||||||
|
//
|
||||||
|
// An explicit flag wins. Otherwise the config is read, the one the operator named or the
|
||||||
|
// one found next to the executable, and the path is the socket that config implies: its
|
||||||
|
// local_api.control.socket if set, else the same derivation the daemon applies.
|
||||||
|
func resolveSocket(socketFlag, configFlag string) (string, error) {
|
||||||
|
if socketFlag != "" {
|
||||||
|
return socketFlag, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathFromConfig(configFlag)
|
||||||
|
}
|
||||||
|
|
||||||
|
// pathFromConfig returns the socket path the daemon would be serving: the one
|
||||||
|
// local_api.control.socket names in the config, so an operator who moved the socket does
|
||||||
|
// not have to repeat themselves on every invocation, else the default.
|
||||||
|
//
|
||||||
|
// A config the operator did not name is a guess: config.DefaultPath looks next to the
|
||||||
|
// executable, and a package that installs a default config there while systemd starts
|
||||||
|
// the daemon with another will make it the wrong guess. It is still the only answer
|
||||||
|
// that involves no searching. A guess that cannot be read is not an error, it is no
|
||||||
|
// guess: a member of the socket's group cannot read a root daemon's config, and is
|
||||||
|
// answered by the default path, where the daemon serves unless that config moved it.
|
||||||
|
// A config the operator named is theirs to make readable.
|
||||||
|
func pathFromConfig(configFlag string) (string, error) {
|
||||||
|
return socketFromConfigFile(configFlag, configFlag != "")
|
||||||
|
}
|
||||||
|
|
||||||
|
func socketFromConfigFile(configPath string, named bool) (string, error) {
|
||||||
|
if !named {
|
||||||
|
p, err := config.DefaultPath()
|
||||||
|
if err != nil {
|
||||||
|
return localapi.DefaultSocketPath, nil
|
||||||
|
}
|
||||||
|
configPath = p
|
||||||
|
}
|
||||||
|
|
||||||
|
// The config is loaded only to find the socket path. Loading logs lines that belong
|
||||||
|
// to the daemon, not to someone running a read only command, and mixing them into
|
||||||
|
// the CLI's output would corrupt a -json result, so they are discarded.
|
||||||
|
c := config.NewC(slog.New(slog.DiscardHandler))
|
||||||
|
if err := c.Load(configPath); err != nil {
|
||||||
|
if !named {
|
||||||
|
return localapi.DefaultSocketPath, nil
|
||||||
|
}
|
||||||
|
// The operating system's error, as it came: permission denied on a root daemon's
|
||||||
|
// config says what to do.
|
||||||
|
return "", fmt.Errorf("nebula: could not read %s: %w", configPath, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A daemon running this config serves no socket; dialing the path would only say
|
||||||
|
// that nothing is there.
|
||||||
|
if !localapi.ControlEnabled(c) {
|
||||||
|
return "", fmt.Errorf("nebula: the control socket is disabled in %s by %s", configPath, localapi.CtlEnabledKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The same call the daemon makes, so the two agree on the path and on what makes a
|
||||||
|
// path unusable.
|
||||||
|
p, err := localapi.SocketPathFromConfig(c)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("nebula: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return p, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,294 @@
|
|||||||
|
package ctl
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"flag"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
"github.com/slackhq/nebula/localapi"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestResolveSocketReportsAnUnreadableConfig: an operator who named a config must hear
|
||||||
|
// that it could not be read, rather than have the command steered anywhere else.
|
||||||
|
func TestResolveSocketReportsAnUnreadableConfig(t *testing.T) {
|
||||||
|
missing := filepath.Join(t.TempDir(), "typo.yml")
|
||||||
|
|
||||||
|
_, err := resolveSocket("", missing)
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), missing)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestResolveSocketGuessedConfigNeedNotBeReadable: a config nobody named is a guess, and
|
||||||
|
// one that cannot be read, a root daemon's config read by a member of the socket's
|
||||||
|
// group, means the default path rather than an error.
|
||||||
|
func TestResolveSocketGuessedConfigNeedNotBeReadable(t *testing.T) {
|
||||||
|
missing := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
|
||||||
|
p, err := socketFromConfigFile(missing, false)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, localapi.DefaultSocketPath, p)
|
||||||
|
|
||||||
|
_, err = socketFromConfigFile(missing, true)
|
||||||
|
require.ErrorContains(t, err, missing)
|
||||||
|
}
|
||||||
|
|
||||||
|
// nowhereSocket is a socket name nothing listens on, spelled the way the platform
|
||||||
|
// requires: a full pipe name on windows, an absolute path elsewhere.
|
||||||
|
var nowhereSocket = map[bool]string{true: `\\.\pipe\nebula-nowhere`, false: "/nowhere/ctl.sock"}[runtime.GOOS == "windows"]
|
||||||
|
|
||||||
|
// namedSocketConfig is a config that names nowhereSocket as the control socket. Single
|
||||||
|
// quotes keep a pipe name's backslashes literal in YAML.
|
||||||
|
var namedSocketConfig = "local_api:\n control:\n socket: '" + nowhereSocket + "'\n"
|
||||||
|
|
||||||
|
// TestResolveSocketTrustsANamedConfig: a config the operator named yields the socket it
|
||||||
|
// implies even when nothing is listening there, so a dial failure names that socket.
|
||||||
|
func TestResolveSocketTrustsANamedConfig(t *testing.T) {
|
||||||
|
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
require.NoError(t, os.WriteFile(cfg, []byte(namedSocketConfig), 0600))
|
||||||
|
|
||||||
|
p, err := resolveSocket("", cfg)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, nowhereSocket, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestResolveSocketSaysTheSocketIsDisabled: a config that turns the control socket off
|
||||||
|
// is answered with that, not with a dial to a path nothing serves. -socket still wins.
|
||||||
|
func TestResolveSocketSaysTheSocketIsDisabled(t *testing.T) {
|
||||||
|
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
require.NoError(t, os.WriteFile(cfg, []byte("local_api:\n control:\n enabled: false\n"), 0600))
|
||||||
|
|
||||||
|
_, err := resolveSocket("", cfg)
|
||||||
|
require.ErrorContains(t, err, "the control socket is disabled in "+cfg+" by local_api.control.enabled")
|
||||||
|
|
||||||
|
p, err := resolveSocket("/explicit.sock", cfg)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "/explicit.sock", p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestResolveSocketUsesTheDefaultWithoutAnOverride: a config that does not name the
|
||||||
|
// socket means the default path, the same one the daemon serves with that config, and
|
||||||
|
// no config at all means the default too, since that is where a daemon started without
|
||||||
|
// an override serves. Nothing is searched for.
|
||||||
|
func TestResolveSocketUsesTheDefaultWithoutAnOverride(t *testing.T) {
|
||||||
|
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
require.NoError(t, os.WriteFile(cfg, []byte("static_host_map: {}\n"), 0600))
|
||||||
|
|
||||||
|
p, err := resolveSocket("", cfg)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, localapi.DefaultSocketPath, p)
|
||||||
|
|
||||||
|
// The test binary has no config next to it.
|
||||||
|
p, err = resolveSocket("", "")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, localapi.DefaultSocketPath, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestResolveSocketFlagWins(t *testing.T) {
|
||||||
|
p, err := resolveSocket("/explicit.sock", "/does/not/matter.yml")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "/explicit.sock", p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestParseCommandReportsWhatFlagSaid covers the three ways a flag line goes wrong, which
|
||||||
|
// are different mistakes: an unknown flag, a valid flag with a missing value, and a
|
||||||
|
// valid flag with a value it cannot parse.
|
||||||
|
func TestParseCommandReportsWhatFlagSaid(t *testing.T) {
|
||||||
|
schema := []commands.CommandSchema{{
|
||||||
|
Name: "change-remote",
|
||||||
|
Flags: []commands.FlagSchema{
|
||||||
|
{Name: "address"},
|
||||||
|
{Name: "by-index", Bool: true},
|
||||||
|
},
|
||||||
|
}}
|
||||||
|
|
||||||
|
cases := map[string]struct {
|
||||||
|
argv []string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
"missing value": {[]string{"change-remote", "-address"}, "flag needs an argument: -address"},
|
||||||
|
"bad bool": {[]string{"change-remote", "-by-index=maybe"}, "invalid boolean value \"maybe\" for -by-index"},
|
||||||
|
"unknown flag": {[]string{"change-remote", "-nope"}, "flag provided but not defined: -nope"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, tc := range cases {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
_, _, err := parseCommand(schema, tc.argv)
|
||||||
|
require.Error(t, err)
|
||||||
|
require.ErrorContains(t, err, "nebula: change-remote: "+tc.want)
|
||||||
|
require.ErrorContains(t, err, "see 'nebula ctl change-remote -h'")
|
||||||
|
assert.NotContains(t, err.Error(), "does not take")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestParseCommandOffPresentationFlagIsNoPreference: the daemon treats -json=false as
|
||||||
|
// no preference, so nebula ctl must too, or the same line renders differently on the
|
||||||
|
// two surfaces. Only a true value asks for JSON, and -pretty implies it.
|
||||||
|
func TestParseCommandOffPresentationFlagIsNoPreference(t *testing.T) {
|
||||||
|
schema := []commands.CommandSchema{{
|
||||||
|
Name: "device-info",
|
||||||
|
Flags: []commands.FlagSchema{
|
||||||
|
{Name: commands.FlagJSON, Bool: true, Default: "false"},
|
||||||
|
{Name: commands.FlagPretty, Bool: true, Default: "false"},
|
||||||
|
},
|
||||||
|
}}
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
argv []string
|
||||||
|
want commands.Format
|
||||||
|
wire string
|
||||||
|
}{
|
||||||
|
{[]string{"device-info"}, commands.FormatUnset, "text"},
|
||||||
|
{[]string{"device-info", "-json=false"}, commands.FormatUnset, "text"},
|
||||||
|
{[]string{"device-info", "-json"}, commands.FormatJSON, "json"},
|
||||||
|
{[]string{"device-info", "-pretty"}, commands.FormatPrettyJSON, "json"},
|
||||||
|
} {
|
||||||
|
t.Run(strings.Join(tc.argv[1:], " "), func(t *testing.T) {
|
||||||
|
req, printedHelp, err := parseCommand(schema, tc.argv)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.False(t, printedHelp)
|
||||||
|
assert.Equal(t, tc.want, req.Format)
|
||||||
|
assert.Equal(t, tc.wire, wireFormat(req.Format))
|
||||||
|
assert.Nil(t, req.Params, "presentation flags are never sent as parameters")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestParseCommandReadsTheLineAsTheDaemonDoes: nebula ctl parses the line with the same
|
||||||
|
// rules as the daemon, so an operand after "--" reaches the command on both and a
|
||||||
|
// negative number before it is the flag it would be at an ssh prompt.
|
||||||
|
func TestParseCommandReadsTheLineAsTheDaemonDoes(t *testing.T) {
|
||||||
|
schema := []commands.CommandSchema{{Name: "set"}}
|
||||||
|
|
||||||
|
req, printedHelp, err := parseCommand(schema, []string{"set", "--", "-1"})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.False(t, printedHelp)
|
||||||
|
assert.Equal(t, commands.Name("set"), req.name)
|
||||||
|
assert.Nil(t, req.Params)
|
||||||
|
assert.Equal(t, []string{"-1"}, req.Args)
|
||||||
|
|
||||||
|
_, _, err = parseCommand(schema, []string{"set", "-1"})
|
||||||
|
require.ErrorContains(t, err, "flag provided but not defined: -1")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestOutputRendersForTheFormatAsked: what the daemon answered is read by the format the
|
||||||
|
// line asked for, never by sniffing the bytes. A text answer is the command's rendering,
|
||||||
|
// printed as it came; a JSON answer whose value is a string stays quoted, since to the
|
||||||
|
// script reading it that string is the JSON.
|
||||||
|
func TestOutputRendersForTheFormatAsked(t *testing.T) {
|
||||||
|
text := &localapi.Response{Text: []byte("Log level is: info\n")}
|
||||||
|
assert.Equal(t, "Log level is: info\n", output(text, commands.FormatUnset))
|
||||||
|
assert.Equal(t, "Log level is: info\n", output(text, commands.FormatText))
|
||||||
|
|
||||||
|
str := &localapi.Response{Result: json.RawMessage(`"some string"`)}
|
||||||
|
assert.Equal(t, `"some string"`, output(str, commands.FormatJSON))
|
||||||
|
assert.Equal(t, `"some string"`, output(str, commands.FormatPrettyJSON))
|
||||||
|
|
||||||
|
// Keys stay in the order the daemon wrote them and a uint64 past 2^53 is not rounded,
|
||||||
|
// which decoding into `any` and encoding again would do.
|
||||||
|
obj := &localapi.Response{Result: json.RawMessage(`{"z":18446744073709551615,"a":{"y":[1,2],"b":true}}`)}
|
||||||
|
//nolint:testifylint // the layout is what is under test, which JSONEq would not see
|
||||||
|
assert.Equal(t, `{"z":18446744073709551615,"a":{"y":[1,2],"b":true}}`, output(obj, commands.FormatJSON))
|
||||||
|
//nolint:testifylint // as above
|
||||||
|
assert.Equal(t, "{\n \"z\": 18446744073709551615,\n \"a\": {\n \"y\": [\n 1,\n 2\n ],\n \"b\": true\n }\n}", output(obj, commands.FormatPrettyJSON))
|
||||||
|
|
||||||
|
bad := &localapi.Response{Result: json.RawMessage(`{"a":`)}
|
||||||
|
assert.Equal(t, `{"a":`, output(bad, commands.FormatPrettyJSON), "what cannot be indented is printed as it came")
|
||||||
|
|
||||||
|
none := &localapi.Response{}
|
||||||
|
assert.Empty(t, output(none, commands.FormatJSON))
|
||||||
|
assert.Empty(t, output(none, commands.FormatUnset))
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSplitLineLiftsOwnFlagsFromAnywhere: -config and -socket are the client's wherever
|
||||||
|
// they appear, before the command or after it, in either spelling, so the two orders
|
||||||
|
// mean the same line. Everything else after the command word stays in order for the
|
||||||
|
// command's own parse, including flags and operands that happen to look like values.
|
||||||
|
func TestSplitLineLiftsOwnFlagsFromAnywhere(t *testing.T) {
|
||||||
|
newFS := func() *flag.FlagSet {
|
||||||
|
fs := flag.NewFlagSet("nebula ctl", flag.ContinueOnError)
|
||||||
|
fs.String(commands.FlagConfig, "", "")
|
||||||
|
fs.String(commands.FlagSocket, "", "")
|
||||||
|
return fs
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
args []string
|
||||||
|
wantOwn []string
|
||||||
|
wantCmd []string
|
||||||
|
}{
|
||||||
|
{nil, nil, nil},
|
||||||
|
{[]string{"identity"}, nil, []string{"identity"}},
|
||||||
|
{[]string{"-config", "x", "identity"}, []string{"-config", "x"}, []string{"identity"}},
|
||||||
|
{[]string{"identity", "-config", "x"}, []string{"-config", "x"}, []string{"identity"}},
|
||||||
|
{[]string{"identity", "-config=x"}, []string{"-config=x"}, []string{"identity"}},
|
||||||
|
{[]string{"identity", "--socket", "s"}, []string{"--socket", "s"}, []string{"identity"}},
|
||||||
|
{[]string{"-socket", "s", "identity", "-config", "x"}, []string{"-socket", "s", "-config", "x"}, []string{"identity"}},
|
||||||
|
// The command's flags and operands are left where they are, around the lifted ones.
|
||||||
|
{[]string{"print-tunnel", "10.0.0.1", "-config", "x", "-json"}, []string{"-config", "x"}, []string{"print-tunnel", "10.0.0.1", "-json"}},
|
||||||
|
{[]string{"change-remote", "-address", "1.2.3.4:5", "-socket", "s", "10.0.0.1"}, []string{"-socket", "s"}, []string{"change-remote", "-address", "1.2.3.4:5", "10.0.0.1"}},
|
||||||
|
// -h before the command is the client's usage; after it, the command's help.
|
||||||
|
{[]string{"-h"}, []string{"-h"}, nil},
|
||||||
|
{[]string{"identity", "-h"}, nil, []string{"identity", "-h"}},
|
||||||
|
// An unknown flag before the command is the client's to report, and does not
|
||||||
|
// swallow the command word as its value.
|
||||||
|
{[]string{"-nope", "identity"}, []string{"-nope"}, []string{"identity"}},
|
||||||
|
// A -config with nothing after it is left for fs.Parse to report.
|
||||||
|
{[]string{"identity", "-config"}, []string{"-config"}, []string{"identity"}},
|
||||||
|
// "--" before the command is consumed, as fs.Parse consumed it; after the command
|
||||||
|
// it belongs to the line and ends the lifting.
|
||||||
|
{[]string{"--", "identity", "-config", "x"}, []string{"-config", "x"}, []string{"identity"}},
|
||||||
|
{[]string{"identity", "--", "-config", "x"}, nil, []string{"identity", "--", "-config", "x"}},
|
||||||
|
} {
|
||||||
|
t.Run(strings.Join(tc.args, " "), func(t *testing.T) {
|
||||||
|
own, cmd := splitLine(newFS(), tc.args)
|
||||||
|
assert.Equal(t, tc.wantOwn, own)
|
||||||
|
assert.Equal(t, tc.wantCmd, cmd)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestTrailingHandlesWordsAfterTheDaemonsFlags: what flag.Parse leaves behind is never
|
||||||
|
// a daemon to start. A leading ctl runs the client on the rest, with the daemon's
|
||||||
|
// -config carried over; anything else is a mistyped subcommand. Only -h is run here,
|
||||||
|
// since the client's help needs no daemon: it proves the words reach Run and that a
|
||||||
|
// carried -config is accepted by it.
|
||||||
|
func TestTrailingHandlesWordsAfterTheDaemonsFlags(t *testing.T) {
|
||||||
|
code, done := Trailing(nil, "")
|
||||||
|
assert.False(t, done)
|
||||||
|
assert.Equal(t, 0, code)
|
||||||
|
|
||||||
|
code, done = Trailing([]string{"clt"}, "")
|
||||||
|
assert.True(t, done)
|
||||||
|
assert.Equal(t, 1, code)
|
||||||
|
|
||||||
|
code, done = Trailing([]string{Word, "-h"}, "")
|
||||||
|
assert.True(t, done)
|
||||||
|
assert.Equal(t, 0, code)
|
||||||
|
|
||||||
|
code, done = Trailing([]string{Word, "-h"}, "/etc/nebula/config.yml")
|
||||||
|
assert.True(t, done)
|
||||||
|
assert.Equal(t, 0, code)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSubcommandOnlyReadsTheFirstWord: a flag first means the line is the daemon's to
|
||||||
|
// parse, and whatever follows the flags is Trailing's to judge.
|
||||||
|
func TestSubcommandOnlyReadsTheFirstWord(t *testing.T) {
|
||||||
|
_, done := Subcommand([]string{"nebula", "-config", "x", Word})
|
||||||
|
assert.False(t, done)
|
||||||
|
|
||||||
|
code, done := Subcommand([]string{"nebula", "clt"})
|
||||||
|
assert.True(t, done)
|
||||||
|
assert.Equal(t, 1, code)
|
||||||
|
|
||||||
|
code, done = Subcommand([]string{"nebula", Word, "-h"})
|
||||||
|
assert.True(t, done)
|
||||||
|
assert.Equal(t, 0, code)
|
||||||
|
}
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
//go:build !windows
|
||||||
|
|
||||||
|
package ctl
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/localapi"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestResolveSocketDiagnosesAnOverlongOverride: the CLI applies the daemon's own rule to
|
||||||
|
// the override, so it says what the daemon's log says rather than dialing a path the
|
||||||
|
// kernel would truncate and reporting the generic failure. The rule is sun_path's, which
|
||||||
|
// a named pipe does not have, so this is a unix test.
|
||||||
|
func TestResolveSocketDiagnosesAnOverlongOverride(t *testing.T) {
|
||||||
|
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
long := "/" + strings.Repeat("x", 120)
|
||||||
|
require.NoError(t, os.WriteFile(cfg, []byte("local_api:\n control:\n socket: "+long+"\n"), 0600))
|
||||||
|
|
||||||
|
_, err := resolveSocket("", cfg)
|
||||||
|
require.Error(t, err)
|
||||||
|
require.ErrorContains(t, err, "too long for this platform")
|
||||||
|
assert.ErrorContains(t, err, localapi.CtlSocketKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestResolveSocketRefusesARelativeOverride: the CLI applies the daemon's rule here too,
|
||||||
|
// so a relative path in the config is reported as the daemon's log reports it rather
|
||||||
|
// than resolved against wherever nebula ctl happened to be run from.
|
||||||
|
func TestResolveSocketRefusesARelativeOverride(t *testing.T) {
|
||||||
|
cfg := filepath.Join(t.TempDir(), "config.yml")
|
||||||
|
require.NoError(t, os.WriteFile(cfg, []byte("local_api:\n control:\n socket: run/ctl.sock\n"), 0600))
|
||||||
|
|
||||||
|
_, err := resolveSocket("", cfg)
|
||||||
|
require.Error(t, err)
|
||||||
|
require.ErrorContains(t, err, "must be an absolute path")
|
||||||
|
assert.ErrorContains(t, err, localapi.CtlSocketKey)
|
||||||
|
}
|
||||||
@@ -151,7 +151,7 @@ func ca(args []string, out io.Writer, errOut io.Writer, pr PasswordReader) error
|
|||||||
|
|
||||||
var groups []string
|
var groups []string
|
||||||
if *cf.groups != "" {
|
if *cf.groups != "" {
|
||||||
for _, rg := range strings.Split(*cf.groups, ",") {
|
for rg := range strings.SplitSeq(*cf.groups, ",") {
|
||||||
g := strings.TrimSpace(rg)
|
g := strings.TrimSpace(rg)
|
||||||
if g != "" {
|
if g != "" {
|
||||||
groups = append(groups, g)
|
groups = append(groups, g)
|
||||||
@@ -171,7 +171,7 @@ func ca(args []string, out io.Writer, errOut io.Writer, pr PasswordReader) error
|
|||||||
}
|
}
|
||||||
|
|
||||||
if *cf.networks != "" {
|
if *cf.networks != "" {
|
||||||
for _, rs := range strings.Split(*cf.networks, ",") {
|
for rs := range strings.SplitSeq(*cf.networks, ",") {
|
||||||
rs := strings.Trim(rs, " ")
|
rs := strings.Trim(rs, " ")
|
||||||
if rs != "" {
|
if rs != "" {
|
||||||
n, err := netip.ParsePrefix(rs)
|
n, err := netip.ParsePrefix(rs)
|
||||||
@@ -193,7 +193,7 @@ func ca(args []string, out io.Writer, errOut io.Writer, pr PasswordReader) error
|
|||||||
}
|
}
|
||||||
|
|
||||||
if *cf.unsafeNetworks != "" {
|
if *cf.unsafeNetworks != "" {
|
||||||
for _, rs := range strings.Split(*cf.unsafeNetworks, ",") {
|
for rs := range strings.SplitSeq(*cf.unsafeNetworks, ",") {
|
||||||
rs := strings.Trim(rs, " ")
|
rs := strings.Trim(rs, " ")
|
||||||
if rs != "" {
|
if rs != "" {
|
||||||
n, err := netip.ParsePrefix(rs)
|
n, err := netip.ParsePrefix(rs)
|
||||||
@@ -221,7 +221,7 @@ func ca(args []string, out io.Writer, errOut io.Writer, pr PasswordReader) error
|
|||||||
if !isP11 && *cf.encryption {
|
if !isP11 && *cf.encryption {
|
||||||
passphrase = []byte(os.Getenv("NEBULA_CA_PASSPHRASE"))
|
passphrase = []byte(os.Getenv("NEBULA_CA_PASSPHRASE"))
|
||||||
if len(passphrase) == 0 {
|
if len(passphrase) == 0 {
|
||||||
for i := 0; i < 5; i++ {
|
for range 5 {
|
||||||
errOut.Write([]byte("Enter passphrase: "))
|
errOut.Write([]byte("Enter passphrase: "))
|
||||||
passphrase, err = pr.ReadPassword()
|
passphrase, err = pr.ReadPassword()
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build !windows
|
//go:build !windows
|
||||||
// +build !windows
|
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
|
|||||||
@@ -146,7 +146,7 @@ func signCert(args []string, out io.Writer, errOut io.Writer, pr PasswordReader)
|
|||||||
passphrase = []byte(os.Getenv("NEBULA_CA_PASSPHRASE"))
|
passphrase = []byte(os.Getenv("NEBULA_CA_PASSPHRASE"))
|
||||||
if len(passphrase) == 0 {
|
if len(passphrase) == 0 {
|
||||||
// ask for a passphrase until we get one
|
// ask for a passphrase until we get one
|
||||||
for i := 0; i < 5; i++ {
|
for range 5 {
|
||||||
errOut.Write([]byte("Enter passphrase: "))
|
errOut.Write([]byte("Enter passphrase: "))
|
||||||
passphrase, err = pr.ReadPassword()
|
passphrase, err = pr.ReadPassword()
|
||||||
|
|
||||||
@@ -203,7 +203,7 @@ func signCert(args []string, out io.Writer, errOut io.Writer, pr PasswordReader)
|
|||||||
}
|
}
|
||||||
|
|
||||||
if *sf.networks != "" {
|
if *sf.networks != "" {
|
||||||
for _, rs := range strings.Split(*sf.networks, ",") {
|
for rs := range strings.SplitSeq(*sf.networks, ",") {
|
||||||
rs := strings.Trim(rs, " ")
|
rs := strings.Trim(rs, " ")
|
||||||
if rs != "" {
|
if rs != "" {
|
||||||
n, err := netip.ParsePrefix(rs)
|
n, err := netip.ParsePrefix(rs)
|
||||||
@@ -228,7 +228,7 @@ func signCert(args []string, out io.Writer, errOut io.Writer, pr PasswordReader)
|
|||||||
}
|
}
|
||||||
|
|
||||||
if *sf.unsafeNetworks != "" {
|
if *sf.unsafeNetworks != "" {
|
||||||
for _, rs := range strings.Split(*sf.unsafeNetworks, ",") {
|
for rs := range strings.SplitSeq(*sf.unsafeNetworks, ",") {
|
||||||
rs := strings.Trim(rs, " ")
|
rs := strings.Trim(rs, " ")
|
||||||
if rs != "" {
|
if rs != "" {
|
||||||
n, err := netip.ParsePrefix(rs)
|
n, err := netip.ParsePrefix(rs)
|
||||||
@@ -247,7 +247,7 @@ func signCert(args []string, out io.Writer, errOut io.Writer, pr PasswordReader)
|
|||||||
|
|
||||||
var groups []string
|
var groups []string
|
||||||
if *sf.groups != "" {
|
if *sf.groups != "" {
|
||||||
for _, rg := range strings.Split(*sf.groups, ",") {
|
for rg := range strings.SplitSeq(*sf.groups, ",") {
|
||||||
g := strings.TrimSpace(rg)
|
g := strings.TrimSpace(rg)
|
||||||
if g != "" {
|
if g != "" {
|
||||||
groups = append(groups, g)
|
groups = append(groups, g)
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build !windows
|
//go:build !windows
|
||||||
// +build !windows
|
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build !windows
|
//go:build !windows
|
||||||
// +build !windows
|
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,9 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/slackhq/nebula"
|
"github.com/slackhq/nebula"
|
||||||
|
"github.com/slackhq/nebula/cmd/internal/ctl"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
|
"github.com/slackhq/nebula/localapi"
|
||||||
"github.com/slackhq/nebula/logging"
|
"github.com/slackhq/nebula/logging"
|
||||||
"github.com/slackhq/nebula/util"
|
"github.com/slackhq/nebula/util"
|
||||||
)
|
)
|
||||||
@@ -32,6 +34,11 @@ func init() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
// commands are either `nebula ctl ...` or `nebula -<flag> ...`
|
||||||
|
if code, done := ctl.Subcommand(os.Args); done {
|
||||||
|
os.Exit(code)
|
||||||
|
}
|
||||||
|
|
||||||
serviceFlag := flag.String("service", "", "Control the system service.")
|
serviceFlag := flag.String("service", "", "Control the system service.")
|
||||||
configPath := flag.String("config", "", "Path to either a file or directory to load configuration from")
|
configPath := flag.String("config", "", "Path to either a file or directory to load configuration from")
|
||||||
configTest := flag.Bool("test", false, "Test the config and print the end result. Non zero exit indicates a faulty config")
|
configTest := flag.Bool("test", false, "Test the config and print the end result. Non zero exit indicates a faulty config")
|
||||||
@@ -40,6 +47,12 @@ func main() {
|
|||||||
|
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
|
// A word after the daemon's flags is `ctl` in the other place an operator puts it,
|
||||||
|
// or a mistyped subcommand, and either way not a daemon to start; see Trailing.
|
||||||
|
if code, done := ctl.Trailing(flag.Args(), *configPath); done {
|
||||||
|
os.Exit(code)
|
||||||
|
}
|
||||||
|
|
||||||
if *printVersion {
|
if *printVersion {
|
||||||
fmt.Printf("Version: %s\n", Build)
|
fmt.Printf("Version: %s\n", Build)
|
||||||
os.Exit(0)
|
os.Exit(0)
|
||||||
@@ -85,9 +98,10 @@ func main() {
|
|||||||
fmt.Printf("failed to apply logging config: %s", err)
|
fmt.Printf("failed to apply logging config: %s", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
c.RegisterReloadCallback(func(c *config.C) {
|
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||||
if err := logging.ApplyConfig(l, c); err != nil {
|
if err := logging.ApplyConfig(l, c); err != nil {
|
||||||
l.Error("Failed to reconfigure logger on reload", "error", err)
|
l.Error("Failed to reconfigure logger on reload", "error", err)
|
||||||
|
r.Failed()
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -103,9 +117,17 @@ func main() {
|
|||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
local := localapi.Wire(ctrl.Context(), l, c, ctrl.Commands())
|
||||||
|
|
||||||
go ctrl.ShutdownBlock()
|
go ctrl.ShutdownBlock()
|
||||||
|
|
||||||
if err := ctrl.Wait(); err != nil {
|
err := ctrl.Wait()
|
||||||
|
|
||||||
|
// os.Exit skips deferred calls, so the sockets are removed here, before either
|
||||||
|
// exit below, rather than left to a deferred Stop that would never run.
|
||||||
|
local.Stop()
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
l.Error("Nebula stopped due to fatal error", "error", err)
|
l.Error("Nebula stopped due to fatal error", "error", err)
|
||||||
os.Exit(2)
|
os.Exit(2)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"github.com/kardianos/service"
|
"github.com/kardianos/service"
|
||||||
"github.com/slackhq/nebula"
|
"github.com/slackhq/nebula"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
|
"github.com/slackhq/nebula/localapi"
|
||||||
"github.com/slackhq/nebula/logging"
|
"github.com/slackhq/nebula/logging"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -17,6 +18,7 @@ type program struct {
|
|||||||
configPath *string
|
configPath *string
|
||||||
build string
|
build string
|
||||||
control *nebula.Control
|
control *nebula.Control
|
||||||
|
local *localapi.Endpoints
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *program) Start(s service.Service) error {
|
func (p *program) Start(s service.Service) error {
|
||||||
@@ -34,9 +36,10 @@ func (p *program) Start(s service.Service) error {
|
|||||||
if err := logging.ApplyConfig(l, c); err != nil {
|
if err := logging.ApplyConfig(l, c); err != nil {
|
||||||
return fmt.Errorf("failed to apply logging config: %s", err)
|
return fmt.Errorf("failed to apply logging config: %s", err)
|
||||||
}
|
}
|
||||||
c.RegisterReloadCallback(func(c *config.C) {
|
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||||
if err := logging.ApplyConfig(l, c); err != nil {
|
if err := logging.ApplyConfig(l, c); err != nil {
|
||||||
l.Error("Failed to reconfigure logger on reload", "error", err)
|
l.Error("Failed to reconfigure logger on reload", "error", err)
|
||||||
|
r.Failed()
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -49,10 +52,16 @@ func (p *program) Start(s service.Service) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Now that we're started, stand up the local APIs.
|
||||||
|
p.local = localapi.Wire(p.control.Context(), l, c, p.control.Commands())
|
||||||
|
|
||||||
// Nebula can stop itself on a fatal packet reader error, make sure to log it if it happens.
|
// Nebula can stop itself on a fatal packet reader error, make sure to log it if it happens.
|
||||||
go func() {
|
go func() {
|
||||||
if err := p.control.Wait(); err != nil {
|
if err := p.control.Wait(); err != nil {
|
||||||
logger.Error(fmt.Sprintf("Nebula stopped due to fatal error: %v", err))
|
logger.Error(fmt.Sprintf("Nebula stopped due to fatal error: %v", err))
|
||||||
|
// os.Exit skips deferred calls and races the sockets' own context watchers,
|
||||||
|
// so they are removed here, as cmd/nebula does.
|
||||||
|
p.local.Stop()
|
||||||
os.Exit(2)
|
os.Exit(2)
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
@@ -62,6 +71,11 @@ func (p *program) Start(s service.Service) error {
|
|||||||
|
|
||||||
func (p *program) Stop(s service.Service) error {
|
func (p *program) Stop(s service.Service) error {
|
||||||
logger.Info("Nebula service stopping.")
|
logger.Info("Nebula service stopping.")
|
||||||
|
|
||||||
|
if p.local != nil {
|
||||||
|
p.local.Stop()
|
||||||
|
}
|
||||||
|
|
||||||
if p.control == nil {
|
if p.control == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
+24
-2
@@ -8,7 +8,9 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/slackhq/nebula"
|
"github.com/slackhq/nebula"
|
||||||
|
"github.com/slackhq/nebula/cmd/internal/ctl"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
|
"github.com/slackhq/nebula/localapi"
|
||||||
"github.com/slackhq/nebula/logging"
|
"github.com/slackhq/nebula/logging"
|
||||||
"github.com/slackhq/nebula/util"
|
"github.com/slackhq/nebula/util"
|
||||||
)
|
)
|
||||||
@@ -32,6 +34,11 @@ func init() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
// commands are either `nebula ctl ...` or `nebula -<flag> ...`
|
||||||
|
if code, done := ctl.Subcommand(os.Args); done {
|
||||||
|
os.Exit(code)
|
||||||
|
}
|
||||||
|
|
||||||
configPath := flag.String("config", "", "Path to either a file or directory to load configuration from")
|
configPath := flag.String("config", "", "Path to either a file or directory to load configuration from")
|
||||||
configTest := flag.Bool("test", false, "Test the config and print the end result. Non zero exit indicates a faulty config")
|
configTest := flag.Bool("test", false, "Test the config and print the end result. Non zero exit indicates a faulty config")
|
||||||
printVersion := flag.Bool("version", false, "Print version")
|
printVersion := flag.Bool("version", false, "Print version")
|
||||||
@@ -39,6 +46,12 @@ func main() {
|
|||||||
|
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
|
// A word after the daemon's flags is `ctl` in the other place an operator puts it,
|
||||||
|
// or a mistyped subcommand, and either way not a daemon to start; see Trailing.
|
||||||
|
if code, done := ctl.Trailing(flag.Args(), *configPath); done {
|
||||||
|
os.Exit(code)
|
||||||
|
}
|
||||||
|
|
||||||
if *printVersion {
|
if *printVersion {
|
||||||
fmt.Printf("Version: %s\n", Build)
|
fmt.Printf("Version: %s\n", Build)
|
||||||
os.Exit(0)
|
os.Exit(0)
|
||||||
@@ -71,9 +84,10 @@ func main() {
|
|||||||
fmt.Printf("failed to apply logging config: %s", err)
|
fmt.Printf("failed to apply logging config: %s", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
c.RegisterReloadCallback(func(c *config.C) {
|
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||||
if err := logging.ApplyConfig(l, c); err != nil {
|
if err := logging.ApplyConfig(l, c); err != nil {
|
||||||
l.Error("Failed to reconfigure logger on reload", "error", err)
|
l.Error("Failed to reconfigure logger on reload", "error", err)
|
||||||
|
r.Failed()
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -89,10 +103,18 @@ func main() {
|
|||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
local := localapi.Wire(ctrl.Context(), l, c, ctrl.Commands())
|
||||||
|
|
||||||
go ctrl.ShutdownBlock()
|
go ctrl.ShutdownBlock()
|
||||||
notifyReady(l)
|
notifyReady(l)
|
||||||
|
|
||||||
if err := ctrl.Wait(); err != nil {
|
err := ctrl.Wait()
|
||||||
|
|
||||||
|
// os.Exit skips deferred calls, so the sockets are removed here, before either
|
||||||
|
// exit below, rather than left to a deferred Stop that would never run.
|
||||||
|
local.Stop()
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
l.Error("Nebula stopped due to fatal error", "error", err)
|
l.Error("Nebula stopped due to fatal error", "error", err)
|
||||||
os.Exit(2)
|
os.Exit(2)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build !linux
|
//go:build !linux
|
||||||
// +build !linux
|
|
||||||
|
|
||||||
package main
|
package main
|
||||||
|
|
||||||
|
|||||||
+683
@@ -0,0 +1,683 @@
|
|||||||
|
package nebula
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"maps"
|
||||||
|
"net/netip"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/cert"
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
"github.com/slackhq/nebula/config"
|
||||||
|
"github.com/slackhq/nebula/header"
|
||||||
|
"github.com/slackhq/nebula/logging"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The commands nebula serves. attachCommands builds the one registry every surface
|
||||||
|
// reads; the ssh debug server is a consumer of it, not its owner, which is why this
|
||||||
|
// is not ssh.go. See the commands package for what a Command is.
|
||||||
|
|
||||||
|
type listHostMapFlags struct {
|
||||||
|
ByIndex bool
|
||||||
|
}
|
||||||
|
|
||||||
|
type printCertFlags struct {
|
||||||
|
Raw bool
|
||||||
|
|
||||||
|
// Address is the -address form of the vpn addr, which the info API needs since a
|
||||||
|
// query string has no operands; see identityFlags for why presence is recorded.
|
||||||
|
Address string
|
||||||
|
addressSet bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *printCertFlags) setAddress(v string) error {
|
||||||
|
f.Address = v
|
||||||
|
f.addressSet = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type changeRemoteFlags struct {
|
||||||
|
Address string
|
||||||
|
}
|
||||||
|
|
||||||
|
type closeTunnelFlags struct {
|
||||||
|
LocalOnly bool
|
||||||
|
}
|
||||||
|
|
||||||
|
type createTunnelFlags struct {
|
||||||
|
Address string
|
||||||
|
}
|
||||||
|
|
||||||
|
// lighthouseInfo is one entry of list-lighthouse-addrmap.
|
||||||
|
type lighthouseInfo struct {
|
||||||
|
VpnAddr string `json:"vpnAddr"`
|
||||||
|
Addrs *CacheMap `json:"addrs"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// deviceInfo is the result of device-info.
|
||||||
|
type deviceInfo struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Cidr []netip.Prefix `json:"cidr"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// certPEM is the result of print-cert -raw. The PEM form is a different thing to emit,
|
||||||
|
// not a different formatting of the certificate, so it is its own shape.
|
||||||
|
type certPEM struct {
|
||||||
|
PEM string `json:"pem"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Result shapes for print-relays. Field names are the JSON keys; changing them would
|
||||||
|
// change the output.
|
||||||
|
type relayFor struct {
|
||||||
|
Error string `json:",omitempty"`
|
||||||
|
Type string
|
||||||
|
State string
|
||||||
|
PeerAddr netip.Addr
|
||||||
|
LocalIndex uint32
|
||||||
|
RemoteIndex uint32
|
||||||
|
RelayedThrough []netip.Addr
|
||||||
|
}
|
||||||
|
|
||||||
|
type relayOutput struct {
|
||||||
|
NebulaAddr netip.Addr
|
||||||
|
RelayForAddrs []relayFor
|
||||||
|
}
|
||||||
|
|
||||||
|
type relaysOutput struct {
|
||||||
|
Relays []*relayOutput
|
||||||
|
}
|
||||||
|
|
||||||
|
type versionInfo struct {
|
||||||
|
Version string `json:"version"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type logLevelInfo struct {
|
||||||
|
Level string `json:"level"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type logFormatInfo struct {
|
||||||
|
Format string `json:"format"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// defineListHostMapFlags declares the flags list-hostmap and list-pending-hostmap share.
|
||||||
|
func defineListHostMapFlags(fl *flag.FlagSet, s *listHostMapFlags) {
|
||||||
|
fl.BoolVar(&s.ByIndex, "by-index", false, "gets all hosts in the hostmap from the index table")
|
||||||
|
}
|
||||||
|
|
||||||
|
func attachCommands(l *slog.Logger, c *config.C, reg *commands.Registry, f *Interface) {
|
||||||
|
reg.Register(commands.Flagged(&commands.Command{
|
||||||
|
Name: commands.ListHostmap,
|
||||||
|
ShortDescription: "List all known previously connected hosts",
|
||||||
|
Text: commands.Typed(textListHostMap),
|
||||||
|
}, defineListHostMapFlags, func(s *listHostMapFlags, a []string) (commands.Result, error) {
|
||||||
|
return runListHostMap(f.hostMap, s)
|
||||||
|
}))
|
||||||
|
|
||||||
|
reg.Register(commands.Flagged(&commands.Command{
|
||||||
|
Name: commands.ListPendingHostmap,
|
||||||
|
ShortDescription: "List all handshaking hosts",
|
||||||
|
Text: commands.Typed(textListHostMap),
|
||||||
|
}, defineListHostMapFlags, func(s *listHostMapFlags, a []string) (commands.Result, error) {
|
||||||
|
return runListHostMap(f.handshakeManager, s)
|
||||||
|
}))
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.ListLighthouseAddrmap,
|
||||||
|
ShortDescription: "List all lighthouse map entries",
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
return runListLighthouseMap(f.lightHouse)
|
||||||
|
},
|
||||||
|
Text: commands.Typed(textListLighthouseMap),
|
||||||
|
})
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.Reload,
|
||||||
|
ShortDescription: "Reloads configuration from disk, same as sending HUP to the process",
|
||||||
|
// The line goes out before the reload: a reload that restarts the ssh server ends
|
||||||
|
// the session that asked, and this is what it sees.
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
return commands.Did("Reloading config"), nil
|
||||||
|
},
|
||||||
|
Then: func() commands.Result {
|
||||||
|
return runReload(l, c)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.LogLevel,
|
||||||
|
ShortDescription: "Gets or sets the current log level",
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
return runLogLevel(l, a)
|
||||||
|
},
|
||||||
|
Text: commands.Typed(textLogLevel),
|
||||||
|
})
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.LogFormat,
|
||||||
|
ShortDescription: "Gets or sets the current log format",
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
return runLogFormat(l, a)
|
||||||
|
},
|
||||||
|
Text: commands.Typed(textLogFormat),
|
||||||
|
})
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.Version,
|
||||||
|
ShortDescription: "Prints the currently running version of nebula",
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
return commands.Value(versionInfo{Version: f.version}), nil
|
||||||
|
},
|
||||||
|
Text: commands.Typed(textVersion),
|
||||||
|
})
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.DeviceInfo,
|
||||||
|
ShortDescription: "Prints information about the network device.",
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
return commands.Value(runDeviceInfo(f)), nil
|
||||||
|
},
|
||||||
|
Text: commands.Typed(textDeviceInfo),
|
||||||
|
})
|
||||||
|
|
||||||
|
reg.Register(commands.Flagged(&commands.Command{
|
||||||
|
Name: commands.PrintCert,
|
||||||
|
ShortDescription: "Prints the current certificate being used or the certificate for the provided vpn addr",
|
||||||
|
Help: "The vpn addr is an operand or -address, which may carry a port so a connection's remote address can be passed through as is. For a peer it is the certificate nebula verified when the tunnel came up; with no address it is this node's own, the v2 certificate when both versions are loaded. -raw prints the PEM.",
|
||||||
|
Identity: true,
|
||||||
|
Text: textPrintCert,
|
||||||
|
}, func(fl *flag.FlagSet, s *printCertFlags) {
|
||||||
|
fl.BoolVar(&s.Raw, "raw", false, "prints the PEM encoded certificate; with -json, an object holding it")
|
||||||
|
fl.Func("address", "The vpn addr to look up, optionally with a port", s.setAddress)
|
||||||
|
}, func(s *printCertFlags, a []string) (commands.Result, error) {
|
||||||
|
return runPrintCert(f, s, a)
|
||||||
|
}))
|
||||||
|
|
||||||
|
reg.Register(commands.Flagged(&commands.Command{
|
||||||
|
Name: commands.Identity,
|
||||||
|
ShortDescription: "Prints the certificate identity of the host owning the provided vpn addr",
|
||||||
|
Help: "Identity is what the certificate says: name, vpn addrs, networks, groups, fingerprint, issuer and validity. The address may carry a port, so a connection's remote address can be passed through as is. For this node's own identity use whoami.",
|
||||||
|
Identity: true,
|
||||||
|
Text: commands.Typed(textIdentity),
|
||||||
|
}, func(fl *flag.FlagSet, s *identityFlags) {
|
||||||
|
fl.Func("address", "The vpn addr to look up, optionally with a port", s.setAddress)
|
||||||
|
}, func(s *identityFlags, a []string) (commands.Result, error) {
|
||||||
|
return runIdentity(f, s, a)
|
||||||
|
}))
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.Whoami,
|
||||||
|
ShortDescription: "Prints the certificate identity of this node",
|
||||||
|
Help: "The fields identity prints, read from this node's own certificate.",
|
||||||
|
Identity: true,
|
||||||
|
Text: commands.Typed(textIdentity),
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
if len(a) > 0 {
|
||||||
|
return commands.Failed("whoami takes no arguments"), nil
|
||||||
|
}
|
||||||
|
return runWhoami(f)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.PrintTunnel,
|
||||||
|
ShortDescription: "Prints json details about a tunnel for the provided vpn addr",
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
return runPrintTunnel(f, a)
|
||||||
|
},
|
||||||
|
// No Text on purpose: nothing human readable exists yet, and shipping an interim
|
||||||
|
// form would invite scripts against it. ssh defaults these to JSON; ctl asks.
|
||||||
|
JSONOnly: true,
|
||||||
|
})
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.PrintRelays,
|
||||||
|
ShortDescription: "Prints json details about all relay info",
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
return commands.Value(runPrintRelays(f)), nil
|
||||||
|
},
|
||||||
|
// No Text on purpose; see print-tunnel.
|
||||||
|
JSONOnly: true,
|
||||||
|
})
|
||||||
|
|
||||||
|
reg.Register(commands.Flagged(&commands.Command{
|
||||||
|
Name: commands.ChangeRemote,
|
||||||
|
ShortDescription: "Changes the remote address used in the tunnel for the provided vpn addr",
|
||||||
|
}, func(fl *flag.FlagSet, s *changeRemoteFlags) {
|
||||||
|
fl.StringVar(&s.Address, "address", "", "The new remote address, ip:port")
|
||||||
|
}, func(s *changeRemoteFlags, a []string) (commands.Result, error) {
|
||||||
|
return runChangeRemote(f, s, a)
|
||||||
|
}))
|
||||||
|
|
||||||
|
reg.Register(commands.Flagged(&commands.Command{
|
||||||
|
Name: commands.CloseTunnel,
|
||||||
|
ShortDescription: "Closes a tunnel for the provided vpn addr",
|
||||||
|
}, func(fl *flag.FlagSet, s *closeTunnelFlags) {
|
||||||
|
fl.BoolVar(&s.LocalOnly, "local-only", false, "Disables notifying the remote that the tunnel is shutting down")
|
||||||
|
}, func(s *closeTunnelFlags, a []string) (commands.Result, error) {
|
||||||
|
return runCloseTunnel(f, s, a)
|
||||||
|
}))
|
||||||
|
|
||||||
|
reg.Register(commands.Flagged(&commands.Command{
|
||||||
|
Name: commands.CreateTunnel,
|
||||||
|
ShortDescription: "Creates a tunnel for the provided vpn address",
|
||||||
|
Help: "The lighthouses will be queried for real addresses but you can provide one as well.",
|
||||||
|
}, func(fl *flag.FlagSet, s *createTunnelFlags) {
|
||||||
|
fl.StringVar(&s.Address, "address", "", "Optionally provide a real remote address, ip:port ")
|
||||||
|
}, func(s *createTunnelFlags, a []string) (commands.Result, error) {
|
||||||
|
return runCreateTunnel(f, s, a)
|
||||||
|
}))
|
||||||
|
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: commands.QueryLighthouse,
|
||||||
|
ShortDescription: "Query the lighthouses for the provided vpn address",
|
||||||
|
Help: "This command is asynchronous. Only currently known udp addresses will be printed.",
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
return runQueryLighthouse(f, a)
|
||||||
|
},
|
||||||
|
// No Text on purpose; see print-tunnel.
|
||||||
|
JSONOnly: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// runListHostMap computes the hostmap listing. Presentation is Render's job.
|
||||||
|
func runListHostMap(hl controlHostLister, fs *listHostMapFlags) (commands.Result, error) {
|
||||||
|
var hm []ControlHostInfo
|
||||||
|
if fs.ByIndex {
|
||||||
|
hm = listHostMapIndexes(hl)
|
||||||
|
} else {
|
||||||
|
hm = listHostMapHosts(hl)
|
||||||
|
}
|
||||||
|
|
||||||
|
sort.Slice(hm, func(i, j int) bool {
|
||||||
|
return hm[i].VpnAddrs[0].Compare(hm[j].VpnAddrs[0]) < 0
|
||||||
|
})
|
||||||
|
|
||||||
|
return commands.Value(hm), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// textListHostMap is the human rendering, shared by every surface.
|
||||||
|
func textListHostMap(hm []ControlHostInfo, w io.Writer) error {
|
||||||
|
for _, h := range hm {
|
||||||
|
if _, err := fmt.Fprintf(w, "%s: %s\n", h.VpnAddrs, h.RemoteAddrs); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runListLighthouseMap(lightHouse *LightHouse) (commands.Result, error) {
|
||||||
|
lightHouse.RLock()
|
||||||
|
addrMap := make([]lighthouseInfo, len(lightHouse.addrMap))
|
||||||
|
x := 0
|
||||||
|
for k, v := range lightHouse.addrMap {
|
||||||
|
addrMap[x] = lighthouseInfo{
|
||||||
|
VpnAddr: k.String(),
|
||||||
|
Addrs: v.CopyCache(),
|
||||||
|
}
|
||||||
|
x++
|
||||||
|
}
|
||||||
|
lightHouse.RUnlock()
|
||||||
|
|
||||||
|
sort.Slice(addrMap, func(i, j int) bool {
|
||||||
|
return strings.Compare(addrMap[i].VpnAddr, addrMap[j].VpnAddr) < 0
|
||||||
|
})
|
||||||
|
|
||||||
|
return commands.Value(addrMap), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func textListLighthouseMap(addrMap []lighthouseInfo, w io.Writer) error {
|
||||||
|
for _, e := range addrMap {
|
||||||
|
b, err := json.Marshal(e.Addrs)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if _, err := fmt.Fprintf(w, "%s: %s\n", e.VpnAddr, string(b)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func textVersion(vi versionInfo, w io.Writer) error {
|
||||||
|
_, err := fmt.Fprintf(w, "%s\n", vi.Version)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// vpnAddrOperand parses the vpn address a command takes as its first operand. noun is
|
||||||
|
// how the command's messages name it, "vpn address" or "vpn addr", which the output
|
||||||
|
// golden pins per command. With no operand, or one that does not parse, ok is false and
|
||||||
|
// res is the refusal to return.
|
||||||
|
func vpnAddrOperand(a []string, noun string) (vpnAddr netip.Addr, res commands.Result, ok bool) {
|
||||||
|
if len(a) == 0 {
|
||||||
|
return netip.Addr{}, commands.Failed("No vpn address was provided"), false
|
||||||
|
}
|
||||||
|
|
||||||
|
vpnAddr, err := netip.ParseAddr(a[0])
|
||||||
|
if err != nil {
|
||||||
|
return netip.Addr{}, commands.Failed("The provided %s could not be parsed: %s", noun, a[0]), false
|
||||||
|
}
|
||||||
|
|
||||||
|
return vpnAddr, commands.Result{}, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// tunnelOperand is vpnAddrOperand followed by the lookup of the tunnel it names.
|
||||||
|
func tunnelOperand(ifce *Interface, a []string, noun string) (*HostInfo, commands.Result, bool) {
|
||||||
|
vpnAddr, res, ok := vpnAddrOperand(a, noun)
|
||||||
|
if !ok {
|
||||||
|
return nil, res, false
|
||||||
|
}
|
||||||
|
|
||||||
|
hostInfo := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||||
|
if hostInfo == nil {
|
||||||
|
return nil, commands.Failed("Could not find tunnel for %s: %v", noun, a[0]), false
|
||||||
|
}
|
||||||
|
|
||||||
|
return hostInfo, commands.Result{}, true
|
||||||
|
}
|
||||||
|
|
||||||
|
func runQueryLighthouse(ifce *Interface, a []string) (commands.Result, error) {
|
||||||
|
vpnAddr, res, ok := vpnAddrOperand(a, "vpn address")
|
||||||
|
if !ok {
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var cm *CacheMap
|
||||||
|
rl := ifce.lightHouse.Query(vpnAddr)
|
||||||
|
if rl != nil {
|
||||||
|
cm = rl.CopyCache()
|
||||||
|
}
|
||||||
|
return commands.Value(cm), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runCloseTunnel(ifce *Interface, flags *closeTunnelFlags, a []string) (commands.Result, error) {
|
||||||
|
hostInfo, res, ok := tunnelOperand(ifce, a, "vpn address")
|
||||||
|
if !ok {
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if !flags.LocalOnly {
|
||||||
|
ifce.send(
|
||||||
|
header.CloseTunnel,
|
||||||
|
0,
|
||||||
|
hostInfo.ConnectionState,
|
||||||
|
hostInfo,
|
||||||
|
[]byte{},
|
||||||
|
make([]byte, 12, 12),
|
||||||
|
make([]byte, mtu),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
ifce.closeTunnel(hostInfo)
|
||||||
|
return commands.Did("Closed"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runCreateTunnel(ifce *Interface, flags *createTunnelFlags, a []string) (commands.Result, error) {
|
||||||
|
|
||||||
|
vpnAddr, res, ok := vpnAddrOperand(a, "vpn address")
|
||||||
|
if !ok {
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if hostInfo := ifce.hostMap.QueryVpnAddr(vpnAddr); hostInfo != nil {
|
||||||
|
return commands.Failed("Tunnel already exists"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if hostInfo := ifce.handshakeManager.QueryVpnAddr(vpnAddr); hostInfo != nil {
|
||||||
|
return commands.Failed("Tunnel already handshaking"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var addr netip.AddrPort
|
||||||
|
if flags.Address != "" {
|
||||||
|
var err error
|
||||||
|
addr, err = netip.ParseAddrPort(flags.Address)
|
||||||
|
if err != nil {
|
||||||
|
return commands.Failed("Address could not be parsed"), nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set the remote from the callback, which StartHandshake runs under the handshake manager lock
|
||||||
|
// before the hostinfo reaches the handshake loop or the static-host trigger, so the address is
|
||||||
|
// in the RemoteList before the first handshake is sent.
|
||||||
|
ifce.handshakeManager.StartHandshake(vpnAddr, func(hh *HandshakeHostInfo) {
|
||||||
|
if addr.IsValid() {
|
||||||
|
hh.hostinfo.SetRemote(addr)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
return commands.Did("Created"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runChangeRemote(ifce *Interface, flags *changeRemoteFlags, a []string) (commands.Result, error) {
|
||||||
|
|
||||||
|
if len(a) == 0 {
|
||||||
|
return commands.Failed("No vpn address was provided"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if flags.Address == "" {
|
||||||
|
return commands.Failed("No address was provided"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
addr, err := netip.ParseAddrPort(flags.Address)
|
||||||
|
if err != nil {
|
||||||
|
return commands.Failed("Address could not be parsed"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
hostInfo, res, ok := tunnelOperand(ifce, a, "vpn address")
|
||||||
|
if !ok {
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
hostInfo.SetRemote(addr)
|
||||||
|
return commands.Did("Changed"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runLogLevel(l *slog.Logger, a []string) (commands.Result, error) {
|
||||||
|
ctrl, ok := l.Handler().(interface {
|
||||||
|
GetLevel() slog.Level
|
||||||
|
SetLevel(slog.Level)
|
||||||
|
})
|
||||||
|
if !ok {
|
||||||
|
return commands.Failed("Log level is not reconfigurable on this logger"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(a) > 0 {
|
||||||
|
level, err := logging.ParseLevel(strings.ToLower(a[0]))
|
||||||
|
if err != nil {
|
||||||
|
return commands.Failed("Unknown log level %s. Possible log levels: trace, debug, info, warn, error", a), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
ctrl.SetLevel(level)
|
||||||
|
}
|
||||||
|
|
||||||
|
return commands.Value(logLevelInfo{Level: logging.LevelName(ctrl.GetLevel())}), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func textLogLevel(li logLevelInfo, w io.Writer) error {
|
||||||
|
_, err := fmt.Fprintf(w, "Log level is: %s\n", li.Level)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func runLogFormat(l *slog.Logger, a []string) (commands.Result, error) {
|
||||||
|
ctrl, ok := l.Handler().(interface {
|
||||||
|
GetFormat() string
|
||||||
|
SetFormat(string) error
|
||||||
|
})
|
||||||
|
if !ok {
|
||||||
|
return commands.Failed("Log format is not reconfigurable on this logger"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(a) > 0 {
|
||||||
|
if err := ctrl.SetFormat(strings.ToLower(a[0])); err != nil {
|
||||||
|
return commands.Failed("Unable to set log format: %s", err), nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return commands.Value(logFormatInfo{Format: ctrl.GetFormat()}), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func textLogFormat(fi logFormatInfo, w io.Writer) error {
|
||||||
|
_, err := fmt.Fprintf(w, "Log format is: %s\n", fi.Format)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// runPrintCert prints a certificate: this node's own, or the one the host owning a vpn
|
||||||
|
// addr presented. The addr is an operand, as it always was over ssh, or -address, which
|
||||||
|
// is how the info API names it, and an address of our own answers with our own
|
||||||
|
// certificate as identity does. A tunnel still handshaking, or one being torn down, has
|
||||||
|
// no certificate and is reported as not found.
|
||||||
|
func runPrintCert(ifce *Interface, args *printCertFlags, a []string) (commands.Result, error) {
|
||||||
|
if len(a) > 0 && args.addressSet {
|
||||||
|
return commands.Failed("print-cert takes one vpn addr, as -address or as an operand, not both"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
cs := ifce.pki.getCertState()
|
||||||
|
var c cert.Certificate
|
||||||
|
switch {
|
||||||
|
case len(a) > 0:
|
||||||
|
vpnAddr, res, ok := vpnAddrOperand(a, "vpn addr")
|
||||||
|
if !ok {
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
if c, _ = findCertificateForVpnAddr(cs, ifce.hostMap, vpnAddr); c == nil {
|
||||||
|
return commands.NotFound("Could not find tunnel for vpn addr: %v", a[0]), nil
|
||||||
|
}
|
||||||
|
case args.addressSet:
|
||||||
|
vpnAddr, err := parseVpnAddrWithOptionalPort(args.Address)
|
||||||
|
if err != nil {
|
||||||
|
return commands.Failed("The provided vpn addr could not be parsed: %s", args.Address), nil
|
||||||
|
}
|
||||||
|
if c, _ = findCertificateForVpnAddr(cs, ifce.hostMap, vpnAddr); c == nil {
|
||||||
|
return commands.NotFound("Could not find tunnel for vpn addr: %v", args.Address), nil
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
if c = ownCertificate(cs); c == nil {
|
||||||
|
return commands.Failed("No certificate is loaded"), nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if args.Raw {
|
||||||
|
b, err := c.MarshalPEM()
|
||||||
|
if err != nil {
|
||||||
|
return commands.Failed("Unable to marshal the certificate: %s", err), nil
|
||||||
|
}
|
||||||
|
return commands.Value(certPEM{PEM: string(b)}), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return commands.Value(c), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// textPrintCert takes the value untyped: print-cert returns a certificate or, with -raw,
|
||||||
|
// its PEM, and those are two things to emit rather than two renderings of one.
|
||||||
|
func textPrintCert(v any, w io.Writer) error {
|
||||||
|
switch c := v.(type) {
|
||||||
|
case certPEM:
|
||||||
|
_, err := io.WriteString(w, c.PEM)
|
||||||
|
return err
|
||||||
|
case cert.Certificate:
|
||||||
|
_, err := io.WriteString(w, c.String()+"\n")
|
||||||
|
return err
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("expected a certificate, got %T", v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func runPrintRelays(ifce *Interface) any {
|
||||||
|
ifce.hostMap.RLock()
|
||||||
|
relays := maps.Clone(ifce.hostMap.Relays)
|
||||||
|
ifce.hostMap.RUnlock()
|
||||||
|
|
||||||
|
co := relaysOutput{}
|
||||||
|
|
||||||
|
for k, v := range relays {
|
||||||
|
ro := relayOutput{NebulaAddr: v.vpnAddrs[0]}
|
||||||
|
co.Relays = append(co.Relays, &ro)
|
||||||
|
relayHI := ifce.hostMap.QueryVpnAddr(v.vpnAddrs[0])
|
||||||
|
if relayHI == nil {
|
||||||
|
ro.RelayForAddrs = append(ro.RelayForAddrs, relayFor{Error: "could not find hostinfo"})
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, vpnAddr := range relayHI.relayState.CopyRelayForIps() {
|
||||||
|
rf := relayFor{}
|
||||||
|
r, ok := relayHI.relayState.GetRelayForByAddr(vpnAddr)
|
||||||
|
if ok {
|
||||||
|
t := ""
|
||||||
|
switch r.Type {
|
||||||
|
case ForwardingType:
|
||||||
|
t = "forwarding"
|
||||||
|
case TerminalType:
|
||||||
|
t = "terminal"
|
||||||
|
default:
|
||||||
|
t = "unknown"
|
||||||
|
}
|
||||||
|
|
||||||
|
st := ""
|
||||||
|
switch r.State {
|
||||||
|
case Requested:
|
||||||
|
st = "requested"
|
||||||
|
case Established:
|
||||||
|
st = "established"
|
||||||
|
default:
|
||||||
|
st = "unknown"
|
||||||
|
}
|
||||||
|
|
||||||
|
rf.LocalIndex = r.LocalIndex
|
||||||
|
rf.RemoteIndex = r.RemoteIndex
|
||||||
|
rf.PeerAddr = r.PeerAddr
|
||||||
|
rf.Type = t
|
||||||
|
rf.State = st
|
||||||
|
if rf.LocalIndex != k {
|
||||||
|
rf.Error = fmt.Sprintf("hostmap LocalIndex '%v' does not match RelayState LocalIndex", k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
relayedHI := ifce.hostMap.QueryVpnAddr(vpnAddr)
|
||||||
|
if relayedHI != nil {
|
||||||
|
rf.RelayedThrough = append(rf.RelayedThrough, relayedHI.relayState.CopyRelayIps()...)
|
||||||
|
}
|
||||||
|
|
||||||
|
ro.RelayForAddrs = append(ro.RelayForAddrs, rf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return co
|
||||||
|
}
|
||||||
|
|
||||||
|
func runPrintTunnel(ifce *Interface, a []string) (commands.Result, error) {
|
||||||
|
hostInfo, res, ok := tunnelOperand(ifce, a, "vpn addr")
|
||||||
|
if !ok {
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return commands.Value(copyHostInfo(hostInfo, ifce.hostMap.GetPreferredRanges())), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runDeviceInfo(ifce *Interface) deviceInfo {
|
||||||
|
d := deviceInfo{
|
||||||
|
Name: ifce.inside.Name(),
|
||||||
|
Cidr: make([]netip.Prefix, len(ifce.inside.Networks())),
|
||||||
|
}
|
||||||
|
copy(d.Cidr, ifce.inside.Networks())
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
func textDeviceInfo(d deviceInfo, w io.Writer) error {
|
||||||
|
_, err := fmt.Fprintf(w, "name=%v cidr=%v\n", d.Name, d.Cidr)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// runReload reloads the config and reports how it went. A reload that failed is a
|
||||||
|
// refusal, exit 1 over ssh; one that merely needs a restart is not.
|
||||||
|
func runReload(l *slog.Logger, c *config.C) commands.Result {
|
||||||
|
res := c.ReloadConfig()
|
||||||
|
res.Log(l)
|
||||||
|
if res.Err != nil || res.Failed {
|
||||||
|
return commands.Failed("%s", res.String())
|
||||||
|
}
|
||||||
|
return commands.Did("%s", res.String())
|
||||||
|
}
|
||||||
@@ -0,0 +1,303 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// CommandFlags is called before help or command execution to parse command line flags.
|
||||||
|
// It should return a flag.FlagSet instance and a pointer to the struct that will contain parsed flags
|
||||||
|
//
|
||||||
|
// Every call must build a fresh FlagSet and a fresh struct. Nothing may be shared between
|
||||||
|
// calls: a command runs on more than one surface and on more than one goroutine.
|
||||||
|
type CommandFlags func() (*flag.FlagSet, any)
|
||||||
|
|
||||||
|
// RunFunc computes a command's Result.
|
||||||
|
//
|
||||||
|
// fs is the pointer returned by Command.Flags, if there was one; -h, -help, -json and
|
||||||
|
// -pretty are reserved and handled before Run is called. a is the operands: whatever
|
||||||
|
// was not consumed as a flag. The Result is rendered by whichever surface asked: Value
|
||||||
|
// for a command that reports, Did or Failed for one that acts, Nothing for one with
|
||||||
|
// nothing to say. An error is for a failure of the command itself; a bad argument is
|
||||||
|
// Failed, so the caller hears why in its own format.
|
||||||
|
type RunFunc func(fs any, a []string) (Result, error)
|
||||||
|
|
||||||
|
// TextFunc renders a Result's Value for a person. See Typed for declaring one against
|
||||||
|
// the type the command actually returns.
|
||||||
|
type TextFunc func(v any, w io.Writer) error
|
||||||
|
|
||||||
|
type Command struct {
|
||||||
|
Name Name
|
||||||
|
ShortDescription string
|
||||||
|
Help string
|
||||||
|
|
||||||
|
// Identity indicates this command should be made available via the info socket.
|
||||||
|
Identity bool
|
||||||
|
|
||||||
|
Flags CommandFlags
|
||||||
|
|
||||||
|
// Run produces the command's Result, leaving presentation to Render.
|
||||||
|
Run RunFunc
|
||||||
|
|
||||||
|
// Text renders a Result's Value for a person. Both surfaces call it, so a command
|
||||||
|
// reads the same over ssh as it does through the control socket. It never sees an
|
||||||
|
// outcome: Render prints those itself, the same way for every command. Leaving it
|
||||||
|
// nil declares that no human rendering of the Value exists yet, which JSONOnly says
|
||||||
|
// up front; Render then refuses text rather than inventing an interim form for
|
||||||
|
// people to script against.
|
||||||
|
Text TextFunc
|
||||||
|
|
||||||
|
// JSONOnly declares that the command's Value has no human rendering yet, so a surface
|
||||||
|
// whose default is text asks for JSON instead, and the schema says so to a client. It
|
||||||
|
// is a statement that no such form exists, not a fallback. A refusal is still
|
||||||
|
// rendered as a sentence, since that always has a human form.
|
||||||
|
JSONOnly bool
|
||||||
|
|
||||||
|
// Then, when set, is the second half of a command that acts: Run says what is about
|
||||||
|
// to happen and Then does it and says how it went, with its Result rendered after
|
||||||
|
// Run's and deciding the outcome. A Run that refused is the outcome, and Then does
|
||||||
|
// not run. It exists for a command whose action can cut off
|
||||||
|
// its own reply: reload restarts the ssh server when the sshd keys changed, which
|
||||||
|
// ends the session that asked, so Run's line has to be on the wire before the reload
|
||||||
|
// begins. A surface that answers in one piece, the control socket, runs Then before
|
||||||
|
// it answers and carries both.
|
||||||
|
Then func() Result
|
||||||
|
}
|
||||||
|
|
||||||
|
// Failure is the error a surface gets for a refusal the person has already been shown:
|
||||||
|
// a Run that returned Failed, a command that is not there, a line that would not parse.
|
||||||
|
// The message it rendered is the whole story, so the surface reports the failure, exit
|
||||||
|
// status 1 over ssh, and does not log it.
|
||||||
|
type Failure struct {
|
||||||
|
Msg string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *Failure) Error() string {
|
||||||
|
return f.Msg
|
||||||
|
}
|
||||||
|
|
||||||
|
// commandFlags returns the FlagSet a command is driven through, on any surface: the
|
||||||
|
// command's own flags, if it declares any, with the two presentation flags added. own
|
||||||
|
// reports whether the command declared any of its own, which is what tells a caller
|
||||||
|
// whether to say a parameter is unknown or that the command takes none at all.
|
||||||
|
//
|
||||||
|
// The presentation flags are defined here rather than by each command, because how a
|
||||||
|
// result is displayed is not a property of the command that produced it. This is also
|
||||||
|
// the one definition of them: the ssh line parses into it, nebula ctl parses its line
|
||||||
|
// against the schema derived from it, and help renders from that schema. They are
|
||||||
|
// command line flags only: a socket request chooses its rendering with the envelope's
|
||||||
|
// format field, and Invoke refuses them as parameters.
|
||||||
|
func commandFlags(c *Command) (fl *flag.FlagSet, fs any, own bool) {
|
||||||
|
if c.Flags != nil {
|
||||||
|
fl, fs = c.Flags()
|
||||||
|
}
|
||||||
|
own = fl != nil
|
||||||
|
if fl == nil {
|
||||||
|
fl = flag.NewFlagSet(string(c.Name), flag.ContinueOnError)
|
||||||
|
}
|
||||||
|
|
||||||
|
addPresentationFlags(fl)
|
||||||
|
|
||||||
|
// What Parse prints after a bad flag, and for -h: the command's usage as help renders
|
||||||
|
// it, so a line that went wrong is answered with the same text as `help <command>`.
|
||||||
|
fl.Usage = func() { _ = WriteCommandHelp(schemaOf(c, fl), fl.Output()) }
|
||||||
|
|
||||||
|
return fl, fs, own
|
||||||
|
}
|
||||||
|
|
||||||
|
// addPresentationFlags defines the two presentation flags on fl.
|
||||||
|
func addPresentationFlags(fl *flag.FlagSet) {
|
||||||
|
fl.Bool(FlagJSON, false, "outputs as json")
|
||||||
|
fl.Bool(FlagPretty, false, "pretty prints json, assumes -json")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Flagged fills in c's Flags and Run as a pair: define declares the flags on a fresh F,
|
||||||
|
// and run is handed that F. The struct the flags fill is the struct Run reads by
|
||||||
|
// construction, so no Run has to assert the type it was given or decide what to do
|
||||||
|
// when the assertion fails.
|
||||||
|
func Flagged[F any](c *Command, define func(*flag.FlagSet, *F), run func(*F, []string) (Result, error)) *Command {
|
||||||
|
c.Flags = func() (*flag.FlagSet, any) {
|
||||||
|
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||||
|
s := new(F)
|
||||||
|
define(fl, s)
|
||||||
|
return fl, s
|
||||||
|
}
|
||||||
|
c.Run = func(fs any, a []string) (Result, error) {
|
||||||
|
s, ok := fs.(*F)
|
||||||
|
if !ok {
|
||||||
|
return Result{}, fmt.Errorf("%s was handed %T for its flags, not %T", c.Name, fs, s)
|
||||||
|
}
|
||||||
|
return run(s, a)
|
||||||
|
}
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// isPresentationFlag reports whether name is one of the two flags commandFlags adds.
|
||||||
|
func isPresentationFlag(name string) bool {
|
||||||
|
return name == FlagJSON || name == FlagPretty
|
||||||
|
}
|
||||||
|
|
||||||
|
// execLine runs an ssh command line against c, reporting problems to w. The line is
|
||||||
|
// parsed into the command's own FlagSet and Run reads it directly, so a flag.Value whose
|
||||||
|
// String does not re-parse, flag.Func above all, arrives as the line said. Invoke fills
|
||||||
|
// the same FlagSet through Set.
|
||||||
|
func (r *Registry) execLine(c *Command, args []string, w Output) error {
|
||||||
|
fl, fs, _ := commandFlags(c)
|
||||||
|
|
||||||
|
// Parse reports a bad flag to this writer, with the command's usage after it. -h,
|
||||||
|
// -help and --help take the same path with nothing wrong: the usage is the whole
|
||||||
|
// answer, and Parse says so with ErrHelp. A -h that is a flag's value or follows --
|
||||||
|
// is read as the operand it is, since ParseArgs is the one reading of the line.
|
||||||
|
fl.SetOutput(w.Err)
|
||||||
|
operands, err := ParseArgs(fl, args)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, flag.ErrHelp) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
format := presentationFormat(fl)
|
||||||
|
|
||||||
|
// An error from Run is something the command could not do rather than a refusal it
|
||||||
|
// chose, but the person at the prompt still hears it; the surface logs it too.
|
||||||
|
res, err := c.Run(fs, operands)
|
||||||
|
if err != nil {
|
||||||
|
_, _ = fmt.Fprintln(w.Err, err.Error())
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run's reply goes out first, and then the action, if the command has one and Run
|
||||||
|
// did not refuse, whose Result is the outcome. In JSON only the outcome travels:
|
||||||
|
// the promise is for a person to read, and a program expects one document.
|
||||||
|
if c.Then == nil || !res.OK || r.formatFor(c, res, format) == FormatText {
|
||||||
|
if err := r.renderLine(c, res, format, w); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if c.Then != nil && res.OK {
|
||||||
|
res = c.Then()
|
||||||
|
if err := r.renderLine(c, res, format, w); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !res.OK {
|
||||||
|
return &Failure{Msg: res.Reason}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// formatFor is the format a Result is rendered in. The line wins when it asked for one;
|
||||||
|
// otherwise the surface that owns the registry decides, from the command and its
|
||||||
|
// Result, so each surface can keep its own default.
|
||||||
|
func (r *Registry) formatFor(c *Command, res Result, format Format) Format {
|
||||||
|
if format == FormatUnset {
|
||||||
|
return r.defaultFormatFor(c, res)
|
||||||
|
}
|
||||||
|
return format
|
||||||
|
}
|
||||||
|
|
||||||
|
// renderLine writes one Result of a command line to w; see formatFor. An empty Result
|
||||||
|
// writes nothing.
|
||||||
|
func (r *Registry) renderLine(c *Command, res Result, format Format, w Output) error {
|
||||||
|
if res.Empty() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := Render(c, res, r.formatFor(c, res, format), w.Out); err != nil {
|
||||||
|
if errors.Is(err, ErrNoTextRendering) {
|
||||||
|
_, _ = fmt.Fprintln(w.Err, err.Error())
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseArgs parses args with fl and returns the operands.
|
||||||
|
//
|
||||||
|
// It differs from fl.Parse in two ways, and both surfaces parse through here so a line
|
||||||
|
// means the same typed at an ssh prompt or to nebula ctl.
|
||||||
|
//
|
||||||
|
// Flags and operands may come in any order, which is the one way it differs from
|
||||||
|
// fl.Parse. Parse stops at the first operand, so `print-tunnel 10.0.0.1 -json` would
|
||||||
|
// reach the command with "-json" as a second operand and the flag silently dropped. Here
|
||||||
|
// an operand ends nothing: parsing resumes after it, and only "--" ends the flags, with
|
||||||
|
// everything after it an operand. What counts as a flag is Parse's rule: every argument
|
||||||
|
// that starts with "-", a negative number included, so one that is meant as an operand
|
||||||
|
// goes after "--".
|
||||||
|
func ParseArgs(fl *flag.FlagSet, args []string) ([]string, error) {
|
||||||
|
operands := make([]string, 0, len(args))
|
||||||
|
|
||||||
|
for len(args) > 0 {
|
||||||
|
// Walk the flags the way Parse will, to the first argument it would not read as a
|
||||||
|
// flag: an operand or the terminator. Everything before it is Parse's.
|
||||||
|
end := len(args)
|
||||||
|
for i := 0; i < len(args); {
|
||||||
|
a := args[i]
|
||||||
|
if a == "--" {
|
||||||
|
if err := fl.Parse(args[:i]); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return append(operands, args[i+1:]...), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(a) < 2 || a[0] != '-' {
|
||||||
|
end = i
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
f, hasValue := LookupArg(fl, a)
|
||||||
|
if f == nil {
|
||||||
|
// An undefined flag: leave it for Parse to report.
|
||||||
|
i++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if hasValue || IsBoolFlag(f) {
|
||||||
|
i++
|
||||||
|
} else {
|
||||||
|
// The flag's value is the next argument, whatever it looks like.
|
||||||
|
i += 2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := fl.Parse(args[:end]); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if end == len(args) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
operands = append(operands, args[end])
|
||||||
|
args = args[end+1:]
|
||||||
|
}
|
||||||
|
|
||||||
|
return operands, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// LookupArg reads arg the way Parse does: one or two leading dashes, the flag's name, and
|
||||||
|
// an optional "=value". f is the flag of fl by that name, nil when fl has none, and
|
||||||
|
// hasValue reports that the value came with the argument rather than in the one after it.
|
||||||
|
// It is the one reading of an argument's shape: ParseArgs walks a line with it, and
|
||||||
|
// nebula ctl lifts its own flags out of a line with it, so the two cannot disagree about
|
||||||
|
// which word is a flag's value.
|
||||||
|
func LookupArg(fl *flag.FlagSet, arg string) (f *flag.Flag, hasValue bool) {
|
||||||
|
name := strings.TrimPrefix(strings.TrimPrefix(arg, "-"), "-")
|
||||||
|
if eq := strings.IndexByte(name, '='); eq >= 0 {
|
||||||
|
name, hasValue = name[:eq], true
|
||||||
|
}
|
||||||
|
return fl.Lookup(name), hasValue
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsBoolFlag reports whether f is satisfied by its presence alone and never reads the
|
||||||
|
// argument after it as its value. The flag package marks these with an unexported
|
||||||
|
// interface, which is the only way to tell.
|
||||||
|
func IsBoolFlag(f *flag.Flag) bool {
|
||||||
|
bf, ok := f.Value.(interface{ IsBoolFlag() bool })
|
||||||
|
return ok && bf.IsBoolFlag()
|
||||||
|
}
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"flag"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestParseArgsAllowsFlagsAfterOperands pins the one way ParseArgs departs from fl.Parse,
|
||||||
|
// that a flag may follow an operand, and that it departs in no other: a negative number
|
||||||
|
// is a flag, as Parse reads it, and goes after "--" when it is meant as an operand.
|
||||||
|
func TestParseArgsAllowsFlagsAfterOperands(t *testing.T) {
|
||||||
|
cases := map[string]struct {
|
||||||
|
args []string
|
||||||
|
wantOps []string
|
||||||
|
wantN string
|
||||||
|
wantV bool
|
||||||
|
wantJSON bool
|
||||||
|
wantErr string
|
||||||
|
}{
|
||||||
|
"flag after operand": {args: []string{"x", "-json"}, wantOps: []string{"x"}, wantJSON: true},
|
||||||
|
"flags around": {args: []string{"-v", "x", "-n", "1", "y"}, wantOps: []string{"x", "y"}, wantV: true, wantN: "1"},
|
||||||
|
"value after operand": {args: []string{"x", "-n", "-1"}, wantOps: []string{"x"}, wantN: "-1"},
|
||||||
|
"equals value": {args: []string{"-n=-1", "x"}, wantOps: []string{"x"}, wantN: "-1"},
|
||||||
|
"terminator after": {args: []string{"x", "--", "-json", "-1"}, wantOps: []string{"x", "-json", "-1"}},
|
||||||
|
"terminator": {args: []string{"--", "-json"}, wantOps: []string{"-json"}},
|
||||||
|
"defined numeric": {args: []string{"-2", "x"}, wantOps: []string{"x"}, wantV: true},
|
||||||
|
"negative number": {args: []string{"-1"}, wantErr: "flag provided but not defined: -1"},
|
||||||
|
"bad flag after": {args: []string{"x", "-nope"}, wantErr: "flag provided but not defined: -nope"},
|
||||||
|
"undefined flag": {args: []string{"-nope", "x"}, wantErr: "flag provided but not defined: -nope"},
|
||||||
|
"missing value": {args: []string{"-n"}, wantErr: "flag needs an argument: -n"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, tc := range cases {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
fl := flag.NewFlagSet("t", flag.ContinueOnError)
|
||||||
|
fl.SetOutput(&bytes.Buffer{})
|
||||||
|
n := fl.String("n", "", "")
|
||||||
|
v := fl.Bool("v", false, "")
|
||||||
|
two := fl.Bool("2", false, "a flag that happens to be a number")
|
||||||
|
asJSON := fl.Bool(FlagJSON, false, "")
|
||||||
|
|
||||||
|
ops, err := ParseArgs(fl, tc.args)
|
||||||
|
if tc.wantErr != "" {
|
||||||
|
require.ErrorContains(t, err, tc.wantErr)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, tc.wantOps, ops)
|
||||||
|
assert.Equal(t, tc.wantN, *n)
|
||||||
|
assert.Equal(t, tc.wantV, *v || *two)
|
||||||
|
assert.Equal(t, tc.wantJSON, *asJSON)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDispatchFlagAfterOperand: the same through a registered command with no Flags of
|
||||||
|
// its own, which only has the presentation flags to find.
|
||||||
|
func TestDispatchFlagAfterOperand(t *testing.T) {
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, testRegistry().DispatchArgs([]string{"served", "x", "-json"}, MergedOutput(out)))
|
||||||
|
assert.Equal(t, "\"read x\"\n", out.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestLookupArg pins the reading of an argument's shape that ParseArgs and nebula ctl
|
||||||
|
// share.
|
||||||
|
func TestLookupArg(t *testing.T) {
|
||||||
|
fl := flag.NewFlagSet("t", flag.ContinueOnError)
|
||||||
|
fl.String("n", "", "")
|
||||||
|
fl.Bool("v", false, "")
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
arg string
|
||||||
|
name string
|
||||||
|
hasValue bool
|
||||||
|
}{
|
||||||
|
{"-n", "n", false},
|
||||||
|
{"--n", "n", false},
|
||||||
|
{"-n=1", "n", true},
|
||||||
|
{"--n=", "n", true},
|
||||||
|
{"-v", "v", false},
|
||||||
|
{"-nope", "", false},
|
||||||
|
{"-1", "", false},
|
||||||
|
} {
|
||||||
|
f, hasValue := LookupArg(fl, tc.arg)
|
||||||
|
if tc.name == "" {
|
||||||
|
assert.Nil(t, f, tc.arg)
|
||||||
|
} else {
|
||||||
|
require.NotNil(t, f, tc.arg)
|
||||||
|
assert.Equal(t, tc.name, f.Name, tc.arg)
|
||||||
|
}
|
||||||
|
assert.Equal(t, tc.hasValue, hasValue, tc.arg)
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.True(t, IsBoolFlag(fl.Lookup("v")))
|
||||||
|
assert.False(t, IsBoolFlag(fl.Lookup("n")))
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
// Name identifies a command. Every command nebula serves is a constant here, so a
|
||||||
|
// surface, a client and a test spell it the same way and are told at compile time when
|
||||||
|
// they do not. It is a string rather than an integer so a test can register a throwaway
|
||||||
|
// command without adding it here, and so the wire carries the name as the string it has
|
||||||
|
// always been.
|
||||||
|
type Name string
|
||||||
|
|
||||||
|
const (
|
||||||
|
ChangeRemote Name = "change-remote"
|
||||||
|
CloseTunnel Name = "close-tunnel"
|
||||||
|
CreateTunnel Name = "create-tunnel"
|
||||||
|
DeviceInfo Name = "device-info"
|
||||||
|
Help Name = "help"
|
||||||
|
Identity Name = "identity"
|
||||||
|
ListHostmap Name = "list-hostmap"
|
||||||
|
ListLighthouseAddrmap Name = "list-lighthouse-addrmap"
|
||||||
|
ListPendingHostmap Name = "list-pending-hostmap"
|
||||||
|
LogFormat Name = "log-format"
|
||||||
|
LogLevel Name = "log-level"
|
||||||
|
Logout Name = "logout"
|
||||||
|
PrintCert Name = "print-cert"
|
||||||
|
PrintRelays Name = "print-relays"
|
||||||
|
PrintTunnel Name = "print-tunnel"
|
||||||
|
QueryLighthouse Name = "query-lighthouse"
|
||||||
|
Reload Name = "reload"
|
||||||
|
Version Name = "version"
|
||||||
|
Whoami Name = "whoami"
|
||||||
|
)
|
||||||
@@ -0,0 +1,456 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"cmp"
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"maps"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
|
||||||
|
"github.com/anmitsu/go-shlex"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Registry holds a set of commands.
|
||||||
|
//
|
||||||
|
// It is safe for concurrent use: the ssh server clones it per session and the control
|
||||||
|
// socket serves it as it is, while the daemon fills it once at startup.
|
||||||
|
type Registry struct {
|
||||||
|
mu sync.RWMutex
|
||||||
|
commands map[Name]*Command
|
||||||
|
|
||||||
|
// full is set on a filtered registry and points at the registry it was filtered
|
||||||
|
// from, so a command that's filtered can be reported as such.
|
||||||
|
full *Registry
|
||||||
|
|
||||||
|
// reason explains, in the terms an operator cares about, why this registry withholds
|
||||||
|
// a command they can name. It is supplied by whoever built the filter, because why a
|
||||||
|
// surface declines a command is that surface's business, not the registry's.
|
||||||
|
reason string
|
||||||
|
|
||||||
|
// DefaultFormat decides how a result is rendered when the command line named no
|
||||||
|
// format. It sees the command and its Result, and applies to values and refusals
|
||||||
|
// alike: the registry does not special-case either. The renderer is shared between
|
||||||
|
// surfaces; what each asks for by default is not, so the surface that owns this
|
||||||
|
// registry sets it. Nil means text.
|
||||||
|
DefaultFormat func(c *Command, r Result) Format
|
||||||
|
}
|
||||||
|
|
||||||
|
// defaultFormatFor resolves the surface's default for c's Result.
|
||||||
|
func (r *Registry) defaultFormatFor(c *Command, res Result) Format {
|
||||||
|
if r.DefaultFormat == nil {
|
||||||
|
return FormatText
|
||||||
|
}
|
||||||
|
return r.DefaultFormat(c, res)
|
||||||
|
}
|
||||||
|
|
||||||
|
// New returns an empty Registry with only `help` available.
|
||||||
|
func New() *Registry {
|
||||||
|
r := &Registry{commands: map[Name]*Command{}}
|
||||||
|
r.registerHelp()
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Registry) registerHelp() {
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: Help,
|
||||||
|
ShortDescription: "prints available commands or help <command> for specific usage info",
|
||||||
|
Run: func(a any, args []string) (Result, error) {
|
||||||
|
if len(args) == 0 {
|
||||||
|
return Value(r.Schema()), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
c, err := r.Resolve(Name(args[0]))
|
||||||
|
if err != nil {
|
||||||
|
var withheld *WithheldError
|
||||||
|
if errors.As(err, &withheld) {
|
||||||
|
return Failed("%s", err), nil
|
||||||
|
}
|
||||||
|
return Failed("Command not available %s", args[0]), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return Value(r.SchemaFor(c)), nil
|
||||||
|
},
|
||||||
|
Text: renderHelp,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// renderHelp is help's human rendering: the command list, or one command's usage.
|
||||||
|
func renderHelp(v any, w io.Writer) error {
|
||||||
|
switch h := v.(type) {
|
||||||
|
case []CommandSchema:
|
||||||
|
return writeCommandList(h, w)
|
||||||
|
case CommandSchema:
|
||||||
|
return WriteCommandHelp(h, w)
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("expected a command schema, got %T", v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeCommandList(cmds []CommandSchema, w io.Writer) error {
|
||||||
|
if _, err := io.WriteString(w, "Available commands:\n"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// In the order the schema came, which is the display order; see Registry.All.
|
||||||
|
lines := make([]string, 0, len(cmds))
|
||||||
|
for _, c := range cmds {
|
||||||
|
lines = append(lines, fmt.Sprintf("%s - %s", c.Name, c.Short))
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := io.WriteString(w, strings.Join(lines, "\n")+"\n\n")
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// WriteCommandHelp renders one command's usage. It is the single rendering of a
|
||||||
|
// CommandSchema for a person: the daemon uses it for `help <command>` on both surfaces,
|
||||||
|
// and a client that already holds the schema uses it for `-h`, so the two cannot drift.
|
||||||
|
func WriteCommandHelp(c CommandSchema, w io.Writer) error {
|
||||||
|
if _, err := fmt.Fprintf(w, "%s - %s\n", c.Name, c.Short); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.Help != "" {
|
||||||
|
if _, err := fmt.Fprintf(w, " %s\n", c.Help); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Same layout as flag.PrintDefaults, including its habit of leaving out a default
|
||||||
|
// that is the zero value.
|
||||||
|
for _, f := range c.Flags {
|
||||||
|
kind := ""
|
||||||
|
if !f.Bool {
|
||||||
|
kind = " string"
|
||||||
|
}
|
||||||
|
def := ""
|
||||||
|
if f.Default != "" && f.Default != "false" {
|
||||||
|
def = fmt.Sprintf(" (default %s)", f.Default)
|
||||||
|
}
|
||||||
|
if _, err := fmt.Fprintf(w, " -%s%s\n \t%s%s\n", f.Name, kind, f.Usage, def); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Register adds a command that can be run by a user.
|
||||||
|
//
|
||||||
|
// It panics if the command declares a reserved flag. That is a programming error, and
|
||||||
|
// surfacing it here, at startup, is better than at the moment an operator first types
|
||||||
|
// the command.
|
||||||
|
func (r *Registry) Register(c *Command) {
|
||||||
|
if c.Run == nil {
|
||||||
|
panic(fmt.Sprintf("commands: %s has no Run", c.Name))
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.Flags != nil {
|
||||||
|
if fl, _ := c.Flags(); fl != nil {
|
||||||
|
for _, name := range reservedFlags {
|
||||||
|
if fl.Lookup(name) != nil {
|
||||||
|
panic(fmt.Sprintf("commands: %s declares reserved flag -%s", c.Name, name))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
r.insert(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// insert adds c without the reserved flag check, for commands that have already passed
|
||||||
|
// it on another registry.
|
||||||
|
func (r *Registry) insert(c *Command) {
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
r.commands[c.Name] = c
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get returns the command registered under name, or nil if there is no such command.
|
||||||
|
func (r *Registry) Get(name Name) *Command {
|
||||||
|
r.mu.RLock()
|
||||||
|
defer r.mu.RUnlock()
|
||||||
|
return r.commands[name]
|
||||||
|
}
|
||||||
|
|
||||||
|
// Match returns the names of every command starting with prefix, sorted, as strings for
|
||||||
|
// a prompt to complete and print.
|
||||||
|
func (r *Registry) Match(prefix string) []string {
|
||||||
|
cmds := make([]string, 0)
|
||||||
|
r.mu.RLock()
|
||||||
|
for n := range r.commands {
|
||||||
|
if strings.HasPrefix(string(n), prefix) {
|
||||||
|
cmds = append(cmds, string(n))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
r.mu.RUnlock()
|
||||||
|
slices.Sort(cmds)
|
||||||
|
return cmds
|
||||||
|
}
|
||||||
|
|
||||||
|
// All returns every registered command sorted by name, which is the order help lists
|
||||||
|
// them and the schema describes them.
|
||||||
|
func (r *Registry) All() []*Command {
|
||||||
|
r.mu.RLock()
|
||||||
|
defer r.mu.RUnlock()
|
||||||
|
|
||||||
|
cmds := slices.Collect(maps.Values(r.commands))
|
||||||
|
slices.SortFunc(cmds, func(a, b *Command) int { return cmp.Compare(a.Name, b.Name) })
|
||||||
|
return cmds
|
||||||
|
}
|
||||||
|
|
||||||
|
// Clone returns a copy holding the same commands.
|
||||||
|
//
|
||||||
|
// help is re-registered on the copy rather than carried over, because the source's help
|
||||||
|
// is bound to the source and would list its commands, not the copy's, once a caller
|
||||||
|
// registers something on the copy.
|
||||||
|
func (r *Registry) Clone() *Registry {
|
||||||
|
r.mu.RLock()
|
||||||
|
out := &Registry{
|
||||||
|
commands: maps.Clone(r.commands),
|
||||||
|
full: r.full,
|
||||||
|
reason: r.reason,
|
||||||
|
DefaultFormat: r.DefaultFormat,
|
||||||
|
}
|
||||||
|
r.mu.RUnlock()
|
||||||
|
|
||||||
|
out.registerHelp()
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Filter returns a filtered copy of the registry.
|
||||||
|
//
|
||||||
|
// Keep should return true for commands that should be included in the copy. reason
|
||||||
|
// says, to an operator who names a command the copy left out, why this surface does
|
||||||
|
// not serve it; "" leaves the registry to say only that it does not.
|
||||||
|
func (r *Registry) Filter(keep func(*Command) bool, reason string) *Registry {
|
||||||
|
out := &Registry{commands: map[Name]*Command{}, full: r, reason: reason, DefaultFormat: r.DefaultFormat}
|
||||||
|
|
||||||
|
for _, cmd := range r.All() {
|
||||||
|
if keep(cmd) {
|
||||||
|
out.insert(cmd)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Bind help to the filtered set so it only advertises what this surface serves.
|
||||||
|
out.registerHelp()
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dispatch parses a command line and runs it, reporting problems to w. The error is for
|
||||||
|
// the caller to log, not to show; see RunFunc and Failure.
|
||||||
|
func (r *Registry) Dispatch(line string, w Output) error {
|
||||||
|
// A line shlex cannot split, an unbalanced quote. Reported on Err so the output
|
||||||
|
// stream stays parseable.
|
||||||
|
args, err := shlex.Split(line, true)
|
||||||
|
if err != nil {
|
||||||
|
msg := "could not parse the command line: " + err.Error()
|
||||||
|
if _, err := fmt.Fprintln(w.Err, msg); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return &Failure{Msg: msg}
|
||||||
|
}
|
||||||
|
|
||||||
|
return r.DispatchArgs(args, w)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DispatchArgs runs an already tokenized command line. The error is as for Dispatch.
|
||||||
|
//
|
||||||
|
// An empty line and an unknown command both end up running `help`, the first with the
|
||||||
|
// arguments help itself would take; `<command> -h` is answered by the command's own
|
||||||
|
// FlagSet, with the same rendering, in execLine.
|
||||||
|
func (r *Registry) DispatchArgs(args []string, w Output) error {
|
||||||
|
if len(args) == 0 {
|
||||||
|
args = []string{"help"}
|
||||||
|
}
|
||||||
|
|
||||||
|
c, err := r.Resolve(Name(args[0]))
|
||||||
|
if err != nil {
|
||||||
|
var withheld *WithheldError
|
||||||
|
if errors.As(err, &withheld) {
|
||||||
|
// Saying why, rather than "did not understand", keeps the rule legible and
|
||||||
|
// points at a surface that will actually run the command.
|
||||||
|
_, _ = fmt.Fprintln(w.Err, err)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only the first word was looked up, so only it is named.
|
||||||
|
msg := fmt.Sprintf("did not understand: %s", args[0])
|
||||||
|
if _, err := fmt.Fprintln(w.Out, msg); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := r.DispatchArgs([]string{"help"}, w); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return &Failure{Msg: msg}
|
||||||
|
}
|
||||||
|
|
||||||
|
return r.execLine(c, args[1:], w)
|
||||||
|
}
|
||||||
|
|
||||||
|
// unavailable explains why name cannot be run here when this registry was filtered from
|
||||||
|
// one that holds it: the command exists, and this surface withholds it, for the reason
|
||||||
|
// whoever built the filter gave. It is nil when name is simply unknown, so the two cases
|
||||||
|
// read differently to an operator.
|
||||||
|
func (r *Registry) unavailable(name Name) error {
|
||||||
|
if r.full == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
c := r.full.Get(name)
|
||||||
|
if c == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
reason := r.reason
|
||||||
|
if reason == "" {
|
||||||
|
reason = "this surface does not serve it"
|
||||||
|
}
|
||||||
|
|
||||||
|
return &WithheldError{msg: fmt.Sprintf("%s is not available on this surface: %s", c.Name, reason)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithheldError indicates that the command is supported by Nebula, but not via this path.
|
||||||
|
type WithheldError struct {
|
||||||
|
msg string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *WithheldError) Error() string { return e.msg }
|
||||||
|
|
||||||
|
// Resolve returns the command registered under name, or says why there is none: a
|
||||||
|
// WithheldError with the filter's reason, or unknown for a name that does not exist.
|
||||||
|
func (r *Registry) Resolve(name Name) (*Command, error) {
|
||||||
|
if c := r.Get(name); c != nil {
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := r.unavailable(name); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, fmt.Errorf("unknown command %q", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParamError is what Invoke returns for a parameter the command would not take: one it
|
||||||
|
// does not have, or a value its flag would not parse. It is the caller's mistake rather
|
||||||
|
// than the command's failure, and a surface with status codes tells the two apart by
|
||||||
|
// it; every other error from Invoke came out of Run.
|
||||||
|
type ParamError struct {
|
||||||
|
msg string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *ParamError) Error() string { return e.msg }
|
||||||
|
|
||||||
|
func paramErrorf(format string, args ...any) error {
|
||||||
|
return &ParamError{msg: fmt.Sprintf(format, args...)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// setParams sets each named parameter on fl, in the order of names, and stops at the
|
||||||
|
// first that is unknown or does not parse. own says whether the command declared flags
|
||||||
|
// of its own, which decides between "takes no parameters" and "has no parameter".
|
||||||
|
//
|
||||||
|
// The presentation flags are on fl, since commandFlags put them there, but they are not
|
||||||
|
// parameters: a request has one place to choose its rendering, the envelope's format
|
||||||
|
// field, and a client that sends them here is told where that is rather than having a
|
||||||
|
// second, weaker way to say the same thing.
|
||||||
|
func setParams(fl *flag.FlagSet, name string, names []string, params map[string]string, own bool) error {
|
||||||
|
for _, k := range names {
|
||||||
|
if isPresentationFlag(k) {
|
||||||
|
return paramErrorf("%s is a command line flag, not a parameter; choose the rendering with the request's format field", k)
|
||||||
|
}
|
||||||
|
|
||||||
|
f := fl.Lookup(k)
|
||||||
|
if f == nil {
|
||||||
|
if !own {
|
||||||
|
return paramErrorf("%s takes no parameters", name)
|
||||||
|
}
|
||||||
|
return paramErrorf("%s has no parameter %q", name, k)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := setFlag(fl, f, params[k]); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// setFlag applies one value to f, reporting a refusal as a ParamError in words that
|
||||||
|
// name the value: the flag package's own words for a bad boolean are "parse error".
|
||||||
|
func setFlag(fl *flag.FlagSet, f *flag.Flag, v string) error {
|
||||||
|
if err := fl.Set(f.Name, v); err != nil {
|
||||||
|
if IsBoolFlag(f) {
|
||||||
|
return paramErrorf("%s: expected a boolean, got %q", f.Name, v)
|
||||||
|
}
|
||||||
|
return paramErrorf("%s: %v", f.Name, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Schema describes every command in the registry, so a client can offer them without
|
||||||
|
// having been built against this daemon.
|
||||||
|
func (r *Registry) Schema() []CommandSchema {
|
||||||
|
all := r.All()
|
||||||
|
out := make([]CommandSchema, 0, len(all))
|
||||||
|
for _, c := range all {
|
||||||
|
out = append(out, r.SchemaFor(c))
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// SchemaFor describes one command. It is the one derivation, for the whole schema and
|
||||||
|
// for `help <command>` alike.
|
||||||
|
func (r *Registry) SchemaFor(c *Command) CommandSchema {
|
||||||
|
fl, _, _ := commandFlags(c)
|
||||||
|
return schemaOf(c, fl)
|
||||||
|
}
|
||||||
|
|
||||||
|
// schemaOf describes c as driven through fl, the FlagSet commandFlags built for it. The
|
||||||
|
// presentation flags are included because a command line client parses its line
|
||||||
|
// against this and help renders from it; they are listed after the command's own,
|
||||||
|
// which is where readers expect them. Invoke refuses them as parameters.
|
||||||
|
func schemaOf(c *Command, fl *flag.FlagSet) CommandSchema {
|
||||||
|
cs := CommandSchema{Name: c.Name, Short: c.ShortDescription, Help: c.Help}
|
||||||
|
|
||||||
|
var own, shared []FlagSchema
|
||||||
|
fl.VisitAll(func(f *flag.Flag) {
|
||||||
|
fs := FlagSchema{
|
||||||
|
Name: f.Name,
|
||||||
|
Bool: IsBoolFlag(f),
|
||||||
|
Default: f.DefValue,
|
||||||
|
Usage: f.Usage,
|
||||||
|
}
|
||||||
|
if isPresentationFlag(f.Name) {
|
||||||
|
shared = append(shared, fs)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
own = append(own, fs)
|
||||||
|
})
|
||||||
|
cs.Flags = append(own, shared...)
|
||||||
|
|
||||||
|
return cs
|
||||||
|
}
|
||||||
|
|
||||||
|
// CommandSchema describes one command well enough for a client to offer it.
|
||||||
|
type CommandSchema struct {
|
||||||
|
Name Name `json:"name"`
|
||||||
|
Short string `json:"short,omitempty"`
|
||||||
|
Help string `json:"help,omitempty"`
|
||||||
|
Flags []FlagSchema `json:"flags,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// FlagSchema describes one of a command's named parameters.
|
||||||
|
type FlagSchema struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
|
||||||
|
// Bool reports a parameter that takes no value, which is what tells a command line
|
||||||
|
// client whether `-pretty` swallows the word after it.
|
||||||
|
Bool bool `json:"bool,omitempty"`
|
||||||
|
|
||||||
|
Default string `json:"default,omitempty"`
|
||||||
|
Usage string `json:"usage,omitempty"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,481 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"io"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// notWithheld is a stand in for a surface's own policy, which the registry knows nothing
|
||||||
|
// of; see Command.Identity for the one the info API applies.
|
||||||
|
func notWithheld(c *Command) bool { return c.Name != "withheld" }
|
||||||
|
|
||||||
|
const testReason = "this surface does not run commands that write"
|
||||||
|
|
||||||
|
// textLine is a Text renderer for test commands whose result is one string.
|
||||||
|
func textLine(v any, w io.Writer) error {
|
||||||
|
_, err := io.WriteString(w, v.(string)+"\n")
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func testRegistry() *Registry {
|
||||||
|
r := New()
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "served",
|
||||||
|
ShortDescription: "a command this surface serves",
|
||||||
|
Run: func(fs any, a []string) (Result, error) {
|
||||||
|
return Value("read " + strings.Join(a, ",")), nil
|
||||||
|
},
|
||||||
|
Text: textLine,
|
||||||
|
})
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "withheld",
|
||||||
|
ShortDescription: "a command this surface withholds",
|
||||||
|
Run: func(fs any, a []string) (Result, error) {
|
||||||
|
return Value("wrote"), nil
|
||||||
|
},
|
||||||
|
Text: textLine,
|
||||||
|
})
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestFilterKeepsWhatKeepSays: the copy holds the commands keep accepted, and help.
|
||||||
|
func TestFilterKeepsWhatKeepSays(t *testing.T) {
|
||||||
|
ro := testRegistry().Filter(notWithheld, testReason)
|
||||||
|
|
||||||
|
names := make([]string, 0)
|
||||||
|
for _, c := range ro.All() {
|
||||||
|
names = append(names, string(c.Name))
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.ElementsMatch(t, []string{"help", "served"}, names)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRefusesWithheldByName covers a client that knows a command exists and asks for it
|
||||||
|
// anyway. The filter lives on the serving side, so the answer must not depend on what
|
||||||
|
// the client was told was available.
|
||||||
|
func TestRefusesWithheldByName(t *testing.T) {
|
||||||
|
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||||
|
w := Output{Out: out, Err: errOut}
|
||||||
|
|
||||||
|
err := testRegistry().Filter(notWithheld, testReason).DispatchArgs([]string{"withheld"}, w)
|
||||||
|
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "withheld is not available on this surface")
|
||||||
|
assert.Empty(t, out.String(), "a withheld command must produce no output")
|
||||||
|
assert.Contains(t, errOut.String(), "withheld is not available on this surface")
|
||||||
|
assert.Contains(t, errOut.String(), testReason,
|
||||||
|
"the registry should render the explanation the filter supplied, not one of its own")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWithheldIsNotReportedAsUnknown keeps the two cases distinct: an operator who
|
||||||
|
// mistypes and one who asked for a real command should not get the same answer.
|
||||||
|
func TestWithheldIsNotReportedAsUnknown(t *testing.T) {
|
||||||
|
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||||
|
err := testRegistry().Filter(notWithheld, testReason).DispatchArgs([]string{"no-such-command"}, Output{Out: out, Err: errOut})
|
||||||
|
|
||||||
|
var f *Failure
|
||||||
|
require.ErrorAs(t, err, &f, "an unknown command is a failure to the surface")
|
||||||
|
assert.Contains(t, out.String(), "did not understand: no-such-command")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestResolveTellsUnknownFromWithheld: the two cases read differently to an operator,
|
||||||
|
// and a surface with status codes tells them apart by the error's type, never by asking
|
||||||
|
// the unfiltered registry, which is the one thing a filtered surface must not consult.
|
||||||
|
func TestResolveTellsUnknownFromWithheld(t *testing.T) {
|
||||||
|
r := testRegistry().Filter(notWithheld, testReason)
|
||||||
|
|
||||||
|
c, err := r.Resolve("served")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, Name("served"), c.Name)
|
||||||
|
|
||||||
|
_, err = r.Resolve("withheld")
|
||||||
|
var withheld *WithheldError
|
||||||
|
require.ErrorAs(t, err, &withheld)
|
||||||
|
require.ErrorContains(t, err, "withheld is not available on this surface")
|
||||||
|
require.ErrorContains(t, err, testReason)
|
||||||
|
|
||||||
|
_, err = r.Resolve("no-such-command")
|
||||||
|
require.ErrorContains(t, err, `unknown command "no-such-command"`)
|
||||||
|
assert.NotErrorAs(t, err, &withheld, "an unknown name is not a withheld one")
|
||||||
|
}
|
||||||
|
|
||||||
|
// paramRegistry holds one command with a bool flag and a duration flag, and reports what
|
||||||
|
// the command saw when it ran.
|
||||||
|
func paramRegistry(t *testing.T) (*Registry, *[]paramsSeen) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var seen []paramsSeen
|
||||||
|
r := New()
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "set",
|
||||||
|
ShortDescription: "sets things",
|
||||||
|
Flags: func() (*flag.FlagSet, any) {
|
||||||
|
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||||
|
s := paramsSeen{}
|
||||||
|
fl.BoolVar(&s.Verbose, "verbose", false, "say more")
|
||||||
|
fl.DurationVar(&s.Wait, "wait", 0, "how long")
|
||||||
|
return fl, &s
|
||||||
|
},
|
||||||
|
Run: func(fs any, a []string) (Result, error) {
|
||||||
|
seen = append(seen, *fs.(*paramsSeen))
|
||||||
|
return Value("ok"), nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
return r, &seen
|
||||||
|
}
|
||||||
|
|
||||||
|
type paramsSeen struct {
|
||||||
|
Verbose bool
|
||||||
|
Wait time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInvokeReportsParametersInNameOrder: parameters arrive as an unordered object, so
|
||||||
|
// with two bad ones the error must not depend on map iteration. Name order decides.
|
||||||
|
func TestInvokeReportsParametersInNameOrder(t *testing.T) {
|
||||||
|
r, _ := paramRegistry(t)
|
||||||
|
|
||||||
|
cases := map[string]struct {
|
||||||
|
params map[string]string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
"two unknown": {map[string]string{"zed": "1", "alpha": "1"}, `set has no parameter "alpha"`},
|
||||||
|
"unknown before bad bool": {map[string]string{"aaa": "1", "verbose": "maybe"}, `set has no parameter "aaa"`},
|
||||||
|
"bad bool before unknown": {map[string]string{"verbose": "maybe", "zzz": "1"}, `verbose: expected a boolean, got "maybe"`},
|
||||||
|
"bad value before bad bool": {map[string]string{"wait": "soon", "verbose": "maybe"}, `verbose: expected a boolean`},
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, tc := range cases {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
// Enough runs that a map-order dependence would show.
|
||||||
|
for i := 0; i < 50; i++ {
|
||||||
|
_, err := Invoke(Request{Command: r.Get("set"), Params: tc.params})
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.ErrorContains(t, err, tc.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInvokeWithABadParameterSetsNothing: a request with any bad parameter must not run
|
||||||
|
// the command, and must leave nothing behind for the next request to see. The good
|
||||||
|
// parameter sorts before the bad one, so a one-pass Invoke would have applied it.
|
||||||
|
func TestInvokeWithABadParameterSetsNothing(t *testing.T) {
|
||||||
|
r, seen := paramRegistry(t)
|
||||||
|
|
||||||
|
_, err := Invoke(Request{Command: r.Get("set"), Params: map[string]string{"verbose": "true", "wait": "soon"}})
|
||||||
|
require.ErrorContains(t, err, "wait:")
|
||||||
|
assert.Empty(t, *seen, "the command must not run with a partial parameter set")
|
||||||
|
|
||||||
|
v, err := Invoke(Request{Command: r.Get("set")})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "ok", v.Value)
|
||||||
|
require.Len(t, *seen, 1)
|
||||||
|
assert.Equal(t, paramsSeen{}, (*seen)[0], "nothing from the failed request carried over")
|
||||||
|
|
||||||
|
_, err = Invoke(Request{Command: r.Get("set"), Params: map[string]string{"verbose": "true", "wait": "2s"}})
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Len(t, *seen, 2)
|
||||||
|
assert.Equal(t, paramsSeen{Verbose: true, Wait: 2 * time.Second}, (*seen)[1])
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHelpListsOnlyServedCommands(t *testing.T) {
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, testRegistry().Filter(notWithheld, testReason).DispatchArgs(nil, MergedOutput(out)))
|
||||||
|
|
||||||
|
assert.Contains(t, out.String(), "served")
|
||||||
|
assert.NotContains(t, out.String(), "withheld")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestDispatchReportsUnparseableLine pins that a line shlex rejects says so on Err rather
|
||||||
|
// than coming back silent, so an operator with an unbalanced quote learns the quote is the
|
||||||
|
// problem instead of assuming the command is broken.
|
||||||
|
func TestDispatchReportsUnparseableLine(t *testing.T) {
|
||||||
|
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||||
|
testRegistry().Dispatch(`served "unterminated`, Output{Out: out, Err: errOut})
|
||||||
|
assert.Empty(t, out.String())
|
||||||
|
assert.Contains(t, errOut.String(), "could not parse the command line")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRegisterRejectsReservedFlags: a command that declares a reserved flag is refused
|
||||||
|
// at Register rather than when an operator first runs it; see reservedFlags.
|
||||||
|
func TestRegisterRejectsReservedFlags(t *testing.T) {
|
||||||
|
for _, name := range []string{"json", "pretty", "h", "help", "config", "socket"} {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
r := New()
|
||||||
|
assert.PanicsWithValue(t, "commands: clash declares reserved flag -"+name, func() {
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "clash",
|
||||||
|
Flags: func() (*flag.FlagSet, any) {
|
||||||
|
fl := flag.NewFlagSet("clash", flag.ContinueOnError)
|
||||||
|
fl.Bool(name, false, "")
|
||||||
|
return fl, nil
|
||||||
|
},
|
||||||
|
Run: func(fs any, a []string) (Result, error) { return Nothing(), nil },
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRegistryIsSafeForConcurrentUse runs the operations the surfaces perform, filtering
|
||||||
|
// and cloning per request or session, against a stream of registrations. It exists to
|
||||||
|
// be run under the race detector: the map underneath is not goroutine safe.
|
||||||
|
func TestRegistryIsSafeForConcurrentUse(t *testing.T) {
|
||||||
|
r := testRegistry()
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
for i := 0; i < 8; i++ {
|
||||||
|
wg.Add(1)
|
||||||
|
go func(i int) {
|
||||||
|
defer wg.Done()
|
||||||
|
for j := 0; j < 50; j++ {
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: Name("late-" + strings.Repeat("a", i) + "-" + strings.Repeat("b", j)),
|
||||||
|
ShortDescription: "registered after the surfaces started",
|
||||||
|
Run: func(fs any, a []string) (Result, error) { return Nothing(), nil },
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}(i)
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < 8; i++ {
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
for j := 0; j < 50; j++ {
|
||||||
|
f := r.Filter(notWithheld, testReason)
|
||||||
|
_ = f.Get("served")
|
||||||
|
_ = f.Schema()
|
||||||
|
_ = r.Clone().Match("late-")
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
|
wg.Wait()
|
||||||
|
|
||||||
|
f := r.Filter(notWithheld, testReason)
|
||||||
|
assert.Len(t, f.Match("late-"), 8*50, "every late registration is visible once the writers finish")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestCloneHelpSeesCloneCommands: the ssh session registers logout on its clone, and
|
||||||
|
// the source does not learn of it. Help on the clone answers for the clone, and -h on a
|
||||||
|
// command prints what `help <name>` does, on a clone as on the source: both render
|
||||||
|
// through WriteCommandHelp, and Clone rebinds help to the copy.
|
||||||
|
func TestCloneHelpSeesCloneCommands(t *testing.T) {
|
||||||
|
r := testRegistry()
|
||||||
|
c := r.Clone()
|
||||||
|
c.Register(&Command{
|
||||||
|
Name: Logout,
|
||||||
|
ShortDescription: "ends the session",
|
||||||
|
Run: func(fs any, a []string) (Result, error) { return Nothing(), nil },
|
||||||
|
})
|
||||||
|
assert.Nil(t, r.Get(Logout), "the source is not affected")
|
||||||
|
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, c.DispatchArgs([]string{"help"}, MergedOutput(out)))
|
||||||
|
assert.Contains(t, out.String(), "logout")
|
||||||
|
|
||||||
|
for _, name := range []string{"logout", "served"} {
|
||||||
|
flag := &bytes.Buffer{}
|
||||||
|
c.Dispatch(name+" -h", MergedOutput(flag))
|
||||||
|
cmd := &bytes.Buffer{}
|
||||||
|
c.Dispatch("help "+name, MergedOutput(cmd))
|
||||||
|
assert.Equal(t, cmd.String(), flag.String(), name)
|
||||||
|
assert.Contains(t, flag.String(), name+" - ", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestThenRunsAfterTheReply pins the order Then exists for: Run's line is on the writer
|
||||||
|
// before the action begins, Then's Result follows it, and Then's outcome is the
|
||||||
|
// command's.
|
||||||
|
func TestThenRunsAfterTheReply(t *testing.T) {
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
seen := "never ran"
|
||||||
|
outcome := Did("acted")
|
||||||
|
|
||||||
|
r := New()
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "act",
|
||||||
|
ShortDescription: "replies, then acts",
|
||||||
|
Run: func(fs any, a []string) (Result, error) {
|
||||||
|
return Did("about to act"), nil
|
||||||
|
},
|
||||||
|
Then: func() Result {
|
||||||
|
seen = out.String()
|
||||||
|
return outcome
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
require.NoError(t, r.DispatchArgs([]string{"act"}, MergedOutput(out)))
|
||||||
|
assert.Equal(t, "about to act\n", seen, "the line was written before the action")
|
||||||
|
assert.Equal(t, "about to act\nacted\n", out.String())
|
||||||
|
|
||||||
|
out.Reset()
|
||||||
|
outcome = Failed("could not act")
|
||||||
|
var f *Failure
|
||||||
|
require.ErrorAs(t, r.DispatchArgs([]string{"act"}, MergedOutput(out)), &f)
|
||||||
|
assert.Equal(t, "about to act\ncould not act\n", out.String())
|
||||||
|
|
||||||
|
// In JSON only the outcome travels: one document for the program that asked.
|
||||||
|
out.Reset()
|
||||||
|
require.ErrorAs(t, r.DispatchArgs([]string{"act", "-json"}, MergedOutput(out)), &f)
|
||||||
|
assert.JSONEq(t, `{"ok":false,"reason":"could not act"}`, out.String())
|
||||||
|
|
||||||
|
// A Run that refused is the outcome; the action does not happen.
|
||||||
|
ran := false
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "refuse",
|
||||||
|
ShortDescription: "refuses, so never acts",
|
||||||
|
Run: func(fs any, a []string) (Result, error) {
|
||||||
|
return Failed("not like that"), nil
|
||||||
|
},
|
||||||
|
Then: func() Result {
|
||||||
|
ran = true
|
||||||
|
return Did("acted anyway")
|
||||||
|
},
|
||||||
|
})
|
||||||
|
out.Reset()
|
||||||
|
require.ErrorAs(t, r.DispatchArgs([]string{"refuse"}, MergedOutput(out)), &f)
|
||||||
|
assert.Equal(t, "not like that\n", out.String())
|
||||||
|
assert.False(t, ran)
|
||||||
|
out.Reset()
|
||||||
|
require.ErrorAs(t, r.DispatchArgs([]string{"refuse", "-json"}, MergedOutput(out)), &f)
|
||||||
|
assert.JSONEq(t, `{"ok":false,"reason":"not like that"}`, out.String())
|
||||||
|
assert.False(t, ran)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWriteCommandHelpIsTheOneRendering pins the layout both `help <command>` on the
|
||||||
|
// daemon and `-h` in the client print, so the two cannot drift apart again.
|
||||||
|
func TestWriteCommandHelpIsTheOneRendering(t *testing.T) {
|
||||||
|
cs := CommandSchema{
|
||||||
|
Name: "change-remote",
|
||||||
|
Short: "changes a remote",
|
||||||
|
Help: "Give it an address.",
|
||||||
|
Flags: []FlagSchema{
|
||||||
|
{Name: "address", Usage: "the new remote", Default: "1.2.3.4:4242"},
|
||||||
|
{Name: "by-index", Bool: true, Usage: "match by index"},
|
||||||
|
{Name: "json", Bool: true, Usage: "outputs as json"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, WriteCommandHelp(cs, out))
|
||||||
|
|
||||||
|
assert.Equal(t, "change-remote - changes a remote\n"+
|
||||||
|
" Give it an address.\n"+
|
||||||
|
" -address string\n \tthe new remote (default 1.2.3.4:4242)\n"+
|
||||||
|
" -by-index\n \tmatch by index\n"+
|
||||||
|
" -json\n \toutputs as json\n", out.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// addrFlags is the flag struct of a test command that takes -address.
|
||||||
|
type addrFlags struct{ Address string }
|
||||||
|
|
||||||
|
// TestHelpFlagIsReadWhereParseReadsIt: -h asks for help only where the line's parser
|
||||||
|
// reads it as a flag. As a flag's value or after -- it reaches the command as the
|
||||||
|
// operand it is, and help is rendered by the same function `help <command>` uses.
|
||||||
|
func TestHelpFlagIsReadWhereParseReadsIt(t *testing.T) {
|
||||||
|
var seen []string
|
||||||
|
r := New()
|
||||||
|
r.Register(Flagged(&Command{Name: "x", ShortDescription: "takes an address"},
|
||||||
|
func(fl *flag.FlagSet, s *addrFlags) { fl.StringVar(&s.Address, "address", "", "an address") },
|
||||||
|
func(s *addrFlags, a []string) (Result, error) {
|
||||||
|
seen = append(seen, s.Address+"|"+strings.Join(a, ","))
|
||||||
|
return Nothing(), nil
|
||||||
|
}))
|
||||||
|
|
||||||
|
for _, line := range []string{"x -h", "x -help", "x --help", "x 10.0.0.1 -h", "x -address=1 -h"} {
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
r.Dispatch(line, MergedOutput(out))
|
||||||
|
assert.Contains(t, out.String(), "x - takes an address\n", line)
|
||||||
|
assert.Contains(t, out.String(), "-address string", line)
|
||||||
|
}
|
||||||
|
assert.Empty(t, seen, "asking for help must not run the command")
|
||||||
|
|
||||||
|
for _, line := range []string{"x -address -h", "x -- -h"} {
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
r.Dispatch(line, MergedOutput(out))
|
||||||
|
assert.Empty(t, out.String(), line)
|
||||||
|
}
|
||||||
|
assert.Equal(t, []string{"-h|", "|-h"}, seen)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestBadFlagIsAnsweredWithTheCommandsHelp: a flag the command does not have is reported
|
||||||
|
// on the error stream followed by the command's usage, in the rendering help uses.
|
||||||
|
func TestBadFlagIsAnsweredWithTheCommandsHelp(t *testing.T) {
|
||||||
|
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||||
|
r := New()
|
||||||
|
r.Register(&Command{Name: "x", ShortDescription: "has no flags", Run: func(fs any, a []string) (Result, error) { return Nothing(), nil }})
|
||||||
|
|
||||||
|
require.Error(t, r.DispatchArgs([]string{"x", "-nope"}, Output{Out: out, Err: errOut}))
|
||||||
|
assert.Empty(t, out.String())
|
||||||
|
assert.Equal(t, "flag provided but not defined: -nope\nx - has no flags\n -json\n \toutputs as json\n -pretty\n \tpretty prints json, assumes -json\n", errOut.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestParameterMistakesAreParamErrors: a surface with status codes needs to tell a
|
||||||
|
// parameter the caller got wrong from a command that failed, and Invoke says which by
|
||||||
|
// the error's type rather than its words.
|
||||||
|
func TestParameterMistakesAreParamErrors(t *testing.T) {
|
||||||
|
r := New()
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "flagged",
|
||||||
|
Flags: func() (*flag.FlagSet, any) {
|
||||||
|
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||||
|
s := struct{ N int }{}
|
||||||
|
fl.IntVar(&s.N, "n", 0, "")
|
||||||
|
return fl, &s
|
||||||
|
},
|
||||||
|
Run: func(fs any, a []string) (Result, error) { return Result{}, errors.New("ran and failed") },
|
||||||
|
})
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "bare",
|
||||||
|
Run: func(fs any, a []string) (Result, error) { return Nothing(), nil },
|
||||||
|
})
|
||||||
|
|
||||||
|
var pe *ParamError
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
params map[string]string
|
||||||
|
}{
|
||||||
|
{"flagged", map[string]string{"nope": "1"}},
|
||||||
|
{"flagged", map[string]string{"n": "x"}},
|
||||||
|
{"flagged", map[string]string{FlagJSON: "true"}},
|
||||||
|
{"bare", map[string]string{"n": "1"}},
|
||||||
|
} {
|
||||||
|
_, err := Invoke(Request{Command: r.Get(Name(tc.name)), Params: tc.params})
|
||||||
|
require.Error(t, err, "%s %v", tc.name, tc.params)
|
||||||
|
require.ErrorAs(t, err, &pe, "%s %v: %v", tc.name, tc.params, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := Invoke(Request{Command: r.Get("flagged"), Params: map[string]string{"n": "1"}})
|
||||||
|
require.EqualError(t, err, "ran and failed")
|
||||||
|
assert.NotErrorAs(t, err, &pe, "a Run error is the command's, not the caller's")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRunErrorIsShown: an error Run returns reaches the person at the prompt on the
|
||||||
|
// error stream, as well as the surface that logs it.
|
||||||
|
func TestRunErrorIsShown(t *testing.T) {
|
||||||
|
r := New()
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "broken",
|
||||||
|
ShortDescription: "cannot do what it is asked",
|
||||||
|
Run: func(fs any, a []string) (Result, error) {
|
||||||
|
return Result{}, errors.New("no certificate is loaded")
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
out, errOut := &bytes.Buffer{}, &bytes.Buffer{}
|
||||||
|
require.EqualError(t, r.DispatchArgs([]string{"broken"}, Output{Out: out, Err: errOut}), "no certificate is loaded")
|
||||||
|
assert.Empty(t, out.String())
|
||||||
|
assert.Equal(t, "no certificate is loaded\n", errOut.String())
|
||||||
|
}
|
||||||
@@ -0,0 +1,194 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNoTextRendering is returned by Render when a command's Value has no human rendering
|
||||||
|
// and text was asked for anyway. A command declares this by leaving Text nil and saying
|
||||||
|
// so with JSONOnly; it is not a fallback situation but a statement that no such form
|
||||||
|
// exists yet, so nobody builds a script around an interim one. Each surface's default
|
||||||
|
// policy avoids ever asking.
|
||||||
|
var ErrNoTextRendering = errors.New("no human readable output yet; pass -json or -pretty")
|
||||||
|
|
||||||
|
// Format is how a result should be presented.
|
||||||
|
type Format int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// FormatUnset is a request that expressed no preference. A surface resolves it with
|
||||||
|
// its own default before rendering; Render itself treats it as FormatText.
|
||||||
|
FormatUnset Format = iota
|
||||||
|
|
||||||
|
// FormatText renders for a person. It is what an operator gets by default on every
|
||||||
|
// surface with a human at the other end.
|
||||||
|
FormatText
|
||||||
|
|
||||||
|
// FormatJSON renders the result as compact JSON.
|
||||||
|
FormatJSON
|
||||||
|
|
||||||
|
// FormatPrettyJSON renders the result as indented JSON.
|
||||||
|
FormatPrettyJSON
|
||||||
|
)
|
||||||
|
|
||||||
|
// Flag names for the two presentation flags. They are offered on every command rather
|
||||||
|
// than declared by each one, because how a result is displayed is not a property of the
|
||||||
|
// command that produced it.
|
||||||
|
const (
|
||||||
|
FlagJSON = "json"
|
||||||
|
FlagPretty = "pretty"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Flag names nebula ctl takes for itself, anywhere on its line, to say which daemon to
|
||||||
|
// talk to; see reservedFlags.
|
||||||
|
const (
|
||||||
|
FlagConfig = "config"
|
||||||
|
FlagSocket = "socket"
|
||||||
|
)
|
||||||
|
|
||||||
|
// reservedFlags are handled before a command's Run is called, so a command may not
|
||||||
|
// declare them itself. -h and -help are intercepted as a request for usage; -json and
|
||||||
|
// -pretty are added to every command's FlagSet by commandFlags, on every surface, so a
|
||||||
|
// command that defined either would make that definition panic with "flag redefined"
|
||||||
|
// on whichever goroutine ran the command; and -config and -socket are nebula ctl's own,
|
||||||
|
// taken off the line before the client knows which command it names, so a command
|
||||||
|
// that declared either would never receive it there.
|
||||||
|
var reservedFlags = []string{"h", "help", FlagJSON, FlagPretty, FlagConfig, FlagSocket}
|
||||||
|
|
||||||
|
// Render writes r in the requested format. Every surface calls it, so a hostmap looks
|
||||||
|
// the same over ssh as it does through the control socket, and a change to either
|
||||||
|
// rendering happens once.
|
||||||
|
func Render(c *Command, r Result, f Format, w io.Writer) error {
|
||||||
|
switch f {
|
||||||
|
case FormatJSON:
|
||||||
|
return renderJSON(r.Payload(), w, false)
|
||||||
|
|
||||||
|
case FormatPrettyJSON:
|
||||||
|
return renderJSON(r.Payload(), w, true)
|
||||||
|
|
||||||
|
default:
|
||||||
|
// An outcome reads the same for every command: its reason, as a sentence. Only a
|
||||||
|
// Value needs the command's own rendering, so Text never sees anything else.
|
||||||
|
if r.Value == nil {
|
||||||
|
_, err := io.WriteString(w, r.Reason+"\n")
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if c != nil && c.Text != nil {
|
||||||
|
return c.Text(r.Value, w)
|
||||||
|
}
|
||||||
|
|
||||||
|
name := "this command"
|
||||||
|
if c != nil {
|
||||||
|
name = string(c.Name)
|
||||||
|
}
|
||||||
|
return fmt.Errorf("%s has %w", name, ErrNoTextRendering)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func renderJSON(v any, w io.Writer, indent bool) error {
|
||||||
|
enc := json.NewEncoder(w)
|
||||||
|
if indent {
|
||||||
|
enc.SetIndent("", " ")
|
||||||
|
}
|
||||||
|
|
||||||
|
return enc.Encode(v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Result is what every Run returns: whether the command worked, a sentence saying so,
|
||||||
|
// and, for a command that reports rather than acts, the value it produced.
|
||||||
|
//
|
||||||
|
// Value and Reason are alternatives. A command that reports returns Value(v), and the
|
||||||
|
// surfaces render v, as JSON or through the command's Text. A command that acts, or any
|
||||||
|
// command refusing its arguments, returns Did or Failed, and the surfaces render the
|
||||||
|
// Outcome: its Reason is the sentence these commands have always printed. Nothing is for
|
||||||
|
// a command with nothing to say.
|
||||||
|
//
|
||||||
|
// The envelope itself never reaches a caller. Payload is what JSON carries, and Render
|
||||||
|
// hands Text only the Value, so a command's renderer sees the one type it returns on
|
||||||
|
// success and is never asked to recognise an Outcome.
|
||||||
|
type Result struct {
|
||||||
|
Outcome
|
||||||
|
Value any
|
||||||
|
|
||||||
|
// NotFound marks a refusal that is about the thing asked for rather than the asking:
|
||||||
|
// a vpn address with no tunnel behind it, as opposed to one that would not parse. It
|
||||||
|
// renders exactly as any other refusal, and never reaches the wire; the distinction
|
||||||
|
// is for a surface whose protocol has a word for it, so an HTTP client is told 404
|
||||||
|
// rather than 400 and never has to parse the sentence.
|
||||||
|
NotFound bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Outcome is the part of a Result that says whether the command worked and, in words a
|
||||||
|
// caller can show someone, why. It is what a program receives from a command that acts
|
||||||
|
// rather than reports: closing a tunnel, changing a remote, reloading config.
|
||||||
|
//
|
||||||
|
// One shape serves all of them. Designing a payload per outcome would be work without a
|
||||||
|
// reader. Reason is set either way, so a success says what it did rather than leaving
|
||||||
|
// the caller to infer it from a bare true.
|
||||||
|
type Outcome struct {
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
Reason string `json:"reason"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Value is the Result of a command that reports: v is what it has to show, and it must
|
||||||
|
// marshal to JSON.
|
||||||
|
func Value(v any) Result {
|
||||||
|
return Result{Outcome: Outcome{OK: true}, Value: v}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Failed is a convenience for the common "it did not work, here is why" case.
|
||||||
|
func Failed(format string, args ...any) Result {
|
||||||
|
return Result{Outcome: Outcome{Reason: fmt.Sprintf(format, args...)}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotFound is Failed for a command asked about something that does not exist. See
|
||||||
|
// Result.NotFound.
|
||||||
|
func NotFound(format string, args ...any) Result {
|
||||||
|
r := Failed(format, args...)
|
||||||
|
r.NotFound = true
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// Did is a convenience for the common "it worked, here is what happened" case.
|
||||||
|
func Did(format string, args ...any) Result {
|
||||||
|
return Result{Outcome: Outcome{OK: true, Reason: fmt.Sprintf(format, args...)}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nothing is the Result of a command with nothing to say: it did its work, and the
|
||||||
|
// surface sends an empty, successful reply without rendering anything.
|
||||||
|
func Nothing() Result {
|
||||||
|
return Result{Outcome: Outcome{OK: true}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Empty reports a Result with nothing to render: no Value and no Reason. The zero Result
|
||||||
|
// counts, so a Run that returns Result{} says nothing rather than failing silently.
|
||||||
|
func (r Result) Empty() bool {
|
||||||
|
return r.Value == nil && r.Reason == ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// Payload is what a program receives: the Value when there is one, otherwise the
|
||||||
|
// Outcome. No surface sends the envelope itself, so print-tunnel -json emits the tunnel
|
||||||
|
// and close-tunnel -json emits {ok, reason}.
|
||||||
|
func (r Result) Payload() any {
|
||||||
|
if r.Value != nil {
|
||||||
|
return r.Value
|
||||||
|
}
|
||||||
|
return r.Outcome
|
||||||
|
}
|
||||||
|
|
||||||
|
// Typed adapts a renderer for one result type to the TextFunc a Command declares. The
|
||||||
|
// value Render passes is the command's own, see Result, so all that is left is to name
|
||||||
|
// its type once here instead of asserting it at the top of every renderer. A renderer
|
||||||
|
// paired with a command that returns something else fails here, saying what arrived.
|
||||||
|
func Typed[T any](render func(T, io.Writer) error) TextFunc {
|
||||||
|
return func(v any, w io.Writer) error {
|
||||||
|
t, ok := v.(T)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("expected %T, got %T", t, v)
|
||||||
|
}
|
||||||
|
return render(t, w)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,123 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"io"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestRenderPrintsAnOutcomeWithoutText: a command that acts declares no Text. Its
|
||||||
|
// outcome renders as the reason, the same for every command, and as {ok, reason} in
|
||||||
|
// JSON, which is the shape these commands have always emitted.
|
||||||
|
func TestRenderPrintsAnOutcomeWithoutText(t *testing.T) {
|
||||||
|
c := &Command{Name: "act"}
|
||||||
|
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, Render(c, Did("Closed"), FormatText, out))
|
||||||
|
assert.Equal(t, "Closed\n", out.String())
|
||||||
|
|
||||||
|
out.Reset()
|
||||||
|
require.NoError(t, Render(c, Failed("No vpn address was provided"), FormatText, out))
|
||||||
|
assert.Equal(t, "No vpn address was provided\n", out.String())
|
||||||
|
|
||||||
|
out.Reset()
|
||||||
|
require.NoError(t, Render(c, Failed("nope"), FormatJSON, out))
|
||||||
|
assert.JSONEq(t, `{"ok":false,"reason":"nope"}`, out.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRenderHandsTextOnlyTheValue pins the guarantee Result exists for: a command's
|
||||||
|
// renderer sees the type it returns on success and never the envelope or an outcome, so
|
||||||
|
// a report command that refuses its arguments needs nothing in its Text to cope.
|
||||||
|
func TestRenderHandsTextOnlyTheValue(t *testing.T) {
|
||||||
|
var got any
|
||||||
|
c := &Command{
|
||||||
|
Name: "report",
|
||||||
|
Text: func(v any, w io.Writer) error {
|
||||||
|
got = v
|
||||||
|
_, err := io.WriteString(w, "rendered\n")
|
||||||
|
return err
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, Render(c, Value("data"), FormatText, out))
|
||||||
|
assert.Equal(t, "data", got)
|
||||||
|
assert.Equal(t, "rendered\n", out.String())
|
||||||
|
|
||||||
|
got, out = nil, &bytes.Buffer{}
|
||||||
|
require.NoError(t, Render(c, Failed("refused"), FormatText, out))
|
||||||
|
assert.Nil(t, got, "Text must not be called for an outcome")
|
||||||
|
assert.Equal(t, "refused\n", out.String())
|
||||||
|
|
||||||
|
out.Reset()
|
||||||
|
require.NoError(t, Render(c, Value("data"), FormatJSON, out))
|
||||||
|
assert.JSONEq(t, `"data"`, out.String(), "JSON carries the value, never the envelope")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRenderRefusesTextForAValueWithoutText: leaving Text nil is a statement that no
|
||||||
|
// human form of the value exists yet, and asking for one is an error that says so.
|
||||||
|
func TestRenderRefusesTextForAValueWithoutText(t *testing.T) {
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
err := Render(&Command{Name: "print-tunnel"}, Value(map[string]int{"index": 7}), FormatText, out)
|
||||||
|
require.ErrorIs(t, err, ErrNoTextRendering)
|
||||||
|
require.ErrorContains(t, err, "print-tunnel has no human readable output yet")
|
||||||
|
assert.Empty(t, out.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestTypedNamesTheTypeOnce: Typed replaces the assertion at the top of every renderer.
|
||||||
|
// The right type reaches the renderer; the wrong one is reported, naming both.
|
||||||
|
func TestTypedNamesTheTypeOnce(t *testing.T) {
|
||||||
|
type info struct{ Name string }
|
||||||
|
render := Typed(func(i info, w io.Writer) error {
|
||||||
|
_, err := io.WriteString(w, i.Name+"\n")
|
||||||
|
return err
|
||||||
|
})
|
||||||
|
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, render(info{Name: "tun0"}, out))
|
||||||
|
assert.Equal(t, "tun0\n", out.String())
|
||||||
|
|
||||||
|
err := render("not an info", out)
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.ErrorContains(t, err, "expected commands.info, got string")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestResultShapes pins what each constructor means to a surface: Empty is the one that
|
||||||
|
// renders nothing, Payload is what a program receives, and OK is set wherever a reason
|
||||||
|
// or value says the command worked.
|
||||||
|
func TestResultShapes(t *testing.T) {
|
||||||
|
assert.True(t, Nothing().Empty())
|
||||||
|
assert.True(t, Result{}.Empty(), "the zero Result says nothing rather than failing silently")
|
||||||
|
assert.False(t, Did("done").Empty())
|
||||||
|
assert.False(t, Failed("no").Empty())
|
||||||
|
assert.False(t, Value("x").Empty())
|
||||||
|
|
||||||
|
assert.True(t, Value("x").OK)
|
||||||
|
assert.True(t, Did("done").OK)
|
||||||
|
assert.False(t, Failed("no").OK)
|
||||||
|
|
||||||
|
assert.Equal(t, "x", Value("x").Payload())
|
||||||
|
assert.Equal(t, Outcome{OK: true, Reason: "done"}, Did("done").Payload())
|
||||||
|
assert.Equal(t, Outcome{Reason: "no"}, Failed("no").Payload())
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestNotFoundIsARefusalLikeAnyOther: NotFound renders and marshals exactly as Failed
|
||||||
|
// does, so no surface's output changes by a command adopting it. The mark is on the
|
||||||
|
// Result alone, for a surface whose protocol has a word for it.
|
||||||
|
func TestNotFoundIsARefusalLikeAnyOther(t *testing.T) {
|
||||||
|
r := NotFound("No active tunnel for vpn addr: %s", "10.0.0.5")
|
||||||
|
assert.False(t, r.OK)
|
||||||
|
assert.True(t, r.NotFound)
|
||||||
|
assert.False(t, Failed("nope").NotFound)
|
||||||
|
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, Render(&Command{Name: "look"}, r, FormatText, out))
|
||||||
|
assert.Equal(t, "No active tunnel for vpn addr: 10.0.0.5\n", out.String())
|
||||||
|
|
||||||
|
out.Reset()
|
||||||
|
require.NoError(t, Render(&Command{Name: "look"}, r, FormatJSON, out))
|
||||||
|
assert.JSONEq(t, `{"ok":false,"reason":"No active tunnel for vpn addr: 10.0.0.5"}`, out.String(), "the mark never reaches the wire")
|
||||||
|
}
|
||||||
@@ -0,0 +1,143 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"flag"
|
||||||
|
"maps"
|
||||||
|
"slices"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Request is one command to run, as every surface hands it to Invoke: the command, its
|
||||||
|
// options by name in the form their flags parse, its operands, and the rendering the
|
||||||
|
// line asked for, if any.
|
||||||
|
//
|
||||||
|
// nebula ctl builds one with ParseLine and it travels as a JSON object to the control
|
||||||
|
// socket. An ssh line never becomes one: it is parsed straight into the command's own
|
||||||
|
// FlagSet; see execLine.
|
||||||
|
type Request struct {
|
||||||
|
// Command is the command to run, resolved by the surface at its edge. See
|
||||||
|
// Registry.Resolve for the one that tells an unknown name from a withheld one.
|
||||||
|
Command *Command
|
||||||
|
|
||||||
|
// Params carries the options the line set, by flag name, each in the form its flag
|
||||||
|
// parses from. An option left alone is absent, so the command's default applies.
|
||||||
|
Params map[string]string
|
||||||
|
|
||||||
|
// Args carries the operands: whatever the line did not consume as a flag.
|
||||||
|
Args []string
|
||||||
|
|
||||||
|
// Format is the rendering the line asked for with -json or -pretty, or FormatUnset
|
||||||
|
// when it expressed no preference. It is ParseLine's reading of the line for the
|
||||||
|
// client that sends the Request; Invoke does not read it, since the surface that
|
||||||
|
// runs a Request renders with the format it agreed with its caller.
|
||||||
|
Format Format
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseLine reads a FlagSet that ParseArgs has filled, and the operands it returned,
|
||||||
|
// into a Request to send over the wire. Command is left for the caller to set.
|
||||||
|
//
|
||||||
|
// Every flag the line set other than the presentation flags travels by name, as its
|
||||||
|
// flag's String, which is what the daemon's Set parses. That round trip is exact for
|
||||||
|
// the bool and string flags a client builds from the schema; it is the client's to make,
|
||||||
|
// and the ssh path does not make it, since it runs the FlagSet it parsed.
|
||||||
|
func ParseLine(fl *flag.FlagSet, operands []string) Request {
|
||||||
|
req := Request{Args: operands, Format: presentationFormat(fl)}
|
||||||
|
|
||||||
|
fl.Visit(func(f *flag.Flag) {
|
||||||
|
if isPresentationFlag(f.Name) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if req.Params == nil {
|
||||||
|
req.Params = map[string]string{}
|
||||||
|
}
|
||||||
|
req.Params[f.Name] = f.Value.String()
|
||||||
|
})
|
||||||
|
|
||||||
|
return req
|
||||||
|
}
|
||||||
|
|
||||||
|
// presentationFormat is the one reading of -json and -pretty from a parsed line, so a
|
||||||
|
// line means the same on every surface: only a flag set to true asks for JSON, since one
|
||||||
|
// set to false expresses no preference, and -pretty implies -json. FormatUnset means the
|
||||||
|
// line expressed no preference and the surface's own default applies.
|
||||||
|
func presentationFormat(fl *flag.FlagSet) Format {
|
||||||
|
var asJSON, pretty bool
|
||||||
|
fl.Visit(func(f *flag.Flag) {
|
||||||
|
switch f.Name {
|
||||||
|
case FlagJSON:
|
||||||
|
asJSON = flagIsTrue(f)
|
||||||
|
case FlagPretty:
|
||||||
|
pretty = flagIsTrue(f)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case pretty:
|
||||||
|
return FormatPrettyJSON
|
||||||
|
case asJSON:
|
||||||
|
return FormatJSON
|
||||||
|
default:
|
||||||
|
return FormatUnset
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PresentationFormat is presentationFormat for a surface that takes a command's options
|
||||||
|
// by name rather than from a line: the info API's query string. Only the two presentation
|
||||||
|
// flags are read from params; the command's own parameters are the caller's to pass to
|
||||||
|
// Invoke, which refuses these two among them. A flag given with no value counts as set,
|
||||||
|
// as -pretty does on a line, and one that is not a boolean is a ParamError.
|
||||||
|
func PresentationFormat(params map[string]string) (Format, error) {
|
||||||
|
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||||
|
addPresentationFlags(fl)
|
||||||
|
|
||||||
|
for _, k := range []string{FlagJSON, FlagPretty} {
|
||||||
|
v, ok := params[k]
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if v == "" {
|
||||||
|
v = "true"
|
||||||
|
}
|
||||||
|
if err := setFlag(fl, fl.Lookup(k), v); err != nil {
|
||||||
|
return FormatUnset, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return presentationFormat(fl), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// flagIsTrue reports whether a bool flag was set to true. The flag package's bool value
|
||||||
|
// is a flag.Getter whose Get returns the bool, so this never falls back to parsing text.
|
||||||
|
func flagIsTrue(f *flag.Flag) bool {
|
||||||
|
g, ok := f.Value.(flag.Getter)
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
b, _ := g.Get().(bool)
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// Invoke runs one Request and returns the command's Result, unrendered.
|
||||||
|
//
|
||||||
|
// The parameters are applied by flag name, in name order: a request from the wire is a
|
||||||
|
// JSON object with no order of its own, and which of two bad parameters is reported must
|
||||||
|
// not change from one request to the next. An unknown parameter is an error rather than
|
||||||
|
// something quietly ignored, because a caller that misspells one deserves to hear about
|
||||||
|
// it instead of getting a default. A bad parameter means Run is never called, and the
|
||||||
|
// FlagSet is fresh for this call, so nothing set before it is seen by anyone.
|
||||||
|
//
|
||||||
|
// Nothing here writes anywhere and nothing here renders. What a surface does with the
|
||||||
|
// Result, marshal its Payload or run the command's own text rendering through Render,
|
||||||
|
// is the surface's decision, and keeping that out of here is what lets a caller tell a
|
||||||
|
// refusal from a success after the text has been produced. The presentation flags are
|
||||||
|
// not parameters: a Request says how it wants rendering in Format, and sending them as
|
||||||
|
// parameters is refused rather than read as a preference.
|
||||||
|
func Invoke(req Request) (Result, error) {
|
||||||
|
c := req.Command
|
||||||
|
|
||||||
|
fl, fs, own := commandFlags(c)
|
||||||
|
if err := setParams(fl, string(c.Name), slices.Sorted(maps.Keys(req.Params)), req.Params, own); err != nil {
|
||||||
|
return Result{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.Run(fs, req.Args)
|
||||||
|
}
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
import (
|
||||||
|
"flag"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func lineFlags() *flag.FlagSet {
|
||||||
|
fl := flag.NewFlagSet("set", flag.ContinueOnError)
|
||||||
|
fl.Bool("verbose", false, "")
|
||||||
|
fl.Duration("wait", 0, "")
|
||||||
|
fl.String("label", "none", "")
|
||||||
|
fl.Bool(FlagJSON, false, "")
|
||||||
|
fl.Bool(FlagPretty, false, "")
|
||||||
|
return fl
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestParseLineReadsThePresentationFlagsOnce: presentationFormat is the one reading of
|
||||||
|
// -json and -pretty, for every surface, and ParseLine carries its answer. A flag set to
|
||||||
|
// false expresses no preference, and neither flag ever travels as a parameter.
|
||||||
|
func TestParseLineReadsThePresentationFlagsOnce(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
args []string
|
||||||
|
want Format
|
||||||
|
}{
|
||||||
|
{nil, FormatUnset},
|
||||||
|
{[]string{"-json=false"}, FormatUnset},
|
||||||
|
{[]string{"-pretty=false"}, FormatUnset},
|
||||||
|
{[]string{"-json"}, FormatJSON},
|
||||||
|
{[]string{"-pretty"}, FormatPrettyJSON},
|
||||||
|
{[]string{"-pretty", "-json=false"}, FormatPrettyJSON},
|
||||||
|
} {
|
||||||
|
fl := lineFlags()
|
||||||
|
operands, err := ParseArgs(fl, tc.args)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
req := ParseLine(fl, operands)
|
||||||
|
assert.Equal(t, tc.want, req.Format, "%v", tc.args)
|
||||||
|
assert.Nil(t, req.Params, "%v: presentation flags are not parameters", tc.args)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestParseLineCarriesWhatWasSetInParseableForm: only the flags the line set travel,
|
||||||
|
// each as the string its flag parses from, so the daemon's Invoke can apply them to a
|
||||||
|
// fresh FlagSet and get the same values back. Operands come through untouched, those
|
||||||
|
// after "--" included.
|
||||||
|
func TestParseLineCarriesWhatWasSetInParseableForm(t *testing.T) {
|
||||||
|
fl := lineFlags()
|
||||||
|
operands, err := ParseArgs(fl, []string{"-verbose", "-wait", "2s", "x", "--", "-1"})
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
req := ParseLine(fl, operands)
|
||||||
|
assert.Equal(t, map[string]string{"verbose": "true", "wait": "2s"}, req.Params, "label was left alone and must be absent")
|
||||||
|
assert.Equal(t, []string{"x", "-1"}, req.Args)
|
||||||
|
assert.Equal(t, FormatUnset, req.Format)
|
||||||
|
|
||||||
|
// The round trip a client makes: what ParseLine produced is what Invoke applies.
|
||||||
|
r, seen := paramRegistry(t)
|
||||||
|
req.Command = r.Get("set")
|
||||||
|
_, err = Invoke(req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Len(t, *seen, 1)
|
||||||
|
assert.Equal(t, paramsSeen{Verbose: true, Wait: 2 * time.Second}, (*seen)[0])
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestLineRunsTheFlagSetItParsed: the ssh path hands Run the FlagSet the line was parsed
|
||||||
|
// into, with no trip through a Request. A flag.Func has no String worth re-parsing, so a
|
||||||
|
// round trip would hand Run an empty value and no error; the line's value must arrive.
|
||||||
|
func TestLineRunsTheFlagSetItParsed(t *testing.T) {
|
||||||
|
var seen []string
|
||||||
|
r := New()
|
||||||
|
r.Register(&Command{
|
||||||
|
Name: "mode",
|
||||||
|
Flags: func() (*flag.FlagSet, any) {
|
||||||
|
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||||
|
s := new(string)
|
||||||
|
fl.Func("mode", "the mode", func(v string) error {
|
||||||
|
*s = "set:" + v
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
return fl, s
|
||||||
|
},
|
||||||
|
Run: func(fs any, a []string) (Result, error) {
|
||||||
|
seen = append(seen, *fs.(*string))
|
||||||
|
return Value("ok"), nil
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
var out, errw strings.Builder
|
||||||
|
r.Dispatch("mode -json -mode fast", Output{Out: &out, Err: &errw})
|
||||||
|
require.Equal(t, []string{"set:fast"}, seen)
|
||||||
|
assert.Empty(t, errw.String())
|
||||||
|
assert.Equal(t, "\"ok\"\n", out.String(), "-json was read from the same FlagSet")
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
package commands
|
||||||
|
|
||||||
|
import "io"
|
||||||
|
|
||||||
|
// Output is where a command line surface's text goes.
|
||||||
|
//
|
||||||
|
// Out and Err are distinct so a command's primary output can stay machine readable on
|
||||||
|
// a surface that separates the two. The ssh surface points both at the same channel and
|
||||||
|
// sees a single merged stream. The local
|
||||||
|
// control socket does not use one at all: it invokes by named parameter and carries the
|
||||||
|
// returned value, so there is no stream for a command to write to.
|
||||||
|
type Output struct {
|
||||||
|
// Out receives what a command produces.
|
||||||
|
Out io.Writer
|
||||||
|
|
||||||
|
// Err receives usage text, refusals and errors.
|
||||||
|
Err io.Writer
|
||||||
|
}
|
||||||
|
|
||||||
|
// MergedOutput sends output and errors to the same writer.
|
||||||
|
func MergedOutput(w io.Writer) Output {
|
||||||
|
return Output{Out: w, Err: w}
|
||||||
|
}
|
||||||
@@ -0,0 +1,145 @@
|
|||||||
|
package nebula
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"io"
|
||||||
|
"net/netip"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/cert"
|
||||||
|
"github.com/slackhq/nebula/cert_test"
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
"github.com/slackhq/nebula/logging"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestLogFormatRefusalIsShown: a format the logger does not know is a refusal the user
|
||||||
|
// sees, rather than a bare error, which over ssh was silence.
|
||||||
|
func TestLogFormatRefusalIsShown(t *testing.T) {
|
||||||
|
l := logging.NewLogger(io.Discard)
|
||||||
|
|
||||||
|
res, err := runLogFormat(l, []string{"bogus"})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.False(t, res.OK)
|
||||||
|
assert.Equal(t, "Unable to set log format: unknown log format `bogus`. possible formats: [text json]", res.Reason)
|
||||||
|
|
||||||
|
res, err = runLogFormat(l, []string{"JSON"})
|
||||||
|
require.NoError(t, err)
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, commands.Typed(textLogFormat)(res.Value, out))
|
||||||
|
assert.Equal(t, "Log format is: json\n", out.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPrintRelaysReportsErrorsAsText: the Error field was an error value, which encodes
|
||||||
|
// as {} and lost the message. It is the message now, and absent when there is none.
|
||||||
|
func TestPrintRelaysReportsErrorsAsText(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
hm := newHostMap(l)
|
||||||
|
relay := netip.MustParseAddr("10.0.0.1")
|
||||||
|
peer := netip.MustParseAddr("10.0.0.2")
|
||||||
|
|
||||||
|
// A relay host that is in Relays but not in Hosts, so its hostinfo cannot be found.
|
||||||
|
hm.Relays[1] = &HostInfo{vpnAddrs: []netip.Addr{relay}}
|
||||||
|
ifce := &Interface{hostMap: hm}
|
||||||
|
|
||||||
|
marshal := func() string {
|
||||||
|
b, err := json.Marshal(runPrintRelays(ifce))
|
||||||
|
require.NoError(t, err)
|
||||||
|
return string(b)
|
||||||
|
}
|
||||||
|
assert.JSONEq(t, `{"Relays":[{"NebulaAddr":"10.0.0.1","RelayForAddrs":[{"Error":"could not find hostinfo","Type":"","State":"","PeerAddr":"","LocalIndex":0,"RemoteIndex":0,"RelayedThrough":null}]}]}`, marshal())
|
||||||
|
|
||||||
|
// The same relay host, found, relaying for a peer whose index matches: no Error key.
|
||||||
|
hi := hm.Relays[1]
|
||||||
|
r := &Relay{Type: ForwardingType, State: Established, PeerAddr: peer, LocalIndex: 1, RemoteIndex: 2}
|
||||||
|
hi.relayState = RelayState{
|
||||||
|
relayForByAddr: map[netip.Addr]*Relay{peer: r},
|
||||||
|
relayForByIdx: map[uint32]*Relay{r.LocalIndex: r},
|
||||||
|
}
|
||||||
|
hm.Hosts[relay] = hi
|
||||||
|
assert.JSONEq(t, `{"Relays":[{"NebulaAddr":"10.0.0.1","RelayForAddrs":[{"Type":"forwarding","State":"established","PeerAddr":"10.0.0.2","LocalIndex":1,"RemoteIndex":2,"RelayedThrough":null}]}]}`, marshal())
|
||||||
|
|
||||||
|
// And an index mismatch names it.
|
||||||
|
hm.Relays[7] = hi
|
||||||
|
delete(hm.Relays, 1)
|
||||||
|
assert.Contains(t, marshal(), `"Error":"hostmap LocalIndex '7' does not match RelayState LocalIndex"`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPrintCertOfATunnelWithoutACertificate: a tunnel still handshaking, or one being
|
||||||
|
// torn down, has no certificate, and print-cert refuses rather than panicking.
|
||||||
|
func TestPrintCertOfATunnelWithoutACertificate(t *testing.T) {
|
||||||
|
f, _ := identityFixture(t)
|
||||||
|
|
||||||
|
r, err := runPrintCert(f, &printCertFlags{}, []string{"10.0.0.3"})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.False(t, r.OK)
|
||||||
|
assert.Equal(t, "Could not find tunnel for vpn addr: 10.0.0.3", r.Reason)
|
||||||
|
|
||||||
|
r, err = runPrintCert(f, &printCertFlags{}, []string{"10.0.0.2"})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.True(t, r.OK, "a tunnel with a certificate is printed")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPrintCertByAddressFlag: -address is the info API's spelling of the operand, takes a
|
||||||
|
// port and a 4in6 form the way identity does, answers our own address with our own
|
||||||
|
// certificate, and is refused together with an operand.
|
||||||
|
func TestPrintCertByAddressFlag(t *testing.T) {
|
||||||
|
f, peerCert := identityFixture(t)
|
||||||
|
|
||||||
|
for _, addr := range []string{"10.0.0.2", "10.0.0.2:4242", "[::ffff:10.0.0.2]:4242"} {
|
||||||
|
fl := &printCertFlags{}
|
||||||
|
require.NoError(t, fl.setAddress(addr))
|
||||||
|
r, err := runPrintCert(f, fl, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.True(t, r.OK, addr)
|
||||||
|
assert.Equal(t, peerCert, r.Value, addr)
|
||||||
|
}
|
||||||
|
|
||||||
|
fl := &printCertFlags{}
|
||||||
|
require.NoError(t, fl.setAddress("10.0.0.1"))
|
||||||
|
r, err := runPrintCert(f, fl, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.True(t, r.OK)
|
||||||
|
assert.Equal(t, ownCertificate(f.pki.getCertState()), r.Value, "our own address is our own certificate")
|
||||||
|
|
||||||
|
fl = &printCertFlags{}
|
||||||
|
require.NoError(t, fl.setAddress("10.0.0.3"))
|
||||||
|
r, err = runPrintCert(f, fl, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.False(t, r.OK)
|
||||||
|
assert.True(t, r.NotFound)
|
||||||
|
|
||||||
|
fl = &printCertFlags{}
|
||||||
|
require.NoError(t, fl.setAddress("not-an-address"))
|
||||||
|
r, err = runPrintCert(f, fl, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "The provided vpn addr could not be parsed: not-an-address", r.Reason)
|
||||||
|
|
||||||
|
fl = &printCertFlags{}
|
||||||
|
require.NoError(t, fl.setAddress("10.0.0.2"))
|
||||||
|
r, err = runPrintCert(f, fl, []string{"10.0.0.2"})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "print-cert takes one vpn addr, as -address or as an operand, not both", r.Reason)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPrintCertPrefersOwnV2: with no address print-cert reports the certificate whoami
|
||||||
|
// does, the v2 when both versions are loaded, rather than the one handshakes start with.
|
||||||
|
func TestPrintCertPrefersOwnV2(t *testing.T) {
|
||||||
|
v4 := netip.MustParsePrefix("10.0.0.1/24")
|
||||||
|
ca1, _, caKey1, _ := cert_test.NewTestCaCert(cert.Version1, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||||
|
v1, _, _, _ := cert_test.NewTestCert(cert.Version1, cert.Curve_CURVE25519, ca1, caKey1, "me", time.Time{}, time.Time{}, []netip.Prefix{v4}, nil, nil)
|
||||||
|
ca2, _, caKey2, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||||
|
v2, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca2, caKey2, "me", time.Time{}, time.Time{}, []netip.Prefix{v4}, nil, nil)
|
||||||
|
|
||||||
|
f := &Interface{pki: &PKI{}, hostMap: newHostMap(test.NewLogger())}
|
||||||
|
f.pki.cs.Store(&CertState{v1Cert: v1, v2Cert: v2, initiatingVersion: cert.Version1})
|
||||||
|
|
||||||
|
r, err := runPrintCert(f, &printCertFlags{}, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.True(t, r.OK)
|
||||||
|
assert.Equal(t, v2, r.Value)
|
||||||
|
}
|
||||||
+71
-32
@@ -5,6 +5,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"maps"
|
||||||
"math"
|
"math"
|
||||||
"os"
|
"os"
|
||||||
"os/signal"
|
"os/signal"
|
||||||
@@ -25,9 +26,17 @@ type C struct {
|
|||||||
files []string
|
files []string
|
||||||
Settings map[string]any
|
Settings map[string]any
|
||||||
oldSettings map[string]any
|
oldSettings map[string]any
|
||||||
callbacks []func(*C)
|
callbacks []func(*C, *Reload)
|
||||||
l *slog.Logger
|
l *slog.Logger
|
||||||
reloadLock sync.Mutex
|
reloadLock sync.Mutex
|
||||||
|
|
||||||
|
// Set by the first reload that needs a restart and never cleared. Guarded by reloadLock
|
||||||
|
needsRestart bool
|
||||||
|
|
||||||
|
// callbackLock guards callbacks. Registration is not confined to startup: CatchHUP is
|
||||||
|
// running from inside Main, and anything wired up after Main returns registers while
|
||||||
|
// a HUP could already be reloading, so append and iteration have to be serialized.
|
||||||
|
callbackLock sync.Mutex
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewC(l *slog.Logger) *C {
|
func NewC(l *slog.Logger) *C {
|
||||||
@@ -71,16 +80,45 @@ func (c *C) LoadString(raw string) error {
|
|||||||
// RegisterReloadCallback stores a function to be called when a config reload is triggered. The functions registered
|
// RegisterReloadCallback stores a function to be called when a config reload is triggered. The functions registered
|
||||||
// here should decide if they need to make a change to the current process before making the change. HasChanged can be
|
// here should decide if they need to make a change to the current process before making the change. HasChanged can be
|
||||||
// used to help decide if a change is necessary.
|
// used to help decide if a change is necessary.
|
||||||
// These functions should return quickly or spawn their own go routine if they will take a while
|
// These functions should return quickly or spawn their own go routine if they will take a while.
|
||||||
func (c *C) RegisterReloadCallback(f func(*C)) {
|
// Use r to report anything that failed or needs a restart to apply.
|
||||||
|
func (c *C) RegisterReloadCallback(f func(c *C, r *Reload)) {
|
||||||
|
c.callbackLock.Lock()
|
||||||
|
defer c.callbackLock.Unlock()
|
||||||
c.callbacks = append(c.callbacks, f)
|
c.callbacks = append(c.callbacks, f)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// reloadCallbacks returns a snapshot of the registered callbacks. Reloads iterate the
|
||||||
|
// snapshot rather than the live slice, so a registration from another goroutine cannot
|
||||||
|
// race the loop; a callback registered while a reload is in progress runs from the next
|
||||||
|
// reload on. callbackLock is not held during the calls themselves, so a callback that
|
||||||
|
// registers another callback does not deadlock.
|
||||||
|
func (c *C) reloadCallbacks() []func(*C, *Reload) {
|
||||||
|
c.callbackLock.Lock()
|
||||||
|
defer c.callbackLock.Unlock()
|
||||||
|
return append(make([]func(*C, *Reload), 0, len(c.callbacks)), c.callbacks...)
|
||||||
|
}
|
||||||
|
|
||||||
// InitialLoad returns true if this is the first load of the config, and ReloadConfig has not been called yet.
|
// InitialLoad returns true if this is the first load of the config, and ReloadConfig has not been called yet.
|
||||||
func (c *C) InitialLoad() bool {
|
func (c *C) InitialLoad() bool {
|
||||||
return c.oldSettings == nil
|
return c.oldSettings == nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Render returns keys and their values as yaml, for a subsystem to remember what it applied. Empty means they couldn't
|
||||||
|
// be rendered and should never match.
|
||||||
|
func (c *C) Render(keys ...string) string {
|
||||||
|
m := make(map[string]any, len(keys))
|
||||||
|
for _, k := range keys {
|
||||||
|
m[k] = c.Get(k)
|
||||||
|
}
|
||||||
|
b, err := yaml.Marshal(m)
|
||||||
|
if err != nil {
|
||||||
|
c.l.Debug("Failed to render config", "keys", keys, "error", err)
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return string(b)
|
||||||
|
}
|
||||||
|
|
||||||
// HasChanged checks if the underlying structure of the provided key has changed after a config reload. The value of
|
// HasChanged checks if the underlying structure of the provided key has changed after a config reload. The value of
|
||||||
// k in both the old and new settings will be serialized, the result of the string comparison is returned.
|
// k in both the old and new settings will be serialized, the result of the string comparison is returned.
|
||||||
// If k is an empty string the entire config is tested.
|
// If k is an empty string the entire config is tested.
|
||||||
@@ -143,54 +181,55 @@ func (c *C) CatchHUP(ctx context.Context) {
|
|||||||
return
|
return
|
||||||
case <-ch:
|
case <-ch:
|
||||||
c.l.Info("Caught HUP, reloading config")
|
c.l.Info("Caught HUP, reloading config")
|
||||||
c.ReloadConfig()
|
c.ReloadConfig().Log(c.l)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *C) ReloadConfig() {
|
// ReloadConfig reloads the config from the path provided to Load and runs every registered callback. A config that
|
||||||
|
// fails to load is logged here, like any other failure, and the result carries the error for the summary.
|
||||||
|
func (c *C) ReloadConfig() ReloadResult {
|
||||||
c.reloadLock.Lock()
|
c.reloadLock.Lock()
|
||||||
defer c.reloadLock.Unlock()
|
defer c.reloadLock.Unlock()
|
||||||
|
|
||||||
c.oldSettings = make(map[string]any)
|
c.oldSettings = make(map[string]any)
|
||||||
for k, v := range c.Settings {
|
maps.Copy(c.oldSettings, c.Settings)
|
||||||
c.oldSettings[k] = v
|
|
||||||
|
if err := c.Load(c.path); err != nil {
|
||||||
|
c.l.Error("Error occurred while reloading config", "config_path", c.path, "error", err)
|
||||||
|
return ReloadResult{Err: err, RestartRequired: c.needsRestart}
|
||||||
}
|
}
|
||||||
|
|
||||||
err := c.Load(c.path)
|
return c.runCallbacks()
|
||||||
if err != nil {
|
|
||||||
c.l.Error("Error occurred while reloading config",
|
|
||||||
"config_path", c.path,
|
|
||||||
"error", err,
|
|
||||||
)
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, v := range c.callbacks {
|
// ReloadConfigString is ReloadConfig for a config held in memory rather than on disk.
|
||||||
v(c)
|
func (c *C) ReloadConfigString(raw string) ReloadResult {
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *C) ReloadConfigString(raw string) error {
|
|
||||||
c.reloadLock.Lock()
|
c.reloadLock.Lock()
|
||||||
defer c.reloadLock.Unlock()
|
defer c.reloadLock.Unlock()
|
||||||
|
|
||||||
c.oldSettings = make(map[string]any)
|
c.oldSettings = make(map[string]any)
|
||||||
for k, v := range c.Settings {
|
maps.Copy(c.oldSettings, c.Settings)
|
||||||
c.oldSettings[k] = v
|
|
||||||
|
if err := c.LoadString(raw); err != nil {
|
||||||
|
c.l.Error("Error occurred while reloading config", "error", err)
|
||||||
|
return ReloadResult{Err: err, RestartRequired: c.needsRestart}
|
||||||
}
|
}
|
||||||
|
|
||||||
err := c.LoadString(raw)
|
return c.runCallbacks()
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, v := range c.callbacks {
|
func (c *C) runCallbacks() ReloadResult {
|
||||||
v(c)
|
r := &Reload{c: c}
|
||||||
|
for _, v := range c.reloadCallbacks() {
|
||||||
|
v(c, r)
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
if r.restart {
|
||||||
|
c.needsRestart = true
|
||||||
|
}
|
||||||
|
return ReloadResult{Failed: r.failed, RestartRequired: c.needsRestart, RestartKeys: r.keys}
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetString will get the string for k or return the default d if not found or invalid
|
// GetString will get the string for k or return the default d if not found or invalid
|
||||||
@@ -216,7 +255,7 @@ func (c *C) GetStringSlice(k string, d []string) []string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
v := make([]string, len(rv))
|
v := make([]string, len(rv))
|
||||||
for i := 0; i < len(v); i++ {
|
for i := range v {
|
||||||
v[i] = fmt.Sprintf("%v", rv[i])
|
v[i] = fmt.Sprintf("%v", rv[i])
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -310,8 +349,8 @@ func (c *C) IsSet(k string) bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (c *C) get(k string, v any) any {
|
func (c *C) get(k string, v any) any {
|
||||||
parts := strings.Split(k, ".")
|
parts := strings.SplitSeq(k, ".")
|
||||||
for _, p := range parts {
|
for p := range parts {
|
||||||
m, ok := v.(map[string]any)
|
m, ok := v.(map[string]any)
|
||||||
if !ok {
|
if !ok {
|
||||||
return nil
|
return nil
|
||||||
@@ -394,7 +433,7 @@ func (c *C) parse() error {
|
|||||||
var nm map[string]any
|
var nm map[string]any
|
||||||
err = yaml.Unmarshal(b, &nm)
|
err = yaml.Unmarshal(b, &nm)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return fmt.Errorf("%s: %w", path, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// We need to use WithAppendSlice so that firewall rules in separate
|
// We need to use WithAppendSlice so that firewall rules in separate
|
||||||
|
|||||||
+41
-2
@@ -3,6 +3,7 @@ package config
|
|||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -19,7 +20,7 @@ func TestConfig_Load(t *testing.T) {
|
|||||||
// invalid yaml
|
// invalid yaml
|
||||||
c := NewC(l)
|
c := NewC(l)
|
||||||
os.WriteFile(filepath.Join(dir, "01.yaml"), []byte(" invalid yaml"), 0644)
|
os.WriteFile(filepath.Join(dir, "01.yaml"), []byte(" invalid yaml"), 0644)
|
||||||
require.EqualError(t, c.Load(dir), "yaml: unmarshal errors:\n line 1: cannot unmarshal !!str `invalid...` into map[string]interface {}")
|
require.EqualError(t, c.Load(dir), filepath.Join(dir, "01.yaml")+": yaml: unmarshal errors:\n line 1: cannot unmarshal !!str `invalid...` into map[string]interface {}")
|
||||||
|
|
||||||
// simple multi config merge
|
// simple multi config merge
|
||||||
c = NewC(l)
|
c = NewC(l)
|
||||||
@@ -129,7 +130,7 @@ func TestConfig_ReloadConfig(t *testing.T) {
|
|||||||
|
|
||||||
os.WriteFile(filepath.Join(dir, "01.yaml"), []byte("outer:\n inner: ho"), 0644)
|
os.WriteFile(filepath.Join(dir, "01.yaml"), []byte("outer:\n inner: ho"), 0644)
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *C) {
|
c.RegisterReloadCallback(func(c *C, _ *Reload) {
|
||||||
done <- true
|
done <- true
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -220,3 +221,41 @@ firewall:
|
|||||||
}
|
}
|
||||||
assert.Equal(t, expected, m)
|
assert.Equal(t, expected, m)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestRegisterReloadCallbackDuringReload: registration is not confined to startup. The
|
||||||
|
// HUP handler runs from inside nebula.Main, and anything wired after Main returns
|
||||||
|
// registers while a reload may already be iterating the callbacks. Under -race this is
|
||||||
|
// the data race on the slice; without it, it checks a callback registered mid-reload is
|
||||||
|
// picked up by the next one.
|
||||||
|
func TestRegisterReloadCallbackDuringReload(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
c := NewC(l)
|
||||||
|
require.NoError(t, c.LoadString("a: 1"))
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(2)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
for i := 0; i < 200; i++ {
|
||||||
|
c.RegisterReloadCallback(func(*C, *Reload) {})
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
for i := 0; i < 200; i++ {
|
||||||
|
assert.NoError(t, c.ReloadConfigString("a: 1").Err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
wg.Wait()
|
||||||
|
|
||||||
|
// A callback that registers another callback must not deadlock, and the new one
|
||||||
|
// runs from the following reload on.
|
||||||
|
var ran int
|
||||||
|
c.RegisterReloadCallback(func(c *C, _ *Reload) {
|
||||||
|
c.RegisterReloadCallback(func(*C, *Reload) { ran++ })
|
||||||
|
})
|
||||||
|
require.NoError(t, c.ReloadConfigString("a: 1").Err)
|
||||||
|
assert.Equal(t, 0, ran, "registered during this reload, so not run by it")
|
||||||
|
require.NoError(t, c.ReloadConfigString("a: 1").Err)
|
||||||
|
assert.Equal(t, 1, ran, "and run by the next")
|
||||||
|
}
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"slices"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ReloadResult describes how a reload went. Problems are logged where they happen, Log writes a one line summary.
|
||||||
|
type ReloadResult struct {
|
||||||
|
// Err is set when the new config could not be read or parsed, no callbacks ran
|
||||||
|
Err error
|
||||||
|
// Failed is true when a callback could not apply part of the new config
|
||||||
|
Failed bool
|
||||||
|
// RestartRequired is true once any reload has needed a restart, and stays true until the process restarts
|
||||||
|
RestartRequired bool
|
||||||
|
// RestartKeys are the keys this reload changed that only apply on a restart
|
||||||
|
RestartKeys []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Summary returns a one line summary of the reload and the level to log it at.
|
||||||
|
func (r ReloadResult) Summary() (slog.Level, string) {
|
||||||
|
switch {
|
||||||
|
case r.Err != nil && r.RestartRequired:
|
||||||
|
return slog.LevelError, "Config reload failed, the new config did not load and a restart is still required"
|
||||||
|
case r.Err != nil:
|
||||||
|
return slog.LevelError, "Config reload failed, the new config did not load"
|
||||||
|
case r.Failed && r.RestartRequired:
|
||||||
|
return slog.LevelError, "Config reload completed with errors and requires a restart to fully apply, review the logs"
|
||||||
|
case r.Failed:
|
||||||
|
return slog.LevelError, "Config reload completed with errors, review the logs"
|
||||||
|
case r.RestartRequired:
|
||||||
|
return slog.LevelWarn, "Config reload was completed but requires a restart to fully apply"
|
||||||
|
default:
|
||||||
|
return slog.LevelInfo, "Config reload complete"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// String is the summary with Err and RestartKeys included, for output other than the log.
|
||||||
|
func (r ReloadResult) String() string {
|
||||||
|
_, msg := r.Summary()
|
||||||
|
if r.Err != nil {
|
||||||
|
msg = fmt.Sprintf("%s: %v", msg, r.Err)
|
||||||
|
}
|
||||||
|
if len(r.RestartKeys) > 0 {
|
||||||
|
msg = fmt.Sprintf("%s, keys %v", msg, r.RestartKeys)
|
||||||
|
}
|
||||||
|
return msg
|
||||||
|
}
|
||||||
|
|
||||||
|
// Log writes Summary to l.
|
||||||
|
func (r ReloadResult) Log(l *slog.Logger) {
|
||||||
|
level, msg := r.Summary()
|
||||||
|
if len(r.RestartKeys) > 0 {
|
||||||
|
l.Log(context.Background(), level, msg, "keys", r.RestartKeys)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
l.Log(context.Background(), level, msg)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reload is passed to each reload callback to report how applying the new config went.
|
||||||
|
type Reload struct {
|
||||||
|
c *C
|
||||||
|
failed bool
|
||||||
|
restart bool
|
||||||
|
// Changed keys that only apply on a restart, from every callback
|
||||||
|
keys []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Failed marks the reload as failed, the caller logs why. Safe to call on a nil Reload, which is what the initial load
|
||||||
|
// passes.
|
||||||
|
func (r *Reload) Failed() {
|
||||||
|
if r != nil {
|
||||||
|
r.failed = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RestartRequired marks the reload as needing a restart, the caller logs why. Safe to call on a nil Reload.
|
||||||
|
func (r *Reload) RestartRequired() {
|
||||||
|
if r != nil {
|
||||||
|
r.restart = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RestartRequiredIfChanged marks the reload as needing a restart if any of keys changed, and adds them to RestartKeys.
|
||||||
|
// Use it for keys that are only read at startup. Safe to call on a nil Reload.
|
||||||
|
func (r *Reload) RestartRequiredIfChanged(keys ...string) {
|
||||||
|
if r == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, k := range keys {
|
||||||
|
if r.c.HasChanged(k) && !slices.Contains(r.keys, k) {
|
||||||
|
r.keys = append(r.keys, k)
|
||||||
|
r.restart = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,108 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"log/slog"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestReloadConfigString(t *testing.T) {
|
||||||
|
c := NewC(test.NewLogger())
|
||||||
|
require.NoError(t, c.LoadString("a: 1"))
|
||||||
|
fail := false
|
||||||
|
ran := 0
|
||||||
|
c.RegisterReloadCallback(func(c *C, r *Reload) {
|
||||||
|
ran++
|
||||||
|
if fail {
|
||||||
|
r.Failed()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, ReloadResult{}, c.ReloadConfigString("a: 2"))
|
||||||
|
fail = true
|
||||||
|
assert.Equal(t, ReloadResult{Failed: true}, c.ReloadConfigString("a: 3"))
|
||||||
|
assert.Equal(t, 2, ran)
|
||||||
|
|
||||||
|
// A config that fails to load runs no callbacks and returns the error
|
||||||
|
res := c.ReloadConfigString("a: [")
|
||||||
|
require.Error(t, res.Err)
|
||||||
|
assert.False(t, res.Failed)
|
||||||
|
assert.Equal(t, 2, ran)
|
||||||
|
assert.Equal(t, 3, c.GetInt("a", 0))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReloadRestartRequiredLatches(t *testing.T) {
|
||||||
|
c := NewC(test.NewLogger())
|
||||||
|
require.NoError(t, c.LoadString("a: 1\nb: 1"))
|
||||||
|
c.RegisterReloadCallback(func(c *C, r *Reload) { r.RestartRequiredIfChanged("a", "b") })
|
||||||
|
|
||||||
|
// Nothing that needs a restart changed
|
||||||
|
assert.Equal(t, ReloadResult{}, c.ReloadConfigString("a: 1\nb: 1\nc: 1"))
|
||||||
|
assert.Equal(t, ReloadResult{RestartRequired: true, RestartKeys: []string{"a"}}, c.ReloadConfigString("a: 2\nb: 1\nc: 1"))
|
||||||
|
|
||||||
|
// The restart sticks through a reload with no changes, reverting the key and a config that fails to load. Only the
|
||||||
|
// reload that changed the key lists it
|
||||||
|
assert.Equal(t, ReloadResult{RestartRequired: true}, c.ReloadConfigString("a: 2\nb: 1\nc: 1"))
|
||||||
|
assert.Equal(t, ReloadResult{RestartRequired: true, RestartKeys: []string{"a"}}, c.ReloadConfigString("a: 1\nb: 1\nc: 1"))
|
||||||
|
|
||||||
|
res := c.ReloadConfigString("a: [")
|
||||||
|
require.Error(t, res.Err)
|
||||||
|
assert.True(t, res.RestartRequired)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A key reported by more than one callback is listed once
|
||||||
|
func TestReloadRestartKeysDeduped(t *testing.T) {
|
||||||
|
c := NewC(test.NewLogger())
|
||||||
|
require.NoError(t, c.LoadString("a: 1\nb: 1"))
|
||||||
|
c.RegisterReloadCallback(func(c *C, r *Reload) { r.RestartRequiredIfChanged("a") })
|
||||||
|
c.RegisterReloadCallback(func(c *C, r *Reload) { r.RestartRequiredIfChanged("a", "b") })
|
||||||
|
|
||||||
|
assert.Equal(t, []string{"a", "b"}, c.ReloadConfigString("a: 2\nb: 2").RestartKeys)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A callback can require a restart without a key changing, a file the config points at may have
|
||||||
|
func TestReloadRestartRequiredWithoutAChange(t *testing.T) {
|
||||||
|
c := NewC(test.NewLogger())
|
||||||
|
require.NoError(t, c.LoadString("a: 1"))
|
||||||
|
c.RegisterReloadCallback(func(c *C, r *Reload) { r.RestartRequired() })
|
||||||
|
|
||||||
|
assert.Equal(t, ReloadResult{RestartRequired: true}, c.ReloadConfigString("a: 1"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReloadResultSummary(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
res ReloadResult
|
||||||
|
level slog.Level
|
||||||
|
msg string
|
||||||
|
}{
|
||||||
|
{ReloadResult{}, slog.LevelInfo, "Config reload complete"},
|
||||||
|
{ReloadResult{RestartRequired: true}, slog.LevelWarn, "Config reload was completed but requires a restart to fully apply"},
|
||||||
|
{ReloadResult{Failed: true}, slog.LevelError, "Config reload completed with errors, review the logs"},
|
||||||
|
{ReloadResult{Failed: true, RestartRequired: true}, slog.LevelError, "Config reload completed with errors and requires a restart to fully apply, review the logs"},
|
||||||
|
{ReloadResult{Err: errors.New("bad yaml")}, slog.LevelError, "Config reload failed, the new config did not load"},
|
||||||
|
{ReloadResult{Err: errors.New("bad yaml"), RestartRequired: true}, slog.LevelError, "Config reload failed, the new config did not load and a restart is still required"},
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
level, msg := tc.res.Summary()
|
||||||
|
assert.Equal(t, tc.level, level, tc.msg)
|
||||||
|
assert.Equal(t, tc.msg, msg)
|
||||||
|
}
|
||||||
|
|
||||||
|
res := ReloadResult{RestartRequired: true, RestartKeys: []string{"a", "b"}}
|
||||||
|
assert.Equal(t, "Config reload was completed but requires a restart to fully apply, keys [a b]", res.String())
|
||||||
|
|
||||||
|
// String includes the error
|
||||||
|
assert.Equal(t, "Config reload failed, the new config did not load: bad yaml", ReloadResult{Err: errors.New("bad yaml")}.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// The initial load passes a nil Reload
|
||||||
|
func TestReloadNilIsSafe(t *testing.T) {
|
||||||
|
var r *Reload
|
||||||
|
r.Failed()
|
||||||
|
r.RestartRequired()
|
||||||
|
r.RestartRequiredIfChanged("a")
|
||||||
|
}
|
||||||
@@ -57,7 +57,8 @@ func newConnectionManagerFromConfig(l *slog.Logger, c *config.C, hm *HostMap, p
|
|||||||
}
|
}
|
||||||
|
|
||||||
cm.reload(c, true)
|
cm.reload(c, true)
|
||||||
c.RegisterReloadCallback(func(c *config.C) {
|
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||||
|
r.RestartRequiredIfChanged("timers.connection_alive_interval", "timers.pending_deletion_interval")
|
||||||
cm.reload(c, false)
|
cm.reload(c, false)
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -174,10 +175,8 @@ func (cm *connectionManager) doTrafficCheck(localIndex uint32, p, nb, out []byte
|
|||||||
|
|
||||||
switch decision {
|
switch decision {
|
||||||
case deleteTunnel:
|
case deleteTunnel:
|
||||||
if cm.hostMap.DeleteHostInfo(hostinfo) {
|
// Local delete only, clearing the lighthouse cache if this was the last hostinfo for the vpn addr
|
||||||
// Only clearing the lighthouse cache if this is the last hostinfo for this vpn ip in the hostmap
|
cm.intf.closeTunnel(hostinfo)
|
||||||
cm.intf.lightHouse.DeleteVpnAddrs(hostinfo.vpnAddrs)
|
|
||||||
}
|
|
||||||
|
|
||||||
case closeTunnel:
|
case closeTunnel:
|
||||||
cm.intf.sendCloseTunnel(hostinfo)
|
cm.intf.sendCloseTunnel(hostinfo)
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/rcrowley/go-metrics"
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/overlay/overlaytest"
|
"github.com/slackhq/nebula/overlay/overlaytest"
|
||||||
@@ -21,6 +22,8 @@ func newTestLighthouse() *LightHouse {
|
|||||||
l: test.NewLogger(),
|
l: test.NewLogger(),
|
||||||
addrMap: map[netip.Addr]*RemoteList{},
|
addrMap: map[netip.Addr]*RemoteList{},
|
||||||
queryChan: make(chan netip.Addr, 10),
|
queryChan: make(chan netip.Addr, 10),
|
||||||
|
// Nothing drains queryChan here, so an 11th query is dropped.
|
||||||
|
queryDropped: metrics.NilCounter{},
|
||||||
}
|
}
|
||||||
lighthouses := []netip.Addr{}
|
lighthouses := []netip.Addr{}
|
||||||
staticList := map[netip.Addr]struct{}{}
|
staticList := map[netip.Addr]struct{}{}
|
||||||
|
|||||||
+120
-1
@@ -2,6 +2,8 @@ package nebula
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"net/netip"
|
"net/netip"
|
||||||
|
"strconv"
|
||||||
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -11,6 +13,7 @@ import (
|
|||||||
ct "github.com/slackhq/nebula/cert_test"
|
ct "github.com/slackhq/nebula/cert_test"
|
||||||
"github.com/slackhq/nebula/handshake"
|
"github.com/slackhq/nebula/handshake"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
|
"github.com/slackhq/nebula/overlay"
|
||||||
"github.com/slackhq/nebula/test"
|
"github.com/slackhq/nebula/test"
|
||||||
"github.com/slackhq/nebula/udp"
|
"github.com/slackhq/nebula/udp"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
@@ -97,7 +100,7 @@ func TestConnectionState_NextMessageCounter(t *testing.T) {
|
|||||||
assert.Equal(t, RejectAfterMessages, cs.messageCounter.Load())
|
assert.Equal(t, RejectAfterMessages, cs.messageCounter.Load())
|
||||||
|
|
||||||
// Continued send attempts stay refused and the counter never wraps
|
// Continued send attempts stay refused and the counter never wraps
|
||||||
for i := 0; i < 10; i++ {
|
for range 10 {
|
||||||
_, ok = cs.NextMessageCounter()
|
_, ok = cs.NextMessageCounter()
|
||||||
assert.False(t, ok)
|
assert.False(t, ok)
|
||||||
}
|
}
|
||||||
@@ -147,6 +150,122 @@ func TestSendNoMetricsCloseTunnelKeepsRebindEpoch(t *testing.T) {
|
|||||||
assert.True(t, hostinfo.markOut(1), "a CloseTunnel send must not consume the rebind epoch")
|
assert.True(t, hostinfo.markOut(1), "a CloseTunnel send must not consume the rebind epoch")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// capturingConn is a udp.Conn that records every WriteTo.
|
||||||
|
type capturingConn struct {
|
||||||
|
udp.NoopConn
|
||||||
|
writes [][]byte
|
||||||
|
addrs []netip.AddrPort
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *capturingConn) WriteTo(b []byte, addr netip.AddrPort) error {
|
||||||
|
c.writes = append(c.writes, append([]byte(nil), b...))
|
||||||
|
c.addrs = append(c.addrs, addr)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSendNoMetricsViaRelay sends through a relay from the mtu sized buffer the cached packet flush uses. Payloads up
|
||||||
|
// to overlay.MaxMTU go out intact, anything bigger is dropped rather than outgrowing the buffer, which once panicked.
|
||||||
|
func TestSendNoMetricsViaRelay(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
n int
|
||||||
|
sent bool
|
||||||
|
}{
|
||||||
|
{0, true},
|
||||||
|
{1300, true},
|
||||||
|
{overlay.MaxMTU, true},
|
||||||
|
{overlay.MaxMTU + 1, false}, // too big for the relay's tag
|
||||||
|
{mtu - 47, false}, // too big for the inner tag, this panicked
|
||||||
|
{9000, false}, // a full packet at tun.mtu 9000
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(strconv.Itoa(tt.n), func(t *testing.T) {
|
||||||
|
// One tunnel to the target, carried end to end, and one to the relay that wraps it
|
||||||
|
targetInit, targetResp := runTestHandshake(t)
|
||||||
|
relayInit, relayResp := runTestHandshake(t)
|
||||||
|
ci, err := newConnectionStateFromResult(targetInit)
|
||||||
|
require.NoError(t, err)
|
||||||
|
relayCI, err := newConnectionStateFromResult(relayInit)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
targetAddr := netip.MustParseAddr("10.0.0.2")
|
||||||
|
relayAddr := netip.MustParseAddr("10.0.0.3")
|
||||||
|
relayRemote := netip.MustParseAddrPort("192.0.2.1:4242")
|
||||||
|
|
||||||
|
relay := &Relay{Type: TerminalType, State: Established, LocalIndex: 5, RemoteIndex: 6, PeerAddr: targetAddr}
|
||||||
|
relayHI := &HostInfo{
|
||||||
|
vpnAddrs: []netip.Addr{relayAddr},
|
||||||
|
ConnectionState: relayCI,
|
||||||
|
relayState: RelayState{
|
||||||
|
relayForByAddr: map[netip.Addr]*Relay{targetAddr: relay},
|
||||||
|
relayForByIdx: map[uint32]*Relay{relay.LocalIndex: relay},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
relayHI.remote.Store(&relayRemote)
|
||||||
|
|
||||||
|
// No remote of its own, so the send has to go via the relay
|
||||||
|
hostinfo := &HostInfo{
|
||||||
|
vpnAddrs: []netip.Addr{targetAddr},
|
||||||
|
ConnectionState: ci,
|
||||||
|
remoteIndexId: 7,
|
||||||
|
relayState: RelayState{
|
||||||
|
relays: []netip.Addr{relayAddr},
|
||||||
|
relayForByAddr: map[netip.Addr]*Relay{},
|
||||||
|
relayForByIdx: map[uint32]*Relay{},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
l := test.NewLogger()
|
||||||
|
hm := newHostMap(l)
|
||||||
|
hm.Hosts[relayAddr] = relayHI
|
||||||
|
conn := &capturingConn{}
|
||||||
|
f := &Interface{
|
||||||
|
l: l,
|
||||||
|
hostMap: hm,
|
||||||
|
messageMetrics: &MessageMetrics{txExhausted: metrics.NewCounter()},
|
||||||
|
writers: []udp.Conn{conn},
|
||||||
|
}
|
||||||
|
f.connectionManager = &connectionManager{intf: f, relayUsed: map[uint32]struct{}{}, relayUsedLock: &sync.RWMutex{}}
|
||||||
|
|
||||||
|
payload := make([]byte, tt.n)
|
||||||
|
for i := range payload {
|
||||||
|
payload[i] = byte(i)
|
||||||
|
}
|
||||||
|
counter := ci.messageCounter.Load()
|
||||||
|
f.sendNoMetrics(header.Message, 0, ci, hostinfo, netip.AddrPort{}, payload, make([]byte, 12), make([]byte, mtu), 0)
|
||||||
|
|
||||||
|
if !tt.sent {
|
||||||
|
assert.Empty(t, conn.writes)
|
||||||
|
assert.Equal(t, counter, ci.messageCounter.Load(), "a dropped packet must not spend a counter")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
require.Len(t, conn.writes, 1)
|
||||||
|
assert.Equal(t, relayRemote, conn.addrs[0])
|
||||||
|
pkt := conn.writes[0]
|
||||||
|
|
||||||
|
// The relay authenticates the whole packet under its own header
|
||||||
|
outer := &header.H{}
|
||||||
|
require.NoError(t, outer.Parse(pkt))
|
||||||
|
assert.Equal(t, header.MessageRelay, outer.Subtype)
|
||||||
|
assert.Equal(t, relay.RemoteIndex, outer.RemoteIndex)
|
||||||
|
relayPeer, err := newConnectionStateFromResult(relayResp)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, relayPeer.VerifyRelay(l, outer.MessageCounter, pkt, make([]byte, 12)))
|
||||||
|
|
||||||
|
// Inside it, the target decrypts the end to end packet back to the payload
|
||||||
|
inner := pkt[header.Len : len(pkt)-relayPeer.dKey.Overhead()]
|
||||||
|
h := &header.H{}
|
||||||
|
require.NoError(t, h.Parse(inner))
|
||||||
|
assert.Equal(t, header.Message, h.Type)
|
||||||
|
assert.Equal(t, hostinfo.remoteIndexId, h.RemoteIndex)
|
||||||
|
targetPeer, err := newConnectionStateFromResult(targetResp)
|
||||||
|
require.NoError(t, err)
|
||||||
|
got, err := targetPeer.Decrypt(l, h.MessageCounter, inner, make([]byte, 12))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, payload, got)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestNewConnectionStateFromResult(t *testing.T) {
|
func TestNewConnectionStateFromResult(t *testing.T) {
|
||||||
initR, respR := runTestHandshake(t)
|
initR, respR := runTestHandshake(t)
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import (
|
|||||||
"syscall"
|
"syscall"
|
||||||
|
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
"github.com/slackhq/nebula/overlay"
|
"github.com/slackhq/nebula/overlay"
|
||||||
)
|
)
|
||||||
@@ -47,6 +48,7 @@ type Control struct {
|
|||||||
|
|
||||||
f *Interface
|
f *Interface
|
||||||
l *slog.Logger
|
l *slog.Logger
|
||||||
|
commands *commands.Registry
|
||||||
ctx context.Context
|
ctx context.Context
|
||||||
cancel context.CancelFunc
|
cancel context.CancelFunc
|
||||||
sshStart func()
|
sshStart func()
|
||||||
@@ -372,6 +374,13 @@ func (c *Control) CloseAllTunnels(excludeLighthouses bool) (closed int) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Commands returns the registry the daemon's surfaces serve from. It is the live
|
||||||
|
// registry, not a copy: a command registered on it is served to every ssh session that
|
||||||
|
// starts afterwards. Clone it to run commands without that reach.
|
||||||
|
func (c *Control) Commands() *commands.Registry {
|
||||||
|
return c.commands
|
||||||
|
}
|
||||||
|
|
||||||
func (c *Control) Device() overlay.Device {
|
func (c *Control) Device() overlay.Device {
|
||||||
return c.f.inside
|
return c.f.inside
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ func (c *fakeConn) WriteTo(_ []byte, _ netip.AddrPort) error { return nil }
|
|||||||
func (c *fakeConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
func (c *fakeConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
|
||||||
return len(bufs), nil
|
return len(bufs), nil
|
||||||
}
|
}
|
||||||
func (c *fakeConn) ReloadConfig(_ *config.C) {}
|
func (c *fakeConn) ReloadConfig(_ *config.C, _ *config.Reload) {}
|
||||||
func (c *fakeConn) SupportsMultipleReaders() bool { return true }
|
func (c *fakeConn) SupportsMultipleReaders() bool { return true }
|
||||||
func (c *fakeConn) Close() error { c.closed = true; return nil }
|
func (c *fakeConn) Close() error { c.closed = true; return nil }
|
||||||
|
|
||||||
@@ -247,7 +247,7 @@ func TestControl_ConcurrentStopAndStart(t *testing.T) {
|
|||||||
c, _, _ := newReadyControl(t)
|
c, _, _ := newReadyControl(t)
|
||||||
|
|
||||||
var wg sync.WaitGroup
|
var wg sync.WaitGroup
|
||||||
for i := 0; i < 2; i++ {
|
for range 2 {
|
||||||
wg.Go(func() { c.Stop() })
|
wg.Go(func() { c.Stop() })
|
||||||
}
|
}
|
||||||
wg.Go(func() { _ = c.Start() })
|
wg.Go(func() { _ = c.Start() })
|
||||||
|
|||||||
+13
-22
@@ -12,6 +12,7 @@ import (
|
|||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
|
|
||||||
"github.com/miekg/dns"
|
"github.com/miekg/dns"
|
||||||
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -69,9 +70,10 @@ func newDnsServerFromConfig(ctx context.Context, l *slog.Logger, pki *PKI, hostM
|
|||||||
ds.mux = dns.NewServeMux()
|
ds.mux = dns.NewServeMux()
|
||||||
ds.mux.HandleFunc(".", ds.handleDnsRequest)
|
ds.mux.HandleFunc(".", ds.handleDnsRequest)
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C) {
|
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||||
if err := ds.reload(c, false); err != nil {
|
if err := ds.reload(c, false); err != nil {
|
||||||
ds.l.Error("Failed to reload DNS responder from config", "error", err)
|
ds.l.Error("Failed to reload DNS responder from config", "error", err)
|
||||||
|
r.Failed()
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -258,31 +260,20 @@ func (d *dnsServer) QueryCert(data string) string {
|
|||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
// The hostmap only ever contains peers we have handshaked with, so it never carries an entry for ourselves.
|
// Our own address answers with the certificate handshakes are initiated with, as the
|
||||||
// Answer self lookups straight from the local cert state.
|
// TXT record always has; which of our certificates identity reports is its own choice.
|
||||||
if cs := d.certState(); cs != nil && cs.myVpnAddrsTable != nil && cs.myVpnAddrsTable.Contains(ip) {
|
cs := d.certState()
|
||||||
c := cs.GetDefaultCertificate()
|
var crt cert.Certificate
|
||||||
if c == nil {
|
if ownsVpnAddr(cs, ip) {
|
||||||
return ""
|
crt = cs.getCertificate(cs.initiatingVersion)
|
||||||
|
} else {
|
||||||
|
crt, _ = peerCertificateForVpnAddr(d.hostMap, ip)
|
||||||
}
|
}
|
||||||
b, err := c.MarshalJSON()
|
if crt == nil {
|
||||||
if err != nil {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
return string(b)
|
|
||||||
}
|
|
||||||
|
|
||||||
hostinfo := d.hostMap.QueryVpnAddr(ip)
|
|
||||||
if hostinfo == nil {
|
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
q := hostinfo.GetCert()
|
b, err := crt.MarshalJSON()
|
||||||
if q == nil {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
b, err := q.Certificate.MarshalJSON()
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package nebula
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net"
|
"net"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
@@ -402,6 +403,32 @@ func TestDnsServer_QueryCert_returnsOwnCert(t *testing.T) {
|
|||||||
assert.Empty(t, ds.QueryCert(other.String()+"."), "unknown peer IP should return nothing")
|
assert.Empty(t, ds.QueryCert(other.String()+"."), "unknown peer IP should return nothing")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestDnsServer_QueryCert_answersWithTheInitiatingCertificate: with both versions loaded
|
||||||
|
// the TXT record carries the certificate handshakes start with, as it always has, where
|
||||||
|
// identity and print-cert report the v2.
|
||||||
|
func TestDnsServer_QueryCert_answersWithTheInitiatingCertificate(t *testing.T) {
|
||||||
|
ds, _ := newTestDnsServer(t)
|
||||||
|
me := netip.MustParseAddr("10.0.0.1")
|
||||||
|
network := netip.PrefixFrom(me, 24)
|
||||||
|
ca1, _, caKey1, _ := cert_test.NewTestCaCert(cert.Version1, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||||
|
v1, _, _, _ := cert_test.NewTestCert(cert.Version1, cert.Curve_CURVE25519, ca1, caKey1, "lighthouse", time.Time{}, time.Time{}, []netip.Prefix{network}, nil, nil)
|
||||||
|
ca2, _, caKey2, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||||
|
v2, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca2, caKey2, "lighthouse", time.Time{}, time.Time{}, []netip.Prefix{network}, nil, nil)
|
||||||
|
|
||||||
|
addrsTable := new(bart.Lite)
|
||||||
|
addrsTable.Insert(netip.PrefixFrom(me, me.BitLen()))
|
||||||
|
cs := &CertState{v1Cert: v1, v2Cert: v2, initiatingVersion: cert.Version1, myVpnAddrs: []netip.Addr{me}, myVpnAddrsTable: addrsTable}
|
||||||
|
ds.pki = &PKI{}
|
||||||
|
ds.pki.cs.Store(cs)
|
||||||
|
|
||||||
|
var got struct {
|
||||||
|
Version cert.Version `json:"version"`
|
||||||
|
}
|
||||||
|
require.NoError(t, json.Unmarshal([]byte(ds.QueryCert(me.String()+".")), &got))
|
||||||
|
assert.Equal(t, cert.Version1, got.Version)
|
||||||
|
assert.Equal(t, v2, ownCertificate(cs), "identity reports the v2 from the same state")
|
||||||
|
}
|
||||||
|
|
||||||
func TestDnsServer_reload_disable_stopsRunningServer(t *testing.T) {
|
func TestDnsServer_reload_disable_stopsRunningServer(t *testing.T) {
|
||||||
port := freeUDPPort(t)
|
port := freeUDPPort(t)
|
||||||
ds, c := newTestDnsServer(t)
|
ds, c := newTestDnsServer(t)
|
||||||
|
|||||||
@@ -0,0 +1,181 @@
|
|||||||
|
//go:build e2e_testing
|
||||||
|
|
||||||
|
package e2e
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/cert"
|
||||||
|
"github.com/slackhq/nebula/cert_test"
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
"github.com/slackhq/nebula/sshd"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// volatile lists everything in command output that legitimately differs between runs.
|
||||||
|
// Each run mints fresh certificates and indexes, so these are replaced with a marker
|
||||||
|
// before comparison. Keep the list short: anything added here is something the golden
|
||||||
|
// stops guarding.
|
||||||
|
var volatile = []struct {
|
||||||
|
re *regexp.Regexp
|
||||||
|
with string
|
||||||
|
}{
|
||||||
|
{regexp.MustCompile(`[0-9a-f]{40,}`), "<hex>"}, // fingerprints, keys, signatures
|
||||||
|
{regexp.MustCompile(`\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})`), "<time>"}, // RFC 3339
|
||||||
|
{regexp.MustCompile(`\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}(?:\.\d+)? [+-]\d{4} \w+`), "<time>"}, // time.Time.String()
|
||||||
|
{regexp.MustCompile(`(?s)(-----BEGIN [A-Z ]+-----\n).*?(\n-----END [A-Z ]+-----)`), "${1}<pem>${2}"}, // print-cert -raw
|
||||||
|
{regexp.MustCompile(`(-----BEGIN [A-Z ]+-----\\n).*?(\\n-----END [A-Z ]+-----)`), "${1}<pem>${2}"}, // the same, inside a JSON string
|
||||||
|
{regexp.MustCompile(`"(localIndex|remoteIndex|messageCounter)":\d+`), `"$1":<n>`},
|
||||||
|
{regexp.MustCompile(`(?m)^(\s*"?(?:LocalIndex|RemoteIndex|localIndex|remoteIndex|messageCounter)"?:?\s*)\d+`), "${1}<n>"}, // and the -pretty form
|
||||||
|
}
|
||||||
|
|
||||||
|
func normalise(s string) string {
|
||||||
|
for _, v := range volatile {
|
||||||
|
s = v.re.ReplaceAllString(s, v.with)
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// outputCase is one command line to run through the ssh dispatch path.
|
||||||
|
type outputCase struct {
|
||||||
|
name string
|
||||||
|
args []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestCommandOutput pins the bytes every command produces, in every format, through the
|
||||||
|
// ssh dispatch path. It is the safety net for moving rendering out of the commands: a
|
||||||
|
// change here is a change someone at an ssh prompt would see. Regenerate with:
|
||||||
|
//
|
||||||
|
// go test -tags e2e_testing ./e2e -run TestCommandOutput -update
|
||||||
|
func TestCommandOutput(t *testing.T) {
|
||||||
|
ca, _, caKey, _ := cert_test.NewTestCaCert(
|
||||||
|
cert.Version1, cert.Curve_CURVE25519,
|
||||||
|
time.Now(), time.Now().Add(10*time.Minute),
|
||||||
|
nil, nil, []string{},
|
||||||
|
)
|
||||||
|
|
||||||
|
control, _, _, _ := newSimpleServer(cert.Version1, ca, caKey, "output-golden", "10.222.0.1/24", nil)
|
||||||
|
control.Start()
|
||||||
|
t.Cleanup(func() { control.Stop() })
|
||||||
|
|
||||||
|
// As an ssh session does: a clone of the daemon's registry with logout added, which
|
||||||
|
// help on the clone lists and describes. There is no session to end here.
|
||||||
|
reg := control.Commands().Clone()
|
||||||
|
reg.Register(sshd.LogoutCommand(func() {}))
|
||||||
|
// Dispatch with ssh's default-format policy, so the no-flag column records what an
|
||||||
|
// operator at an ssh prompt sees.
|
||||||
|
reg.DefaultFormat = sshd.DefaultFormat
|
||||||
|
|
||||||
|
// run dispatches as the ssh exec path does and returns the output and the error, which
|
||||||
|
// over ssh is exit status 1.
|
||||||
|
run := func(args ...string) (string, error) {
|
||||||
|
buf := &bytes.Buffer{}
|
||||||
|
err := reg.DispatchArgs(args, commands.MergedOutput(buf))
|
||||||
|
return buf.String(), err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Seed a pending tunnel so the listing and per-address commands have something to show.
|
||||||
|
seed, err := run("create-tunnel", "10.222.0.9")
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, "Created\n", seed, "seeding a tunnel should succeed before anything else is recorded")
|
||||||
|
|
||||||
|
cases := []outputCase{
|
||||||
|
{"version", nil},
|
||||||
|
{"device-info", nil},
|
||||||
|
{"list-hostmap", nil},
|
||||||
|
{"list-hostmap", []string{"-by-index"}},
|
||||||
|
{"list-pending-hostmap", nil},
|
||||||
|
{"list-pending-hostmap", []string{"-by-index"}},
|
||||||
|
{"list-lighthouse-addrmap", nil},
|
||||||
|
{"print-cert", nil},
|
||||||
|
{"print-cert", []string{"-raw"}},
|
||||||
|
{"print-cert", []string{"10.222.0.9"}},
|
||||||
|
// A flag after the operand is still a flag, on both surfaces.
|
||||||
|
{"print-cert", []string{"10.222.0.9", "-json"}},
|
||||||
|
{"print-cert", []string{"10.222.0.250"}},
|
||||||
|
{"print-cert", []string{"not-an-address"}},
|
||||||
|
{"whoami", nil},
|
||||||
|
{"whoami", []string{"x"}},
|
||||||
|
// No address is a refusal that names whoami, never this node's identity.
|
||||||
|
{"identity", nil},
|
||||||
|
// Our own address, which the hostmap never holds, answers from our certificate.
|
||||||
|
{"identity", []string{"-address", "10.222.0.1"}},
|
||||||
|
{"identity", []string{"-address", "10.222.0.1:4242"}},
|
||||||
|
// A pending tunnel has no certificate yet.
|
||||||
|
{"identity", []string{"-address", "10.222.0.9"}},
|
||||||
|
{"identity", []string{"-address", "not-an-address"}},
|
||||||
|
{"identity", []string{"-address", ""}},
|
||||||
|
{"identity", []string{"10.222.0.9"}},
|
||||||
|
{"print-tunnel", nil},
|
||||||
|
{"print-tunnel", []string{"10.222.0.9"}},
|
||||||
|
{"print-tunnel", []string{"10.222.0.250"}},
|
||||||
|
{"print-relays", nil},
|
||||||
|
{"query-lighthouse", nil},
|
||||||
|
{"query-lighthouse", []string{"10.222.0.9"}},
|
||||||
|
{"query-lighthouse", []string{"not-an-address"}},
|
||||||
|
// The test logger cannot change level or format, so these cases record the
|
||||||
|
// refusal each command prints on it, not a successful change.
|
||||||
|
{"log-level", nil},
|
||||||
|
{"log-level", []string{"debug"}},
|
||||||
|
{"log-level", []string{"bogus"}},
|
||||||
|
{"log-level", []string{"info"}},
|
||||||
|
{"log-format", nil},
|
||||||
|
{"log-format", []string{"json"}},
|
||||||
|
{"log-format", []string{"text"}},
|
||||||
|
{"change-remote", nil},
|
||||||
|
{"change-remote", []string{"10.222.0.9"}},
|
||||||
|
{"change-remote", []string{"-address", "10.94.0.10:4242", "10.222.0.9"}},
|
||||||
|
{"change-remote", []string{"-address", "10.94.0.10:4242", "10.222.0.250"}},
|
||||||
|
{"create-tunnel", nil},
|
||||||
|
{"create-tunnel", []string{"10.222.0.9"}},
|
||||||
|
// A fresh address, so this exercises the handshake start with a remote attached
|
||||||
|
// rather than the "already handshaking" path above.
|
||||||
|
{"create-tunnel", []string{"-address", "10.94.0.10:4242", "10.222.0.10"}},
|
||||||
|
{"create-tunnel", []string{"not-an-address"}},
|
||||||
|
{"close-tunnel", nil},
|
||||||
|
{"close-tunnel", []string{"10.222.0.250"}},
|
||||||
|
{"close-tunnel", []string{"not-an-address"}},
|
||||||
|
{"help", nil},
|
||||||
|
{"help", []string{"print-cert"}},
|
||||||
|
{"help", []string{"logout"}},
|
||||||
|
{"logout", []string{"-h"}},
|
||||||
|
{"not-a-command", []string{"10.222.0.9"}},
|
||||||
|
// reload is last so that whatever a reload does to the daemon cannot leak into an
|
||||||
|
// earlier case. In this harness it fails: the config was loaded from a string and
|
||||||
|
// has no path to re-read, which is what the recorded result says.
|
||||||
|
{"reload", nil},
|
||||||
|
}
|
||||||
|
|
||||||
|
got := &strings.Builder{}
|
||||||
|
for _, c := range cases {
|
||||||
|
for _, fmtFlags := range [][]string{nil, {"-json"}, {"-pretty"}} {
|
||||||
|
args := append([]string{c.name}, fmtFlags...)
|
||||||
|
args = append(args, c.args...)
|
||||||
|
|
||||||
|
fmt.Fprintf(got, "$ %s\n", strings.Join(args, " "))
|
||||||
|
out, err := run(args...)
|
||||||
|
out = normalise(out)
|
||||||
|
got.WriteString(out)
|
||||||
|
// Output that does not end in a newline is recorded as such, the way diff marks
|
||||||
|
// it, so the golden sees that byte too and the next prompt still starts a line.
|
||||||
|
if out != "" && !strings.HasSuffix(out, "\n") {
|
||||||
|
got.WriteString("\\ No newline at end of output\n")
|
||||||
|
}
|
||||||
|
// A failed command is recorded as the exit status an ssh caller sees, so the
|
||||||
|
// golden pins which outcomes count as failures.
|
||||||
|
if err != nil {
|
||||||
|
got.WriteString("exit status 1\n")
|
||||||
|
}
|
||||||
|
got.WriteString("\n")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
test.Golden(t, filepath.Join("testdata", "commands_output.golden"), got.String())
|
||||||
|
}
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package e2e
|
package e2e
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package e2e
|
package e2e
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package e2e
|
package e2e
|
||||||
|
|
||||||
@@ -1514,7 +1513,7 @@ func TestLighthouseUpdateOnReload(t *testing.T) {
|
|||||||
// Reload the config. The lighthouse.hosts change triggers TriggerUpdate,
|
// Reload the config. The lighthouse.hosts change triggers TriggerUpdate,
|
||||||
// which wakes the update worker. It calls SendUpdate, initiating a
|
// which wakes the update worker. It calls SendUpdate, initiating a
|
||||||
// handshake to the new lighthouse and caching the HostUpdateNotification.
|
// handshake to the new lighthouse and caching the HostUpdateNotification.
|
||||||
require.NoError(t, myConfig.ReloadConfigString(string(newCfg)))
|
require.NoError(t, myConfig.ReloadConfigString(string(newCfg)).Err)
|
||||||
|
|
||||||
// Route until the lighthouse receives the HostUpdateNotification.
|
// Route until the lighthouse receives the HostUpdateNotification.
|
||||||
// This covers: handshake stage 1, stage 2, then the cached update.
|
// This covers: handshake stage 1, stage 2, then the cached update.
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package e2e
|
package e2e
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,143 @@
|
|||||||
|
//go:build e2e_testing
|
||||||
|
|
||||||
|
package e2e
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/netip"
|
||||||
|
"path/filepath"
|
||||||
|
"runtime"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/cert"
|
||||||
|
"github.com/slackhq/nebula/cert_test"
|
||||||
|
"github.com/slackhq/nebula/e2e/router"
|
||||||
|
"github.com/slackhq/nebula/localapi"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestIdentityOverTheInfoAPI is the info API's reason to exist, end to end: a program on
|
||||||
|
// this host has a connection arriving over the overlay and asks who is behind its
|
||||||
|
// source address, and the answer is the identity in the certificate the tunnel was
|
||||||
|
// established with.
|
||||||
|
func TestIdentityOverTheInfoAPI(t *testing.T) {
|
||||||
|
if runtime.GOOS == "windows" {
|
||||||
|
t.Skip("the test's HTTP helpers dial unix sockets; on windows the info API is a named pipe")
|
||||||
|
}
|
||||||
|
|
||||||
|
ca, _, caKey, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Now(), time.Now().Add(10*time.Minute), nil, nil, []string{})
|
||||||
|
myControl, myVpnIpNet, _, _ := newSimpleServer(cert.Version2, ca, caKey, "me", "10.128.0.1/24", nil)
|
||||||
|
theirControl, theirVpnIpNet, theirUdpAddr, _ := newSimpleServer(cert.Version2, ca, caKey, "them", "10.128.0.2/24", nil)
|
||||||
|
|
||||||
|
myControl.InjectLightHouseAddr(theirVpnIpNet[0].Addr(), theirUdpAddr)
|
||||||
|
|
||||||
|
r := router.NewR(t, myControl, theirControl)
|
||||||
|
defer r.RenderFlow()
|
||||||
|
|
||||||
|
myControl.Start()
|
||||||
|
theirControl.Start()
|
||||||
|
t.Cleanup(func() {
|
||||||
|
myControl.Stop()
|
||||||
|
theirControl.Stop()
|
||||||
|
})
|
||||||
|
|
||||||
|
// Before the tunnel is up their address is unknown to us.
|
||||||
|
path := infoSocket(t)
|
||||||
|
info := localapi.NewInfoServer(NewTestLogger(), myControl.Commands())
|
||||||
|
require.NoError(t, info.Rebind(context.Background(), path, localapi.Access{Mode: 0600}))
|
||||||
|
t.Cleanup(info.Stop)
|
||||||
|
|
||||||
|
status, body := test.HTTPGet(t, path, "/v1/identity?address="+theirVpnIpNet[0].Addr().String())
|
||||||
|
assert.Equal(t, http.StatusNotFound, status)
|
||||||
|
assert.JSONEq(t, `{"error":"No active tunnel for vpn addr: 10.128.0.2"}`, body)
|
||||||
|
|
||||||
|
// Only we know how to reach them, so the first packet has to be ours; once the tunnel
|
||||||
|
// is up both directions work and assertTunnel can check it.
|
||||||
|
myControl.InjectTunPacket(BuildTunUDPPacket(theirVpnIpNet[0].Addr(), 80, myVpnIpNet[0].Addr(), 80, []byte("Hi from me")))
|
||||||
|
p := r.RouteForAllUntilTxTun(theirControl)
|
||||||
|
assertUdpPacket(t, []byte("Hi from me"), p, myVpnIpNet[0].Addr(), theirVpnIpNet[0].Addr(), 80, 80)
|
||||||
|
assertTunnel(t, myVpnIpNet[0].Addr(), theirVpnIpNet[0].Addr(), myControl, theirControl, r)
|
||||||
|
|
||||||
|
type identity struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
VpnAddrs []netip.Addr `json:"vpnAddrs"`
|
||||||
|
Networks []netip.Prefix `json:"networks"`
|
||||||
|
Groups []string `json:"groups"`
|
||||||
|
Issuer string `json:"issuer"`
|
||||||
|
Fingerprint string `json:"fingerprint"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// A connection's RemoteAddr, port and all, resolves to the peer.
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/identity?address="+netip.AddrPortFrom(theirVpnIpNet[0].Addr(), 51234).String())
|
||||||
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
|
var them identity
|
||||||
|
require.NoError(t, json.Unmarshal([]byte(body), &them))
|
||||||
|
assert.Equal(t, "them", them.Name)
|
||||||
|
assert.Equal(t, []netip.Addr{theirVpnIpNet[0].Addr()}, them.VpnAddrs)
|
||||||
|
assert.Equal(t, theirVpnIpNet, them.Networks)
|
||||||
|
assert.Equal(t, []string{}, them.Groups)
|
||||||
|
caFP, err := ca.Fingerprint()
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, caFP, them.Issuer)
|
||||||
|
|
||||||
|
// No address is a caller that forgot the parameter, and is refused rather than handed
|
||||||
|
// this node's identity to authorize against; whoami is the command for that.
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/identity")
|
||||||
|
assert.Equal(t, http.StatusBadRequest, status, body)
|
||||||
|
assert.Contains(t, body, "whoami")
|
||||||
|
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/whoami")
|
||||||
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
|
var me identity
|
||||||
|
require.NoError(t, json.Unmarshal([]byte(body), &me))
|
||||||
|
assert.Equal(t, "me", me.Name)
|
||||||
|
assert.Equal(t, []netip.Addr{myVpnIpNet[0].Addr()}, me.VpnAddrs)
|
||||||
|
|
||||||
|
// An empty address is a caller's bug, and is told so rather than handed our identity.
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/identity?address=")
|
||||||
|
assert.Equal(t, http.StatusBadRequest, status)
|
||||||
|
assert.JSONEq(t, `{"error":"The provided vpn addr could not be parsed: "}`, body)
|
||||||
|
|
||||||
|
// The certificate itself, for a program that verifies it against its own CAs: the one
|
||||||
|
// nebula verified when the tunnel came up, as PEM, by the address a connection carries.
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/print-cert?address="+netip.AddrPortFrom(theirVpnIpNet[0].Addr(), 51234).String()+"&raw=true")
|
||||||
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
|
var raw struct {
|
||||||
|
PEM string `json:"pem"`
|
||||||
|
}
|
||||||
|
require.NoError(t, json.Unmarshal([]byte(body), &raw))
|
||||||
|
theirs, _, err := cert.UnmarshalCertificateFromPEM([]byte(raw.PEM))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "them", theirs.Name())
|
||||||
|
fp, err := theirs.Fingerprint()
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, them.Fingerprint, fp, "the same certificate identity reports")
|
||||||
|
|
||||||
|
// Without raw it is the certificate's fields; without an address, our own.
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/print-cert")
|
||||||
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
|
assert.Contains(t, body, `"name":"me"`)
|
||||||
|
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/print-cert?address=10.128.0.9")
|
||||||
|
assert.Equal(t, http.StatusNotFound, status)
|
||||||
|
assert.JSONEq(t, `{"error":"Could not find tunnel for vpn addr: 10.128.0.9"}`, body)
|
||||||
|
|
||||||
|
// Nothing else nebula serves is reachable here.
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/list-hostmap")
|
||||||
|
assert.Equal(t, http.StatusForbidden, status)
|
||||||
|
assert.Contains(t, body, "identity lookups only")
|
||||||
|
|
||||||
|
r.RenderHostmaps("Final hostmaps", myControl, theirControl)
|
||||||
|
}
|
||||||
|
|
||||||
|
// infoSocket returns a short socket path in a private directory, one level below it
|
||||||
|
// so that listen has a directory of its own to create.
|
||||||
|
func infoSocket(t *testing.T) string {
|
||||||
|
t.Helper()
|
||||||
|
return filepath.Join(test.ShortTempDir(t), "n", "info.sock")
|
||||||
|
}
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package e2e
|
package e2e
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package e2e
|
package e2e
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package e2e
|
package e2e
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package router
|
package router
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package router
|
package router
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package e2e
|
package e2e
|
||||||
|
|
||||||
|
|||||||
Vendored
+1362
File diff suppressed because it is too large.
Load diff
+2
-3
@@ -1,5 +1,4 @@
|
|||||||
//go:build e2e_testing
|
//go:build e2e_testing
|
||||||
// +build e2e_testing
|
|
||||||
|
|
||||||
package e2e
|
package e2e
|
||||||
|
|
||||||
@@ -130,7 +129,7 @@ func TestCertUpgrade(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
r.Logf("reload new v2-only config")
|
r.Logf("reload new v2-only config")
|
||||||
err = myC.ReloadConfigString(string(cb))
|
err = myC.ReloadConfigString(string(cb)).Err
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
r.Log("yay, spin until their sees it")
|
r.Log("yay, spin until their sees it")
|
||||||
waitStart := time.Now()
|
waitStart := time.Now()
|
||||||
@@ -223,7 +222,7 @@ func TestCertDowngrade(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
r.Logf("reload new v1-only config")
|
r.Logf("reload new v1-only config")
|
||||||
err = myC.ReloadConfigString(string(cb))
|
err = myC.ReloadConfigString(string(cb)).Err
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
r.Log("yay, spin until their sees it")
|
r.Log("yay, spin until their sees it")
|
||||||
waitStart := time.Now()
|
waitStart := time.Now()
|
||||||
|
|||||||
+80
-19
@@ -8,6 +8,7 @@ pki:
|
|||||||
cert: /etc/nebula/host.crt
|
cert: /etc/nebula/host.crt
|
||||||
key: /etc/nebula/host.key
|
key: /etc/nebula/host.key
|
||||||
# blocklist is a list of certificate fingerprints that we will refuse to talk to
|
# blocklist is a list of certificate fingerprints that we will refuse to talk to
|
||||||
|
# Entries are the hex fingerprints shown by `nebula-cert print`, an invalid entry fails startup and reload.
|
||||||
#blocklist:
|
#blocklist:
|
||||||
# - c99d4e650533b92061b09918e838a5a0a6aaee21eed1d12fd937682865936c72
|
# - c99d4e650533b92061b09918e838a5a0a6aaee21eed1d12fd937682865936c72
|
||||||
# disconnect_invalid is a toggle to force a client to be disconnected if the certificate is expired or invalid.
|
# disconnect_invalid is a toggle to force a client to be disconnected if the certificate is expired or invalid.
|
||||||
@@ -43,7 +44,7 @@ static_host_map:
|
|||||||
|
|
||||||
lighthouse:
|
lighthouse:
|
||||||
# am_lighthouse is used to enable lighthouse functionality for a node. This should ONLY be true on nodes
|
# am_lighthouse is used to enable lighthouse functionality for a node. This should ONLY be true on nodes
|
||||||
# you have configured to be lighthouses in your network
|
# you have configured to be lighthouses in your network. Not reloadable.
|
||||||
am_lighthouse: false
|
am_lighthouse: false
|
||||||
# serve_dns optionally starts a dns listener that responds to various queries and can even be
|
# serve_dns optionally starts a dns listener that responds to various queries and can even be
|
||||||
# delegated to for resolution
|
# delegated to for resolution
|
||||||
@@ -126,8 +127,9 @@ lighthouse:
|
|||||||
# Port Nebula will be listening on. The default here is 4242. For a lighthouse node, the port should be defined,
|
# Port Nebula will be listening on. The default here is 4242. For a lighthouse node, the port should be defined,
|
||||||
# however using port 0 will dynamically assign a port and is recommended for roaming nodes.
|
# however using port 0 will dynamically assign a port and is recommended for roaming nodes.
|
||||||
listen:
|
listen:
|
||||||
# To listen on only ipv4, use "0.0.0.0"
|
# To listen on only ipv4, use "0.0.0.0". Not reloadable.
|
||||||
host: "::"
|
host: "::"
|
||||||
|
# Not reloadable.
|
||||||
port: 4242
|
port: 4242
|
||||||
# Sets the max number of packets to pull from the kernel for each syscall (under systems that support recvmmsg)
|
# Sets the max number of packets to pull from the kernel for each syscall (under systems that support recvmmsg)
|
||||||
# default is 64, does not support reload
|
# default is 64, does not support reload
|
||||||
@@ -135,12 +137,13 @@ listen:
|
|||||||
# superpacket, so the receive scratch is batch * 64KiB per listening socket (~4MiB per routine at the
|
# superpacket, so the receive scratch is batch * 64KiB per listening socket (~4MiB per routine at the
|
||||||
# default of 64). Lower this to trade peak per-syscall throughput for memory on constrained hosts.
|
# default of 64). Lower this to trade peak per-syscall throughput for memory on constrained hosts.
|
||||||
#batch: 64
|
#batch: 64
|
||||||
|
# Linux only. Reloadable, but removing a value leaves the socket at the old size until Nebula restarts.
|
||||||
# Configure socket buffers for the udp side (outside), leave unset to use the system defaults. Values will be doubled by the kernel
|
# Configure socket buffers for the udp side (outside), leave unset to use the system defaults. Values will be doubled by the kernel
|
||||||
# Default is net.core.rmem_default and net.core.wmem_default (/proc/sys/net/core/rmem_default and /proc/sys/net/core/rmem_default)
|
# Default is net.core.rmem_default and net.core.wmem_default (/proc/sys/net/core/rmem_default and /proc/sys/net/core/rmem_default)
|
||||||
# Maximum is limited by memory in the system, SO_RCVBUFFORCE and SO_SNDBUFFORCE is used to avoid having to raise the system wide
|
# Maximum is limited by memory in the system, SO_RCVBUFFORCE and SO_SNDBUFFORCE is used to avoid having to raise the system wide
|
||||||
# max, net.core.rmem_max and net.core.wmem_max
|
# max, net.core.rmem_max and net.core.wmem_max
|
||||||
#read_buffer: 10485760
|
read_buffer: 3412512
|
||||||
#write_buffer: 10485760
|
write_buffer: 3412512
|
||||||
|
|
||||||
# On Windows only
|
# On Windows only
|
||||||
# When true, Nebula installs a WFP (Windows Filtering Platform) PERMIT filter scoped to UDP at the listener port.
|
# When true, Nebula installs a WFP (Windows Filtering Platform) PERMIT filter scoped to UDP at the listener port.
|
||||||
@@ -179,7 +182,7 @@ listen:
|
|||||||
# Currently, this defaults to 1 which means we have 1 tun queue reader and 1
|
# Currently, this defaults to 1 which means we have 1 tun queue reader and 1
|
||||||
# UDP queue reader. Setting this above one will set IFF_MULTI_QUEUE on the tun
|
# UDP queue reader. Setting this above one will set IFF_MULTI_QUEUE on the tun
|
||||||
# device and SO_REUSEPORT on the UDP socket to allow multiple queues.
|
# device and SO_REUSEPORT on the UDP socket to allow multiple queues.
|
||||||
# This option is only supported on Linux.
|
# This option is only supported on Linux. Not reloadable.
|
||||||
#routines: 1
|
#routines: 1
|
||||||
|
|
||||||
punchy:
|
punchy:
|
||||||
@@ -203,6 +206,7 @@ punchy:
|
|||||||
|
|
||||||
# Cipher allows you to choose between the available ciphers for your network. Options are chachapoly or aes
|
# Cipher allows you to choose between the available ciphers for your network. Options are chachapoly or aes
|
||||||
# IMPORTANT: this value must be identical on ALL NODES/LIGHTHOUSES. We do not/will not support use of different ciphers simultaneously!
|
# IMPORTANT: this value must be identical on ALL NODES/LIGHTHOUSES. We do not/will not support use of different ciphers simultaneously!
|
||||||
|
# Not reloadable.
|
||||||
#cipher: aes
|
#cipher: aes
|
||||||
|
|
||||||
# Preferred ranges is used to define a hint about the local network ranges, which speeds up discovering the fastest
|
# Preferred ranges is used to define a hint about the local network ranges, which speeds up discovering the fastest
|
||||||
@@ -229,12 +233,57 @@ punchy:
|
|||||||
# Trusted SSH CA public keys. These are the public keys of the CAs that are allowed to sign SSH keys for access.
|
# Trusted SSH CA public keys. These are the public keys of the CAs that are allowed to sign SSH keys for access.
|
||||||
#trusted_cas:
|
#trusted_cas:
|
||||||
#- "ssh public key string"
|
#- "ssh public key string"
|
||||||
# sandbox_dir restricts file paths for profiling commands (start-cpu-profile, save-heap-profile,
|
|
||||||
# save-mutex-profile) to the specified directory. Relative paths will be resolved within this directory,
|
# Local APIs allow accessing running nebula state.
|
||||||
# and absolute paths outside of it will be rejected. Default is $TMP/nebula-debug.
|
#local_api:
|
||||||
# The directory is NOT automatically created.
|
# There are two types of sockets available: a control socket intended for use on the
|
||||||
# Overriding this to "" is the same as "/" and will allow overwriting any path on the host.
|
# local machine, primarily for debugging, and an info socket intended to make
|
||||||
#sandbox_dir: /var/tmp/nebula-debug
|
# nebula's internal state available to other consumers.
|
||||||
|
#
|
||||||
|
# The control socket is made available by default, and can be accessed via
|
||||||
|
# `nebula ctl <command>`. It defaults to /var/run/nebula/ctl.sock on Linux, macOS and
|
||||||
|
# the BSDs; on Windows it is a named pipe under \\.\pipe\ProtectedPrefix\Administrators.
|
||||||
|
#control:
|
||||||
|
# Set to false to turn the control socket off. Reloadable.
|
||||||
|
#enabled: true
|
||||||
|
# The absolute path where the control socket should live, or a full pipe name on
|
||||||
|
# Windows. The last directory is created if missing, and must be owned by root or by
|
||||||
|
# the user running nebula. It must not be writable by anyone else.
|
||||||
|
#socket: /var/run/nebula/ctl.sock
|
||||||
|
# A group (or account/group/SID on Windows) that should be allowed to access the
|
||||||
|
# socket.
|
||||||
|
#group: nebula
|
||||||
|
|
||||||
|
# The info socket is not made available by default. If you enable it, it makes some
|
||||||
|
# internal state available over HTTP.
|
||||||
|
#
|
||||||
|
# The currently supported HTTP requests are:
|
||||||
|
# GET /v1/identity?address=<vpn addr>[:port] the host owning the address; the port
|
||||||
|
# is ignored. 404 when no tunnel is
|
||||||
|
# up, 400 when no address is given.
|
||||||
|
# GET /v1/whoami this node's identity
|
||||||
|
# GET /v1/print-cert?address=<vpn addr>[:port]&raw=true
|
||||||
|
# the certificate for the specified
|
||||||
|
# address, as {"pem": ...}.
|
||||||
|
# GET /v1 describes what is served
|
||||||
|
#
|
||||||
|
# NB: unless a connection arrived on the nebula interface, there's no guarantee
|
||||||
|
# that the identity returned belongs to the sender.
|
||||||
|
#
|
||||||
|
#info:
|
||||||
|
#enabled: false
|
||||||
|
# The absolute path to listen on, or a full pipe name on Windows. Name a pipe under
|
||||||
|
# \\.\pipe\ProtectedPrefix\Administrators\.
|
||||||
|
#socket: /var/run/nebula/info.sock
|
||||||
|
# A group (or account/group/SID on Windows) that should be allowed to access the
|
||||||
|
# socket. On Windows the group may read and write the pipe but not create an
|
||||||
|
# instance of it, so a client in the group must open the pipe asking for read and
|
||||||
|
# write data rather than generic read and write.
|
||||||
|
#group: nebula-info
|
||||||
|
# Octal mode for the socket, as a quoted string. Defaults to "0600" unless a
|
||||||
|
# group is set, in which case it defaults to "0660". On Windows a pipe has no
|
||||||
|
# mode and this is ignored; the group alone decides who may connect.
|
||||||
|
#socket_mode: "0660"
|
||||||
|
|
||||||
# EXPERIMENTAL: relay support for networks that can't establish direct connections.
|
# EXPERIMENTAL: relay support for networks that can't establish direct connections.
|
||||||
relay:
|
relay:
|
||||||
@@ -253,18 +302,25 @@ relay:
|
|||||||
# Configure the private interface. Note: addr is baked into the nebula certificate
|
# Configure the private interface. Note: addr is baked into the nebula certificate
|
||||||
tun:
|
tun:
|
||||||
# When tun is disabled, a lighthouse can be started without a local tun interface (and therefore without root)
|
# When tun is disabled, a lighthouse can be started without a local tun interface (and therefore without root)
|
||||||
|
# Not reloadable.
|
||||||
disabled: false
|
disabled: false
|
||||||
# Name of the device. If not set, a default will be chosen by the OS.
|
# Name of the device. If not set, a default will be chosen by the OS.
|
||||||
# For macOS: if set, must be in the form `utun[0-9]+`.
|
# For macOS: if set, must be in the form `utun[0-9]+`.
|
||||||
# For NetBSD: Required to be set, must be in the form `tun[0-9]+`
|
# For OpenBSD and NetBSD: if set, must be in the form `tun[0-9]+`, otherwise the first free one is used.
|
||||||
|
# Not reloadable.
|
||||||
dev: nebula1
|
dev: nebula1
|
||||||
# Toggles forwarding of local broadcast packets, the address of which depends on the ip/mask encoded in pki.cert
|
# Toggles forwarding of local broadcast packets, the address of which depends on the ip/mask encoded in pki.cert
|
||||||
|
# Not reloadable.
|
||||||
drop_local_broadcast: false
|
drop_local_broadcast: false
|
||||||
# Toggles forwarding of multicast packets
|
# Toggles forwarding of multicast packets. Not reloadable.
|
||||||
drop_multicast: false
|
drop_multicast: false
|
||||||
# Sets the transmit queue length, if you notice lots of transmit drops on the tun it may help to raise this number. Default is 500
|
# Sets the transmit queue length, if you notice lots of transmit drops on the tun it may help to raise this number. Default is 5000
|
||||||
tx_queue: 500
|
# Not reloadable.
|
||||||
|
tx_queue: 5000
|
||||||
# Default MTU for every packet, safe setting is (and the default) 1300 for internet based traffic
|
# Default MTU for every packet, safe setting is (and the default) 1300 for internet based traffic
|
||||||
|
# Anything above 8937, here or on a route below, is capped to 8937 with a warning
|
||||||
|
# Reloadable on Linux only. Where the tun is handed to nebula by a host app (iOS, Android, macOS network extensions)
|
||||||
|
# the host app owns the MTU.
|
||||||
mtu: 1300
|
mtu: 1300
|
||||||
|
|
||||||
# the use_offloads setting controls if Nebula will attempt to enable GSO and GRO for the tun device. Linux only, not reloadable.
|
# the use_offloads setting controls if Nebula will attempt to enable GSO and GRO for the tun device. Linux only, not reloadable.
|
||||||
@@ -326,6 +382,9 @@ tun:
|
|||||||
# `mtu`: will default to tun mtu if this option is not specified
|
# `mtu`: will default to tun mtu if this option is not specified
|
||||||
# `metric`: will default to 0 if this option is not specified
|
# `metric`: will default to 0 if this option is not specified
|
||||||
# `install`: will default to true, controls whether this route is installed in the systems routing table.
|
# `install`: will default to true, controls whether this route is installed in the systems routing table.
|
||||||
|
# On macOS, a route whose destination another interface already routes, like the local network, is installed once
|
||||||
|
# that route is removed. One deleted by hand stays deleted until nebula reloads or restarts, or until another
|
||||||
|
# interface routes its destination and lets it go.
|
||||||
# This setting is reloadable.
|
# This setting is reloadable.
|
||||||
unsafe_routes:
|
unsafe_routes:
|
||||||
#- route: 172.16.1.0/24
|
#- route: 172.16.1.0/24
|
||||||
@@ -357,7 +416,7 @@ tun:
|
|||||||
#use_system_route_table: false
|
#use_system_route_table: false
|
||||||
# Buffer size for reading routes updates. 0 means default system buffer size. (/proc/sys/net/core/rmem_default).
|
# Buffer size for reading routes updates. 0 means default system buffer size. (/proc/sys/net/core/rmem_default).
|
||||||
# If using massive routes updates, for example BGP, you may need to increase this value to avoid packet loss.
|
# If using massive routes updates, for example BGP, you may need to increase this value to avoid packet loss.
|
||||||
# SO_RCVBUFFORCE is used to avoid having to raise the system wide max
|
# SO_RCVBUFFORCE is used to avoid having to raise the system wide max. Not reloadable.
|
||||||
#use_system_route_table_buffer_size: 0
|
#use_system_route_table_buffer_size: 0
|
||||||
|
|
||||||
# Configure logging level
|
# Configure logging level
|
||||||
@@ -407,14 +466,16 @@ logging:
|
|||||||
# Handshakes are sent to all known addresses at each interval with a linear backoff,
|
# Handshakes are sent to all known addresses at each interval with a linear backoff,
|
||||||
# Wait try_interval after the 1st attempt, 2 * try_interval after the 2nd, etc, until the handshake is older than timeout
|
# Wait try_interval after the 1st attempt, 2 * try_interval after the 2nd, etc, until the handshake is older than timeout
|
||||||
# A 100ms interval with the default 10 retries will give a handshake 5.5 seconds to resolve before timing out
|
# A 100ms interval with the default 10 retries will give a handshake 5.5 seconds to resolve before timing out
|
||||||
|
# Not reloadable.
|
||||||
#try_interval: 100ms
|
#try_interval: 100ms
|
||||||
#retries: 20
|
#retries: 20
|
||||||
|
|
||||||
# query_buffer is the size of the buffer channel for querying lighthouses
|
# query_buffer is the size of the buffer channel for querying lighthouses, drops are recorded in the lighthouse.query.dropped metric.
|
||||||
#query_buffer: 64
|
# Not reloadable.
|
||||||
|
#query_buffer: 1024
|
||||||
|
|
||||||
# trigger_buffer is the size of the buffer channel for quickly sending handshakes
|
# trigger_buffer is the size of the buffer channel for quickly sending handshakes
|
||||||
# after receiving the response for lighthouse queries
|
# after receiving the response for lighthouse queries. Not reloadable.
|
||||||
#trigger_buffer: 64
|
#trigger_buffer: 64
|
||||||
|
|
||||||
# Tunnel manager settings
|
# Tunnel manager settings
|
||||||
|
|||||||
+38
-4
@@ -60,12 +60,18 @@ type Firewall struct {
|
|||||||
|
|
||||||
// assignedNetworks is a list of vpn networks assigned to us in the certificate.
|
// assignedNetworks is a list of vpn networks assigned to us in the certificate.
|
||||||
assignedNetworks []netip.Prefix
|
assignedNetworks []netip.Prefix
|
||||||
|
// vpnNetworks holds assignedNetworks for lookup: a source address inside one of them
|
||||||
|
// belongs to a node of the overlay, and only that node may send as it.
|
||||||
|
vpnNetworks *bart.Lite
|
||||||
// unsafeNetworks is the list of unsafe networks issued to us in the certificate
|
// unsafeNetworks is the list of unsafe networks issued to us in the certificate
|
||||||
unsafeNetworks []netip.Prefix
|
unsafeNetworks []netip.Prefix
|
||||||
|
|
||||||
rules string
|
rules string
|
||||||
rulesVersion uint16
|
rulesVersion uint16
|
||||||
|
|
||||||
|
// source is the rendered firewall config this firewall was built from, the cert networks are kept above
|
||||||
|
source string
|
||||||
|
|
||||||
defaultLocalCIDRAny bool
|
defaultLocalCIDRAny bool
|
||||||
incomingMetrics firewallMetrics
|
incomingMetrics firewallMetrics
|
||||||
outgoingMetrics firewallMetrics
|
outgoingMetrics firewallMetrics
|
||||||
@@ -153,10 +159,12 @@ func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Dur
|
|||||||
}
|
}
|
||||||
|
|
||||||
routableNetworks := new(bart.Lite)
|
routableNetworks := new(bart.Lite)
|
||||||
|
vpnNetworks := new(bart.Lite)
|
||||||
var assignedNetworks []netip.Prefix
|
var assignedNetworks []netip.Prefix
|
||||||
for _, network := range c.Networks() {
|
for _, network := range c.Networks() {
|
||||||
nprefix := netip.PrefixFrom(network.Addr(), network.Addr().BitLen())
|
nprefix := netip.PrefixFrom(network.Addr(), network.Addr().BitLen())
|
||||||
routableNetworks.Insert(nprefix)
|
routableNetworks.Insert(nprefix)
|
||||||
|
vpnNetworks.Insert(network)
|
||||||
assignedNetworks = append(assignedNetworks, network)
|
assignedNetworks = append(assignedNetworks, network)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -177,6 +185,7 @@ func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Dur
|
|||||||
DefaultTimeout: defaultTimeout,
|
DefaultTimeout: defaultTimeout,
|
||||||
routableNetworks: routableNetworks,
|
routableNetworks: routableNetworks,
|
||||||
assignedNetworks: assignedNetworks,
|
assignedNetworks: assignedNetworks,
|
||||||
|
vpnNetworks: vpnNetworks,
|
||||||
unsafeNetworks: unsafeNetworks,
|
unsafeNetworks: unsafeNetworks,
|
||||||
l: l,
|
l: l,
|
||||||
|
|
||||||
@@ -203,11 +212,25 @@ func NewFirewallFromConfig(l *slog.Logger, cs *CertState, c *config.C) (*Firewal
|
|||||||
panic("No certificate available to reconfigure the firewall")
|
panic("No certificate available to reconfigure the firewall")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
tcpTimeout := c.GetDuration("firewall.conntrack.tcp_timeout", time.Minute*12)
|
||||||
|
udpTimeout := c.GetDuration("firewall.conntrack.udp_timeout", time.Minute*3)
|
||||||
|
defaultTimeout := c.GetDuration("firewall.conntrack.default_timeout", time.Minute*10)
|
||||||
|
|
||||||
|
if tcpTimeout <= 0 {
|
||||||
|
return nil, fmt.Errorf("firewall.conntrack.tcp_timeout must be greater than 0, got: %s", tcpTimeout)
|
||||||
|
}
|
||||||
|
if udpTimeout <= 0 {
|
||||||
|
return nil, fmt.Errorf("firewall.conntrack.udp_timeout must be greater than 0, got: %s", udpTimeout)
|
||||||
|
}
|
||||||
|
if defaultTimeout <= 0 {
|
||||||
|
return nil, fmt.Errorf("firewall.conntrack.default_timeout must be greater than 0, got: %s", defaultTimeout)
|
||||||
|
}
|
||||||
|
|
||||||
fw := NewFirewall(
|
fw := NewFirewall(
|
||||||
l,
|
l,
|
||||||
c.GetDuration("firewall.conntrack.tcp_timeout", time.Minute*12),
|
tcpTimeout,
|
||||||
c.GetDuration("firewall.conntrack.udp_timeout", time.Minute*3),
|
udpTimeout,
|
||||||
c.GetDuration("firewall.conntrack.default_timeout", time.Minute*10),
|
defaultTimeout,
|
||||||
certificate,
|
certificate,
|
||||||
//TODO: max_connections
|
//TODO: max_connections
|
||||||
)
|
)
|
||||||
@@ -246,6 +269,7 @@ func NewFirewallFromConfig(l *slog.Logger, cs *CertState, c *config.C) (*Firewal
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fw.source = c.Render("firewall")
|
||||||
return fw, nil
|
return fw, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -444,7 +468,17 @@ func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *
|
|||||||
f.metrics(incoming).droppedRemoteAddr.Inc(1)
|
f.metrics(incoming).droppedRemoteAddr.Inc(1)
|
||||||
return ErrPeerRejected // reject for now, one day this may have different FW rules
|
return ErrPeerRejected // reject for now, one day this may have different FW rules
|
||||||
case NetworkTypeUnsafe:
|
case NetworkTypeUnsafe:
|
||||||
break // nothing special, one day this may have different FW rules
|
// An unsafe network says what a peer routes for, never who it is. One that
|
||||||
|
// overlaps our own networks would let the peer send as any node of the overlay,
|
||||||
|
// and whatever trusts the source address, the firewall's own rules and the
|
||||||
|
// identity a program looks up for it, would be told the wrong node. A source
|
||||||
|
// inside our networks is a node's own address, which only that node sends
|
||||||
|
// from, as NetworkTypeVPN, matched first; through an unsafe network it is
|
||||||
|
// refused. Outbound the address is a destination and claims nothing.
|
||||||
|
if incoming && f.vpnNetworks.Contains(fp.RemoteAddr) {
|
||||||
|
f.metrics(incoming).droppedRemoteAddr.Inc(1)
|
||||||
|
return ErrInvalidRemoteIP
|
||||||
|
}
|
||||||
default:
|
default:
|
||||||
f.metrics(incoming).droppedRemoteAddr.Inc(1)
|
f.metrics(incoming).droppedRemoteAddr.Inc(1)
|
||||||
return ErrUnknownNetworkType //should never happen
|
return ErrUnknownNetworkType //should never happen
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ func newFixedTicker(t *testing.T, l *slog.Logger, cacheLen int) *ConntrackCacheT
|
|||||||
l: l,
|
l: l,
|
||||||
cache: make(ConntrackCache, cacheLen),
|
cache: make(ConntrackCache, cacheLen),
|
||||||
}
|
}
|
||||||
for i := 0; i < cacheLen; i++ {
|
for i := range cacheLen {
|
||||||
c.cache[Packet{LocalPort: uint16(i) + 1}] = struct{}{}
|
c.cache[Packet{LocalPort: uint16(i) + 1}] = struct{}{}
|
||||||
}
|
}
|
||||||
c.cacheTick.Store(1) // cacheV starts at 0, so Get() takes the reset path
|
c.cacheTick.Store(1) // cacheV starts at 0, so Get() takes the reset path
|
||||||
|
|||||||
@@ -58,6 +58,31 @@ func TestNewFirewall(t *testing.T) {
|
|||||||
assert.Equal(t, 3602, conntrack.TimerWheel.wheelLen)
|
assert.Equal(t, 3602, conntrack.TimerWheel.wheelLen)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestNewFirewall_ZeroOrNegativeTimeout(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
c := &dummyCert{}
|
||||||
|
cs := &CertState{v2Cert: c, initiatingVersion: cert.Version2}
|
||||||
|
|
||||||
|
cases := map[string]string{
|
||||||
|
"tcp_timeout zero": "firewall:\n conntrack:\n tcp_timeout: 0s\n",
|
||||||
|
"tcp_timeout negative": "firewall:\n conntrack:\n tcp_timeout: -5s\n",
|
||||||
|
"udp_timeout zero": "firewall:\n conntrack:\n udp_timeout: 0s\n",
|
||||||
|
"udp_timeout negative": "firewall:\n conntrack:\n udp_timeout: -5s\n",
|
||||||
|
"default_timeout zero": "firewall:\n conntrack:\n default_timeout: 0s\n",
|
||||||
|
"default_timeout negative": "firewall:\n conntrack:\n default_timeout: -5s\n",
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, cfgStr := range cases {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
cfg := config.NewC(l)
|
||||||
|
require.NoError(t, cfg.LoadString(cfgStr))
|
||||||
|
_, err := NewFirewallFromConfig(l, cs, cfg)
|
||||||
|
require.Error(t, err, "expected error for non-positive timeout duration")
|
||||||
|
assert.ErrorContains(t, err, "must be greater than 0")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestFirewall_AddRule(t *testing.T) {
|
func TestFirewall_AddRule(t *testing.T) {
|
||||||
ob := &bytes.Buffer{}
|
ob := &bytes.Buffer{}
|
||||||
l := test.NewLoggerWithOutput(ob)
|
l := test.NewLoggerWithOutput(ob)
|
||||||
@@ -252,6 +277,58 @@ func TestFirewall_Drop(t *testing.T) {
|
|||||||
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
require.NoError(t, fw.Drop(p, true, &h, cp, nil))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestFirewall_DropOverlaySourceThroughUnsafeNetwork: a peer whose unsafe network
|
||||||
|
// overlaps our overlay may not send as another node of it. Its own address and sources
|
||||||
|
// outside the overlay still pass through the unsafe network, and outbound to such an
|
||||||
|
// address, where the address is a destination, is not the firewall's to refuse here.
|
||||||
|
func TestFirewall_DropOverlaySourceThroughUnsafeNetwork(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
myVpnNetworksTable := new(bart.Lite)
|
||||||
|
myVpnNetworksTable.Insert(netip.MustParsePrefix("1.2.3.0/24"))
|
||||||
|
|
||||||
|
me := dummyCert{name: "me", networks: []netip.Prefix{netip.MustParsePrefix("1.2.3.4/24")}}
|
||||||
|
// A router for 1.2.0.0/16, which contains the whole overlay.
|
||||||
|
peer := dummyCert{
|
||||||
|
name: "router",
|
||||||
|
networks: []netip.Prefix{netip.MustParsePrefix("1.2.3.9/24")},
|
||||||
|
unsafeNetworks: []netip.Prefix{netip.MustParsePrefix("1.2.0.0/16")},
|
||||||
|
groups: []string{"default-group"},
|
||||||
|
}
|
||||||
|
h := HostInfo{
|
||||||
|
ConnectionState: &ConnectionState{
|
||||||
|
peerCert: &cert.CachedCertificate{Certificate: &peer, InvertedGroups: map[string]struct{}{"default-group": {}}},
|
||||||
|
},
|
||||||
|
vpnAddrs: []netip.Addr{netip.MustParseAddr("1.2.3.9")},
|
||||||
|
}
|
||||||
|
h.buildNetworks(myVpnNetworksTable, &peer)
|
||||||
|
|
||||||
|
fw := NewFirewall(l, time.Second, time.Minute, time.Hour, &me)
|
||||||
|
require.NoError(t, fw.AddRule(true, firewall.ProtoAny, 0, 0, []string{"any"}, "", "", "", "", ""))
|
||||||
|
cp := cert.NewCAPool()
|
||||||
|
packet := func(remote string) firewall.Packet {
|
||||||
|
return firewall.Packet{
|
||||||
|
LocalAddr: netip.MustParseAddr("1.2.3.4"),
|
||||||
|
RemoteAddr: netip.MustParseAddr(remote),
|
||||||
|
LocalPort: 10,
|
||||||
|
RemotePort: 90,
|
||||||
|
Protocol: iputil.IPProtocolUDP,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Another node's overlay address, through the unsafe network: refused.
|
||||||
|
assert.Equal(t, ErrInvalidRemoteIP, fw.Drop(packet("1.2.3.10"), true, &h, cp, nil))
|
||||||
|
assert.Equal(t, int64(1), fw.incomingMetrics.droppedRemoteAddr.Count())
|
||||||
|
|
||||||
|
// The peer's own address, and an address outside the overlay it routes for: served.
|
||||||
|
require.NoError(t, fw.Drop(packet("1.2.3.9"), true, &h, cp, nil))
|
||||||
|
require.NoError(t, fw.Drop(packet("1.2.5.5"), true, &h, cp, nil))
|
||||||
|
|
||||||
|
// Outbound to the overlay address via the router is not refused here; it meets the
|
||||||
|
// outbound rules as before.
|
||||||
|
resetConntrack(fw)
|
||||||
|
assert.Equal(t, ErrNoMatchingRule, fw.Drop(packet("1.2.3.10"), false, &h, cp, nil))
|
||||||
|
}
|
||||||
|
|
||||||
func TestFirewall_DropV6(t *testing.T) {
|
func TestFirewall_DropV6(t *testing.T) {
|
||||||
ob := &bytes.Buffer{}
|
ob := &bytes.Buffer{}
|
||||||
l := test.NewLoggerWithOutput(ob)
|
l := test.NewLoggerWithOutput(ob)
|
||||||
|
|||||||
@@ -1,39 +1,39 @@
|
|||||||
module github.com/slackhq/nebula
|
module github.com/slackhq/nebula
|
||||||
|
|
||||||
go 1.26.0
|
go 1.27.2
|
||||||
|
|
||||||
require (
|
require (
|
||||||
dario.cat/mergo v1.0.2
|
dario.cat/mergo v1.0.2
|
||||||
filippo.io/bigmod v0.1.0
|
filippo.io/bigmod v0.1.0
|
||||||
|
github.com/DefinedNet/netlink v1.3.2-dn.1
|
||||||
|
github.com/Microsoft/go-winio v0.6.2
|
||||||
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be
|
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be
|
||||||
github.com/armon/go-radix v1.0.0
|
|
||||||
github.com/flynn/noise v1.1.0
|
github.com/flynn/noise v1.1.0
|
||||||
github.com/gaissmai/bart v0.28.0
|
github.com/gaissmai/bart v0.29.0
|
||||||
github.com/gogo/protobuf v1.3.2
|
github.com/gogo/protobuf v1.3.2
|
||||||
github.com/google/gopacket v1.1.19
|
github.com/google/gopacket v1.1.19
|
||||||
github.com/kardianos/service v1.3.0
|
github.com/kardianos/service v1.3.0
|
||||||
github.com/miekg/dns v1.1.72
|
github.com/miekg/dns v1.1.73
|
||||||
github.com/miekg/pkcs11 v1.1.2
|
github.com/miekg/pkcs11 v1.1.2
|
||||||
github.com/nbrownus/go-metrics-prometheus v0.0.0-20210712211119-974a6260965f
|
github.com/nbrownus/go-metrics-prometheus v0.0.0-20210712211119-974a6260965f
|
||||||
github.com/prometheus/client_golang v1.24.1
|
github.com/prometheus/client_golang v1.24.1
|
||||||
github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475
|
github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475
|
||||||
github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
|
github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
|
||||||
github.com/stefanberger/go-pkcs11uri v0.0.0-20230803200340-78284954bff6
|
github.com/stefanberger/go-pkcs11uri v0.0.0-20230803200340-78284954bff6
|
||||||
github.com/stretchr/testify v1.12.0
|
github.com/stretchr/testify v1.12.1
|
||||||
github.com/vishvananda/netlink v1.3.1
|
|
||||||
go.uber.org/goleak v1.3.0
|
go.uber.org/goleak v1.3.0
|
||||||
go.yaml.in/yaml/v3 v3.0.5
|
go.yaml.in/yaml/v3 v3.0.5
|
||||||
golang.org/x/crypto v0.54.0
|
golang.org/x/crypto v0.57.0
|
||||||
golang.org/x/net v0.57.0
|
golang.org/x/net v0.59.0
|
||||||
golang.org/x/sync v0.22.0
|
golang.org/x/sync v0.23.0
|
||||||
golang.org/x/sys v0.47.0
|
golang.org/x/sys v0.48.0
|
||||||
golang.org/x/term v0.45.0
|
golang.org/x/term v0.46.0
|
||||||
golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2
|
golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2
|
||||||
golang.zx2c4.com/wireguard v0.0.0-20230325221338-052af4a8072b
|
golang.zx2c4.com/wireguard v0.0.0-20230325221338-052af4a8072b
|
||||||
golang.zx2c4.com/wireguard/windows v1.0.1
|
golang.zx2c4.com/wireguard/windows v1.0.1
|
||||||
google.golang.org/protobuf v1.36.11
|
google.golang.org/protobuf v1.36.12
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
gvisor.dev/gvisor v0.0.0-20240423190808-9d7a357edefe
|
gvisor.dev/gvisor v0.0.0-20261014193016-04d31b385980
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
@@ -45,7 +45,6 @@ require (
|
|||||||
github.com/prometheus/common v0.70.1 // indirect
|
github.com/prometheus/common v0.70.1 // indirect
|
||||||
github.com/prometheus/procfs v0.21.1 // indirect
|
github.com/prometheus/procfs v0.21.1 // indirect
|
||||||
github.com/vishvananda/netns v0.0.5 // indirect
|
github.com/vishvananda/netns v0.0.5 // indirect
|
||||||
golang.org/x/mod v0.36.0 // indirect
|
golang.org/x/exp v0.0.0-20250711185948-6ae5c78190dc // indirect
|
||||||
golang.org/x/time v0.5.0 // indirect
|
golang.org/x/time v0.15.0 // indirect
|
||||||
golang.org/x/tools v0.45.0 // indirect
|
|
||||||
)
|
)
|
||||||
@@ -3,6 +3,10 @@ dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8=
|
|||||||
dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA=
|
dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA=
|
||||||
filippo.io/bigmod v0.1.0 h1:UNzDk7y9ADKST+axd9skUpBQeW7fG2KrTZyOE4uGQy8=
|
filippo.io/bigmod v0.1.0 h1:UNzDk7y9ADKST+axd9skUpBQeW7fG2KrTZyOE4uGQy8=
|
||||||
filippo.io/bigmod v0.1.0/go.mod h1:OjOXDNlClLblvXdwgFFOQFJEocLhhtai8vGLy0JCZlI=
|
filippo.io/bigmod v0.1.0/go.mod h1:OjOXDNlClLblvXdwgFFOQFJEocLhhtai8vGLy0JCZlI=
|
||||||
|
github.com/DefinedNet/netlink v1.3.2-dn.1 h1:Md2PsUE1Xuy1Zxs/Bm6356n1kt5bq2HspXlPJ6pEspg=
|
||||||
|
github.com/DefinedNet/netlink v1.3.2-dn.1/go.mod h1:o4YSn8Jw7zoDcYXDmV77TRd4eS5sSLuE+vu2zAN67C8=
|
||||||
|
github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY=
|
||||||
|
github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU=
|
||||||
github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
|
github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
|
||||||
github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
|
github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
|
||||||
github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
|
github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
|
||||||
@@ -10,8 +14,6 @@ github.com/alecthomas/units v0.0.0-20190717042225-c3de453c63f4/go.mod h1:ybxpYRF
|
|||||||
github.com/alecthomas/units v0.0.0-20190924025748-f65c72e2690d/go.mod h1:rBZYJk541a8SKzHPHnH3zbiI+7dagKZ0cgpgrD7Fyho=
|
github.com/alecthomas/units v0.0.0-20190924025748-f65c72e2690d/go.mod h1:rBZYJk541a8SKzHPHnH3zbiI+7dagKZ0cgpgrD7Fyho=
|
||||||
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8=
|
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8=
|
||||||
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4=
|
github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4=
|
||||||
github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI=
|
|
||||||
github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=
|
|
||||||
github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
|
github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
|
||||||
github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
|
github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
|
||||||
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
|
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
|
||||||
@@ -23,8 +25,8 @@ github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
|
|||||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
github.com/flynn/noise v1.1.0 h1:KjPQoQCEFdZDiP03phOvGi11+SVVhBG2wOWAorLsstg=
|
github.com/flynn/noise v1.1.0 h1:KjPQoQCEFdZDiP03phOvGi11+SVVhBG2wOWAorLsstg=
|
||||||
github.com/flynn/noise v1.1.0/go.mod h1:xbMo+0i6+IGbYdJhF31t2eR1BIU0CYc12+BNAKwUTag=
|
github.com/flynn/noise v1.1.0/go.mod h1:xbMo+0i6+IGbYdJhF31t2eR1BIU0CYc12+BNAKwUTag=
|
||||||
github.com/gaissmai/bart v0.28.0 h1:89yZLo8NmyqD0RYgJ3QO9HhqqGGw+oWhf90cZm69Lko=
|
github.com/gaissmai/bart v0.29.0 h1:wO6HGE8g9YE0Wm0bCpYxwRzfQ4+fbJKOhL64e5ACGCI=
|
||||||
github.com/gaissmai/bart v0.28.0/go.mod h1:GREWQfTLRWz/c5FTOsIw+KkscuFkIV5t8Rp7Nd1Td5c=
|
github.com/gaissmai/bart v0.29.0/go.mod h1:GREWQfTLRWz/c5FTOsIw+KkscuFkIV5t8Rp7Nd1Td5c=
|
||||||
github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
|
github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
|
||||||
github.com/go-kit/kit v0.9.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
|
github.com/go-kit/kit v0.9.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
|
||||||
github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY=
|
github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY=
|
||||||
@@ -81,8 +83,8 @@ github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
|
|||||||
github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
|
github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
|
||||||
github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
|
github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
|
||||||
github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
|
github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
|
||||||
github.com/miekg/dns v1.1.72 h1:vhmr+TF2A3tuoGNkLDFK9zi36F2LS+hKTRW0Uf8kbzI=
|
github.com/miekg/dns v1.1.73 h1:uhT8nJxmTrPJYClxVxTCX+CVn6qnzSiybRk72Z6DgrE=
|
||||||
github.com/miekg/dns v1.1.72/go.mod h1:+EuEPhdHOsfk6Wk5TT2CzssZdqkmFhf8r+aVyDEToIs=
|
github.com/miekg/dns v1.1.73/go.mod h1:RW2Obtfd5NZHvOFe3zYG0W8koWOQtAzyHaLo8vASBuQ=
|
||||||
github.com/miekg/pkcs11 v1.1.2 h1:/VxmeAX5qU6Q3EwafypogwWbYryHFmF2RpkJmw3m4MQ=
|
github.com/miekg/pkcs11 v1.1.2 h1:/VxmeAX5qU6Q3EwafypogwWbYryHFmF2RpkJmw3m4MQ=
|
||||||
github.com/miekg/pkcs11 v1.1.2/go.mod h1:XsNlhZGX73bx86s2hdc/FuaLm2CPZJemRLMA+WTFxgs=
|
github.com/miekg/pkcs11 v1.1.2/go.mod h1:XsNlhZGX73bx86s2hdc/FuaLm2CPZJemRLMA+WTFxgs=
|
||||||
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
|
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
|
||||||
@@ -136,10 +138,8 @@ github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXf
|
|||||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||||
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
|
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
|
||||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||||
github.com/stretchr/testify v1.12.0 h1:K6Mr6jO9JICuend/5xzTM03ydSV3vdNRYAdPSukj8uI=
|
github.com/stretchr/testify v1.12.1 h1:EuwCh5fleGS7H32xRwO3wRGT7DxrDhLAT6FF8MpWDWE=
|
||||||
github.com/stretchr/testify v1.12.0/go.mod h1:bOYBZb5qJ00vPzWfIqBUZPaxK8jWiXc6d3ErP4Ca9Gw=
|
github.com/stretchr/testify v1.12.1/go.mod h1:MDEgiDPPsNp5cuIrHPPCyornHKgEVbtFUmoNlxoYthg=
|
||||||
github.com/vishvananda/netlink v1.3.1 h1:3AEMt62VKqz90r0tmNhog0r/PpWKmrEShJU0wJW6bV0=
|
|
||||||
github.com/vishvananda/netlink v1.3.1/go.mod h1:ARtKouGSTGchR8aMwmkzC0qiNPrrWO5JS/XMVl45+b4=
|
|
||||||
github.com/vishvananda/netns v0.0.5 h1:DfiHV+j8bA32MFM7bfEunvT8IAqQ/NzSJHtcmW5zdEY=
|
github.com/vishvananda/netns v0.0.5 h1:DfiHV+j8bA32MFM7bfEunvT8IAqQ/NzSJHtcmW5zdEY=
|
||||||
github.com/vishvananda/netns v0.0.5/go.mod h1:SpkAiCQRtJ6TvvxPnOSyH3BMl6unz3xZlaprSwhNNJM=
|
github.com/vishvananda/netns v0.0.5/go.mod h1:SpkAiCQRtJ6TvvxPnOSyH3BMl6unz3xZlaprSwhNNJM=
|
||||||
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
||||||
@@ -155,14 +155,14 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk
|
|||||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
||||||
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||||
golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
|
golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
|
||||||
golang.org/x/crypto v0.54.0 h1:YLIA59K4fiNzHzjnZt2tUJQjQtUWfWbeHBqKtk3eScw=
|
golang.org/x/crypto v0.57.0 h1:3ZVCjf8Ggz7zneR/EHRVx68Ctf+2pmIMP2UFhh9cC6M=
|
||||||
golang.org/x/crypto v0.54.0/go.mod h1:KWL8ny2AZdGR2cWmzeHrp2azQPGogOv+HeQaVEXC2dk=
|
golang.org/x/crypto v0.57.0/go.mod h1:Fdz0i5U6CoizGwLda9DttjSk6qlZo25zYNtR+ycvuZA=
|
||||||
|
golang.org/x/exp v0.0.0-20250711185948-6ae5c78190dc h1:TS73t7x3KarrNd5qAipmspBDS1rkMcgVG/fS1aRb4Rc=
|
||||||
|
golang.org/x/exp v0.0.0-20250711185948-6ae5c78190dc/go.mod h1:A+z0yzpGtvnG90cToK5n2tu8UJVP2XUATh+r+sfOOOc=
|
||||||
golang.org/x/lint v0.0.0-20200302205851-738671d3881b/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY=
|
golang.org/x/lint v0.0.0-20200302205851-738671d3881b/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY=
|
||||||
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
|
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
|
||||||
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||||
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||||
golang.org/x/mod v0.36.0 h1:JJjpVx6myfUsUdAzZuOSTTmRE0PfZeNWzzvKrP7amb4=
|
|
||||||
golang.org/x/mod v0.36.0/go.mod h1:moc6ELqsWcOw5Ef3xVprK5ul/MvtVvkIXLziUOICjUQ=
|
|
||||||
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||||
golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||||
golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||||
@@ -173,8 +173,8 @@ golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLL
|
|||||||
golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
|
golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
|
||||||
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
||||||
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
|
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
|
||||||
golang.org/x/net v0.57.0 h1:K5+3DljvIuDG9/Jv9rvyMywYNFCQ9RSUY6OOTTkT+tE=
|
golang.org/x/net v0.59.0 h1:5zfYln+w5XCxwrnMMJPufRgNoXEaGxl0wo5GqPXyues=
|
||||||
golang.org/x/net v0.57.0/go.mod h1:KpXc8iv+r3XplLAG/f7Jsf9RPszJzdR0f58q9vGOuEU=
|
golang.org/x/net v0.59.0/go.mod h1:2DA/G1UfVbCpQPeWTmMPGY7Cs2PkBkwu743bVX5PIVg=
|
||||||
golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
|
golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
|
||||||
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
@@ -182,8 +182,8 @@ golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJ
|
|||||||
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.22.0 h1:SZjpbeLmrCk4xhRSZFNZW5gFUeCeFgjekvI/+gfScek=
|
golang.org/x/sync v0.23.0 h1:KameEIfc1IkluZyXWLn39Wd4tURc6GbCiISGiZm2bQk=
|
||||||
golang.org/x/sync v0.22.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
|
golang.org/x/sync v0.23.0/go.mod h1:sUUOizhqBxiL6pEWpqNLUiaJn1ShEbZ6BBqskPbjZm0=
|
||||||
golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
@@ -197,25 +197,21 @@ golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7w
|
|||||||
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20210603081109-ebe580a85c40/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.0.0-20210603081109-ebe580a85c40/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.48.0 h1:bbX/i/6MgT9BVLM9RT1thmxL04yeTAhbEz4SyadbXoo=
|
||||||
golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.48.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
|
||||||
golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
|
|
||||||
golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
|
||||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||||
golang.org/x/term v0.45.0 h1:NwWyBmoJCbfTHpxrWoZ9C6/VxOf7ic219I8xZZFdrf0=
|
golang.org/x/term v0.46.0 h1:3+OXuTbaKDgwk8jTi3aSLHRlmWqHEUDUtxnbFigO4YE=
|
||||||
golang.org/x/term v0.45.0/go.mod h1:9aqxs0blBcrm/n0L9QW0aRVD+ktan8ssZromtqJC43w=
|
golang.org/x/term v0.46.0/go.mod h1:+K02xbkittuwc0Am4abfA3Fc+XRGXkvBXNO88NCXPoc=
|
||||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||||
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
|
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
|
||||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||||
golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk=
|
golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U=
|
||||||
golang.org/x/time v0.5.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
|
golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno=
|
||||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||||
golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
|
golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
|
||||||
golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
|
golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
|
||||||
golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
||||||
golang.org/x/tools v0.45.0 h1:18qN3FAooORvApf5XjCXgsuayZOEtXf6JK18I3+ONa8=
|
|
||||||
golang.org/x/tools v0.45.0/go.mod h1:LuUGqqaXcXMEFEruIVJVm5mgDD8vww/z/SR1gQ4uE/0=
|
|
||||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
@@ -234,8 +230,8 @@ google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miE
|
|||||||
google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
|
google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
|
||||||
google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
|
google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
|
||||||
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
|
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
|
||||||
google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
|
google.golang.org/protobuf v1.36.12 h1:pJOKDDOyeXErUroCihFAd5LQuwXBSpVnKGrj5o/fwxc=
|
||||||
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
|
google.golang.org/protobuf v1.36.12/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
|
||||||
gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw=
|
gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
@@ -249,5 +245,5 @@ gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
|||||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
gvisor.dev/gvisor v0.0.0-20240423190808-9d7a357edefe h1:fre4i6mv4iBuz5lCMOzHD1rH1ljqHWSICFmZRbbgp3g=
|
gvisor.dev/gvisor v0.0.0-20261014193016-04d31b385980 h1:ribyrTYQ/QYeUIs8x8bVLYwGyepa7RnHLqJzegT5YYk=
|
||||||
gvisor.dev/gvisor v0.0.0-20240423190808-9d7a357edefe/go.mod h1:sxc3Uvk/vHcd3tj7/DHVBoR5wvWT/MmRq2pj7HRJnwU=
|
gvisor.dev/gvisor v0.0.0-20261014193016-04d31b385980/go.mod h1:pK/dapF5Bf3KGW7/kd5CI5IC4lYh9FMFY1qETAIGLXk=
|
||||||
+18
-5
@@ -31,6 +31,7 @@ package nebula
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net"
|
"net"
|
||||||
"strconv"
|
"strconv"
|
||||||
@@ -51,17 +52,29 @@ type graphiteConfigExport struct {
|
|||||||
Percentiles []float64 // Percentiles to export from timers and histograms
|
Percentiles []float64 // Percentiles to export from timers and histograms
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// graphiteTimeout bounds one submission, the connect and the write together. An export is a few KB, a host that can't
|
||||||
|
// take that in this long isn't going to.
|
||||||
|
const graphiteTimeout = 30 * time.Second
|
||||||
|
|
||||||
// graphiteOnce performs a single submission to Graphite, returning a non-nil
|
// graphiteOnce performs a single submission to Graphite, returning a non-nil
|
||||||
// error on failed connections.
|
// error if it could not connect or write all of it within timeout. It gives up
|
||||||
func graphiteOnce(c graphiteConfigExport) error {
|
// as soon as ctx is done.
|
||||||
|
func graphiteOnce(ctx context.Context, c graphiteConfigExport, timeout time.Duration) error {
|
||||||
now := time.Now().Unix()
|
now := time.Now().Unix()
|
||||||
du := float64(c.DurationUnit)
|
du := float64(c.DurationUnit)
|
||||||
flushSeconds := float64(c.FlushInterval) / float64(time.Second)
|
flushSeconds := float64(c.FlushInterval) / float64(time.Second)
|
||||||
conn, err := net.DialTCP("tcp", nil, c.Addr)
|
deadline := time.Now().Add(timeout)
|
||||||
|
d := net.Dialer{Deadline: deadline}
|
||||||
|
conn, err := d.DialContext(ctx, "tcp", c.Addr.String())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
defer conn.Close()
|
defer conn.Close()
|
||||||
|
if err := conn.SetDeadline(deadline); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
stop := context.AfterFunc(ctx, func() { _ = conn.Close() })
|
||||||
|
defer stop()
|
||||||
w := bufio.NewWriter(conn)
|
w := bufio.NewWriter(conn)
|
||||||
c.Registry.Each(func(name string, i any) {
|
c.Registry.Each(func(name string, i any) {
|
||||||
switch metric := i.(type) {
|
switch metric := i.(type) {
|
||||||
@@ -111,7 +124,7 @@ func graphiteOnce(c graphiteConfigExport) error {
|
|||||||
fmt.Fprintf(w, "%s.%s.fifteen-minute %.2f %d\n", c.Prefix, name, t.Rate15(), now)
|
fmt.Fprintf(w, "%s.%s.fifteen-minute %.2f %d\n", c.Prefix, name, t.Rate15(), now)
|
||||||
fmt.Fprintf(w, "%s.%s.mean-rate %.2f %d\n", c.Prefix, name, t.RateMean(), now)
|
fmt.Fprintf(w, "%s.%s.mean-rate %.2f %d\n", c.Prefix, name, t.RateMean(), now)
|
||||||
}
|
}
|
||||||
w.Flush()
|
|
||||||
})
|
})
|
||||||
return nil
|
// A failed write sticks, so this reports the first one
|
||||||
|
return w.Flush()
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,315 @@
|
|||||||
|
package nebula
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/rcrowley/go-metrics"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// graphiteHost accepts connections and hands each one to the test
|
||||||
|
type graphiteHost struct {
|
||||||
|
ln net.Listener
|
||||||
|
conns chan net.Conn
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
closed bool
|
||||||
|
open []net.Conn
|
||||||
|
}
|
||||||
|
|
||||||
|
// newGraphiteHost accepts connections for the test. A non-zero window shrinks each connection's receive buffer, so a
|
||||||
|
// sender that is not read from blocks after a little whatever the host's TCP tuning. Only for tests that need a stall,
|
||||||
|
// a small window makes reading very slow on Linux.
|
||||||
|
func newGraphiteHost(t *testing.T, window int) *graphiteHost {
|
||||||
|
t.Helper()
|
||||||
|
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
||||||
|
require.NoError(t, err)
|
||||||
|
h := &graphiteHost{ln: ln, conns: make(chan net.Conn, 8)}
|
||||||
|
done := make(chan struct{})
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = ln.Close()
|
||||||
|
h.mu.Lock()
|
||||||
|
h.closed = true
|
||||||
|
for _, c := range h.open {
|
||||||
|
_ = c.Close()
|
||||||
|
}
|
||||||
|
h.mu.Unlock()
|
||||||
|
close(done)
|
||||||
|
})
|
||||||
|
go func() {
|
||||||
|
for {
|
||||||
|
c, err := ln.Accept()
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.mu.Lock()
|
||||||
|
if h.closed {
|
||||||
|
h.mu.Unlock()
|
||||||
|
_ = c.Close()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.open = append(h.open, c)
|
||||||
|
h.mu.Unlock()
|
||||||
|
if tc, ok := c.(*net.TCPConn); ok && window > 0 {
|
||||||
|
_ = tc.SetReadBuffer(window)
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case h.conns <- c:
|
||||||
|
case <-done:
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
return h
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *graphiteHost) addr(t *testing.T) *net.TCPAddr {
|
||||||
|
a, err := net.ResolveTCPAddr("tcp", h.ln.Addr().String())
|
||||||
|
require.NoError(t, err)
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
|
||||||
|
// readExport reads what one send wrote, bounded so a send that never finishes fails the test rather than hanging it
|
||||||
|
func readExport(t *testing.T, c net.Conn) []byte {
|
||||||
|
t.Helper()
|
||||||
|
require.NoError(t, c.SetReadDeadline(time.Now().Add(10*time.Second)))
|
||||||
|
b, err := io.ReadAll(c)
|
||||||
|
require.NoError(t, err)
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *graphiteHost) next(t *testing.T, wait time.Duration) net.Conn {
|
||||||
|
t.Helper()
|
||||||
|
select {
|
||||||
|
case c := <-h.conns:
|
||||||
|
return c
|
||||||
|
case <-time.After(wait):
|
||||||
|
t.Fatal("no connection")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// lockedBuffer is a log destination a test can read while the code under test writes to it from another goroutine
|
||||||
|
type lockedBuffer struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
buf bytes.Buffer
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *lockedBuffer) Write(p []byte) (int, error) {
|
||||||
|
b.mu.Lock()
|
||||||
|
defer b.mu.Unlock()
|
||||||
|
return b.buf.Write(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *lockedBuffer) String() string {
|
||||||
|
b.mu.Lock()
|
||||||
|
defer b.mu.Unlock()
|
||||||
|
return b.buf.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func testGraphiteConfig(addr *net.TCPAddr, r metrics.Registry) graphiteConfigExport {
|
||||||
|
return graphiteConfigExport{Addr: addr, Registry: r, FlushInterval: time.Second, DurationUnit: time.Nanosecond, Prefix: "nebula"}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enough metrics that one export overflows the socket buffers on any platform, so a send to a host that stops
|
||||||
|
// reading blocks
|
||||||
|
func bigGraphiteRegistry(r metrics.Registry, t *testing.T) {
|
||||||
|
for i := range 200000 {
|
||||||
|
name := fmt.Sprintf("big.gauge.%d", i)
|
||||||
|
metrics.GetOrRegisterGauge(name, r).Update(int64(i))
|
||||||
|
t.Cleanup(func() { r.Unregister(name) })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGraphiteOnce_sends(t *testing.T) {
|
||||||
|
r := metrics.NewRegistry()
|
||||||
|
metrics.GetOrRegisterGauge("g", r).Update(7)
|
||||||
|
metrics.GetOrRegisterCounter("c", r).Inc(3)
|
||||||
|
h := newGraphiteHost(t, 0)
|
||||||
|
|
||||||
|
require.NoError(t, graphiteOnce(t.Context(), testGraphiteConfig(h.addr(t), r), time.Minute))
|
||||||
|
b := readExport(t, h.next(t, 5*time.Second))
|
||||||
|
assert.Contains(t, string(b), "nebula.g.value 7 ")
|
||||||
|
assert.Contains(t, string(b), "nebula.c.count 3 ")
|
||||||
|
assert.Contains(t, string(b), "nebula.c.count_ps 3.00 ")
|
||||||
|
}
|
||||||
|
|
||||||
|
// A host that accepts and never reads is given up on, and the failed write is reported
|
||||||
|
func TestGraphiteOnce_stalledHostTimesOut(t *testing.T) {
|
||||||
|
r := metrics.NewRegistry()
|
||||||
|
bigGraphiteRegistry(r, t)
|
||||||
|
h := newGraphiteHost(t, 4096)
|
||||||
|
done := make(chan error, 1)
|
||||||
|
cfg := testGraphiteConfig(h.addr(t), r)
|
||||||
|
go func() { done <- graphiteOnce(t.Context(), cfg, 300*time.Millisecond) }()
|
||||||
|
h.next(t, 5*time.Second) // accepted, never read
|
||||||
|
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
require.Error(t, err)
|
||||||
|
case <-time.After(10 * time.Second):
|
||||||
|
t.Fatal("the send did not give up on a host that stopped reading")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The timeout covers the whole send, a host that keeps reading but too slowly is still given up on
|
||||||
|
func TestGraphiteOnce_timeoutCoversTheWholeSend(t *testing.T) {
|
||||||
|
r := metrics.NewRegistry()
|
||||||
|
bigGraphiteRegistry(r, t)
|
||||||
|
h := newGraphiteHost(t, 0)
|
||||||
|
done := make(chan error, 1)
|
||||||
|
start := time.Now()
|
||||||
|
cfg := testGraphiteConfig(h.addr(t), r)
|
||||||
|
go func() { done <- graphiteOnce(t.Context(), cfg, 500*time.Millisecond) }()
|
||||||
|
c := h.next(t, 5*time.Second)
|
||||||
|
stopReading := make(chan struct{})
|
||||||
|
defer close(stopReading)
|
||||||
|
// 32KB every 10ms keeps every write well inside the timeout, the whole export takes seconds
|
||||||
|
go func() {
|
||||||
|
buf := make([]byte, 32<<10)
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-stopReading:
|
||||||
|
return
|
||||||
|
case <-time.After(10 * time.Millisecond):
|
||||||
|
}
|
||||||
|
if _, err := c.Read(buf); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Less(t, time.Since(start), 5*time.Second)
|
||||||
|
case <-time.After(10 * time.Second):
|
||||||
|
t.Fatal("a host that kept reading slowly held the send past its timeout")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGraphiteOnce_cancelledCtxDoesNotConnect(t *testing.T) {
|
||||||
|
h := newGraphiteHost(t, 0)
|
||||||
|
ctx, cancel := context.WithCancel(t.Context())
|
||||||
|
cancel()
|
||||||
|
require.Error(t, graphiteOnce(ctx, testGraphiteConfig(h.addr(t), metrics.NewRegistry()), time.Minute))
|
||||||
|
select {
|
||||||
|
case <-h.conns:
|
||||||
|
t.Fatal("connected on a cancelled ctx")
|
||||||
|
case <-time.After(200 * time.Millisecond):
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A stop or reload abandons a stuck send rather than waiting out its timeout
|
||||||
|
func TestGraphiteOnce_cancelAbandonsSend(t *testing.T) {
|
||||||
|
r := metrics.NewRegistry()
|
||||||
|
bigGraphiteRegistry(r, t)
|
||||||
|
h := newGraphiteHost(t, 4096)
|
||||||
|
ctx, cancel := context.WithCancel(t.Context())
|
||||||
|
done := make(chan error, 1)
|
||||||
|
cfg := testGraphiteConfig(h.addr(t), r)
|
||||||
|
go func() { done <- graphiteOnce(ctx, cfg, time.Minute) }()
|
||||||
|
h.next(t, 5*time.Second)
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
t.Fatalf("the send should be stuck on a host that is not reading, it ended with %v", err)
|
||||||
|
case <-time.After(200 * time.Millisecond):
|
||||||
|
}
|
||||||
|
|
||||||
|
cancel()
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
require.Error(t, err)
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("the send is still stuck after its ctx was cancelled")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildRuntime hands graphite the configured prefix and interval
|
||||||
|
func TestStatsServer_graphiteExportUsesConfig(t *testing.T) {
|
||||||
|
const name = "graphite.wiring.test"
|
||||||
|
metrics.GetOrRegisterCounter(name, nil).Inc(8)
|
||||||
|
t.Cleanup(func() { metrics.DefaultRegistry.Unregister(name) })
|
||||||
|
h := newGraphiteHost(t, 0)
|
||||||
|
s, c := newTestStatsServer(t)
|
||||||
|
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "4s", "prefix": "pfx", "host": h.ln.Addr().String()})
|
||||||
|
cfg, err := loadStatsConfig(c)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
s.runMu.Lock()
|
||||||
|
fns, _ := s.buildRuntime(t.Context(), cfg)
|
||||||
|
s.runMu.Unlock()
|
||||||
|
for _, fn := range fns {
|
||||||
|
fn()
|
||||||
|
}
|
||||||
|
b := readExport(t, h.next(t, 5*time.Second))
|
||||||
|
assert.Contains(t, string(b), "pfx."+name+".count 8 ")
|
||||||
|
assert.Contains(t, string(b), "pfx."+name+".count_ps 2.00 ")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStatsServer_graphiteFailureIsLogged(t *testing.T) {
|
||||||
|
logs := &lockedBuffer{}
|
||||||
|
s, c := newTestStatsServer(t)
|
||||||
|
s.l = test.NewLoggerWithOutput(logs)
|
||||||
|
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "1h", "host": "127.0.0.1:" + freeTCPPort(t)})
|
||||||
|
cfg, err := loadStatsConfig(c)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
s.runMu.Lock()
|
||||||
|
fns, _ := s.buildRuntime(t.Context(), cfg)
|
||||||
|
s.runMu.Unlock()
|
||||||
|
for _, fn := range fns {
|
||||||
|
fn()
|
||||||
|
}
|
||||||
|
assert.Contains(t, logs.String(), "Graphite export failed")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stop abandons the running export, so it goes through Start rather than handing buildRuntime a ctx, and a stop is
|
||||||
|
// not logged as a failure
|
||||||
|
func TestStatsServer_stopAbandonsGraphiteSend(t *testing.T) {
|
||||||
|
bigGraphiteRegistry(metrics.DefaultRegistry, t)
|
||||||
|
h := newGraphiteHost(t, 4096)
|
||||||
|
logs := &lockedBuffer{}
|
||||||
|
s, c := newTestStatsServer(t)
|
||||||
|
s.l = test.NewLoggerWithOutput(logs)
|
||||||
|
setStatsConfig(c, map[string]any{"type": "graphite", "interval": "50ms", "host": h.ln.Addr().String()})
|
||||||
|
require.NoError(t, s.reload(c, true))
|
||||||
|
|
||||||
|
started := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
s.Start()
|
||||||
|
close(started)
|
||||||
|
}()
|
||||||
|
stuck := h.next(t, 30*time.Second)
|
||||||
|
s.Stop()
|
||||||
|
select {
|
||||||
|
case <-started:
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("Start did not return after Stop")
|
||||||
|
}
|
||||||
|
|
||||||
|
// A closed sender resets the connection once it sees this, one still sending just buffers it. Either way the
|
||||||
|
// read below doesn't have to drain the export through the small window to find out
|
||||||
|
_, err := stuck.Write([]byte("x"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, stuck.SetReadDeadline(time.Now().Add(10*time.Second)))
|
||||||
|
n, err := io.Copy(io.Discard, stuck)
|
||||||
|
var ne net.Error
|
||||||
|
if errors.As(err, &ne) && ne.Timeout() {
|
||||||
|
t.Fatalf("the send kept the connection after Stop, read %d bytes", n)
|
||||||
|
}
|
||||||
|
assert.Less(t, n, int64(1<<20), "the send kept going after Stop")
|
||||||
|
// The capture loop logs on its own goroutine after Start has returned, give it the chance
|
||||||
|
assert.Never(t, func() bool { return strings.Contains(logs.String(), "Graphite export failed") }, 500*time.Millisecond, 10*time.Millisecond, "a stop is not a failure")
|
||||||
|
}
|
||||||
+21
-14
@@ -54,7 +54,8 @@ type HandshakeConfig struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type HandshakeManager struct {
|
type HandshakeManager struct {
|
||||||
// Mutex for interacting with the vpnIps and indexes maps
|
// Mutex for interacting with the vpnIps and indexes maps.
|
||||||
|
// Lock order is hostmap, then this lock, then the lighthouse, then a RemoteList.
|
||||||
sync.RWMutex
|
sync.RWMutex
|
||||||
|
|
||||||
vpnIps map[netip.Addr]*HandshakeHostInfo
|
vpnIps map[netip.Addr]*HandshakeHostInfo
|
||||||
@@ -68,6 +69,7 @@ type HandshakeManager struct {
|
|||||||
messageMetrics *MessageMetrics
|
messageMetrics *MessageMetrics
|
||||||
metricInitiated metrics.Counter
|
metricInitiated metrics.Counter
|
||||||
metricTimedOut metrics.Counter
|
metricTimedOut metrics.Counter
|
||||||
|
metricRejectedBlocklisted metrics.Counter
|
||||||
f *Interface
|
f *Interface
|
||||||
l *slog.Logger
|
l *slog.Logger
|
||||||
|
|
||||||
@@ -128,6 +130,7 @@ func NewHandshakeManager(l *slog.Logger, mainHostMap *HostMap, lightHouse *Light
|
|||||||
messageMetrics: config.messageMetrics,
|
messageMetrics: config.messageMetrics,
|
||||||
metricInitiated: metrics.GetOrRegisterCounter("handshake_manager.initiated", nil),
|
metricInitiated: metrics.GetOrRegisterCounter("handshake_manager.initiated", nil),
|
||||||
metricTimedOut: metrics.GetOrRegisterCounter("handshake_manager.timed_out", nil),
|
metricTimedOut: metrics.GetOrRegisterCounter("handshake_manager.timed_out", nil),
|
||||||
|
metricRejectedBlocklisted: metrics.GetOrRegisterCounter("handshake_manager.rejected.blocklisted", nil),
|
||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -259,14 +262,6 @@ func (hm *HandshakeManager) handleOutbound(vpnIp netip.Addr, lighthouseTriggered
|
|||||||
"style": header.SubTypeName(header.Handshake, hh.machine.Subtype()),
|
"style": header.SubTypeName(header.Handshake, hh.machine.Subtype()),
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get a remotes object if we don't already have one.
|
|
||||||
// This is mainly to protect us as this should never be the case
|
|
||||||
// NB ^ This comment doesn't jive. It's how the thing gets initialized.
|
|
||||||
// It's the common path. Should it update every time, in case a future LH query/queries give us more info?
|
|
||||||
if hostinfo.remotes == nil {
|
|
||||||
hostinfo.remotes = hm.lightHouse.QueryCache([]netip.Addr{vpnIp})
|
|
||||||
}
|
|
||||||
|
|
||||||
remotes := hostinfo.remotes.CopyAddrs(hm.mainHostMap.GetPreferredRanges())
|
remotes := hostinfo.remotes.CopyAddrs(hm.mainHostMap.GetPreferredRanges())
|
||||||
remotesHaveChanged := !slices.Equal(remotes, hh.lastRemotes)
|
remotesHaveChanged := !slices.Equal(remotes, hh.lastRemotes)
|
||||||
|
|
||||||
@@ -371,6 +366,9 @@ func (hm *HandshakeManager) StartHandshake(vpnAddr netip.Addr, cacheCb func(*Han
|
|||||||
hostinfo := &HostInfo{
|
hostinfo := &HostInfo{
|
||||||
vpnAddrs: []netip.Addr{vpnAddr},
|
vpnAddrs: []netip.Addr{vpnAddr},
|
||||||
HandshakePacket: make(map[uint8][]byte, 0),
|
HandshakePacket: make(map[uint8][]byte, 0),
|
||||||
|
// Attached here so a pending hostinfo never exists without one: SetRemote dereferences
|
||||||
|
// it, and create-tunnel -address can reach SetRemote before the handshake loop runs.
|
||||||
|
remotes: hm.lightHouse.QueryCache([]netip.Addr{vpnAddr}),
|
||||||
relayState: RelayState{
|
relayState: RelayState{
|
||||||
relays: nil,
|
relays: nil,
|
||||||
relayForByAddr: map[netip.Addr]*Relay{},
|
relayForByAddr: map[netip.Addr]*Relay{},
|
||||||
@@ -721,7 +719,12 @@ func (hm *HandshakeManager) beginHandshake(via ViaSender, packet []byte, h *head
|
|||||||
|
|
||||||
response, result, err := machine.ProcessPacket(nil, packet)
|
response, result, err := machine.ProcessPacket(nil, packet)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
f.l.Error("Failed to process handshake packet", "from", via, "error", err)
|
level := slog.LevelError
|
||||||
|
if errors.Is(err, cert.ErrBlockListed) {
|
||||||
|
level = slog.LevelDebug
|
||||||
|
hm.metricRejectedBlocklisted.Inc(1)
|
||||||
|
}
|
||||||
|
f.l.Log(context.Background(), level, "Failed to process handshake packet", "from", via, "error", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -807,7 +810,7 @@ func (hm *HandshakeManager) beginHandshake(via ViaSender, packet []byte, h *head
|
|||||||
}
|
}
|
||||||
|
|
||||||
hm.sendHandshakeResponse(via, response, hostinfo, false)
|
hm.sendHandshakeResponse(via, response, hostinfo, false)
|
||||||
hostinfo.remotes.RefreshFromHandshake(vpnAddrs, remoteCert.Certificate.Version())
|
hostinfo.remotes.RefreshFromHandshake(vpnAddrs)
|
||||||
|
|
||||||
// Don't wait for UpdateWorker
|
// Don't wait for UpdateWorker
|
||||||
if f.lightHouse.IsAnyLighthouseAddr(vpnAddrs) {
|
if f.lightHouse.IsAnyLighthouseAddr(vpnAddrs) {
|
||||||
@@ -853,6 +856,9 @@ func (hm *HandshakeManager) continueHandshake(via ViaSender, hh *HandshakeHostIn
|
|||||||
|
|
||||||
response, result, err := machine.ProcessPacket(nil, packet)
|
response, result, err := machine.ProcessPacket(nil, packet)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
if errors.Is(err, cert.ErrBlockListed) {
|
||||||
|
hm.metricRejectedBlocklisted.Inc(1)
|
||||||
|
}
|
||||||
// Recoverable errors are routine noise, log at Debug. Fatal errors get a Warn.
|
// Recoverable errors are routine noise, log at Debug. Fatal errors get a Warn.
|
||||||
if machine.Failed() {
|
if machine.Failed() {
|
||||||
f.l.Warn("Failed to process handshake packet, abandoning",
|
f.l.Warn("Failed to process handshake packet, abandoning",
|
||||||
@@ -946,13 +952,14 @@ func (hm *HandshakeManager) continueHandshake(via ViaSender, hh *HandshakeHostIn
|
|||||||
|
|
||||||
hm.DeleteHostInfo(hostinfo)
|
hm.DeleteHostInfo(hostinfo)
|
||||||
hm.StartHandshake(hostinfo.vpnAddrs[0], func(newHH *HandshakeHostInfo) {
|
hm.StartHandshake(hostinfo.vpnAddrs[0], func(newHH *HandshakeHostInfo) {
|
||||||
newHH.hostinfo.remotes = hostinfo.remotes
|
|
||||||
newHH.hostinfo.remotes.BlockRemote(via)
|
newHH.hostinfo.remotes.BlockRemote(via)
|
||||||
newHH.packetStore = hh.packetStore
|
newHH.packetStore = hh.packetStore
|
||||||
hh.packetStore = []*cachedPacket{}
|
hh.packetStore = []*cachedPacket{}
|
||||||
|
})
|
||||||
|
// sendCloseTunnel may take the hostmap lock, so it must not run under the handshake
|
||||||
|
// manager lock that StartHandshake holds around the callback.
|
||||||
hostinfo.vpnAddrs = vpnAddrs
|
hostinfo.vpnAddrs = vpnAddrs
|
||||||
f.sendCloseTunnel(hostinfo)
|
f.sendCloseTunnel(hostinfo)
|
||||||
})
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -995,7 +1002,7 @@ func (hm *HandshakeManager) continueHandshake(via ViaSender, hh *HandshakeHostIn
|
|||||||
f.cachedPacketMetrics.sent.Inc(int64(len(hh.packetStore)))
|
f.cachedPacketMetrics.sent.Inc(int64(len(hh.packetStore)))
|
||||||
}
|
}
|
||||||
|
|
||||||
hostinfo.remotes.RefreshFromHandshake(vpnAddrs, remoteCert.Certificate.Version())
|
hostinfo.remotes.RefreshFromHandshake(vpnAddrs)
|
||||||
f.metricHandshakes.Update(duration)
|
f.metricHandshakes.Update(duration)
|
||||||
|
|
||||||
// Don't wait for UpdateWorker
|
// Don't wait for UpdateWorker
|
||||||
|
|||||||
+156
-2
@@ -1,16 +1,22 @@
|
|||||||
package nebula
|
package nebula
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"log/slog"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/flynn/noise"
|
||||||
"github.com/gaissmai/bart"
|
"github.com/gaissmai/bart"
|
||||||
|
"github.com/rcrowley/go-metrics"
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
|
ct "github.com/slackhq/nebula/cert_test"
|
||||||
|
"github.com/slackhq/nebula/handshake"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
"github.com/slackhq/nebula/test"
|
"github.com/slackhq/nebula/test"
|
||||||
"github.com/slackhq/nebula/udp"
|
"github.com/slackhq/nebula/udp"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
func Test_NewHandshakeManagerVpnIp(t *testing.T) {
|
func Test_NewHandshakeManagerVpnIp(t *testing.T) {
|
||||||
@@ -42,8 +48,6 @@ func Test_NewHandshakeManagerVpnIp(t *testing.T) {
|
|||||||
i2 := blah.StartHandshake(ip, nil)
|
i2 := blah.StartHandshake(ip, nil)
|
||||||
assert.Same(t, i, i2)
|
assert.Same(t, i, i2)
|
||||||
|
|
||||||
i.remotes = NewRemoteList([]netip.Addr{}, nil)
|
|
||||||
|
|
||||||
// Adding something to pending should not affect the main hostmap
|
// Adding something to pending should not affect the main hostmap
|
||||||
assert.Empty(t, mainHM.Hosts)
|
assert.Empty(t, mainHM.Hosts)
|
||||||
|
|
||||||
@@ -235,3 +239,153 @@ func TestHandleIncomingDispatch(t *testing.T) {
|
|||||||
assert.Empty(t, hm.indexes, "orphan stage-2 must not create state")
|
assert.Empty(t, hm.indexes, "orphan stage-2 must not create state")
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestBlocklistedHandshakeLogLevelAndCounter(t *testing.T) {
|
||||||
|
ca, _, caKey, _ := ct.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||||
|
pool := ct.NewTestCAPool(ca)
|
||||||
|
|
||||||
|
newCredential := func(name, network string) (cert.Certificate, *handshake.Credential) {
|
||||||
|
c, _, rawKey, _ := ct.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca, caKey,
|
||||||
|
name, ca.NotBefore(), ca.NotAfter(), []netip.Prefix{netip.MustParsePrefix(network)}, nil, nil)
|
||||||
|
privateKey, _, _, err := cert.UnmarshalPrivateKeyFromPEM(rawKey)
|
||||||
|
require.NoError(t, err)
|
||||||
|
certBytes, err := c.MarshalForHandshakes()
|
||||||
|
require.NoError(t, err)
|
||||||
|
cipherSuite := noise.NewCipherSuite(noise.DH25519, noise.CipherChaChaPoly, noise.HashSHA256)
|
||||||
|
return c, handshake.NewCredential(c, certBytes, privateKey, cipherSuite)
|
||||||
|
}
|
||||||
|
|
||||||
|
initiatorCert, initiatorCredential := newCredential("initiator", "10.0.0.1/24")
|
||||||
|
responderCert, responderCredential := newCredential("responder", "10.0.0.2/24")
|
||||||
|
fingerprint, err := initiatorCert.Fingerprint()
|
||||||
|
require.NoError(t, err)
|
||||||
|
pool.BlocklistFingerprint(fingerprint)
|
||||||
|
|
||||||
|
initiator, err := handshake.NewMachine(cert.Version2,
|
||||||
|
func(cert.Version) *handshake.Credential { return initiatorCredential },
|
||||||
|
func(c cert.Certificate) (*cert.CachedCertificate, error) {
|
||||||
|
return pool.VerifyCertificate(time.Now(), c)
|
||||||
|
},
|
||||||
|
func() (uint32, error) { return 1, nil }, true, header.HandshakeIXPSK0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
packet, err := initiator.Initiate(nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
handler := &capturingHandler{}
|
||||||
|
logger := slog.New(handler)
|
||||||
|
pki := &PKI{}
|
||||||
|
pki.cs.Store(&CertState{initiatingVersion: cert.Version2, v2Credential: responderCredential})
|
||||||
|
pki.caPool.Store(pool)
|
||||||
|
hm := NewHandshakeManager(logger, nil, nil, nil, defaultHandshakeConfig)
|
||||||
|
hm.metricRejectedBlocklisted = metrics.NewCounter()
|
||||||
|
hm.f = &Interface{pki: pki, l: logger}
|
||||||
|
via := ViaSender{UdpAddr: netip.MustParseAddrPort("198.51.100.7:4242")}
|
||||||
|
|
||||||
|
hm.beginHandshake(via, packet, nil)
|
||||||
|
entry := findEntry(t, handler.entries, "Failed to process handshake packet")
|
||||||
|
assert.Equal(t, slog.LevelDebug, entry.Level)
|
||||||
|
require.ErrorIs(t, entry.Attrs["error"].(error), cert.ErrBlockListed)
|
||||||
|
assert.Equal(t, int64(1), hm.metricRejectedBlocklisted.Count())
|
||||||
|
|
||||||
|
handler.entries = nil
|
||||||
|
hm.beginHandshake(via, nil, nil)
|
||||||
|
entry = findEntry(t, handler.entries, "Failed to process handshake packet")
|
||||||
|
assert.Equal(t, slog.LevelError, entry.Level)
|
||||||
|
assert.Equal(t, int64(1), hm.metricRejectedBlocklisted.Count())
|
||||||
|
|
||||||
|
// The initiator sees the same rejection in continueHandshake, after a
|
||||||
|
// responder has accepted its first packet and sent a valid reply.
|
||||||
|
cleanPool := ct.NewTestCAPool(ca)
|
||||||
|
responder, err := handshake.NewMachine(cert.Version2,
|
||||||
|
func(cert.Version) *handshake.Credential { return responderCredential },
|
||||||
|
func(c cert.Certificate) (*cert.CachedCertificate, error) {
|
||||||
|
return cleanPool.VerifyCertificate(time.Now(), c)
|
||||||
|
},
|
||||||
|
func() (uint32, error) { return 2, nil }, false, header.HandshakeIXPSK0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
response, _, err := responder.ProcessPacket(nil, packet)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
responderFingerprint, err := responderCert.Fingerprint()
|
||||||
|
require.NoError(t, err)
|
||||||
|
pool.BlocklistFingerprint(responderFingerprint)
|
||||||
|
|
||||||
|
initiatingHM := NewHandshakeManager(logger, nil, nil, nil, defaultHandshakeConfig)
|
||||||
|
initiatingHM.metricRejectedBlocklisted = metrics.NewCounter()
|
||||||
|
initiatingHM.f = &Interface{l: logger}
|
||||||
|
hh := &HandshakeHostInfo{
|
||||||
|
machine: initiator,
|
||||||
|
hostinfo: &HostInfo{localIndexId: 1, vpnAddrs: []netip.Addr{netip.MustParseAddr("10.0.0.2")}},
|
||||||
|
}
|
||||||
|
initiatingHM.indexes[1] = hh
|
||||||
|
via.IsRelayed = true // skip the remote allow list before certificate validation
|
||||||
|
initiatingHM.continueHandshake(via, hh, response)
|
||||||
|
assert.Equal(t, int64(1), initiatingHM.metricRejectedBlocklisted.Count())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test_PendingHandshakeHasRemotes covers create-tunnel -address: a pending hostinfo must already
|
||||||
|
// carry its RemoteList when StartHandshake runs its callback, so SetRemote there, before the
|
||||||
|
// handshake loop has run, is safe and the address becomes one the handshake is sent to.
|
||||||
|
func Test_PendingHandshakeHasRemotes(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
mainHM := newHostMap(l)
|
||||||
|
preferredRanges := []netip.Prefix{}
|
||||||
|
mainHM.preferredRanges.Store(&preferredRanges)
|
||||||
|
|
||||||
|
hm := NewHandshakeManager(l, mainHM, newTestLighthouse(), &udp.NoopConn{}, defaultHandshakeConfig)
|
||||||
|
|
||||||
|
vpnIp := netip.MustParseAddr("172.1.1.2")
|
||||||
|
remote := netip.MustParseAddrPort("192.168.1.9:4242")
|
||||||
|
|
||||||
|
hi := hm.StartHandshake(vpnIp, func(hh *HandshakeHostInfo) {
|
||||||
|
require.NotNil(t, hh.hostinfo.remotes, "a pending handshake must never be without its RemoteList")
|
||||||
|
hh.hostinfo.SetRemote(remote)
|
||||||
|
})
|
||||||
|
assert.Contains(t, hi.remotes.CopyAddrs(preferredRanges), remote, "the handshake must be sent to the supplied remote")
|
||||||
|
assert.Equal(t, remote, hi.GetRemote())
|
||||||
|
|
||||||
|
// A RemoteList keeps one learned address per host, so a second remote replaces the
|
||||||
|
// first — the same behaviour change-remote has on an established tunnel.
|
||||||
|
other := netip.MustParseAddrPort("192.168.1.10:4242")
|
||||||
|
hi.SetRemote(other)
|
||||||
|
assert.Equal(t, []netip.AddrPort{other}, hi.remotes.CopyAddrs(preferredRanges))
|
||||||
|
assert.Equal(t, other, hi.GetRemote())
|
||||||
|
}
|
||||||
|
|
||||||
|
// newRemotesRaceFixture builds a handshake manager with an established tunnel to vpnAddr whose
|
||||||
|
// RemoteList is the lighthouse's cached list, the state every teardown-during-handshake race starts from.
|
||||||
|
func newRemotesRaceFixture(t *testing.T, vpnAddr netip.Addr) (*HandshakeManager, *Interface, *HostInfo) {
|
||||||
|
t.Helper()
|
||||||
|
l := test.NewLogger()
|
||||||
|
mainHM := newHostMap(l)
|
||||||
|
preferredRanges := []netip.Prefix{}
|
||||||
|
mainHM.preferredRanges.Store(&preferredRanges)
|
||||||
|
|
||||||
|
lh := newTestLighthouse()
|
||||||
|
hm := NewHandshakeManager(l, mainHM, lh, &udp.NoopConn{}, defaultHandshakeConfig)
|
||||||
|
f := &Interface{hostMap: mainHM, lightHouse: lh, handshakeManager: hm, l: l}
|
||||||
|
hm.f = f
|
||||||
|
|
||||||
|
established := &HostInfo{
|
||||||
|
vpnAddrs: []netip.Addr{vpnAddr},
|
||||||
|
localIndexId: 1,
|
||||||
|
remoteIndexId: 101,
|
||||||
|
remotes: lh.QueryCache([]netip.Addr{vpnAddr}),
|
||||||
|
HandshakePacket: map[uint8][]byte{},
|
||||||
|
}
|
||||||
|
mainHM.Lock()
|
||||||
|
mainHM.unlockedAddHostInfo(established, f)
|
||||||
|
mainHM.Unlock()
|
||||||
|
|
||||||
|
return hm, f, established
|
||||||
|
}
|
||||||
|
|
||||||
|
// With no handshake pending, tearing down the last tunnel still evicts the list.
|
||||||
|
func Test_CloseTunnelEvictsWithoutPendingHandshake(t *testing.T) {
|
||||||
|
vpnAddr := netip.MustParseAddr("172.1.1.2")
|
||||||
|
_, f, established := newRemotesRaceFixture(t, vpnAddr)
|
||||||
|
|
||||||
|
f.closeTunnel(established)
|
||||||
|
assert.NotContains(t, f.hostMap.Hosts, vpnAddr)
|
||||||
|
assert.NotContains(t, f.lightHouse.addrMap, vpnAddr)
|
||||||
|
}
|
||||||
@@ -24,6 +24,11 @@ type m = map[string]any
|
|||||||
const (
|
const (
|
||||||
Version uint8 = 1
|
Version uint8 = 1
|
||||||
Len = 16
|
Len = 16
|
||||||
|
|
||||||
|
// MaxOverhead is the most a payload grows on its way to the underlay.
|
||||||
|
// A relayed packet has two headers and two AEAD tags, one for the inner tunnel and another for the relay tunnel.
|
||||||
|
// Every supported cipher (today) has a 16 byte tag.
|
||||||
|
MaxOverhead = 2 * (Len + 16)
|
||||||
)
|
)
|
||||||
|
|
||||||
type MessageType uint8
|
type MessageType uint8
|
||||||
|
|||||||
+7
-63
@@ -6,7 +6,6 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net"
|
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"slices"
|
"slices"
|
||||||
"sync"
|
"sync"
|
||||||
@@ -18,7 +17,6 @@ import (
|
|||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
"github.com/slackhq/nebula/logging"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const defaultPromoteEvery = 1000 // Count of packets sent before we try moving a tunnel to a preferred underlay ip address
|
const defaultPromoteEvery = 1000 // Count of packets sent before we try moving a tunnel to a preferred underlay ip address
|
||||||
@@ -318,9 +316,9 @@ type cachedPacketMetrics struct {
|
|||||||
func NewHostMapFromConfig(l *slog.Logger, c *config.C) *HostMap {
|
func NewHostMapFromConfig(l *slog.Logger, c *config.C) *HostMap {
|
||||||
hm := newHostMap(l)
|
hm := newHostMap(l)
|
||||||
|
|
||||||
hm.reload(c, true)
|
hm.reload(c, true, nil)
|
||||||
c.RegisterReloadCallback(func(c *config.C) {
|
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||||
hm.reload(c, false)
|
hm.reload(c, false, r)
|
||||||
})
|
})
|
||||||
|
|
||||||
l.Info("Main HostMap created", "preferredRanges", hm.GetPreferredRanges())
|
l.Info("Main HostMap created", "preferredRanges", hm.GetPreferredRanges())
|
||||||
@@ -339,7 +337,8 @@ func newHostMap(l *slog.Logger) *HostMap {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (hm *HostMap) reload(c *config.C, initial bool) {
|
// r is nil on the initial load
|
||||||
|
func (hm *HostMap) reload(c *config.C, initial bool, r *config.Reload) {
|
||||||
if initial || c.HasChanged("preferred_ranges") {
|
if initial || c.HasChanged("preferred_ranges") {
|
||||||
var preferredRanges []netip.Prefix
|
var preferredRanges []netip.Prefix
|
||||||
rawPreferredRanges := c.GetStringSlice("preferred_ranges", []string{})
|
rawPreferredRanges := c.GetStringSlice("preferred_ranges", []string{})
|
||||||
@@ -350,8 +349,9 @@ func (hm *HostMap) reload(c *config.C, initial bool) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
hm.l.Warn("Failed to parse preferred ranges, ignoring",
|
hm.l.Warn("Failed to parse preferred ranges, ignoring",
|
||||||
"error", err,
|
"error", err,
|
||||||
"range", rawPreferredRanges,
|
"range", rawPreferredRange,
|
||||||
)
|
)
|
||||||
|
r.Failed()
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -930,59 +930,3 @@ func (i *HostInfo) logger(l *slog.Logger) *slog.Logger {
|
|||||||
|
|
||||||
return li
|
return li
|
||||||
}
|
}
|
||||||
|
|
||||||
// Utility functions
|
|
||||||
|
|
||||||
func localAddrs(l *slog.Logger, allowList *LocalAllowList) []netip.Addr {
|
|
||||||
//FIXME: This function is pretty garbage
|
|
||||||
var finalAddrs []netip.Addr
|
|
||||||
ifaces, _ := net.Interfaces()
|
|
||||||
for _, i := range ifaces {
|
|
||||||
allow := allowList.AllowName(i.Name)
|
|
||||||
if l.Enabled(context.Background(), logging.LevelTrace) {
|
|
||||||
l.Log(context.Background(), logging.LevelTrace, "localAllowList.AllowName",
|
|
||||||
"interfaceName", i.Name,
|
|
||||||
"allow", allow,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !allow {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
addrs, _ := i.Addrs()
|
|
||||||
for _, rawAddr := range addrs {
|
|
||||||
var addr netip.Addr
|
|
||||||
switch v := rawAddr.(type) {
|
|
||||||
case *net.IPNet:
|
|
||||||
//continue
|
|
||||||
addr, _ = netip.AddrFromSlice(v.IP)
|
|
||||||
case *net.IPAddr:
|
|
||||||
addr, _ = netip.AddrFromSlice(v.IP)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !addr.IsValid() {
|
|
||||||
if l.Enabled(context.Background(), slog.LevelDebug) {
|
|
||||||
l.Debug("addr was invalid", "localAddr", rawAddr)
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
addr = addr.Unmap()
|
|
||||||
|
|
||||||
if addr.IsLoopback() == false && addr.IsLinkLocalUnicast() == false {
|
|
||||||
isAllowed := allowList.Allow(addr)
|
|
||||||
if l.Enabled(context.Background(), logging.LevelTrace) {
|
|
||||||
l.Log(context.Background(), logging.LevelTrace, "localAllowList.Allow",
|
|
||||||
"localAddr", addr,
|
|
||||||
"allowed", isAllowed,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
if !isAllowed {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
finalAddrs = append(finalAddrs, addr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return finalAddrs
|
|
||||||
}
|
|
||||||
@@ -447,3 +447,16 @@ func TestHostInfo_markOutOnly(t *testing.T) {
|
|||||||
assert.True(t, h.markOut(6), "a relayed send must not consume the epoch edge")
|
assert.True(t, h.markOut(6), "a relayed send must not consume the epoch edge")
|
||||||
assert.False(t, h.markOut(6))
|
assert.False(t, h.markOut(6))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A preferred range that doesn't parse is skipped and the rest are used, the reload says one was skipped
|
||||||
|
func TestHostMap_reloadBadPreferredRangeFails(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
c := config.NewC(l)
|
||||||
|
require.NoError(t, c.LoadString("preferred_ranges: [10.0.0.0/8]\n"))
|
||||||
|
hm := NewHostMapFromConfig(l, c)
|
||||||
|
|
||||||
|
res := c.ReloadConfigString("preferred_ranges: [10.0.0.0/8, nope]\n")
|
||||||
|
require.NoError(t, res.Err)
|
||||||
|
assert.True(t, res.Failed)
|
||||||
|
assert.Equal(t, []netip.Prefix{netip.MustParsePrefix("10.0.0.0/8")}, hm.GetPreferredRanges())
|
||||||
|
}
|
||||||
+235
@@ -0,0 +1,235 @@
|
|||||||
|
package nebula
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/netip"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/cert"
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
)
|
||||||
|
|
||||||
|
type identityFlags struct {
|
||||||
|
Address string
|
||||||
|
|
||||||
|
// addressSet records that -address was given at all, so a line that left it out is
|
||||||
|
// told to pass it and one that passed it empty is told the value did not parse. Neither
|
||||||
|
// is answered with this node's identity, which is whoami's to report: a program
|
||||||
|
// passing a connection's remote address through must get an error for a value it
|
||||||
|
// failed to fill in, not the daemon's own identity to authorize against.
|
||||||
|
addressSet bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// setAddress is -address's setter. flag.Func rather than StringVar so that presence is
|
||||||
|
// known; its String is empty, which is what a client building a line from the schema
|
||||||
|
// sees as the default.
|
||||||
|
func (f *identityFlags) setAddress(v string) error {
|
||||||
|
f.Address = v
|
||||||
|
f.addressSet = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// hostIdentity is what identity reports: the identity a certificate asserts for a host,
|
||||||
|
// and nothing else. Every field is read from a certificate nebula verified when the
|
||||||
|
// tunnel came up, or from our own, which is what lets a program on this host make an
|
||||||
|
// authorization decision from it, within one limit. Nebula drops an inbound packet
|
||||||
|
// whose source address is not in the sender's certificate, and one with an overlay
|
||||||
|
// source address that arrived through a peer's unsafe network rather than from the node
|
||||||
|
// holding it, so for a connection that arrived on the nebula interface the source
|
||||||
|
// address is the sender's and this is the sender's identity. A connection that arrived
|
||||||
|
// on any other interface with an overlay source address was never checked by nebula at
|
||||||
|
// all, so a program authorizing on this answer should confirm the connection came in
|
||||||
|
// on the nebula interface. The field names are an API: the info API serves this shape
|
||||||
|
// to programs that were not built against nebula.
|
||||||
|
type hostIdentity struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
VpnAddrs []netip.Addr `json:"vpnAddrs"`
|
||||||
|
Networks []netip.Prefix `json:"networks"`
|
||||||
|
UnsafeNetworks []netip.Prefix `json:"unsafeNetworks"`
|
||||||
|
Groups []string `json:"groups"`
|
||||||
|
Fingerprint string `json:"fingerprint"`
|
||||||
|
Issuer string `json:"issuer"`
|
||||||
|
NotBefore time.Time `json:"notBefore"`
|
||||||
|
NotAfter time.Time `json:"notAfter"`
|
||||||
|
CertVersion int `json:"certVersion"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// runIdentity answers for whoever owns the address: this node, when it is one of ours, or
|
||||||
|
// the peer behind an established tunnel. The address is required. This node's own
|
||||||
|
// identity is whoami's to report, so a caller that failed to pass an address is told so
|
||||||
|
// rather than handed an identity it could mistake for its peer's.
|
||||||
|
func runIdentity(ifce *Interface, args *identityFlags, a []string) (commands.Result, error) {
|
||||||
|
// print-cert takes its address as an operand; this takes a flag, because the query
|
||||||
|
// string of the info API names its parameters and an operand has no name there. One
|
||||||
|
// spelling on every surface, so the mistake is named rather than ignored.
|
||||||
|
if len(a) > 0 {
|
||||||
|
return commands.Failed("identity takes the vpn addr as -address, not as an operand: identity -address %s", a[0]), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if !args.addressSet {
|
||||||
|
return commands.Failed("No vpn addr was provided, use -address <vpn addr>[:port]; whoami prints this node's own identity"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
vpnAddr, err := parseVpnAddrWithOptionalPort(args.Address)
|
||||||
|
if err != nil {
|
||||||
|
return commands.Failed("The provided vpn addr could not be parsed: %s", args.Address), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
crt, fingerprint := findCertificateForVpnAddr(ifce.pki.getCertState(), ifce.hostMap, vpnAddr)
|
||||||
|
if crt == nil {
|
||||||
|
return commands.NotFound("No active tunnel for vpn addr: %s", vpnAddr), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
id, err := newHostIdentity(crt, fingerprint)
|
||||||
|
if err != nil {
|
||||||
|
return commands.Result{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return commands.Value(id), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// runWhoami answers with this node's own identity, from its own certificate.
|
||||||
|
func runWhoami(ifce *Interface) (commands.Result, error) {
|
||||||
|
crt := ownCertificate(ifce.pki.getCertState())
|
||||||
|
if crt == nil {
|
||||||
|
return commands.Failed("No certificate is loaded"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
id, err := newHostIdentity(crt, "")
|
||||||
|
if err != nil {
|
||||||
|
return commands.Result{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return commands.Value(id), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// textIdentity is the human rendering, shared by every surface.
|
||||||
|
func textIdentity(id hostIdentity, w io.Writer) error {
|
||||||
|
_, err := fmt.Fprintf(w,
|
||||||
|
"name: %s\nvpn addrs: %s\nnetworks: %s\nunsafe networks: %s\ngroups: %s\nfingerprint: %s\nissuer: %s\nnot before: %s\nnot after: %s\ncert version: %d\n",
|
||||||
|
id.Name,
|
||||||
|
joinStringers(id.VpnAddrs),
|
||||||
|
joinStringers(id.Networks),
|
||||||
|
joinStringers(id.UnsafeNetworks),
|
||||||
|
strings.Join(id.Groups, ", "),
|
||||||
|
id.Fingerprint,
|
||||||
|
id.Issuer,
|
||||||
|
id.NotBefore.Format(time.RFC3339),
|
||||||
|
id.NotAfter.Format(time.RFC3339),
|
||||||
|
id.CertVersion,
|
||||||
|
)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func joinStringers[T fmt.Stringer](in []T) string {
|
||||||
|
parts := make([]string, 0, len(in))
|
||||||
|
for _, v := range in {
|
||||||
|
parts = append(parts, v.String())
|
||||||
|
}
|
||||||
|
return strings.Join(parts, ", ")
|
||||||
|
}
|
||||||
|
|
||||||
|
// newHostIdentity reads the identity out of a certificate. fingerprint is the
|
||||||
|
// certificate's when the caller already holds it, as a verified peer certificate does,
|
||||||
|
// and "" to have it hashed here. Slices are always allocated so a host with no groups
|
||||||
|
// reports [] rather than null.
|
||||||
|
func newHostIdentity(crt cert.Certificate, fingerprint string) (hostIdentity, error) {
|
||||||
|
if fingerprint == "" {
|
||||||
|
fp, err := crt.Fingerprint()
|
||||||
|
if err != nil {
|
||||||
|
return hostIdentity{}, err
|
||||||
|
}
|
||||||
|
fingerprint = fp
|
||||||
|
}
|
||||||
|
|
||||||
|
networks, unsafeNetworks, groups := crt.Networks(), crt.UnsafeNetworks(), crt.Groups()
|
||||||
|
id := hostIdentity{
|
||||||
|
Name: crt.Name(),
|
||||||
|
VpnAddrs: make([]netip.Addr, 0, len(networks)),
|
||||||
|
Networks: append(make([]netip.Prefix, 0, len(networks)), networks...),
|
||||||
|
UnsafeNetworks: append(make([]netip.Prefix, 0, len(unsafeNetworks)), unsafeNetworks...),
|
||||||
|
Groups: append(make([]string, 0, len(groups)), groups...),
|
||||||
|
Fingerprint: fingerprint,
|
||||||
|
Issuer: crt.Issuer(),
|
||||||
|
NotBefore: crt.NotBefore(),
|
||||||
|
NotAfter: crt.NotAfter(),
|
||||||
|
CertVersion: int(crt.Version()),
|
||||||
|
}
|
||||||
|
for _, n := range networks {
|
||||||
|
id.VpnAddrs = append(id.VpnAddrs, n.Addr())
|
||||||
|
}
|
||||||
|
|
||||||
|
return id, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ownCertificate is this node's certificate: the v2 one when it is loaded, else the v1.
|
||||||
|
// A v2 certificate is a superset of the v1 and may carry more networks, and it is the
|
||||||
|
// one newCertState builds myVpnAddrsTable from, so an address that matched that table is
|
||||||
|
// always listed in the certificate reported here. It is nil only when no certificate is
|
||||||
|
// loaded, which a running nebula never has.
|
||||||
|
func ownCertificate(cs *CertState) cert.Certificate {
|
||||||
|
if cs == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if crt := cs.getCertificate(cert.Version2); crt != nil {
|
||||||
|
return crt
|
||||||
|
}
|
||||||
|
return cs.getCertificate(cert.Version1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// findCertificateForVpnAddr answers who owns a vpn address: this node, from its own
|
||||||
|
// certificate state, since the hostmap never carries an entry for ourselves, or the peer
|
||||||
|
// behind an established tunnel. The certificate is nil when the address is unknown,
|
||||||
|
// when the tunnel is still pending and when it is mid teardown. A peer's comes with the
|
||||||
|
// fingerprint nebula computed when it verified the certificate; our own comes with "",
|
||||||
|
// since none is kept for it. identity and print-cert go through it, and the lighthouse's
|
||||||
|
// DNS TXT lookup through the two halves, so no surface disagrees about whose address it
|
||||||
|
// is; the TXT record alone keeps answering with the certificate handshakes start with.
|
||||||
|
func findCertificateForVpnAddr(cs *CertState, hostMap *HostMap, ip netip.Addr) (crt cert.Certificate, fingerprint string) {
|
||||||
|
if ownsVpnAddr(cs, ip) {
|
||||||
|
return ownCertificate(cs), ""
|
||||||
|
}
|
||||||
|
return peerCertificateForVpnAddr(hostMap, ip)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ownsVpnAddr reports whether ip is one of this node's own vpn addresses.
|
||||||
|
func ownsVpnAddr(cs *CertState, ip netip.Addr) bool {
|
||||||
|
return cs != nil && cs.myVpnAddrsTable != nil && cs.myVpnAddrsTable.Contains(ip)
|
||||||
|
}
|
||||||
|
|
||||||
|
// peerCertificateForVpnAddr is the certificate of the peer behind an established tunnel
|
||||||
|
// to ip, with the fingerprint nebula computed when it verified it, or nil when there is
|
||||||
|
// no such tunnel. See findCertificateForVpnAddr.
|
||||||
|
func peerCertificateForVpnAddr(hostMap *HostMap, ip netip.Addr) (crt cert.Certificate, fingerprint string) {
|
||||||
|
hostinfo := hostMap.QueryVpnAddr(ip)
|
||||||
|
if hostinfo == nil {
|
||||||
|
return nil, ""
|
||||||
|
}
|
||||||
|
|
||||||
|
cc := hostinfo.GetCert()
|
||||||
|
if cc == nil {
|
||||||
|
return nil, ""
|
||||||
|
}
|
||||||
|
|
||||||
|
return cc.Certificate, cc.Fingerprint
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseVpnAddrWithOptionalPort reads a vpn address alone or with a port,
|
||||||
|
// 192.168.100.7:54321 or [fd00::1]:443, so a program can pass a connection's remote
|
||||||
|
// address through as its runtime reported it. A 4in6 address (::ffff:a.b.c.d) is
|
||||||
|
// unmapped, which is how an IPv4 peer arrives on a dual stack listener, and a zone is
|
||||||
|
// dropped, since no vpn address carries one.
|
||||||
|
func parseVpnAddrWithOptionalPort(s string) (netip.Addr, error) {
|
||||||
|
ip, err := netip.ParseAddr(s)
|
||||||
|
if err != nil {
|
||||||
|
ap, err := netip.ParseAddrPort(s)
|
||||||
|
if err != nil {
|
||||||
|
return netip.Addr{}, err
|
||||||
|
}
|
||||||
|
ip = ap.Addr()
|
||||||
|
}
|
||||||
|
|
||||||
|
return ip.Unmap().WithZone(""), nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,223 @@
|
|||||||
|
package nebula
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"net/netip"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/cert"
|
||||||
|
"github.com/slackhq/nebula/cert_test"
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// identityFixture is an Interface with our own certificate loaded and one peer behind an
|
||||||
|
// established tunnel, which is all identity reads.
|
||||||
|
func identityFixture(t *testing.T) (*Interface, cert.Certificate) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
l := test.NewLogger()
|
||||||
|
me := netip.MustParseAddr("10.0.0.1")
|
||||||
|
peer := netip.MustParsePrefix("10.0.0.2/24")
|
||||||
|
|
||||||
|
ca, _, caKey, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||||
|
peerCert, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca, caKey, "peer", time.Time{}, time.Time{},
|
||||||
|
[]netip.Prefix{peer}, []netip.Prefix{netip.MustParsePrefix("192.168.1.0/24")}, []string{"web", "db"})
|
||||||
|
|
||||||
|
hm := newHostMap(l)
|
||||||
|
hm.Hosts[peer.Addr()] = &HostInfo{
|
||||||
|
vpnAddrs: []netip.Addr{peer.Addr()},
|
||||||
|
ConnectionState: &ConnectionState{peerCert: &cert.CachedCertificate{Certificate: peerCert}},
|
||||||
|
}
|
||||||
|
// A tunnel still handshaking has no certificate yet, and must not be reported.
|
||||||
|
hm.Hosts[netip.MustParseAddr("10.0.0.3")] = &HostInfo{
|
||||||
|
vpnAddrs: []netip.Addr{netip.MustParseAddr("10.0.0.3")},
|
||||||
|
ConnectionState: &ConnectionState{},
|
||||||
|
}
|
||||||
|
|
||||||
|
return &Interface{pki: newTestPKI(t, "me", []netip.Addr{me}), hostMap: hm}, peerCert
|
||||||
|
}
|
||||||
|
|
||||||
|
// identity runs the command with -address given as address.
|
||||||
|
func identity(t *testing.T, f *Interface, address string, operands ...string) commands.Result {
|
||||||
|
t.Helper()
|
||||||
|
fs := &identityFlags{}
|
||||||
|
require.NoError(t, fs.setAddress(address))
|
||||||
|
r, err := runIdentity(f, fs, operands)
|
||||||
|
require.NoError(t, err)
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// whoami runs the whoami command.
|
||||||
|
func whoami(t *testing.T, f *Interface) commands.Result {
|
||||||
|
t.Helper()
|
||||||
|
r, err := runWhoami(f)
|
||||||
|
require.NoError(t, err)
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWhoamiWithoutACertificateRefuses: no certificate is a refusal with the reason, as
|
||||||
|
// print-cert answers it, not an error a surface collapses to "command failed".
|
||||||
|
func TestWhoamiWithoutACertificateRefuses(t *testing.T) {
|
||||||
|
r := whoami(t, &Interface{pki: &PKI{}})
|
||||||
|
assert.False(t, r.OK)
|
||||||
|
assert.Equal(t, "No certificate is loaded", r.Reason)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWhoamiReportsThisNode(t *testing.T) {
|
||||||
|
f, _ := identityFixture(t)
|
||||||
|
|
||||||
|
r := whoami(t, f)
|
||||||
|
require.True(t, r.OK)
|
||||||
|
id, ok := r.Value.(hostIdentity)
|
||||||
|
require.True(t, ok, "got %T", r.Value)
|
||||||
|
assert.Equal(t, "me", id.Name)
|
||||||
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.0.0.1")}, id.VpnAddrs)
|
||||||
|
assert.Equal(t, 2, id.CertVersion)
|
||||||
|
assert.NotEmpty(t, id.Fingerprint)
|
||||||
|
assert.NotEmpty(t, id.Issuer)
|
||||||
|
|
||||||
|
// Our own address answers the same way: the hostmap never holds ourselves.
|
||||||
|
self := identity(t, f, "10.0.0.1")
|
||||||
|
assert.Equal(t, id, self.Value)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdentityReportsAPeerFromItsCertificate(t *testing.T) {
|
||||||
|
f, peerCert := identityFixture(t)
|
||||||
|
|
||||||
|
for _, addr := range []string{
|
||||||
|
"10.0.0.2",
|
||||||
|
"10.0.0.2:54321", // a connection's RemoteAddr, as a server has it
|
||||||
|
"::ffff:10.0.0.2", // the same peer seen through a dual stack listener
|
||||||
|
"[::ffff:10.0.0.2]:8", // and with a port
|
||||||
|
} {
|
||||||
|
r := identity(t, f, addr)
|
||||||
|
require.True(t, r.OK, "%s: %s", addr, r.Reason)
|
||||||
|
id := r.Value.(hostIdentity)
|
||||||
|
assert.Equal(t, "peer", id.Name, addr)
|
||||||
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.0.0.2")}, id.VpnAddrs, addr)
|
||||||
|
assert.Equal(t, []netip.Prefix{netip.MustParsePrefix("10.0.0.2/24")}, id.Networks, addr)
|
||||||
|
assert.Equal(t, []netip.Prefix{netip.MustParsePrefix("192.168.1.0/24")}, id.UnsafeNetworks, addr)
|
||||||
|
assert.Equal(t, []string{"web", "db"}, id.Groups, addr)
|
||||||
|
assert.Equal(t, peerCert.Issuer(), id.Issuer, addr)
|
||||||
|
assert.Equal(t, peerCert.NotAfter(), id.NotAfter, addr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestIdentityRefusals: the ways a lookup fails are told apart, because a program
|
||||||
|
// deciding whether to let a connection in treats them differently.
|
||||||
|
func TestIdentityRefusals(t *testing.T) {
|
||||||
|
f, _ := identityFixture(t)
|
||||||
|
|
||||||
|
unknown := identity(t, f, "10.0.0.9")
|
||||||
|
assert.False(t, unknown.OK)
|
||||||
|
assert.True(t, unknown.NotFound, "no tunnel is a not found")
|
||||||
|
assert.Equal(t, "No active tunnel for vpn addr: 10.0.0.9", unknown.Reason)
|
||||||
|
|
||||||
|
pending := identity(t, f, "10.0.0.3:1")
|
||||||
|
assert.True(t, pending.NotFound, "a tunnel without a certificate yet is not active")
|
||||||
|
assert.Equal(t, "No active tunnel for vpn addr: 10.0.0.3", pending.Reason, "the reason names the address, not the port")
|
||||||
|
|
||||||
|
garbage := identity(t, f, "not-an-address")
|
||||||
|
assert.False(t, garbage.OK)
|
||||||
|
assert.False(t, garbage.NotFound, "an address that does not parse is the caller's mistake")
|
||||||
|
assert.Equal(t, "The provided vpn addr could not be parsed: not-an-address", garbage.Reason)
|
||||||
|
|
||||||
|
// An address that was given and is empty is a caller that failed to fill it in, and
|
||||||
|
// must not be answered with our own identity.
|
||||||
|
empty := identity(t, f, "")
|
||||||
|
assert.False(t, empty.OK)
|
||||||
|
assert.False(t, empty.NotFound)
|
||||||
|
assert.Equal(t, "The provided vpn addr could not be parsed: ", empty.Reason)
|
||||||
|
|
||||||
|
operand := identity(t, f, "", "10.0.0.2")
|
||||||
|
assert.False(t, operand.OK)
|
||||||
|
assert.Contains(t, operand.Reason, "identity -address 10.0.0.2")
|
||||||
|
|
||||||
|
// No address at all is a caller that forgot the parameter, and is pointed at whoami
|
||||||
|
// rather than handed this node's identity.
|
||||||
|
omitted, err := runIdentity(f, &identityFlags{}, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.False(t, omitted.OK)
|
||||||
|
assert.False(t, omitted.NotFound)
|
||||||
|
assert.Contains(t, omitted.Reason, "-address")
|
||||||
|
assert.Contains(t, omitted.Reason, "whoami")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestOwnCertificatePrefersV2: with both versions loaded, the v2 certificate is the one
|
||||||
|
// myVpnAddrsTable is built from and may carry addresses the v1 does not, so it is the one
|
||||||
|
// whoami and an identity lookup of our own address report, whichever version handshakes
|
||||||
|
// are initiated with.
|
||||||
|
func TestOwnCertificatePrefersV2(t *testing.T) {
|
||||||
|
v4 := netip.MustParsePrefix("10.0.0.1/24")
|
||||||
|
ca1, _, caKey1, _ := cert_test.NewTestCaCert(cert.Version1, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||||
|
v1, _, _, _ := cert_test.NewTestCert(cert.Version1, cert.Curve_CURVE25519, ca1, caKey1, "me", time.Time{}, time.Time{}, []netip.Prefix{v4}, nil, nil)
|
||||||
|
ca2, _, caKey2, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
||||||
|
v2, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca2, caKey2, "me", time.Time{}, time.Time{},
|
||||||
|
[]netip.Prefix{v4, netip.MustParsePrefix("fd00::1/64")}, nil, nil)
|
||||||
|
|
||||||
|
assert.Nil(t, ownCertificate(nil))
|
||||||
|
assert.Equal(t, v1, ownCertificate(&CertState{v1Cert: v1, initiatingVersion: cert.Version1}))
|
||||||
|
assert.Equal(t, v2, ownCertificate(&CertState{v2Cert: v2, initiatingVersion: cert.Version2}))
|
||||||
|
assert.Equal(t, v2, ownCertificate(&CertState{v1Cert: v1, v2Cert: v2, initiatingVersion: cert.Version1}),
|
||||||
|
"the initiating version is v1, the reported certificate is still the v2")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestIdentityShapes pins the JSON a program reads and the text a person reads. The
|
||||||
|
// field names are an API served to programs not built against nebula.
|
||||||
|
func TestIdentityShapes(t *testing.T) {
|
||||||
|
f, _ := identityFixture(t)
|
||||||
|
r := identity(t, f, "10.0.0.2")
|
||||||
|
|
||||||
|
b, err := json.Marshal(r.Payload())
|
||||||
|
require.NoError(t, err)
|
||||||
|
var got map[string]any
|
||||||
|
require.NoError(t, json.Unmarshal(b, &got))
|
||||||
|
var keys []string
|
||||||
|
for k := range got {
|
||||||
|
keys = append(keys, k)
|
||||||
|
}
|
||||||
|
assert.ElementsMatch(t, []string{
|
||||||
|
"name", "vpnAddrs", "networks", "unsafeNetworks", "groups",
|
||||||
|
"fingerprint", "issuer", "notBefore", "notAfter", "certVersion",
|
||||||
|
}, keys)
|
||||||
|
|
||||||
|
// Empty lists marshal as [], never null.
|
||||||
|
self := whoami(t, f)
|
||||||
|
b, err = json.Marshal(self.Payload())
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, string(b), `"groups":[]`)
|
||||||
|
assert.Contains(t, string(b), `"unsafeNetworks":[]`)
|
||||||
|
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
require.NoError(t, commands.Render(&commands.Command{Name: commands.Identity, Text: commands.Typed(textIdentity)}, r, commands.FormatText, out))
|
||||||
|
assert.Contains(t, out.String(), "name: peer\n")
|
||||||
|
assert.Contains(t, out.String(), "vpn addrs: 10.0.0.2\n")
|
||||||
|
assert.Contains(t, out.String(), "groups: web, db\n")
|
||||||
|
assert.Contains(t, out.String(), "cert version: 2\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseVpnAddrWithOptionalPort(t *testing.T) {
|
||||||
|
for in, want := range map[string]string{
|
||||||
|
"10.0.0.2": "10.0.0.2",
|
||||||
|
"10.0.0.2:443": "10.0.0.2",
|
||||||
|
"fd00::1": "fd00::1",
|
||||||
|
"[fd00::1]:443": "fd00::1",
|
||||||
|
"::ffff:10.0.0.2": "10.0.0.2",
|
||||||
|
"[::ffff:10.0.0.2]:1": "10.0.0.2",
|
||||||
|
"fe80::1%eth0": "fe80::1",
|
||||||
|
} {
|
||||||
|
got, err := parseVpnAddrWithOptionalPort(in)
|
||||||
|
require.NoError(t, err, in)
|
||||||
|
assert.Equal(t, netip.MustParseAddr(want), got, in)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, in := range []string{"", "10.0.0.2:", ":443", "10.0.0", "example.com:80"} {
|
||||||
|
_, err := parseVpnAddrWithOptionalPort(in)
|
||||||
|
assert.Error(t, err, in)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -10,6 +10,7 @@ import (
|
|||||||
"github.com/slackhq/nebula/firewall"
|
"github.com/slackhq/nebula/firewall"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
"github.com/slackhq/nebula/iputil"
|
"github.com/slackhq/nebula/iputil"
|
||||||
|
"github.com/slackhq/nebula/logging"
|
||||||
"github.com/slackhq/nebula/noiseutil"
|
"github.com/slackhq/nebula/noiseutil"
|
||||||
"github.com/slackhq/nebula/overlay/batch"
|
"github.com/slackhq/nebula/overlay/batch"
|
||||||
"github.com/slackhq/nebula/overlay/tio"
|
"github.com/slackhq/nebula/overlay/tio"
|
||||||
@@ -198,8 +199,8 @@ func (f *Interface) sendInsideMessage(hostinfo *HostInfo, pkt tio.Packet, nb []b
|
|||||||
}
|
}
|
||||||
|
|
||||||
err = tio.SegmentSuperpacket(pkt, func(seg []byte) error {
|
err = tio.SegmentSuperpacket(pkt, func(seg []byte) error {
|
||||||
//relay header + header + plaintext + AEAD tag (16 bytes for both AES-GCM and ChaCha20-Poly1305) + relay tag
|
//relay header + header + plaintext + AEAD tag + relay tag
|
||||||
scratch := sendBatch.Reserve(header.Len + header.Len + len(seg) + 16 + 16)
|
scratch := sendBatch.Reserve(len(seg) + header.MaxOverhead)
|
||||||
|
|
||||||
innerPacket := f.sendInsideEncrypt(hostinfo, ci, seg, scratch[header.Len:], nb)
|
innerPacket := f.sendInsideEncrypt(hostinfo, ci, seg, scratch[header.Len:], nb)
|
||||||
if innerPacket == nil {
|
if innerPacket == nil {
|
||||||
@@ -517,7 +518,9 @@ func (f *Interface) SendVia(via *HostInfo, relay *Relay, ad, nb, out []byte, noc
|
|||||||
|
|
||||||
err = f.writers[q].WriteTo(toSend, via.GetRemote())
|
err = f.writers[q].WriteTo(toSend, via.GetRemote())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
via.logger(f.l).Info("Failed to WriteTo in sendVia", "error", err)
|
if l, ok := logging.RateLimited(f.l, f.udpRelayTxErrLimiter); ok {
|
||||||
|
via.logger(l).Info("Failed to WriteTo in sendVia", "error", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -526,16 +529,26 @@ func (f *Interface) sendNoMetrics(t header.MessageType, st header.MessageSubType
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
useRelay := !remote.IsValid() && !hostinfo.GetRemote().IsValid()
|
useRelay := !remote.IsValid() && !hostinfo.GetRemote().IsValid()
|
||||||
fullOut := out
|
|
||||||
|
|
||||||
|
// The encrypt appends to out in place and a relayed packet is then wrapped in place,
|
||||||
|
// so out has to fit the whole packet up front or the encrypt reallocates out from under SendVia.
|
||||||
|
// We cap the MTU of tun devices and routes we create ourselves, so only a host that set a bigger MTU than we allow gets here.
|
||||||
|
need := header.Len + len(p) + ci.eKey.Overhead()
|
||||||
if useRelay {
|
if useRelay {
|
||||||
if len(out) < header.Len {
|
// The relay tunnel runs the same cipher, and adds its own header and tag
|
||||||
// out always has a capacity of mtu, but not always a length greater than the header.Len.
|
need += header.Len + ci.eKey.Overhead()
|
||||||
// Grow it to make sure the next operation works.
|
|
||||||
out = out[:header.Len]
|
|
||||||
}
|
}
|
||||||
|
if cap(out) < need {
|
||||||
|
if l, ok := logging.RateLimited(f.l, f.txOversizeLimiter); ok {
|
||||||
|
hostinfo.logger(l).Error("Dropping outbound packet, out buffer not large enough", "outCap", cap(out), "payloadLen", len(p), "relayed", useRelay)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
fullOut := out
|
||||||
|
if useRelay {
|
||||||
// Save a header's worth of data at the front of the 'out' buffer.
|
// Save a header's worth of data at the front of the 'out' buffer.
|
||||||
out = out[header.Len:]
|
out = out[header.Len:header.Len]
|
||||||
}
|
}
|
||||||
|
|
||||||
if noiseutil.EncryptLockNeeded {
|
if noiseutil.EncryptLockNeeded {
|
||||||
@@ -582,19 +595,23 @@ func (f *Interface) sendNoMetrics(t header.MessageType, st header.MessageSubType
|
|||||||
if remote.IsValid() {
|
if remote.IsValid() {
|
||||||
err = f.writers[q].WriteTo(out, remote)
|
err = f.writers[q].WriteTo(out, remote)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
hostinfo.logger(f.l).Error("Failed to write outgoing packet",
|
if l, ok := logging.RateLimited(f.l, f.udpTxErrLimiter); ok {
|
||||||
|
hostinfo.logger(l).Error("Failed to write outgoing packet",
|
||||||
"error", err,
|
"error", err,
|
||||||
"udpAddr", remote,
|
"udpAddr", remote,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
} else if hr := hostinfo.GetRemote(); hr.IsValid() {
|
} else if hr := hostinfo.GetRemote(); hr.IsValid() {
|
||||||
err = f.writers[q].WriteTo(out, hr)
|
err = f.writers[q].WriteTo(out, hr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
hostinfo.logger(f.l).Error("Failed to write outgoing packet",
|
if l, ok := logging.RateLimited(f.l, f.udpTxErrLimiter); ok {
|
||||||
|
hostinfo.logger(l).Error("Failed to write outgoing packet",
|
||||||
"error", err,
|
"error", err,
|
||||||
"udpAddr", hr,
|
"udpAddr", hr,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
// Try to send via a relay
|
// Try to send via a relay
|
||||||
for _, relayIP := range hostinfo.relayState.CopyRelayIps() {
|
for _, relayIP := range hostinfo.relayState.CopyRelayIps() {
|
||||||
|
|||||||
+95
-37
@@ -24,6 +24,7 @@ import (
|
|||||||
"github.com/slackhq/nebula/overlay"
|
"github.com/slackhq/nebula/overlay"
|
||||||
"github.com/slackhq/nebula/overlay/batch"
|
"github.com/slackhq/nebula/overlay/batch"
|
||||||
"github.com/slackhq/nebula/overlay/tio"
|
"github.com/slackhq/nebula/overlay/tio"
|
||||||
|
"github.com/slackhq/nebula/ratelimit"
|
||||||
"github.com/slackhq/nebula/udp"
|
"github.com/slackhq/nebula/udp"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -123,6 +124,12 @@ type Interface struct {
|
|||||||
// reused (every udp.Conn ListenOut guarantees that ordering).
|
// reused (every udp.Conn ListenOut guarantees that ordering).
|
||||||
batchers []*batch.MultiCoalescer
|
batchers []*batch.MultiCoalescer
|
||||||
wg sync.WaitGroup
|
wg sync.WaitGroup
|
||||||
|
// readers covers just the listenIn and listenOut goroutines, wg also holds the construction token Close releases
|
||||||
|
readers sync.WaitGroup
|
||||||
|
|
||||||
|
udpTxErrLimiter *ratelimit.Limiter // udp direct transmit error log limiter
|
||||||
|
udpRelayTxErrLimiter *ratelimit.Limiter // udp relay transmit error log limiter
|
||||||
|
txOversizeLimiter *ratelimit.Limiter // oversized outbound packet drop log limiter
|
||||||
|
|
||||||
// fatalErr holds the first unexpected reader error that caused shutdown.
|
// fatalErr holds the first unexpected reader error that caused shutdown.
|
||||||
// nil means "no fatal error" (yet)
|
// nil means "no fatal error" (yet)
|
||||||
@@ -198,6 +205,19 @@ func NewInterface(ctx context.Context, c *InterfaceConfig) (*Interface, error) {
|
|||||||
return nil, errors.New("no connection manager")
|
return nil, errors.New("no connection manager")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
udpTxErrLimiter, err := ratelimit.New(1, time.Second)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
udpRelayTxErrLimiter, err := ratelimit.New(1, time.Second)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
txOversizeLimiter, err := ratelimit.New(1, time.Second)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
if c.routines <= 1 {
|
if c.routines <= 1 {
|
||||||
c.PinThreads = false //pinning is not useful unless there's more than one tun reader
|
c.PinThreads = false //pinning is not useful unless there's more than one tun reader
|
||||||
}
|
}
|
||||||
@@ -230,6 +250,9 @@ func NewInterface(ctx context.Context, c *InterfaceConfig) (*Interface, error) {
|
|||||||
conntrackCacheTimeout: c.ConntrackCacheTimeout,
|
conntrackCacheTimeout: c.ConntrackCacheTimeout,
|
||||||
cpuAffinity: c.CpuAffinity,
|
cpuAffinity: c.CpuAffinity,
|
||||||
pinThreads: c.PinThreads,
|
pinThreads: c.PinThreads,
|
||||||
|
udpTxErrLimiter: udpTxErrLimiter,
|
||||||
|
udpRelayTxErrLimiter: udpRelayTxErrLimiter,
|
||||||
|
txOversizeLimiter: txOversizeLimiter,
|
||||||
|
|
||||||
metricHandshakes: metrics.GetOrRegisterHistogram("handshakes", nil, metrics.NewExpDecaySample(1028, 0.015)),
|
metricHandshakes: metrics.GetOrRegisterHistogram("handshakes", nil, metrics.NewExpDecaySample(1028, 0.015)),
|
||||||
metricTxDropped: metrics.GetOrRegisterCounter("udp.tx.dropped", nil),
|
metricTxDropped: metrics.GetOrRegisterCounter("udp.tx.dropped", nil),
|
||||||
@@ -320,14 +343,18 @@ func (f *Interface) activate() error {
|
|||||||
func (f *Interface) run() {
|
func (f *Interface) run() {
|
||||||
// Launch n queues to read packets from udp
|
// Launch n queues to read packets from udp
|
||||||
for i := 0; i < f.routines; i++ {
|
for i := 0; i < f.routines; i++ {
|
||||||
|
f.readers.Add(1)
|
||||||
f.wg.Go(func() {
|
f.wg.Go(func() {
|
||||||
|
defer f.readers.Done()
|
||||||
f.listenOut(i)
|
f.listenOut(i)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Launch n queues to read packets from tun dev
|
// Launch n queues to read packets from tun dev
|
||||||
for i := 0; i < f.routines; i++ {
|
for i := 0; i < f.routines; i++ {
|
||||||
|
f.readers.Add(1)
|
||||||
f.wg.Go(func() {
|
f.wg.Go(func() {
|
||||||
|
defer f.readers.Done()
|
||||||
f.listenIn(f.queues[i], i)
|
f.listenIn(f.queues[i], i)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -488,10 +515,11 @@ func (f *Interface) flushSendBatch(sb *batch.SendBatch, q int) {
|
|||||||
|
|
||||||
func (f *Interface) RegisterConfigChangeCallbacks(c *config.C) {
|
func (f *Interface) RegisterConfigChangeCallbacks(c *config.C) {
|
||||||
c.RegisterReloadCallback(f.reloadFirewall)
|
c.RegisterReloadCallback(f.reloadFirewall)
|
||||||
c.RegisterReloadCallback(f.reloadSendRecvError)
|
for _, reload := range []func(*config.C){
|
||||||
c.RegisterReloadCallback(f.reloadAcceptRecvError)
|
f.reloadSendRecvError, f.reloadAcceptRecvError, f.reloadDisconnectInvalid, f.reloadMisc,
|
||||||
c.RegisterReloadCallback(f.reloadDisconnectInvalid)
|
} {
|
||||||
c.RegisterReloadCallback(f.reloadMisc)
|
c.RegisterReloadCallback(func(c *config.C, _ *config.Reload) { reload(c) })
|
||||||
|
}
|
||||||
|
|
||||||
for _, udpConn := range f.writers {
|
for _, udpConn := range f.writers {
|
||||||
c.RegisterReloadCallback(udpConn.ReloadConfig)
|
c.RegisterReloadCallback(udpConn.ReloadConfig)
|
||||||
@@ -508,18 +536,19 @@ func (f *Interface) reloadDisconnectInvalid(c *config.C) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Interface) reloadFirewall(c *config.C) {
|
func (f *Interface) reloadFirewall(c *config.C, r *config.Reload) {
|
||||||
cs := f.pki.getCertState()
|
cs := f.pki.getCertState()
|
||||||
curCert := cs.getCertificate(cert.Version2)
|
curCert := cs.getCertificate(cert.Version2)
|
||||||
if curCert == nil {
|
if curCert == nil {
|
||||||
curCert = cs.getCertificate(cert.Version1)
|
curCert = cs.getCertificate(cert.Version1)
|
||||||
}
|
}
|
||||||
|
|
||||||
// The firewall builds its routableNetworks set from the certificate's UnsafeNetworks at construction.
|
// Compare with what the running firewall was built from, not the last config, so a firewall that failed to build
|
||||||
// Check to see if that set has changed, and if so, rebuild the firewall.
|
// is tried again. The cert is the one this reload brought, PKI registers its reload callback before this one
|
||||||
certUnsafeChanged := curCert != nil && !slices.Equal(curCert.UnsafeNetworks(), f.firewall.unsafeNetworks)
|
src := c.Render("firewall")
|
||||||
|
if src != "" && src == f.firewall.source && curCert != nil &&
|
||||||
if !c.HasChanged("firewall") && !certUnsafeChanged {
|
slices.Equal(curCert.Networks(), f.firewall.assignedNetworks) &&
|
||||||
|
slices.Equal(curCert.UnsafeNetworks(), f.firewall.unsafeNetworks) {
|
||||||
f.l.Debug("No firewall config change detected")
|
f.l.Debug("No firewall config change detected")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -527,6 +556,7 @@ func (f *Interface) reloadFirewall(c *config.C) {
|
|||||||
fw, err := NewFirewallFromConfig(f.l, cs, c)
|
fw, err := NewFirewallFromConfig(f.l, cs, c)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
f.l.Error("Error while creating firewall during reload", "error", err)
|
f.l.Error("Error while creating firewall during reload", "error", err)
|
||||||
|
r.Failed()
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -624,17 +654,15 @@ func (f *Interface) reloadMisc(c *config.C) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Interface) emitStats(ctx context.Context, i time.Duration) {
|
// statsEmitter updates the interface's gauges, the stats server runs it on its capture loop.
|
||||||
ticker := time.NewTicker(i)
|
func (f *Interface) statsEmitter() func() {
|
||||||
defer ticker.Stop()
|
|
||||||
|
|
||||||
udpStats := udp.NewUDPStatsEmitter(f.writers)
|
udpStats := udp.NewUDPStatsEmitter(f.writers)
|
||||||
|
|
||||||
certExpirationGauge := metrics.GetOrRegisterGauge("certificate.ttl_seconds", nil)
|
certExpirationGauge := metrics.GetOrRegisterGauge("certificate.ttl_seconds", nil)
|
||||||
certInitiatingVersion := metrics.GetOrRegisterGauge("certificate.initiating_version", nil)
|
certInitiatingVersion := metrics.GetOrRegisterGauge("certificate.initiating_version", nil)
|
||||||
certMaxVersion := metrics.GetOrRegisterGauge("certificate.max_version", nil)
|
certMaxVersion := metrics.GetOrRegisterGauge("certificate.max_version", nil)
|
||||||
|
|
||||||
emit := func() {
|
return func() {
|
||||||
f.firewall.EmitStats()
|
f.firewall.EmitStats()
|
||||||
f.handshakeManager.EmitStats()
|
f.handshakeManager.EmitStats()
|
||||||
udpStats()
|
udpStats()
|
||||||
@@ -651,19 +679,6 @@ func (f *Interface) emitStats(ctx context.Context, i time.Duration) {
|
|||||||
certMaxVersion.Update(int64(certState.v1Cert.Version()))
|
certMaxVersion.Update(int64(certState.v1Cert.Version()))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Prime gauges so a Prometheus scrape that lands before the first tick
|
|
||||||
// sees real values instead of the zero defaults (issue #907).
|
|
||||||
emit()
|
|
||||||
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return
|
|
||||||
case <-ticker.C:
|
|
||||||
emit()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Interface) GetHostInfo(vpnIp netip.Addr) *HostInfo {
|
func (f *Interface) GetHostInfo(vpnIp netip.Addr) *HostInfo {
|
||||||
@@ -674,6 +689,14 @@ func (f *Interface) GetCertState() *CertState {
|
|||||||
return f.pki.getCertState()
|
return f.pki.getCertState()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// shutdowner is a udp.Conn or overlay.Device whose readers can be woken without releasing their fds
|
||||||
|
type shutdowner interface {
|
||||||
|
Shutdown() error
|
||||||
|
}
|
||||||
|
|
||||||
|
// readerShutdownTimeout bounds how long Close waits on woken readers before releasing their fds anyway
|
||||||
|
const readerShutdownTimeout = 5 * time.Second
|
||||||
|
|
||||||
// Close releases the interface's resources: the udp sockets and the tun device.
|
// Close releases the interface's resources: the udp sockets and the tun device.
|
||||||
// It is idempotent and safe to call at any point in the lifecycle, including on an interface that never activated,
|
// It is idempotent and safe to call at any point in the lifecycle, including on an interface that never activated,
|
||||||
// calls after the first return nil without doing anything.
|
// calls after the first return nil without doing anything.
|
||||||
@@ -683,20 +706,55 @@ func (f *Interface) Close() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
var errs []error
|
var errs []error
|
||||||
|
closeUdp := func(i int, u udp.Conn) {
|
||||||
// Release the udp readers
|
if err := u.Close(); err != nil {
|
||||||
for i, u := range f.writers {
|
|
||||||
err := u.Close()
|
|
||||||
if err != nil {
|
|
||||||
f.l.Error("Error while closing udp socket", "error", err, "writer", i)
|
f.l.Error("Error while closing udp socket", "error", err, "writer", i)
|
||||||
errs = append(errs, err)
|
errs = append(errs, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
closeTun := func() {
|
||||||
|
if err := f.inside.Close(); err != nil {
|
||||||
|
errs = append(errs, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Release the tun device (closing the tun also closes all readers)
|
// Wake every reader before releasing any fd, one that loops back into a syscall on a reused fd number never wakes.
|
||||||
closeErr := f.inside.Close()
|
// Anything without Shutdown is closed right away, as before.
|
||||||
if closeErr != nil {
|
var deferred []func()
|
||||||
errs = append(errs, closeErr)
|
for i, u := range f.writers {
|
||||||
|
if s, ok := u.(shutdowner); ok {
|
||||||
|
if err := s.Shutdown(); err != nil {
|
||||||
|
f.l.Error("Error while shutting down udp socket", "error", err, "writer", i)
|
||||||
|
errs = append(errs, err)
|
||||||
|
}
|
||||||
|
deferred = append(deferred, func() { closeUdp(i, u) })
|
||||||
|
} else {
|
||||||
|
closeUdp(i, u)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if s, ok := f.inside.(shutdowner); ok {
|
||||||
|
if err := s.Shutdown(); err != nil {
|
||||||
|
errs = append(errs, err)
|
||||||
|
}
|
||||||
|
deferred = append(deferred, closeTun)
|
||||||
|
} else {
|
||||||
|
closeTun()
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(deferred) > 0 {
|
||||||
|
readersDone := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
f.readers.Wait()
|
||||||
|
close(readersDone)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-readersDone:
|
||||||
|
case <-time.After(readerShutdownTimeout):
|
||||||
|
f.l.Warn("Readers did not stop, closing their fds anyway", "timeout", readerShutdownTimeout)
|
||||||
|
}
|
||||||
|
for _, closeFn := range deferred {
|
||||||
|
closeFn()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Release the construction token so waiters know the resources are gone
|
// Release the construction token so waiters know the resources are gone
|
||||||
|
|||||||
+5
-14
@@ -3,7 +3,6 @@
|
|||||||
package nebula
|
package nebula
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
@@ -18,11 +17,8 @@ import (
|
|||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Test_emitStats_primesGauges covers issue #907: a Prometheus scrape that
|
// Priming before the first tick (issue #907) is Start's job, see TestStatsServer_Start_primes.
|
||||||
// landed before the first ticker fire used to read 0 for the cert gauges.
|
func Test_statsEmitter_setsGauges(t *testing.T) {
|
||||||
// emitStats now primes the gauges before entering the ticker loop. We assert
|
|
||||||
// the gauge is zero before the first call and non-zero after.
|
|
||||||
func Test_emitStats_primesGauges(t *testing.T) {
|
|
||||||
defer metrics.DefaultRegistry.UnregisterAll()
|
defer metrics.DefaultRegistry.UnregisterAll()
|
||||||
|
|
||||||
l := test.NewLogger()
|
l := test.NewLogger()
|
||||||
@@ -56,17 +52,12 @@ func Test_emitStats_primesGauges(t *testing.T) {
|
|||||||
ifce.pki.cs.Store(cs)
|
ifce.pki.cs.Store(cs)
|
||||||
|
|
||||||
ttlGauge := metrics.GetOrRegisterGauge("certificate.ttl_seconds", nil)
|
ttlGauge := metrics.GetOrRegisterGauge("certificate.ttl_seconds", nil)
|
||||||
require.Zero(t, ttlGauge.Value(), "gauge should be zero before emitStats runs")
|
require.Zero(t, ttlGauge.Value(), "gauge should be zero before the emitter runs")
|
||||||
|
|
||||||
// Pre-cancel the context so emitStats returns after priming the gauges
|
ifce.statsEmitter()()
|
||||||
// without ever reading from ticker.C. The one hour interval is just a
|
|
||||||
// belt-and-suspenders, the test does not expect the ticker to fire.
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
cancel()
|
|
||||||
ifce.emitStats(ctx, time.Hour)
|
|
||||||
|
|
||||||
ttl := ttlGauge.Value()
|
ttl := ttlGauge.Value()
|
||||||
assert.Positive(t, ttl, "ttl gauge should be primed by emitStats before its first tick")
|
assert.Positive(t, ttl, "ttl gauge should be set by one run of the emitter")
|
||||||
assert.LessOrEqual(t, ttl, int64(3600))
|
assert.LessOrEqual(t, ttl, int64(3600))
|
||||||
assert.Equal(t, int64(cert.Version1), metrics.GetOrRegisterGauge("certificate.initiating_version", nil).Value())
|
assert.Equal(t, int64(cert.Version1), metrics.GetOrRegisterGauge("certificate.initiating_version", nil).Value())
|
||||||
assert.Equal(t, int64(cert.Version1), metrics.GetOrRegisterGauge("certificate.max_version", nil).Value())
|
assert.Equal(t, int64(cert.Version1), metrics.GetOrRegisterGauge("certificate.max_version", nil).Value())
|
||||||
|
|||||||
+81
-4
@@ -65,10 +65,10 @@ func TestReloadFirewall_CertUnsafeNetworksChanged(t *testing.T) {
|
|||||||
pki.cs.Store(&CertState{v2Cert: c2, initiatingVersion: cert.Version2})
|
pki.cs.Store(&CertState{v2Cert: c2, initiatingVersion: cert.Version2})
|
||||||
|
|
||||||
// Reload with the same YAML so HasChanged("firewall") reports false.
|
// Reload with the same YAML so HasChanged("firewall") reports false.
|
||||||
require.NoError(t, cfg.ReloadConfigString(rawYAML))
|
require.NoError(t, cfg.ReloadConfigString(rawYAML).Err)
|
||||||
require.False(t, cfg.HasChanged("firewall"))
|
require.False(t, cfg.HasChanged("firewall"))
|
||||||
|
|
||||||
f.reloadFirewall(cfg)
|
f.reloadFirewall(cfg, nil)
|
||||||
|
|
||||||
assert.NotSame(t, fw, f.firewall, "firewall pointer should have been replaced")
|
assert.NotSame(t, fw, f.firewall, "firewall pointer should have been replaced")
|
||||||
assert.Equal(t, newUnsafe, f.firewall.unsafeNetworks)
|
assert.Equal(t, newUnsafe, f.firewall.unsafeNetworks)
|
||||||
@@ -113,8 +113,85 @@ func TestReloadFirewall_NoChange(t *testing.T) {
|
|||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
|
|
||||||
require.NoError(t, cfg.ReloadConfigString(rawYAML))
|
require.NoError(t, cfg.ReloadConfigString(rawYAML).Err)
|
||||||
f.reloadFirewall(cfg)
|
f.reloadFirewall(cfg, nil)
|
||||||
|
|
||||||
assert.Same(t, fw, f.firewall, "firewall should not have been replaced")
|
assert.Same(t, fw, f.firewall, "firewall should not have been replaced")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Rules that don't parse keep the old firewall, and the reload says it could not apply them
|
||||||
|
func TestReloadFirewall_BadRulesFailTheReload(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
pki := &PKI{}
|
||||||
|
pki.cs.Store(&CertState{v2Cert: &dummyCert{version: cert.Version2, networks: []netip.Prefix{netip.MustParsePrefix("10.0.0.1/24")}}, initiatingVersion: cert.Version2})
|
||||||
|
|
||||||
|
rules := func(proto string) string {
|
||||||
|
return "firewall:\n outbound:\n - port: any\n proto: any\n host: any\n inbound:\n - port: any\n proto: " + proto + "\n host: any\n"
|
||||||
|
}
|
||||||
|
cfg := config.NewC(l)
|
||||||
|
require.NoError(t, cfg.LoadString(rules("any")))
|
||||||
|
fw, err := NewFirewallFromConfig(l, pki.getCertState(), cfg)
|
||||||
|
require.NoError(t, err)
|
||||||
|
f := &Interface{pki: pki, firewall: fw, l: l}
|
||||||
|
cfg.RegisterReloadCallback(f.reloadFirewall)
|
||||||
|
|
||||||
|
// The running firewall still isn't built from what the config asks for, so the same reload fails again
|
||||||
|
for range 2 {
|
||||||
|
res := cfg.ReloadConfigString(rules("nope"))
|
||||||
|
require.NoError(t, res.Err)
|
||||||
|
assert.True(t, res.Failed)
|
||||||
|
assert.Same(t, fw, f.firewall)
|
||||||
|
}
|
||||||
|
|
||||||
|
res := cfg.ReloadConfigString(rules("tcp"))
|
||||||
|
require.NoError(t, res.Err)
|
||||||
|
assert.False(t, res.Failed)
|
||||||
|
assert.NotSame(t, fw, f.firewall)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every input the firewall is built from rebuilds it when it changes, and nothing else does
|
||||||
|
func TestReloadFirewall_RebuildsOnAnyInput(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
networks := []netip.Prefix{netip.MustParsePrefix("10.0.0.1/24")}
|
||||||
|
base := "firewall:\n inbound:\n - port: any\n proto: any\n host: any\n"
|
||||||
|
setup := func() (*config.C, *Interface, *PKI) {
|
||||||
|
pki := &PKI{}
|
||||||
|
pki.cs.Store(&CertState{v2Cert: &dummyCert{version: cert.Version2, networks: networks}, initiatingVersion: cert.Version2})
|
||||||
|
cfg := config.NewC(l)
|
||||||
|
require.NoError(t, cfg.LoadString(base))
|
||||||
|
fw, err := NewFirewallFromConfig(l, pki.getCertState(), cfg)
|
||||||
|
require.NoError(t, err)
|
||||||
|
f := &Interface{pki: pki, firewall: fw, l: l}
|
||||||
|
cfg.RegisterReloadCallback(f.reloadFirewall)
|
||||||
|
return cfg, f, pki
|
||||||
|
}
|
||||||
|
setCert := func(pki *PKI, networks, unsafe []netip.Prefix) {
|
||||||
|
pki.cs.Store(&CertState{v2Cert: &dummyCert{version: cert.Version2, networks: networks, unsafeNetworks: unsafe}, initiatingVersion: cert.Version2})
|
||||||
|
}
|
||||||
|
|
||||||
|
cases := map[string]struct {
|
||||||
|
cfg string
|
||||||
|
cert func(*PKI)
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
"nothing": {base + "punchy:\n punch: true\n", nil, false},
|
||||||
|
"rules": {base + " outbound:\n - port: any\n proto: any\n host: any\n", nil, true},
|
||||||
|
"inbound_action": {base + " inbound_action: reject\n", nil, true},
|
||||||
|
"conntrack": {base + " conntrack:\n tcp_timeout: 1m\n", nil, true},
|
||||||
|
"networks": {base, func(p *PKI) { setCert(p, []netip.Prefix{netip.MustParsePrefix("10.0.0.2/24")}, nil) }, true},
|
||||||
|
"unsafe_networks": {base, func(p *PKI) { setCert(p, networks, []netip.Prefix{netip.MustParsePrefix("192.168.0.0/24")}) }, true},
|
||||||
|
}
|
||||||
|
for name, tc := range cases {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
cfg, f, pki := setup()
|
||||||
|
old := f.firewall
|
||||||
|
if tc.cert != nil {
|
||||||
|
tc.cert(pki)
|
||||||
|
}
|
||||||
|
res := cfg.ReloadConfigString(tc.cfg)
|
||||||
|
require.NoError(t, res.Err)
|
||||||
|
assert.False(t, res.Failed)
|
||||||
|
assert.Equal(t, tc.want, f.firewall != old)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
+3
-13
@@ -45,8 +45,7 @@ func setTransportChecksum4(packet []byte) {
|
|||||||
if ihl < ipv4.HeaderLen || end < ihl || end > len(packet) {
|
if ihl < ipv4.HeaderLen || end < ihl || end > len(packet) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
// The checksum covers the whole datagram, which a fragment (MF set or a
|
// do not attempt to set checksums for fragments
|
||||||
// non-zero offset) does not carry.
|
|
||||||
if binary.BigEndian.Uint16(packet[6:8])&0x3fff != 0 {
|
if binary.BigEndian.Uint16(packet[6:8])&0x3fff != 0 {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -68,10 +67,7 @@ func setTransportChecksum6(packet []byte) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// The checksum covers the whole datagram, which a fragment does not carry.
|
// we must find the transport header in order to write a checksum
|
||||||
// An unknown extension header hides where the transport header starts. A
|
|
||||||
// chain longer than the walk's budget ends it early, at an offset that was
|
|
||||||
// never checked against the packet.
|
|
||||||
proto, offset, _, anyFragment, err := IPv6FindUpperProtocol(packet[:end])
|
proto, offset, _, anyFragment, err := IPv6FindUpperProtocol(packet[:end])
|
||||||
if err != nil || anyFragment || offset >= end {
|
if err != nil || anyFragment || offset >= end {
|
||||||
return
|
return
|
||||||
@@ -109,8 +105,7 @@ func transportExtent(transport []byte, proto uint8) ([]byte, bool) {
|
|||||||
// writeTransportChecksum stores the checksum of transport, taken over the
|
// writeTransportChecksum stores the checksum of transport, taken over the
|
||||||
// pseudo-header sum csum, in the header's checksum field. A UDP checksum that
|
// pseudo-header sum csum, in the header's checksum field. A UDP checksum that
|
||||||
// computes to zero goes on the wire as 0xffff: zero means no checksum was
|
// computes to zero goes on the wire as 0xffff: zero means no checksum was
|
||||||
// computed (RFC 768), and over IPv6 the checksum is mandatory (RFC 8200
|
// computed (RFC 768), and over IPv6 the checksum is mandatory (RFC 8200 section 8.1).
|
||||||
// section 8.1).
|
|
||||||
func writeTransportChecksum(transport []byte, proto uint8, csum uint32) {
|
func writeTransportChecksum(transport []byte, proto uint8, csum uint32) {
|
||||||
var at, minLen int
|
var at, minLen int
|
||||||
switch proto {
|
switch proto {
|
||||||
@@ -133,11 +128,6 @@ func writeTransportChecksum(transport []byte, proto uint8, csum uint32) {
|
|||||||
binary.BigEndian.PutUint16(transport[at:], sum)
|
binary.BigEndian.PutUint16(transport[at:], sum)
|
||||||
}
|
}
|
||||||
|
|
||||||
// fold reduces a pseudo-header sum to the 16 bit seed Checksum takes. Carrying
|
|
||||||
// the high half back into the low half is what keeps the reduction lossless, so
|
|
||||||
// the seed sums exactly as the wider value would; 0xffff is its fixed point.
|
|
||||||
// Every term of that sum comes from a 16 bit field, so it stays far below the
|
|
||||||
// width at which the accumulator would wrap.
|
|
||||||
func fold(csum uint32) uint16 {
|
func fold(csum uint32) uint16 {
|
||||||
for csum > 0xffff {
|
for csum > 0xffff {
|
||||||
csum = (csum >> 16) + (csum & 0xffff)
|
csum = (csum >> 16) + (csum & 0xffff)
|
||||||
|
|||||||
+13
-16
@@ -345,14 +345,11 @@ func ipv6CreateRejectTCPPacket(packet []byte, out []byte, offset int) []byte {
|
|||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
// IPv6FindUpperProtocol walks the ipv6 extension header chain and returns the upper layer protocol, the
|
// IPv6FindUpperProtocol walks the ipv6 extension header chain and returns the upper layer protocol, the offset it begins at, and whether the packet is a non-first fragment.
|
||||||
// offset it begins at, and whether the packet is a non-first fragment. Only the RFC 8200 and IANA extension
|
// Only the RFC 8200 and IANA extension headers below are walked.
|
||||||
// headers below are walked. Everything else, including Mobility (135), HIP (139), Shim6 (140), experimental
|
// Everything else, including Mobility (135), HIP (139), Shim6 (140), experimental 253/254, and real upper layer protocols like SCTP or GRE, is terminal.
|
||||||
// 253/254, and real upper layer protocols like SCTP or GRE, is terminal. Walking those as extension headers
|
// For a non-first fragment the returned protocol is the fragmented protocol and offset points at the fragment header, there is no transport header to locate.
|
||||||
// is a firewall bypass, so they fail closed. For a non-first fragment the returned protocol is the fragmented
|
// Returns ErrIPv6CouldNotFindPayload if packet is smaller than an ipv6 header, or the chain is truncated, or if more than 8 extension headers are present.
|
||||||
// protocol and offset points at the fragment header, there is no transport header to locate. Returns
|
|
||||||
// ErrIPv6CouldNotFindPayload if packet is smaller than an ipv6 header or the chain is truncated before a
|
|
||||||
// terminal protocol is reached.
|
|
||||||
func IPv6FindUpperProtocol(packet []byte) (nextHeader uint8, offset int, isFragment bool, anyFragment bool, err error) {
|
func IPv6FindUpperProtocol(packet []byte) (nextHeader uint8, offset int, isFragment bool, anyFragment bool, err error) {
|
||||||
const maxIPv6ExtHeaders = 8
|
const maxIPv6ExtHeaders = 8
|
||||||
if len(packet) < ipv6.HeaderLen {
|
if len(packet) < ipv6.HeaderLen {
|
||||||
@@ -365,14 +362,14 @@ func IPv6FindUpperProtocol(packet []byte) (nextHeader uint8, offset int, isFragm
|
|||||||
switch nextHeader {
|
switch nextHeader {
|
||||||
case 0, 43, 60: // Hop-by-Hop, Routing, Destination
|
case 0, 43, 60: // Hop-by-Hop, Routing, Destination
|
||||||
if len(packet) < offset+2 {
|
if len(packet) < offset+2 {
|
||||||
return nextHeader, offset, isFragment, anyFragment, ErrIPv6CouldNotFindPayload
|
return 0, 0, false, false, ErrIPv6CouldNotFindPayload
|
||||||
}
|
}
|
||||||
nextHeader = packet[offset]
|
nextHeader = packet[offset]
|
||||||
offset += (int(packet[offset+1]) + 1) << 3
|
offset += (int(packet[offset+1]) + 1) << 3
|
||||||
|
|
||||||
case 44: // Fragment
|
case 44: // Fragment
|
||||||
if len(packet) < offset+8 {
|
if len(packet) < offset+8 {
|
||||||
return nextHeader, offset, isFragment, anyFragment, ErrIPv6CouldNotFindPayload
|
return 0, 0, false, false, ErrIPv6CouldNotFindPayload
|
||||||
}
|
}
|
||||||
anyFragment = true
|
anyFragment = true
|
||||||
// Non-first fragments carry no transport header, report the fragmented protocol and stop
|
// Non-first fragments carry no transport header, report the fragmented protocol and stop
|
||||||
@@ -384,21 +381,21 @@ func IPv6FindUpperProtocol(packet []byte) (nextHeader uint8, offset int, isFragm
|
|||||||
|
|
||||||
case 51: // AH
|
case 51: // AH
|
||||||
if len(packet) < offset+2 {
|
if len(packet) < offset+2 {
|
||||||
return nextHeader, offset, isFragment, anyFragment, ErrIPv6CouldNotFindPayload
|
return 0, 0, false, false, ErrIPv6CouldNotFindPayload
|
||||||
}
|
}
|
||||||
nextHeader = packet[offset]
|
nextHeader = packet[offset]
|
||||||
offset += (int(packet[offset+1]) + 2) << 2
|
offset += (int(packet[offset+1]) + 2) << 2
|
||||||
|
|
||||||
default:
|
default:
|
||||||
// A prior extension header can declare a length that advances offset past the packet. The terminal
|
|
||||||
// protocol's header isn't actually here, so treat the chain as truncated rather than classifying it.
|
|
||||||
if offset > len(packet) {
|
if offset > len(packet) {
|
||||||
return nextHeader, offset, isFragment, anyFragment, ErrIPv6CouldNotFindPayload
|
// A prior extension header can declare a length that advances offset past the packet, reject this.
|
||||||
|
return 0, 0, false, false, ErrIPv6CouldNotFindPayload
|
||||||
}
|
}
|
||||||
return nextHeader, offset, isFragment, anyFragment, nil
|
return nextHeader, offset, isFragment, anyFragment, nil //success!
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return nextHeader, offset, isFragment, anyFragment, nil
|
// Fail closed
|
||||||
|
return 0, 0, false, false, ErrIPv6CouldNotFindPayload
|
||||||
}
|
}
|
||||||
|
|
||||||
func CreateICMPEchoResponse(packet, out []byte) []byte {
|
func CreateICMPEchoResponse(packet, out []byte) []byte {
|
||||||
|
|||||||
+17
-5
@@ -529,6 +529,17 @@ func Test_IPv6FindUpperProtocol(t *testing.T) {
|
|||||||
firstFragToUDP := []byte{17, 0, 0, 1, 0, 0, 0, 1} // frag offset 0, M=1, next = UDP
|
firstFragToUDP := []byte{17, 0, 0, 1, 0, 0, 0, 1} // frag offset 0, M=1, next = UDP
|
||||||
nonFirstFrag := []byte{17, 0, 0, 9, 0, 0, 0, 1} // frag offset non-zero, next = UDP
|
nonFirstFrag := []byte{17, 0, 0, 9, 0, 0, 0, 1} // frag offset non-zero, next = UDP
|
||||||
transport := []byte{0, 80, 1, 187, 0, 0, 0, 0} // stand-in bytes, IPv6FindUpperProtocol never reads ports
|
transport := []byte{0, 80, 1, 187, 0, 0, 0, 0} // stand-in bytes, IPv6FindUpperProtocol never reads ports
|
||||||
|
extToHbH := []byte{0, 0, 0, 0, 0, 0, 0, 0} // len 0 -> 8 bytes, next = Hop-by-Hop
|
||||||
|
|
||||||
|
// 8 walked headers spend the budget before the 9th slot's terminal is ever classified. This is the
|
||||||
|
// report 4040546 shape: without failing closed the walk hands back offset 104, and a caller reads ports
|
||||||
|
// from the attacker's bytes there.
|
||||||
|
var budgetChain []byte
|
||||||
|
for range 7 {
|
||||||
|
budgetChain = append(budgetChain, extToHbH...)
|
||||||
|
}
|
||||||
|
budgetChain = append(budgetChain, extToTCP...)
|
||||||
|
budgetChain = append(budgetChain, transport...)
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
@@ -549,9 +560,10 @@ func Test_IPv6FindUpperProtocol(t *testing.T) {
|
|||||||
{"first fragment walks to transport", 44, append(firstFragToUDP, transport...), 17, ipv6.HeaderLen + 8, false, true, nil},
|
{"first fragment walks to transport", 44, append(firstFragToUDP, transport...), 17, ipv6.HeaderLen + 8, false, true, nil},
|
||||||
{"non-first fragment stops", 44, append(nonFirstFrag, transport...), 17, ipv6.HeaderLen, true, true, nil},
|
{"non-first fragment stops", 44, append(nonFirstFrag, transport...), 17, ipv6.HeaderLen, true, true, nil},
|
||||||
{"unknown protocol is terminal", 132, transport, 132, ipv6.HeaderLen, false, false, nil}, // SCTP
|
{"unknown protocol is terminal", 132, transport, 132, ipv6.HeaderLen, false, false, nil}, // SCTP
|
||||||
{"truncated extension header", 0, nil, 0, ipv6.HeaderLen, false, false, ErrIPv6CouldNotFindPayload},
|
{"truncated extension header", 0, nil, 0, 0, false, false, ErrIPv6CouldNotFindPayload},
|
||||||
// Destination Options with a declared length (255+1)*8 = 2048 that runs past the 48 byte buffer, next = SCTP
|
// Destination Options with a declared length (255+1)*8 = 2048 that runs past the 48 byte buffer, next = SCTP
|
||||||
{"extension length past buffer", 60, []byte{132, 255, 0, 0, 0, 0, 0, 0}, 132, ipv6.HeaderLen + 2048, false, false, ErrIPv6CouldNotFindPayload},
|
{"extension length past buffer", 0, []byte{132, 255, 0, 0, 0, 0, 0, 0}, 0, 0, false, false, ErrIPv6CouldNotFindPayload},
|
||||||
|
{"budget exhausted fails closed", 0, budgetChain, 0, 0, false, false, ErrIPv6CouldNotFindPayload},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
@@ -559,10 +571,10 @@ func Test_IPv6FindUpperProtocol(t *testing.T) {
|
|||||||
packet := makeIPv6Packet(src, dst, tt.nextHeader, tt.payload)
|
packet := makeIPv6Packet(src, dst, tt.nextHeader, tt.payload)
|
||||||
proto, offset, isFragment, anyFragment, err := IPv6FindUpperProtocol(packet)
|
proto, offset, isFragment, anyFragment, err := IPv6FindUpperProtocol(packet)
|
||||||
if tt.wantErr != nil {
|
if tt.wantErr != nil {
|
||||||
assert.ErrorIs(t, err, tt.wantErr)
|
require.ErrorIs(t, err, tt.wantErr)
|
||||||
return
|
} else {
|
||||||
}
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
}
|
||||||
assert.Equal(t, tt.wantProto, proto)
|
assert.Equal(t, tt.wantProto, proto)
|
||||||
assert.Equal(t, tt.wantOffset, offset)
|
assert.Equal(t, tt.wantOffset, offset)
|
||||||
assert.Equal(t, tt.wantFragment, isFragment)
|
assert.Equal(t, tt.wantFragment, isFragment)
|
||||||
|
|||||||
+93
-56
@@ -15,10 +15,12 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/gaissmai/bart"
|
"github.com/gaissmai/bart"
|
||||||
|
"github.com/rcrowley/go-metrics"
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
"github.com/slackhq/nebula/logging"
|
"github.com/slackhq/nebula/logging"
|
||||||
|
"github.com/slackhq/nebula/nicfinder"
|
||||||
"github.com/slackhq/nebula/udp"
|
"github.com/slackhq/nebula/udp"
|
||||||
"github.com/slackhq/nebula/util"
|
"github.com/slackhq/nebula/util"
|
||||||
)
|
)
|
||||||
@@ -34,12 +36,18 @@ type LightHouse struct {
|
|||||||
|
|
||||||
myVpnNetworks []netip.Prefix
|
myVpnNetworks []netip.Prefix
|
||||||
myVpnNetworksTable *bart.Lite
|
myVpnNetworksTable *bart.Lite
|
||||||
|
// myVpnAddrsTable contains our overlay host addrs, as opposed to the overlay networks
|
||||||
|
myVpnAddrsTable *bart.Lite
|
||||||
punchy *Punchy
|
punchy *Punchy
|
||||||
|
|
||||||
// localAddrsFn enumerates the underlay addresses we advertise. It is a field so tests can supply simulated
|
// localAddrsFn enumerates the underlay addresses we advertise. It is a field so tests can supply simulated
|
||||||
// addresses rather than whatever this machine's NICs happen to be. Set it before Start.
|
// addresses rather than whatever this machine's NICs happen to be. Set it before Start.
|
||||||
localAddrsFn func(*LocalAllowList) []netip.Addr
|
localAddrsFn func(*LocalAllowList) []netip.Addr
|
||||||
|
|
||||||
|
// lastLocalAddrsErr is the previous localAddrsFn failure. Enumeration runs on every update, so an
|
||||||
|
// unchanged failure is demoted to Debug rather than warning every lighthouse.interval forever.
|
||||||
|
lastLocalAddrsErr atomic.Pointer[string]
|
||||||
|
|
||||||
// Local cache of answers from light houses
|
// Local cache of answers from light houses
|
||||||
// map of vpn addr to answers
|
// map of vpn addr to answers
|
||||||
addrMap map[netip.Addr]*RemoteList
|
addrMap map[netip.Addr]*RemoteList
|
||||||
@@ -74,6 +82,8 @@ type LightHouse struct {
|
|||||||
|
|
||||||
updateTrigger chan struct{}
|
updateTrigger chan struct{}
|
||||||
queryChan chan netip.Addr
|
queryChan chan netip.Addr
|
||||||
|
// queryDropped counts queries QueryServer dropped because queryChan was full.
|
||||||
|
queryDropped metrics.Counter
|
||||||
|
|
||||||
calculatedRemotes atomic.Pointer[bart.Table[[]*calculatedRemote]] // Maps VpnAddr to []*calculatedRemote
|
calculatedRemotes atomic.Pointer[bart.Table[[]*calculatedRemote]] // Maps VpnAddr to []*calculatedRemote
|
||||||
|
|
||||||
@@ -104,15 +114,19 @@ func NewLightHouseFromConfig(ctx context.Context, l *slog.Logger, c *config.C, c
|
|||||||
amLighthouse: amLighthouse,
|
amLighthouse: amLighthouse,
|
||||||
myVpnNetworks: cs.myVpnNetworks,
|
myVpnNetworks: cs.myVpnNetworks,
|
||||||
myVpnNetworksTable: cs.myVpnNetworksTable,
|
myVpnNetworksTable: cs.myVpnNetworksTable,
|
||||||
|
myVpnAddrsTable: cs.myVpnAddrsTable,
|
||||||
addrMap: make(map[netip.Addr]*RemoteList),
|
addrMap: make(map[netip.Addr]*RemoteList),
|
||||||
nebulaPort: nebulaPort,
|
nebulaPort: nebulaPort,
|
||||||
punchy: p,
|
punchy: p,
|
||||||
updateTrigger: make(chan struct{}, 1),
|
updateTrigger: make(chan struct{}, 1),
|
||||||
queryChan: make(chan netip.Addr, c.GetUint32("handshakes.query_buffer", 64)),
|
queryChan: make(chan netip.Addr, c.GetUint32("handshakes.query_buffer", 1024)),
|
||||||
|
queryDropped: metrics.GetOrRegisterCounter("lighthouse.query.dropped", nil),
|
||||||
l: l,
|
l: l,
|
||||||
}
|
}
|
||||||
h.localAddrsFn = func(al *LocalAllowList) []netip.Addr {
|
h.localAddrsFn = func(al *LocalAllowList) []netip.Addr {
|
||||||
return localAddrs(h.l, al)
|
addrs, err := nicfinder.Find(ctx, h.l, al)
|
||||||
|
h.logLocalAddrsErr(err)
|
||||||
|
return addrs
|
||||||
}
|
}
|
||||||
|
|
||||||
lighthouses := make([]netip.Addr, 0)
|
lighthouses := make([]netip.Addr, 0)
|
||||||
@@ -124,18 +138,21 @@ func NewLightHouseFromConfig(ctx context.Context, l *slog.Logger, c *config.C, c
|
|||||||
h.metrics = newLighthouseMetrics()
|
h.metrics = newLighthouseMetrics()
|
||||||
}
|
}
|
||||||
|
|
||||||
err := h.reload(c, true)
|
err := h.reload(c, true, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
c.RegisterReloadCallback(func(c *config.C) {
|
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
|
||||||
err := h.reload(c, false)
|
r.RestartRequiredIfChanged("lighthouse.am_lighthouse", "listen.port", "handshakes.query_buffer", "stats.lighthouse_metrics")
|
||||||
|
err := h.reload(c, false, r)
|
||||||
switch v := err.(type) {
|
switch v := err.(type) {
|
||||||
case *util.ContextualError:
|
case *util.ContextualError:
|
||||||
v.Log(l)
|
v.Log(l)
|
||||||
|
r.Failed()
|
||||||
case error:
|
case error:
|
||||||
l.Error("failed to reload lighthouse", "error", err)
|
l.Error("failed to reload lighthouse", "error", err)
|
||||||
|
r.Failed()
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -176,7 +193,8 @@ func (lh *LightHouse) GetUpdateInterval() int64 {
|
|||||||
return lh.interval.Load()
|
return lh.interval.Load()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (lh *LightHouse) reload(c *config.C, initial bool) error {
|
// r is nil on the initial load
|
||||||
|
func (lh *LightHouse) reload(c *config.C, initial bool, r *config.Reload) error {
|
||||||
if initial || c.HasChanged("lighthouse.advertise_addrs") {
|
if initial || c.HasChanged("lighthouse.advertise_addrs") {
|
||||||
rawAdvAddrs := c.GetStringSlice("lighthouse.advertise_addrs", []string{})
|
rawAdvAddrs := c.GetStringSlice("lighthouse.advertise_addrs", []string{})
|
||||||
advAddrs := make([]netip.AddrPort, 0)
|
advAddrs := make([]netip.AddrPort, 0)
|
||||||
@@ -211,6 +229,7 @@ func (lh *LightHouse) reload(c *config.C, initial bool) error {
|
|||||||
"addr", rawAddr,
|
"addr", rawAddr,
|
||||||
"entry", i+1,
|
"entry", i+1,
|
||||||
)
|
)
|
||||||
|
r.Failed()
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -345,7 +364,13 @@ func (lh *LightHouse) reload(c *config.C, initial bool) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if initial || c.HasChanged("relay.relays") {
|
// am_relay decides whether relay.relays applies to us at all
|
||||||
|
if initial || c.HasChanged("relay.relays") || c.HasChanged("relay.am_relay") {
|
||||||
|
var before []netip.Addr
|
||||||
|
if !initial {
|
||||||
|
before = lh.GetRelaysForMe()
|
||||||
|
}
|
||||||
|
|
||||||
switch c.GetBool("relay.am_relay", false) {
|
switch c.GetBool("relay.am_relay", false) {
|
||||||
case true:
|
case true:
|
||||||
// Relays aren't allowed to specify other relays
|
// Relays aren't allowed to specify other relays
|
||||||
@@ -363,6 +388,7 @@ func (lh *LightHouse) reload(c *config.C, initial bool) error {
|
|||||||
"relay", v,
|
"relay", v,
|
||||||
"error", err,
|
"error", err,
|
||||||
)
|
)
|
||||||
|
r.Failed()
|
||||||
} else {
|
} else {
|
||||||
lh.l.Info("Read relay from config", "relay", v)
|
lh.l.Info("Read relay from config", "relay", v)
|
||||||
relaysForMe = append(relaysForMe, configRIP)
|
relaysForMe = append(relaysForMe, configRIP)
|
||||||
@@ -370,6 +396,11 @@ func (lh *LightHouse) reload(c *config.C, initial bool) error {
|
|||||||
}
|
}
|
||||||
lh.relaysForMe.Store(&relaysForMe)
|
lh.relaysForMe.Store(&relaysForMe)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Tell the lighthouses now rather than at the next interval, but only when what we advertise changed
|
||||||
|
if !initial && !slices.Equal(before, lh.GetRelaysForMe()) {
|
||||||
|
lh.TriggerUpdate()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -502,26 +533,33 @@ func (lh *LightHouse) Query(vpnAddr netip.Addr) *RemoteList {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// QueryServer is asynchronous so no reply should be expected
|
// QueryServer is asynchronous and non-blocking, no reply should be expected.
|
||||||
|
// If the query channel is full, the query is dropped.
|
||||||
func (lh *LightHouse) QueryServer(vpnAddr netip.Addr) {
|
func (lh *LightHouse) QueryServer(vpnAddr netip.Addr) {
|
||||||
// Don't put lighthouse addrs in the query channel because we can't query lighthouses about lighthouses
|
// Don't put lighthouse addrs in the query channel because we can't query lighthouses about lighthouses
|
||||||
if lh.amLighthouse || lh.IsLighthouseAddr(vpnAddr) {
|
if lh.amLighthouse || lh.IsLighthouseAddr(vpnAddr) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
lh.queryChan <- vpnAddr
|
select {
|
||||||
|
case lh.queryChan <- vpnAddr:
|
||||||
|
default:
|
||||||
|
lh.queryDropped.Inc(1)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (lh *LightHouse) QueryCache(vpnAddrs []netip.Addr) *RemoteList {
|
func (lh *LightHouse) QueryCache(vpnAddrs []netip.Addr) *RemoteList {
|
||||||
rl, ok := lh.findRemoteList(vpnAddrs)
|
lh.RLock()
|
||||||
if ok {
|
if v, ok := lh.addrMap[vpnAddrs[0]]; ok {
|
||||||
return rl
|
lh.RUnlock()
|
||||||
|
return v
|
||||||
}
|
}
|
||||||
|
lh.RUnlock()
|
||||||
|
|
||||||
lh.Lock()
|
lh.Lock()
|
||||||
defer lh.Unlock()
|
defer lh.Unlock()
|
||||||
// Add an entry if we don't already have one
|
// Add an entry if we don't already have one
|
||||||
return lh.unlockedGetRemoteList(vpnAddrs) //todo this re-calls unlockedFindRemoteList
|
return lh.unlockedGetRemoteList(vpnAddrs) //todo CERT-V2 this contains addrmap lookups we could potentially skip
|
||||||
}
|
}
|
||||||
|
|
||||||
// queryAndPrepMessage is a lock helper on RemoteList, assisting the caller to build a lighthouse message containing
|
// queryAndPrepMessage is a lock helper on RemoteList, assisting the caller to build a lighthouse message containing
|
||||||
@@ -667,58 +705,23 @@ func (lh *LightHouse) addCalculatedRemotes(vpnAddr netip.Addr) bool {
|
|||||||
return len(calculatedV4) > 0 || len(calculatedV6) > 0
|
return len(calculatedV4) > 0 || len(calculatedV6) > 0
|
||||||
}
|
}
|
||||||
|
|
||||||
func (lh *LightHouse) findRemoteList(vpnAddrs []netip.Addr) (*RemoteList, bool) {
|
|
||||||
lh.RLock()
|
|
||||||
defer lh.RUnlock()
|
|
||||||
return lh.unlockedFindRemoteList(vpnAddrs)
|
|
||||||
}
|
|
||||||
|
|
||||||
// unlockedFindRemoteList checks addrMap for each of vpnAddrs. It returns the first RemoteList found,
|
|
||||||
// and true if that RemoteList is present for all vpnAddrs.
|
|
||||||
// If false, it means the addrMap, and possibly the RemoteList, need to be corrected.
|
|
||||||
func (lh *LightHouse) unlockedFindRemoteList(vpnAddrs []netip.Addr) (*RemoteList, bool) {
|
|
||||||
var am *RemoteList
|
|
||||||
//todo: if a host with addresses A and B is "split", so it only has address A and a new host has only address B
|
|
||||||
//todo: we don't handly that correctly, I'm pretty sure.
|
|
||||||
missingOrDifferent := false
|
|
||||||
for _, addr := range vpnAddrs {
|
|
||||||
found, ok := lh.addrMap[addr]
|
|
||||||
if !ok {
|
|
||||||
missingOrDifferent = true
|
|
||||||
} else if am == nil {
|
|
||||||
am = found //the first list we find wins
|
|
||||||
} else if am != found {
|
|
||||||
missingOrDifferent = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return am, !missingOrDifferent
|
|
||||||
}
|
|
||||||
|
|
||||||
// unlockedGetRemoteList assumes you have the lh lock
|
// unlockedGetRemoteList assumes you have the lh lock
|
||||||
func (lh *LightHouse) unlockedGetRemoteList(allAddrs []netip.Addr) *RemoteList {
|
func (lh *LightHouse) unlockedGetRemoteList(allAddrs []netip.Addr) *RemoteList {
|
||||||
// before we go and make a new remotelist, we need to make sure we don't have one for any of this set of vpnaddrs yet
|
// before we go and make a new remotelist, we need to make sure we don't have one for any of this set of vpnaddrs yet
|
||||||
am, ok := lh.unlockedFindRemoteList(allAddrs)
|
for i, addr := range allAddrs {
|
||||||
|
am, ok := lh.addrMap[addr]
|
||||||
// we failed to find any RemoteLists: make a new one, fill out the addrMap
|
if ok {
|
||||||
if am == nil {
|
if i != 0 {
|
||||||
am = NewRemoteList(allAddrs, lh.shouldAdd)
|
lh.addrMap[allAddrs[0]] = am
|
||||||
for _, addr := range allAddrs {
|
|
||||||
lh.addrMap[addr] = am
|
|
||||||
}
|
}
|
||||||
return am
|
return am
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// we found one! Do we need to fix it?
|
am := NewRemoteList(allAddrs, lh.shouldAdd)
|
||||||
if !ok {
|
|
||||||
am.Lock()
|
|
||||||
am.vpnAddrs = make([]netip.Addr, len(allAddrs))
|
|
||||||
copy(am.vpnAddrs, allAddrs)
|
|
||||||
am.Unlock()
|
|
||||||
for _, addr := range allAddrs {
|
for _, addr := range allAddrs {
|
||||||
lh.addrMap[addr] = am
|
lh.addrMap[addr] = am
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
return am
|
return am
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -946,6 +949,26 @@ func (lh *LightHouse) TriggerUpdate() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// logLocalAddrsErr reports a localAddrs failure at Warn the first time it is seen and at Debug while
|
||||||
|
// it persists unchanged, so a permanent failure does not warn on every update forever.
|
||||||
|
func (lh *LightHouse) logLocalAddrsErr(err error) {
|
||||||
|
if err == nil {
|
||||||
|
lh.lastLocalAddrsErr.Store(nil)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
msg := err.Error()
|
||||||
|
prev := lh.lastLocalAddrsErr.Swap(&msg)
|
||||||
|
if prev != nil && *prev == msg {
|
||||||
|
if lh.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
|
lh.l.Debug("Failed to collect local addresses to advertise", "error", err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
lh.l.Warn("Failed to collect local addresses to advertise", "error", err)
|
||||||
|
}
|
||||||
|
|
||||||
func (lh *LightHouse) SendUpdate() {
|
func (lh *LightHouse) SendUpdate() {
|
||||||
var v4 []*V4AddrPort
|
var v4 []*V4AddrPort
|
||||||
var v6 []*V6AddrPort
|
var v6 []*V6AddrPort
|
||||||
@@ -1191,6 +1214,17 @@ func (lhh *LightHouseHandler) handleHostQuery(n *NebulaMeta, fromVpnAddrs []neti
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Don't respond to requests for us.
|
||||||
|
if lhh.lh.myVpnAddrsTable.Contains(queryVpnAddr) {
|
||||||
|
if lhh.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
|
lhh.l.Debug("Ignoring HostQuery for one of my own addresses",
|
||||||
|
"fromVpnAddrs", fromVpnAddrs,
|
||||||
|
"queryVpnAddr", queryVpnAddr,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
found, ln, err := lhh.lh.queryAndPrepMessage(queryVpnAddr, func(c *cache) (int, error) {
|
found, ln, err := lhh.lh.queryAndPrepMessage(queryVpnAddr, func(c *cache) (int, error) {
|
||||||
n = lhh.resetMeta()
|
n = lhh.resetMeta()
|
||||||
n.Type = NebulaMeta_HostQueryReply
|
n.Type = NebulaMeta_HostQueryReply
|
||||||
@@ -1227,10 +1261,13 @@ func (lhh *LightHouseHandler) handleHostQuery(n *NebulaMeta, fromVpnAddrs []neti
|
|||||||
// sendHostPunchNotification signals the other side to punch some zero byte udp packets
|
// sendHostPunchNotification signals the other side to punch some zero byte udp packets
|
||||||
func (lhh *LightHouseHandler) sendHostPunchNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, punchNotifDest netip.Addr, w EncWriter) {
|
func (lhh *LightHouseHandler) sendHostPunchNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, punchNotifDest netip.Addr, w EncWriter) {
|
||||||
whereToPunch := fromVpnAddrs[0]
|
whereToPunch := fromVpnAddrs[0]
|
||||||
|
// Resolve the target before taking the querier's RemoteList lock below. GetHostInfo takes the
|
||||||
|
// hostmap lock, and the hostmap is taken before the lighthouse, which is taken before a
|
||||||
|
// RemoteList, so looking it up inside the callback would deadlock.
|
||||||
|
targetHI := lhh.lh.ifce.GetHostInfo(punchNotifDest)
|
||||||
found, ln, err := lhh.lh.queryAndPrepMessage(whereToPunch, func(c *cache) (int, error) {
|
found, ln, err := lhh.lh.queryAndPrepMessage(whereToPunch, func(c *cache) (int, error) {
|
||||||
n = lhh.resetMeta()
|
n = lhh.resetMeta()
|
||||||
n.Type = NebulaMeta_HostPunchNotification
|
n.Type = NebulaMeta_HostPunchNotification
|
||||||
targetHI := lhh.lh.ifce.GetHostInfo(punchNotifDest)
|
|
||||||
var useVersion cert.Version
|
var useVersion cert.Version
|
||||||
if targetHI == nil {
|
if targetHI == nil {
|
||||||
useVersion = lhh.lh.ifce.GetCertState().initiatingVersion
|
useVersion = lhh.lh.ifce.GetCertState().initiatingVersion
|
||||||
|
|||||||
+346
-162
@@ -1,16 +1,21 @@
|
|||||||
package nebula
|
package nebula
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"encoding/binary"
|
"encoding/binary"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/gaissmai/bart"
|
"github.com/gaissmai/bart"
|
||||||
"github.com/slackhq/nebula/cert"
|
"github.com/slackhq/nebula/cert"
|
||||||
"github.com/slackhq/nebula/config"
|
"github.com/slackhq/nebula/config"
|
||||||
"github.com/slackhq/nebula/header"
|
"github.com/slackhq/nebula/header"
|
||||||
"github.com/slackhq/nebula/test"
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/slackhq/nebula/udp"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
"go.yaml.in/yaml/v3"
|
"go.yaml.in/yaml/v3"
|
||||||
@@ -27,15 +32,27 @@ func TestOldIPv4Only(t *testing.T) {
|
|||||||
assert.Equal(t, binary.BigEndian.Uint32(bp[:]), m.GetAddr())
|
assert.Equal(t, binary.BigEndian.Uint32(bp[:]), m.GetAddr())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func testCertState(networks ...netip.Prefix) *CertState {
|
||||||
|
cs := &CertState{
|
||||||
|
myVpnNetworks: networks,
|
||||||
|
myVpnNetworksTable: new(bart.Lite),
|
||||||
|
myVpnAddrs: make([]netip.Addr, 0, len(networks)),
|
||||||
|
myVpnAddrsTable: new(bart.Lite),
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, n := range networks {
|
||||||
|
cs.myVpnNetworksTable.Insert(n)
|
||||||
|
cs.myVpnAddrs = append(cs.myVpnAddrs, n.Addr())
|
||||||
|
cs.myVpnAddrsTable.Insert(netip.PrefixFrom(n.Addr(), n.Addr().BitLen()))
|
||||||
|
}
|
||||||
|
|
||||||
|
return cs
|
||||||
|
}
|
||||||
|
|
||||||
func Test_lhStaticMapping(t *testing.T) {
|
func Test_lhStaticMapping(t *testing.T) {
|
||||||
l := test.NewLogger()
|
l := test.NewLogger()
|
||||||
myVpnNet := netip.MustParsePrefix("10.128.0.1/16")
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/16")
|
||||||
nt := new(bart.Lite)
|
cs := testCertState(myVpnNet)
|
||||||
nt.Insert(myVpnNet)
|
|
||||||
cs := &CertState{
|
|
||||||
myVpnNetworks: []netip.Prefix{myVpnNet},
|
|
||||||
myVpnNetworksTable: nt,
|
|
||||||
}
|
|
||||||
lh1 := "10.128.0.2"
|
lh1 := "10.128.0.2"
|
||||||
|
|
||||||
c := config.NewC(l)
|
c := config.NewC(l)
|
||||||
@@ -55,12 +72,7 @@ func Test_lhStaticMapping(t *testing.T) {
|
|||||||
func TestReloadLighthouseInterval(t *testing.T) {
|
func TestReloadLighthouseInterval(t *testing.T) {
|
||||||
l := test.NewLogger()
|
l := test.NewLogger()
|
||||||
myVpnNet := netip.MustParsePrefix("10.128.0.1/16")
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/16")
|
||||||
nt := new(bart.Lite)
|
cs := testCertState(myVpnNet)
|
||||||
nt.Insert(myVpnNet)
|
|
||||||
cs := &CertState{
|
|
||||||
myVpnNetworks: []netip.Prefix{myVpnNet},
|
|
||||||
myVpnNetworksTable: nt,
|
|
||||||
}
|
|
||||||
lh1 := "10.128.0.2"
|
lh1 := "10.128.0.2"
|
||||||
|
|
||||||
c := config.NewC(l)
|
c := config.NewC(l)
|
||||||
@@ -75,27 +87,22 @@ func TestReloadLighthouseInterval(t *testing.T) {
|
|||||||
lh.ifce = &mockEncWriter{}
|
lh.ifce = &mockEncWriter{}
|
||||||
|
|
||||||
// The first one routine is kicked off by main.go currently, lets make sure that one dies
|
// The first one routine is kicked off by main.go currently, lets make sure that one dies
|
||||||
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 5"))
|
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 5").Err)
|
||||||
assert.Equal(t, int64(5), lh.interval.Load())
|
assert.Equal(t, int64(5), lh.interval.Load())
|
||||||
|
|
||||||
// Subsequent calls are killed off by the LightHouse.Reload function
|
// Subsequent calls are killed off by the LightHouse.Reload function
|
||||||
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 10"))
|
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 10").Err)
|
||||||
assert.Equal(t, int64(10), lh.interval.Load())
|
assert.Equal(t, int64(10), lh.interval.Load())
|
||||||
|
|
||||||
// If this completes then nothing is stealing our reload routine
|
// If this completes then nothing is stealing our reload routine
|
||||||
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 11"))
|
require.NoError(t, c.ReloadConfigString("lighthouse:\n interval: 11").Err)
|
||||||
assert.Equal(t, int64(11), lh.interval.Load())
|
assert.Equal(t, int64(11), lh.interval.Load())
|
||||||
}
|
}
|
||||||
|
|
||||||
func BenchmarkLighthouseHandleRequest(b *testing.B) {
|
func BenchmarkLighthouseHandleRequest(b *testing.B) {
|
||||||
l := test.NewLogger()
|
l := test.NewLogger()
|
||||||
myVpnNet := netip.MustParsePrefix("10.128.0.1/0")
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/0")
|
||||||
nt := new(bart.Lite)
|
cs := testCertState(myVpnNet)
|
||||||
nt.Insert(myVpnNet)
|
|
||||||
cs := &CertState{
|
|
||||||
myVpnNetworks: []netip.Prefix{myVpnNet},
|
|
||||||
myVpnNetworksTable: nt,
|
|
||||||
}
|
|
||||||
|
|
||||||
c := config.NewC(l)
|
c := config.NewC(l)
|
||||||
lh, err := NewLightHouseFromConfig(b.Context(), l, c, cs, nil, nil)
|
lh, err := NewLightHouseFromConfig(b.Context(), l, c, cs, nil, nil)
|
||||||
@@ -195,12 +202,7 @@ func TestLighthouse_Memory(t *testing.T) {
|
|||||||
c.Settings["listen"] = map[string]any{"port": 4242}
|
c.Settings["listen"] = map[string]any{"port": 4242}
|
||||||
|
|
||||||
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
||||||
nt := new(bart.Lite)
|
cs := testCertState(myVpnNet)
|
||||||
nt.Insert(myVpnNet)
|
|
||||||
cs := &CertState{
|
|
||||||
myVpnNetworks: []netip.Prefix{myVpnNet},
|
|
||||||
myVpnNetworksTable: nt,
|
|
||||||
}
|
|
||||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
||||||
lh.ifce = &mockEncWriter{}
|
lh.ifce = &mockEncWriter{}
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
@@ -280,12 +282,7 @@ func TestLighthouse_reload(t *testing.T) {
|
|||||||
c.Settings["listen"] = map[string]any{"port": 4242}
|
c.Settings["listen"] = map[string]any{"port": 4242}
|
||||||
|
|
||||||
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
||||||
nt := new(bart.Lite)
|
cs := testCertState(myVpnNet)
|
||||||
nt.Insert(myVpnNet)
|
|
||||||
cs := &CertState{
|
|
||||||
myVpnNetworks: []netip.Prefix{myVpnNet},
|
|
||||||
myVpnNetworksTable: nt,
|
|
||||||
}
|
|
||||||
|
|
||||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
@@ -299,7 +296,7 @@ func TestLighthouse_reload(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
c.ReloadConfigString(string(rc))
|
c.ReloadConfigString(string(rc))
|
||||||
|
|
||||||
err = lh.reload(c, false)
|
err = lh.reload(c, false, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -315,12 +312,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
||||||
nt := new(bart.Lite)
|
cs := testCertState(myVpnNet)
|
||||||
nt.Insert(myVpnNet)
|
|
||||||
cs := &CertState{
|
|
||||||
myVpnNetworks: []netip.Prefix{myVpnNet},
|
|
||||||
myVpnNetworksTable: nt,
|
|
||||||
}
|
|
||||||
|
|
||||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
@@ -342,7 +334,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err := yaml.Marshal(nc)
|
rc, err := yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||||
|
|
||||||
rl := lh.Query(staticHost)
|
rl := lh.Query(staticHost)
|
||||||
require.NotNil(t, rl)
|
require.NotNil(t, rl)
|
||||||
@@ -358,7 +350,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err = yaml.Marshal(nc)
|
rc, err = yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||||
|
|
||||||
rl = lh.Query(staticHost)
|
rl = lh.Query(staticHost)
|
||||||
require.NotNil(t, rl)
|
require.NotNil(t, rl)
|
||||||
@@ -366,7 +358,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
assert.Equal(t, []netip.AddrPort{netip.MustParseAddrPort("1.1.1.1:4242")}, rl.CopyAddrs([]netip.Prefix{}))
|
assert.Equal(t, []netip.AddrPort{netip.MustParseAddrPort("1.1.1.1:4242")}, rl.CopyAddrs([]netip.Prefix{}))
|
||||||
|
|
||||||
// Reload with the same config. An unchanged entry must not duplicate.
|
// Reload with the same config. An unchanged entry must not duplicate.
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||||
|
|
||||||
rl = lh.Query(staticHost)
|
rl = lh.Query(staticHost)
|
||||||
require.NotNil(t, rl)
|
require.NotNil(t, rl)
|
||||||
@@ -381,7 +373,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err = yaml.Marshal(nc)
|
rc, err = yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||||
|
|
||||||
// Add a second host alongside the first. Both should be present, neither duplicated.
|
// Add a second host alongside the first. Both should be present, neither duplicated.
|
||||||
nc = map[string]any{
|
nc = map[string]any{
|
||||||
@@ -392,7 +384,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err = yaml.Marshal(nc)
|
rc, err = yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||||
|
|
||||||
rl = lh.Query(staticHost)
|
rl = lh.Query(staticHost)
|
||||||
require.NotNil(t, rl)
|
require.NotNil(t, rl)
|
||||||
@@ -414,7 +406,7 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
}
|
}
|
||||||
rc, err = yaml.Marshal(nc)
|
rc, err = yaml.Marshal(nc)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NoError(t, c.ReloadConfigString(string(rc)))
|
require.NoError(t, c.ReloadConfigString(string(rc)).Err)
|
||||||
|
|
||||||
_, isStatic := lh.GetStaticHostList()[staticHost]
|
_, isStatic := lh.GetStaticHostList()[staticHost]
|
||||||
assert.False(t, isStatic)
|
assert.False(t, isStatic)
|
||||||
@@ -429,7 +421,9 @@ func TestLighthouse_reloadStaticHostMap(t *testing.T) {
|
|||||||
assert.Equal(t, []netip.AddrPort{netip.MustParseAddrPort("3.3.3.3:4242")}, rl.CopyAddrs([]netip.Prefix{}))
|
assert.Equal(t, []netip.AddrPort{netip.MustParseAddrPort("3.3.3.3:4242")}, rl.CopyAddrs([]netip.Prefix{}))
|
||||||
}
|
}
|
||||||
|
|
||||||
func newLHHostRequest(fromAddr netip.AddrPort, myVpnIp, queryVpnIp netip.Addr, lhh *LightHouseHandler) testLhReply {
|
// sendLHHostRequest delivers a HostQuery to lhh and hands back the writer that
|
||||||
|
// captured what it emitted. Pass a nil filter to see every message.
|
||||||
|
func sendLHHostRequest(fromAddr netip.AddrPort, myVpnIp, queryVpnIp netip.Addr, lhh *LightHouseHandler, filter *NebulaMeta_MessageType) *testEncWriter {
|
||||||
req := &NebulaMeta{
|
req := &NebulaMeta{
|
||||||
Type: NebulaMeta_HostQuery,
|
Type: NebulaMeta_HostQuery,
|
||||||
Details: &NebulaMetaDetails{},
|
Details: &NebulaMetaDetails{},
|
||||||
@@ -447,12 +441,59 @@ func newLHHostRequest(fromAddr netip.AddrPort, myVpnIp, queryVpnIp netip.Addr, l
|
|||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
filter := NebulaMeta_HostQueryReply
|
w := &testEncWriter{metaFilter: filter}
|
||||||
w := &testEncWriter{
|
|
||||||
metaFilter: &filter,
|
|
||||||
}
|
|
||||||
lhh.HandleRequest(fromAddr, []netip.Addr{myVpnIp}, b, w)
|
lhh.HandleRequest(fromAddr, []netip.Addr{myVpnIp}, b, w)
|
||||||
return w.lastReply
|
return w
|
||||||
|
}
|
||||||
|
|
||||||
|
func newLHHostRequest(fromAddr netip.AddrPort, myVpnIp, queryVpnIp netip.Addr, lhh *LightHouseHandler) testLhReply {
|
||||||
|
filter := NebulaMeta_HostQueryReply
|
||||||
|
return sendLHHostRequest(fromAddr, myVpnIp, queryVpnIp, lhh, &filter).lastReply
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLighthouse_IgnoresHostQueryForItself(t *testing.T) {
|
||||||
|
// Validate that we don't answer host queries for our own address.
|
||||||
|
l := test.NewLogger()
|
||||||
|
|
||||||
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
||||||
|
myVpnIp := myVpnNet.Addr()
|
||||||
|
|
||||||
|
c := config.NewC(l)
|
||||||
|
c.Settings["lighthouse"] = map[string]any{"am_lighthouse": true}
|
||||||
|
c.Settings["listen"] = map[string]any{"port": 4242}
|
||||||
|
// Add a static_host_map entry for ourselves, so our address
|
||||||
|
// is in the addrMap.
|
||||||
|
c.Settings["static_host_map"] = map[string]any{
|
||||||
|
myVpnIp.String(): []any{"192.168.100.1:4242"},
|
||||||
|
}
|
||||||
|
|
||||||
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(myVpnNet), nil, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
lh.ifce = &mockEncWriter{}
|
||||||
|
lhh := lh.NewRequestHandler()
|
||||||
|
|
||||||
|
peerVpnIp := netip.MustParseAddr("10.128.0.2")
|
||||||
|
peerUdpAddr := netip.MustParseAddrPort("10.0.0.2:4242")
|
||||||
|
otherVpnIp := netip.MustParseAddr("10.128.0.3")
|
||||||
|
otherUdpAddr := netip.MustParseAddrPort("10.0.0.3:4242")
|
||||||
|
|
||||||
|
newLHHostUpdate(peerUdpAddr, peerVpnIp, []netip.AddrPort{peerUdpAddr}, lhh)
|
||||||
|
newLHHostUpdate(otherUdpAddr, otherVpnIp, []netip.AddrPort{otherUdpAddr}, lhh)
|
||||||
|
|
||||||
|
// Control: a query about a real peer is still answered, and still ends with
|
||||||
|
// the punch notification aimed at the host that was asked about.
|
||||||
|
w := sendLHHostRequest(peerUdpAddr, peerVpnIp, otherVpnIp, lhh, nil)
|
||||||
|
require.NotNil(t, w.lastReply.msg)
|
||||||
|
assert.Equal(t, NebulaMeta_HostPunchNotification, w.lastReply.msg.Type)
|
||||||
|
assert.Equal(t, otherVpnIp, w.lastReply.vpnIp)
|
||||||
|
|
||||||
|
// Now validate that we don't send to ourselves.
|
||||||
|
found, _, err := lh.queryAndPrepMessage(myVpnIp, func(*cache) (int, error) { return 0, nil })
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.True(t, found, "the lighthouse should hold a cache entry for its own address")
|
||||||
|
|
||||||
|
w = sendLHHostRequest(peerUdpAddr, peerVpnIp, myVpnIp, lhh, nil)
|
||||||
|
assert.Nil(t, w.lastReply.msg, "a query about our own address must produce no reply and no punch notification")
|
||||||
}
|
}
|
||||||
|
|
||||||
func newLHHostUpdate(fromAddr netip.AddrPort, vpnIp netip.Addr, addrs []netip.AddrPort, lhh *LightHouseHandler) {
|
func newLHHostUpdate(fromAddr netip.AddrPort, vpnIp netip.Addr, addrs []netip.AddrPort, lhh *LightHouseHandler) {
|
||||||
@@ -642,12 +683,7 @@ func TestLighthouse_Dont_Delete_Static_Hosts(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
||||||
nt := new(bart.Lite)
|
cs := testCertState(myVpnNet)
|
||||||
nt.Insert(myVpnNet)
|
|
||||||
cs := &CertState{
|
|
||||||
myVpnNetworks: []netip.Prefix{myVpnNet},
|
|
||||||
myVpnNetworksTable: nt,
|
|
||||||
}
|
|
||||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
lh.ifce = &mockEncWriter{}
|
lh.ifce = &mockEncWriter{}
|
||||||
@@ -708,12 +744,7 @@ func TestLighthouse_DeletesWork(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
||||||
nt := new(bart.Lite)
|
cs := testCertState(myVpnNet)
|
||||||
nt.Insert(myVpnNet)
|
|
||||||
cs := &CertState{
|
|
||||||
myVpnNetworks: []netip.Prefix{myVpnNet},
|
|
||||||
myVpnNetworksTable: nt,
|
|
||||||
}
|
|
||||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
lh.ifce = &mockEncWriter{}
|
lh.ifce = &mockEncWriter{}
|
||||||
@@ -739,122 +770,275 @@ func TestLighthouse_DeletesWork(t *testing.T) {
|
|||||||
assert.Nil(t, out)
|
assert.Nil(t, out)
|
||||||
}
|
}
|
||||||
|
|
||||||
// newLHHostUpdateV2 sends a v2-style HostUpdateNotification where the sending tunnel carries
|
func TestLightHouse_logLocalAddrsErr(t *testing.T) {
|
||||||
// multiple vpn addrs (a dual-stack v2 cert). Details.VpnAddr is left blank like SendUpdate does.
|
out := &bytes.Buffer{}
|
||||||
func newLHHostUpdateV2(fromAddr netip.AddrPort, vpnAddrs []netip.Addr, addrs []netip.AddrPort, lhh *LightHouseHandler) {
|
lh := &LightHouse{l: test.NewLoggerWithOutput(out)}
|
||||||
req := &NebulaMeta{
|
|
||||||
Type: NebulaMeta_HostUpdateNotification,
|
// The first sighting of a failure warns.
|
||||||
Details: &NebulaMetaDetails{},
|
lh.logLocalAddrsErr(errors.New("permission denied"))
|
||||||
}
|
assert.Contains(t, out.String(), "level=WARN")
|
||||||
for _, v := range addrs {
|
assert.Contains(t, out.String(), "permission denied")
|
||||||
if v.Addr().Is4() {
|
|
||||||
req.Details.V4AddrPorts = append(req.Details.V4AddrPorts, netAddrToProtoV4AddrPort(v.Addr(), v.Port()))
|
// Repeating unchanged does not warn again, which is what keeps a permanent failure from warning
|
||||||
} else {
|
// on every lighthouse.interval for the life of the process.
|
||||||
req.Details.V6AddrPorts = append(req.Details.V6AddrPorts, netAddrToProtoV6AddrPort(v.Addr(), v.Port()))
|
out.Reset()
|
||||||
}
|
lh.logLocalAddrsErr(errors.New("permission denied"))
|
||||||
}
|
assert.NotContains(t, out.String(), "level=WARN")
|
||||||
b, err := req.Marshal()
|
|
||||||
if err != nil {
|
// A different failure is a new event and warns.
|
||||||
panic(err)
|
out.Reset()
|
||||||
}
|
lh.logLocalAddrsErr(errors.New("something else"))
|
||||||
lhh.HandleRequest(fromAddr, vpnAddrs, b, &testEncWriter{})
|
assert.Contains(t, out.String(), "level=WARN")
|
||||||
|
assert.Contains(t, out.String(), "something else")
|
||||||
|
|
||||||
|
// Recovering resets, so the same failure returning later warns again.
|
||||||
|
out.Reset()
|
||||||
|
lh.logLocalAddrsErr(nil)
|
||||||
|
assert.Empty(t, out.String())
|
||||||
|
lh.logLocalAddrsErr(errors.New("something else"))
|
||||||
|
assert.Contains(t, out.String(), "level=WARN")
|
||||||
}
|
}
|
||||||
|
|
||||||
func newIssue1868Lighthouse(t *testing.T) (*LightHouse, *LightHouseHandler) {
|
// heldEncWriter holds the query worker in its first GetHostInfo until release closes.
|
||||||
|
type heldEncWriter struct {
|
||||||
|
mockEncWriter
|
||||||
|
once sync.Once
|
||||||
|
held chan struct{}
|
||||||
|
release chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *heldEncWriter) GetHostInfo(netip.Addr) *HostInfo {
|
||||||
|
w.once.Do(func() { close(w.held) })
|
||||||
|
<-w.release
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueryServer never waits on the query worker, since the packet readers call it and nothing drains the channel at
|
||||||
|
// shutdown; a query that finds the channel full is dropped and counted. The worker is held on its first query so the
|
||||||
|
// channel fills.
|
||||||
|
func TestLighthouse_QueryServerDoesNotBlock(t *testing.T) {
|
||||||
l := test.NewLogger()
|
l := test.NewLogger()
|
||||||
|
cs := testCertState(netip.MustParsePrefix("10.128.0.1/16"))
|
||||||
|
lh1 := "10.128.0.2"
|
||||||
|
c := config.NewC(l)
|
||||||
|
c.Settings["lighthouse"] = map[string]any{"hosts": []any{lh1}}
|
||||||
|
c.Settings["static_host_map"] = map[string]any{lh1: []any{"1.1.1.1:4242"}}
|
||||||
|
c.Settings["handshakes"] = map[string]any{"query_buffer": 1}
|
||||||
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
w := &heldEncWriter{held: make(chan struct{}), release: make(chan struct{})}
|
||||||
|
lh.ifce = w
|
||||||
|
t.Cleanup(func() { close(w.release) })
|
||||||
|
|
||||||
|
lh.QueryServer(netip.MustParseAddr("10.128.0.10"))
|
||||||
|
select {
|
||||||
|
case <-w.held:
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("the query worker never took the first query")
|
||||||
|
}
|
||||||
|
dropped := lh.queryDropped.Count()
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
lh.QueryServer(netip.MustParseAddr("10.128.0.11"))
|
||||||
|
lh.QueryServer(netip.MustParseAddr("10.128.0.12"))
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("QueryServer blocked on a full query channel")
|
||||||
|
}
|
||||||
|
assert.EqualValues(t, 1, lh.queryDropped.Count()-dropped)
|
||||||
|
}
|
||||||
|
|
||||||
|
// hostmapEncWriter answers GetHostInfo from a real hostmap, the way Interface does.
|
||||||
|
type hostmapEncWriter struct {
|
||||||
|
mockEncWriter
|
||||||
|
hm *HostMap
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *hostmapEncWriter) GetHostInfo(a netip.Addr) *HostInfo { return w.hm.QueryVpnAddr(a) }
|
||||||
|
func (w *hostmapEncWriter) GetCertState() *CertState {
|
||||||
|
return &CertState{initiatingVersion: cert.Version1}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A lighthouse runs four paths that each hold one lock while waiting for the next: CheckAndComplete
|
||||||
|
// holds the hostmap and takes the handshake manager, StartHandshake holds the handshake manager and
|
||||||
|
// takes the lighthouse, a host update holds the lighthouse and takes the sender's RemoteList, and a
|
||||||
|
// punch notification holds the querier's RemoteList while it resolves the target. If that last step
|
||||||
|
// reaches the hostmap under the RemoteList lock, the four deadlock. Drive them all at once.
|
||||||
|
func TestLighthouse_PunchNotificationDoesNotCloseLockCycle(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
myVpnNet := netip.MustParsePrefix("10.128.0.1/24")
|
||||||
|
|
||||||
c := config.NewC(l)
|
c := config.NewC(l)
|
||||||
c.Settings["lighthouse"] = map[string]any{"am_lighthouse": true}
|
c.Settings["lighthouse"] = map[string]any{"am_lighthouse": true}
|
||||||
c.Settings["listen"] = map[string]any{"port": 4242}
|
c.Settings["listen"] = map[string]any{"port": 4242}
|
||||||
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(myVpnNet), nil, nil)
|
||||||
myVpnNet4 := netip.MustParsePrefix("10.128.0.1/24")
|
|
||||||
myVpnNet6 := netip.MustParsePrefix("fd00::1/64")
|
|
||||||
nt := new(bart.Lite)
|
|
||||||
nt.Insert(myVpnNet4)
|
|
||||||
nt.Insert(myVpnNet6)
|
|
||||||
cs := &CertState{
|
|
||||||
myVpnNetworks: []netip.Prefix{myVpnNet4, myVpnNet6},
|
|
||||||
myVpnNetworksTable: nt,
|
|
||||||
}
|
|
||||||
lh, err := NewLightHouseFromConfig(t.Context(), l, c, cs, nil, nil)
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
lh.ifce = &mockEncWriter{}
|
|
||||||
return lh, lh.NewRequestHandler()
|
mainHM := newHostMap(l)
|
||||||
|
pr := []netip.Prefix{}
|
||||||
|
mainHM.preferredRanges.Store(&pr)
|
||||||
|
lh.ifce = &hostmapEncWriter{hm: mainHM}
|
||||||
|
|
||||||
|
hm := NewHandshakeManager(l, mainHM, lh, &udp.NoopConn{}, defaultHandshakeConfig)
|
||||||
|
f := &Interface{hostMap: mainHM, lightHouse: lh, handshakeManager: hm, l: l}
|
||||||
|
hm.f = f
|
||||||
|
|
||||||
|
peer := netip.MustParseAddr("10.128.0.2")
|
||||||
|
peerUdp := netip.MustParseAddrPort("10.0.0.2:4242")
|
||||||
|
target := netip.MustParseAddr("10.128.0.3")
|
||||||
|
targetUdp := netip.MustParseAddrPort("10.0.0.3:4242")
|
||||||
|
outbound := netip.MustParseAddr("10.128.0.4")
|
||||||
|
inbound := netip.MustParseAddr("10.128.0.5")
|
||||||
|
|
||||||
|
seed := lh.NewRequestHandler()
|
||||||
|
newLHHostUpdate(peerUdp, peer, []netip.AddrPort{peerUdp}, seed)
|
||||||
|
newLHHostUpdate(targetUdp, target, []netip.AddrPort{targetUdp}, seed)
|
||||||
|
|
||||||
|
stop := make(chan struct{})
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
loop := func(body func()) {
|
||||||
|
defer wg.Done()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-stop:
|
||||||
|
return
|
||||||
|
default:
|
||||||
|
body()
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
wg.Add(4)
|
||||||
|
|
||||||
// Scenario A: host registers via v2 (both addrs), then a v1 handshake with the same host completes on
|
// Outbound handshakes keep starting and being dropped.
|
||||||
// the lighthouse (rehandshake after cert renewal, relay-initiated handshake, traffic to the LH's v4
|
go loop(func() {
|
||||||
// addr...). handshake_manager does QueryCache(vpnAddrs) + RefreshFromHandshake(vpnAddrs) with the v1
|
hm.DeleteHostInfo(hm.StartHandshake(outbound, nil))
|
||||||
// cert's single address, which truncates RemoteList.vpnAddrs.
|
})
|
||||||
func TestLighthouse_Issue1868_V1HandshakeTruncatesVpnAddrs(t *testing.T) {
|
|
||||||
lh, lhh := newIssue1868Lighthouse(t)
|
|
||||||
|
|
||||||
hostV4 := netip.MustParseAddr("10.128.0.3")
|
// Inbound handshakes keep completing and being torn down.
|
||||||
hostV6 := netip.MustParseAddr("fd00::3")
|
var idx uint32
|
||||||
hostUdp := netip.MustParseAddrPort("192.0.2.3:4242")
|
go loop(func() {
|
||||||
hostLan := netip.MustParseAddrPort("10.0.0.3:4242")
|
idx++
|
||||||
|
hi := &HostInfo{
|
||||||
|
vpnAddrs: []netip.Addr{inbound},
|
||||||
|
localIndexId: idx,
|
||||||
|
remoteIndexId: idx,
|
||||||
|
remotes: lh.QueryCache([]netip.Addr{inbound}),
|
||||||
|
HandshakePacket: map[uint8][]byte{handshakePacketStage0: {byte(idx)}},
|
||||||
|
}
|
||||||
|
if _, err := hm.CheckAndComplete(hi, handshakePacketStage0, f); err == nil {
|
||||||
|
mainHM.DeleteHostInfo(hi)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
askerV4 := netip.MustParseAddr("10.128.0.2")
|
// The peer keeps sending host updates.
|
||||||
askerUdp := netip.MustParseAddrPort("192.0.2.2:4242")
|
updates := lh.NewRequestHandler()
|
||||||
|
go loop(func() {
|
||||||
|
newLHHostUpdate(peerUdp, peer, []netip.AddrPort{peerUdp}, updates)
|
||||||
|
})
|
||||||
|
|
||||||
// Boot: host handshakes with the LH using its v2 cert and sends an update
|
// The same peer keeps querying for the target, which ends in a punch notification.
|
||||||
newLHHostUpdateV2(hostUdp, []netip.Addr{hostV4, hostV6}, []netip.AddrPort{hostLan}, lhh)
|
queries := lh.NewRequestHandler()
|
||||||
|
go loop(func() {
|
||||||
|
sendLHHostRequest(peerUdp, peer, target, queries, nil)
|
||||||
|
})
|
||||||
|
|
||||||
// Both addresses resolve
|
time.Sleep(time.Second)
|
||||||
r := newLHHostRequest(askerUdp, askerV4, hostV4, lhh)
|
close(stop)
|
||||||
require.NotNil(t, r.msg, "v4 query should be answered")
|
done := make(chan struct{})
|
||||||
assertIp4InArray(t, r.msg.Details.V4AddrPorts, hostLan)
|
go func() { wg.Wait(); close(done) }()
|
||||||
|
select {
|
||||||
r = newLHHostRequest(askerUdp, askerV4, hostV6, lhh)
|
case <-done:
|
||||||
require.NotNil(t, r.msg, "v6 query should be answered before the v1 handshake")
|
case <-time.After(5 * time.Second):
|
||||||
assertIp4InArray(t, r.msg.Details.V4AddrPorts, hostLan)
|
t.Fatal("deadlock: the lighthouse paths never finished after stop was signalled")
|
||||||
|
|
||||||
// Later: a v1 handshake with the same host completes on the LH. This is exactly what
|
|
||||||
// handshake_manager.go does on completion, with the v1 cert's single vpn addr.
|
|
||||||
rl := lh.QueryCache([]netip.Addr{hostV4})
|
|
||||||
rl.RefreshFromHandshake([]netip.Addr{hostV4}, cert.Version1)
|
|
||||||
|
|
||||||
// The host keeps sending v2 updates over its v2 tunnel too
|
|
||||||
newLHHostUpdateV2(hostUdp, []netip.Addr{hostV4, hostV6}, []netip.AddrPort{hostLan}, lhh)
|
|
||||||
|
|
||||||
r = newLHHostRequest(askerUdp, askerV4, hostV4, lhh)
|
|
||||||
require.NotNil(t, r.msg, "v4 query should still be answered")
|
|
||||||
assertIp4InArray(t, r.msg.Details.V4AddrPorts, hostLan)
|
|
||||||
|
|
||||||
r = newLHHostRequest(askerUdp, askerV4, hostV6, lhh)
|
|
||||||
if assert.NotNil(t, r.msg, "BUG: v6 query is silently dropped after a v1 handshake truncated RemoteList.vpnAddrs") {
|
|
||||||
assertIp4InArray(t, r.msg.Details.V4AddrPorts, hostLan)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Scenario B: the LH first creates a RemoteList for the host keyed only by its v4 addr (a pending
|
func TestLighthouse_reloadRelaysTriggersUpdate(t *testing.T) {
|
||||||
// LH-initiated v1 handshake does QueryCache([v4]) in handleOutbound), then the host arrives with v2.
|
l := test.NewLogger()
|
||||||
// unlockedGetRemoteList/QueryCache hit on allAddrs[0] and never add the v6 key to addrMap.
|
c := config.NewC(l)
|
||||||
func TestLighthouse_Issue1868_V4OnlyListNeverGainsV6Key(t *testing.T) {
|
base := "lighthouse:\n am_lighthouse: true\nlisten:\n port: 4242\n"
|
||||||
lh, lhh := newIssue1868Lighthouse(t)
|
require.NoError(t, c.LoadString(base+"relay:\n relays: [10.128.0.5]\n"))
|
||||||
|
|
||||||
hostV4 := netip.MustParseAddr("10.128.0.3")
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
||||||
hostV6 := netip.MustParseAddr("fd00::3")
|
require.NoError(t, err)
|
||||||
hostUdp := netip.MustParseAddrPort("192.0.2.3:4242")
|
assert.Empty(t, lh.updateTrigger)
|
||||||
hostLan := netip.MustParseAddrPort("10.0.0.3:4242")
|
|
||||||
|
|
||||||
askerV4 := netip.MustParseAddr("10.128.0.2")
|
require.NoError(t, c.ReloadConfigString(base+"relay:\n relays: [10.128.0.6]\n").Err)
|
||||||
askerUdp := netip.MustParseAddrPort("192.0.2.2:4242")
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.6")}, lh.GetRelaysForMe())
|
||||||
|
require.Len(t, lh.updateTrigger, 1)
|
||||||
|
<-lh.updateTrigger
|
||||||
|
|
||||||
// LH is a relay and someone asked it to relay to hostV4 while the host was offline:
|
// The config changed but what we advertise did not, a bad entry is skipped
|
||||||
// StartHandshake(hostV4) -> handleOutbound -> QueryCache([hostV4]) creates a v4-only list.
|
require.NoError(t, c.ReloadConfigString(base+"relay:\n relays: [10.128.0.6, nope]\n").Err)
|
||||||
_ = lh.QueryCache([]netip.Addr{hostV4})
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.6")}, lh.GetRelaysForMe())
|
||||||
|
assert.Empty(t, lh.updateTrigger)
|
||||||
// Host boots and handshakes v2 with the LH (responder path does QueryCache + RefreshFromHandshake)
|
|
||||||
rl := lh.QueryCache([]netip.Addr{hostV4, hostV6})
|
|
||||||
rl.RefreshFromHandshake([]netip.Addr{hostV4, hostV6}, cert.Version2)
|
|
||||||
newLHHostUpdateV2(hostUdp, []netip.Addr{hostV4, hostV6}, []netip.AddrPort{hostLan}, lhh)
|
|
||||||
|
|
||||||
r := newLHHostRequest(askerUdp, askerV4, hostV4, lhh)
|
|
||||||
require.NotNil(t, r.msg, "v4 query should be answered")
|
|
||||||
assertIp4InArray(t, r.msg.Details.V4AddrPorts, hostLan)
|
|
||||||
|
|
||||||
r = newLHHostRequest(askerUdp, askerV4, hostV6, lhh)
|
|
||||||
if assert.NotNil(t, r.msg, "BUG: v6 query is silently dropped, addrMap never got the v6 key") {
|
|
||||||
assertIp4InArray(t, r.msg.Details.V4AddrPorts, hostLan)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLighthouse_reloadAmRelayAlone(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
c := config.NewC(l)
|
||||||
|
base := "lighthouse:\n am_lighthouse: true\nlisten:\n port: 4242\nrelay:\n relays: [10.128.0.5]\n"
|
||||||
|
require.NoError(t, c.LoadString(base+" am_relay: false\n"))
|
||||||
|
|
||||||
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.5")}, lh.GetRelaysForMe())
|
||||||
|
|
||||||
|
// Relays aren't allowed to have relays, flipping am_relay alone must drop them and tell the lighthouses
|
||||||
|
require.NoError(t, c.ReloadConfigString(base+" am_relay: true\n").Err)
|
||||||
|
assert.Empty(t, lh.GetRelaysForMe())
|
||||||
|
require.Len(t, lh.updateTrigger, 1)
|
||||||
|
<-lh.updateTrigger
|
||||||
|
|
||||||
|
require.NoError(t, c.ReloadConfigString(base+" am_relay: false\n").Err)
|
||||||
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.5")}, lh.GetRelaysForMe())
|
||||||
|
require.Len(t, lh.updateTrigger, 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLighthouse_reloadRestartRequired(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
c := config.NewC(l)
|
||||||
|
base := "lighthouse:\n am_lighthouse: true\n"
|
||||||
|
require.NoError(t, c.LoadString(base+"listen:\n port: 4242\n"))
|
||||||
|
|
||||||
|
_, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
res := c.ReloadConfigString(base + "listen:\n port: 4242\n")
|
||||||
|
require.NoError(t, res.Err)
|
||||||
|
assert.False(t, res.RestartRequired)
|
||||||
|
res = c.ReloadConfigString(base + "listen:\n port: 4243\n")
|
||||||
|
require.NoError(t, res.Err)
|
||||||
|
assert.True(t, res.RestartRequired)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A relay that doesn't parse is skipped and the rest are used, the reload says one was skipped
|
||||||
|
func TestLighthouse_reloadBadRelayFails(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
c := config.NewC(l)
|
||||||
|
require.NoError(t, c.LoadString("listen:\n port: 4242\n"))
|
||||||
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
res := c.ReloadConfigString("listen:\n port: 4242\nrelay:\n relays: [10.128.0.2, nope]\n")
|
||||||
|
require.NoError(t, res.Err)
|
||||||
|
assert.True(t, res.Failed)
|
||||||
|
assert.Equal(t, []netip.Addr{netip.MustParseAddr("10.128.0.2")}, lh.GetRelaysForMe())
|
||||||
|
}
|
||||||
|
|
||||||
|
// An advertise_addrs entry inside our own network is skipped and the rest are used, the reload says one was skipped
|
||||||
|
func TestLighthouse_reloadAdvertiseAddrInNetworkFails(t *testing.T) {
|
||||||
|
l := test.NewLogger()
|
||||||
|
c := config.NewC(l)
|
||||||
|
require.NoError(t, c.LoadString("listen:\n port: 4242\n"))
|
||||||
|
lh, err := NewLightHouseFromConfig(t.Context(), l, c, testCertState(netip.MustParsePrefix("10.128.0.1/24")), nil, nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
res := c.ReloadConfigString("listen:\n port: 4242\nlighthouse:\n advertise_addrs: [\"1.2.3.4:4242\", \"10.128.0.5:4242\"]\n")
|
||||||
|
require.NoError(t, res.Err)
|
||||||
|
assert.True(t, res.Failed)
|
||||||
|
assert.Equal(t, []netip.AddrPort{netip.MustParseAddrPort("1.2.3.4:4242")}, lh.GetAdvertiseAddrs())
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Access is who may reach a socket beyond the account nebula runs as: the node's mode,
|
||||||
|
// and the group that shares the socket when the config names one.
|
||||||
|
//
|
||||||
|
// It is the dockerd model (-G): the operator names a group, nebula hands the socket to
|
||||||
|
// it, and who is in the group is managed outside nebula. On unix the mode is the
|
||||||
|
// socket node's and the group becomes its owning group; on windows the group is an
|
||||||
|
// entry in the pipe's security descriptor and the mode means nothing to a pipe.
|
||||||
|
type Access struct {
|
||||||
|
Mode os.FileMode
|
||||||
|
Group Group
|
||||||
|
}
|
||||||
|
|
||||||
|
// Group is a group named in the config, resolved to what the platform checks. The zero
|
||||||
|
// Group is none.
|
||||||
|
type Group struct {
|
||||||
|
// Name is what the config said.
|
||||||
|
Name string
|
||||||
|
|
||||||
|
// ID is the platform's identifier for it: a gid on unix, a SID on windows.
|
||||||
|
ID string
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ownerOnlyMode is a socket's mode when no group shares it: the account nebula runs
|
||||||
|
// as, and nobody else.
|
||||||
|
ownerOnlyMode os.FileMode = 0600
|
||||||
|
|
||||||
|
// groupSocketMode is the mode a socket takes when a group shares it and the config
|
||||||
|
// names no other: the account nebula runs as and the group, and nobody else.
|
||||||
|
groupSocketMode os.FileMode = 0660
|
||||||
|
)
|
||||||
|
|
||||||
|
// errReopenForAccess is returned by applyAccess on a platform whose access control is
|
||||||
|
// fixed when the endpoint is created, so a change means creating it again.
|
||||||
|
var errReopenForAccess = errors.New("access is fixed at listen time")
|
||||||
|
|
||||||
|
// ownerOnly is the control socket's access when no group is configured. The mode
|
||||||
|
// itself is not configurable there; what an operator can choose is a group,
|
||||||
|
// CtlGroupKey, which makes it groupSocketMode.
|
||||||
|
func ownerOnly() Access { return Access{Mode: ownerOnlyMode} }
|
||||||
|
|
||||||
|
// shared reports whether a group shares the socket.
|
||||||
|
func (a Access) shared() bool { return a.Group.ID != "" }
|
||||||
|
|
||||||
|
// String renders the access for a log line.
|
||||||
|
func (a Access) String() string {
|
||||||
|
if !a.shared() {
|
||||||
|
return modeString(a.Mode)
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("%s group %s (%s)", modeString(a.Mode), a.Group.Name, a.Group.ID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// groupFromConfig reads the group a key names, the zero Group when it names none. The
|
||||||
|
// name is resolved here, when the config is read, so a group that does not exist is a
|
||||||
|
// config error reported with the key rather than a bind that fails later.
|
||||||
|
func groupFromConfig(c interface{ GetString(string, string) string }, key string) (Group, error) {
|
||||||
|
name := c.GetString(key, "")
|
||||||
|
if name == "" {
|
||||||
|
return Group{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
id, err := lookupGroupID(name)
|
||||||
|
if err != nil {
|
||||||
|
return Group{}, fmt.Errorf("%s: %w", key, err)
|
||||||
|
}
|
||||||
|
return Group{Name: name, ID: id}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func modeString(m os.FileMode) string {
|
||||||
|
return fmt.Sprintf("%04o", m)
|
||||||
|
}
|
||||||
@@ -0,0 +1,208 @@
|
|||||||
|
//go:build !windows
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"os/user"
|
||||||
|
"strconv"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/config"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"golang.org/x/sys/unix"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ownGroup returns a group this process may hand a socket to: its own effective group,
|
||||||
|
// by name and by gid, which is the one chown accepts from an unprivileged user.
|
||||||
|
func ownGroup(t *testing.T) (name, gid string) {
|
||||||
|
t.Helper()
|
||||||
|
gid = strconv.Itoa(os.Getegid())
|
||||||
|
g, err := user.LookupGroupId(gid)
|
||||||
|
require.NoError(t, err)
|
||||||
|
return g.Name, gid
|
||||||
|
}
|
||||||
|
|
||||||
|
func socketGroup(t *testing.T, path string) uint32 {
|
||||||
|
t.Helper()
|
||||||
|
fi, err := os.Lstat(path)
|
||||||
|
require.NoError(t, err)
|
||||||
|
st, ok := fi.Sys().(*syscall.Stat_t)
|
||||||
|
require.True(t, ok)
|
||||||
|
return uint32(st.Gid)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestLookupGroupID: a group is named as the host names it or by its gid; a gid the
|
||||||
|
// host does not list is accepted as chown would accept it, and a name it does not list
|
||||||
|
// is a mistake to report.
|
||||||
|
func TestLookupGroupID(t *testing.T) {
|
||||||
|
name, gid := ownGroup(t)
|
||||||
|
|
||||||
|
got, err := lookupGroupID(name)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, gid, got)
|
||||||
|
|
||||||
|
got, err = lookupGroupID(gid)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, gid, got)
|
||||||
|
|
||||||
|
got, err = lookupGroupID("4000000000")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "4000000000", got)
|
||||||
|
|
||||||
|
_, err = lookupGroupID("no-such-group-nebula-test")
|
||||||
|
require.ErrorContains(t, err, "does not exist")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestControlAccessFromConfig: no group is the owner-only socket; a group is 0660 with
|
||||||
|
// that group; a group the host does not know is a config error naming the key.
|
||||||
|
func TestControlAccessFromConfig(t *testing.T) {
|
||||||
|
name, gid := ownGroup(t)
|
||||||
|
load := func(body string) (Access, error) {
|
||||||
|
c := config.NewC(test.NewLogger())
|
||||||
|
require.NoError(t, c.LoadString(body))
|
||||||
|
return controlAccessFrom(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
acc, err := load("local_api: {}\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, ownerOnly(), acc)
|
||||||
|
|
||||||
|
acc, err = load("local_api:\n control:\n group: " + name + "\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, os.FileMode(0660), acc.Mode)
|
||||||
|
assert.Equal(t, name, acc.Group.Name)
|
||||||
|
assert.Equal(t, gid, acc.Group.ID)
|
||||||
|
|
||||||
|
_, err = load("local_api:\n control:\n group: no-such-group-nebula-test\n")
|
||||||
|
require.ErrorContains(t, err, CtlGroupKey)
|
||||||
|
assert.ErrorContains(t, err, "does not exist")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestControlSocketIsHandedToTheGroup: the socket is created with the group's gid and
|
||||||
|
// 0660, whatever the umask, and a reload that takes the group away tightens the socket
|
||||||
|
// in place, without moving it. The endpoint is shared, so this covers the info API too.
|
||||||
|
func TestControlSocketIsHandedToTheGroup(t *testing.T) {
|
||||||
|
old := unix.Umask(0077)
|
||||||
|
defer unix.Umask(old)
|
||||||
|
|
||||||
|
name, gid := ownGroup(t)
|
||||||
|
want, err := strconv.ParseUint(gid, 10, 32)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
s := NewServer(test.NewLogger(), basicRegistry())
|
||||||
|
path := testSocket(t)
|
||||||
|
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: 0660, Group: Group{Name: name, ID: gid}}))
|
||||||
|
defer s.Stop()
|
||||||
|
|
||||||
|
fi, err := os.Lstat(path)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, os.FileMode(0660), fi.Mode().Perm())
|
||||||
|
assert.Equal(t, uint32(want), socketGroup(t, path))
|
||||||
|
|
||||||
|
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||||
|
fi, err = os.Lstat(path)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, os.FileMode(0600), fi.Mode().Perm())
|
||||||
|
assert.Equal(t, path, s.Path())
|
||||||
|
|
||||||
|
_, err = (&Client{Path: path}).Describe()
|
||||||
|
require.NoError(t, err, "the same listener is still serving")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestControlSocketWithAGroupTrustsTheKernel: with a group sharing the socket, the
|
||||||
|
// kernel's check on connect is the access control and the daemon's peer check stands
|
||||||
|
// aside, so a connection the peer check alone would refuse is served. Without a group
|
||||||
|
// the same connection is refused; see TestPeerCheckRefusesAnotherUser.
|
||||||
|
func TestControlSocketWithAGroupTrustsTheKernel(t *testing.T) {
|
||||||
|
if !peerCheckSupported {
|
||||||
|
t.Skip("no peer credentials on this platform")
|
||||||
|
}
|
||||||
|
name, gid := ownGroup(t)
|
||||||
|
|
||||||
|
me := currentUID()
|
||||||
|
asUID(t, me+1)
|
||||||
|
s := NewServer(test.NewLogger(), basicRegistry())
|
||||||
|
asUID(t, me)
|
||||||
|
|
||||||
|
path := testSocket(t)
|
||||||
|
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: 0660, Group: Group{Name: name, ID: gid}}))
|
||||||
|
defer s.Stop()
|
||||||
|
|
||||||
|
_, err := (&Client{Path: path}).Describe()
|
||||||
|
require.NoError(t, err, "the socket's group admitted us; the peer check must not refuse")
|
||||||
|
|
||||||
|
// Taking the group away on a reload puts the peer check back.
|
||||||
|
require.NoError(t, s.Rebind(context.Background(), path, ownerOnly()))
|
||||||
|
_, err = (&Client{Path: path}).Describe()
|
||||||
|
require.ErrorContains(t, err, "not permitted")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInfoAccessFromConfig: a group with no mode is 0660; a mode that gives the group
|
||||||
|
// nothing is refused, with the mode that would; an explicit mode with group bits is
|
||||||
|
// kept as given.
|
||||||
|
func TestInfoAccessFromConfig(t *testing.T) {
|
||||||
|
name, gid := ownGroup(t)
|
||||||
|
load := func(body string) (infoConfig, error) {
|
||||||
|
c := config.NewC(test.NewLogger())
|
||||||
|
require.NoError(t, c.LoadString(body))
|
||||||
|
return infoConfigFrom(c)
|
||||||
|
}
|
||||||
|
section := func(extra string) string {
|
||||||
|
return "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n" + extra
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg, err := load(section(" group: " + name + "\n"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, os.FileMode(0660), cfg.Access.Mode)
|
||||||
|
assert.Equal(t, gid, cfg.Access.Group.ID)
|
||||||
|
|
||||||
|
cfg, err = load(section(" group: " + name + "\n socket_mode: \"0664\"\n"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, os.FileMode(0664), cfg.Access.Mode)
|
||||||
|
|
||||||
|
_, err = load(section(" group: " + name + "\n socket_mode: \"0600\"\n"))
|
||||||
|
require.ErrorContains(t, err, "gives group "+name+" no access")
|
||||||
|
require.ErrorContains(t, err, `"0660"`)
|
||||||
|
|
||||||
|
cfg, err = load(section(""))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, ownerOnly(), cfg.Access)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRemovingTheGroupHandsTheSocketBack: a reload that drops the group key leaves the
|
||||||
|
// mode the operator set but returns the socket to the daemon's own group, so the old
|
||||||
|
// group's members are no longer admitted. The socket is first handed to a group this
|
||||||
|
// process belongs to other than its own, which not every host offers.
|
||||||
|
func TestRemovingTheGroupHandsTheSocketBack(t *testing.T) {
|
||||||
|
own := os.Getegid()
|
||||||
|
groups, err := os.Getgroups()
|
||||||
|
require.NoError(t, err)
|
||||||
|
other := -1
|
||||||
|
for _, g := range groups {
|
||||||
|
if g != own {
|
||||||
|
other = g
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if other < 0 {
|
||||||
|
t.Skip("this process belongs to no group but its own")
|
||||||
|
}
|
||||||
|
gid := strconv.Itoa(other)
|
||||||
|
|
||||||
|
s := NewServer(test.NewLogger(), basicRegistry())
|
||||||
|
path := testSocket(t)
|
||||||
|
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: 0660, Group: Group{Name: gid, ID: gid}}))
|
||||||
|
defer s.Stop()
|
||||||
|
assert.Equal(t, uint32(other), socketGroup(t, path))
|
||||||
|
|
||||||
|
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: 0660}))
|
||||||
|
assert.Equal(t, uint32(own), socketGroup(t, path), "the daemon's own group again")
|
||||||
|
fi, err := os.Lstat(path)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, os.FileMode(0660), fi.Mode().Perm(), "the mode is the operator's")
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
//go:build windows
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"golang.org/x/sys/windows"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestLookupGroupIDOnWindows: an account name resolves to its SID, a SID written out
|
||||||
|
// is accepted as it is, and an account the host does not know is reported.
|
||||||
|
func TestLookupGroupIDOnWindows(t *testing.T) {
|
||||||
|
users, err := windows.CreateWellKnownSid(windows.WinBuiltinUsersSid)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
got, err := lookupGroupID("Users")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, users.String(), got)
|
||||||
|
|
||||||
|
got, err = lookupGroupID(users.String())
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, users.String(), got)
|
||||||
|
|
||||||
|
_, err = lookupGroupID("no-such-account-nebula-test")
|
||||||
|
require.ErrorContains(t, err, "does not exist")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSDDLAdmitsTheGroup: the descriptor is the owner, SYSTEM and Administrators with
|
||||||
|
// full access, plus the group with what a client needs and nothing generic, so a
|
||||||
|
// member cannot create an instance of the pipe; see pipeClientAccess.
|
||||||
|
func TestSDDLAdmitsTheGroup(t *testing.T) {
|
||||||
|
sddl, err := sddlFor(ownerOnly())
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.NotContains(t, sddl, "S-1-5-32-545")
|
||||||
|
|
||||||
|
sddl, err = sddlFor(Access{Mode: groupSocketMode, Group: Group{Name: "Users", ID: "S-1-5-32-545"}})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, sddl, "(A;;GA;;;SY)(A;;GA;;;BA)(A;;0x120083;;;S-1-5-32-545)")
|
||||||
|
assert.Zero(t, pipeClientAccess&windows.FILE_APPEND_DATA, "FILE_APPEND_DATA is FILE_CREATE_PIPE_INSTANCE on a pipe")
|
||||||
|
assert.Zero(t, pipeClientAccess&(windows.GENERIC_READ|windows.GENERIC_WRITE|windows.GENERIC_ALL))
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestUnprotectedNameWarning: a pipe outside the protected namespace is warned about,
|
||||||
|
// since anyone could have created the name first; one under it, however spelled, is not.
|
||||||
|
func TestUnprotectedNameWarning(t *testing.T) {
|
||||||
|
assert.Empty(t, unprotectedNameWarning(DefaultSocketPath))
|
||||||
|
assert.Empty(t, unprotectedNameWarning(`\\.\PIPE\protectedprefix\administrators\nebula-info`))
|
||||||
|
assert.Contains(t, unprotectedNameWarning(`\\.\pipe\nebula-info`), protectedPrefix)
|
||||||
|
}
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
//go:build darwin || freebsd || netbsd || openbsd
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"golang.org/x/sys/unix"
|
||||||
|
)
|
||||||
|
|
||||||
|
// applyAccess sets the owning group and the mode of the socket node at path, and of
|
||||||
|
// nothing a link at path names. The node is looked at without following links and must
|
||||||
|
// be a socket of ours; the chown and the chmod are fchownat and fchmodat with
|
||||||
|
// AT_SYMLINK_NOFOLLOW, which these kernels honour, so a symlink put at path in the one
|
||||||
|
// syscall between the look and either call gets its own group or mode changed, which
|
||||||
|
// means nothing, and not its target's. A socket cannot be opened, and there is no O_PATH
|
||||||
|
// here to hold the inode across the calls the way the linux side does, so a hard link
|
||||||
|
// to a file of somebody's choosing swapped in during that one syscall would be changed;
|
||||||
|
// that needs the file on the socket's filesystem and the right to link to it, which
|
||||||
|
// darwin and the BSDs grant to any user by default.
|
||||||
|
func applyAccess(path string, acc Access) error {
|
||||||
|
fi, err := os.Lstat(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := checkOwnSocket(path, fi); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// With no group configured the socket is handed back to the daemon's own group, so a
|
||||||
|
// reload that drops the key takes the access away; see the linux side.
|
||||||
|
gid, err := gidFor(acc)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := unix.Fchownat(unix.AT_FDCWD, path, -1, gid, unix.AT_SYMLINK_NOFOLLOW); err != nil {
|
||||||
|
return &os.PathError{Op: "chown", Path: path, Err: err}
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := unix.Fchmodat(unix.AT_FDCWD, path, uint32(acc.Mode.Perm()), unix.AT_SYMLINK_NOFOLLOW); err != nil {
|
||||||
|
return &os.PathError{Op: "chmod", Path: path, Err: err}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
//go:build linux
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"golang.org/x/sys/unix"
|
||||||
|
)
|
||||||
|
|
||||||
|
// applyAccess sets the owning group and the mode of the socket node at path, and of
|
||||||
|
// nothing else. The node is opened O_PATH, which takes a reference to the inode without
|
||||||
|
// opening the socket itself (a socket cannot be opened, and O_PATH does not try), and
|
||||||
|
// O_NOFOLLOW, so a symlink at path is a refusal rather than a target. What the
|
||||||
|
// descriptor holds is checked to be a socket of ours, and the chown and the chmod are
|
||||||
|
// then made through /proc/self/fd, which names that inode whatever is at path by then:
|
||||||
|
// a node swapped between the look and the change, for a link or for a hard link to a
|
||||||
|
// file of somebody's choosing, is not what gets the group or the mode. This is how
|
||||||
|
// glibc implements fchmodat(AT_SYMLINK_NOFOLLOW) too.
|
||||||
|
//
|
||||||
|
// Without /proc the change falls back to fchownat and fchmodat2, which do not follow a
|
||||||
|
// link but are by path again, so a swap in the one syscall between the check and each
|
||||||
|
// would be changed. Older than kernel 6.6 with no /proc, the mode is not set and the
|
||||||
|
// socket is not served.
|
||||||
|
func applyAccess(path string, acc Access) error {
|
||||||
|
// The look is for the message: a link or a plain file is named as what it is, which
|
||||||
|
// the O_PATH open's ELOOP or the fstat below would say less well.
|
||||||
|
fi, err := os.Lstat(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := checkOwnSocket(path, fi); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
fd, err := unix.Open(path, unix.O_PATH|unix.O_NOFOLLOW|unix.O_CLOEXEC, 0)
|
||||||
|
if err != nil {
|
||||||
|
return &os.PathError{Op: "open", Path: path, Err: err}
|
||||||
|
}
|
||||||
|
defer unix.Close(fd)
|
||||||
|
|
||||||
|
// What the descriptor holds is what the changes land on; the Lstat above looked at
|
||||||
|
// the path, which may have changed since.
|
||||||
|
var st unix.Stat_t
|
||||||
|
if err := unix.Fstat(fd, &st); err != nil {
|
||||||
|
return &os.PathError{Op: "fstat", Path: path, Err: err}
|
||||||
|
}
|
||||||
|
if st.Mode&unix.S_IFMT != unix.S_IFSOCK || st.Uid != currentUID() {
|
||||||
|
return fmt.Errorf("%s was replaced while its access was being set, refusing to change it", path)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The /proc name of the inode the descriptor holds. ENOENT from it means no /proc.
|
||||||
|
held := "/proc/self/fd/" + strconv.Itoa(fd)
|
||||||
|
|
||||||
|
// The group first: a chown by root clears the setgid bit, which a socket never has,
|
||||||
|
// but the mode is pinned afterwards either way. With no group configured the socket
|
||||||
|
// is handed back to the daemon's own, so taking the key out of the config on a reload
|
||||||
|
// takes the access away as surely as a restart would.
|
||||||
|
gid, err := gidFor(acc)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
err = unix.Chown(held, -1, gid)
|
||||||
|
if err == unix.ENOENT {
|
||||||
|
err = unix.Fchownat(unix.AT_FDCWD, path, -1, gid, unix.AT_SYMLINK_NOFOLLOW)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return &os.PathError{Op: "chown", Path: path, Err: err}
|
||||||
|
}
|
||||||
|
|
||||||
|
perm := uint32(acc.Mode.Perm())
|
||||||
|
err = unix.Chmod(held, perm)
|
||||||
|
if err == unix.ENOENT {
|
||||||
|
err = unix.Fchmodat(unix.AT_FDCWD, path, perm, unix.AT_SYMLINK_NOFOLLOW)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return &os.PathError{Op: "chmod", Path: path, Err: err}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,163 @@
|
|||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DialTimeout bounds the connect to a socket that exists but is not being served.
|
||||||
|
const DialTimeout = 5 * time.Second
|
||||||
|
|
||||||
|
// ResponseTimeout bounds the exchange once connected: sending the request and waiting
|
||||||
|
// for the daemon's answer. The daemon drops a client that is slow to send in 10s and one
|
||||||
|
// that is slow to read in 30s, so this is the other side of the same bargain, with room
|
||||||
|
// for the slowest command (a hostmap dump on a large network) before a stalled daemon is
|
||||||
|
// given up on. Client.Timeout overrides it.
|
||||||
|
const ResponseTimeout = 60 * time.Second
|
||||||
|
|
||||||
|
// MaxResponseBytes bounds what a client will read back. A response carries one command's
|
||||||
|
// output, and a hostmap dump on a large network is the realistic worst case.
|
||||||
|
const MaxResponseBytes = 64 << 20
|
||||||
|
|
||||||
|
// Client talks to a nebula listening at Path.
|
||||||
|
type Client struct {
|
||||||
|
Path string
|
||||||
|
|
||||||
|
// Timeout bounds the request and response once connected. Zero means
|
||||||
|
// ResponseTimeout.
|
||||||
|
Timeout time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplyError is an answer the client could not read: the daemon was reached and wrote
|
||||||
|
// something back, but not a response this client understands. The daemon is not
|
||||||
|
// nebula, or not a version this client speaks to.
|
||||||
|
type ReplyError struct {
|
||||||
|
Err error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *ReplyError) Error() string { return "the daemon's reply could not be read: " + e.Err.Error() }
|
||||||
|
func (e *ReplyError) Unwrap() error { return e.Err }
|
||||||
|
|
||||||
|
// DaemonError is a refusal the daemon answered with: the connection worked, the request
|
||||||
|
// was read, and the daemon said no. It is told apart from a failure to reach the daemon
|
||||||
|
// so that a client does not send its user after a socket path, or a sudo, when the daemon
|
||||||
|
// was right there and answered. A protocol version the daemon does not speak, a socket at
|
||||||
|
// its connection limit and a peer the daemon will not serve all arrive as one of these.
|
||||||
|
type DaemonError struct {
|
||||||
|
Msg string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *DaemonError) Error() string { return e.Msg }
|
||||||
|
|
||||||
|
// Describe asks the daemon which commands it serves and what parameters they take, so a
|
||||||
|
// client can offer them without having been built against this daemon.
|
||||||
|
func (c *Client) Describe() ([]commands.CommandSchema, error) {
|
||||||
|
res, err := c.do(&Request{Version: ProtocolVersion, Describe: true})
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if res.Error != "" {
|
||||||
|
return nil, &DaemonError{Msg: res.Error}
|
||||||
|
}
|
||||||
|
|
||||||
|
schema := []commands.CommandSchema{}
|
||||||
|
if err := json.Unmarshal(res.Result, &schema); err != nil {
|
||||||
|
return nil, &ReplyError{Err: fmt.Errorf("could not parse the command schema: %w", err)}
|
||||||
|
}
|
||||||
|
|
||||||
|
return schema, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Invoke runs one command and returns what the daemon said. params are the command's
|
||||||
|
// options by name, as the strings a command line parsed them from; a program speaking
|
||||||
|
// the protocol directly may send JSON's own types instead, see Request.Params. An empty
|
||||||
|
// format asks for JSON, which is the API's default; "text" asks the daemon to apply the
|
||||||
|
// command's own human rendering.
|
||||||
|
func (c *Client) Invoke(command string, params map[string]string, args []string, format string) (*Response, error) {
|
||||||
|
var wire map[string]any
|
||||||
|
if len(params) > 0 {
|
||||||
|
wire = make(map[string]any, len(params))
|
||||||
|
for k, v := range params {
|
||||||
|
wire[k] = v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.do(&Request{
|
||||||
|
Version: ProtocolVersion,
|
||||||
|
Command: command,
|
||||||
|
Params: wire,
|
||||||
|
Args: args,
|
||||||
|
Format: format,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// do sends one request and reads the one response.
|
||||||
|
//
|
||||||
|
// Nothing is checked about the socket before the connect: its mode is the kernel's to
|
||||||
|
// enforce, and a socket that is not ours to connect to is refused there with a
|
||||||
|
// permission error, which the caller turns into advice.
|
||||||
|
func (c *Client) do(req *Request) (*Response, error) {
|
||||||
|
conn, err := dial(c.Path, DialTimeout)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer conn.Close()
|
||||||
|
|
||||||
|
// Without this a daemon that accepts and then stalls, blocked inside a command or
|
||||||
|
// stopped with SIGSTOP, hangs the client for good, and a script wrapping it never
|
||||||
|
// completes. One deadline covers the write and the read: the answer is due within
|
||||||
|
// the budget, however the time is spent.
|
||||||
|
timeout := c.Timeout
|
||||||
|
if timeout <= 0 {
|
||||||
|
timeout = ResponseTimeout
|
||||||
|
}
|
||||||
|
_ = conn.SetDeadline(time.Now().Add(timeout))
|
||||||
|
|
||||||
|
// If we get a write error, save that fact but then look for a response from the server.
|
||||||
|
// Some error conditions manifest as the server accepting our connection, writing an
|
||||||
|
// error, and then closing the connection. Our write races against that close.
|
||||||
|
writeErr := error(nil)
|
||||||
|
if err := writeFrame(conn, req); err != nil {
|
||||||
|
writeErr = fmt.Errorf("could not send request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
res, err := readResponse(conn)
|
||||||
|
if err != nil {
|
||||||
|
// Something answered and it was not a response: the daemon was reached, and
|
||||||
|
// that is the message even when it hung up before the request was written,
|
||||||
|
// which a daemon that is not nebula is likely to do.
|
||||||
|
var fe *frameError
|
||||||
|
if errors.As(err, &fe) {
|
||||||
|
return nil, &ReplyError{Err: err}
|
||||||
|
}
|
||||||
|
if writeErr != nil {
|
||||||
|
return nil, writeErr
|
||||||
|
}
|
||||||
|
var ne net.Error
|
||||||
|
if errors.As(err, &ne) && ne.Timeout() {
|
||||||
|
return nil, fmt.Errorf("the daemon did not answer within %s", timeout)
|
||||||
|
}
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func readResponse(conn net.Conn) (*Response, error) {
|
||||||
|
res := &Response{}
|
||||||
|
if err := readFrame(conn, MaxResponseBytes, "response", res, false); err != nil {
|
||||||
|
if errors.Is(err, io.EOF) {
|
||||||
|
return nil, errors.New("the daemon closed the connection without answering")
|
||||||
|
}
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,203 @@
|
|||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"net"
|
||||||
|
"sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
// endpoint is the lifecycle the two local APIs share: one socket at a path, bound and
|
||||||
|
// given up under a mutex, moved by binding the new path before the old one is released,
|
||||||
|
// and stopped when the context that brought it up ends. What is served on the socket,
|
||||||
|
// and by what, is the embedding server's: it hands rebindLocked a serve function and
|
||||||
|
// gets back the thing to close.
|
||||||
|
type endpoint struct {
|
||||||
|
l *slog.Logger
|
||||||
|
|
||||||
|
// name is what the endpoint is called in its own log lines and errors, so the two
|
||||||
|
// read apart.
|
||||||
|
name string
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
|
||||||
|
// closer stops the serving when closed: the listener itself, or the server that owns
|
||||||
|
// it. It is nil while the endpoint is stopped, which is what stopped means here.
|
||||||
|
closer io.Closer
|
||||||
|
path string
|
||||||
|
access Access
|
||||||
|
unwatch func() bool
|
||||||
|
|
||||||
|
// id identifies the node listen created at path, so a reload can tell whether the
|
||||||
|
// socket is still there and Stop whether the node it would unlink is still ours.
|
||||||
|
id socketID
|
||||||
|
}
|
||||||
|
|
||||||
|
// socketID identifies a socket's node on the filesystem, by device and inode on unix.
|
||||||
|
// The zero value is no identity: a platform with no node to identify, or one that could
|
||||||
|
// not be read, and removeSocket then unlinks without looking.
|
||||||
|
type socketID struct {
|
||||||
|
dev, ino uint64
|
||||||
|
}
|
||||||
|
|
||||||
|
// Path returns the socket path currently being served, or "" when stopped.
|
||||||
|
func (e *endpoint) Path() string {
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
return e.path
|
||||||
|
}
|
||||||
|
|
||||||
|
// rebindLocked brings the endpoint up at path with acc, moves it there, or, when it is
|
||||||
|
// already there, applies a changed access; with nothing changed it does nothing, which
|
||||||
|
// is what lets Wire's first attempt and its reload callback be the same call.
|
||||||
|
//
|
||||||
|
// The new socket is bound before the old one is given up: a bad path in a reloaded
|
||||||
|
// config leaves the operator with the endpoint they already had rather than none. serve
|
||||||
|
// is handed the new listener once it is certain to be kept and returns what to close to
|
||||||
|
// stop serving it; what becomes of the old socket's connections is that closer's.
|
||||||
|
//
|
||||||
|
// The caller holds e.mu for the whole operation, bind included. Releasing it around
|
||||||
|
// listen would let a Stop land in between, and this would then install a fresh socket on
|
||||||
|
// an endpoint that had just shut down, leaving a live socket on disk until the process
|
||||||
|
// exits. listen does not take e.mu, so holding it costs the other methods one bind's
|
||||||
|
// wait, at most the stale socket probe, once per reload.
|
||||||
|
func (e *endpoint) rebindLocked(ctx context.Context, path string, acc Access, serve func(net.Listener) io.Closer) error {
|
||||||
|
reopening := false
|
||||||
|
if e.closer != nil && e.path == path {
|
||||||
|
if cur, ok := identifySocket(path); ok && cur == e.id {
|
||||||
|
if e.access == acc {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
err := applyAccess(path, acc)
|
||||||
|
if err == nil {
|
||||||
|
e.access = acc
|
||||||
|
e.l.Info("Changed the "+e.name+"'s socket access", "path", path, "access", acc.String())
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if !errors.Is(err, errReopenForAccess) {
|
||||||
|
return fmt.Errorf("could not change the access of %s: %w", path, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The platform fixes access when the endpoint is created, so it is created
|
||||||
|
// again. The name cannot be held twice, so the old one goes first, and a bind
|
||||||
|
// that then fails leaves the endpoint down rather than on the old access the
|
||||||
|
// operator asked to change; that is reported below.
|
||||||
|
reopening = true
|
||||||
|
old := e.closer
|
||||||
|
e.forgetLocked()
|
||||||
|
_ = old.Close()
|
||||||
|
} else {
|
||||||
|
// The node at the path is not the one this endpoint bound: something outside
|
||||||
|
// nebula removed it, logind clearing /run/user/<uid> on logout or a unit
|
||||||
|
// cleaning a RuntimeDirectory= it shares, or replaced it. The listener is still
|
||||||
|
// open and nothing can reach it, so it is given up now and the path is bound
|
||||||
|
// afresh below; listen's stale check decides whether whatever is there now may
|
||||||
|
// be cleared. Given up first, rather than after a successful bind as a move
|
||||||
|
// does, so that a bind that fails leaves the endpoint reported as down, which
|
||||||
|
// it is, instead of serving a path nothing can reach.
|
||||||
|
e.l.Warn("The "+e.name+"'s socket is no longer at its path, binding it again", "path", path)
|
||||||
|
old := e.closer
|
||||||
|
e.forgetLocked()
|
||||||
|
_ = old.Close()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ln, err := listen(path, acc)
|
||||||
|
if err != nil {
|
||||||
|
if reopening {
|
||||||
|
return fmt.Errorf("the %s was closed to change its access and could not be created again: %w", e.name, err)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
id, _ := identifySocket(path)
|
||||||
|
|
||||||
|
// A reload that arrives during shutdown must not bring the endpoint back. Stop is
|
||||||
|
// not terminal (a Rebind after Stop is allowed, and is how an endpoint whose first
|
||||||
|
// bind failed comes up), so whether it is running is no guide; the context is what
|
||||||
|
// shutdown cancels, and it is checked here, while nothing else can change the state.
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
release(ln, path, id)
|
||||||
|
return fmt.Errorf("not starting the %s, nebula is shutting down: %w", e.name, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
old, oldPath, oldID := e.closer, e.path, e.id
|
||||||
|
e.closer = serve(ln)
|
||||||
|
e.path = path
|
||||||
|
e.access = acc
|
||||||
|
e.id = id
|
||||||
|
e.watchLocked(ctx)
|
||||||
|
|
||||||
|
// Stop serving the old socket. When it was on this same path its node is already
|
||||||
|
// gone, and the node there now is the new socket's, so only the closer goes.
|
||||||
|
if old != nil {
|
||||||
|
if oldPath == path {
|
||||||
|
_ = old.Close()
|
||||||
|
} else {
|
||||||
|
release(old, oldPath, oldID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// watchLocked stops the endpoint when ctx is cancelled. One watcher covers a run of the
|
||||||
|
// endpoint, from the first bind that succeeds until Stop: a daemon whose initial listen
|
||||||
|
// failed and which later Rebinds onto a good path from a reloaded config still needs its
|
||||||
|
// socket removed on shutdown, and a Rebind on a running endpoint must not stack a second
|
||||||
|
// watcher on the same ctx. Stop detaches the watcher, so an endpoint started again
|
||||||
|
// afterwards is watched on the ctx that started it, and the ctx of an earlier run no
|
||||||
|
// longer reaches it whenever that one ends. Callers hold e.mu.
|
||||||
|
func (e *endpoint) watchLocked(ctx context.Context) {
|
||||||
|
if e.unwatch != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
e.unwatch = context.AfterFunc(ctx, e.Stop)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stop closes the endpoint and removes its socket. Work in flight is the closer's
|
||||||
|
// business: a listener leaves the connections it already accepted to finish, a server
|
||||||
|
// cuts them off.
|
||||||
|
//
|
||||||
|
// The whole of it runs under e.mu, closer and socket included, so a Rebind cannot land
|
||||||
|
// between the state change and the close and find a path that is still bound by the
|
||||||
|
// socket it is replacing.
|
||||||
|
func (e *endpoint) Stop() {
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
|
||||||
|
if e.closer == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
release(e.closer, e.path, e.id)
|
||||||
|
e.forgetLocked()
|
||||||
|
}
|
||||||
|
|
||||||
|
// forgetLocked drops the state of a run once its socket has been given up, the watcher
|
||||||
|
// with it: one watcher covers one run, and a bind that follows starts a new one on the
|
||||||
|
// ctx it was given. The watcher is set whenever closer is; when the Stop that got here
|
||||||
|
// is the watcher's own, stopping one that has already fired is a no-op.
|
||||||
|
func (e *endpoint) forgetLocked() {
|
||||||
|
e.closer, e.path, e.access, e.id = nil, "", Access{}, socketID{}
|
||||||
|
if e.unwatch != nil {
|
||||||
|
e.unwatch()
|
||||||
|
e.unwatch = nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// release gives up a socket's closer and the node at its path. The node goes first,
|
||||||
|
// while the socket is still open: for as long as it is, the node is this endpoint's,
|
||||||
|
// since a starting daemon's stale check refuses to remove a socket that answers. The
|
||||||
|
// other order opens a window between the close and the unlink in which a new daemon can
|
||||||
|
// find the node stale, clear it and bind its own at the same path, which the unlink then
|
||||||
|
// takes from under it, leaving that daemon serving a socket nothing can reach. listen
|
||||||
|
// turns off the listener's own unlink on close so this is the only unlink. id is the
|
||||||
|
// node listen created, and the only node removeSocket will remove: one that replaced it,
|
||||||
|
// another daemon's socket bound after ours was taken from under us, is left alone.
|
||||||
|
func release(c io.Closer, path string, id socketID) {
|
||||||
|
removeSocket(path, id)
|
||||||
|
_ = c.Close()
|
||||||
|
}
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
//go:build !windows
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/user"
|
||||||
|
"strconv"
|
||||||
|
)
|
||||||
|
|
||||||
|
// lookupGroupID resolves a group's name, or a numeric gid, to the gid as a string. A
|
||||||
|
// gid that the group database does not list is accepted as chown would accept it: the
|
||||||
|
// operator may be naming a group the host will learn about later, or one that only a
|
||||||
|
// directory service knows.
|
||||||
|
func lookupGroupID(name string) (string, error) {
|
||||||
|
if g, err := user.LookupGroup(name); err == nil {
|
||||||
|
return g.Gid, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := strconv.ParseUint(name, 10, 32); err == nil {
|
||||||
|
return name, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return "", fmt.Errorf("group %q does not exist on this host", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// gidFor returns the gid the socket is owned by under acc: the configured group's, or
|
||||||
|
// the daemon's own effective group when none is configured.
|
||||||
|
func gidFor(acc Access) (int, error) {
|
||||||
|
if !acc.shared() {
|
||||||
|
return os.Getegid(), nil
|
||||||
|
}
|
||||||
|
gid, err := strconv.ParseUint(acc.Group.ID, 10, 32)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("group %q resolved to %q, which is not a gid", acc.Group.Name, acc.Group.ID)
|
||||||
|
}
|
||||||
|
return int(gid), nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
//go:build windows
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"golang.org/x/sys/windows"
|
||||||
|
)
|
||||||
|
|
||||||
|
// lookupGroupID resolves an account name, local or domain qualified, or a SID written
|
||||||
|
// out, to the SID as a string, which is how the pipe's security descriptor names it.
|
||||||
|
// Any account the host can resolve is accepted, as docker accepts any SID for its -G: a
|
||||||
|
// group is the natural thing to name, but the descriptor does not care.
|
||||||
|
func lookupGroupID(name string) (string, error) {
|
||||||
|
if strings.HasPrefix(strings.ToUpper(name), "S-1-") {
|
||||||
|
sid, err := windows.StringToSid(name)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("%q is not a SID: %w", name, err)
|
||||||
|
}
|
||||||
|
return sid.String(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
sid, _, _, err := windows.LookupSID("", name)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("account %q does not exist on this host: %w", name, err)
|
||||||
|
}
|
||||||
|
return sid.String(), nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,452 @@
|
|||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"maps"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
"os"
|
||||||
|
"path"
|
||||||
|
"runtime"
|
||||||
|
"runtime/debug"
|
||||||
|
"slices"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
"github.com/slackhq/nebula/config"
|
||||||
|
"golang.org/x/net/netutil"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The info API's config keys. It is off until InfoEnabledKey is true and InfoSocketKey
|
||||||
|
// names a socket; nothing is derived, because the programs that will dial it have to be
|
||||||
|
// told where it is anyway.
|
||||||
|
const (
|
||||||
|
InfoEnabledKey = "local_api.info.enabled"
|
||||||
|
InfoSocketKey = "local_api.info.socket"
|
||||||
|
InfoModeKey = "local_api.info.socket_mode"
|
||||||
|
InfoGroupKey = "local_api.info.group"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// infoMaxConns bounds the connections held open at once. Beyond it the kernel
|
||||||
|
// queues, which is what an HTTP client expects of a busy server; the control socket
|
||||||
|
// refuses instead because its clients are people at a prompt.
|
||||||
|
infoMaxConns = 64
|
||||||
|
|
||||||
|
infoWriteTimeout = 30 * time.Second
|
||||||
|
infoIdleTimeout = 60 * time.Second
|
||||||
|
infoMaxHeaderBytes = 64 * 1024
|
||||||
|
)
|
||||||
|
|
||||||
|
// The read deadlines are variables so a test can shorten them. infoReadTimeout bounds
|
||||||
|
// the whole request, not only its headers: a request is a GET with a query string and
|
||||||
|
// the handlers never read a body, but net/http drains an unread body after the handler
|
||||||
|
// returns, and without a deadline on that read a client sending a body a byte at a time
|
||||||
|
// would hold its connection slot for as long as it liked, and sixty-four of them would
|
||||||
|
// hold every slot. A body is refused as well, see refuseBody, but net/http drains it
|
||||||
|
// before it closes, so this deadline is what ends a client that announced a body and
|
||||||
|
// never sent it.
|
||||||
|
var (
|
||||||
|
infoReadHeaderTimeout = 10 * time.Second
|
||||||
|
infoReadTimeout = 15 * time.Second
|
||||||
|
)
|
||||||
|
|
||||||
|
// servedOnInfo decides what the info API will run: the commands that report identity
|
||||||
|
// and nothing else, which the commands declare about themselves. Filter adds help to
|
||||||
|
// the result, so a client can ask what is served; help on a filtered registry describes
|
||||||
|
// only that registry.
|
||||||
|
func servedOnInfo(c *commands.Command) bool {
|
||||||
|
return c.Identity
|
||||||
|
}
|
||||||
|
|
||||||
|
// notServedOnInfo explains a refusal, naming the surfaces that will run the command.
|
||||||
|
const notServedOnInfo = "the info API serves identity lookups only; the ssh debug server and nebula ctl serve the rest"
|
||||||
|
|
||||||
|
// InfoServer serves the identity commands over HTTP, on a socket an operator may open to
|
||||||
|
// other users on the host.
|
||||||
|
//
|
||||||
|
// It is the second local API, and the opposite of the control socket in who it is for.
|
||||||
|
// The control socket is for the user who runs nebula, serves nearly everything and needs
|
||||||
|
// no configuration. This one is for every other program on the machine, a web server
|
||||||
|
// that wants to know who is on the other end of a connection arriving over the overlay,
|
||||||
|
// say, and it is off until an operator names a socket and a mode for it. What it serves
|
||||||
|
// is decided by the commands themselves, Command.Identity: the identity a certificate
|
||||||
|
// asserts and nothing operational, so opening it to a group of services, or to everyone
|
||||||
|
// on the host, gives away nothing the overlay did not already tell them.
|
||||||
|
//
|
||||||
|
// HTTP, so that no client library is needed. GET /v1/<command>?<flag>=<value> runs a
|
||||||
|
// command with its options as the query string and answers with the command's JSON, the
|
||||||
|
// same value the control socket and -json produce. GET /v1 describes what is served. A
|
||||||
|
// refusal is a 4xx with {"error": reason}: 404 when the command said the thing asked
|
||||||
|
// about does not exist (commands.NotFound), 400 for a parameter or an argument the
|
||||||
|
// command would not take, 403 for a command this surface withholds.
|
||||||
|
type InfoServer struct {
|
||||||
|
endpoint
|
||||||
|
|
||||||
|
// reg is the identity commands this surface serves, filtered from the daemon's
|
||||||
|
// registry when the server was built.
|
||||||
|
reg *commands.Registry
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewInfoServer returns an InfoServer that serves the identity commands in reg. reg is
|
||||||
|
// complete when it arrives: nebula registers every command before it wires its local
|
||||||
|
// APIs, and nothing registers one later, so the filter is taken once here rather than
|
||||||
|
// kept up to date against the source.
|
||||||
|
func NewInfoServer(l *slog.Logger, reg *commands.Registry) *InfoServer {
|
||||||
|
return &InfoServer{
|
||||||
|
endpoint: endpoint{l: l, name: "local info API"},
|
||||||
|
reg: reg.Filter(servedOnInfo, notServedOnInfo),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rebind brings the server up at path with mode, moves it there, or, when it is already
|
||||||
|
// there, applies a changed mode; endpoint.rebindLocked says what that promises. It is
|
||||||
|
// the one way the server comes up, so Wire's reload callback and its first attempt are
|
||||||
|
// the same call.
|
||||||
|
func (s *InfoServer) Rebind(ctx context.Context, path string, acc Access) error {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
|
||||||
|
return s.rebindLocked(ctx, path, acc, func(ln net.Listener) io.Closer {
|
||||||
|
srv := &http.Server{
|
||||||
|
Handler: s.handler(),
|
||||||
|
ReadHeaderTimeout: infoReadHeaderTimeout,
|
||||||
|
ReadTimeout: infoReadTimeout,
|
||||||
|
WriteTimeout: infoWriteTimeout,
|
||||||
|
IdleTimeout: infoIdleTimeout,
|
||||||
|
MaxHeaderBytes: infoMaxHeaderBytes,
|
||||||
|
ErrorLog: slog.NewLogLogger(s.l.Handler(), slog.LevelDebug),
|
||||||
|
}
|
||||||
|
|
||||||
|
s.l.Info("Local info API listening", "path", path, "access", acc.String())
|
||||||
|
if w := unprotectedNameWarning(path); w != "" {
|
||||||
|
s.l.Warn("Local info API is served on a pipe name that is not protected", "path", path, "risk", w)
|
||||||
|
}
|
||||||
|
go s.serve(srv, ln)
|
||||||
|
|
||||||
|
// Closing the server closes the listener Serve was handed, and a Serve that has
|
||||||
|
// not started yet closes it on its way out, so the node is never left bound by a
|
||||||
|
// listener nothing is accepting from. Requests in flight are cut off rather than
|
||||||
|
// waited for: a reload must not hang on a slow client, and the answer is a lookup
|
||||||
|
// the client can simply repeat.
|
||||||
|
return srv
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// serve runs the HTTP server on ln until it is closed. Only an error other than the
|
||||||
|
// close is worth a line: Stop and Rebind are the two things that close it.
|
||||||
|
func (s *InfoServer) serve(srv *http.Server, ln net.Listener) {
|
||||||
|
err := srv.Serve(netutil.LimitListener(ln, infoMaxConns))
|
||||||
|
if err != nil && !errors.Is(err, http.ErrServerClosed) && !errors.Is(err, net.ErrClosed) {
|
||||||
|
s.l.Error("Local info API stopped serving", "error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// handler builds the routes. Every answer is JSON, the misses included, so a client
|
||||||
|
// never has to parse net/http's text for a path or method it did not expect. That
|
||||||
|
// includes a path ServeMux would clean and redirect, /v1/../v1/x or //v1/x, which is
|
||||||
|
// refused outright: nothing legitimate sends one, and a redirect is one more thing a
|
||||||
|
// client would have to follow.
|
||||||
|
func (s *InfoServer) handler() http.Handler {
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("GET /v1", s.handleDescribe)
|
||||||
|
mux.HandleFunc("GET /v1/{command}", s.handleCommand)
|
||||||
|
mux.HandleFunc("/v1", methodNotAllowed)
|
||||||
|
mux.HandleFunc("/v1/{command}", methodNotAllowed)
|
||||||
|
mux.HandleFunc("/", notFoundRoute)
|
||||||
|
return s.recovering(refuseBody(mux))
|
||||||
|
}
|
||||||
|
|
||||||
|
// refuseBody answers a request that carries a body with 400, before any handler sees
|
||||||
|
// it, and has the connection closed after the reply rather than kept for another
|
||||||
|
// request. Nothing here reads a body; one is a mistake, and the client is told what to
|
||||||
|
// do instead. net/http still drains what the body it announced it would send, up to the
|
||||||
|
// read deadline, so the deadline is what bounds a client that never sends it.
|
||||||
|
func refuseBody(next http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.ContentLength != 0 || len(r.TransferEncoding) > 0 {
|
||||||
|
w.Header().Set("Connection", "close")
|
||||||
|
writeJSONError(w, http.StatusBadRequest, "the info API takes no request body; put the command's parameters in the query string")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// recovering turns a panic in a command into a 500 and a log line rather than a dropped
|
||||||
|
// connection, which is all net/http would offer, and keeps the daemon up, which is what
|
||||||
|
// matters: this surface is reachable by whoever the operator opened it to. The handlers
|
||||||
|
// produce their whole answer before writing any of it, so a panic in Run always finds
|
||||||
|
// the response unwritten.
|
||||||
|
func (s *InfoServer) recovering(next http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
defer func() {
|
||||||
|
if rec := recover(); rec != nil {
|
||||||
|
s.l.Error("Recovered from panic serving a local info API request",
|
||||||
|
"panic", rec,
|
||||||
|
"path", r.URL.Path,
|
||||||
|
"query", r.URL.RawQuery,
|
||||||
|
"stack", string(debug.Stack()),
|
||||||
|
)
|
||||||
|
writeJSONError(w, http.StatusInternalServerError, "command failed")
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
if path.Clean(r.URL.Path) != r.URL.Path {
|
||||||
|
notFoundRoute(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleDescribe answers GET /v1 with the schema of every command served here, the same
|
||||||
|
// document the control socket's describe returns for its own surface.
|
||||||
|
func (s *InfoServer) handleDescribe(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
body, err := json.Marshal(s.reg.Schema())
|
||||||
|
if err != nil {
|
||||||
|
writeJSONError(w, http.StatusInternalServerError, err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, body)
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleCommand answers GET /v1/<command>: the query string carries the command's
|
||||||
|
// parameters, and the response body is the command's JSON. A request body is never
|
||||||
|
// read. It is the control socket's serve with HTTP's vocabulary for the outcomes.
|
||||||
|
func (s *InfoServer) handleCommand(w http.ResponseWriter, r *http.Request) {
|
||||||
|
name := commands.Name(r.PathValue("command"))
|
||||||
|
|
||||||
|
reg := s.reg
|
||||||
|
cmd, err := reg.Resolve(name)
|
||||||
|
if err != nil {
|
||||||
|
// A command this surface withholds is a different answer from one that does not
|
||||||
|
// exist, and Resolve says which; only the status is picked here.
|
||||||
|
status := http.StatusNotFound
|
||||||
|
var withheld *commands.WithheldError
|
||||||
|
if errors.As(err, &withheld) {
|
||||||
|
status = http.StatusForbidden
|
||||||
|
}
|
||||||
|
writeJSONError(w, status, err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parsed strictly: the lenient parser on the request drops a pair it cannot decode
|
||||||
|
// and keeps the rest, and a request that lost its address would be answered as one
|
||||||
|
// that never had it, which for print-cert is this node's own certificate.
|
||||||
|
q, err := url.ParseQuery(r.URL.RawQuery)
|
||||||
|
if err != nil {
|
||||||
|
writeJSONError(w, http.StatusBadRequest, "malformed query string: "+err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
params, format, err := queryParams(q, reg.SchemaFor(cmd))
|
||||||
|
if err != nil {
|
||||||
|
writeJSONError(w, http.StatusBadRequest, err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
res, err := commands.Invoke(commands.Request{Command: cmd, Params: params})
|
||||||
|
if err != nil {
|
||||||
|
var pe *commands.ParamError
|
||||||
|
if errors.As(err, &pe) {
|
||||||
|
writeJSONError(w, http.StatusBadRequest, err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run failed. The sentence is for the operator's log; the caller, who may be
|
||||||
|
// anyone the operator admitted, is told that it failed and no more.
|
||||||
|
s.l.Warn("Local info API command failed", "command", name, "error", err)
|
||||||
|
writeJSONError(w, http.StatusInternalServerError, "command failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// A command that acts does so before this surface's one reply, whose body is the
|
||||||
|
// outcome; see Command.Then.
|
||||||
|
if cmd.Then != nil && res.OK {
|
||||||
|
res = cmd.Then()
|
||||||
|
}
|
||||||
|
|
||||||
|
// A refusal is answered before an empty Result is: the zero Result is a refusal with
|
||||||
|
// nothing to say, which exits 1 over ssh and must not read as success here. One with
|
||||||
|
// no reason is the command's fault, as a Run error is, and is answered the same way.
|
||||||
|
if !res.OK {
|
||||||
|
if res.Reason == "" {
|
||||||
|
s.l.Warn("Local info API command refused without a reason", "command", name)
|
||||||
|
writeJSONError(w, http.StatusInternalServerError, "command failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
status := http.StatusBadRequest
|
||||||
|
if res.NotFound {
|
||||||
|
status = http.StatusNotFound
|
||||||
|
}
|
||||||
|
writeJSONError(w, status, res.Reason)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if res.Empty() {
|
||||||
|
w.WriteHeader(http.StatusNoContent)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// The same rendering function every surface uses, so the value here is byte for
|
||||||
|
// byte what -json prints at an ssh prompt.
|
||||||
|
buf := &bytes.Buffer{}
|
||||||
|
if err := commands.Render(cmd, res, format, buf); err != nil {
|
||||||
|
s.l.Warn("Local info API could not render a result", "command", name, "error", err)
|
||||||
|
writeJSONError(w, http.StatusInternalServerError, "command failed")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
writeJSON(w, http.StatusOK, buf.Bytes())
|
||||||
|
}
|
||||||
|
|
||||||
|
// queryParams reads a query string as a command's parameters. Each key is a flag of the
|
||||||
|
// command, by name, in the form the control socket takes them; one given twice is
|
||||||
|
// refused rather than silently picking either. The presentation flags are read as a
|
||||||
|
// command line reads them, and set apart: the answer is JSON regardless, and pretty
|
||||||
|
// indents it.
|
||||||
|
func queryParams(q url.Values, schema commands.CommandSchema) (map[string]string, commands.Format, error) {
|
||||||
|
var params, presentation map[string]string
|
||||||
|
for _, k := range slices.Sorted(maps.Keys(q)) {
|
||||||
|
vs := q[k]
|
||||||
|
if len(vs) > 1 {
|
||||||
|
return nil, commands.FormatUnset, fmt.Errorf("parameter %q was given more than once", k)
|
||||||
|
}
|
||||||
|
|
||||||
|
into := ¶ms
|
||||||
|
if k == commands.FlagJSON || k == commands.FlagPretty {
|
||||||
|
into = &presentation
|
||||||
|
}
|
||||||
|
if *into == nil {
|
||||||
|
*into = map[string]string{}
|
||||||
|
}
|
||||||
|
v := vs[0]
|
||||||
|
// ?raw is ?raw=true, as -raw is -raw=true on a command line.
|
||||||
|
if v == "" && isBoolParam(schema, k) {
|
||||||
|
v = "true"
|
||||||
|
}
|
||||||
|
(*into)[k] = v
|
||||||
|
}
|
||||||
|
|
||||||
|
format, err := commands.PresentationFormat(presentation)
|
||||||
|
if err != nil {
|
||||||
|
return nil, commands.FormatUnset, err
|
||||||
|
}
|
||||||
|
if format == commands.FormatUnset {
|
||||||
|
format = commands.FormatJSON
|
||||||
|
}
|
||||||
|
|
||||||
|
return params, format, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// isBoolParam reports whether name is one of the command's boolean flags.
|
||||||
|
func isBoolParam(schema commands.CommandSchema, name string) bool {
|
||||||
|
for _, f := range schema.Flags {
|
||||||
|
if f.Name == name {
|
||||||
|
return f.Bool
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func methodNotAllowed(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Allow", http.MethodGet)
|
||||||
|
writeJSONError(w, http.StatusMethodNotAllowed, fmt.Sprintf("%s is not allowed; the info API is read only, use GET", r.Method))
|
||||||
|
}
|
||||||
|
|
||||||
|
func notFoundRoute(w http.ResponseWriter, r *http.Request) {
|
||||||
|
writeJSONError(w, http.StatusNotFound, fmt.Sprintf("no such path %s; GET /v1 lists the commands and GET /v1/<command> runs one", r.URL.Path))
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeJSON(w http.ResponseWriter, status int, body []byte) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
w.Header().Set("X-Content-Type-Options", "nosniff")
|
||||||
|
w.Header().Set("Content-Length", strconv.Itoa(len(body)))
|
||||||
|
w.WriteHeader(status)
|
||||||
|
_, _ = w.Write(body)
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeJSONError(w http.ResponseWriter, status int, msg string) {
|
||||||
|
body, _ := json.Marshal(map[string]string{"error": msg})
|
||||||
|
writeJSON(w, status, append(body, '\n'))
|
||||||
|
}
|
||||||
|
|
||||||
|
// infoConfig is the info API section of a config, read and checked.
|
||||||
|
type infoConfig struct {
|
||||||
|
Enabled bool
|
||||||
|
Path string
|
||||||
|
Access Access
|
||||||
|
}
|
||||||
|
|
||||||
|
// infoConfigFrom reads the info API section. A disabled section needs nothing else to be
|
||||||
|
// right; an enabled one needs a socket path, a group that exists if it names one, and
|
||||||
|
// a mode that parses if it names one. A group with no mode means groupSocketMode, and a
|
||||||
|
// mode that gives a named group nothing is refused: it would be a group that cannot
|
||||||
|
// connect, which is not what naming one asks for.
|
||||||
|
func infoConfigFrom(c *config.C) (infoConfig, error) {
|
||||||
|
cfg := infoConfig{Enabled: c.GetBool(InfoEnabledKey, false)}
|
||||||
|
if !cfg.Enabled {
|
||||||
|
return cfg, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
p := c.GetString(InfoSocketKey, "")
|
||||||
|
if p == "" {
|
||||||
|
return cfg, fmt.Errorf("%s is true but %s is not set; the info API needs a socket path", InfoEnabledKey, InfoSocketKey)
|
||||||
|
}
|
||||||
|
if err := checkSocketPath(InfoSocketKey, p); err != nil {
|
||||||
|
return cfg, err
|
||||||
|
}
|
||||||
|
cfg.Path = p
|
||||||
|
|
||||||
|
group, err := groupFromConfig(c, InfoGroupKey)
|
||||||
|
if err != nil {
|
||||||
|
return cfg, err
|
||||||
|
}
|
||||||
|
// With neither a mode nor a group named, the daemon's user alone, so that enabling
|
||||||
|
// the API does not open it to anyone until the operator says who.
|
||||||
|
def := ownerOnlyMode
|
||||||
|
if group.ID != "" {
|
||||||
|
def = groupSocketMode
|
||||||
|
}
|
||||||
|
|
||||||
|
mode, err := parseSocketMode(c.Get(InfoModeKey), def)
|
||||||
|
if err != nil {
|
||||||
|
return cfg, fmt.Errorf("%s: %w", InfoModeKey, err)
|
||||||
|
}
|
||||||
|
// On unix the mode is what admits the group, so one that shuts it out is a config
|
||||||
|
// error; on windows the group is an entry in the pipe's security descriptor and the
|
||||||
|
// mode means nothing to a pipe, so it is not held against the group there.
|
||||||
|
if runtime.GOOS != "windows" && group.ID != "" && mode&0070 == 0 {
|
||||||
|
return cfg, fmt.Errorf("%s %s gives group %s no access to the socket; use \"%04o\" or leave the mode unset", InfoModeKey, modeString(mode), group.Name, mode|0060)
|
||||||
|
}
|
||||||
|
cfg.Access = Access{Mode: mode, Group: group}
|
||||||
|
|
||||||
|
return cfg, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseSocketMode reads an octal mode written as a string. A bare 0660 in yaml is an
|
||||||
|
// integer, and which integer depends on the parser (octal 432 under YAML 1.1, decimal
|
||||||
|
// 660 under 1.2), so a number is refused with the fix rather than quietly applied as
|
||||||
|
// whichever mode its digits happen to spell in octal.
|
||||||
|
func parseSocketMode(raw any, def os.FileMode) (os.FileMode, error) {
|
||||||
|
switch v := raw.(type) {
|
||||||
|
case nil:
|
||||||
|
return def, nil
|
||||||
|
case string:
|
||||||
|
mode, err := strconv.ParseUint(v, 8, 32)
|
||||||
|
if err != nil || mode&^0777 != 0 {
|
||||||
|
return 0, fmt.Errorf("%q is not an octal file mode such as \"0660\"", v)
|
||||||
|
}
|
||||||
|
return os.FileMode(mode), nil
|
||||||
|
default:
|
||||||
|
return 0, fmt.Errorf("must be a quoted octal string such as \"0660\", not the number %v; yaml reads a bare mode as a decimal or octal integer depending on the parser", v)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,432 @@
|
|||||||
|
//go:build !windows
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
"github.com/slackhq/nebula/config"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
type whoamiFlags struct {
|
||||||
|
Name string
|
||||||
|
Shout bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// infoRegistry holds one identity command, whoami, whose -name selects an outcome, and
|
||||||
|
// one command the info API must withhold.
|
||||||
|
func infoRegistry() *commands.Registry {
|
||||||
|
reg := commands.New()
|
||||||
|
reg.Register(&commands.Command{
|
||||||
|
Name: "whoami",
|
||||||
|
ShortDescription: "reports who a name belongs to",
|
||||||
|
Identity: true,
|
||||||
|
Flags: func() (*flag.FlagSet, any) {
|
||||||
|
fl := flag.NewFlagSet("", flag.ContinueOnError)
|
||||||
|
s := &whoamiFlags{}
|
||||||
|
fl.StringVar(&s.Name, "name", "", "the name to look up")
|
||||||
|
fl.BoolVar(&s.Shout, "shout", false, "answers in capitals")
|
||||||
|
return fl, s
|
||||||
|
},
|
||||||
|
Run: func(fs any, a []string) (commands.Result, error) {
|
||||||
|
if f := fs.(*whoamiFlags); f.Shout {
|
||||||
|
return commands.Value(map[string]any{"name": strings.ToUpper(f.Name)}), nil
|
||||||
|
}
|
||||||
|
switch name := fs.(*whoamiFlags).Name; name {
|
||||||
|
case "":
|
||||||
|
return commands.Value(map[string]any{"name": "me", "groups": []string{}}), nil
|
||||||
|
case "nobody":
|
||||||
|
return commands.NotFound("No active tunnel for vpn addr: %s", name), nil
|
||||||
|
case "bad":
|
||||||
|
return commands.Failed("The provided vpn addr could not be parsed: %s", name), nil
|
||||||
|
case "boom":
|
||||||
|
panic("this command is broken")
|
||||||
|
case "err":
|
||||||
|
return commands.Result{}, errors.New("an internal detail")
|
||||||
|
case "silent":
|
||||||
|
return commands.Result{}, nil
|
||||||
|
case "done":
|
||||||
|
return commands.Nothing(), nil
|
||||||
|
default:
|
||||||
|
return commands.Value(map[string]any{"name": name}), nil
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
|
reg.Register(echoCommand())
|
||||||
|
return reg
|
||||||
|
}
|
||||||
|
|
||||||
|
func serveInfo(t *testing.T, reg *commands.Registry, mode os.FileMode) (*InfoServer, string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
path := testSocket(t)
|
||||||
|
s := NewInfoServer(test.NewLogger(), reg)
|
||||||
|
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: mode}))
|
||||||
|
t.Cleanup(s.Stop)
|
||||||
|
return s, path
|
||||||
|
}
|
||||||
|
|
||||||
|
// httpDo sends one request over the socket at path and returns the status, body and
|
||||||
|
// headers. The host in the URL is a placeholder: the dialer ignores it.
|
||||||
|
func TestInfoServesIdentityCommands(t *testing.T) {
|
||||||
|
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||||
|
|
||||||
|
status, body, hdr := test.HTTPDo(t, path, http.MethodGet, "/v1/whoami?name=alice")
|
||||||
|
assert.Equal(t, http.StatusOK, status)
|
||||||
|
assert.JSONEq(t, `{"name":"alice"}`, body)
|
||||||
|
assert.Equal(t, "application/json", hdr.Get("Content-Type"))
|
||||||
|
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/whoami")
|
||||||
|
assert.Equal(t, http.StatusOK, status)
|
||||||
|
assert.JSONEq(t, `{"name":"me","groups":[]}`, body, "a parameter left out is the command's default")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInfoWithholdsTheRest checks the filter at the wire: a command that exists but is
|
||||||
|
// not an identity command is refused with the reason, and a name nothing is registered
|
||||||
|
// under is unknown, so a caller can tell a typo from a closed door.
|
||||||
|
func TestInfoWithholdsTheRest(t *testing.T) {
|
||||||
|
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||||
|
|
||||||
|
status, body := test.HTTPGet(t, path, "/v1/echo?x=1")
|
||||||
|
assert.Equal(t, http.StatusForbidden, status)
|
||||||
|
assert.Contains(t, body, "echo is not available on this surface")
|
||||||
|
assert.Contains(t, body, "identity lookups only")
|
||||||
|
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/nope")
|
||||||
|
assert.Equal(t, http.StatusNotFound, status)
|
||||||
|
assert.Contains(t, body, `unknown command \"nope\"`)
|
||||||
|
|
||||||
|
for _, target := range []string{"/", "/v2/whoami", "/v1/", "/v1/whoami/extra", "//v1/whoami", "/v1/x/../whoami", "/v1/../v1/whoami"} {
|
||||||
|
status, body = test.HTTPGet(t, path, target)
|
||||||
|
assert.Equal(t, http.StatusNotFound, status, target)
|
||||||
|
assert.Contains(t, body, `"error"`, "%s: misses are JSON too", target)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInfoStatusCodes(t *testing.T) {
|
||||||
|
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
target string
|
||||||
|
status int
|
||||||
|
body string
|
||||||
|
}{
|
||||||
|
{"/v1/whoami?name=nobody", http.StatusNotFound, `{"error":"No active tunnel for vpn addr: nobody"}`},
|
||||||
|
{"/v1/whoami?name=bad", http.StatusBadRequest, `{"error":"The provided vpn addr could not be parsed: bad"}`},
|
||||||
|
{"/v1/whoami?nope=1", http.StatusBadRequest, `{"error":"whoami has no parameter \"nope\""}`},
|
||||||
|
{"/v1/whoami?name=a&name=b", http.StatusBadRequest, `{"error":"parameter \"name\" was given more than once"}`},
|
||||||
|
{"/v1/whoami?pretty=maybe", http.StatusBadRequest, `{"error":"pretty: expected a boolean, got \"maybe\""}`},
|
||||||
|
// A pair that does not decode is a malformed request, not a request without
|
||||||
|
// the pair: the lenient parser would drop it and keep the rest.
|
||||||
|
{"/v1/whoami?name=%zz", http.StatusBadRequest, `{"error":"malformed query string: invalid URL escape \"%zz\""}`},
|
||||||
|
{"/v1/whoami?name=a;shout", http.StatusBadRequest, `{"error":"malformed query string: invalid semicolon separator in query"}`},
|
||||||
|
// A boolean parameter with no value is set, as -shout is on a command line.
|
||||||
|
{"/v1/whoami?name=alice&shout", http.StatusOK, `{"name":"ALICE"}`},
|
||||||
|
{"/v1/whoami?name=alice&shout=false", http.StatusOK, `{"name":"alice"}`},
|
||||||
|
// Run failed: the caller hears that it did and no more; the detail is for the log.
|
||||||
|
{"/v1/whoami?name=err", http.StatusInternalServerError, `{"error":"command failed"}`},
|
||||||
|
// A refusal with no reason, the zero Result, fails the same way rather than
|
||||||
|
// passing as a success with nothing to say.
|
||||||
|
{"/v1/whoami?name=silent", http.StatusInternalServerError, `{"error":"command failed"}`},
|
||||||
|
} {
|
||||||
|
status, body := test.HTTPGet(t, path, tc.target)
|
||||||
|
assert.Equal(t, tc.status, status, tc.target)
|
||||||
|
assert.JSONEq(t, tc.body, body, tc.target)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A success with nothing to say is the one empty reply.
|
||||||
|
status, body := test.HTTPGet(t, path, "/v1/whoami?name=done")
|
||||||
|
assert.Equal(t, http.StatusNoContent, status)
|
||||||
|
assert.Empty(t, body)
|
||||||
|
|
||||||
|
status, body, hdr := test.HTTPDo(t, path, http.MethodPost, "/v1/whoami?name=alice")
|
||||||
|
assert.Equal(t, http.StatusMethodNotAllowed, status)
|
||||||
|
assert.Equal(t, http.MethodGet, hdr.Get("Allow"))
|
||||||
|
assert.Contains(t, body, "read only")
|
||||||
|
|
||||||
|
status, _, _ = test.HTTPDo(t, path, http.MethodDelete, "/v1")
|
||||||
|
assert.Equal(t, http.StatusMethodNotAllowed, status)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInfoPanicDoesNotKillTheDaemon: a broken command costs a request, not the overlay.
|
||||||
|
// This surface may be open to anyone on the host, so that holds against them too.
|
||||||
|
func TestInfoPanicDoesNotKillTheDaemon(t *testing.T) {
|
||||||
|
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||||
|
|
||||||
|
status, body := test.HTTPGet(t, path, "/v1/whoami?name=boom")
|
||||||
|
assert.Equal(t, http.StatusInternalServerError, status)
|
||||||
|
assert.JSONEq(t, `{"error":"command failed"}`, body)
|
||||||
|
|
||||||
|
status, body = test.HTTPGet(t, path, "/v1/whoami?name=alice")
|
||||||
|
assert.Equal(t, http.StatusOK, status)
|
||||||
|
assert.JSONEq(t, `{"name":"alice"}`, body)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInfoDescribe(t *testing.T) {
|
||||||
|
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||||
|
|
||||||
|
status, body := test.HTTPGet(t, path, "/v1")
|
||||||
|
require.Equal(t, http.StatusOK, status)
|
||||||
|
|
||||||
|
var schema []commands.CommandSchema
|
||||||
|
require.NoError(t, json.Unmarshal([]byte(body), &schema))
|
||||||
|
|
||||||
|
var names []commands.Name
|
||||||
|
flags := map[commands.Name][]string{}
|
||||||
|
for _, c := range schema {
|
||||||
|
names = append(names, c.Name)
|
||||||
|
for _, f := range c.Flags {
|
||||||
|
flags[c.Name] = append(flags[c.Name], f.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assert.ElementsMatch(t, []commands.Name{"help", "whoami"}, names, "only what is served is described")
|
||||||
|
assert.Equal(t, []string{"name", "shout", commands.FlagJSON, commands.FlagPretty}, flags["whoami"])
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInfoPresentationFlags: the query string takes -json and -pretty as a command line
|
||||||
|
// would. The answer is JSON either way; pretty indents it.
|
||||||
|
func TestInfoPresentationFlags(t *testing.T) {
|
||||||
|
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||||
|
|
||||||
|
_, compact := test.HTTPGet(t, path, "/v1/whoami?name=alice&json=true")
|
||||||
|
//nolint:testifylint // the exact bytes, newline included, are what is under test
|
||||||
|
assert.Equal(t, "{\"name\":\"alice\"}\n", compact)
|
||||||
|
|
||||||
|
_, pretty := test.HTTPGet(t, path, "/v1/whoami?name=alice&pretty")
|
||||||
|
//nolint:testifylint // the layout is what is under test
|
||||||
|
assert.Equal(t, "{\n \"name\": \"alice\"\n}\n", pretty)
|
||||||
|
|
||||||
|
_, off := test.HTTPGet(t, path, "/v1/whoami?name=alice&pretty=false")
|
||||||
|
assert.Equal(t, compact, off)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInfoModeChangeRefusesASwappedSocket: whoever can write the directory can replace
|
||||||
|
// the node with a link to a file of their choosing; the daemon must not set the
|
||||||
|
// operator's mode on that file. The node is seen to be gone, the link is refused by the
|
||||||
|
// stale check, the file is untouched, and the endpoint reports itself down, since
|
||||||
|
// nothing of ours is reachable at the path.
|
||||||
|
func TestInfoModeChangeRefusesASwappedSocket(t *testing.T) {
|
||||||
|
s, path := serveInfo(t, infoRegistry(), 0600)
|
||||||
|
|
||||||
|
target := filepath.Join(filepath.Dir(path), "target")
|
||||||
|
require.NoError(t, os.WriteFile(target, nil, 0600))
|
||||||
|
require.NoError(t, os.Remove(path))
|
||||||
|
require.NoError(t, os.Symlink(target, path))
|
||||||
|
|
||||||
|
err := s.Rebind(context.Background(), path, Access{Mode: 0666})
|
||||||
|
require.ErrorContains(t, err, "is not a socket")
|
||||||
|
fi, err := os.Stat(target)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, os.FileMode(0600), fi.Mode().Perm(), "the file behind the link keeps its mode")
|
||||||
|
assert.Empty(t, s.Path(), "nothing of ours answers at the path, so nothing is served")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInfoConfig(t *testing.T) {
|
||||||
|
load := func(t *testing.T, yaml string) (infoConfig, error) {
|
||||||
|
t.Helper()
|
||||||
|
c := config.NewC(test.NewLogger())
|
||||||
|
require.NoError(t, c.LoadString(yaml))
|
||||||
|
return infoConfigFrom(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg, err := load(t, "local_api: {}\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.False(t, cfg.Enabled)
|
||||||
|
|
||||||
|
cfg, err = load(t, "local_api:\n info:\n socket: /run/nebula/info.sock\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.False(t, cfg.Enabled, "a socket alone does not enable it")
|
||||||
|
|
||||||
|
_, err = load(t, "local_api:\n info:\n enabled: true\n")
|
||||||
|
require.Error(t, err)
|
||||||
|
require.ErrorContains(t, err, "needs a socket path")
|
||||||
|
|
||||||
|
cfg, err = load(t, "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, infoConfig{Enabled: true, Path: "/run/nebula/info.sock", Access: Access{Mode: 0600}}, cfg)
|
||||||
|
|
||||||
|
cfg, err = load(t, "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n socket_mode: \"0660\"\n")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, infoConfig{Enabled: true, Path: "/run/nebula/info.sock", Access: Access{Mode: 0660}}, cfg)
|
||||||
|
|
||||||
|
_, err = load(t, "local_api:\n info:\n enabled: true\n socket: run/info.sock\n")
|
||||||
|
require.Error(t, err, "a relative socket path is refused rather than resolved against anything")
|
||||||
|
require.ErrorContains(t, err, "must be an absolute path")
|
||||||
|
require.ErrorContains(t, err, InfoSocketKey)
|
||||||
|
|
||||||
|
_, err = load(t, "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n socket_mode: 0660\n")
|
||||||
|
require.Error(t, err, "a bare number is whichever integer the yaml parser made of it")
|
||||||
|
require.ErrorContains(t, err, "quoted octal string")
|
||||||
|
|
||||||
|
for _, bad := range []string{`"abc"`, `"1777"`, `"08"`} {
|
||||||
|
_, err = load(t, "local_api:\n info:\n enabled: true\n socket: /run/nebula/info.sock\n socket_mode: "+bad+"\n")
|
||||||
|
require.Error(t, err, bad)
|
||||||
|
require.ErrorContains(t, err, "not an octal file mode", bad)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = load(t, fmt.Sprintf("local_api:\n info:\n enabled: true\n socket: /%s\n", strings.Repeat("x", sunPathMax)))
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.ErrorContains(t, err, "too long")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWireInfoFollowsConfig: off by default, up when enabled, down when disabled, and
|
||||||
|
// never on the control socket's path.
|
||||||
|
func TestWireInfoFollowsConfig(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
t.Cleanup(cancel)
|
||||||
|
|
||||||
|
ctlPath := testSocket(t)
|
||||||
|
infoPath := testSocket(t)
|
||||||
|
section := func(enabled bool, socket string) string {
|
||||||
|
return fmt.Sprintf("local_api:\n control:\n socket: %s\n info:\n enabled: %t\n socket: %s\n", ctlPath, enabled, socket)
|
||||||
|
}
|
||||||
|
|
||||||
|
c := config.NewC(test.NewLogger())
|
||||||
|
require.NoError(t, c.LoadString(section(false, infoPath)))
|
||||||
|
|
||||||
|
var logs lockedBuffer
|
||||||
|
eps := Wire(ctx, test.NewLoggerWithOutput(&logs), c, infoRegistry())
|
||||||
|
t.Cleanup(eps.Stop)
|
||||||
|
assert.Equal(t, ctlPath, eps.Control.Path())
|
||||||
|
assert.Empty(t, eps.Info.Path(), "off until enabled")
|
||||||
|
|
||||||
|
require.NoError(t, c.ReloadConfigString(section(true, infoPath)).Err)
|
||||||
|
assert.Equal(t, infoPath, eps.Info.Path())
|
||||||
|
status, body := test.HTTPGet(t, infoPath, "/v1/whoami?name=alice")
|
||||||
|
assert.Equal(t, http.StatusOK, status)
|
||||||
|
assert.JSONEq(t, `{"name":"alice"}`, body)
|
||||||
|
|
||||||
|
// A reload that changes nothing leaves it where it is.
|
||||||
|
require.NoError(t, c.ReloadConfigString(section(true, infoPath)).Err)
|
||||||
|
assert.Equal(t, infoPath, eps.Info.Path())
|
||||||
|
|
||||||
|
// A reload that moves the socket moves it, and removes the old one.
|
||||||
|
moved := testSocket(t)
|
||||||
|
require.NoError(t, c.ReloadConfigString(section(true, moved)).Err)
|
||||||
|
assert.Equal(t, moved, eps.Info.Path())
|
||||||
|
_, err := os.Stat(infoPath)
|
||||||
|
assert.True(t, os.IsNotExist(err))
|
||||||
|
status, body = test.HTTPGet(t, moved, "/v1/whoami?name=bob")
|
||||||
|
assert.Equal(t, http.StatusOK, status)
|
||||||
|
assert.JSONEq(t, `{"name":"bob"}`, body)
|
||||||
|
require.NoError(t, c.ReloadConfigString(section(true, infoPath)).Err)
|
||||||
|
require.Equal(t, infoPath, eps.Info.Path())
|
||||||
|
|
||||||
|
// The control socket's path is refused, and the running endpoint is kept, which is
|
||||||
|
// what the log says.
|
||||||
|
require.NoError(t, c.ReloadConfigString(section(true, ctlPath)).Err)
|
||||||
|
assert.Equal(t, infoPath, eps.Info.Path())
|
||||||
|
assert.Equal(t, ctlPath, eps.Control.Path())
|
||||||
|
assert.Contains(t, logs.String(), "keeping the current endpoint")
|
||||||
|
assert.NotContains(t, logs.String(), "Local info API is not available")
|
||||||
|
|
||||||
|
require.NoError(t, c.ReloadConfigString(section(false, infoPath)).Err)
|
||||||
|
assert.Empty(t, eps.Info.Path())
|
||||||
|
_, err = os.Stat(infoPath)
|
||||||
|
assert.True(t, os.IsNotExist(err))
|
||||||
|
|
||||||
|
// One Stop takes both down.
|
||||||
|
require.NoError(t, c.ReloadConfigString(section(true, infoPath)).Err)
|
||||||
|
eps.Stop()
|
||||||
|
assert.Empty(t, eps.Info.Path())
|
||||||
|
assert.Empty(t, eps.Control.Path())
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestWireInfoKeepsRunningOnABadReload: a typo in the section must not cut off the
|
||||||
|
// programs relying on the endpoint; the operator is told and the endpoint stays.
|
||||||
|
func TestWireInfoKeepsRunningOnABadReload(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
t.Cleanup(cancel)
|
||||||
|
|
||||||
|
infoPath := testSocket(t)
|
||||||
|
good := fmt.Sprintf("local_api:\n info:\n enabled: true\n socket: %s\n", infoPath)
|
||||||
|
|
||||||
|
c := config.NewC(test.NewLogger())
|
||||||
|
require.NoError(t, c.LoadString(good))
|
||||||
|
|
||||||
|
srv := wireInfo(ctx, test.NewLogger(), c, infoRegistry())
|
||||||
|
t.Cleanup(srv.Stop)
|
||||||
|
require.Equal(t, infoPath, srv.Path())
|
||||||
|
|
||||||
|
require.NoError(t, c.ReloadConfigString(good+" socket_mode: 0660\n").Err)
|
||||||
|
assert.Equal(t, infoPath, srv.Path())
|
||||||
|
status, _ := test.HTTPGet(t, infoPath, "/v1/whoami")
|
||||||
|
assert.Equal(t, http.StatusOK, status)
|
||||||
|
}
|
||||||
|
|
||||||
|
// rawInfoRequest opens the socket and writes req as it is, so a test can send what an
|
||||||
|
// HTTP client would not: a body that never arrives. It returns the connection.
|
||||||
|
func rawInfoRequest(t *testing.T, path, req string) net.Conn {
|
||||||
|
t.Helper()
|
||||||
|
conn, err := net.DialTimeout("unix", path, time.Second)
|
||||||
|
require.NoError(t, err)
|
||||||
|
t.Cleanup(func() { _ = conn.Close() })
|
||||||
|
_, err = conn.Write([]byte(req))
|
||||||
|
require.NoError(t, err)
|
||||||
|
return conn
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInfoRefusesARequestBody: a request that announces a body is answered 400 at once,
|
||||||
|
// before the body arrives, and the connection is closed once the read deadline has ended
|
||||||
|
// the wait for it, so a client that never sends the body holds its slot for the deadline
|
||||||
|
// and no longer.
|
||||||
|
func TestInfoRefusesARequestBody(t *testing.T) {
|
||||||
|
oldHeader, oldRead := infoReadHeaderTimeout, infoReadTimeout
|
||||||
|
infoReadHeaderTimeout, infoReadTimeout = 200*time.Millisecond, 300*time.Millisecond
|
||||||
|
t.Cleanup(func() { infoReadHeaderTimeout, infoReadTimeout = oldHeader, oldRead })
|
||||||
|
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||||
|
|
||||||
|
start := time.Now()
|
||||||
|
conn := rawInfoRequest(t, path, "GET /v1/whoami HTTP/1.1\r\nHost: nebula\r\nContent-Length: 10\r\n\r\n")
|
||||||
|
require.NoError(t, conn.SetReadDeadline(time.Now().Add(2*time.Second)))
|
||||||
|
res, err := http.ReadResponse(bufio.NewReader(conn), nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
body, _ := io.ReadAll(res.Body)
|
||||||
|
res.Body.Close()
|
||||||
|
assert.Equal(t, http.StatusBadRequest, res.StatusCode)
|
||||||
|
assert.Contains(t, string(body), "takes no request body")
|
||||||
|
assert.True(t, res.Close, "the connection is not kept for another request")
|
||||||
|
assert.Less(t, time.Since(start), 200*time.Millisecond, "answered before the body, which never comes")
|
||||||
|
|
||||||
|
_, err = conn.Read(make([]byte, 1))
|
||||||
|
require.ErrorIs(t, err, io.EOF, "the server closed the connection")
|
||||||
|
assert.Less(t, time.Since(start), time.Second, "and did so at the read deadline, not later")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestInfoDropsASlowClient: a client that sends its headers and then nothing loses its
|
||||||
|
// connection at the read timeout rather than holding a slot for as long as it likes.
|
||||||
|
func TestInfoDropsASlowClient(t *testing.T) {
|
||||||
|
oldHeader, oldRead := infoReadHeaderTimeout, infoReadTimeout
|
||||||
|
infoReadHeaderTimeout, infoReadTimeout = 200*time.Millisecond, 300*time.Millisecond
|
||||||
|
t.Cleanup(func() { infoReadHeaderTimeout, infoReadTimeout = oldHeader, oldRead })
|
||||||
|
_, path := serveInfo(t, infoRegistry(), 0600)
|
||||||
|
|
||||||
|
// Half a request line, then silence: the header deadline ends it.
|
||||||
|
conn := rawInfoRequest(t, path, "GET /v1/whoami HTTP/1.1\r\nHost: neb")
|
||||||
|
require.NoError(t, conn.SetReadDeadline(time.Now().Add(2*time.Second)))
|
||||||
|
start := time.Now()
|
||||||
|
_, err := conn.Read(make([]byte, 1))
|
||||||
|
require.Error(t, err, "the server closed the connection")
|
||||||
|
assert.Less(t, time.Since(start), time.Second)
|
||||||
|
|
||||||
|
// And the server still answers the next client.
|
||||||
|
status, _ := test.HTTPGet(t, path, "/v1/whoami")
|
||||||
|
assert.Equal(t, http.StatusOK, status)
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
//go:build windows
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/Microsoft/go-winio"
|
||||||
|
"github.com/slackhq/nebula/commands"
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"golang.org/x/sys/windows"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TestInfoIsServedOnAPipe: the info API serves HTTP on a named pipe, whose security
|
||||||
|
// descriptor is its access control the way a socket's mode is on unix; a group named
|
||||||
|
// in the config is admitted by it.
|
||||||
|
func TestInfoIsServedOnAPipe(t *testing.T) {
|
||||||
|
users, err := windows.CreateWellKnownSid(windows.WinBuiltinUsersSid)
|
||||||
|
require.NoError(t, err)
|
||||||
|
group := Group{Name: "Users", ID: users.String()}
|
||||||
|
|
||||||
|
s := NewInfoServer(test.NewLogger(), commands.New())
|
||||||
|
path := pipePrefix + "nebula-info-test"
|
||||||
|
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: groupSocketMode, Group: group}))
|
||||||
|
t.Cleanup(s.Stop)
|
||||||
|
assert.Equal(t, path, s.Path())
|
||||||
|
|
||||||
|
client := &http.Client{Transport: &http.Transport{
|
||||||
|
// What a program on the host has to do: ask for the data rights alone, since the
|
||||||
|
// group is granted no more; see pipeClientAccess.
|
||||||
|
DialContext: func(ctx context.Context, _, _ string) (net.Conn, error) {
|
||||||
|
ctx, cancel := context.WithTimeout(ctx, 2*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
return winio.DialPipeAccess(ctx, path, pipeClientAccess)
|
||||||
|
},
|
||||||
|
}}
|
||||||
|
res, err := client.Get("http://nebula/v1")
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer res.Body.Close()
|
||||||
|
body, err := io.ReadAll(res.Body)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, http.StatusOK, res.StatusCode)
|
||||||
|
assert.Contains(t, string(body), `"help"`)
|
||||||
|
|
||||||
|
// A change of group means a new pipe under the same name, still serving.
|
||||||
|
require.NoError(t, s.Rebind(context.Background(), path, Access{Mode: groupSocketMode}))
|
||||||
|
res, err = client.Get("http://nebula/v1")
|
||||||
|
require.NoError(t, err)
|
||||||
|
res.Body.Close()
|
||||||
|
assert.Equal(t, http.StatusOK, res.StatusCode)
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
package localapi
|
||||||
|
|
||||||
|
// DirName is the directory under /var/run that holds nebula's sockets by default.
|
||||||
|
const DirName = "nebula"
|
||||||
|
|
||||||
|
// CtlEnabledKey is the optional config key that turns the control socket off. It is on
|
||||||
|
// unless the config says false, and reloadable: a reload that turns it off removes the
|
||||||
|
// socket, and one that turns it back on brings it up again.
|
||||||
|
const CtlEnabledKey = "local_api.control.enabled"
|
||||||
|
|
||||||
|
// ControlEnabled reports whether a config leaves the control socket on. nebula ctl reads
|
||||||
|
// it too, so a client pointed at a config that turned the socket off says so rather than
|
||||||
|
// failing to dial.
|
||||||
|
func ControlEnabled(c interface{ GetBool(string, bool) bool }) bool {
|
||||||
|
return c.GetBool(CtlEnabledKey, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CtlSocketKey is the optional config key naming the control socket. Unset, the socket
|
||||||
|
// is DefaultSocketPath, one fixed path per platform that both the daemon and nebula ctl
|
||||||
|
// know, which is what lets the endpoint work with no configuration on either side. It
|
||||||
|
// suits a daemon running as root, which is what the tun device needs anyway. A daemon run as another user, or a second daemon on
|
||||||
|
// one host, names its own. The CLI reads the same key, so when both sides see the same
|
||||||
|
// config file they agree on the socket with nothing more said.
|
||||||
|
const CtlSocketKey = "local_api.control.socket"
|
||||||
|
|
||||||
|
// CtlGroupKey is the optional config key naming a group that shares the control socket.
|
||||||
|
// Unset, the socket admits the account nebula runs as and nobody else. Set, the socket
|
||||||
|
// is handed to the group, 0660 on unix and an entry in the pipe's security descriptor on
|
||||||
|
// windows; see Access and Server.trustSocket.
|
||||||
|
const CtlGroupKey = "local_api.control.group"
|
||||||
|
|
||||||
|
// controlAccessFrom returns the control socket's access a config implies: the group
|
||||||
|
// CtlGroupKey names, if any, and the mode that goes with having one or not.
|
||||||
|
func controlAccessFrom(c interface{ GetString(string, string) string }) (Access, error) {
|
||||||
|
group, err := groupFromConfig(c, CtlGroupKey)
|
||||||
|
if err != nil {
|
||||||
|
return Access{}, err
|
||||||
|
}
|
||||||
|
if group.ID == "" {
|
||||||
|
return ownerOnly(), nil
|
||||||
|
}
|
||||||
|
return Access{Mode: groupSocketMode, Group: group}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SocketPathFromConfig returns the control socket path a config implies: CtlSocketKey
|
||||||
|
// when it is set, else DefaultSocketPath. A configured path must be absolute, so that
|
||||||
|
// the daemon and nebula ctl, started from wherever the operator happens to be, name the
|
||||||
|
// same socket from one config, and one this platform can bind; see checkSocketPath.
|
||||||
|
func SocketPathFromConfig(c interface{ GetString(string, string) string }) (string, error) {
|
||||||
|
override := c.GetString(CtlSocketKey, "")
|
||||||
|
if override == "" {
|
||||||
|
return DefaultSocketPath, nil
|
||||||
|
}
|
||||||
|
if err := checkSocketPath(CtlSocketKey, override); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return override, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
//go:build !windows
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
type fakeConfig map[string]string
|
||||||
|
|
||||||
|
func (f fakeConfig) GetString(k, d string) string {
|
||||||
|
if v, ok := f[k]; ok {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSocketPathFromConfigUsesTheDefault is what makes the endpoint work with no
|
||||||
|
// configuration: the daemon and the CLI both land on the one fixed path.
|
||||||
|
func TestSocketPathFromConfigUsesTheDefault(t *testing.T) {
|
||||||
|
p, err := SocketPathFromConfig(fakeConfig{})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "/var/run/nebula/ctl.sock", p)
|
||||||
|
assert.Equal(t, DefaultSocketPath, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSocketPathFromConfigHonoursOverride(t *testing.T) {
|
||||||
|
p, err := SocketPathFromConfig(fakeConfig{CtlSocketKey: "/tmp/custom.sock"})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "/tmp/custom.sock", p, "the path is used as given")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestSocketPathFromConfigRefusesARelativeOverride: the daemon and the CLI are started
|
||||||
|
// from different directories, so a relative path would name two sockets from one config.
|
||||||
|
// It is refused rather than resolved against anything.
|
||||||
|
func TestSocketPathFromConfigRefusesARelativeOverride(t *testing.T) {
|
||||||
|
for _, rel := range []string{"run/ctl.sock", "./ctl.sock", "ctl.sock", "../ctl.sock"} {
|
||||||
|
_, err := SocketPathFromConfig(fakeConfig{CtlSocketKey: rel})
|
||||||
|
require.Error(t, err, rel)
|
||||||
|
require.ErrorContains(t, err, "must be an absolute path", rel)
|
||||||
|
assert.ErrorContains(t, err, CtlSocketKey, rel)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSocketPathFromConfigRejectsOverlongOverride(t *testing.T) {
|
||||||
|
_, err := SocketPathFromConfig(fakeConfig{CtlSocketKey: "/" + strings.Repeat("x", sunPathMax)})
|
||||||
|
assert.ErrorContains(t, err, "too long for this platform")
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
//go:build darwin || freebsd
|
||||||
|
|
||||||
|
package localapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net"
|
||||||
|
|
||||||
|
"golang.org/x/sys/unix"
|
||||||
|
)
|
||||||
|
|
||||||
|
// peerCheckSupported reports that this platform can identify a connecting process.
|
||||||
|
const peerCheckSupported = true
|
||||||
|
|
||||||
|
// peerUID returns the uid of the process on the other end of conn.
|
||||||
|
func peerUID(conn net.Conn) (uid uint32, err error) {
|
||||||
|
err = withPeerFD(conn, func(fd int) error {
|
||||||
|
xu, credErr := unix.GetsockoptXucred(fd, unix.SOL_LOCAL, unix.LOCAL_PEERCRED)
|
||||||
|
if credErr != nil {
|
||||||
|
return credErr
|
||||||
|
}
|
||||||
|
uid = xu.Uid
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
return uid, err
|
||||||
|
}
|
||||||
Loaded 100 of 224 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user