xxtea-ruby 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 488c7cce3d24c1541ba45624f3d5da139831541c
-  data.tar.gz: d36abcdaaa44bd169df2b2cbba895e47882e6853
+  metadata.gz: efc56a30ea088303af96c80f4f36b5a809aa1bb0
+  data.tar.gz: d46a9ccdadb94859bbe668d477abcd0f9c92fccf
 SHA512:
-  metadata.gz: 3e646c093bf4e44d84bfcc4fbf50b27bfc7ed4e81200d495e1be676eb55b4ba867313e77a5d2cfb7addc2f6535f3266f0f25eff15f6d4d02e69829488dd23dc4
-  data.tar.gz: 873474e74ca764d7972b409915633eea03584de3da170f138c2d64195c35276c6fe189acdf9ff1ebc16f7451bc8ef4948bb52fe331ea8fcc853a9d42e35cf1f0
+  metadata.gz: 09c1d9fab2db59aa73713a8aabad63b9de3e992fa267a5be3659833a2fa4d0df7cc02f046ed54b0f4fe03e1c123f360a9f0e493655c5a97775ecfcb65f882d70
+  data.tar.gz: b7d99f7446473f63820ac0d667969e760070a445622c25b1c6f0bb4a8e556b1a63cb575399c67bf4bdebe4c5c5e0a2a567351226fff0847219970321c76cb4ea

data/.gitignore

@@ -6,3 +6,5 @@ tmp
 *.bundle
 
 *.gem
+
+*.dylib

data/.travis.yml

@@ -6,4 +6,9 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+  - ree
 script: "bundle exec rake test"

data/Gemfile

@@ -2,6 +2,7 @@ source "http://rubygems.org"
 
 gemspec
 
+gem 'ffi'
 gem 'rake'
 gem 'rake-compiler'
 gem 'minitest', '~> 4.1'

data/README.md

@@ -1,8 +1,15 @@
 # XXTEA for Ruby
 
+<a href="https://github.com/xxtea/">
+    <img src="https://avatars1.githubusercontent.com/u/6683159?v=3&s=86" alt="XXTEA logo" title="XXTEA" align="right" />
+</a>
+
 [![Build Status](https://travis-ci.org/xxtea/xxtea-ruby.svg?branch=master)](https://travis-ci.org/xxtea/xxtea-ruby)
 [![Gem](https://img.shields.io/gem/v/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
 [![Gem](https://img.shields.io/gem/dt/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
+[![Gem](https://img.shields.io/gem/dtv/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
+[![Gems](https://img.shields.io/gem/rt/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
+[![Gems](https://img.shields.io/gem/rd/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
 
 ## Introduction
 
@@ -34,4 +41,4 @@ XXTEA.decrypt_utf8(encrypt_data, key) == XXTEA.decrypt(encrypt_data, key).force_
 
 ## Note
 
-There is no decrypt_utf8 function in ruby 1.8.x or lower version.
+decrypt_utf8 is an alias of decrypt in ruby 1.8.x or lower version.

data/README_zh_CN.md

@@ -1,7 +1,15 @@
 # XXTEA 加密算法的 Ruby 实现
 
+<a href="https://github.com/xxtea/">
+    <img src="https://avatars1.githubusercontent.com/u/6683159?v=3&s=86" alt="XXTEA logo" title="XXTEA" align="right" />
+</a>
+
 [![Build Status](https://travis-ci.org/xxtea/xxtea-ruby.svg?branch=master)](https://travis-ci.org/xxtea/xxtea-ruby)
 [![Gem](https://img.shields.io/gem/v/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
+[![Gem](https://img.shields.io/gem/dt/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
+[![Gem](https://img.shields.io/gem/dtv/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
+[![Gems](https://img.shields.io/gem/rt/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
+[![Gems](https://img.shields.io/gem/rd/xxtea-ruby.svg)](https://rubygems.org/gems/xxtea-ruby)
 
 ## 简介
 
@@ -33,4 +41,4 @@ XXTEA.decrypt_utf8(encrypt_data, key) == XXTEA.decrypt(encrypt_data, key).force_
 
 ## 注意
 
-在 1.8.x 或更低版本的 Ruby 上，没有 decrypt_utf8 这个函数。
+在 1.8.x 或更低版本的 Ruby 上，decrypt_utf8 只是 decrypt 的一个别名。

data/Rakefile

@@ -3,9 +3,11 @@ require 'rake/extensiontask'
 require 'rake/testtask'
 require 'rake/clean'
 
-Rake::ExtensionTask.new('xxtea') do |ext|
-  ext.lib_dir = 'lib'
-end
+#if !defined?(JRUBY_VERSION) then
+  Rake::ExtensionTask.new('xxtea') do |ext|
+    ext.lib_dir = 'lib/xxtea'
+  end
+#end
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
@@ -16,4 +18,6 @@ end
 desc "Run tests"
 task :default => :test
 
-Rake::Task[:test].prerequisites << :compile
+#if !defined?(JRUBY_VERSION) then
+  Rake::Task[:test].prerequisites << :compile
+#end

data/ext/xxtea/extconf.rb

@@ -1,3 +1,38 @@
-require 'mkmf'
-$CFLAGS += ' -g -O3 -Wall '
-create_makefile('xxtea')
+############################################################
+#                                                          #
+# xxtea/extconf.rb                                         #
+#                                                          #
+# XXTEA encryption algorithm library for Ruby.             #
+#                                                          #
+# Encryption Algorithm Authors:                            #
+#      David J. Wheeler                                    #
+#      Roger M. Needham                                    #
+#                                                          #
+# Code Author: Ma Bingyao <mabingyao@gmail.com>            #
+# LastModified: Feb 12, 2016                               #
+#                                                          #
+############################################################
+
+if !defined?(JRUBY_VERSION) then
+  require 'mkmf'
+  create_makefile('xxtea/xxtea')
+else
+  file = File.open('CMakeLists.txt', 'w') do |file|
+    file.puts 'project(xxtea)'
+    file.puts 'cmake_minimum_required(VERSION 2.6)'
+    file.puts 'set(CMAKE_MACOSX_RPATH 1)' if RUBY_PLATFORM=~/darwin/
+    file.puts 'set(LIBXXTEA_SRC ' + File.expand_path(File.dirname(__FILE__) + '/xxtea.c') +')'
+    file.puts 'add_library(xxtea SHARED ${LIBXXTEA_SRC})'
+    file.puts 'set_target_properties(xxtea PROPERTIES PREFIX "")'
+    file.puts 'set_target_properties(xxtea PROPERTIES SUFFIX "")'
+    if RUBY_PLATFORM=~/darwin/ then
+      file.puts 'set_target_properties(xxtea PROPERTIES OUTPUT_NAME "xxtea.bundle")'
+    elsif RUBY_PLATFORM=~/win32|w32/ then
+      file.puts 'set_target_properties(xxtea PROPERTIES OUTPUT_NAME "xxtea.dll")'
+    else
+      file.puts 'set_target_properties(xxtea PROPERTIES OUTPUT_NAME "xxtea.so")'
+    end
+    file.puts 'install(TARGETS xxtea DESTINATION ' + File.expand_path(File.dirname(__FILE__) + '/../../lib/xxtea') + ')'
+  end
+  system('cmake -G "Unix Makefiles" .')
+end

data/ext/xxtea/ruby_xxtea.c

@@ -1,8 +1,8 @@
 /**********************************************************\
 |                                                          |
-| xxtea.c                                                  |
+| ruby_xxtea.c                                             |
 |                                                          |
-| XXTEA encryption algorithm library for Lua.              |
+| XXTEA encryption algorithm library for Ruby.             |
 |                                                          |
 | Encryption Algorithm Authors:                            |
 |      David J. Wheeler                                    |
@@ -10,28 +10,31 @@
 |                                                          |
 | Code Authors: Chen fei <cf850118@163.com>                |
 |               Ma Bingyao <mabingyao@gmail.com>           |
-| LastModified: Feb 8, 2016                                |
+| LastModified: Feb 11, 2016                               |
 |                                                          |
 \**********************************************************/
 
 #include <ruby.h>
-#ifdef RSTRING_NOEMBED
-#include <ruby/encoding.h>
-#endif
 #include "xxtea.h"
 
 VALUE rb_encrypt(VALUE mod, VALUE data, VALUE key) {
-	unsigned char * result;
+	void * result;
 	VALUE retval;
 	size_t data_len, out_len;
 
+	if (data == Qnil) return rb_str_new(0,0);
+
 	Check_Type(data, T_STRING);
 	Check_Type(key, T_STRING);
 
 	data_len = RSTRING_LEN(data);
 
+	if (data_len == 0) return data;
+
 	result = xxtea_encrypt(RSTRING_PTR(data), data_len, RSTRING_PTR(key), &out_len);
 
+	if (result == NULL) return rb_str_new(0,0);
+
 	retval = rb_str_new((const char *)result, out_len);
 
 	free(result);
@@ -40,17 +43,23 @@ VALUE rb_encrypt(VALUE mod, VALUE data, VALUE key) {
 }
 
 VALUE rb_decrypt(VALUE mod, VALUE data, VALUE key) {
-	unsigned char *result;
+	void * result;
 	VALUE retval;
 	size_t data_len, out_len;
 
+	if (data == Qnil) return rb_str_new(0,0);
+
 	Check_Type(data, T_STRING);
 	Check_Type(key, T_STRING);
 
 	data_len = RSTRING_LEN(data);
 
+	if (data_len == 0) return data;
+
 	result = xxtea_decrypt(RSTRING_PTR(data), data_len, RSTRING_PTR(key), &out_len);
 
+	if (result == NULL) return rb_str_new(0,0);
+
 	retval = rb_str_new((const char *)result, out_len);
 
 	free(result);
@@ -58,17 +67,8 @@ VALUE rb_decrypt(VALUE mod, VALUE data, VALUE key) {
 	return retval;
 }
 
-#ifdef RSTRING_NOEMBED
-VALUE rb_decrypt_utf8(VALUE mod, VALUE data, VALUE key) {
-	return rb_enc_associate(rb_decrypt(mod, data, key), rb_utf8_encoding());
-}
-#endif
-
 void Init_xxtea() {
     VALUE XXTEA = rb_define_module("XXTEA");
     rb_define_singleton_method(XXTEA, "encrypt", rb_encrypt, 2);
     rb_define_singleton_method(XXTEA, "decrypt", rb_decrypt, 2);
-#ifdef RSTRING_NOEMBED
-	rb_define_singleton_method(XXTEA, "decrypt_utf8", rb_decrypt_utf8, 2);
-#endif
 }

data/lib/xxtea.rb

@@ -0,0 +1,38 @@
+############################################################
+#                                                          #
+# xxtea.rb                                                 #
+#                                                          #
+# XXTEA encryption algorithm library for Ruby.             #
+#                                                          #
+# Encryption Algorithm Authors:                            #
+#      David J. Wheeler                                    #
+#      Roger M. Needham                                    #
+#                                                          #
+# Code Author: Ma Bingyao <mabingyao@gmail.com>            #
+# LastModified: Feb 12, 2016                               #
+#                                                          #
+############################################################
+
+if File.exists?(File.dirname(__FILE__) + '/xxtea.' + (RUBY_PLATFORM=~/darwin/ ? 'dylib' : RUBY_PLATFORM=~/win32|w32/ ? 'dll' : 'so')) then
+  if !defined?(JRUBY_VERSION) then
+    require "xxtea/xxtea"
+  else
+    require "xxtea/xxtea_ffi"
+  end
+else
+  require "xxtea/xxtea_ruby"
+end
+
+module XXTEA
+  extend self
+  VERSION = "1.3.0"
+  if RUBY_VERSION >= "1.9.0" then
+    def decrypt_utf8(data, key)
+      decrypt(data, key).force_encoding(Encoding::UTF_8)
+    end
+  else
+    def decrypt_utf8(data, key)
+      decrypt(data, key)
+    end
+  end
+end

data/lib/xxtea/xxtea_ffi.rb

@@ -0,0 +1,63 @@
+############################################################
+#                                                          #
+# xxtea_ffi.rb                                            #
+#                                                          #
+# XXTEA encryption algorithm library for Ruby.             #
+#                                                          #
+# Encryption Algorithm Authors:                            #
+#      David J. Wheeler                                    #
+#      Roger M. Needham                                    #
+#                                                          #
+# Code Author: Ma Bingyao <mabingyao@gmail.com>            #
+# LastModified: Feb 12, 2016                               #
+#                                                          #
+############################################################
+
+require "ffi"
+
+module FFI
+  class Pointer
+    type = FFI.find_type(:size_t)
+    type, _ = FFI::TypeDefs.find do |(name, t)|
+      method_defined? "read_#{name}" if t == type
+    end
+    alias_method :read_size_t, "read_#{type}" if type
+  end
+end
+
+module XXTEA
+  private
+  module LIB
+    extend FFI::Library
+    ffi_lib File.dirname(__FILE__) + '/xxtea.' + (RUBY_PLATFORM=~/darwin/ ? 'dylib' : RUBY_PLATFORM=~/win32|w32/ ? 'dll' : 'so')
+    attach_function :xxtea_encrypt, [:pointer, :size_t, :pointer, :pointer], :pointer
+    attach_function :xxtea_decrypt, [:pointer, :size_t, :pointer, :pointer], :pointer
+    attach_function :free, [:pointer], :void
+  end
+  public
+  extend self
+  def encrypt(data, key)
+    return nil if data.nil?
+    data_len = data.bytesize
+    data = FFI::MemoryPointer.from_string(data)
+    key = FFI::MemoryPointer.from_string(key)
+    out_len = FFI::MemoryPointer.new(:size_t, 1)
+    result = LIB.xxtea_encrypt(data, data_len, key, out_len)
+    return nil if result.null?
+    retval = result.read_bytes(out_len.read_size_t)
+    LIB.free(result)
+    return retval
+  end
+  def decrypt(data, key)
+    return nil if data.nil?
+    data_len = data.bytesize
+    data = FFI::MemoryPointer.from_string(data)
+    key = FFI::MemoryPointer.from_string(key)
+    out_len = FFI::MemoryPointer.new(:size_t, 1)
+    result = LIB.xxtea_decrypt(data, data_len, key, out_len)
+    return nil if result.null?
+    retval = result.read_bytes(out_len.read_size_t)
+    LIB.free(result)
+    return retval
+  end
+end

data/lib/xxtea/xxtea_ruby.rb

@@ -0,0 +1,104 @@
+############################################################
+#                                                          #
+# xxtea_ruby.rb                                            #
+#                                                          #
+# XXTEA encryption algorithm library for Ruby.             #
+#                                                          #
+# Encryption Algorithm Authors:                            #
+#      David J. Wheeler                                    #
+#      Roger M. Needham                                    #
+#                                                          #
+# Code Author: Ma Bingyao <mabingyao@gmail.com>            #
+# LastModified: Feb 11, 2016                               #
+#                                                          #
+############################################################
+module XXTEA
+
+  private
+  DELTA = 0x9e3779b9
+
+  extend self
+
+  def uint32_array_to_bytes(v, w)
+    n = (v.size - 1) << 2
+    if w then
+      m = v.last
+      return '' if (m < n - 3) or (m > n)
+      n = m
+    end
+    s = v.pack("V*")
+    w ? s[0, n] : s
+  end
+
+  def bytes_to_uint32_array(s, w)
+    n = s.bytesize
+    v = s.ljust((4 - (n & 3) & 3) + n, "\0").unpack("V*")
+    v[v.size] = n if w
+    v
+  end
+
+  if RUBY_VERSION >= "1.9.0" then
+    def str_to_uint32_array(s, w)
+      s = String.new(s).force_encoding(Encoding::BINARY) if (s.encoding != Encoding::BINARY)
+      bytes_to_uint32_array(s, w)
+    end
+  else
+    alias :str_to_uint32_array :bytes_to_uint32_array
+  end
+
+  def mx(sum, y, z, p, e, k)
+    ((z >> 5 ^ y << 2) + (y >> 3 ^ z << 4)) ^ ((sum ^ y) + (k[p & 3 ^ e] ^ z))
+  end
+
+  def encrypt_uint32_array(v, k)
+    n = v.size - 1
+    z = v[n]
+    y = 0
+    sum = 0
+    (6 + 52 / (n + 1)).downto(1) {
+      sum = (sum + DELTA) & 0xffffffff
+      e = (sum >> 2) & 3
+      for p in (0...n)
+        y = v[p + 1]
+        z = v[p] = (v[p] + mx(sum, y, z, p, e, k)) & 0xffffffff
+      end
+      y = v[0]
+      z = v[n] = (v[n] + mx(sum, y, z, n, e, k)) & 0xffffffff
+    }
+    return v
+  end
+
+  def decrypt_uint32_array(v, k)
+    n = v.size - 1
+    z = 0
+    y = v[0]
+    sum = ((6 + 52 / (n + 1)) * DELTA) & 0xffffffff
+    while (sum != 0)
+      e = sum >> 2 & 3
+      n.downto(1) { |p|
+        z = v[p - 1]
+        y = v[p] = (v[p] - mx(sum, y, z, p, e, k)) & 0xffffffff
+      }
+      z = v[n]
+      y = v[0] = (v[0] - mx(sum, y, z, 0, e, k)) & 0xffffffff
+      sum = (sum - DELTA) & 0xffffffff
+    end
+    return v
+  end
+
+  public
+
+  def encrypt(data, key)
+    return '' if data.nil? or data.empty?
+    v = str_to_uint32_array(data, true)
+    k = str_to_uint32_array(key.ljust(16, "\0"), false)
+    uint32_array_to_bytes(encrypt_uint32_array(v, k), false)
+  end
+
+  def decrypt(data, key)
+    return '' if data.nil? or data.empty?
+    v = str_to_uint32_array(data, false)
+    k = str_to_uint32_array(key.ljust(16, "\0"), false)
+    uint32_array_to_bytes(decrypt_uint32_array(v, k), true)
+  end
+end

data/test/xxtea_test.rb

@@ -2,9 +2,9 @@
 require "minitest/autorun"
 require "xxtea"
 
-describe "XXTEA" do
+describe "xxtea" do
     it "test xxtea encrypt and decrypt" do
-        text = "Hello World! 你好，中国！"
+        text = "Hello World! \0你好，中国！"
         key = "1234567890"
         encrypt_data = XXTEA.encrypt(text, key)
         if RUBY_VERSION >= "1.9.0" then

data/xxtea-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name         = 'xxtea-ruby'
-  s.version      = '1.2.0'
+  s.version      = '1.3.0'
   s.license      = 'MIT'
   s.author       = 'Ma Bingyao ( andot )'
   s.email        = 'mabingyao@gmail.com'
@@ -17,4 +17,7 @@ EOF
   s.test_files   = s.files.grep(%r{^test/})
   s.require_path = 'lib'
   s.extensions   = ["ext/xxtea/extconf.rb"]
-  end
+
+  s.add_runtime_dependency 'ffi', '~> 1.9', '>= 1.9.10'
+  s.requirements << 'cmake'
+end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: xxtea-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ma Bingyao ( andot )
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-07 00:00:00.000000000 Z
-dependencies: []
+date: 2016-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.10
 description: |2
     XXTEA is a fast and secure encryption algorithm. This is a XXTEA library for Ruby.
 
@@ -31,6 +51,9 @@ files:
 - ext/xxtea/ruby_xxtea.c
 - ext/xxtea/xxtea.c
 - ext/xxtea/xxtea.h
+- lib/xxtea.rb
+- lib/xxtea/xxtea_ffi.rb
+- lib/xxtea/xxtea_ruby.rb
 - test/xxtea_test.rb
 - xxtea-ruby.gemspec
 homepage: https://github.com/xxtea/xxtea-ruby
@@ -51,7 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- cmake
 rubyforge_project: 
 rubygems_version: 2.5.0
 signing_key: