spior 0.1.6 → 0.3.5

data/lib/spior/tor/config.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'tempfile'
+require 'auth'
+
+module Spior
+  module Tor
+    # Generate a config file (torrc) for Spior
+    class Config
+      # ==== Attributes
+      #
+      # * +filename+ - A reference to a tempfile like filename=Tempfile.new('foo')
+      #
+      def initialize(filename)
+        @filename = filename
+        @config_torrc = '/etc/tor/torrc'
+        @config_dir = '/etc/torrc.d'
+        @config_spiorrc = "#{@config_dir}/spior.conf"
+        @content = ['# Generated by Spior, don\'t edit.']
+        @content_torrc = []
+      end
+
+      # Generate a `torrc` compatible file for Spior
+      # Use value from Spior::CONFIG
+      def generate
+        create_config_dir
+        configure_torrc
+        generate_content(@content)
+        return if @content.length == 1
+
+        cn = @content.join("\n")
+        File.write(@filename.path, "#{cn}\n")
+        Msg.p "Generating #{@config_spiorrc}..."
+        move(@filename.path, @config_spiorrc)
+      end
+
+      def write_file(content, file, mode = 'a')
+        return if content.nil?
+
+        File.open(file, mode) do |f|
+          if content.is_a?(Array)
+            f.puts(content.join('\n'))
+          else
+            f.puts(content)
+          end
+          # f.chmod(644)
+        end
+      end
+
+      # Save current Tor options (Spior::CONFIG) in /etc/tor/torrc
+      # Only if theses options are not alrealy present
+      def backup
+        generate_content(@content_torrc)
+        write_file @content_torrc, @filename.path, 'w'
+
+        Msg.p 'Saving Tor options...'
+        move(@filename.path, @config_spiorrc)
+      end
+
+      protected
+
+      def create_config_dir
+        return if Dir.exist? @config_dir
+
+        if Process::Sys.getuid == '0'
+          File.mkdir @config_dir
+        else
+          Auth.new.mkdir @config_dir
+        end
+      end
+
+      def configure_torrc
+        temp = Tempfile.new('torrc')
+        content = File.read(@config_torrc)
+        adding content, "%include #{@config_dir}/*.conf"
+        write_file content, temp.path
+        move(temp.path, @config_torrc)
+      end
+
+      def generate_content(content)
+        adding content, 'AutomapHostsOnResolve 1'
+        adding content, "DNSPort #{CONFIG.dns_port}"
+        adding content, "VirtualAddrNetworkIpv4 #{CONFIG.virt_addr}"
+        adding content, "TransPort #{CONFIG.trans_port} IsolateClientAddr
+               IsolateClientProtocol IsolateDestAddr IsolateDestPort"
+      end
+
+      private
+
+      def search(option_name)
+        File.open(@config_torrc) do |f|
+          f.each do |line|
+            return Regexp.last_match(1) if line.match(%r{^#{option_name} ([a-z0-9./*]*)}i)
+          end
+        end
+        false
+      end
+
+      def adding(content, option)
+        o = option.split(' ')
+        all = o[1..o.length].join(' ')
+        return if search(o[0])
+
+        content << "#{o[0]} #{all}"
+      end
+
+      def digest_match?(src, dest)
+        return unless File.exist?(dest)
+
+        md5_src = Digest::MD5.file src
+        md5_dest = Digest::MD5.file dest
+        md5_src == md5_dest
+      end
+
+      # Permission for Archlinux on a torrc are chmod 644, chown root:root
+      def fix_perm(file)
+        if Process::Sys.getuid == '0'
+          file.chown(0, 0)
+        else
+          Helpers::Exec.new('chown').run("root:root #{file}")
+        end
+      end
+
+      def move(src, dest)
+        return if digest_match? src, dest
+
+        fix_perm(@filename.path)
+        if Process::Sys.getuid == '0'
+          FileUtils.mv(src, dest)
+        else
+          Helpers::Exec.new('mv').run("#{src} #{dest}")
+        end
+      end
+    end
+  end
+end

data/lib/spior/tor/data.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'nomansland'
+
+module Spior
+  module Tor
+    ##
+    # Data
+    # Fill Spior::CONFIG with data found on `/etc/tor/torrc` or set default.
+    #
+    # ==== Attributes
+    #
+    # * +user+ - Username used by Tor on your distro, e.g 'tor' on Archlinux
+    # * +dns_port+ - Open this port to listen for UDP DNS requests, and resolve them anonymously
+    # * +uid+ - The uid value from the user attribute.
+    # * +trans_port+ - Port to open to listen for transparent proxy connections.
+    # * +virt_addr+ - Default use '10.192.0.0/10'.
+    #
+    class Data
+      attr_accessor :user, :dns_port, :trans_port, :virt_addr, :uid
+
+      def initialize
+        @user = search('User') || 'tor'
+        @dns_port = search('DNSPort') || '9061'
+        @trans_port = search('TransPort') || '9040'
+        @virt_addr = search('VirtualAddrNetworkIPv4') || '10.192.0.0/10'
+        @uid = search_uid || 0
+      end
+
+      private
+
+      # Search value of option_name in the /etc/tor/torrc
+      # Return false by default
+      def search(option_name)
+        File.open('/etc/tor/torrc') do |f|
+          f.each do |line|
+            return Regexp.last_match(1) if line.match(%r{#{option_name} ([a-z0-9./]*)}i)
+          end
+        end
+        false
+      end
+
+      def search_uid
+        case Nomansland.distro?
+        when :debian || :ubuntu
+          `id -u debian-tor`.chomp
+        else
+          `id -u #{@user}`.chomp
+        end
+      end
+    end
+  end
+end

data/lib/spior/tor/start.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'nomansland'
+require 'tempfile'
+
+module Spior
+  # Module Spior::Tor used to start/stop/restart Tor on the system.
+  module Tor
+    # start should start the Tor service on your distribution
+    class Start
+      def initialize
+        tmp_file = Tempfile.new('torrc')
+
+        Config.new(tmp_file).generate
+
+        nomansland
+      end
+
+      protected
+
+      def nomansland
+        case Nomansland.init?
+        when :systemd
+          start_systemd
+        when :openrc
+          start_openrc
+        when :runit
+          start_runit
+        else
+          Msg.report "Don't known yet how to start Tor for your system."
+        end
+      end
+
+      private
+
+      def start_systemd
+        state = `systemctl is-active tor`.chomp
+        return if state == 'active'
+
+        Msg.p 'Starting Tor with Systemd...'
+        Helpers::Exec.new('systemctl').run('start tor')
+      end
+
+      def start_openrc
+        Msg.p 'Starting Tor with OpenRC...'
+        Helpers::Exec.new('/etc/init.d/tor').run('start')
+      end
+
+      def start_runit
+        Msg.p 'Starting Tor with Runit...'
+        if File.exist? '/var/service/tor'
+          Helpers::Exec.new('sv').run('start tor')
+        else
+          Helpers::Exec.new('ln').run('-s /etc/sv/tor /var/service/tor')
+        end
+      end
+
+      def x(arg)
+        auth = (Process::Sys.getuid == '0' ? '' : 'sudo')
+        pid = spawn("#{auth} #{arg}", out: '/dev/null') or raise 'Error'
+        Process.wait pid
+      end
+    end
+  end
+end

data/lib/spior/tor/stop.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Spior
+  # Module Spior::Tor used to start/stop/restart Tor on the system.
+  module Tor
+    # Stop Tor service on your distribution (linux)
+    # It also kill previous instance run by Spior
+    class Stop
+      def initialize
+        old_pid = `pgrep -f "tor -f /tmp/torrc*"`.chomp
+
+        if old_pid != ''
+          Msg.p "Found old pid > #{old_pid}, killing it..."
+          Helpers::Exec.new('kill').run("-9 #{old_pid}")
+        end
+
+        nomansland
+      end
+
+      protected
+
+      def nomansland
+        case Nomansland.init?
+        when :systemd
+          stop_systemd
+        when :runit
+          stop_runit
+        when :openrc
+          stop_openrc
+        else
+          Msg.report 'Don\'t known how to stop Tor on your system.'
+        end
+      end
+
+      private
+
+      def stop_systemd
+        Msg.p 'Stopping Tor with Systemd...'
+        Helpers::Exec.new('systemctl').run('stop tor')
+      end
+
+      def stop_runit
+        Msg.p 'Stopping Tor with Runit...'
+        Helpers::Exec.new('sv').run('stop tor')
+      end
+
+      def stop_openrc
+        Msg.p 'Stopping Tor with Openrc...'
+        Helpers::Exec.new('/etc/init.d/tor').run('stop')
+      end
+    end
+  end
+end

data/lib/spior/tor.rb

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 module Spior
+  # The module Tor interract with Tor on your system.
   module Tor
   end
 end
 
-require_relative 'tor/info'
+require_relative 'tor/data'
+require_relative 'tor/config'
+require_relative 'tor/start'
+require_relative 'tor/stop'

data/lib/spior/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spior
-  VERSION = '0.1.6'.freeze
+  VERSION = '0.3.5'
 end

data/lib/spior.rb

@@ -1,44 +1,39 @@
-require_relative 'spior/clear'
-require_relative 'spior/copy'
+# frozen_string_literal: true
+
 require_relative 'spior/dep'
 require_relative 'spior/iptables'
 require_relative 'spior/msg'
 require_relative 'spior/options'
 require_relative 'spior/status'
 require_relative 'spior/tor'
-require_relative 'spior/persist'
 require_relative 'spior/menu'
 require_relative 'spior/service'
 require_relative 'spior/helpers'
+require_relative 'spior/ipv6'
 
 module Spior
+  # Contain value of Tor::Data
+  # Can be customized, e.g:
+  #
+  #   Spior::CONFIG.dns_port = '5353'
+  #   Spior::CONFIG.trans_port = '8888'
+  #   Spior::CONFIG.uid = '666'
+  #   Spior::CONFIG.user = 'Tor-User-System'
+  #   Spior::CONFIG.virt_addr = '10.192.0.0/10'
+  CONFIG = Tor::Data.new
+
+  # Main for the CLI
   class Main
     def initialize(argv)
       @argv = argv
-      run
+      x
     end
 
     private
 
-    def run
-      options = Options.new(@argv)
-
-      if options.install
-        Msg.head
-        Dep.install
-        Copy.new.save
-      end
-
-      Dep.check
-
-      if options.tor
-        Msg.head
-        Iptables::Tor.new.run!
-      end
-
-      if options.persist
-        Persist.enable
-      end
+    def x
+      Msg.banner
+      Options.new(@argv)
     end
   end
 end

data/spior.gemspec

@@ -1,18 +1,20 @@
-require File.dirname(__FILE__) + "/lib/spior/version"
+# frozen_string_literal: true
+
+require "#{File.dirname(__FILE__)}/lib/spior/version"
 
 Gem::Specification.new do |s|
-  s.name = "spior"
+  s.name = 'spior'
   s.version = Spior::VERSION
-  s.summary = "A tool to make TOR your default gateway"
-  s.description = <<-EOF 
+  s.summary = 'A tool to make TOR your default gateway'
+  s.description = <<-DESC
     A tool to make TOR your default gateway
-  EOF
+  DESC
   s.metadata = {
-    "changelog_uri" => "https://github.com/szorfein/spior/blob/master/CHANGELOG.md",
-    "bug_tracker_uri" => "https://github.com/szorfein/spior/issues",
-    "wiki_uri" => "https://github.com/szorfein/spior"
+    'changelog_uri' => 'https://github.com/szorfein/spior/blob/master/CHANGELOG.md',
+    'bug_tracker_uri' => 'https://github.com/szorfein/spior/issues',
+    'wiki_uri' => 'https://github.com/szorfein/spior'
   }
-  s.author = ['szorfein']
+  s.author = 'szorfein'
 
   s.platform = Gem::Platform::RUBY
 
@@ -20,24 +22,25 @@ Gem::Specification.new do |s|
   s.email = 'szorfein@protonmail.com'
   s.homepage = 'https://github.com/szorfein/spior'
 
-  s.files = `git ls-files`.split(" ")
-  s.files.reject! { |fn| fn.include? "certs" }
-  s.files.reject! { |fn| fn.include? "Makefile" }
-  s.executables = [ 'spior' ]
+  s.files = `git ls-files`.split(' ')
+  s.files.reject! { |fn| fn.include? 'certs' }
+  s.files.reject! { |fn| fn.include? 'test' }
+  s.executables = ['spior']
+
+  s.extra_rdoc_files = Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt']
 
-  s.extra_rdoc_files = Dir["README.md", "CHANGELOG.md", "LICENSE.txt"]
+  s.test_files = Dir['test/test_*.rb']
 
-  s.test_files = Dir["test/test_*.rb"]
   s.cert_chain = ['certs/szorfein.pem']
-  s.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
+  s.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
 
   s.requirements << 'tor'
   s.requirements << 'iptables'
 
-  s.required_ruby_version = '>=2.5'
+  s.required_ruby_version = '>= 2.6'
 
-  s.add_runtime_dependency('rainbow', '3.0.0')
-  s.add_runtime_dependency('interfacez', '1.0.3')
-  s.add_runtime_dependency('nomansland', '0.0.3')
-  s.add_runtime_dependency('tty-which', '0.4.2')
+  s.add_runtime_dependency('interfacez', '~> 1.0')
+  s.add_runtime_dependency('nomansland', '~> 0.0')
+  s.add_runtime_dependency('rainbow', '~> 3.1')
+  s.add_runtime_dependency('tty-which', '~> 0.5')
 end

data/test/test_install.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require_relative '../lib/spior/install'
 require 'pathname'
 
 class TestInstall < Minitest::Test
-
   def test_sudo_is_installed
     sudo = `which sudo`
     assert_match(/sudo/, sudo, "sudo isn't installed?")
   end
-
 end

data/test/test_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require_relative '../lib/spior/options'
 

data.tar.gz.sig

@@ -1,2 +1,2 @@
-p@�A��ǝ��#tO܈tf�m
C2z��o��@U�L�fb�C�B)�����n��[�����!�%|�e�w���ϻ��E�Ԟ;������E��@Z:y)�O�$���&smz)Me���$��a��bx�=�gW
-3�����H:F
�%�y���L��R�k����P��sԞ����A���Lx�M�B!�‹�i�%�c�A���P�s6�J�۝2�kϖ�;"<�BG�k�����>^���gk	��R���vH�Y�"��"��F�DL������o�ѻkN��j�$��I��U��M�mt`��ߋa�9Km4#�0��d��GG�d��H�ҩ`M��\
+A��@������s���D�.�뿹
���;��������V}9���Jv�FX�Q.֬ڸK������S�(���v(��:&��]�}xoR�G)4F㎓��u�X ��F�1֠5���Rt��]�[�)р�==y~�r��S��KZ���LtM���j�F�V*����ƽC��o6��.�w��Nf�'kA��9�p�Z�
��)��2�X��:Q�Q���)�H�V�ߛ���)��=��}��k��H��k��OtH9zq�dB��P�}��;��
���h�F
+�}f�,�u�n
aK
ia����tQj�C�\^:�^�x@�s�jS(��.�@���z0���|!x�R�t��9�}�E��}�<o��evq䗎��ч�����7/de�