ircblowfish 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dea6b0abfbbd1e7c640e33889753fa44469b04ee
-  data.tar.gz: 180f2968dbbb59c2c70e03db62f4c729c7b45c5a
+  metadata.gz: ce1340544a3a148cd88f1fefed6d5b0df176a8ff
+  data.tar.gz: b41fc84584e98a0c89d702713de8e8c135035ebe
 SHA512:
-  metadata.gz: 4917e35b598efff54cb5e3b855165c4d87e4901b49a08449ef7a1a139c1864f90d18c16d87e432c54bf2f1beb6be46f4bcc7d39e378bab617f7d81a8981f8f45
-  data.tar.gz: fb23a33b987751d9c1516e2f0802254ab096e7fa0def0a859b5febca819239689ced1e504d68bcd45d5d5fa35ca09da76a4ba36c6870c02e3ae5ffe30a51d86e
+  metadata.gz: cfeff05298530252bf7e47c2d324d5a108a684afd5bcdf05a802a5d2126222f8e1a049138457b6c10e77760677230bfc423d160a7474f07135ff969b39725ab4
+  data.tar.gz: 81bb0336a1bd40ee44372b9bdce6cd3b17538cfa1fdae20eb772db284770967b9a0ee85ca5776a41a52dee0f495ec4d56a88998627404d6ea4025dca71fe4ecb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.1 (2016-05-04)
+### Added
+- +mcps prefix support
+
 ## 0.1.0 (2016-04-29)
 
 Initial Release

data/ircblowfish.gemspec

@@ -15,11 +15,17 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = `git ls-files -z {test,spec,features}/*`.split("\x0")
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  # May work on older versions, but this is the oldest I tested
+  spec.required_ruby_version = ">= 1.9.3"
+
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.requirements << 'openssl'
 end

data/lib/ircblowfish.rb

@@ -6,16 +6,26 @@ require "openssl"
 require "securerandom"
 
 module IrcBlowfish
+  # Encrypts a message using the specified key
+  # @param msg [String] the message to be encrypted
+  # @param key [String] the key used for encryption
+  # @return [String] the encrypted message
   def self.encrypt(msg, key)
     return encrypt_ecb(msg, key) if key =~ /^(?:old|ecb):/
     return encrypt_cbc(msg, key)
   end
 
+  # Decrypts a message using the specified key
+  # @param msg [String] the message to be decrypted
+  # @param key [String] the key used for decryption
+  # @return [String] the decrypted message
   def self.decrypt(msg, key)
     return decrypt_ecb(msg, key) if key =~ /^(?:old|ecb):/
     return decrypt_cbc(msg, key)
   end
 
+  # (see #encrypt)
+  # @note Forces the use of Blowfish-ECB despite the key passed
   def self.encrypt_ecb(msg, key)
     return msg if key.nil? or key == ''
     return msg if msg.nil? or msg == ''
@@ -41,13 +51,15 @@ module IrcBlowfish
     '+OK ' + IrcBlowfish::Base64.encode(cipher.update(plaintext))
   end
 
+  # (see #decrypt)
+  # @note Forces the use of Blowfish-ECB despite the key passed
   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 unless ciphertext.sub! %r{^\+(?:OK|mcps) }, ''
     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
 
@@ -66,6 +78,8 @@ module IrcBlowfish
     cipher.update(IrcBlowfish::Base64.decode(ciphertext)).sub! %r{\x00*$}, ''
   end
 
+  # (see #encrypt)
+  # @note Forces the use of Blowfish-CBC despite the key passed
   def self.encrypt_cbc(msg, key)
     return msg if key.nil? or key == ''
     return msg if msg.nil? or msg == ''
@@ -95,13 +109,15 @@ module IrcBlowfish
     '+OK *' + ::Base64.encode64(iv + cipher.update(plaintext)).gsub!(/\n/, '')
   end
 
+  # (see #decrypt)
+  # @note Forces the use of Blowfish-CBC despite the key passed
   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 \*}, ''
+    return msg unless ciphertext.sub! %r{^\+(?:OK|mcps) \*}, ''
 
     # Remove the cbc: prefix if it's used
     key = key.sub %r{^cbc:}, ''
@@ -131,6 +147,9 @@ module IrcBlowfish
 
   private
 
+  # Generates a random string used for the IV in Blowfish-CBC
+  # @param len [Integer] the length of the desired string
+  # @return [String] the random string
   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 << '_'

data/lib/ircblowfish/base64.rb

@@ -1,7 +1,11 @@
 module IrcBlowfish
   module Base64
+    # The Base64 characters modified for IRC Blowfish-ECB
     B64 = './0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.freeze
 
+    # Encodes a binary string in modified IRC Blowfish-ECB Base64
+    # @param bin [String] binary encoded string to be encoded
+    # @return [String] the Base64 encoded string
     def self.encode(bin)
       str = ''
 
@@ -24,6 +28,9 @@ module IrcBlowfish
       str
     end
 
+    # Decodes an IRC Blowfish-ECB Base64 string
+    # @param str [String] the Base64 encoded string
+    # @return [String] the decoded string
     def self.decode(str)
       bin = ''
 

data/lib/ircblowfish/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ircblowfish
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jason Iverson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-01 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,13 +85,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- openssl
 rubyforge_project: 
 rubygems_version: 2.5.1
 signing_key: