hanvon 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjMwZjdlYmU0ZDJjMjMzOTI1Y2Q1YzU5NTczYjBlZWY4OTBlNzZmNg==
+  data.tar.gz: !binary |-
+    ZjlhYTY0YjAwODg4MTFjZGQyZmYxY2ExNjZlMDg0ZTgzN2M0M2MwNA==
+SHA512:
+  metadata.gz: !binary |-
+    MTQ3MmJmMWQxOTFhNTQwY2ZhZWM5MDljZGNiYzFhMjI0YjRhYzBjMDE5MmI1
+    NjU0ZTczOGQxY2JhNjdjMGQxNzdlZGIzZmY0YmNlMTIxZTZjNmZhODk4NDcx
+    MTQ4NzE1ZmJjOTRhNTRlNTVhYmQ2ZThjYzA1ODQxYjNlNWNjOGE=
+  data.tar.gz: !binary |-
+    N2FmNWU3Y2Y5N2U3OGIwYTVjMzYxOWE2MzJiM2MxN2I4NDRiNjBkYTQ1NGJi
+    MDYyYzJhZmY2MmY1ODFiYTk0ODFmMGI3YzViNTQ2NWExZjhmMDNkMmQ0ZGE5
+    YTg1OTgyYTc5MjNjYmM5MjRiOGRhZjc3NWZjYjE3NjY2YjUwNWI=

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+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 hanvon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Heinrich Lee Yu
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+# Ruby Hanvon Client Library
+
+This is a ruby client that communicates with Hanvon Time & Attendance devices over the network.
+
+Hanvon provides an SDK consisting only  of a file named HwDevComm.dll. There is no official Linux support. Hence, I decided to reverse engineer the protocol. When used without a commukey / password, you can easily communicate with the device via a TCP socket and send the commands in plain text. However, when a key is used, messages sent and received are encrypted.
+
+This is not official code from Hanvon. This is tested on the F710, but should work for the other models.
+
+For more info on Hanvon devices, visit:
+
+http://www.hanvon.com/en/products/FaceID/products/index.html
+
+SDK documentation with list of functions is included in doc/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hanvon'

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hanvon.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hanvon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hanvon"
+  spec.version       = Hanvon::VERSION
+  spec.authors       = ["Heinrich Lee Yu"]
+  spec.email         = ["hleeyu@gmail.com"]
+  spec.description   = %q{Ruby client for communicating with Hanvon Time & Attendance Devices over the network}
+  spec.summary       = %q{Ruby client for Hanvon Time & Attendance Devices}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/hanvon.rb

@@ -0,0 +1,7 @@
+require "hanvon/client"
+require "hanvon/crypto"
+require "hanvon/version"
+
+module Hanvon
+
+end

data/lib/hanvon/client.rb

@@ -0,0 +1,85 @@
+require 'socket'
+
+module Hanvon
+  class Client
+
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :password
+
+    attr_accessor :socket
+    attr_accessor :encryptor
+
+    def initialize(host, port = 9922, password = nil)
+      self.host = host
+      self.port = port
+      self.password = password
+
+      self.socket = TCPSocket.new(host, port)
+      self.encryptor = Crypto.new(password) unless password.nil?
+    end
+
+    def send_command(command, params = {})
+      param_strings = []
+      params.each { |k,v|
+        param_strings << "#{k}=\"#{v}\""
+      }
+
+      send("#{command}(#{param_strings.join(" ")})")
+    end
+
+    def send(message)
+      socket.write(encryptor ? encryptor.encrypt(message) : message)
+      parse_reply(read_reply)
+    end
+
+    def parse_reply(reply)
+      response = []
+
+      response_data = reply.sub(/\AReturn\(/, "").chomp(")")
+      response_data.split("\n").each_with_index { |r, i|
+        row_hash = {}
+        r.scan(/(\S+?)="(.*?)"/).each do |m|
+          row_hash[m[0]] = m[1]
+        end
+
+        if i == 0
+          row_hash.delete('result')
+          row_hash.delete('dev_id')
+        end
+
+        response << row_hash unless row_hash.empty?
+      }
+
+      response = response.first if response.size == 1
+
+      return response
+    end
+
+    def close
+      socket.close
+    end
+
+    protected
+
+    def read_reply
+      reply = ""
+
+      while true
+        chunk = socket.recv(1024)
+        reply += encryptor ? encryptor.decrypt(chunk, reply.length % 8) : chunk
+
+        if reply[-1] == ')' and reply =~ /\A\w+\((?:\w+\s*=\s*".*"\s*)*\)\z/
+          if reply.start_with?("Wait(")
+            reply = ""
+          else
+            break
+          end
+        end
+      end
+
+      reply
+    end
+
+  end
+end

data/lib/hanvon/crypto.rb

@@ -0,0 +1,47 @@
+module Hanvon
+  class Crypto
+
+    class InvalidPasswordException < StandardError; end
+
+    attr_accessor :password
+
+    def initialize(password)
+      self.password = password
+    end
+
+    def convert(message, offset = 0)
+      message.each_char.each_with_index.collect do |char, pos|
+        convert_char(char, pos + offset)
+      end.pack('C*')
+    end
+
+    alias_method :encrypt, :convert
+    alias_method :decrypt, :convert
+
+    def password=(password)
+      if valid_password?(password)
+        @password = password
+        compute_key
+      else
+        raise InvalidPasswordException
+      end
+    end
+
+    protected
+
+    def convert_char(char, pos)
+      return char.ord ^ @key[pos % 8]
+    end
+
+    def valid_password?(password)
+      password =~ /\A\d{1,8}\z/
+    end
+
+    def compute_key
+      @key = (0..7).collect do |pos|
+        (password[pos] || 0).ord + (2 ** pos >> 1)
+      end
+    end
+
+  end
+end

data/lib/hanvon/version.rb

@@ -0,0 +1,3 @@
+module Hanvon
+  VERSION = "0.0.2"
+end

data/spec/hanvon_crypto_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Hanvon::Crypto do
+
+  it "should not accept empty password" do
+    lambda {
+      Hanvon::Crypto.new('')
+    }.should raise_exception(Hanvon::Crypto::InvalidPasswordException)
+  end
+
+  it "should not accept password with more than 8 digits" do
+    lambda {
+      Hanvon::Crypto.new('123123123')
+    }.should raise_exception(Hanvon::Crypto::InvalidPasswordException)
+  end
+
+  it "should not accept non-numeric password" do
+    lambda {
+      Hanvon::Crypto.new('abc')
+    }.should raise_exception(Hanvon::Crypto::InvalidPasswordException)
+  end
+
+  context "with password 12345678" do
+    before :all do
+      @crypto = Hanvon::Crypto.new('12345678')
+    end
+
+    describe "#encrypt" do
+      it "returns encrypted message" do
+        @crypto.encrypt("GetDeviceInfo()").should == ['7656417c58303e1b547a5b5e526e7e'].pack("H*")
+      end
+    end
+
+    describe "#decrypt" do
+      it "returns original message" do
+        @crypto.decrypt(['7656417c58303e1b547a5b5e526e7e'].pack("H*")).should == "GetDeviceInfo()"
+      end
+    end
+  end
+
+  context "with password 00000000" do
+    before :all do
+      @crypto = Hanvon::Crypto.new('00000000')
+    end
+
+    describe "#encrypt" do
+      it "returns encrypted message" do
+        @crypto.encrypt("GetDeviceInfo()").should == ['775446705d36391355785c52576879'].pack("H*")
+      end
+    end
+
+    describe "#decrypt" do
+      it "returns original message" do
+        @crypto.decrypt(['775446705d36391355785c52576879'].pack("H*")).should == "GetDeviceInfo()"
+      end
+    end
+  end
+
+  context "with password 1234" do
+    before :all do
+      @crypto = Hanvon::Crypto.new('1234')
+    end
+
+    describe "#encrypt" do
+      it "returns encrypted message" do
+        @crypto.encrypt("GetDeviceInfo()").should == ['7656417c6d664923547a5b5e673809'].pack("H*")
+      end
+    end
+
+    describe "#decrypt" do
+      it "returns original message" do
+        @crypto.decrypt(['7656417c6d664923547a5b5e673809'].pack("H*")).should == "GetDeviceInfo()"
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'hanvon'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: hanvon
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Heinrich Lee Yu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for communicating with Hanvon Time & Attendance Devices over
+  the network
+email:
+- hleeyu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/HanvonSDKManual.pdf
+- hanvon.gemspec
+- lib/hanvon.rb
+- lib/hanvon/client.rb
+- lib/hanvon/crypto.rb
+- lib/hanvon/version.rb
+- spec/hanvon_crypto_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for Hanvon Time & Attendance Devices
+test_files:
+- spec/hanvon_crypto_spec.rb
+- spec/spec_helper.rb