Merge pull request #135 from Tunnelsats/sub-display

bash-script for TS details

Author: TrezorHannes

FAQ.md

@@ -302,6 +302,11 @@ In addition you can chat to our hosted [Tunnel⚡Sats Bot](https://t.me/TunnelSa
 ### How can I verify that my VPN connection is online and active?
 
 On console, run the following WireGuard command to see some connection statistics, especially check latest handshake for an active VPN connection: `sudo wg show`.
+You can also download a helper script to check your configuration:
+```
+$ wget -O tunnelsats-sub-details.sh https://github.com/tunnelsats/tunnelsats/raw/main/scripts/tunnelsats-sub-details.sh
+$ sudo bash tunnelsats-sub-details.sh
+```
 
 If you're on Telegram, you can chat to our hosted [Tunnel⚡Sats Bot](https://t.me/TunnelSatsBot) and send a `/ping [pubkey@tor.onion]` or `/ping [pubkey@tunnelsats-clearnetIP:port]` to check for a positive connection and speed-report.
 

scripts/tunnelsats-sub-details.sh

@@ -0,0 +1,57 @@
+#!/bin/bash
+
+# Check if script is run with sudo
+if [ "$EUID" -ne 0 ]; then
+  echo "Please run as root: sudo bash tunnelsats-sub-details.sh"
+  exit 1
+fi
+
+# Help text
+if [[ "$1" == "-h" ]]; then
+  echo "Usage: sudo bash tunnelsats-sub-details.sh"
+  echo "This script provides details about your Tunnel⚡️Sats subscription."
+  echo "Beware of scammers, don't ever share your private key."
+  exit 0
+fi
+
+# Function to check Wireguard status and config file
+check_wireguard_status() {
+  wg_output=$(sudo wg show)
+  if ! echo "$wg_output" | grep -q "interface: tunnelsatsv2"; then
+    config_file="/etc/wireguard/tunnelsatsv2.conf"
+    if [ ! -f "$config_file" ]; then
+      echo "The wireguard tunnel seems to be offline, and no tunnelsatsv2.conf could be found in the wireguard directory."
+      echo "Please try a reinstall per https://guide.tunnelsats.com"
+      echo "Alternatively, visit the Tunnel⚡️Sats Telegram Chat: https://t.me/tunnelsats"
+      return 1
+    else
+      echo "The wireguard tunnel seems to be offline. Please try restarting your node."
+      return 1
+    fi
+  fi
+  return 0
+}
+
+# Call the function to check Wireguard status
+check_wireguard_status
+if [ $? -ne 0 ]; then
+  exit 1
+fi
+
+interface="tunnelsatsv2"
+latest_handshake=$(echo "$wg_output" | grep -A 12 "interface: $interface" | grep 'latest handshake' | awk -F': ' '{print $2}')
+transfer=$(echo "$wg_output" | grep -A 12 "interface: $interface" | grep 'transfer' | awk -F': ' '{print $2}')
+public_key=$(echo "$wg_output" | grep -A 5 "interface: $interface" | grep 'public key' | awk -F': ' '{print $2}')
+
+# Display summary
+echo -e "\e[1;32m=================================\e[0m"
+echo -e "\e[1;32mTunnel⚡️Sats Subscription Summary\e[0m"
+echo -e "\e[1;32m=================================\e[0m"
+echo -e "My Wireguard Tunnel Public Key: \e[1;34m$public_key\e[0m"
+echo -e "My transfer since last tunnel restart: \e[1;34m$transfer\e[0m"
+echo -e "Latest handshake with the Tunnel Server: \e[1;34m$latest_handshake\e[0m"
+echo ""
+echo "To validate your subscription details, copy your Wireguard Tunnel Public Key and visit 'https://tunnelsats.com/ > Renew'."
+echo "Use Telegram Reminder Bot to add a secure and anon reminder when your subscription runs out: https://t.me/TunnelSatsReminderBot."
+echo ""
+echo "Thank you for using our Service"