spior 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27c8fa0d8922c53ef9e3a7105c34de378489f3e70ddd334fedca96fe354da0ca
-  data.tar.gz: 70dbfd556eecb0db121145b43478129235c26b70a01c8a5c62a1194a9f98df7d
+  metadata.gz: 105d4a29ed0eb407f8116daa49be26a8d8714d999efb531e02676f02c6ed50f3
+  data.tar.gz: 0cfdf8f3a6f857e6d7a1541b103ade1316048c4554ab03076d5d287a2b1ffa1c
 SHA512:
-  metadata.gz: f66d9d28077922f149b01a869a77b494d22d75713f6eeffb65a856efaed6556ec686346de7e1241ede0352328dc4f0e01a9f2c4983a5197aacb28b398413828b
-  data.tar.gz: a14c7edbab9887624014b668377286efb71c5115aebd847ef28da081fedb6dd82882baf0cf8c4175822547d7322e581dd92eefbaf678d7ef69a985152f0190dd
+  metadata.gz: 37258c344e84aa8508a87d6a5b41dc821d54038a9cc163b1976e924301238b5b4debf03c2fba0e0a8015b6d17abedaf4313bdc3beb459eb7add6199f16eb8abe
+  data.tar.gz: fe90d4935a4c36efdfb16553153c67a0a956560edb5515ac8efd412a8319a4f897203027aa55883338a32c3add6be19aa5f96e81bfd1d455e6e71357d4e337ab

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.1.4, release 2020-05-21
+* torrc and resolv.conf are generate dynamically
+* Remove conf/resolv
+* Correct path of conf_dir for the install on gentoo
+* Remove self from lib/copy
+* Correct little error on lib/copy with undefined method `deps`
+
 ## 0.1.3, release 2020-05-14
 * Rename conf dir by ext
 * Clearing all codes about MAC

data/Rakefile

@@ -0,0 +1,19 @@
+# https://github.com/seattlerb/minitest#running-your-tests-
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/test_*.rb"]
+end
+
+namespace :gem do
+  desc "build the gem"
+  task :build do
+    Dir["spior*.gem"].each {|f| File.unlink(f) }
+    system("gem build spior.gemspec")
+    system("gem install spior-0.1.4.gem -P MediumSecurity")
+  end
+end
+
+task :default => :test

data/lib/spior/copy.rb

@@ -6,101 +6,114 @@ require_relative 'helpers'
 
 module Spior
   class Copy
+    class << self
 
-    def self.config_files
-      @cp = Helpers::Exec.new("cp -a")
-      @conf_dir = File.expand_path('../..' + '/ext', __dir__)
-      copy_torrc
-      copy_file(@conf_dir + "/resolv.conf", "/etc/resolv.conf")
-      copy_file(@conf_dir + "/ipt_mod.conf", "/etc/modules-load.d/ipt_mod.conf")
-    end
+      def config_files
+        @cp = Helpers::Exec.new("cp -a")
+        search_conf_dir
+        copy_file(@conf_dir + "/ipt_mod.conf", "/etc/modules-load.d/ipt_mod.conf")
+      end
 
-    def self.restore_files
-      @cp = Helpers::Exec.new("cp -a")
-      backup_exist("/etc/tor/torrc")
-      backup_exist("/etc/resolv.conf")
-    end
+      def backup(file, re = nil)
+        return if regex_match?(file, re)
+        @cp = Helpers::Exec.new("cp -a")
+        backup = file + "_backup"
+        if File.exist? backup
+          puts "File #{backup} exist with content:"
+          system("head -n 10 #{backup}")
+          print "...\nOverwrite this copy? (N/y) "
+          case gets.chomp
+          when /^y|^Y/
+            @cp.run("#{file} #{backup}")
+            Msg.p "Overwrite #{file}"
+          end
+        else
+          @cp.run("#{file} #{backup}")
+          Msg.p "#{file} saved"
+        end
+      end
+
+      def search_conf_dir
+        # ebuild on gentoo copy the ext dir at lib/ext
+        @conf_dir = File.expand_path('../..' + '/lib/ext', __dir__)
+        if not Dir.exist?(@conf_dir)
+          @conf_dir = File.expand_path('../..' + '/ext', __dir__)
+        end
+      end
 
-    def self.search_systemd_dir
-      if Dir.exist?("/usr/lib/systemd/system")
-        @systemd_dir = '/usr/lib/systemd/system'
-      elsif Dir.exist?("/lib/systemd/system")
-        @systemd_dir = '/lib/systemd/system'
-      else
-        Msg.report "Directory systemd/system is no found on your system."
-        exit(-1)
+      def restore(file)
+        @cp = Helpers::Exec.new("cp -a")
+        backup = file + "_backup"
+        if File.exist? backup
+          @cp.run("#{backup} #{file}")
+        end
       end
-    end
 
-    def self.systemd_services
-      @cp = Helpers::Exec.new("cp -a")
-      search_systemd_dir
-      case Nomansland::installer?
-      when :gentoo
-        Msg.p "Copy #{@conf_dir}/iptables.service"
-        copy_file(@conf_dir + "/iptables.service", @systemd_dir + "/iptables.service")
+      def restore_files
+        restore("/etc/tor/torrc")
+        restore("/etc/resolv.conf")
       end
-    end
 
-    private
+      private
 
-    def self.copy_file(conf, target)
-      @config_file = conf
-      return if check_hash(@config_file, target)
-      if File.exist? target then
-        if ! previous_copy target
-          backup_file(target)
-        end 
-        add_file target
-      else
-        add_file target
+      def copy_file(conf, target)
+        @config_file = conf
+        return if check_hash(@config_file, target)
+        if File.exist? target then
+          if ! previous_copy target
+            backup_file(target)
+          end
+          add_file target
+        else
+          add_file target
+        end
       end
-    end
 
-    def self.copy_torrc
-      case Nomansland::distro?
-      when :archlinux
-        copy_file(@conf_dir + "/torrc/torrc_archlinux", "/etc/tor/torrc")
-      else
-        copy_file(@conf_dir + "/torrc/torrc_default", "/etc/tor/torrc")
-        Msg.report "If tor fail to start with the default torrc"
+      def previous_copy(target)
+        backup=`ls #{target}.backup-* | head -n 1`.chomp
+        return false if !File.exist?(backup)
+        check_hash(backup, target)
       end
-    end
 
-    def self.previous_copy(target)
-      backup=`ls #{target}.backup-* | head -n 1`.chomp
-      return false if !File.exist?(backup)
-      check_hash(backup, target)
-    end
+      def check_hash(src, target)
+        return if not File.exist?(target)
+        sha256conf = Digest::SHA256.file src
+        sha256target = Digest::SHA256.file target
+        sha256conf === sha256target
+      end
 
-    def self.check_hash(src, target)
-      return if not File.exist?(target)
-      sha256conf = Digest::SHA256.file src
-      sha256target = Digest::SHA256.file target
-      sha256conf === sha256target
-    end
+      def backup_file(target)
+        d = DateTime.now
+        backup = target + ".backup-" + d.strftime('%b-%d_%I-%M')
+        @cp.run("#{target} #{backup}")
+        puts "Renamed file #{backup}"
+      end
 
-    def self.backup_file(target)
-      d = DateTime.now
-      backup = target + ".backup-" + d.strftime('%b-%d_%I-%M')
-      @cp.run("#{target} #{backup}")
-      puts "Renamed file #{backup}"
-    end
+      def add_file(target)
+        @cp.run("#{@config_file} #{target}")
+        Msg.p "File #{@config_file} has been successfully copied at #{target}"
+      end
 
-    def self.add_file(target)
-      @cp.run("#{@config_file} #{target}")
-      Msg.p "File #{@config_file} has been successfully copied at #{target}"
-    end
+      def backup_exist(target)
+        backup=`ls #{target}.backup-* | head -n 1`.chomp
+        if File.exist? backup
+          if ! check_hash(target, backup)
+            @cp.run("#{backup} #{target}")
+            Msg.p "Restored #{backup}"
+          end
+        else
+          puts "No found previous backup for #{target}"
+        end
+      end
 
-    def self.backup_exist(target)
-      backup=`ls #{target}.backup-* | head -n 1`.chomp
-      if File.exist? backup
-        if ! check_hash(target, backup)
-          @cp.run("#{backup} #{target}")
-          Msg.p "Restored #{backup}"
+      def regex_match?(infile, re = nil)
+        return unless re
+        File.open(infile, 'r') do |file|
+          file.each do |line|
+            return true if line =~ re
+          end
         end
-      else
-        puts "No found previous backup for #{target}"
+        false
       end
     end
   end

data/lib/spior/helpers.rb

@@ -1,8 +1,10 @@
+require 'fileutils'
+require 'tempfile'
+
 module Helpers
   class Exec
     def initialize(name)
-      @search_uid=`id -u`.chomp
-      @search_uid ||= 1000 unless $?.success?
+      @search_uid = Process::Sys.getuid
       @name = name
     end
 
@@ -16,4 +18,95 @@ module Helpers
       end
     end
   end
+
+  # Class Newfile
+  # Create a file and move at the dest
+  # === Example
+  # string = "nameserver 127.0.0.1"
+  # name = "resolv.conf"
+  # dest = "/etc"
+  # new_file = Helpers::Newfile.new(string, name, dest)
+  # new_file.add
+  class NewFile
+    # Method #new
+    # === Parameters
+    # * _string_ = string for the whole file
+    # * _name_ = name of the file (e.g: resolv.conf)
+    # * _dest_ = path (e.g: /etc)
+    def initialize(string, name, dest = "/tmp")
+      @string = string
+      @name = name
+      @dest = dest + "/" + @name
+    end
+
+    # Method #add
+    # Add the file at @dest
+    def add
+      @mv = Helpers::Exec.new("mv")
+      tmp = Tempfile.new(@name)
+      File.open(tmp.path, 'w') do |file|
+        file.puts @string
+      end
+      @mv.run("#{tmp.path} #{@dest}")
+    end
+
+    def perm(user, perm)
+      chown = Helpers::Exec.new("chown")
+      chmod = Helpers::Exec.new("chmod")
+      chown.run("#{user}:#{user} #{@dest}")
+      chmod.run("#{perm} #{@dest}")
+    end
+  end
+
+  # Class NewSystemd
+  # Used to create a systemd service
+  #
+  # === Example:
+  # require Helpers
+  # string = <<EOF
+  # [Description]
+  #
+  # [Service]
+  # Type=simple
+  #
+  # [Installation]
+  # WantedBy =
+  # EOF
+  # new_systemd = Helpers::NewSystemd.new(string, "tor.service")
+  # new_systemd.add
+  class NewSystemd < NewFile
+    # Method #new
+    # === Parameters:
+    # * _string_ = the string of for whole content file
+    # * _name_ = the name of the service (e.g: tor.service)
+    def initialise(string, name)
+      super
+      @systemd_dir = search_systemd_dir
+      @dest = @systemd_dir + "/" + @name
+    end
+
+    # Method #add
+    # Create a temporary file and move
+    # the service @name to the systemd directory
+    def add
+      @systemctl = Helpers::Exec.new("systemctl")
+      super
+      @systemctl.run("daemon-reload")
+    end
+
+    private
+    # Method search_systemd_dir
+    # Search the current directory for systemd services
+    # + Gentoo can install at /lib/systemd/system or /usr/lib/systemd/system
+    def search_systemd_dir
+      if Dir.exist? "/lib/systemd/system"
+        "/lib/systemd/system"
+      elsif Dir.exist? "/usr/lib/systemd/system"
+        "/usr/lib/systemd/system"
+      else
+        raise "No directory systemd found"
+        exit
+      end
+    end
+  end
 end

data/lib/spior/persist.rb

@@ -8,14 +8,51 @@ module Spior
   module Persist
     extend self
 
-    def all(card_name)
-      @card_name = card_name
+    def all
       @services=[ "tor", "iptables" ]
+      services
+      save_rules
       search_for_systemd
     end
 
     private
 
+    # Install a systemd service where needed. TODO: test on more distrib
+    # no need on: archlinux
+    # need on: gentoo, debian, 
+    def services
+      return if !TTY::Which.exist?('systemctl') 
+      path_bin = "/sbin/iptables-restore"
+      path_rules = ""
+      case Nomansland::distro?
+      when :gentoo
+        path_rules = "/var/lib/iptables/rules-save"
+      when :debian
+        path_rules = "/etc/iptables/rules.v4"
+      end
+      string = <<EOF
+[Unit]
+Description=IPv4 Packet Filtering Framework for Spior
+Before=network-pre.target
+Wants=network-pre.target
+
+[Service]
+Type=oneshot
+ExecStart=#{path_bin} #{path_rules}
+ExecReload=#{path_bin} #{path_rules}
+RemainAfterExit=yes
+
+[Install]
+WantedBy=multi-user.target
+EOF
+      case Nomansland::distro?
+      when :gentoo
+        new_systemd = Helpers::NewSystemd.new(string, "iptables.services")
+        new_systemd.add
+        new_systemd.perm("root", "644")
+      end
+    end
+
     def search_for_systemd
       return if !TTY::Which.exist?('systemctl') 
       @systemctl = Helpers::Exec.new("systemctl")
@@ -28,14 +65,14 @@ module Spior
           @systemctl.run("enable #{service}")
         end
       end
-      iptables_systemd
     end
 
-    def iptables_systemd
+    def save_rules
       case Nomansland::installer?
       when :pacman
         @iptables_save.run("-f /etc/iptables/iptables.rules")
       when :emerge
+        @systemctl = Helpers::Exec.new("systemctl")
         @systemctl.run("start iptables-store")
       when :apt_get
         @iptables_save.run("> /etc/iptables/rules.v4")

data/lib/spior/runner.rb

@@ -16,7 +16,7 @@ module Spior
     def run
       if @options.install then
         Msg.head
-        Spior::Install::deps
+        Spior::Install::check_deps
         Spior::Copy::config_files
       end
       if @options.tor then
@@ -27,10 +27,7 @@ module Spior
         Spior::Iptables::tor(@network.card)
       end
       if @options.persist then
-        if not @network
-          @network = Spior::Network.new(@options.interface)
-        end
-        Spior::Persist::all(@network.card)
+        Spior::Persist::all
       end
     end
   end

data/lib/spior/tor.rb

@@ -24,9 +24,50 @@ module Spior
     def check_deps
       Spior::Install::check_deps
       Spior::Copy::config_files
+      add_resolv
+      add_torrc
       verify_service
     end
 
+    def add_resolv
+      string = "nameserver 127.0.0.1"
+      Spior::Copy::backup("/etc/resolv.conf", /nameserver 127.0.0.1$/)
+      new_file = Helpers::NewFile.new(string, "resolv.conf", "/etc")
+      new_file.add
+      new_file.perm("root", "644")
+    end
+
+    def add_torrc
+      user = ""
+      pid = ""
+      dir = "DataDirectory /var/lib/tor/data"
+      case Nomansland::distro?
+      when :gentoo
+        user = "User tor"
+        pid = "PIDFile /run/tor/tor.pid"
+      end
+      string = <<EOF
+# Generated by Spior
+#{user}
+#{pid}
+#{dir}
+GeoIPExcludeUnknown 1
+DNSPort 127.0.0.1:9061
+AutomapHostsOnResolve 1
+AutomapHostsSuffixes .exit,.onion
+SocksPort 9050
+VirtualAddrNetworkIPv4 10.192.0.0/10
+TransPort 9040 IsolateClientAddr IsolateClientProtocol IsolateDestAddr IsolateDestPort
+TestSocks 1
+MaxCircuitDirtiness 600
+EOF
+      re = /# Generated by Spior/
+      Spior::Copy::backup("/etc/tor/torrc", re)
+      new_file = Helpers::NewFile.new(string, "torrc", "/etc/tor")
+      new_file.add
+      new_file.perm("root", "644")
+    end
+
     def search_dns
       9061
     end
@@ -54,10 +95,8 @@ module Spior
       if TTY::Which.exist?('systemctl')
         state = `systemctl is-active tor`.chomp
         if state == 'active'
-          #puts "Restart tor"
           @systemctl.run('restart tor')
         else
-          #puts "Start tor"
           @systemctl.run('start tor')
         end
       else

data/spior.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name = "spior"
-  s.version = "0.1.3"
-  s.summary = "A tool to make TOR your default gateway and randomize your hardware"
+  s.version = "0.1.4"
+  s.summary = "A tool to make TOR your default gateway"
   s.description = <<-EOF 
-    A tool to make TOR your default gateway and randomize your hardware.
+    A tool to make TOR your default gateway
   EOF
   s.metadata = {
     "changelog_uri" => "https://github.com/szorfein/spior/blob/master/CHANGELOG.md",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spior
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - szorfein
@@ -35,7 +35,7 @@ cert_chain:
   J/zT/q2Ac7BWpSLbv6p9lChBiEnD9j24x463LR5QQjDNS5SsjzRQfFuprsa9Nqf2
   Tw==
   -----END CERTIFICATE-----
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -93,7 +93,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.4.2
-description: "    A tool to make TOR your default gateway and randomize your hardware.\n"
+description: "    A tool to make TOR your default gateway\n"
 email: szorfein@protonmail.com
 executables:
 - spior
@@ -106,15 +106,13 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- Rakefile
 - bin/spior
 - ext/ipt_mod.conf
 - ext/iptables.service
-- ext/resolv.conf
 - ext/ssh.conf
 - ext/sshd.conf
 - ext/sshuttle.service
-- ext/torrc/torrc_archlinux
-- ext/torrc/torrc_default
 - lib/spior/clear.rb
 - lib/spior/copy.rb
 - lib/spior/helpers.rb
@@ -159,7 +157,7 @@ requirements:
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A tool to make TOR your default gateway and randomize your hardware
+summary: A tool to make TOR your default gateway
 test_files:
 - test/test_options.rb
 - test/test_install.rb

data/ext/resolv.conf

@@ -1 +0,0 @@
-nameserver 127.0.0.1

data/ext/torrc/torrc_archlinux

@@ -1,18 +0,0 @@
-DataDirectory /var/lib/tor/data
-
-Log notice stdout
-
-GeoIPExcludeUnknown 1
-
-## Torified DNS
-DNSPort 127.0.0.1:9061
-AutomapHostsOnResolve 1
-AutomapHostsSuffixes .exit,.onion
-
-SocksPort 9050
-
-VirtualAddrNetworkIPv4 10.192.0.0/10
-TransPort 9040 IsolateClientAddr IsolateClientProtocol IsolateDestAddr IsolateDestPort
-
-TestSocks 1
-MaxCircuitDirtiness 600

data/ext/torrc/torrc_default

@@ -1,20 +0,0 @@
-User tor
-PIDFile /run/tor/tor.pid
-DataDirectory /var/lib/tor/data
-
-Log notice stdout
-
-GeoIPExcludeUnknown 1
-
-## Torified DNS
-DNSPort 127.0.0.1:9061
-AutomapHostsOnResolve 1
-AutomapHostsSuffixes .exit,.onion
-
-SocksPort 9050
-
-VirtualAddrNetworkIPv4 10.192.0.0/10
-TransPort 9040 IsolateClientAddr IsolateClientProtocol IsolateDestAddr IsolateDestPort
-
-TestSocks 1
-MaxCircuitDirtiness 600