keen 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 982be161aadc1fa73c08a841f36a4056657904c0
-  data.tar.gz: 53ec16352023fac9586003cd097381368e626498
+  metadata.gz: a1699510fc2d24980d980c0fc72cd2a8b95db715
+  data.tar.gz: a50d16fe6edff311e4482217a96a89f812b81988
 SHA512:
-  metadata.gz: fae9fcb9b63d095474b685b872df14c25689251feb04e895c4c23af2f0da6f6002f53b5474473116b9df0032520f890b6ab8292c64668d187a521d8fc2103001
-  data.tar.gz: 782c04eafab7b4f49cf20fd70892c408767491608f20c3426bf66d316956f82d64e2cea8f858cdd3290c001aedbd1cd94b277d34086520713cbf2332fda0580f
+  metadata.gz: 8d4e6b05301f89eaf477bc95f4b9297ac22ca96706e3133458cccdff0bd2a2a0d0a6f6c377273e5358bee1924a0a52376068e8d34f4fcc875ec20d959a816ec3
+  data.tar.gz: eea17f8068313eefcb15f2c23460f23fccf212e1464e12050ee18f2069980d344581cb39228c38838a02f8363ab6bc0988b62b39cb488e019f9a70b1a092d5f5

data/README.md

@@ -412,6 +412,9 @@ If you want some bot protection, check out the [Voight-Kampff](https://github.co
 
 ### Changelog
 
+##### 0.9.5
++ Fix bug with scoped key generation not working with newer Keen projects.
+
 ##### 0.9.4
 + Add SDK support for Saved Queries
 + Removed support for Ruby MRI 1.8.7

data/lib/keen/aes_helper.rb

@@ -3,42 +3,35 @@ require 'digest'
 require 'base64'
 
 module Keen
-  module AESHelper
+  class AESHelper
 
-    BLOCK_SIZE = 32
+    class << self
+      def aes256_decrypt(key, iv_plus_encrypted)
+        aes = OpenSSL::Cipher::AES.new(256, :CBC)
+        iv = iv_plus_encrypted[0, aes.key_len]
+        encrypted = iv_plus_encrypted[aes.key_len, iv_plus_encrypted.length]
+        aes.decrypt
+        aes.key = unhexlify(key)
+        aes.iv = unhexlify(iv)
+        aes.update(unhexlify(encrypted)) + aes.final
+      end
 
-    def aes256_encrypt(key, plaintext, iv = nil)
-      aes = OpenSSL::Cipher::AES.new(256, :CBC)
-      aes.encrypt
-      aes.key = key
-      aes.iv = iv unless iv.nil?
-      iv ||= aes.random_iv
-      [aes.update(plaintext) + aes.final, iv]
-    end
-
-    def aes256_decrypt(key, iv_plus_encrypted)
-      iv = iv_plus_encrypted[0, 16]
-      encrypted = iv_plus_encrypted[16, iv_plus_encrypted.length]
-      aes = OpenSSL::Cipher::AES.new(256, :CBC)
-      aes.decrypt
-      aes.key = key
-      aes.iv = iv
-      aes.update(encrypted) + aes.final
-    end
+      def aes256_encrypt(key, plaintext, iv = nil)
+        aes = OpenSSL::Cipher::AES.new(256, :CBC)
+        aes.encrypt
+        aes.key = unhexlify(key)
+        aes.iv = iv unless iv.nil?
+        iv ||= aes.random_iv
+        hexlify(iv) + hexlify(aes.update(plaintext) + aes.final)
+      end
 
-    def hexlify(msg)
-      msg.unpack('H*')[0]
-    end
-
-    def unhexlify(msg)
-      [msg].pack('H*')
-    end
+      def hexlify(msg)
+        msg.unpack('H*')[0]
+      end
 
-    def pad(msg)
-      pad_len = BLOCK_SIZE - (msg.length % BLOCK_SIZE)
-      padding = pad_len.chr * pad_len
-      padded = msg + padding
-      padded
+      def unhexlify(msg)
+        [msg].pack('H*')
+      end
     end
   end
 end

data/lib/keen/aes_helper_old.rb

@@ -0,0 +1,50 @@
+require 'openssl'
+require 'digest'
+require 'base64'
+
+module Keen
+  class AESHelperOld
+
+    BLOCK_SIZE = 32
+
+    class << self
+      def aes256_decrypt(key, iv_plus_encrypted)
+        padded_key = pad(key)
+        unhexed_iv_plus_encrypted = unhexlify(iv_plus_encrypted)
+        iv = unhexed_iv_plus_encrypted[0, 16]
+        encrypted = unhexed_iv_plus_encrypted[16, unhexed_iv_plus_encrypted.length]
+        aes = OpenSSL::Cipher::AES.new(256, :CBC)
+        aes.decrypt
+        aes.key = padded_key
+        aes.iv = iv
+        aes.update(encrypted) + aes.final
+      end
+
+      def aes256_encrypt(key, plaintext, iv = nil)
+        padded_key = pad(key)
+        aes = OpenSSL::Cipher::AES.new(256, :CBC)
+        aes.encrypt
+        aes.key = padded_key
+        aes.iv = iv unless iv.nil?
+        iv ||= aes.random_iv
+        encrypted = aes.update(plaintext) + aes.final
+        hexlify(iv) + hexlify(encrypted)
+      end
+
+      def hexlify(msg)
+        msg.unpack('H*')[0]
+      end
+
+      def unhexlify(msg)
+        [msg].pack('H*')
+      end
+
+      def pad(msg)
+        pad_len = BLOCK_SIZE - (msg.length % BLOCK_SIZE)
+        padding = pad_len.chr * pad_len
+        padded = msg + padding
+        padded
+      end
+    end
+  end
+end

data/lib/keen/scoped_key.rb

@@ -1,19 +1,20 @@
 require 'multi_json'
 require 'keen/aes_helper'
+require 'keen/aes_helper_old'
 
 module Keen
   class ScopedKey
-    include AESHelper
-    extend AESHelper
 
     attr_accessor :api_key
     attr_accessor :data
 
     class << self
       def decrypt!(api_key, scoped_key)
-        encrypted = unhexlify(scoped_key)
-        padded_api_key = pad(api_key)
-        decrypted = aes256_decrypt(padded_api_key, encrypted)
+        if api_key.length == 64
+          decrypted = Keen::AESHelper.aes256_decrypt(api_key, scoped_key)
+        else
+          decrypted = Keen::AESHelperOld.aes256_decrypt(api_key, scoped_key)
+        end
         data = MultiJson.load(decrypted)
         self.new(api_key, data)
       end
@@ -26,9 +27,11 @@ module Keen
 
     def encrypt!(iv = nil)
       json_str = MultiJson.dump(self.data)
-      padded_api_key = pad(self.api_key)
-      encrypted, iv = aes256_encrypt(padded_api_key, json_str, iv)
-      hexlify(iv) + hexlify(encrypted)
+      if self.api_key.length == 64
+        Keen::AESHelper.aes256_encrypt(self.api_key, json_str, iv)
+      else
+        Keen::AESHelperOld.aes256_encrypt(self.api_key, json_str, iv)
+      end
     end
   end
 end

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.9.4"
+  VERSION = "0.9.5"
 end

data/spec/keen/scoped_key_old_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Keen::ScopedKey do
+  let(:api_key) { "ab428324dbdbcfe744" }
+  let(:bad_api_key) { "badbadbadbad" }
+  let(:data) { {
+   "filters" => [{
+      "property_name" => "accountId",
+      "operator" => "eq",
+      "property_value" => "123456"
+    }]
+  }}
+  let(:new_scoped_key) { Keen::ScopedKey.new(api_key, data) }
+
+  describe "constructor" do
+    it "should retain the api_key" do
+      new_scoped_key.api_key.should == api_key
+    end
+
+    it "should retain the data" do
+      new_scoped_key.data.should == data
+    end
+  end
+
+  describe "encrypt! and decrypt!" do
+    it "should encrypt and hex encode the data using the api key" do
+      encrypted_str = new_scoped_key.encrypt!
+      other_api_key = Keen::ScopedKey.decrypt!(api_key, encrypted_str)
+      other_api_key.data.should == data
+    end
+
+    describe "when an IV is not provided" do
+      it "should not produce the same encrypted key text" do
+        new_scoped_key.encrypt!.should_not == (new_scoped_key.encrypt!)
+      end
+    end
+
+    describe "when an IV is provided" do
+      it "should produce the same encrypted key text for a " do
+        iv = "\0" * 32
+        new_scoped_key.encrypt!(iv).should == (new_scoped_key.encrypt!(iv))
+      end
+
+      it "should raise error when an invalid IV is supplied" do
+        iv = "fakeiv"
+        expect { new_scoped_key.encrypt!(iv) }.to raise_error(OpenSSL::Cipher::CipherError)
+      end
+    end
+
+    it "should not decrypt the scoped key with a bad api key" do
+      encrypted_str = new_scoped_key.encrypt!
+      expect {
+        other_api_key = Keen::ScopedKey.decrypt!(bad_api_key, encrypted_str)
+      }.to raise_error(OpenSSL::Cipher::CipherError)
+    end
+  end
+end

data/spec/keen/scoped_key_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe Keen::ScopedKey do
-  let(:api_key) { "ab428324dbdbcfe744" }
-  let(:bad_api_key) { "badbadbadbad" }
+  let(:api_key) {     "24077ACBCB198BAAA2110EDDB673282F8E34909FD823A15C55A6253A664BE368" }
+  let(:bad_api_key) { "24077ACBCB198BAAA2110EDDB673282F8E34909FD823A15C55A6253A664BE369" }
   let(:data) { {
    "filters" => [{
       "property_name" => "accountId",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Alex Kleissner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -155,6 +155,7 @@ files:
 - keen.gemspec
 - lib/keen.rb
 - lib/keen/aes_helper.rb
+- lib/keen/aes_helper_old.rb
 - lib/keen/client.rb
 - lib/keen/client/maintenance_methods.rb
 - lib/keen/client/publishing_methods.rb
@@ -172,6 +173,7 @@ files:
 - spec/keen/client_spec.rb
 - spec/keen/keen_spec.rb
 - spec/keen/saved_query_spec.rb
+- spec/keen/scoped_key_old_spec.rb
 - spec/keen/scoped_key_spec.rb
 - spec/keen/spec_helper.rb
 - spec/spec_helper.rb
@@ -197,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Keen IO API Client
@@ -211,6 +213,7 @@ test_files:
 - spec/keen/client_spec.rb
 - spec/keen/keen_spec.rb
 - spec/keen/saved_query_spec.rb
+- spec/keen/scoped_key_old_spec.rb
 - spec/keen/scoped_key_spec.rb
 - spec/keen/spec_helper.rb
 - spec/spec_helper.rb