Files
tor-guard-relay/tools/status
rE-Bo0t.bx1 be4f2bc125 feat(v1.1.7): Happy Family support (Tor 0.4.9+ FamilyId)
🔧 New tool: gen-family - generate/view Happy Family keys
  - Supports --force flag to overwrite existing keys without backup prompt

🐳 Dockerfiles: gen-family in both Dockerfile and Dockerfile.edge

🔧 Entrypoint:
- Phase 2: detect *.secret_family_key, log found keys (informational only)
- Guard/exit config gen: append FamilyId + MyFamily from ENV vars
- Bridge intentionally excluded

📊 Status tool: show family key count + Happy Family config state

📚 Docs:
- README: Happy Family section (generate / import), persistence table, flowchart
- ARCHITECTURE: all mermaid diagrams updated (Phase 2, config gen, tools, dirs)
- TOOLS: full gen-family reference with examples and exit codes
- DEPLOYMENT, MIGRATION, MIGRATION-V1.1.X, TROUBLESHOOTING: 5 -> 6 tools
- FAQ, example configs: version bump + FamilyId/MyFamily placeholders
- Directory authority voting: how 9 dirauths vote on relay flags (5/9 consensus)
- CIISS v2 ContactInfo: field reference, generator link, proof:uri-rsa verification
- All TOR_CONTACT_INFO examples updated to CIISS v2 format across templates and docs

📋 Templates:
- Guard/exit/multi-relay compose: TOR_FAMILY_ID + TOR_MY_FAMILY env vars
- All cosmos-compose + docker-compose versions -> 1.1.7

👷 CI: validate.yml gen-family in 8 spots (threshold 6), security tests, quick-test

🛡️ SECURITY.md: 1.1.7 active, 1.1.6 maintenance, gen-family in tools list

🔖 Version bump 1.1.6 -> 1.1.7 across 30+ files, tool count 5 -> 6, CHANGELOG entry

No breaking changes. TOR_FAMILY_ID and TOR_MY_FAMILY are optional.
2026-03-02 16:23:10 +08:00

100 lines
3.4 KiB
Bash

#!/bin/sh
# Enhanced status check (busybox only)
TOR_LOG="${TOR_LOG_DIR:-/var/log/tor}/notices.log"
TOR_DATA="${TOR_DATA_DIR:-/var/lib/tor}"
sanitize_num() {
v=$(printf '%s' "$1" | tr -cd '0-9')
[ -z "$v" ] && v=0
printf '%s' "$v"
}
echo ""
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo "🧅 Tor Relay Status"
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo ""
if pgrep -x tor >/dev/null 2>&1; then
TOR_PID=$(pgrep -x tor)
echo "🚀 Status: RUNNING (PID: $TOR_PID)"
else
echo "❌ Status: STOPPED"
echo ""
exit 1
fi
if [ ! -f "$TOR_LOG" ]; then
echo "⚠️ Log: NOT FOUND"
echo ""
exit 1
fi
if grep -q "Bootstrapped 100%" "$TOR_LOG" 2>/dev/null; then
echo "✅ Bootstrap: 100% COMPLETE"
else
PROGRESS=$(grep "Bootstrapped" "$TOR_LOG" 2>/dev/null | tail -1 | sed 's/.*Bootstrapped \([0-9]*\)%.*/\1/' 2>/dev/null || echo "0")
PROGRESS=$(sanitize_num "$PROGRESS")
echo "⏳ Bootstrap: ${PROGRESS}%"
fi
if grep -q "Self-testing indicates your ORPort is reachable" "$TOR_LOG"; then
echo "🌐 ORPort: REACHABLE"
elif grep -q "ORPort is not reachable" "$TOR_LOG"; then
echo "⚠️ ORPort: NOT REACHABLE"
else
echo "❓ ORPort: TESTING..."
fi
if [ -f "$TOR_DATA/fingerprint" ] && [ -r "$TOR_DATA/fingerprint" ]; then
FINGERPRINT=$(cat "$TOR_DATA/fingerprint" | awk '{print $2}')
NICKNAME=$(cat "$TOR_DATA/fingerprint" | awk '{print $1}')
echo "🪪 Nickname: $NICKNAME"
FP_START=$(printf "%s" "$FINGERPRINT" | cut -c1-8)
FP_END=$(printf "%s" "$FINGERPRINT" | cut -c33-40)
echo "🔑 Fingerprint: ${FP_START}...${FP_END}"
fi
# Happy Family status
FAMILY_KEY_COUNT=0
if [ -d "$TOR_DATA/keys" ]; then
for fk in "$TOR_DATA/keys"/*.secret_family_key; do
[ -f "$fk" ] || continue
FAMILY_KEY_COUNT=$((FAMILY_KEY_COUNT + 1))
done
fi
TORRC="${TOR_CONFIG:-/etc/tor/torrc}"
if [ "$FAMILY_KEY_COUNT" -gt 0 ]; then
echo "👨‍👩‍👧 Family Key: $FAMILY_KEY_COUNT key(s) present"
fi
if [ -f "$TORRC" ] && grep -qi "^FamilyId " "$TORRC" 2>/dev/null; then
echo "✅ Happy Family: CONFIGURED"
elif [ "$FAMILY_KEY_COUNT" -gt 0 ]; then
echo "⚠️ Happy Family: key present but FamilyId not in torrc"
fi
ERRORS=$(grep -c "\[err\]" "$TOR_LOG" 2>/dev/null || echo "0")
ERRORS=$(sanitize_num "$ERRORS")
WARNINGS=$(grep -c "\[warn\]" "$TOR_LOG" 2>/dev/null || echo "0")
WARNINGS=$(sanitize_num "$WARNINGS")
if [ "$ERRORS" -gt 0 ]; then
echo "❌ Errors: $ERRORS (check logs)"
else
echo "✅ Errors: 0"
fi
if [ "$WARNINGS" -gt 5 ]; then
echo "⚠️ Warnings: $WARNINGS"
fi
UPTIME=$(ps -o etime= -p "$TOR_PID" 2>/dev/null | tr -d ' ' || echo "unknown")
[ -n "$UPTIME" ] && echo "⏱️ Uptime: $UPTIME"
echo ""
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo "💡 Tip: Use 'docker logs -f <container>' for live logs"
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
echo ""