spior 0.1.5 → 0.2.8

data/lib/spior/tor/start.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'nomansland'
+require 'tempfile'
+
+module Spior
+  module Tor
+    extend self
+
+    # start should start the Tor service on your distribution
+    def start
+      tmp_file = Tempfile.new('torrc')
+
+      Tor::Config.new(tmp_file).generate
+
+      # Use Kernel.spawn here
+      x("tor -f #{tmp_file.path}") unless File.zero? tmp_file.path
+
+      case Nomansland.init?
+      when :systemd
+        start_systemd
+      when :openrc
+        Msg.p 'Starting Tor with Openrc...'
+        Helpers::Exec.new('/etc/init.d/tor').run('start')
+      when :runit
+        start_runit
+      else
+        Msg.report "Don't known yet how to start Tor for your system."
+      end
+    end
+
+    protected
+
+    def start_systemd
+      state = `systemctl is-active tor`.chomp
+      unless state == 'active'
+        Msg.p 'Starting Tor with Systemd...'
+        Helpers::Exec.new('systemctl').run('start tor')
+      end
+    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
+
+    private
+
+    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

data/lib/spior/tor/stop.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spior
+  module Tor
+    module_function
+
+    # Stop Tor service on your distribution (linux)
+    # It also kill previous instance run by Spior
+    def stop
+      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
+
+      case Nomansland.init?
+      when :systemd
+        Msg.p 'Stopping Tor with Systemd...'
+        Helpers::Exec.new('systemctl').run('stop tor')
+      when :runit
+        Msg.p 'Stopping Tor with Runit...'
+        Helpers::Exec.new('sv').run('stop tor')
+      when :openrc
+        Msg.p 'Stopping Tor with Openrc...'
+        Helpers::Exec.new('/etc/init.d/tor').run('stop')
+      else
+        Msg.report 'Don\'t known how to stop Tor on your system.'
+      end
+    end
+  end
+end

data/lib/spior/tor.rb

@@ -1,7 +1,13 @@
+# 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/restart'
+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.5'.freeze
+  VERSION = '0.2.8'
 end

data/lib/spior.rb

@@ -1,42 +1,37 @@
-require_relative 'spior/clear'
-require_relative 'spior/copy'
-require_relative 'spior/install'
+# 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/network'
 require_relative 'spior/menu'
+require_relative 'spior/service'
 require_relative 'spior/helpers'
 
 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
+
   class Main
     def initialize(argv)
       @argv = argv
-      run
+      x
     end
 
     private
 
-    def run
-      options = Options.new(@argv)
-
-      if options.install
-        Msg.head
-        Install::check_deps
-        Copy.new.save
-      end
-
-      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/man/spior.1

@@ -0,0 +1,53 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "SPIOR" "1" "December 2021" "" ""
+.
+.SH "NAME"
+\fBspior\fR \- Redirect all traffic to the Tor network
+.
+.SH "SYNOPSIS"
+\fBspior\fR [\fIOPTIONS\fR\.\.\.]
+.
+.SH "DESCRIPTION"
+\fBSpior\fR can redirect all the local traffic to the Tor network\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display the help and exit\.
+.
+.TP
+\fB\-t\fR, \fB\-\-tor\fR
+Spior will backup and create a new \fB/etc/tor/torrc\fR to add the required \fBtor\fR options and finally use \fBiptables\fR to create a transparent proxy throught Tor\.
+.
+.TP
+\fB\-p\fR, \fB\-\-persist\fR
+This option use \fBiptable\-save\fR to save actual rules and try to enable the service \fBiptables\fR for boot\.
+.
+.TP
+\fB\-r\fR, \fB\-\-reload\fR
+This option reload the Tor circuit which change your current ip address\. Use this option if your actual ip is blacklisted\.
+.
+.TP
+\fB\-c\fR, \fB\-\-clearnet\fR
+This option stop to redirect to Tor (by cleaning \fBiptables\fR rules) and use the normal connection\.
+.
+.SH "EXAMPLES"
+Display the help:
+.
+.br
+$ spior \-h
+.
+.P
+Redirect all the traffic throught Tor:
+.
+.br
+$ spior \-\-tor
+.
+.SH "SEE ALSO"
+iptables(8), tor(1)
+.
+.SH "ISSUES"
+You are free to report any new bugs|features|issues at https://github\.com/szorfein/spior/issues\.

data/man/spior.1.html

@@ -0,0 +1,122 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>spior(1) - Redirect all traffic to the Tor network</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+    <a href="#ISSUES">ISSUES</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>spior(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>spior(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>spior</code> - <span class="man-whatis">Redirect all traffic to the Tor network</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>spior</code> [<var>OPTIONS</var>...]</p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><strong>Spior</strong> can redirect all the local traffic to the Tor network.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<dl>
+<dt><code>-h</code>, <code>--help</code></dt><dd><p>Display the help and exit.</p></dd>
+<dt><code>-t</code>, <code>--tor</code></dt><dd><p>Spior will backup and create a new <code>/etc/tor/torrc</code> to add the required
+<code>tor</code> options and finally use <code>iptables</code> to create a transparent proxy
+throught Tor.</p></dd>
+<dt><code>-p</code>, <code>--persist</code></dt><dd><p>This option use <code>iptable-save</code> to save actual rules and try to enable the service <code>iptables</code> for boot.</p></dd>
+<dt><code>-r</code>, <code>--reload</code></dt><dd><p>This option reload the Tor circuit which change your current ip address. Use this option if your actual ip is blacklisted.</p></dd>
+<dt><code>-c</code>, <code>--clearnet</code></dt><dd><p>This option stop to redirect to Tor (by cleaning <code>iptables</code> rules) and use the normal connection.</p></dd>
+</dl>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>Display the help:<br />
+    $ spior -h</p>
+
+<p>Redirect all the traffic throught Tor:<br />
+    $ spior --tor</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p><span class="man-ref">iptables<span class="s">(8)</span></span>, <span class="man-ref">tor<span class="s">(1)</span></span></p>
+
+<h2 id="ISSUES">ISSUES</h2>
+
+<p>You are free to report any new bugs|features|issues at https://github.com/szorfein/spior/issues.</p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>December 2021</li>
+    <li class='tr'>spior(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/spior.1.ronn

@@ -0,0 +1,46 @@
+spior(1) -- Redirect all traffic to the Tor network
+====================================================
+
+## SYNOPSIS
+
+`spior` [<OPTIONS>...]
+
+## DESCRIPTION
+
+**Spior** can redirect all the local traffic to the Tor network.
+
+## OPTIONS
+
+  * `-h`, `--help`:
+    Display the help and exit.
+
+  * `-t`, `--tor`:
+    Spior will backup and create a new `/etc/tor/torrc` to add the required
+    `tor` options and finally use `iptables` to create a transparent proxy
+    throught Tor.
+
+  * `-p`, `--persist`:
+    This option use `iptable-save` to save actual rules and try to enable the service `iptables` for boot.
+
+  * `-r`, `--reload`:
+    This option reload the Tor circuit which change your current ip address. Use this option if your actual ip is blacklisted.
+
+  * `-c`, `--clearnet`:
+    This option stop to redirect to Tor (by cleaning `iptables` rules) and use the normal connection.
+
+## EXAMPLES
+
+Display the help:<br>
+    $ spior -h
+
+Redirect all the traffic throught Tor:<br>
+    $ spior --tor
+
+
+## SEE ALSO
+
+iptables(8), tor(1)
+
+## ISSUES
+
+You are free to report any new bugs|features|issues at https://github.com/szorfein/spior/issues.

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.4'
+  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.2')
-  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'