hawk-auth 0.0.0

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 hawk-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2013 Apollic Software, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Apollic Software, LLC nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,96 @@
+# Hawk
+
+Ruby implementation of [Hawk HTTP authentication scheme](https://github.com/hueniverse/hawk).
+
+**Authorization Request Header**
+
+```
+Authorization: Hawk id="{credentials id}", ts="{epoch timestamp}", nonce="{nonce}", hash="{hash}", ext="{ext}", mac="{mac}", app="{application id}", d1g="{d1g}"
+```
+
+`hash`, `ext`, `app`, and `d1g` should only be included if used in mac function.
+
+**Authorization Response Header**
+
+```
+Server-Authorization: Hawk mac="{mac}", hash="{hash}", ext="{ext}"
+```
+
+`mac` is constructed using the same params as in the request with the exception of `hash` and `ext` which are replaced with new values.
+
+`hash` and `ext` are both optional.
+
+**MAC Function**
+
+```
+base-64(
+  hmac-{algorithm (e.g. sha-256)}(
+    hawk.{hawk version}.{type}
+    {epoch timestamp}
+    {nonce}
+    {uppercase request method}
+    {lowercase request path}
+    {lowercase request host}
+    {request port}
+    {hash (see below) or empty line}
+    {ext (optional)}
+    {application id (optional)}
+    {application id digest (requires application id)}
+  )
+)
+```
+
+**Payload Hash Function**
+
+```
+base-64(
+  digest-{algorithm (e.g. sha-256)}(
+    hawk.#{hawk version}.payload
+    {plain content-type (e.g. application/json)}
+    {request payload or empty line}
+  )
+)
+```
+
+**Bewit MAC Function**
+
+```
+base-64(
+  {credentials id} + \ + {expiry epoch timestamp} + \ + hmac-{algorithm (e.g. sha-256)}(
+    hawk.{hawk version}.bewit
+    {epoch timestamp}
+    {nonce}
+    {uppercase request method}
+    {lowercase request path}
+    {lowercase request host}
+    {request port}
+    {ext (optional)}
+  ) + \ + {ext or empty}
+)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hawk-auth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hawk-auth
+
+## Usage
+
+TODO: write usage instructions
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/hawk-auth.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hawk/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hawk-auth"
+  gem.version       = Hawk::VERSION
+  gem.authors       = ["Jesse Stuart"]
+  gem.email         = ["jesse@jessestuart.ca"]
+  gem.description   = "Ruby implementation of Hawk"
+  gem.summary       = "Ruby implementation of Hawk"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+end

data/lib/hawk.rb

@@ -0,0 +1,6 @@
+require 'hawk/version'
+
+module Hawk
+  NotImplementedError = Class.new(StandardError)
+  raise NotImplementedError.new("This implementation of hawk is currently empty!")
+end

data/lib/hawk/version.rb

@@ -0,0 +1,3 @@
+module Hawk
+  VERSION = "0.0.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: hawk-auth
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jesse Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby implementation of Hawk
+email:
+- jesse@jessestuart.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hawk-auth.gemspec
+- lib/hawk.rb
+- lib/hawk/version.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.23
+signing_key: 
+specification_version: 3
+summary: Ruby implementation of Hawk
+test_files: []