onnistuu_fi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d8c750ed0ddbe0401d908a47a5dc306b1ee07b5
+  data.tar.gz: bb7a70479ed65d1c3a98ee28062275dbb0dc27ec
+SHA512:
+  metadata.gz: 76377b3df828ce8b4affe483d69158c0fa7759b3beba5afeb0ea09e7a4791803d67b5d1d7e3c1cc13cb30c1ae4d476cbfd28f0722eae3c3f81009e369a2bd9f4
+  data.tar.gz: 2d63342c6558ed73b7707f90db5480cc2ac978ee5db1728c85a33da06be2f1926551ef3ee30f6cc0a2f7636d8d856c5b91e917b859b666855e3ab26928912a3a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,83 @@
+# OnnistuuFi
+
+This gem implements Onnistuu.fi API version 0.20.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'onnistuu_fi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onnistuu_fi
+
+## Dependencies
+
+Mcrypt needs to be installed for the library to work.
+
+## Usage
+
+### Generating the form
+
+```ruby
+# Outputs the form HTML
+
+OnnistuuFi.generate_form(
+  client_identifier: ENV["ONNISTUU_FI_CLIENT_ID"],
+  encryption_key: ENV["ONNISTUU_FI_ENCRYPTION_KEY"],
+  fields: {
+    return_failure: "https://example.com/failure",
+    return_success: "https://example.com/success",
+    document: "https://example.com/document.pdf",
+    button_text: "Sign the document",
+    requirements: [
+      {"type": "person", "identifier": "110761-635Y"}
+    ]
+  }
+)
+```
+
+If you want to customize the button & other form content, pass a block to `generate_form`:
+
+```ruby
+OnnistuuFi.generate_form(options) {
+  "<button type="submit">Sign document</button>"
+}
+```
+
+### Processing the response
+
+```ruby
+
+# Returns the data from Onnistuu.fi or raises OnnistuuFi::DecodeError
+
+OnnistuuFi.decode_response(
+  client_identifier: ENV["ONNISTUU_FI_CLIENT_ID"],
+  encryption_key: ENV["ONNISTUU_FI_ENCRYPTION_KEY"],
+  encrypted_data: params[:data],
+  iv: params[:iv])
+}
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## TODO
+
+- A class for verifying a document
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kiskolabs/onnistuu_fi.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "onnistuu_fi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+brew install mcrypt

data/lib/onnistuu_fi/form.rb

@@ -0,0 +1,48 @@
+module OnnistuuFi
+  class Form
+    attr_reader :options
+
+    def initialize(signer, options = {})
+      @signer = signer
+      @options = options
+
+      data = {
+        stamp: @options.delete(:stamp) || Time.now,
+        return_success: @options.delete(:return_success),
+        document: @options.delete(:document),
+        requirements: @options.delete(:requirements)
+      }
+      iv, signed_data = signer.encrypt(data)
+
+      options[:iv] = iv
+      options[:data] = signed_data
+      validate_options!
+    end
+
+    def generate_html
+      "<form action='#{API_ENDPOINT}' method='post'>
+        #{fields.compact.join("\n")}
+        <input type='hidden' name='padding' value='pkcs5' />
+        #{@options[:button]}
+      </form>"
+    end
+
+    private
+
+    def validate_options!
+      # TODO
+    end
+
+    def fields
+      [:customer, :return_failure, :return_success, :data, :iv].map {|field_name|
+        if options[field_name]
+          hidden_field(field_name, options[field_name])
+        end
+      }
+    end
+
+    def hidden_field(name, value)
+      "<input type='hidden' name='#{name.to_s}' value='#{value.to_s}' />"
+    end
+  end
+end

data/lib/onnistuu_fi/response.rb

@@ -0,0 +1,17 @@
+require "json"
+
+module OnnistuuFi
+  class Response
+    attr_reader :signer
+
+    def initialize(encrypted, iv, signer)
+      @encrypted = encrypted
+      @iv = iv
+      @signer = signer
+    end
+
+    def data
+      signer.decrypt(@encrypted, @iv)
+    end
+  end
+end

data/lib/onnistuu_fi/signer.rb

@@ -0,0 +1,31 @@
+require "mcrypt"
+require "base64"
+require "openssl"
+
+module OnnistuuFi
+  class Signer
+    def initialize(client_identifier, encryption_key)
+      @client_identifier = client_identifier
+      @encryption_key = Base64.decode64(encryption_key)
+    end
+
+    # Returns [base64_iv, base64_encrypted_data]
+    def encrypt(data)
+      iv = OpenSSL::Cipher::Cipher.new("AES-256-CBC").random_iv.unpack("H*").first
+      mcrypt = Mcrypt.new(:rijndael_256, :cbc, @encryption_key, iv, :pkcs)
+
+      [Base64.encode64(iv), Base64.encode64(mcrypt.encrypt(JSON.dump(data)))]
+    end
+
+    # Parameters:
+    # - encrypted data in base64
+    # - iv in base64
+    #
+    # Returns decrypted data
+    def decrypt(encrypted, iv)
+      mcrypt = Mcrypt.new(:rijndael_256, :cbc, @encryption_key, Base64.decode64(iv), :pkcs)
+
+      JSON.load(mcrypt.decrypt(Base64.decode64(encrypted)))
+    end
+  end
+end

data/lib/onnistuu_fi/version.rb

@@ -0,0 +1,3 @@
+module OnnistuuFi
+  VERSION = "0.1.0"
+end

data/lib/onnistuu_fi.rb

@@ -0,0 +1,34 @@
+require "onnistuu_fi/version"
+require "onnistuu_fi/signer"
+require "onnistuu_fi/form"
+require "onnistuu_fi/response"
+
+module OnnistuuFi
+  API_ENDPOINT = "https://www.onnistuu.fi/external/entry/"
+
+  def self.generate_form(options = {})
+    @client_identifier = options.fetch(:client_identifier) { raise(ArgumentError, "missing client_identifier from the passed arguments") }
+    @encryption_key = options.fetch(:encryption_key) { raise(ArgumentError, "missing encryption_key from the passed arguments") }
+
+    signer = OnnistuuFi::Signer.new(@client_identifier, @encryption_key)
+    fields = options.fetch(:fields)
+    fields = fields.merge(customer: @client_identifier)
+
+    if block_given?
+      fields[:button] = yield
+    else
+      fields[:button] = "<button type='submit'>#{fields.fetch(:button_text, 'Sign')}</button>"
+    end
+
+    OnnistuuFi::Form.new(signer, fields).generate_html
+  end
+
+  def self.decode_response(options = {})
+    @client_identifier = options.fetch(:client_identifier) { raise(ArgumentError, "missing client_identifier from the passed arguments") }
+    @encryption_key = options.fetch(:encryption_key) { raise(ArgumentError, "missing encryption_key from the passed arguments") }
+
+    signer = OnnistuuFi::Signer.new(@client_identifier, @encryption_key)
+
+    OnnistuuFi::Response.new(options.fetch(:encrypted_data), options.fetch(:iv), signer).data
+  end
+end

data/onnistuu_fi.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onnistuu_fi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "onnistuu_fi"
+  spec.version       = OnnistuuFi::VERSION
+  spec.authors       = ["Vesa Vänskä"]
+  spec.email         = ["vesa@vesavanska.com"]
+
+  spec.summary       = %q{Implements Onnistuu.fi interface.}
+  spec.description   = %q{Implements Onnistuu.fi interface}
+  spec.homepage      = "https://github.com/kiskolabs/onnistuu_fi"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-html-matchers", "~> 0.8.0"
+  spec.add_development_dependency "byebug"
+  spec.add_dependency "aes", "~> 0.5.0"
+  spec.add_dependency "ruby-mcrypt", "~> 0.2.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: onnistuu_fi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vesa Vänskä
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: aes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: ruby-mcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Implements Onnistuu.fi interface
+email:
+- vesa@vesavanska.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/onnistuu_fi.rb
+- lib/onnistuu_fi/form.rb
+- lib/onnistuu_fi/response.rb
+- lib/onnistuu_fi/signer.rb
+- lib/onnistuu_fi/version.rb
+- onnistuu_fi.gemspec
+homepage: https://github.com/kiskolabs/onnistuu_fi
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Implements Onnistuu.fi interface.
+test_files: []