oauth2_hmac_header 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c0980088ef79e386fc8ecdbdc025a3f42ae7565
+  data.tar.gz: 4713caca9228e9f7e3ae6426fcb79fd9a6399ad2
+SHA512:
+  metadata.gz: 4686124cb405572f62bd19c65915f0ff7a6aad12aaac044fee56db4c5cb221177edfe890abe345d8f2ecfced517a43575bc759d9ed5fd0b2bb0902e20c9b00e9
+  data.tar.gz: 78c97dc71f17ced4d07da355b1bfd9070a45f1dd0e5821a22584abbf068fecab86f9a8992e296cd85f888198778f5e78d15bd37da7940a0a77563d45651602d7

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,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 1.9.3

data/Gemfile

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

data/README.md

@@ -0,0 +1,119 @@
+# Oauth2HmacHeader
+
+[![Build Status](https://travis-ci.org/mustafaturan/oauth2_hmac_header.png)](https://travis-ci.org/mustafaturan/oauth2_hmac_header) [![Code Climate](https://codeclimate.com/github/mustafaturan/oauth2_hmac_header.png)](https://codeclimate.com/github/mustafaturan/oauth2_hmac_header)
+
+Simple generator, parser and validator for Oauth v2 HTTP message authentication code(MAC) header. It simply generates, parse and verify signatures for Oauth v2 HTTP MAC authentication for 'SHA1' and 'SHA256' algorithms. Please visit https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01 for spec specifications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oauth2_hmac_header'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oauth2_hmac_header
+
+## Usage
+
+### Generating from request vars
+```ruby
+    
+    @client_id = 'client1'
+    @algorithm = 'hmac-sha-256''hmac-sha-256' # 'hmac-sha-1' or 'hmac-sha-256'
+    @key = 'demo_key' # key for client1
+    @method = 'post' # get, post, put, head, patch, etc...
+    @uri = '/request?b5=%3D%253D&a3=a&c%40=&a2=r%20b&c2&a3=2+q' # path for req
+    @host = 'example.com' # hostname for the request
+    @port = 443 # port number for the request
+    @ext = 'a,b,c' # optional str, can be nil
+    @header = Oauth2HmacHeader::AuthorizationHeader.generate_with_new_signature(
+      @client_id, @algorithm, @key, @method, @uri, @host, @port, @ext
+    )
+    
+    # returns header
+    # "MAC id=\"client1\", ts=\"1438532302\", nonce=\"1438532302:12c8e929\", ext=\"a,b,c\", mac=\"F4nIHqhQZp1o2I61Zy9bSZFYfohf9gmdG0XnOIMAHV4=\""
+```
+
+### Generating with early signed signatures
+```ruby
+    
+    @client_id = 'client1'
+    @algorithm = 'hmac-sha-256' # 'hmac-sha-1' or 'hmac-sha-256'
+    @key = 'demo_key' # key for client1
+    @method = 'post' # get, post, put, head, patch, etc...
+    @uri = '/request?b5=%3D%253D&a3=a&c%40=&a2=r%20b&c2&a3=2+q' # path for req
+    @host = 'example.com' # hostname for the request
+    @port = 443 # port number for the request
+    @ext = 'a,b,c' # optional str, can be nil
+    @ts, @nonce, @ext, @mac  = Oauth2HmacSign::Signature.generate(
+      @algorithm, @key, @method, @uri, @host, @port, @ext
+    )
+    @header = Oauth2HmacHeader::AuthorizationHeader.generate(
+      @client_id, @ts, @nonce, @ext, @mac
+    )
+    
+    # returns header
+    # "MAC id=\"client1\", ts=\"1438530720\", nonce=\"1438530720:ab4412bd\", ext=\"a,b,c\", mac=\"Sav0I-p1rAU29TlISoznME5xeOzJIPZEvG26ni_APNE=\""
+```
+
+### Parsing
+```ruby
+    
+    @header = "MAC id=\"client1\", ts=\"1438530720\", nonce=\"1438530720:ab4412bd\", ext=\"a,b,c\", mac=\"Sav0I-p1rAU29TlISoznME5xeOzJIPZEvG26ni_APNE=\""
+    @client_id, @ts, @nonce, @ext, @mac = Oauth2HmacHeader::AuthorizationHeader.parse(@header)
+
+    # returns authorization vars
+    # client_id
+    # ts
+    # nonce
+    # mac
+```
+
+### Verify
+```ruby
+    
+    # Assuming that we know the variables below from the incoming HTTP request
+    @method = 'post' # get, post, put, head, patch, etc...
+    @uri = '/request?b5=%3D%253D&a3=a&c%40=&a2=r%20b&c2&a3=2+q' # path for req
+    @host = 'example.com' # hostname for the request
+    @port = 443 # port number for the request
+    
+    # lets parse auth vars from header
+    @header = "MAC id=\"client1\", ts=\"1438530720\", nonce=\"1438530720:ab4412bd\", ext=\"a,b,c\", mac=\"Sav0I-p1rAU29TlISoznME5xeOzJIPZEvG26ni_APNE=\""
+    @client_id, @ts, @nonce, @ext, @mac = Oauth2HmacHeader::AuthorizationHeader.parse(@header)
+    
+    # now we know 'client1' is the requester from parsed header and so we have the key and algorithm for 'client1' which is 'demo_key' and 'hmac-sha-256'
+    @key = 'demo_key'
+    @algorithm = 'hmac-sha-256'
+    
+    # let check if it is valid?
+    Oauth2HmacHeader::AuthorizationHeader.is_valid?(
+      @mac,
+      @algorithm,
+      @key,
+      @ts,
+      @nonce,
+      @method,
+      @uri,
+      @host,
+      @port,
+      @ext
+    )
+    
+    # if request is valid for client1 then expect to return true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/mustafaturan/oauth2_hmac_header/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Default Task"
+task :default => :spec
+
+# Make a console for testing purposes
+desc "Generate a test console"
+task :console do
+   verbose( false ) { sh "irb -I lib/ -r 'oauth2_hmac_header'" }
+end
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.rspec_opts = ['-c', '-r ./spec/spec_helper.rb']
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oauth2_hmac_header"
+
+# 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 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/oauth2_hmac_header.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/oauth2_hmac_header/version'
+require File.dirname(__FILE__) + '/oauth2_hmac_header/authorization_header'
+
+module Oauth2HmacHeader
+  # Your code goes here...
+end

data/lib/oauth2_hmac_header/authorization_header.rb

@@ -0,0 +1,124 @@
+require 'forwardable'
+require 'oauth2_hmac_sign'
+
+module Oauth2HmacHeader
+  # The "Authorization" Request Header
+  class AuthorizationHeader
+    extend SingleForwardable
+    def_delegator Oauth2HmacSign::Signature, :is_valid?
+
+    attr_reader :id, :ts, :nonce, :ext, :mac
+
+    class << self
+
+      # Generates oauth2 hmac authorization header
+      #
+      # == Parameters:
+      # id::
+      #   Client id for mac auth
+      # ts::
+      #   The timestamp value calculated for the request.
+      # nonce::
+      #   The nonce value generated for the request.
+      # ext:: 
+      #   The value of the "ext" "Authorization" request header field attribute
+      #   if one was included in the request, otherwise, an empty string.
+      # mac::
+      #   The signature
+      #
+      # == Returns:
+      #   Returns the generated header as string 
+      #
+      def generate(id, ts, nonce, ext, mac)
+        header = "MAC "
+        header << "id=\"#{id}\", "
+        header << "ts=\"#{ts}\", "
+        header << "nonce=\"#{nonce}\", "
+        header << "ext=\"#{ext}\", " if (!ext.nil? && !ext.empty?)
+        header << "mac=\"#{mac}\""
+        header
+      end
+
+      # Generates oauth2 hmac authorization header
+      #
+      # == Parameters:
+      # id::
+      #   Client id for mac auth
+      # algorithm::
+      #   Name of the algorithm valid vars are hmac-sha256, hmac-sha1
+      # key::
+      #   Key for hmac algorithm
+      # method::
+      #   The HTTP request method in upper case.  For example: "HEAD", "GET", "POST", etc.
+      # uri::
+      #   The HTTP request-URI as defined by https://tools.ietf.org/html/rfc2616#section-5.1.2
+      # host::
+      #   The hostname included in the HTTP request using the "Host" request header field in lower case.
+      # port::
+      #   The port as included in the HTTP request using the "Host" request
+      #   header field.  If the header field does not include a port, the
+      #   default value for the scheme MUST be used (e.g. 80 for HTTP and
+      #   443 for HTTPS).
+      # ext:: 
+      #   The value of the "ext" "Authorization" request header field
+      #   attribute if one was included in the request, otherwise, an empty
+      #   string.
+      #
+      # == Returns:
+      #   Returns the generated header as string 
+      #
+      def generate_with_new_signature(id, algorithm, key, method, uri, host, port, ext = '')
+        ts, nonce, ext, mac  = Oauth2HmacSign::Signature.generate(
+          algorithm, key, method, uri, host, port, ext
+        )
+        generate(id, ts, nonce, ext, mac)
+      end
+
+      # Parses oauth2 hmac header
+      #
+      # == Parameters:
+      # header::
+      #   Client id for mac auth
+      #
+      # == Returns:
+      #   Returns the generated header as string 
+      # id::
+      #   Client id for mac auth
+      # ts::
+      #   The timestamp value calculated for the request.
+      # nonce::
+      #   The nonce value generated for the request.
+      # ext:: 
+      #   The value of the "ext" "Authorization" request header field attribute
+      #   if one was included in the request, otherwise, an empty string.
+      # mac::
+      #   The signature
+      #
+      def parse(header)
+        pattern = Regexp.new "(id|ts|nonce|ext|mac)=(\"[^\"]+\")"
+        results = Hash[header.scan pattern]
+        validate_presence_of_keys_and_values(results, ['id', 'ts', 'nonce', 'mac'])
+        results = clean_quotes(results)
+        return results['id'], results['ts'], results['nonce'], results['ext'], results['mac']
+      end
+
+      private
+
+      # nodoc
+      def clean_quotes(items)
+        items.each {|item| item[1].gsub!('"', '') }
+        items
+      end
+
+      # nodoc
+      # Verify required keys existence
+      def validate_presence_of_keys_and_values(hash, keys)
+        keys.each do |key|
+          raise(KeyError, "#{key} is a MUST field for Oauth V2 HMAC Authorization header.") unless hash.has_key?(key)
+          next if !hash[key].nil? && !hash[key].empty?
+          raise(StandardError, "#{key} is a MUST field for Oauth V2 HMAC Authorization header and can not be blank!") unless hash.has_key?(key)
+        end
+      end
+    end
+  end
+end

data/lib/oauth2_hmac_header/version.rb

@@ -0,0 +1,3 @@
+module Oauth2HmacHeader
+  VERSION = '0.1.0'
+end

data/oauth2_hmac_header.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oauth2_hmac_header/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oauth2_hmac_header"
+  spec.version       = Oauth2HmacHeader::VERSION
+  spec.authors       = ["Mustafa TURAN"]
+  spec.email         = ["mustafaturan.net@gmail.com"]
+
+  spec.summary       = %q{Authorization header generator, parser and validator Oauth v2 HTTP MAC authentication.}
+  spec.description   = %q{Generate, parse and verify header information for oauth v2 http mac authentication.}
+  spec.homepage      = "https://github.com/mustafaturan/oauth2_hmac_header"
+
+  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_dependency "oauth2_hmac_sign"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: oauth2_hmac_header
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mustafa TURAN
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2_hmac_sign
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: Generate, parse and verify header information for oauth v2 http mac authentication.
+email:
+- mustafaturan.net@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oauth2_hmac_header.rb
+- lib/oauth2_hmac_header/authorization_header.rb
+- lib/oauth2_hmac_header/version.rb
+- oauth2_hmac_header.gemspec
+homepage: https://github.com/mustafaturan/oauth2_hmac_header
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Authorization header generator, parser and validator Oauth v2 HTTP MAC authentication.
+test_files: []