authorization_header_parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0d2bce662c12e178c65f990a14c46707b764e1d
+  data.tar.gz: 0e21e001e47900e9f848bcdc5fc0d4cbb3a71f27
+SHA512:
+  metadata.gz: 222f8060cd448acf936f047d249808fe23620fbf8d01bd4b0107e71d1a006bb5831a4e86a70076fd2c72e54560eac2d318f3cc95452f8a91cc42001fa34fea46
+  data.tar.gz: 834ddcfd2bb39c40ad8cb213a06b537aa3c5914376e0e46b8b6ca70201f29431dda174a1e92ee60c7b67097346f75e94ba5871f2facf451713eadfa8677742e7

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 3"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Julik Tarkhanov
+
+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,32 @@
+# authorization_header_parser
+
+Parse custom authorization parameters from `Authorization:` HTTP headers into a neat
+Ruby Hash. Works best in combination with `Rack::Auth::AbstractRequest`
+
+For instance, with a custom `Authorization` header of `my-scheme token="12345"`
+
+    auth = Rack::Auth::AbstractRequest.new(env)
+    params = AuthorizationHeaderParser.parse_params(auth.params) #=> {'token' => '12345}
+
+or for both scheme and params:
+
+    scheme, params = AuthorizationHeaderParser.parse(env['HTTP_AUTHORIZATION])
+    # => ['my-scheme', {'token' => '12345}]
+
+Works well for token, Digest, OAuth and other schemes using custom authorization parameters.
+
+## Contributing to authorization_header_parser
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require_relative 'lib/authorization_header_parser'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.version = AuthorizationHeaderParser::VERSION
+  gem.name = "authorization_header_parser"
+  gem.homepage = "http://github.com/julik/authorization_header_parser"
+  gem.license = "MIT"
+  gem.description = %Q{Parses parametrized  HTTP Authorization headers}
+  gem.summary = %Q{such as OAuth and Digest}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "authorization_header_parser #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/authorization_header_parser.rb

@@ -0,0 +1,79 @@
+require 'strscan'
+
+
+module AuthorizationHeaderParser
+  VERSION = '1.0.0'
+  InvalidHeader = Class.new(StandardError)
+  
+  # Parse a custom scheme + params Authorization header.
+  #
+  #   parse('absurd-auth token="12345"') #=> ['absurd-auth', {'token' => '12345}]
+  def parse(value)
+    scanner = StringScanner.new(value)
+    scheme = scanner.scan(NON_WHITESPACE)
+    raise InvalidHeader.new("Scheme not provided") unless scheme
+    scanner.skip(WHITESPACE)
+    
+    [scheme.strip, extract_params_from_scanner(scanner)]
+  end
+  
+  # Parse Authorization params. Most useful in combination with Rack::Auth::AbstractRequest
+  #
+  # For instance, with 'Authorization: absurd-auth token="12345"':
+  #
+  #   auth = Rack::Auth::AbstractRequest.new(env)
+  #   params = parse(auth.params) #=> {'token' => '12345}
+  def parse_params(string)
+    extract_params_from_scanner(StringScanner.new(string))
+  end
+  
+  extend self
+  
+  private
+  
+  ANYTHING_BUT_EQ = /[^\s\=]+/
+  EQ = /=/
+  UNTIL_FWD_SLASH_OR_QUOTE = /[^\\"]+/
+  ESCAPED_QUOTE = /\\"/
+  QUOTE = /"/
+  WHITESPACE = /\s+/
+  COMMA = /,/
+  NON_WHITESPACE = /[^\s]+/
+  
+  # http://codereview.stackexchange.com/questions/41270
+  # http://stackoverflow.com/questions/134936
+  def extract_params_from_scanner(scanner)
+    params = {}
+    until scanner.eos? do
+      key = scanner.scan(ANYTHING_BUT_EQ)
+      raise InvalidHeader, "Expected =, but found none at #{scanner.pos}" unless scanner.scan(EQ)
+      value_opener = scanner.get_byte
+      raise InvalidHeader, "Expected opening of a parameter at #{scanner.pos}" unless value_opener
+      if value_opener == '"' # Quoted value
+        buf = ''
+        until scanner.eos?
+          if scanner.scan(UNTIL_FWD_SLASH_OR_QUOTE)
+            buf << scanner.matched
+          elsif scanner.scan(ESCAPED_QUOTE)
+            buf << '"'
+          elsif scanner.scan(QUOTE)
+            params[key] = buf
+            break
+          end
+        end
+      else
+        scanner.unscan # Bare parameter, backtrack 1 byte
+        unless bare_value = scanner.scan(/[^,"]+/)
+          raise InvalidHeader, "Expected a bare parameter value at #{scanner.pos}"
+        end
+        params[key] = bare_value
+      end
+      scanner.skip(WHITESPACE)
+      if !scanner.eos? && !scanner.skip(COMMA)
+        raise InvalidHeader, "Expected end of header or a comma, at #{scanner.pos}"
+      end
+      scanner.skip(WHITESPACE)
+    end
+    params
+  end
+end

data/spec/authorization_header_parser_spec.rb

@@ -0,0 +1,113 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AuthorizationHeaderParser" do
+  context '.parse_params' do
+    it 'parses only the parameter string' do
+      params = AuthorizationHeaderParser.parse_params('foo=bar, baz=bad')
+      expect(params).to eq({"foo"=>"bar", "baz"=>"bad"})
+    end
+  end
+  
+  context '.parse' do
+    it 'parses a simple Token header' do
+      header = 'Token foo=bar, baz=bad'
+      parsed = AuthorizationHeaderParser.parse(header)
+      scheme, params = parsed
+      expect(scheme).to eq('Token')
+      expect(params).to eq({"foo"=>"bar", "baz"=>"bad"})
+    end
+    
+    it 'parses a header with an escaped quote' do
+      digest_header = 'Custom param="value\"such and such\""' 
+      parsed = AuthorizationHeaderParser.parse(digest_header)
+      scheme, params = parsed
+      expect(scheme).to eq('Custom')
+      expect(params).to eq({"param" => 'value"such and such"'})
+    end
+    
+    it "parses a Digest header" do
+      digest_header = 'Digest qop="chap",
+        realm="testrealm@host.com",
+        username="Foobear",
+        response="6629fae49393a05397450978507c4ef1",
+        cnonce="5ccc069c403ebaf9f0171e9517f40e41"'
+     
+      parsed = AuthorizationHeaderParser.parse(digest_header)
+      scheme, params = parsed
+      expect(scheme).to eq('Digest')
+      expect(params).to eq({
+        "qop"=>"chap",
+        "realm"=>"testrealm@host.com",
+        "username"=>"Foobear",
+        "response"=>"6629fae49393a05397450978507c4ef1",
+        "cnonce"=>"5ccc069c403ebaf9f0171e9517f40e41"
+      })
+    end
+    
+    it 'parses an OAuth header from Twitter documentation' do
+      twitter_header = 'OAuth oauth_consumer_key="xvz1evFS4wEEPTGEFPHBog", 
+              oauth_nonce="kYjzVBB8Y0ZFabxSWbWovY3uYSQ2pTgmZeNu2VS4cg", 
+              oauth_signature="tnnArxj06cWHq44gCs1OSKk%2FjLY%3D", 
+              oauth_signature_method="HMAC-SHA1", 
+              oauth_timestamp="1318622958", 
+              oauth_token="370773112-GmHxMAgYyLbNEtIKZeRNFsMKPR9EyMZeS9weJAEb", 
+              oauth_version="1.0"'
+      parsed = AuthorizationHeaderParser.parse(twitter_header)
+      scheme, params = parsed
+      expect(scheme).to eq("OAuth")
+      expect(params).to eq({
+        "oauth_consumer_key"=>"xvz1evFS4wEEPTGEFPHBog",
+        "oauth_nonce"=>"kYjzVBB8Y0ZFabxSWbWovY3uYSQ2pTgmZeNu2VS4cg",
+        "oauth_signature"=>"tnnArxj06cWHq44gCs1OSKk%2FjLY%3D",
+        "oauth_signature_method"=>"HMAC-SHA1",
+        "oauth_timestamp"=>"1318622958",
+        "oauth_token"=>"370773112-GmHxMAgYyLbNEtIKZeRNFsMKPR9EyMZeS9weJAEb",
+        "oauth_version"=>"1.0"
+      })
+    end
+    
+    it 'parses another OAuth params example' do
+      oauth_header = 'OAuth realm="",
+          oauth_nonce="72250409",
+          oauth_timestamp="1294966759",
+          oauth_consumer_key="Dummy",
+          oauth_signature_method="HMAC-SHA1",
+          oauth_version="1.0",
+          oauth_signature="IBlWhOm3PuDwaSdxE/Qu4RKPtVE="'
+    
+      parsed = AuthorizationHeaderParser.parse(oauth_header)
+      scheme, params = parsed
+      expect(scheme).to eq("OAuth")
+      expect(params).to eq({
+        "realm"=>"", 
+        "oauth_nonce" => "72250409", 
+        "oauth_timestamp"=>"1294966759",
+        "oauth_consumer_key"=>"Dummy",
+        "oauth_signature_method"=>"HMAC-SHA1",
+        "oauth_version"=>"1.0",
+        "oauth_signature"=>"IBlWhOm3PuDwaSdxE/Qu4RKPtVE="
+      })
+    end
+  end
+  
+  context 'with invalid headers' do
+    it 'raises InvalidHeader' do
+      expect {
+        AuthorizationHeaderParser.parse_params('foo=')
+      }.to raise_error(AuthorizationHeaderParser::InvalidHeader, /Expected opening of a parameter/)
+    
+      expect {
+        AuthorizationHeaderParser.parse_params('foo=bar"')
+      }.to raise_error(AuthorizationHeaderParser::InvalidHeader, /Expected end of header or a comma/)
+      
+      expect {
+        AuthorizationHeaderParser.parse_params('FONDBSJDJAHJDHAHUYHJHJBDA')
+      }.to raise_error(AuthorizationHeaderParser::InvalidHeader, /Expected =, but found none/)
+      
+      expect {
+        AuthorizationHeaderParser.parse_params('foo="bar"baz"bad" another=123')
+      }.to raise_error(AuthorizationHeaderParser::InvalidHeader, /Expected end of header or a comma/)
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'authorization_header_parser'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: authorization_header_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Parses parametrized  HTTP Authorization headers
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/authorization_header_parser.rb
+- spec/authorization_header_parser_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/julik/authorization_header_parser
+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.2
+signing_key: 
+specification_version: 4
+summary: such as OAuth and Digest
+test_files: []