encinch 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edb2e2e7c096ffda8693dcd2c641689724862796
+  data.tar.gz: 2d8fcb47f7ee5ef3673503654d9cb6224f86d07f
+SHA512:
+  metadata.gz: 589cea1054cbf7f40b792fd6e52b9e51b4d69f81171f13819d204be8616c3576586f44a19a1590cc54a0e1efe80aaa393fe7a1dcf1717a4a8b190c18018ea36f
+  data.tar.gz: 5f640b06f13ca5e1c253ee0bae607762c22dec34e11b7201121a6f02e410cd7377c35825d49e41453448e035defc703bacbfc296377f886aa56ffa6badc97580

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jason Franz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+
+# Encinch
+
+Transparent blowfish encryption plugin for Cinch: An IRC Bot Building Framework
+
+https://github.com/cinchrb/cinch
+
+
+## Installation
+
+  $[sudo] gem install encinch
+
+## Example
+  ```
+  require 'cinch'
+  require 'cinch/plugins/encinch'
+
+
+  bot = Cinch::Bot.new do
+    configure do |c|
+      c.nick            = "EnCinch"
+      c.server          = "irc.freenode.org"
+      c.port            = 7000
+      c.ssl.use         = true
+      c.channels        = ["#cryptedchan", "#plaintext"]
+
+      c.plugins.plugins = [Cinch::Plugins::EnCinch] # optionally add more plugins
+
+      c.plugins.options[Cinch::Plugins::EnCinch] = {
+        :ignore     => ["#ignorechannel", "ignoreperson"],
+        :encrypt    => {
+          '#cryptedchan'  => "myfishkey",
+          'cryptednick'   => "notmyfishkey",
+          :default        => "adefaultfishkey"
+        },
+        :uncrypted  => ["#plaintext"]
+      }
+    end
+  end
+
+  bot.start
+  ```
+
+## Commands
+  None, yet. 
+
+
+## Options
+### :encrypt
+A hash of encryption targets and their corresponding encryption keys. Targets should all be lowercase.
+:default can provide a general purpose key, generally good for private communications with the bot.
+The :encrypt option must be set, :default is optional.
+
+### :uncrypted
+An array of channels and individuals from which the bot will not encrypt messages. All entries must be lowercase. This option must be set. If there are no desired unencrypted targets set an empty array.
+
+### :ignore
+An array of channels and individuals (other bots?) to ignore encrypted messages. All entries must be lower case.
+:ignore is optional.
+
+## TODO
+  1) keyexchange
+  2) maybe store keys to a file?
+  3) add commands for updating, removing and adding keys and other settings?
+  4) user feedback... :-)

data/encinch.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cinch/plugins/encinch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "encinch"
+  spec.version       = EnCinch::Version::VERSION
+  spec.authors       = ["jfrazx"]
+  spec.email         = ["staringblind@gmail.com"]
+  spec.summary       = %q{Transparent blowfish encryption plugin for Cinch: An IRC Bot Building Framework}
+  spec.description   = %q{}
+  spec.platform      = Gem::Platform::RUBY
+  spec.homepage      = "https://github.com/jfrazx/EnCinch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "cinch", "~> 2.0"
+  spec.add_runtime_dependency "crypt", "~> 2.0"
+end

data/lib/cinch/plugins/encinch.rb

@@ -0,0 +1,5 @@
+require 'cinch'
+require 'crypt/blowfish'
+require "cinch/plugins/encinch/encryption"
+require "cinch/plugins/encinch/encinch"
+require "cinch/plugins/encinch/extend"

data/lib/cinch/plugins/encinch/encinch.rb

@@ -0,0 +1,137 @@
+
+module Cinch
+  module Plugins
+      class EnCinch
+        include Cinch::Plugin
+
+        def initialize(*)
+          super
+
+          # does Cinch have something to checked required options already???
+          raise MissingRequiredPluginOptions unless config[:encrypt]
+          raise MissingRequiredPluginOptions unless config[:uncrypted]
+
+        end
+
+        #
+        # All blowfish communication should be prefixed with +OK
+        # capture this to start the process
+        #
+
+        match(/\+OK (\S+)/, use_prefix: false, strip_colors: true, method: :capture)
+
+        def capture(m, message)
+          target = (m.channel ? m.channel.name : m.user.nick).downcase
+          message = strip(m, message)
+
+          return if config[:ignore].include?(target) rescue nil
+          @key = config[:encrypt][target] || config[:encrypt][:default] rescue nil
+
+          return unless @key
+
+          blowfish(@key)
+
+          decrypted = decrypt(message)
+          decrypted << '\u0001' if m.action?
+
+          raw = modify_raw(m.raw, decrypted)
+
+          dispatch(Message.new(raw, m.bot))
+        end
+
+        #
+        # matching for key exchange
+        # NOT WORKING YET
+        # It appears Cinch does not emit a :notice event, unfortunate
+        #
+
+        match(/DH1080_INIT/, use_prefix: false, react_on: [:private, :notice], method: :key_exchange)
+
+        def key_exchange(m)
+          return if m.channel?
+
+          debug "captured key exchange event with key: #{m.message}"
+
+          #TODO -- everything
+        end
+
+        # not sure this is actually needed
+        def encrypt(message)
+          @fish.encrypt(message)
+        end
+
+        def decrypt(message)
+          @fish.decrypt(message)
+        end
+
+        def blowfish(key)
+          @fish = Cinch::Plugins::EnCinch::Encryption.new(key)
+        end
+
+        private
+
+        def dispatch(msg)
+          events = [[:catchall]]
+
+          if ["PRIVMSG", "NOTICE"].include?(msg.command)
+            events << [:ctcp] if msg.ctcp?
+
+            if msg.channel?
+              events << [:channel]
+            else
+              events << [:private]
+            end
+
+            if msg.command == "PRIVMSG"
+              events << [:message]
+            else 
+              events << [:notice]
+            end
+
+            if msg.action?
+              events << [:action]
+            end
+          end
+
+          meth = "on_#{msg.command.downcase}"
+          __send__(meth, msg, events) if respond_to?(meth, true)
+
+          if msg.error?
+            events << [:error]
+          end
+
+          events << [msg.command.downcase.to_sym]
+
+          msg.events = events
+
+          #if its still encrypted for whatever reason we will not be processing it again
+          msg.events.each do |event, *args|
+            msg.bot.handlers.dispatch(event, msg, *args)
+          end unless encrypted?(msg.raw) 
+        end
+
+        # 
+        # TODO: strip ctcp? others?
+        #
+
+        def strip(m, data)
+          data.sub!(/\u0001$/, '') if m.action?
+
+          data
+        end
+
+        def encrypted?(data)
+          !!data.match(/\+OK \S+/)
+        end
+
+        #
+        # replace the encrypted message with the decrypted
+        #
+
+        def modify_raw(data, decrypted)
+          data.sub!(/\+OK \S+(\s+)?(\S+)?/, decrypted)
+          data
+        end
+      end
+  end
+end

data/lib/cinch/plugins/encinch/encryption.rb

@@ -0,0 +1,109 @@
+#
+# much of this code was pilfered from Cinch's long dormant 'feature/fish' branch
+# https://github.com/cinchrb/cinch/tree/feature/fish
+# or from weechat's fish plugin
+# https://github.com/weechat/scripts/blob/master/ruby/weefish.rb
+# 
+
+module Cinch
+  module Plugins
+    class EnCinch
+      class Encryption
+        module Base64
+        
+          Alphabet = "./0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".freeze
+
+          def self.encode(data)
+            res = String.new
+            data = data.dup.force_encoding("BINARY")
+
+            data.chars.each_slice(8) do |slice|
+              slice = slice.join
+              left, right = slice.unpack('L>L>')
+              6.times do
+                res << Alphabet[right & 0x3f]
+                right >>= 6
+              end
+
+              6.times do
+                res << Alphabet[left & 0x3f]
+                left >>= 6
+              end
+            end
+
+            return res
+          end
+
+          def self.decode(data)
+            res = String.new
+            data = data.dup.force_encoding("BINARY")
+            data.chars.each_slice(12) do |slice|
+              slice = slice.join
+              left = right = 0
+
+              slice[0..5].each_char.with_index do |p, i|
+                right |= Alphabet.index(p) << (i * 6)
+              end
+
+              slice[6..11].each_char.with_index do |p, i|
+                left |= Alphabet.index(p) << (i * 6)
+              end
+
+              res << [left, right].pack('L>L>')
+            end
+
+            return res
+          end
+        end
+
+
+        def initialize(key)
+          @blowfish = Crypt::Blowfish.new(key)
+        end
+        
+        def encrypt(text)
+          text = pad(text, 8)
+          result = String.new
+          
+          num_block = text.length / 8
+          num_block.times do |n|
+            block = text[n*8..(n+1)*8-1]
+            enc = @blowfish.encrypt_block(block)
+            result += Base64.encode(enc)
+          end
+          
+          return "+OK " << result
+        end
+        
+        def decrypt(text)
+          return nil if not text.length % 12 == 0
+          
+          result = String.new
+          
+          num_block = (text.length / 12).to_i
+          num_block.times do |n|
+            block = Base64.decode( text[n*12..(n+1)*12-1] )
+            result += @blowfish.decrypt_block(block)
+          end
+          
+          return result.gsub(/\0*$/, "")
+        end
+
+        def self.generate
+          # generate a key for key exchange
+        end
+        
+        private
+        
+        def pad(text, n=8)
+          pad_num = n - (text.length % n)
+          if pad_num > 0 and pad_num != n
+            pad_num.times { text += 0.chr }
+          end
+
+          return text
+        end
+      end
+    end
+  end
+end

data/lib/cinch/plugins/encinch/extend.rb

@@ -0,0 +1,47 @@
+
+module Cinch
+  module Exceptions
+
+    # error to raise for missing required plugin options
+    class MissingRequiredPluginOptions < Generic
+    end
+  end
+
+
+  class IRC
+
+    # Send a message to the server.
+    # @param [String] msg
+    # @return [void]
+    def send(msg)
+
+      # TODO match and modify ACTION
+      if msg.match(/(PRIVMSG|NOTICE)/) && !msg.match(/\+OK (\S+)/)
+
+        verb, target, *message = msg.split
+        message = message.join(' ')[1..-1] rescue nil
+
+        # retrieve bot options
+        if (message && !message.empty?) && options = @bot.config.plugins.options[Cinch::Plugins::EnCinch]
+
+          # key exists
+          if key = (options[:encrypt][target.downcase] || options[:encrypt][:default])
+
+            # ignore if target is in the 'uncrypted' array
+            unless options[:uncrypted].include?(target.downcase)
+
+              fish = Cinch::Plugins::EnCinch::Encryption.new(key)
+              encrypted = fish.encrypt(message)
+              msg.sub!(message, encrypted)
+            end
+          end
+        end
+      end   
+
+      @queue.queue(msg)
+    end
+
+    private
+
+  end
+end

data/lib/cinch/plugins/encinch/version.rb

@@ -0,0 +1,6 @@
+
+class EnCinch
+  class Version
+    VERSION = "0.0.3"
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: encinch
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- jfrazx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: crypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: ''
+email:
+- staringblind@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- encinch.gemspec
+- lib/cinch/plugins/encinch.rb
+- lib/cinch/plugins/encinch/encinch.rb
+- lib/cinch/plugins/encinch/encryption.rb
+- lib/cinch/plugins/encinch/extend.rb
+- lib/cinch/plugins/encinch/version.rb
+homepage: https://github.com/jfrazx/EnCinch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: 'Transparent blowfish encryption plugin for Cinch: An IRC Bot Building Framework'
+test_files: []