shmac 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 134e0f7871345b0f56699849f2fcbb27da1b33b6
+  data.tar.gz: 3fa782727eea6bdcd2b7a5dea3ea0de352add1e5
+SHA512:
+  metadata.gz: fe1a5876c513ac6d943be35ad2ff21b8c4280a02f3b9c769d9cb422c5fc8efa0b348a70c1754324385f2fcbfc65f960d7174c8e71479c43ef0aafa2e275388e4
+  data.tar.gz: 436a767db4e95c9594a6f18ded0a9e489ed422f808e4f1a1c6b19afec603a537fb6f00b77e029c574d8717ed52c17e6dc6b3bf1e3722745023085d5acc82347a

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.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at joel.junstrom@oktavilla.se. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joel Junström
+
+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,35 @@
+# Shmac
+
+Simple HMAC authentication in a semi-usable state.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shmac'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shmac
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/oktavilla/shmac. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "shmac"
+
+# 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/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shmac.rb

@@ -0,0 +1,22 @@
+require "shmac/version"
+require "shmac/authentication"
+require "shmac/request_adapters"
+
+module Shmac
+  def self.rails secret, request, namespace: nil
+    authentication(secret, request, namespace: namespace, request_adapter: RequestAdapters::Rails)
+  end
+
+  def self.net_http secret, request, namespace: nil
+    authentication(secret, request, namespace: namespace, request_adapter: RequestAdapters::NetHttp)
+  end
+
+  def self.authentication secret, request, namespace: nil, request_adapter: nil
+    Authentication.new(
+      secret,
+      request,
+      header_namespace: namespace,
+      request_adapter: request_adapter
+    )
+  end
+end

data/lib/shmac/authentication.rb

@@ -0,0 +1,55 @@
+require "shmac/signature_calculator"
+require "shmac/authorization_header"
+
+module Shmac
+  class Authentication
+    include Comparable
+
+    attr_reader :secret, :header_namespace
+
+    def self.generate_authorization_header request, secret:, access_key:, organization:, header_namespace: nil
+      AuthorizationHeader.generate(
+        organization: organization,
+        access_key: access_key,
+        signature: self.generate_signature(request, secret: secret, header_namespace: header_namespace)
+      ).to_s
+    end
+
+    def self.generate_signature request, secret:, header_namespace: nil
+      new(secret, request, header_namespace: header_namespace).signature
+    end
+
+    def initialize secret, request, header_namespace: nil, request_adapter: nil
+      @secret = secret
+      @request = request
+      @request_adapter = request_adapter
+      @header_namespace = header_namespace
+    end
+
+    def == other
+      other.is_a?(self.class) && self.signature == other.signature
+    end
+
+    def signature
+      SignatureCalculator.new(
+        secret: self.secret,
+        request: self.request,
+        header_namespace: self.header_namespace
+      ).to_s
+    end
+
+    def authentic?
+      return false if request.authorization.to_s.strip.empty?
+
+      AuthorizationHeader.new(request.authorization).signature == self.signature
+    end
+
+    def request
+      request_adapter.call @request
+    end
+
+    def request_adapter
+      @request_adapter ||= ->(r) { r }
+    end
+  end
+end

data/lib/shmac/authorization_header.rb

@@ -0,0 +1,48 @@
+module Shmac
+  class AuthorizationHeader
+    include Comparable
+    class FormatError < StandardError; end
+
+    AUTH_HEADER_PATTERN = /(.+) (.+):(.+)$/
+
+    attr_reader :parts
+
+    def self.generate organization:, access_key:, signature:
+      new("%s %s:%s" % [organization, access_key, signature])
+    end
+
+    def initialize value
+      @value = value
+      self.parts = value
+    end
+
+    def == other
+      other.is_a?(self.class) && self.to_s == other.to_s
+    end
+
+    def to_s
+      @value
+    end
+
+    def parts= value
+      matches = AUTH_HEADER_PATTERN.match(value)
+      unless matches
+        raise FormatError.new("#{value} does not match the expected authorization signature")
+      end
+
+      @parts = matches
+    end
+
+    def organization
+      parts[1]
+    end
+
+    def access_key_id
+      parts[2]
+    end
+
+    def signature
+      parts[3]
+    end
+  end
+end

data/lib/shmac/normalized_http_headers.rb

@@ -0,0 +1,33 @@
+module Shmac
+  class NormalizedHttpHeaders
+    def self.from_request_headers request_headers
+      new(
+        Hash[
+          request_headers.to_h.find_all { |(k, _)|
+            k.upcase.start_with?("HTTP_")
+          }
+        ]
+      )
+    end
+
+    attr_reader :headers
+
+    def initialize http_headers
+      self.headers = http_headers
+    end
+
+    def to_h
+      headers
+    end
+
+    def headers= http_headers
+      @headers = http_headers.each_with_object({}) { |(k,v), memo|
+        memo[normalize_key(k)] = Array(v).join(",")
+      }
+    end
+
+    def normalize_key key
+      key.to_s.downcase.tr("_", "-").gsub(/\Ahttp-/, "")
+    end
+  end
+end

data/lib/shmac/request.rb

@@ -0,0 +1,41 @@
+require "shmac/normalized_http_headers"
+
+module Shmac
+  class Request
+    attr_reader :path, :method, :headers, :body, :content_type
+
+    def initialize path:, method:, headers:, body: nil, content_type: nil
+      @path = path
+      @method = method
+      self.headers = headers
+      @body = body
+      @content_type = content_type
+    end
+
+    # Prefer the value of a namespaced date key if present
+    def date namespace = nil
+      date_key = [namespace, "date"].compact.join("-").downcase
+
+      headers.fetch(date_key) { headers["date"] }
+    end
+
+    def content_md5
+      # Fallback to x-content-md5 for clients that have issues with standard headers
+      headers.fetch("content-md5") { headers["x-content-md5"] }
+    end
+
+    def authorization
+      # Test for x-authorization for clients that have issues with standard headers
+      headers.fetch("x-authorization") { headers["authorization"] }
+    end
+
+    def headers= headers
+      @headers = NormalizedHttpHeaders.new(headers).to_h
+    end
+
+    def api_version
+      headers.fetch("x-authorization-version", 0).to_i
+    end
+  end
+
+end

data/lib/shmac/request_adapters.rb

@@ -0,0 +1,26 @@
+require "shmac/request"
+require "shmac/normalized_http_headers"
+
+module Shmac
+  module RequestAdapters
+    Rails = ->(rails_request) {
+      Request.new(
+        path: rails_request.fullpath,
+        method: rails_request.request_method.to_s.upcase,
+        headers: Shmac::NormalizedHttpHeaders.from_request_headers(rails_request.headers).to_h,
+        body: rails_request.raw_post,
+        content_type: rails_request.content_type
+      )
+    }
+
+    NetHttp = ->(net_http_request) {
+      Request.new(
+        path: net_http_request.uri.path,
+        method: net_http_request.method.to_s.upcase,
+        headers: NormalizedHttpHeaders.new(net_http_request.to_hash).to_h,
+        body: net_http_request.body,
+        content_type: net_http_request.content_type
+      )
+    }
+  end
+end

data/lib/shmac/signature_calculator.rb

@@ -0,0 +1,59 @@
+require "openssl"
+require "base64"
+
+module Shmac
+  class SignatureCalculator
+    attr_reader :secret, :request, :header_namespace
+
+    def initialize secret:, request:, header_namespace: nil
+      @secret = secret
+      @request = request
+      @header_namespace = header_namespace.downcase if header_namespace
+    end
+
+    def to_s
+      signature
+    end
+
+    def signature
+      digest = OpenSSL::Digest.new "sha1"
+      hmac = OpenSSL::HMAC.digest digest, secret, string_to_sign
+      Base64.strict_encode64 hmac
+    end
+
+    def string_to_sign
+      parts = [
+        request.method,
+        request.content_md5,
+        request.content_type,
+        request.date(self.header_namespace)
+      ]
+
+      platform_headers = canonicalized_platform_headers.to_s.strip
+      parts << platform_headers unless platform_headers.empty?
+
+      # The path is expected by spec but the DPO sends the same message (including headers) to several endpoints
+      # We introduce an api version so we do not lose messages
+      parts << request.path unless request.api_version > 0
+
+      parts.join("\n")
+    end
+
+    def canonicalized_platform_headers
+      return unless self.header_namespace
+
+      normalize_key = -> (key) { key.to_s.downcase.strip }
+      normalize_value = -> (value) { value.to_s.strip }
+      canonicalized_header_row = -> (k,v) {
+        "%s:%s" % [normalize_key.(k), normalize_value.(v)]
+      }
+      matches_namespace = ->(value) { value.start_with?(header_namespace) }
+
+      self.request.headers
+        .map(&canonicalized_header_row)
+        .find_all(&matches_namespace)
+        .sort
+        .join("\n")
+    end
+  end
+end

data/lib/shmac/version.rb

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

data/shmac.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shmac/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shmac"
+  spec.version       = Shmac::VERSION
+  spec.authors       = ["Joel Junström"]
+  spec.email         = ["joel.junstrom@oktavilla.se"]
+
+  spec.summary       = %q{Authenticates api requests using HMAC}
+  spec.homepage      = "https://github.com/Oktavilla/shmac"
+  spec.license       = "MIT"
+
+  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 "timecop"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: shmac
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Junström
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-31 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: timecop
+  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: 
+email:
+- joel.junstrom@oktavilla.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/shmac.rb
+- lib/shmac/authentication.rb
+- lib/shmac/authorization_header.rb
+- lib/shmac/normalized_http_headers.rb
+- lib/shmac/request.rb
+- lib/shmac/request_adapters.rb
+- lib/shmac/signature_calculator.rb
+- lib/shmac/version.rb
+- shmac.gemspec
+homepage: https://github.com/Oktavilla/shmac
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Authenticates api requests using HMAC
+test_files: []