mullvadrb 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3efb415f1b28c22ae2da6a06d3f2d7d695e84c2bab9e9894d3c3d560b2bca172
-  data.tar.gz: 86fdb6c682838b06643aa6af8db3397e72a7bbc015666e49f76784c1a48b4ac8
+  metadata.gz: 15b1705d449260a54db9087125b5e4a9e0a6db3d548eb5d21dbeac3fb0031a83
+  data.tar.gz: ef45c9ffec12967471be56c4ca096e4af2bd1e4fde8011744bab1333bf17ea7b
 SHA512:
-  metadata.gz: 1621452ffdfe7a4b16d88796839752670752cb7dec214af858455cad4f38dcae77d1992a1e175eadbe9f19d86ccb4332322ed9780f0dcc2ed5b1ea43c99ddb53
-  data.tar.gz: 84a6e4b648fa849c3a0c3f2bc7e660cca96427d92954b9a0ba7a46798b4eca486a4478b761c23de94e115725c170ef37cbdb9100c663b6ae7658a318b2789679
+  metadata.gz: c78f22e514750210bab56f43fb18d06fa214c25832782ba6593ea915cdcc077235c25daf695ba6ea3aac10badc01e85b9a77d854073dcfaf35079ba6ddc33d85
+  data.tar.gz: 8234009792fa8e18dc7efef9a6e78e5441a5448086c0b7e5d42ab0f11fec3a618a1a8a305dfe0f8ac39cd3ba90d386cbc160ef32ea6204e5ae97e714a9f84447

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 0.0.3
+
+Minor cleanup in the code and updates the way status is displayed.
+
+# 0.0.2
+
+I added back the support for WireGuard, in cases you don't want to or can't install the `mullvad` cli app, which was the initial reason I built this. The first time you run the app, it's going to ask you which one you want to use, and save your preference in `~/.local/share/mullvadrb/backend.conf`. You can switch backends from the Main Menu on the app at any time.
+
+- Added extra options on the Main Menu.
+- Refactored the whole code.
+
+# 0.0.1
+
+Initial release. Allows you to use the TUI as an interface for mullvad, the Mullvad VPN CLI.
+
+I  started this script as a test to build a TUI for Mullvad using WireGuard. Then I switched it to use the `mullvad` CLI. It called the command via a menu on the Terminal, allowing to access most (for now) of the CLI app's features.

data/Gemfile

@@ -1,6 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'tty-prompt'
+gemspec
+
+gem 'ostruct'
 
 group :test, :development do
   gem 'debug'

data/README.md

@@ -1,13 +1,39 @@
 # Ruby TUI for Mullvad VPN
 
-This is a Terminal App I wrote for myself to use with Mullvad VPN on Linux. It adds a Ruby terminal interface to [Mullvad CLI](https://mullvad.net/en/help/how-use-mullvad-cli). 
+This is a Terminal App I wrote for myself to use with Mullvad VPN on Linux. It makes it easier for me to choose servers when using Mullvad from the command line.
 
-On first run, you need to log in (unless you've already run `mullvad account login` on your terminal before). The servers list will be updated and will be serialized to `~/.local/share/mullvadrb.dump`.
+![mullvad](https://github.com/user-attachments/assets/1c628381-9a7c-40f4-9376-2f65496b2bc8)
 
+The app has two "backends", [Mullvad CLI](https://mullvad.net/en/help/how-use-mullvad-cli) or [WireGuard](https://mullvad.net/en/help/wireguard-and-mullvad-vpn).
+
+Most of the basic functionality is available for either backend: Select a server (random, by country, specific server), connect, disconnect and show the current status. You can use either backend. The first time you run the app, it's going to ask you which one you want to use, and save your preference in `~/.local/share/mullvadrb/backend.conf`. You can switch backends from the Main Menu on the app at any time.
 
 ## Requirements
 
-You need to have a [Mullvad VPN](https://mullvad.net) account and install [the CLI](https://mullvad.net/en/download/vpn/linux).
+You need to have a [Mullvad VPN](https://mullvad.net) account to use the app.
+
+> [!WARNING]
+> `mullvad` uses WireGuard, so if you change backends while connected to an OpenVPN server with `wg`, `mullvad` won't be able to disconnect from the OpenVPN connection.
+> In general, it's a good idea to stick to one backend, and disconnect from the VPN before switching backends.
+> This might potentially be fixed in the future.
+
+### For the WireGuard backend
+
+You need to [install WireGuard](https://www.wireguard.com/install/) and follow the instructions on [Mullvad: WireGuard on Linux terminal](https://mullvad.net/en/help/wireguard-and-mullvad-vpn). The configuration script you are asked to run in this last link will download the WireGuard configuration files needed to `/etc/wireguard`.
+
+The app is basically a layer on top of `wg-quick`. The scripts it runs are:
+```
+$ wg-quick up <connected server (e.g. uy-mma-wg-001)> # Connect with WireGuard
+$ curl https://am.i.mullvad.net/connected # Check if you're connected to Mullvad
+$ wg-quick down <connected server> # Disconnect
+```
+It uses `sudo` to read the files on `/etc/wireguard` and execute `wg-quick` for connecting and disconnecting.
+
+### For the Mullvad CLI backend
+
+You need to install [the Mullvad CLI](https://mullvad.net/en/download/vpn/linux) to use this backend.
+
+On first run, you need to log in (unless you've already run `mullvad account login` on your terminal before). The servers list will be updated and will be saved to `~/.local/share/mullvadrb.dump`.
 
 ## Development
 
@@ -16,4 +42,3 @@ Run gem from the source:
 ```bash
 $ irb -Ilib -rmullvadrb
 ```
-

data/lib/mullvadrb/command_manager.rb

@@ -0,0 +1,54 @@
+module Mullvadrb
+  module CommandManager
+    def connect
+      if @wg
+        Mullvadrb::WgManager.connect
+      else
+        Mullvadrb::Connection.connect
+      end
+    end
+
+    def disconnect
+      if @wg
+        Mullvadrb::WgManager.disconnect
+      else
+        Mullvadrb::Connection.disconnect
+      end
+    end
+
+    def status
+      if @wg
+        puts Mullvadrb::WgManager.status
+      else
+        puts Mullvadrb::Connection.status
+      end
+    end
+
+    def random
+      if @wg
+        Mullvadrb::WgManager.random
+      else
+        Mullvadrb::Servers.random
+        Mullvadrb::Connection.connect
+      end
+    end
+
+    def country
+      if @wg
+        Mullvadrb::WgManager.country
+      else
+        Mullvadrb::Servers.select_country
+        Mullvadrb::Connection.connect
+      end
+    end
+
+    def specific
+      if @wg
+        Mullvadrb::WgManager.specific
+      else
+        Mullvadrb::Servers.select_specific
+        Mullvadrb::Connection.connect
+      end
+    end
+  end
+end

data/lib/mullvadrb/connection.rb

@@ -26,7 +26,26 @@ module Mullvadrb
       end
 
       def status
-        puts `mullvad status -v`
+        status = `mullvad status -v`
+        if status.start_with?('Disconnected')
+          status.gsub!('Disconnected', "\n⚠ 🚨  DISCONNECTED  🚨 c⚠")
+                .gsub!(/$/, "\n")
+        elsif status.start_with?('Connected')
+          status = status.split("\n")
+                         .sort
+                         .reject { |a| a == 'Connected' }
+                         .prepend("📡 Connected ✅ \n")
+                         .push("\n")
+                         .join("\n")
+        elsif status.start_with?('Connecting')
+          status = status.split("\n")
+                         .sort
+                         .reject { |a| a == 'Connecting' }
+                         .prepend("📞 Connecting ☎ \n")
+                         .push("\n")
+                         .join("\n")
+        end
+        status
       end
     end
   end

data/lib/mullvadrb/servers.rb

@@ -1,106 +1,108 @@
 module Mullvadrb
   module Servers
-    SERVERS_FILE = File.expand_path('~/.local/share/mullvadrb.dump').freeze
+    class << self
+      SERVERS_FILE = File.expand_path('~/.local/share/mullvadrb/servers.dump').freeze
 
-    def update
-      `mullvad relay update`
-      data = `mullvad relay list`
-      country, city, info, flag, value = nil
+      def update
+        `mullvad relay update`
+        data = `mullvad relay list`
+        country, city, info, flag = nil
 
-      # Each line is either a country, a city or a server
-      servers = data.split("\n").compact.reject(&:empty?).map do |s|
-        if s.start_with?("\t\t")
-          info = s.gsub("\t\t", '')
-          { country: country, city: city, info: info, flag: flag, value: info.split(' ').first }
-        elsif s.start_with?("\t")
-          city = s.gsub("\t", '').split("(").first.strip
-          next
-        else
-          regexp = /\(([a-z]{2})\)/ # Country (xx) - Country name + code and group code
-          flag = s.match(regexp)[1]
-                   .upcase
-                   .codepoints
-                   .map { |c| (c + 127397).chr('utf-8') }.join
-          country = s.gsub(regexp, '').strip
-          next
-        end
-      end.compact
+        # Each line is either a country, a city or a server
+        servers = data.split("\n").compact.reject(&:empty?).map do |s|
+          if s.start_with?("\t\t")
+            info = s.gsub("\t\t", '')
+            { country: country, city: city, info: info, flag: flag, value: info.split(' ').first }
+          elsif s.start_with?("\t")
+            city = s.gsub("\t", '').split("(").first.strip
+            next
+          else
+            regexp = /\(([a-z]{2})\)/ # Country (xx) - Country name + code and group code
+            flag = s.match(regexp)[1]
+                     .upcase
+                     .codepoints
+                     .map { |c| (c + 127397).chr('utf-8') }.join
+            country = s.gsub(regexp, '').strip
+            next
+          end
+        end.compact
 
-      save_servers(servers)
-      puts '🗃 Server list updated'
-      puts
-    end
+        save_servers(servers)
+        puts '🗃 Server list updated'
+        puts
+      end
 
-    def select_country
-      servers = @servers
-      country = TTY::Prompt.new.select('Select country', countries(servers), cycle: true, per_page: 10, filter: true, symbols: { marker: '🛫' })
-      connection = servers.select do |s|
-        s[:country] == country
-      end.sample
-      puts `mullvad relay set location #{connection[:value]}`
-    end
+      def select_country
+        servers = @servers
+        country = TTY::Prompt.new.select('Select country', countries(servers), cycle: true, per_page: 10, filter: true, symbols: { marker: '🛫' })
+        connection = servers.select do |s|
+          s[:country] == country
+        end.sample
+        puts `mullvad relay set location #{connection[:value]}`
+      end
 
-    def random
-      server = all_connections.sample
-      puts "Connecting to #{server[:name]}"
-      puts `mullvad relay set location #{server[:value]}`
-    end
+      def random
+        server = all_connections.sample
+        puts "Connecting to #{server[:name]}"
+        puts `mullvad relay set location #{server[:value]}`
+      end
 
-    def select_specific
-      connections = all_connections
-      server = TTY::Prompt.new.select(
-        'Select server',
-        connections,
-        cycle: true,
-        per_page: 10,
-        filter: true,
-        symbols: { marker: '🛫' }
-      )
-      puts `mullvad relay set location #{server}`
-    end
+      def select_specific
+        connections = all_connections
+        server = TTY::Prompt.new.select(
+          'Select server',
+          connections,
+          cycle: true,
+          per_page: 10,
+          filter: true,
+          symbols: { marker: '🛫' }
+        )
+        puts `mullvad relay set location #{server}`
+      end
 
-    def servers
-      @servers ||= load_servers
-    end
+      def servers
+        @servers ||= load_servers
+      end
 
-    private
+      private
 
-    def countries(servers)
-      servers.uniq { |s| s[:country] }.map do |server|
-        {
-          name: "#{server[:flag]} #{server[:country]}",
-          value: server[:country]
-        }
+      def countries(servers)
+        servers.uniq { |s| s[:country] }.map do |server|
+          {
+            name: "#{server[:flag]} #{server[:country]}",
+            value: server[:country]
+          }
+        end
       end
-    end
 
-    def all_connections
-      servers.map do |server|
-        {
-          name: "#{server[:flag]} #{server[:country]} - #{server[:city]}: #{server[:info]}",
-          value: server[:value]
-        }
+      def all_connections
+        servers.map do |server|
+          {
+            name: "#{server[:flag]} #{server[:country]} - #{server[:city]}: #{server[:info]}",
+            value: server[:value]
+          }
+        end
       end
-    end
 
-    def emoji_from_code(code)
-      code.upcase
-        .codepoints
-        .map { |c| (c + 127397).chr('utf-8') }.join
-    end
+      def emoji_from_code(code)
+        code.upcase
+            .codepoints
+            .map { |c| (c + 127_397).chr('utf-8') }.join
+      end
 
-    def load_servers
-      servers = File.expand_path(SERVERS_FILE)
-      if File.file?(servers)
-        Marshal.load(File.read(servers))
-      else
-        update
+      def load_servers
+        servers = File.expand_path(SERVERS_FILE)
+        if File.file?(servers)
+          Marshal.load(File.read(servers))
+        else
+          update
+        end
       end
-    end
 
-    def save_servers(servers)
-      File.open(SERVERS_FILE, 'w+') do |f|
-        f.write(Marshal.dump(servers))
+      def save_servers(servers)
+        File.open(SERVERS_FILE, 'w+') do |f|
+          f.write(Marshal.dump(servers))
+        end
       end
     end
   end

data/lib/mullvadrb/wg_manager.rb

@@ -0,0 +1,96 @@
+require 'countries'
+
+module Mullvadrb
+  module WgManager
+    # Default path, copy the files here from /etc/wireguard (in general)
+    PATH = '/etc/wireguard'
+    FILES = `sudo find /etc/wireguard/ -name *.conf`.split
+    CONFIG = File.expand_path('~/.local/share/mullvadrb/connection.dump').freeze
+
+    CONNECTIONS = FILES.map { |f| f.split('/').last }.uniq.map do |file|
+      country = ISO3166::Country.find_country_by_alpha2(file[0..1].upcase)
+      name = "#{country.common_name} #{country.emoji_flag}"
+      { value: file, name: name }
+    end.sort_by { |c| c[:name] }
+
+    class << self
+      # Select a random VPN connection
+      def random
+        connect(FILES.sample)
+      end
+
+      # Choose by country
+      def country
+        countries = CONNECTIONS.map { |c| { value: c[:value][0..1], name: c[:name] } }.uniq
+        country = TTY::Prompt.new.select('Select country', countries, cycle: true, per_page: 30, filter: true)
+        connect FILES.select { |a| a.split('/').last.start_with?(country) }.sample
+      end
+
+      # Select a specific connection
+      def specific
+        connections = CONNECTIONS.map { |c| { name: "#{c[:value]} #{c[:name]}", value: c[:value] } }
+        connect(
+          TTY::Prompt.new.select('Select configuration file', connections, cycle: true, per_page: 30, filter: true)
+        )
+      end
+
+      # Check status
+      def status
+        status = `curl -s https://am.i.mullvad.net/connected`
+        regexp = /\(server ([a-z]{2})[a-z\-0-9]+\)/
+        # Add country name to the server if we are connected
+        if (match = status.match(regexp))
+          country = CONNECTIONS.find { |c| c[:value][0..1] == match[1] }[:name]
+          status = status.gsub(regexp, "in #{country} \\0")
+        end
+        status
+      end
+
+      def connected?
+        status.match?('You are connected')
+      end
+
+      def load_connection
+        Marshal.load(File.read(CONFIG))
+      end
+
+      def save_connection
+        File.open(CONFIG, 'wb') do |f|
+          f.write(Marshal.dump(@connection))
+        end
+      end
+
+      def connect(selection)
+        connection_file = selection.split('/').last
+        current = status
+        if current.match?('You are connected')
+          server = current.match(/\(server (.*)\)/)[1]
+          puts "Disconnecting from #{server}"
+          disconnect
+        end
+        @connection = connection_file
+        puts "Attempting to connect to #{@connection}"
+        puts system("wg-quick up #{PATH}/#{@connection}")
+        save_connection
+      end
+
+      def disconnect
+        @connection = load_connection
+        if @connection
+          wg_disconnect
+        else
+          puts 'No active connection available'
+        end
+      end
+
+      def wg_disconnect
+        if system("wg-quick down #{PATH}/#{@connection}")
+          puts "🔌 Successfully pulled the plug from #{@connection}"
+        else
+          puts 'Error disconnecting'
+          puts 'Maybe the connection wasn\'t active? 🤨'
+        end
+      end
+    end
+  end
+end

data/lib/mullvadrb.rb

@@ -2,60 +2,104 @@
 
 require 'tty-prompt'
 require 'mullvadrb/account'
+require 'mullvadrb/command_manager'
 require 'mullvadrb/connection'
 require 'mullvadrb/servers'
 
-include Mullvadrb::Servers
-@servers = load_servers
-
-def main_menu
-  TTY::Prompt.new.select('Select', cycle: true, per_page: 10) do |menu|
-    menu.choice name: '📡 Status', value: 'status'
-    menu.choice name: '🎰 Random', value: 'random'
-    menu.choice name: "#{['🌏', '🌎', '🌍'].sample} Choose country", value: 'country'
-    menu.choice name: '🗺 Choose specific', value: 'specific'
-    menu.choice name: '🔌 Disconnect', value: 'disconnect'
-    menu.choice name: '🗃 Update Servers', value: 'update_servers'
-    menu.choice name: '🔑 Log in', value: 'account_login'
-    menu.choice name: '📁 Account info', value: 'account_info'
-    menu.choice name: '🖥 Devices', value: 'account_devices'
-    menu.choice name: '❌ Exit', value: 'exit'
-  end
-end
+module Mullvadrb
+  class Main
+    include Mullvadrb::CommandManager
+    CONFIG_FILE = File.expand_path('~/.local/share/mullvadrb/backend.conf').freeze
+
+    def initialize
+      # To determine if we're using WireGuard or mullvad cli, attempt to load a pre-saved
+      # configuration or prompt the user which one to use:
+      backend = load_config || ask_backend_and_save
+      puts "Using #{backend} backend"
+      puts Mullvadrb::Connection.status
+    end
+
+    def ask_backend_and_save
+      backend = TTY::Prompt.new.select('Which cli backend would you like to use?', cycle: true) do |menu|
+        menu.choice name: 'WireGuard - wg (needs sudo powers)', value: 'wg'
+        menu.choice name: 'Mullvad - mullvad', value: 'mullvad'
+      end
+      @wg = (backend == 'wg')
+      require 'mullvadrb/wg_manager' if @wg
+      dir = File.expand_path('~/.local/share/mullvadrb/')
+      system 'mkdir', '-p', dir unless File.exist?(dir)
+      File.open(CONFIG_FILE, 'w+') { |f| f.write(backend) }
+    end
+
+    def load_config
+      return unless File.exist?(CONFIG_FILE)
+
+      backend = File.read(CONFIG_FILE)
+      @wg = (backend == 'wg')
+      load_servers unless @wg
+      require 'mullvadrb/wg_manager' if @wg
+      backend
+    end
 
-puts Mullvadrb::Connection.status
-
-loop do
-  selection = main_menu
-  puts "\e[H\e[2J"
-  case selection
-  when 'status'
-    puts Mullvadrb::Connection.status
-  when 'disconnect'
-    Mullvadrb::Connection.disconnect
-  when 'country'
-    select_country
-    Mullvadrb::Connection.connect
-  when 'specific'
-    Mullvadrb::Servers.select_specific
-    Mullvadrb::Connection.connect
-  when 'random'
-    random
-    Mullvadrb::Connection.connect
-  when 'update_servers'
-    update
-  when 'account_login'
-    Mullvadrb::Account.login(
-      TTY::Prompt.new.ask('Please enter your account number:')
-    )
-  when 'account_info'
-    Mullvadrb::Account.info
-  when 'account_devices'
-    Mullvadrb::Account.devices
-  when 'exit'
-    abort('Tioraidh!')
+    def load_servers
+      @servers = Mullvadrb::Servers.servers
+    end
+
+    def main_menu
+      choices = common_menu_choices
+      choices.merge!(mullvad_cli_choices) unless @wg
+      choices.merge!({ '❌ Exit' => 'exit' })
+      TTY::Prompt.new.select('Main Menu', choices, cycle: true, per_page: 12)
+    end
+
+    def common_menu_choices
+      {
+        '📡 Status' => 'status',
+        '🎰 Random' => 'random',
+        "#{['🌏', '🌎', '🌍'].sample} Choose country" => 'country',
+        '🗺 Choose specific' => 'specific',
+        '🔌 Disconnect' => 'disconnect',
+        '⚙ Change backend' => 'backend'
+      }
+    end
+
+    def mullvad_cli_choices
+      {
+        '🗃 Update Servers' => 'update_servers',
+        '🔑 Log in' => 'account_login',
+        '📁 Account info' => 'account_info',
+        '🖥 Devices' => 'account_devices'
+      }
+    end
+
+    def run
+      loop do
+        selection = main_menu
+        puts "\e[H\e[2J"
+        case selection
+        when 'status', 'disconnect', 'country', 'specific', 'random'
+          send(selection)
+        when 'exit'
+          abort('Tioraidh!')
+        when 'backend'
+          ask_backend_and_save
+        # Only when using mullvad cli and not wg:
+        when 'update_servers'
+          Mullvadrb::Servers.update
+        when 'account_login'
+          Mullvadrb::Account.login(
+            TTY::Prompt.new.ask('Please enter your account number:')
+          )
+        when 'account_info'
+          Mullvadrb::Account.info
+        when 'account_devices'
+          Mullvadrb::Account.devices
+        end
+      rescue SystemExit, Interrupt
+        abort("\n\nTioraidh!\n")
+      end
+    end
   end
-rescue SystemExit, Interrupt
-  puts
-  exit
 end
+
+Mullvadrb::Main.new.run

data/mullvadrb.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'mullvadrb'
-  s.version       = '0.0.1'
+  s.version       = '0.0.3'
   s.summary       = 'A TUI to use with Mullvad VPN'
   s.description   = 'A Terminal User Interface to use with Mullvad VPN'
   s.authors       = ['Fernando Briano']
@@ -11,4 +11,6 @@ Gem::Specification.new do |s|
   s.license       = 'GPL-3.0-or-later'
   s.required_ruby_version = '>= 3.0'
   s.executables << 'mullvadrb'
+  s.add_dependency 'countries'
+  s.add_dependency 'tty-prompt'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mullvadrb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Fernando Briano
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
-dependencies: []
+date: 2024-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Terminal User Interface to use with Mullvad VPN
 email: fernando@picandocodigo.net
 executables:
@@ -18,13 +46,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - bin/mullvadrb
 - lib/mullvadrb.rb
 - lib/mullvadrb/account.rb
+- lib/mullvadrb/command_manager.rb
 - lib/mullvadrb/connection.rb
 - lib/mullvadrb/servers.rb
+- lib/mullvadrb/wg_manager.rb
 - mullvadrb.gemspec
 homepage: https://github.com/picandocodigo/mullvad-ruby
 licenses: