unibanner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a987a90282931e2839767ae60f520bcca07c7635f3e66f2481c4e2ce8bae9f59
+  data.tar.gz: 7804309c159b11547855b6cbc3e1083b05c0e6ca1a2914344079c58c0d99f176
+SHA512:
+  metadata.gz: d6e62892ca52da8cca98641430088d06233fc6b9e4739f6dfbff3686a9c11ef9e4404dea3f759f72fefc7be01cfc6a34a1eddf09255086c6a04e60fb7cd467a2
+  data.tar.gz: 7d32bb8ce10aa2351bf336407030e2c9734624eba46aac6f2bca675b36cb7b6d0ef884cca002d2783ba96f3d6916abff4c3093745ba0aaaf7571de36060e1c57

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: "vendor/bundle"

data/.gitignore

@@ -0,0 +1,4 @@
+vendor/
+.project
+.vscode/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    unibanner (0.0.0)
+      irc_socket (~> 1.0, >= 1)
+      logging (~> 2.2.2)
+      paint (~> 2.0.1)
+      parseconfig (~> 1.0.8)
+      pry
+      unirest (~> 1.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    ansi (1.5.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    irc_socket (1.0.7)
+    json (1.8.6)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    method_source (0.9.1)
+    mime-types (1.25.1)
+    minitest (5.11.3)
+    minitest-reporters (1.3.5)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multi_json (1.13.1)
+    paint (2.0.1)
+    parseconfig (1.0.8)
+    pry (0.12.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rest-client (1.6.9)
+      mime-types (~> 1.16)
+    ruby-progressbar (1.10.0)
+    unirest (1.1.2)
+      addressable (~> 2.3.5)
+      json (~> 1.8.1)
+      rest-client (~> 1.6.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5)
+  minitest-reporters (~> 1.1)
+  unibanner!
+
+BUNDLED WITH
+   1.16.4

data/bin/unibanner

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require 'unibanner'
+Unibanner::Bots.find_bots
+Unibanner::Bots.start

data/lib/unibanner/bot_class.rb

@@ -0,0 +1,163 @@
+require "logging"
+require "irc_socket"
+require "yaml"
+require "unibanner/logger"
+
+module Unibanner
+  # class containing all the bot instances and methods to act on them.
+  class Bots
+    @@bots = {}
+    @@threads = []
+    Unibanner::Logger.new(self)
+    @@log = Unibanner::Logger[self]
+
+    def initialize
+      @log = @@log
+    end
+
+    # Find all bots existing in configuration
+    def self.find_bots
+      cfg = YAML::load_file(Pathname(Dir.home).join(".unibanner").join("config"))
+      cfg["networks"].each do |network, hsh|
+        @@log.debug "bot = Unibanner::Bot.new(#{network}, #{hsh})"
+        bot = Unibanner::Bot.new(network, hsh)
+        @@log.debug "Unibanner::Bots.add_bot(#{bot})"
+        Unibanner::Bots.add_bot(bot)
+        @@log.debug "Unibanner::Bot.find_bots ... done."
+      end
+    end
+
+    # Add a bot into the Bots list
+    # @param [Unibanner::Bot] bot Unibanner::Bot object
+    def self.add_bot(bot)
+      @@bots[bot.network] = bot
+    end
+
+    # return list of bots
+    # @return [Array] bots list
+    def self.bots
+      @@bots
+    end
+
+    # Start all bots found via Bots#find_bots
+    def self.start
+      @@bots.each do |network, bot|
+        thr = Thread.new do
+          Thread.current.name = "#{bot.nick}@#{network}[#{bot.server}:#{bot.ssl == true ? '+' : ''}#{bot.port}]"
+          bot.start
+        end
+        @@threads << thr
+        @@threads.each(&:join)
+      end
+    end
+
+    # Cause all bots to die/quit
+    # @overload self.die(msg)
+    #   Quits all bots with 'msg'
+    #    and all threads are exited.
+    #   @param [String] msg quit msg to use
+    # @overload self.die(msg, threads)
+    #   Quits all bots with 'msg'
+    #    and threads determines if threads are killed
+    #   @param [String] msg quit msg to use
+    #   @param [Boolean] threads whether to kill/exit threads
+    def self.die(msg, threads = true)
+      @@bots.each do |network, bot|
+        @@log.info "Quitting off #{network}."
+        bot.quit(msg)
+      end
+      if threads
+        @@threads.each do |thr|
+          @@log.info "Exiting from '#{thr.name}' thread."
+          thr.exit
+        end
+      end
+    end
+  end
+
+  class Bot
+    attr_accessor :irc, :sock
+    attr_reader :server, :port, :ssl, :network, :local_host, :nick, :geckos, :prefix, :oper_name
+    attr :log, :log_level
+
+    # Create a new bot
+    # @param [String] network The network name
+    # @param [Hash] hsh hash full of network options
+    def initialize(network, hsh)
+      @network = group
+      @server = hsh["server"]         # network::server: irc.server.tld
+      @ssl = hsh["ssl"]               # network::ssl: true/false
+      @port = hsh["port"]             # network::port: 0000
+      @local_host = hsh["local_host"] # network::local_host: 0.0.0.0
+      @nick = hsh["nick"]             # network::nick: nickname
+      @geckos = hsh["geckos"]         # network::geckos: Real Name
+      @prefix = hsh["prefix"]         # network::prefix: !
+      @oper_name = hsh["oper_name"]   # network::oper_name: opername
+      @oper_pass = hsh["oper_pass"]   # network::oper_pass: PASSWORD
+      @channels = hsh["channels"]     # network::channels: [channel1,channel2]
+
+      Unibanner::Logger.new(self)
+      @log = Unibanner::Logger[self]
+      @log_level = hsh["log_level"]
+      @log.level = @log_level
+      @irc = IRCSocket.new(@server, @port, @ssl)
+    end
+
+    # Allow Bot.quit(msg) to actually cause the irc connection to /quit
+    # @param [String] msg Quit msg to use
+    def quit(msg)
+      @irc.quit(msg)
+    end
+
+    # Start the IRC connection
+    # @return [nil]
+    def start
+      @irc.connect
+      if @irc.connected?
+        @irc.nick "#{@nick}"
+        @irc.user "#{@nick}", 0, "*", "#{@geckos}"
+        while line = irc.read
+          @log.incoming line
+          # Join Channels after MOTD
+          if line.split[1] == "376"
+            Thread.new {
+              @irc.oper @oper_name, @oper_pass
+              @channels.each do |channel|
+                @irc.join channel
+              end
+            }
+          end
+          #            0           1      2     ------------------3-------------------
+          # :kojo.electrocode.net 340 unibanner :ephemer0l_=+~ephemer0l_@196.27.72.156
+
+          if line.split[1] == "340"
+            user_ip = line.split[3].gsub(/:.*@(.*)/, '\1')
+            @log.info "Got #{user_ip} back from /USERIP. Submitting to blacklist."
+            #reply = SendToBlacklist(user_ip)
+            @log.debug "send2BL(#{user_ip}) returned '#{reply}'"
+            #ircZLine(user_ip)
+          end
+          if line.split[1] == '433'
+            @log.error "#{self.network}: 433, Nickname in use, can't connect"
+            ::Unibanner::Bots.die("Nickname in use, Can't connect")
+          end
+          # unicode characters used by the spammers
+          # spam_pattern = /(\uFE13|\u04BB|\u0501|\u0D20|\u222A|\u217E|\u1EFF){1,}/
+          spam_pattern = Regexp.new('(\ufe68|\u205f|\u0422|\u2009|\u04bb|\u1952|\u217c|\u2004|\u217f|\u1d20|\u03bf|\u0456|\u217d|\u2c9f|\u2024|\u0435|\uff03|\uff0f|\u03f3|\ufe57|\u2216|\u2170|\u1959|\u13df|\u0251|\u222a|\u0441|\u0430|\u2001|\u200a|\u217e|\u0443|\u2005|\u2002|\u0455|\u2000|\u2215|\u2044|\u03f2|\u043e|\u0d20|\u0261|\u1971|\u0501|\u2007|\u0392|\uff0e|\u13a1|\u0458|\u202f|\ufe55|\u15b4|\u1d21|\u2006|\u2cad|\u0440|\u2574|\u16ec|\u13da|\u13a2)')
+          # message pattern
+          nick_pattern = Regexp.new(':(?<nick>.*)!(?<user>.+)\@(?<host>\S+) PRIVMSG (?<channel>\#\S+) :(?<msg>.*)')
+          # Run a /USERIP on the nick that matched the spam text
+          if line =~ nick_pattern
+            @log.info "matched on nick pattern"
+            irc_msg = Regexp.last_match
+            if irc_msg["msg"] =~ spam_pattern
+              @log.info "matched on spam pattern"
+              @irc.userip(irc_msg["nick"])
+            end
+          end
+        end
+      end
+      return nil
+    end
+  end
+end

data/lib/unibanner/functions.rb

@@ -0,0 +1,22 @@
+module Unibanner
+  # A group of functions to help with unibanner
+  # @attr [String] key DNSBL.im key file contents
+  class Functions
+    # Send an IP to the blacklist
+    #   A bit longer description.
+    #
+    # @param [String] ip IP sending to blacklist
+    # @returns [True,False]
+    def send2BL(ip)
+      url = 'https://api.dnsbl.im/import'
+      payload = {
+        key: File.open('/home/ken/.dnsblim-key', 'r').read.chomp!,
+        addresses: [
+          {type: '5,6', ip: ip, reason: 'fngate and/or unicode spam'}
+	      ]
+      }
+      r = Unirest.post(url, parameters: payload.to_json)
+      r.body
+    end
+  end
+end

data/lib/unibanner/logger.rb

@@ -0,0 +1,63 @@
+require "logging"
+require 'paint'
+module Logging
+  class Logger
+
+    def incoming?( ); true; end
+    def incoming( data = nil )
+      data = yield if block_given?
+      log_event(::Logging::LogEvent.new(@name, 1, " #{Paint['->', 'green']} #{data}", @caller_tracing))
+      true
+    end
+    def outgoing?( ); true; end
+    def outgoing( data = nil )
+      data = yield if block_given?
+      log_event(::Logging::LogEvent.new(@name, 1, " #{Paint['<-', 'red']} #{data}", @caller_tracing))
+      true
+    end
+  end
+end
+Logging.color_scheme("bright",
+                     :levels => {
+                       :info => :green,
+                       :warn => :yellow,
+                       :error => :red,
+                       :fatal => [:white, :on_red],
+                     },
+                     :date => :blue,
+                     :logger => :cyan,
+                     :message => :white)
+
+Logging.appenders.stdout(
+  "stdout",
+  :layout => Logging.layouts.pattern(
+    :pattern => '[%d] %-5l %c: %m\n',
+    :color_scheme => "bright",
+  ),
+)
+Logging.logger.root.appenders = Logging.appenders.stdout
+Logging.logger.root.level = :info
+
+module Unibanner
+  LOGGER = Logging.logger[self]
+  class Logger
+    @@loggers = {}
+    @@loggers['Unibanner'] = Logging.logger['Unibanner']
+    @@loggers[self] = Logging.logger[self]
+    @@instance = Logging::Repository.instance
+
+    def initialize(name)
+      @@loggers[name] = Logging.logger[name]
+    end
+
+    def update
+      @@instance = Logging::Repository.instance
+    end
+    def loggers
+      @@loggers
+    end
+    def self.[](key)
+      @@loggers[key]
+    end
+  end
+end

data/lib/unibanner/version.rb

@@ -0,0 +1,3 @@
+module Unibanner
+  VERSION = '0.0.1'
+end

data/lib/unibanner.rb

@@ -0,0 +1,3 @@
+require 'unibanner/bot_class'
+
+# vim: ts=2 sw=2

data/unibanner.gemspec

@@ -0,0 +1,48 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unibanner/version'
+Gem::Specification.new do |s|
+  s.name = 'unibanner'
+  s.version = Unibanner::VERSION
+  s.authors = ['Ken Spencer']
+  s.email = 'me@iotaspencer.me'
+  s.summary = 'A simpleish bot made to ban and blacklist unicode spamming bots.'
+  s.description = 'A simple bot made to ban and blacklist unicode spamming bots on IRC. Use only in channels where such unicode is not commonplace.'
+  s.homepage = 'https://iotaspencer.me/projects/unibanner'
+  s.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if s.respond_to?(:metadata)
+    s.metadata = {
+        'github_repo'       => 'https://git.lasershark.army/IotaSpencer/unibanner',
+        'bug_tracker_uri'   => 'https://git.lasershark.army/IotaSpencer/unibanner/issues',
+#        'documentation_uri' => 'https://rubydoc.info/gems/unibanner',
+        'homepage_uri'      => 'https://iotaspencer.me/projects/unibanner',
+        'source_code_uri'   => 'https://git.lasershark.army/IotaSpencer/unibanner',
+        'wiki_uri'          => 'https://git.lasershark.army/IotaSpencer/unibanner/wiki'
+    }
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+          'public gem pushes.'
+  end
+
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test)/})
+  end
+  s.required_ruby_version = '~> 2'
+  s.bindir = 'bin'
+  s.executables << 'unibanner'
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'irc_socket', '~> 1.0', '>= 1'
+  s.add_runtime_dependency 'logging', '~> 2.2.2'
+  s.add_runtime_dependency 'paint', '~> 2.0.1'
+  s.add_runtime_dependency 'parseconfig', '~> 1.0.8'
+  s.add_runtime_dependency 'pry'
+  s.add_runtime_dependency 'unirest', '~> 1.1.2'
+  s.add_development_dependency 'bundler', '~> 1.16'
+  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'minitest-reporters', '~> 1.1'
+
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: unibanner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ken Spencer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: irc_socket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: parseconfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: A simple bot made to ban and blacklist unicode spamming bots on IRC.
+  Use only in channels where such unicode is not commonplace.
+email: me@iotaspencer.me
+executables:
+- unibanner
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- bin/unibanner
+- lib/unibanner.rb
+- lib/unibanner/bot_class.rb
+- lib/unibanner/functions.rb
+- lib/unibanner/logger.rb
+- lib/unibanner/version.rb
+- unibanner.gemspec
+homepage: https://iotaspencer.me/projects/unibanner
+licenses:
+- MIT
+metadata:
+  github_repo: https://git.lasershark.army/IotaSpencer/unibanner
+  bug_tracker_uri: https://git.lasershark.army/IotaSpencer/unibanner/issues
+  homepage_uri: https://iotaspencer.me/projects/unibanner
+  source_code_uri: https://git.lasershark.army/IotaSpencer/unibanner
+  wiki_uri: https://git.lasershark.army/IotaSpencer/unibanner/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A simpleish bot made to ban and blacklist unicode spamming bots.
+test_files: []