hsign 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1 @@
+This is a property of Helios Technologies Ltd.

data/README.md

@@ -0,0 +1,50 @@
+# Digiweb
+
+This gem aims at signing for cross-application request
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hsign'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hsign
+
+## Usage
+
+For Web application use, a good salt is the IP of the browser
+
+*Never pass the API SECRET in the request*
+
+In consumer (client side) controller
+
+    credentials = {'email' => 'user@example.com', 'password' => '123456', 'client_id' => "sha1apikey", 'response_type' => 'code', 'redirect_uri' => settings[:redirect_uri]}
+
+    @hsign = HSign::Digest.new("api_secret", request.ip)
+    @hsign.sign credentials
+
+In your view
+
+    <%= form_tag "http://otherserver.com/api/example" do %>
+      <% @hsign.each_param do |field, value| %>
+        <%= hidden_field_tag field, value %>
+      <% end %>
+      <%= submit_tag "Submit" %>
+    <% end %>
+
+
+Verification (server side)
+
+    client = Idnet::Core:Client.find params[:client_id]
+    secret = client.secret
+    @hsign = HSign::Digest.new(secret, request.ip)
+    if @hsign.verify? request.params
+      account = Idnet::Core::Account.create email: params[:email], password: params[:password]
+      account.confirm!
+    end

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/hsign.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hsign/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hsign"
+  gem.version       = HSign::VERSION
+  gem.authors       = ["Helios Technologies Ltd."]
+  gem.email         = ["hery@heliostech.hk"]
+  gem.description   = %q{Web Digital Signature}
+  gem.summary       = %q{Web Digital Signature}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.add_dependency "rack"
+  gem.add_development_dependency "test-unit"
+  gem.add_development_dependency "rake"
+  gem.require_paths = ["lib"]
+end

data/lib/hsign.rb

@@ -0,0 +1,5 @@
+require "hsign/version"
+
+module HSign
+  # Your code goes here...
+end

data/lib/hsign/digest.rb

@@ -0,0 +1,40 @@
+require 'openssl'
+require 'rack/utils'
+module HSign
+  class Digest
+    attr_accessor :hmac_key
+    attr_reader :params
+
+    def initialize(secret, salt = nil)
+      @digest = OpenSSL::Digest::Digest.new('sha1')
+      @hmac_key = '_hmac'
+      @secret = secret
+      @salt = salt
+    end
+
+    def sign(request_params)
+      hmac = OpenSSL::HMAC.new @secret, @digest
+      hmac << @salt if @salt
+      # Normalize all params
+      @params = Rack::Utils.parse_query(Rack::Utils.build_nested_query(request_params.dup))
+      @params.delete(hmac_key)
+
+      @params.to_a.sort_by{|k,v| k.to_s}.each do |k,v|
+        hmac << "#{k}=#{v}"
+      end
+
+      @params[hmac_key] =  hmac.hexdigest
+    end
+
+    def verify?(params)
+      expected = params.delete(hmac_key)
+      expected == sign(params)
+    end
+
+    def each_param &block
+      return false unless @params
+      @params.each(&block)
+    end
+
+  end
+end

data/lib/hsign/version.rb

@@ -0,0 +1,3 @@
+module HSign
+  VERSION = "0.0.1"
+end

data/test/digest_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+require 'hsign/digest'
+
+class DigestTest < Test::Unit::TestCase
+
+  def setup
+    @ip = "127.0.0.1"
+    @params = {'key1' => 'value1', 'key2' => 'value2'}
+    @hsign = HSign::Digest.new("secret", @ip)
+  end
+
+  test "changing ip" do
+    sig = @hsign.sign(@params)
+    other_hsign = HSign::Digest.new("secret", "127.0.1.1")
+    sig1 = other_hsign.sign(@params)
+    assert_not_equal sig, sig1
+  end
+
+  test "changing parameter" do
+    params = @params.dup
+    params['key1'] = 'different'
+    sig = @hsign.sign(@params)
+    sig1 = @hsign.sign(params)
+    assert_not_equal sig, sig1
+  end
+
+  test "changing secret" do
+    other_hsign = HSign::Digest.new("anothersecret", @ip)
+    sig = @hsign.sign(@params)
+    sig1 = other_hsign.sign(@params)
+    assert_not_equal sig, sig1
+  end
+
+  test "verify signature" do
+    sig = @hsign.sign(@params)
+    other_hsign = HSign::Digest.new("secret", @ip)
+
+    assert_nil @params[@hsign.hmac_key]
+    params = @params.dup
+    params[@hsign.hmac_key] = sig
+    assert other_hsign.verify?(params)
+
+    # let test another hmac
+    other_hsign = HSign::Digest.new("secret", @ip)
+    p = params.dup
+    params[@hsign.hmac_key] = sig + "altered"
+    assert !other_hsign.verify?(p)
+  end
+
+  test "nested parameters" do
+    params = {prefill: {key1: 'hello', key2: 'world'}}
+    equivalent_params = {'prefill[key1]' => 'hello', 'prefill[key2]' => 'world'}
+    assert_equal @hsign.sign(params), @hsign.sign(equivalent_params)
+
+    params = {prefill: {ns: {name: 'hello'}, key2: 'world'}, terra: 'incognita'}
+    equivalent_params = {'prefill[ns][name]' => 'hello', 'prefill[key2]' => 'world', 'terra' => 'incognita'}
+    assert_equal @hsign.sign(params), @hsign.sign(equivalent_params)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler.require
+require 'test/unit'
+$:.unshift '../lib'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: hsign
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Helios Technologies Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &16653640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *16653640
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &16653220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16653220
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &16652800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16652800
+description: Web Digital Signature
+email:
+- hery@heliostech.hk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hsign.gemspec
+- lib/hsign.rb
+- lib/hsign/digest.rb
+- lib/hsign/version.rb
+- test/digest_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Web Digital Signature
+test_files:
+- test/digest_test.rb
+- test/test_helper.rb