itrg-invoker 1.6.0

data/lib/invoker/power/port_finder.rb

@@ -0,0 +1,49 @@
+module Invoker
+  module Power
+    class PortFinder
+      STARTING_PORT = 23400
+      attr_accessor :dns_port, :http_port, :starting_port, :https_port
+      def initialize
+        @starting_port = STARTING_PORT
+        @ports = []
+        @dns_port = nil
+        @http_port = nil
+      end
+
+      def find_ports
+        STARTING_PORT.upto(STARTING_PORT + 100) do |port|
+          break if @ports.size > 3
+          if check_if_port_is_open(port)
+            @ports << port
+          else
+            next
+          end
+        end
+        @dns_port = @ports[0]
+        @http_port = @ports[1]
+        @https_port = @ports[2]
+      end
+
+      private
+
+      def check_if_port_is_open(port)
+        socket_flag = true
+        sockets = nil
+        begin
+          sockets = Socket.tcp_server_sockets(port)
+          socket_flag = false if sockets.size <= 1
+        rescue Errno::EADDRINUSE
+          socket_flag = false
+        end
+        sockets && close_socket_pairs(sockets)
+        socket_flag
+      end
+
+      def close_socket_pairs(sockets)
+        sockets.each { |s| s.close }
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/invoker/power/power.rb

@@ -0,0 +1,3 @@
+require "invoker/power/http_response"
+require "invoker/power/dns"
+require "invoker/power/balancer"

data/lib/invoker/power/powerup.rb

@@ -0,0 +1,29 @@
+module Invoker
+  # power is really a stupid pun on pow.
+  module Power
+    class Powerup
+      def self.fork_and_start
+        powerup = new()
+        fork { powerup.run }
+      end
+
+      def run
+        require "invoker/power/power"
+        EM.epoll
+        EM.run {
+          trap("TERM") { stop }
+          trap("INT") { stop }
+          if Invoker.darwin?
+            DNS.new.run(listen: DNS.server_ports)
+          end
+          Balancer.run
+        }
+      end
+
+      def stop
+        Invoker::Logger.puts "Terminating Proxy/Server"
+        EventMachine.stop
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/distro/arch.rb

@@ -0,0 +1,15 @@
+module Invoker
+  module Power
+    module Distro
+      class Arch < Base
+        def install_required_software
+          system("pacman -S --needed --noconfirm dnsmasq socat")
+          system("mkdir -p /etc/dnsmasq.d")
+          unless File.open("/etc/dnsmasq.conf").each_line.any? { |line| line.chomp == "conf-dir=/etc/dnsmasq.d" }
+            File.open("/etc/dnsmasq.conf", "a") {|f| f.write("conf-dir=/etc/dnsmasq.d") }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/distro/base.rb

@@ -0,0 +1,80 @@
+module Invoker
+  module Power
+    module Distro
+      class Base
+        SOCAT_SHELLSCRIPT = "/usr/bin/invoker_forwarder.sh"
+        SOCAT_SYSTEMD = "/etc/systemd/system/socat_invoker.service"
+        RESOLVER_DIR = "/etc/dnsmasq.d"
+        attr_accessor :tld
+
+        def resolver_file
+          File.join(RESOLVER_DIR, "#{tld}-tld")
+        end
+
+        def self.distro_installer(tld)
+          if distro.start_with? "Arch Linux", "Manjaro Linux"
+            require "invoker/power/setup/distro/arch"
+            Arch.new(tld)
+          elsif distro.start_with? "Debian"
+            require "invoker/power/setup/distro/debian"
+            Debian.new(tld)
+          elsif distro.start_with? "Fedora"
+            require "invoker/power/setup/distro/redhat"
+            Redhat.new(tld)
+          elsif distro.start_with? "Linux Mint", "Ubuntu"
+            require "invoker/power/setup/distro/ubuntu"
+            Ubuntu.new(tld)
+          elsif distro.start_with? "openSUSE"
+            require "invoker/power/setup/distro/opensuse"
+            Opensuse.new(tld)
+          else
+            raise "Your selected distro is not supported by Invoker"
+          end
+        end
+
+        def self.distro
+          @distro ||= if File.exist?('/etc/os-release')
+            File.read('/etc/os-release').each_line do |line|
+              parsed_line = line.chomp.tr('"', '').split('=')
+              break parsed_line[1] if parsed_line[0] == 'NAME'
+            end
+          else
+            raise "File /etc/os-release doesn't exist or not Linux"
+          end
+        end
+
+        def initialize(tld)
+          self.tld = tld
+        end
+
+        # Install required software
+        def install_required_software
+          raise "Unimplemented"
+        end
+
+        def restart_services
+          system("systemctl enable socat_invoker.service")
+          system("systemctl enable dnsmasq")
+          system("systemctl start socat_invoker.service")
+          system("systemctl restart dnsmasq")
+        end
+
+        def install_packages
+          "dnsmasq and socat"
+        end
+
+        def install_other
+          " a local resolver for .#{tld} domain and"
+        end
+
+        def get_user_confirmation?
+          Invoker::Logger.puts("Invoker is going to install #{install_packages} on this machine."\
+            " It is also going to install#{install_other} a socat service"\
+            " which will forward all local requests on port 80 and 443 to another port")
+          Invoker::Logger.puts("If you still want to proceed with installation, press y.")
+          Invoker::CLI::Question.agree("Proceed with installation (y/n) : ")
+        end
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/distro/debian.rb

@@ -0,0 +1,11 @@
+module Invoker
+  module Power
+    module Distro
+      class Debian < Base
+        def install_required_software
+          system("apt-get --assume-yes install dnsmasq socat")
+        end
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/distro/opensuse.rb

@@ -0,0 +1,11 @@
+module Invoker
+  module Power
+    module Distro
+      class Opensuse < Base
+        def install_required_software
+          system("zypper install -l dnsmasq socat")
+        end
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/distro/redhat.rb

@@ -0,0 +1,11 @@
+module Invoker
+  module Power
+    module Distro
+      class Redhat < Base
+        def install_required_software
+          system("yum --assumeyes install dnsmasq socat")
+        end
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/distro/ubuntu.rb

@@ -0,0 +1,46 @@
+require "invoker/power/setup/distro/debian"
+
+module Invoker
+  module Power
+    module Distro
+      class Ubuntu < Debian
+        def using_systemd_resolved?
+          return @_using_systemd_resolved if defined?(@_using_systemd_resolved)
+          @_using_systemd_resolved = system("systemctl is-active --quiet systemd-resolved")
+        end
+
+        def install_required_software
+          if using_systemd_resolved?
+            # Don't install dnsmasq if Ubuntu version uses systemd-resolved for DNS because they conflict
+            system("apt-get --assume-yes install socat")
+          else
+            super
+          end
+        end
+
+        def install_packages
+          using_systemd_resolved? ? "socat" : super
+        end
+
+        def install_other
+          using_systemd_resolved? ? nil : super
+        end
+
+        def resolver_file
+          using_systemd_resolved? ? nil : super
+        end
+
+        def tld
+          using_systemd_resolved? ? 'localhost' : @tld
+        end
+
+        def get_user_confirmation?
+          if using_systemd_resolved? && tld != 'localhost'
+            Invoker::Logger.puts("Ubuntu installations using systemd-resolved (typically Ubuntu 17+) only support the .localhost domain, so your tld setting (or the default) will be ignored.".colorize(:yellow))
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/files/invoker_forwarder.sh.erb

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -e
+KillJobs() {
+    for job in $(jobs -p); do
+        kill -s SIGTERM $job > /dev/null 2>&1 || (sleep 10 && kill -9 $job > /dev/null 2>&1 &)
+    done
+}
+
+# Whatever you need to clean here
+trap KillJobs SIGINT SIGTERM EXIT
+
+/usr/bin/socat TCP-LISTEN:80,reuseaddr,fork TCP:0.0.0.0:<%= http_port %>&
+pid1=$!
+/usr/bin/socat TCP-LISTEN:443,reuseaddr,fork TCP:0.0.0.0:<%= https_port %>&
+pid2=$!
+wait $pid1 $pid2
+wait $pid1 $pid2

data/lib/invoker/power/setup/files/socat_invoker.service

@@ -0,0 +1,12 @@
+[Unit]
+Description=Socat port forwarding service
+After=network.target
+Documentation=man:socat(1)
+
+[Service]
+ExecStart=/usr/bin/invoker_forwarder.sh
+Restart=on-success
+
+
+[Install]
+WantedBy=multi-user.target

data/lib/invoker/power/setup/linux_setup.rb

@@ -0,0 +1,97 @@
+require "invoker/power/setup/distro/base"
+require 'erb'
+require 'fileutils'
+
+module Invoker
+  module Power
+    class LinuxSetup < Setup
+      attr_accessor :distro_installer
+
+      def setup_invoker
+        initialize_distro_installer
+        if distro_installer.get_user_confirmation?
+          find_open_ports
+          distro_installer.install_required_software
+          install_resolver
+          install_port_forwarder
+          distro_installer.restart_services
+          drop_to_normal_user
+          create_config_file
+        else
+          Invoker::Logger.puts("Invoker is not configured to serve from subdomains".colorize(:red))
+        end
+        self
+      end
+
+      def uninstall_invoker
+        system("systemctl disable socat_invoker.service")
+        system("systemctl stop socat_invoker.service")
+        system("rm #{Invoker::Power::Distro::Base::SOCAT_SYSTEMD}")
+        system("rm #{Invoker::Power::Distro::Base::SOCAT_SHELLSCRIPT}")
+        initialize_distro_installer
+        remove_resolver_file
+        drop_to_normal_user
+        Invoker::Power::Config.delete
+      end
+
+      def build_power_config
+        config = super
+        config[:tld] = distro_installer.tld
+        config
+      end
+
+      def resolver_file
+        distro_installer.resolver_file
+      end
+
+      def forwarder_script
+        File.join(File.dirname(__FILE__), "files/invoker_forwarder.sh.erb")
+      end
+
+      def socat_unit
+        File.join(File.dirname(__FILE__), "files/socat_invoker.service")
+      end
+
+      private
+
+      def initialize_distro_installer
+        @distro_installer ||= Invoker::Power::Distro::Base.distro_installer(tld)
+      end
+
+      def install_resolver
+        return if resolver_file.nil?
+        File.open(resolver_file, "w") do |fl|
+          fl.write(resolver_file_content)
+        end
+      end
+
+      def install_port_forwarder
+        install_forwarder_script(port_finder.http_port, port_finder.https_port)
+        install_systemd_unit
+      end
+
+      def resolver_file_content
+        content =<<-EOD
+local=/#{tld}/
+address=/#{tld}/127.0.0.1
+        EOD
+        content
+      end
+
+      def install_forwarder_script(http_port, https_port)
+        script_template = File.read(forwarder_script)
+        renderer = ERB.new(script_template)
+        script_output = renderer.result(binding)
+        File.open(Invoker::Power::Distro::Base::SOCAT_SHELLSCRIPT, "w") do |fl|
+          fl.write(script_output)
+        end
+        system("chmod +x #{Invoker::Power::Distro::Base::SOCAT_SHELLSCRIPT}")
+      end
+
+      def install_systemd_unit
+        FileUtils.cp(socat_unit, Invoker::Power::Distro::Base::SOCAT_SYSTEMD)
+        system("chmod 644 #{Invoker::Power::Distro::Base::SOCAT_SYSTEMD}")
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/osx_setup.rb

@@ -0,0 +1,137 @@
+module Invoker
+  module Power
+    class OsxSetup < Setup
+      FIREWALL_PLIST_FILE = "/Library/LaunchDaemons/com.codemancers.invoker.firewall.plist"
+      RESOLVER_DIR = "/etc/resolver"
+
+      def resolver_file
+        File.join(RESOLVER_DIR, tld)
+      end
+
+      def setup_invoker
+        if setup_resolver_file
+          find_open_ports
+          install_resolver(port_finder.dns_port)
+          install_firewall(port_finder.http_port, port_finder.https_port)
+          # Before writing the config file, drop down to a normal user
+          drop_to_normal_user
+          create_config_file
+        else
+          Invoker::Logger.puts("Invoker is not configured to serve from subdomains".colorize(:red))
+        end
+        self
+      end
+
+      def uninstall_invoker
+        uninstall_invoker_flag = Invoker::CLI::Question.agree("Are you sure you want to uninstall firewall rules created by setup (y/n) : ")
+
+        if uninstall_invoker_flag
+          remove_resolver_file
+          unload_firewall_rule(true)
+          Invoker::Power::Config.delete
+          Invoker::Logger.puts("Firewall rules were removed")
+        end
+      end
+
+      def build_power_config
+        config = super
+        config[:dns_port] = port_finder.dns_port
+        config
+      end
+
+      def install_resolver(dns_port)
+        open_resolver_for_write { |fl| fl.write(resolve_string(dns_port)) }
+      rescue Errno::EACCES
+        Invoker::Logger.puts("Running setup requires root access, please rerun it with sudo".colorize(:red))
+        raise
+      end
+
+      def install_firewall(http_port, https_port)
+        File.open(FIREWALL_PLIST_FILE, "w") { |fl|
+          fl.write(plist_string(http_port, https_port))
+        }
+        unload_firewall_rule
+        load_firewall_rule
+      end
+
+      def load_firewall_rule
+        system("launchctl load -Fw #{FIREWALL_PLIST_FILE} 2>/dev/null")
+      end
+
+      def unload_firewall_rule(remove = false)
+        system("pfctl -a com.apple/250.InvokerFirewall -F nat 2>/dev/null")
+        system("launchctl unload -w #{FIREWALL_PLIST_FILE} 2>/dev/null")
+        system("rm -rf #{FIREWALL_PLIST_FILE}") if remove
+      end
+
+      # Ripped from POW code
+      def plist_string(http_port, https_port)
+        plist =<<-EOD
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+<key>Label</key>
+<string>com.codemancers.invoker</string>
+<key>ProgramArguments</key>
+<array>
+<string>sh</string>
+<string>-c</string>
+<string>#{firewall_command(http_port, https_port)}</string>
+</array>
+<key>RunAtLoad</key>
+<true/>
+<key>UserName</key>
+<string>root</string>
+</dict>
+</plist>
+        EOD
+        plist
+      end
+
+      def resolve_string(dns_port)
+        string =<<-EOD
+nameserver 127.0.0.1
+port #{dns_port}
+        EOD
+        string
+      end
+
+      # Ripped from Pow code
+      def firewall_command(http_port, https_port)
+        rules = [
+          "rdr pass on lo0 inet proto tcp from any to any port 80 -> 127.0.0.1 port #{http_port}",
+          "rdr pass on lo0 inet proto tcp from any to any port 443 -> 127.0.0.1 port #{https_port}"
+        ].join("\n")
+        "echo \"#{rules}\" | pfctl -a 'com.apple/250.InvokerFirewall' -f - -E"
+      end
+
+      def setup_resolver_file
+        return true unless File.exist?(resolver_file)
+
+        Invoker::Logger.puts "Invoker has detected an existing Pow installation. We recommend "\
+          "that you uninstall pow and rerun this setup.".colorize(:red)
+        Invoker::Logger.puts "If you have already uninstalled Pow, proceed with installation"\
+          " by pressing y/n."
+        replace_resolver_flag = Invoker::CLI::Question.agree("Replace Pow configuration (y/n) : ")
+
+        if replace_resolver_flag
+          Invoker::Logger.puts "Invoker has overwritten one or more files created by Pow. "\
+          "If .#{tld} domains still don't resolve locally, try turning off the wi-fi"\
+          " and turning it on. It'll force OS X to reload network configuration".colorize(:green)
+        end
+        replace_resolver_flag
+      end
+
+      private
+
+      def open_resolver_for_write
+        FileUtils.mkdir(RESOLVER_DIR) unless Dir.exist?(RESOLVER_DIR)
+        fl = File.open(resolver_file, "w")
+        yield fl
+      ensure
+        fl && fl.close
+      end
+    end
+  end
+end

data/lib/invoker/power/setup.rb

@@ -0,0 +1,93 @@
+require "eventmachine"
+
+module Invoker
+  module Power
+    class Setup
+      attr_accessor :port_finder, :tld
+
+      def self.install(tld)
+        selected_installer_klass = installer_klass
+        selected_installer_klass.new(tld).install
+      end
+
+      def self.uninstall
+        if Invoker::Power::Config.has_config?
+          power_config = Invoker::Power::Config.load_config
+          selected_installer_klass = installer_klass
+          selected_installer_klass.new(power_config.tld).uninstall_invoker
+        end
+      end
+
+      def self.installer_klass
+        if Invoker.darwin?
+          Invoker::Power::OsxSetup
+        else
+          Invoker::Power::LinuxSetup
+        end
+      end
+
+      def initialize(tld)
+        if tld !~ /^[a-z]+$/
+          Invoker::Logger.puts("Please specify valid tld".colorize(:red))
+          exit(1)
+        end
+        self.tld = tld
+      end
+
+      def install
+        if check_if_setup_can_run?
+          setup_invoker
+        else
+          Invoker::Logger.puts("The setup has been already run.".colorize(:red))
+        end
+        self
+      end
+
+      def drop_to_normal_user
+        EventMachine.set_effective_user(ENV["SUDO_USER"])
+      end
+
+      def find_open_ports
+        port_finder.find_ports()
+      end
+
+      def port_finder
+        @port_finder ||= Invoker::Power::PortFinder.new()
+      end
+
+      def check_if_setup_can_run?
+        !File.exist?(Invoker::Power::Config.config_file)
+      end
+
+      def create_config_file
+        Invoker.setup_config_location
+        config = build_power_config
+        Invoker::Power::Config.create(config)
+      end
+
+      # Builds and returns power config hash. Override this method in subclasses if necessary.
+      def build_power_config
+        config = {
+          http_port: port_finder.http_port,
+          https_port: port_finder.https_port,
+          tld: tld
+        }
+        config
+      end
+
+      def remove_resolver_file
+        return if resolver_file.nil?
+        begin
+          safe_remove_file(resolver_file)
+        rescue Errno::EACCES
+          Invoker::Logger.puts("Running uninstall requires root access, please rerun it with sudo".colorize(:red))
+          raise
+        end
+      end
+
+      def safe_remove_file(file)
+        File.delete(file) if File.exist?(file)
+      end
+    end
+  end
+end

data/lib/invoker/power/templates/400.html

@@ -0,0 +1,40 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Invoker</title>
+    <style>
+    body {
+      margin: 0;
+      padding: 0;
+      background: #fff;
+      line-height: 18px;
+    }
+    div.page {
+      padding: 36px 90px;
+    }
+    h1, h2, p, li {
+      font-family: Helvetica, sans-serif;
+      font-size: 13px;
+    }
+    h1 {
+      line-height: 45px;
+      font-size: 36px;
+      margin: 0;
+    }
+    h2 {
+      line-height: 27px;
+      font-size: 18px;
+      font-weight: normal;
+      margin: 0;
+    }
+    </style>
+  </head>
+  <body class="">
+    <div class="page">
+      <h1>Bad request</h1>
+      <hr>
+      <h2>Invoker couldn't understand the request</h2>
+    </div>
+  </body>
+</html>