ircblowfish 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dea6b0abfbbd1e7c640e33889753fa44469b04ee
+  data.tar.gz: 180f2968dbbb59c2c70e03db62f4c729c7b45c5a
+SHA512:
+  metadata.gz: 4917e35b598efff54cb5e3b855165c4d87e4901b49a08449ef7a1a139c1864f90d18c16d87e432c54bf2f1beb6be46f4bcc7d39e378bab617f7d81a8981f8f45
+  data.tar.gz: fb23a33b987751d9c1516e2f0802254ab096e7fa0def0a859b5febca819239689ced1e504d68bcd45d5d5fa35ca09da76a4ba36c6870c02e3ae5ffe30a51d86e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--warnings

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2016-04-29)
+
+Initial Release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ircblowfish.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jason Iverson
+
+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,51 @@
+# IrcBlowfish
+
+A Ruby module for encrypting and decrypting IRC Blowfish ECB/CBC messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ircblowfish'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ircblowfish
+
+## Usage
+
+```ruby
+message = '+OK '
+key = 'ecb:AWeakKey'
+plaintext = IrcBlowfish.decrypt message, key
+
+text = 'This is a test string'
+key = 'cbc:ABetter?Key'
+message = IrcBlowfish.encrypt text, key
+```
+
+To define an ECB key, prefix it with either `ecb:` or `old:`. CBC keys can be prefixed with `cbc:` or are assumed to be CBC with no prefix.
+
+You can explicitly call `encrypt_ecb` or `encrypt_cbc`, but just calling `encrypt` will automatically figure out which to use based on the key passed.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/JasonIverson/ircblowfish.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ircblowfish"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ircblowfish.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ircblowfish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ircblowfish"
+  spec.version       = IrcBlowfish::VERSION
+  spec.authors       = ["Jason Iverson"]
+  spec.email         = ["iverson.jason.code@gmail.com"]
+
+  spec.summary       = %q{Ruby Encryption Module for IRC Blowfish Messages}
+  spec.description   = %q{A Ruby module for encrypting and decrypting IRC Blowfish ECB/CBC messages}
+  spec.homepage      = "https://github.com/JasonIverson/ircblowfish-ruby/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ircblowfish.rb

@@ -0,0 +1,139 @@
+require "ircblowfish/version"
+require "ircblowfish/base64"
+
+require "base64"
+require "openssl"
+require "securerandom"
+
+module IrcBlowfish
+  def self.encrypt(msg, key)
+    return encrypt_ecb(msg, key) if key =~ /^(?:old|ecb):/
+    return encrypt_cbc(msg, key)
+  end
+
+  def self.decrypt(msg, key)
+    return decrypt_ecb(msg, key) if key =~ /^(?:old|ecb):/
+    return decrypt_cbc(msg, key)
+  end
+
+  def self.encrypt_ecb(msg, key)
+    return msg if key.nil? or key == ''
+    return msg if msg.nil? or msg == ''
+
+    # Force encoding to binary in case of non-ascii messages
+    plaintext = msg.dup.force_encoding 'BINARY'
+
+    # Remove the ecb:/old: prefix if it's used
+    key = key.sub %r{^(?:old|ecb):}, ''
+    return msg if key == ''
+
+    # Create the Blowfish-CBC cipher
+    cipher = OpenSSL::Cipher.new 'bf-ecb'
+    cipher.encrypt
+    cipher.key_len = key.length
+    cipher.key = key
+    cipher.padding = 0
+
+    # Add null padding to make the length a multiple of 8
+    plaintext += "\x00" * (8 - (plaintext.bytesize % 8))
+
+    # Generate the IRC message with prefix
+    '+OK ' + IrcBlowfish::Base64.encode(cipher.update(plaintext))
+  end
+
+  def self.decrypt_ecb(msg, key)
+    return msg if key.nil? or key == ''
+    return msg if msg.nil? or msg == ''
+
+    # Ensure the message is a valid Blowfish-ECB message and remove the prefix
+    ciphertext = msg.dup
+    return msg unless ciphertext.sub! %r{^\+OK }, ''
+    return msg if ciphertext[0] == '*' # Dump if this is actually a Blowfish-CBC message
+    return '' if ciphertext == '' # I've seen some clients send "+OK " for null messages
+
+    # Remove the ecb:/old: prefix if it's used
+    key = key.sub %r{^(?:old|ecb):}, ''
+    return msg if key == ''
+
+    # Create the Blowfish-CBC cipher
+    cipher = OpenSSL::Cipher.new 'bf-ecb'
+    cipher.decrypt
+    cipher.key_len = key.length
+    cipher.key = key
+    cipher.padding = 0
+
+    # Decrypt the ciphertext and remove the trailing padding
+    cipher.update(IrcBlowfish::Base64.decode(ciphertext)).sub! %r{\x00*$}, ''
+  end
+
+  def self.encrypt_cbc(msg, key)
+    return msg if key.nil? or key == ''
+    return msg if msg.nil? or msg == ''
+
+    # Force encoding to binary in case of non-ascii messages
+    plaintext = msg.dup.force_encoding 'BINARY'
+
+    # Remove the cbc: prefix if it's used
+    key = key.sub %r{^cbc:}, ''
+    return msg if key == ''
+
+    # Generate a random IV of length 8
+    iv = random_iv 8
+
+    # Create the Blowfish-CBC cipher
+    cipher = OpenSSL::Cipher.new 'bf-cbc'
+    cipher.encrypt
+    cipher.key_len = key.length
+    cipher.key = key
+    cipher.padding = 0
+    cipher.iv = iv
+
+    # Add null padding to make the length a multiple of 8
+    plaintext += "\x00" * (8 - (plaintext.bytesize % 8))
+
+    # Generate the IRC message with prefix
+    '+OK *' + ::Base64.encode64(iv + cipher.update(plaintext)).gsub!(/\n/, '')
+  end
+
+  def self.decrypt_cbc(msg, key)
+    return msg if key.nil? or key == ''
+    return msg if msg.nil? or msg == ''
+
+    # Ensure the message is a valid Blowfish-CBC message and remove the prefix
+    ciphertext = msg.dup
+    return msg unless ciphertext.sub! %r{^\+OK \*}, ''
+
+    # Remove the cbc: prefix if it's used
+    key = key.sub %r{^cbc:}, ''
+    return msg if key == ''
+
+    # Decode the text to get the IV + ciphertext
+    ciphertext = ::Base64.decode64 ciphertext
+
+    return msg if ciphertext.bytesize < 8
+
+    iv = ciphertext[0,8]           # Extract the IV from the string
+    ciphertext = ciphertext[8..-1] # Remove the IV from the string
+
+    return '' if ciphertext == ''
+
+    # Create the Blowfish-CBC cipher
+    cipher = OpenSSL::Cipher.new 'bf-cbc'
+    cipher.decrypt
+    cipher.key_len = key.length
+    cipher.key = key
+    cipher.padding = 0
+    cipher.iv = iv
+
+    # Decrypt the ciphertext and remove the trailing padding
+    cipher.update(ciphertext).sub! %r{\x00*$}, ''
+  end
+
+  private
+
+  def self.random_iv(len)
+    # Valid characters for IRC Blowfish-CBC IV: a-z A-Z 0-9 _
+    letters = [('a'..'z'),('A'..'Z'),('0'..'9')].map { |i| i.to_a }.flatten << '_'
+    (0...len).map { letters[SecureRandom.random_number(letters.length)] }.join
+  end
+end

data/lib/ircblowfish/base64.rb

@@ -0,0 +1,48 @@
+module IrcBlowfish
+  module Base64
+    B64 = './0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.freeze
+
+    def self.encode(bin)
+      str = ''
+
+      k = -1
+      while k < bin.length - 1
+        (l,r) = [0,0].map do |i|
+          [24, 16, 8, 0].each do |j|
+            i += bin[k+=1].ord << j
+          end
+          i
+        end
+        [r,l].each do |i|
+          6.times do
+            str += B64[i & 0x3F]
+            i >>= 6
+          end
+        end
+      end
+
+      str
+    end
+
+    def self.decode(str)
+      bin = ''
+
+      k = -1
+      while k < str.length - 1
+        (l,r) = [0,0].map do |i|
+          6.times do |j|
+            i |= B64.index(str[k+=1]) << (j * 6)
+          end
+          i
+        end
+        [r,l].each do |i|
+          [24, 16, 8, 0].each do |j|
+            bin += ((i & (0xFF << j)) >> j).chr
+          end
+        end
+      end
+
+      bin
+    end
+  end
+end

data/lib/ircblowfish/version.rb

@@ -0,0 +1,3 @@
+module IrcBlowfish
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ircblowfish
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Iverson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Ruby module for encrypting and decrypting IRC Blowfish ECB/CBC messages
+email:
+- iverson.jason.code@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ircblowfish.gemspec
+- lib/ircblowfish.rb
+- lib/ircblowfish/base64.rb
+- lib/ircblowfish/version.rb
+homepage: https://github.com/JasonIverson/ircblowfish-ruby/
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Encryption Module for IRC Blowfish Messages
+test_files: []