we_whisper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a56a0106dba9c9dec08902dab5edc2b149e2413
+  data.tar.gz: 6559b472e8beae2752e28dae4af52b996af1dcaf
+SHA512:
+  metadata.gz: 0ce8d458f5ec1faa48f54fdaefe2cc3b35fffa5bd2f7a540ea182e5e5c400d10593dc8dcf5abdb333de09f5f00c1d3e03fa26226d5474063f2c1f111b905841f
+  data.tar.gz: 6f2c2d9c94c1368b56ef0f7cec5471d30b2b907f8b4062572e68399c8878ff5fbeb1f783a5331151da4f40ed0c15b7f9221391cbd35c826d95fde36883847fe9

data/lib/we_whisper/cipher.rb

@@ -0,0 +1,72 @@
+# Credit: https://github.com/Eric-Guo/wechat/blob/master/lib/wechat/cipher.rb
+
+require 'openssl/cipher'
+require 'securerandom'
+require 'base64'
+
+module WeWhisper
+  module Cipher
+
+    BLOCK_SIZE = 32
+    CIPHER = 'AES-256-CBC'.freeze
+
+    def encrypt(plain, encoding_aes_key)
+      cipher = OpenSSL::Cipher.new(CIPHER)
+      cipher.encrypt
+
+      cipher.padding = 0
+      key_data = Base64.decode64(encoding_aes_key + '=')
+      cipher.key = key_data
+      cipher.iv = key_data[0..16]
+
+      cipher.update(plain) + cipher.final
+    end
+
+    def decrypt(msg, encoding_aes_key)
+      cipher = OpenSSL::Cipher.new(CIPHER)
+      cipher.decrypt
+
+      cipher.padding = 0
+      key_data = Base64.decode64(encoding_aes_key + '=')
+      cipher.key = key_data
+      cipher.iv = key_data[0..16]
+
+      plain = cipher.update(msg) + cipher.final
+      decode_padding(plain)
+    end
+
+    def pack(content, app_id)
+      random = SecureRandom.hex(8)
+      text = content.force_encoding('ASCII-8BIT')
+      msg_len = [text.length].pack('N')
+
+      encode_padding("#{random}#{msg_len}#{text}#{app_id}")
+    end
+
+    def unpack(msg)
+      msg = decode_padding(msg)
+      msg_len = msg[16, 4].reverse.unpack('V')[0]
+      content = msg[20, msg_len]
+      app_id = msg[(20 + msg_len)..-1]
+
+      [content, app_id]
+    end
+
+    private
+
+    def encode_padding(data)
+      length = data.bytes.length
+      amount_to_pad = BLOCK_SIZE - (length % BLOCK_SIZE)
+      amount_to_pad = BLOCK_SIZE if amount_to_pad == 0
+      padding = ([amount_to_pad].pack('c') * amount_to_pad)
+      data + padding
+    end
+
+    def decode_padding(plain)
+      pad = plain.bytes[-1]
+      # if padding is less than 1 or larger than block size, then set to 0
+      pad = 0 if pad < 1 || pad > BLOCK_SIZE
+      plain[0...(plain.length - pad)]
+    end
+  end
+end

data/lib/we_whisper/message.rb

@@ -0,0 +1,40 @@
+require 'active_support/core_ext/hash'
+
+module WeWhisper
+
+  InvalidMessageClassError = Class.new StandardError
+
+  module Message
+    extend self
+
+    def to_xml(content, signature, timestamp, nonce)
+"""<xml>
+<Encrypt><![CDATA[#{content}]]></Encrypt>
+<MsgSignature><![CDATA[#{signature}]]></MsgSignature>
+<TimeStamp>#{timestamp}</TimeStamp>
+<Nonce><![CDATA[#{nonce}]]></Nonce>
+</xml>"""
+    end
+
+    def get_value_of_key_in_message(message, key)
+      case message.class.name
+      when "String"
+        message_hash = Hash.from_xml(message)
+        message_hash[key] || message_hash["xml"][key]
+      when "Hash"
+        message[key] || message[key.to_sym]
+      else
+        raise InvalidMessageClassError, "Message can only be a String or a Hash"
+      end
+    end
+
+    def get_encrypted_content_from_message(message)
+      get_value_of_key_in_message(message, "Encrypt")
+    end
+
+    def get_signature_from_messge(message)
+      get_value_of_key_in_message(message, "MsgSignature")
+    end
+
+  end
+end

data/lib/we_whisper/signature.rb

@@ -0,0 +1,11 @@
+require 'digest/sha2'
+
+module WeWhisper
+  module Signature
+    def self.sign(token, timestamp, nonce, encrypted)
+      array = [token, timestamp, nonce]
+      array << encrypted unless encrypted.nil?
+      Digest::SHA1.hexdigest array.compact.collect(&:to_s).sort.join
+    end
+  end
+end

data/lib/we_whisper/version.rb

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

data/lib/we_whisper/whisper.rb

@@ -0,0 +1,61 @@
+require 'base64'
+
+require_relative 'cipher'
+require_relative 'signature'
+require_relative 'message'
+
+module WeWhisper
+  InvalidSignature = Class.new StandardError
+  AppIdNotMatch = Class.new StandardError
+
+  class Whisper
+    include Cipher
+
+    attr_reader :appid, :encoding_aes_key, :token, :options
+
+    def initialize(appid, token, encoding_aes_key, opts={})
+      @options = {
+        assert_signature: true,
+        assert_appid: true
+      }.merge(opts)
+
+      @appid = appid
+      @token = token
+      @encoding_aes_key = encoding_aes_key
+    end
+
+    def decrypt_message(message, nonce="", timestamp="")
+      # 1. Get the encrypted content from XML Message
+      encrypted_text = Message.get_encrypted_content_from_message(message)
+
+      # 2. If we need to validate signature, generate one from the encrypted text
+      #    and check with the Signature in message
+      if options[:assert_signature] && signature = Message.get_signature_from_messge(message)
+        sign = Signature.sign(token, timestamp, nonce, encrypted_text)
+        raise InvalidSignature if sign != signature
+      end
+
+      # 3. Decode and decrypt the encrypted text
+      decrypted_message, decrypted_appid = \
+        unpack(decrypt(Base64.decode64(encrypted_text), encoding_aes_key))
+
+      if options[:assert_appid]
+        raise AppIdNotMatch if decrypted_appid != appid
+      end
+
+      decrypted_message
+    end
+
+    def encrypt_message(message, nonce, timestamp)
+      # 1. Encrypt and encode the xml message
+      encrypt = Base64.strict_encode64(encrypt(pack(message, appid), encoding_aes_key))
+
+      # 2. Create signature
+      sign = Signature.sign(token, timestamp, nonce, encrypt)
+
+      # 3. Construct xml
+      Message.to_xml(encrypt, sign, timestamp, nonce)
+    end
+
+  end
+end

data/lib/we_whisper.rb

@@ -0,0 +1,6 @@
+module WeWhisper
+  require_relative 'we_whisper/cipher'
+  require_relative 'we_whisper/signature'
+  require_relative 'we_whisper/message'
+  require_relative 'we_whisper/whisper'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+
+require "we_whisper"

data/spec/we_whisper/message_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe WeWhisper::Message do
+
+  it "constructs XML message" do
+    expect(subject.to_xml("hello", "signature", "2016/10/10", "nonce")).to \
+      eq """<xml>
+<Encrypt><![CDATA[hello]]></Encrypt>
+<MsgSignature><![CDATA[signature]]></MsgSignature>
+<TimeStamp>2016/10/10</TimeStamp>
+<Nonce><![CDATA[nonce]]></Nonce>
+</xml>"""
+  end
+
+  describe "Message parsing" do
+    let(:hash_message) { { Encrypt: "hash_encrypted" } }
+    let(:xml_message) { """<xml>
+<Encrypt>xml_encrypted_message</Encrypt>
+</xml>"""
+      }
+
+    it "parses encrypted content from Hash message" do
+      expect(subject.get_encrypted_content_from_message(hash_message)).to \
+        eq "hash_encrypted"
+    end
+
+    it "parses encrypted content from XML message" do
+      expect(subject.get_encrypted_content_from_message(xml_message)).to \
+        eq "xml_encrypted_message"
+    end
+
+    it "raises invalid message class error from unknown message" do
+      expect{ subject.get_encrypted_content_from_message(nil) }.to \
+        raise_error WeWhisper::InvalidMessageClassError
+    end
+  end
+
+end

data/spec/we_whisper/signature_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe WeWhisper::Signature do
+
+  let(:timestamp) { "1415979516" }
+  let(:nonce)     { "1320562132" }
+  let(:signature) { "096d8cda45e4678ca23460f6b8cd281b3faf1fc3" }
+  let(:token)     { "spamtest" }
+  let(:encrypted) { "3kKZ++U5ocvIF8dAHPct7xvUqEv6vplhuzA8Vwj7OnVcBu9fdmbbI41zclSfKqP6/bdYAxuE3x8jse43ImHaV07siJF473TsXhl8Yt8task0n9KC7BDA73mFTwlhYvuCIFnU6wFlzOkHyM5Bh2qpOHYk5nSMRyUG4BwmXpxq8TvLgJV1jj2DXdGW4qdknGLfJgDH5sCPJeBzNC8j8KtrJFxmG7qIwKHn3H5sqBf6UqhXFdbLuTWL3jwE7yMLhzOmiHi/MX/ZsVQ7sMuBiV6bW0wkgielESC3yNUPo4q/RMAFEH0fRLr76BR5Ct0nUbf9PdClc0RdlYcztyOs54X/KLbYRNCQ2kXxmJYL6ekdNe70PCAReIEfXEp+pGpry4ss8bD6LKAtNvBJUwHshZe6sbf+fOiDiuKEqp1wdQLmgN+8nX62LklySWr8QrNCpsmKClxco0kbVYNX/QVh5yd0UA1sAqIn6baZ9G+Z/OXG+Q4n9lUuzLprLhDBPaCvXm4N14oqXNcw7tqU2xfhYNIDaD72djyIc/4eyAi2ZsJ+3hb+jgiISR5WVveRWYYqGZGTW3u+27JiXEo0fs3DQDbGVIcYxaMgU/RRIDdXzZSFcf6Z1azjzCDyV9FFEsicghHn" }
+
+  it "signs message" do
+    expect(subject.sign(token, timestamp, nonce, encrypted)).to eq signature
+  end
+
+end

data/spec/we_whisper/whisper_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe WeWhisper::Whisper do
+
+  let(:timestamp) { "1415979516" }
+  let(:nonce)     { "1320562132" }
+  let(:signature) { "096d8cda45e4678ca23460f6b8cd281b3faf1fc3" }
+  let(:message)   { "<xml><ToUserName><![CDATA[oia2TjjewbmiOUlr6X-1crbLOvLw]]></ToUserName><FromUserName><![CDATA[gh_7f083739789a]]></FromUserName><CreateTime>1407743423</CreateTime><MsgType>  <![CDATA[video]]></MsgType><Video><MediaId><![CDATA[eYJ1MbwPRJtOvIEabaxHs7TX2D-HV71s79GUxqdUkjm6Gs2Ed1KF3ulAOA9H1xG0]]></MediaId><Title><![CDATA[testCallBackReplyVideo]]></Title><Description><![CDATA[testCallBackReplyVideo]]></Description></Video></xml>" }
+  let(:whisper) { WeWhisper::Whisper.new "wx2c2769f8efd9abc2", "spamtest", "abcdefghijklmnopqrstuvwxyz0123456789ABCDEFG" }
+  let(:encrypted_message) {
+    """<xml>
+<Encrypt><![CDATA[3kKZ++U5ocvIF8dAHPct7xvUqEv6vplhuzA8Vwj7OnVcBu9fdmbbI41zclSfKqP6/bdYAxuE3x8jse43ImHaV07siJF473TsXhl8Yt8task0n9KC7BDA73mFTwlhYvuCIFnU6wFlzOkHyM5Bh2qpOHYk5nSMRyUG4BwmXpxq8TvLgJV1jj2DXdGW4qdknGLfJgDH5sCPJeBzNC8j8KtrJFxmG7qIwKHn3H5sqBf6UqhXFdbLuTWL3jwE7yMLhzOmiHi/MX/ZsVQ7sMuBiV6bW0wkgielESC3yNUPo4q/RMAFEH0fRLr76BR5Ct0nUbf9PdClc0RdlYcztyOs54X/KLbYRNCQ2kXxmJYL6ekdNe70PCAReIEfXEp+pGpry4ss8bD6LKAtNvBJUwHshZe6sbf+fOiDiuKEqp1wdQLmgN+8nX62LklySWr8QrNCpsmKClxco0kbVYNX/QVh5yd0UA1sAqIn6baZ9G+Z/OXG+Q4n9lUuzLprLhDBPaCvXm4N14oqXNcw7tqU2xfhYNIDaD72djyIc/4eyAi2ZsJ+3hb+jgiISR5WVveRWYYqGZGTW3u+27JiXEo0fs3DQDbGVIcYxaMgU/RRIDdXzZSFcf6Z1azjzCDyV9FFEsicghHn]]></Encrypt>
+<MsgSignature><![CDATA[096d8cda45e4678ca23460f6b8cd281b3faf1fc3]]></MsgSignature>
+<TimeStamp>1415979516</TimeStamp>
+<Nonce><![CDATA[1320562132]]></Nonce>
+</xml>"""
+  }
+
+  it "decrypts message" do
+    decrypted_message = whisper.decrypt_message(encrypted_message, nonce, timestamp)
+    expect(decrypted_message).to eq message
+  end
+
+  it "encryptes message" do
+    expect(SecureRandom).to receive(:hex).with(8).and_return("HLFOQjbkfgUh46s8")
+    encrypted_msg = whisper.encrypt_message(message, nonce, timestamp)
+
+    expect(encrypted_msg).to eq encrypted_message
+  end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: we_whisper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Qi He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+description: |2
+      Wechat(微信) open platform requires requests/messages to be encrypted. This
+      gem wrapps the encryption.
+email: qihe229@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/we_whisper/cipher.rb
+- lib/we_whisper/message.rb
+- lib/we_whisper/signature.rb
+- lib/we_whisper/version.rb
+- lib/we_whisper/whisper.rb
+- lib/we_whisper.rb
+- spec/spec_helper.rb
+- spec/we_whisper/message_spec.rb
+- spec/we_whisper/signature_spec.rb
+- spec/we_whisper/whisper_spec.rb
+homepage: http://github.com/he9qi/we_whisper
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A Ruby Wrapper for Wechat Message Encryption.
+test_files:
+- spec/spec_helper.rb
+- spec/we_whisper/message_spec.rb
+- spec/we_whisper/signature_spec.rb
+- spec/we_whisper/whisper_spec.rb