rack-simple_auth 1.0.0rc → 1.0.0

data/lib/rack/simple_auth.rb

@@ -12,7 +12,9 @@ module Rack
   # Module which Contains different Authorization / Authentication Classes (HMAC, ..)
   module SimpleAuth
     class << self
-      # Method to return Gem Root Dir
+      ##
+      # Method to return Gem Root Dir from everywhere in the gem
+      #
       # @return [String] Gem Root Folder
       def root
         ::File.dirname(::File.dirname(::File.expand_path('..', __FILE__)))

data/lib/rack/simple_auth/hmac/config.rb

@@ -1,30 +1,68 @@
 module Rack
   module SimpleAuth
     module HMAC
-      # class Config
+      ##
       # Config objects will be instantiated out of this class when using Rack::SimpleAuth::HMAC::Middleware
       # Also the public instance attributes / virtual attributes will be populated via the Middleware DSL
+      #
+      # @!attribute [w] tolerance
+      #  @return [Fixnum|Float]
+      #
+      # @!attribute [w] secret
+      #  @return [String]
+      #
+      # @!attribute [w] signature
+      #  @return [String]
+      #
+      # @!attribute [rw] logpath
+      #  @return [String]
+      #
+      # @!attribute [rw] request_config
+      #  @return [Hash]
+      #
+      # @!attribute [rw] verbose
+      #  @return [TrueClass|NilClass]
+      #
       class Config < Hash
-        attr_writer :tolerance, :stepsize
+        attr_writer :tolerance
         attr_writer :secret, :signature
+
+        attr_accessor :verbose
         attr_accessor :logpath, :request_config
 
+        ##
+        # Throw Runtime error for unknown attribute
+        #
+        # @param [Symbol] name
+        # @param [Array] args
+        #
         def method_missing(name, *args)
-          fail "Unkown option #{name.to_s.gsub!('=', '')}"
+          fail "Unknown option #{name.to_s.gsub!('=', '')}"
         end
 
+        ##
+        # Tolerance Attribute with nil guard
+        #
+        # @return [Fixnum] tolerance
+        #
         def tolerance
-          @tolerance || 1
-        end
-
-        def stepsize
-          @stepsize || 1
+          @tolerance || 1000
         end
 
+        ##
+        # Secret Attribute with nil guard
+        #
+        # @return [String] secret
+        #
         def secret
           @secret || ''
         end
 
+        ##
+        # Signature Attribute with nil guard
+        #
+        # @return [String] signature
+        #
         def signature
           @signature || ''
         end

data/lib/rack/simple_auth/hmac/middleware.rb

@@ -1,39 +1,43 @@
 module Rack
-  # Module which Contains different Authorization / Authentication Classes (HMAC, ..)
   module SimpleAuth
-    # module HMAC
     # Contains different classes for authorizing against a hmac signed request
     module HMAC
-      # class Middleware
-      # Middleware class which represents the interface to the rack api via Middleware#call
+      ##
+      # Middleware class which represents the interface to the rack api via {#call}
       # and checks if a request is hmac authorized.
       #
-      # Usage:
+      # @example Basic Usage
+      #   "request_config = {
+      #      'GET' => 'path',
+      #      'POST' => 'params',
+      #      'DELETE' => 'path',
+      #      'PUT' => 'path',
+      #      'PATCH' => 'path'
+      #    }
       #
-      # require 'rack/lobster'
-      # require 'rack/simple_auth'
+      #    use Rack::SimpleAuth::HMAC::Middleware do |options|
+      #      options.tolerance = 1500
       #
-      # request_config = {
-      #   'GET' => 'path',
-      #   'POST' => 'params',
-      #   'DELETE' => 'path',
-      #   'PUT' => 'path',
-      #   'PATCH' => 'path'
-      # }
+      #      options.secret = 'test_secret'
+      #      options.signature = 'test_signature'
       #
-      # use Rack::SimpleAuth::HMAC::Middleware do |options|
-      #   options.tolerance = 0.5
-      #   options.stepsize  = 0.01
+      #      options.logpath = "#{File.expand_path('..', __FILE__)}/logs"
+      #      options.request_config = request_config
       #
-      #   options.secret = 'test_secret'
-      #   options.signature = 'test_signature'
+      #      options.verbose = true
+      #    end
       #
-      #   options.logpath = "#{File.expand_path('..', __FILE__)}/logs"
-      #   options.request_config = request_config
-      # end
+      #    run Rack::Lobster.new"
       #
-      # run Rack::Lobster.new
       class Middleware
+        ##
+        # Throw NoMethodError and give hint if method who was called is Rack::SimpleAuth::Middleware.call
+        #
+        # @param [Symbol] name
+        # @param [Array] args
+        #
+        # @raise [NoMethodError] if the method isn't defined
+        #   and outputs additional hint for calling Rack::SimpleAuth::Middleware.call
         def self.method_missing(name, *args)
           msg = "Did you try to use HMAC Middleware as Rack Application via 'run'?\n" if name.eql?(:call)
           msg << "method: #{name}\n"
@@ -42,21 +46,27 @@ module Rack
 
           fail NoMethodError, msg
         end
+
+        ##
         # Constructor for Rack Middleware (passing the rack stack)
+        #
         # @param [Rack Application] app [next middleware or rack app which gets called]
-        # @param [Hash] config [config hash where tolerance, secret, signature etc.. are set]
+        # @param [Proc] block [the dsl block which will be yielded into the config object]
+        #
         def initialize(app, &block)
           @app, @config = app, Config.new
-          yield @config if block_given?
 
-          valid_stepsize?(0.01)
-          valid_tolerance?
+          yield @config if block_given?
         end
 
+        ##
         # call Method for Rack Middleware/Application
+        #
         # @param [Hash] env [Rack Env Hash which contains headers etc..]
+        #
         def call(env)
           @request = Rack::Request.new(env)
+          @allowed_messages = allowed_messages
 
           if valid_request?
             @app.call(env)
@@ -66,68 +76,95 @@ module Rack
           end
         end
 
-        # checks for valid HMAC Request
-        # @return [boolean] ValidationStatus [If authorized returns true, else false]
+        private
+
+        ##
+        # Checks for valid HMAC Request
+        #
+        # @return [TrueClass] if request is authorized
+        # @return [FalseClass] if request is not authorized or HTTP_AUTHORIZATION Header is not set
+        #
         def valid_request?
-          if @request.env['HTTP_AUTHORIZATION'].nil?
-            log
+          log
 
-            return false
-          end
+          return false if empty_header? || !authorized?
 
-          if request_signature == @config.signature && allowed_messages.include?(request_message)
-            true
-          else
-            log
+          true
+        end
 
-            false
-          end
+        ##
+        # Check if HTTP_AUTHORIZATION Header is set
+        #
+        # @return [TrueClass] if header is set
+        # @return [FalseClass] if header is not set
+        #
+        def empty_header?
+          @request.env['HTTP_AUTHORIZATION'].nil?
         end
 
-        private
+        ##
+        # Check if request is authorized
+        #
+        # @return [TrueClass] if request is authorized -> {#request_signature} is correct & {#request_message} is included
+        #   in {#allowed_messages}
+        # @return [FalseClass] if request is not authorized
+        #
+        def authorized?
+          request_signature.eql?(@config.signature) && @allowed_messages.include?(request_message)
+        end
 
+        ##
         # Get request signature
+        #
+        # @return [String] signature of current request
+        #
         def request_signature
           @request.env['HTTP_AUTHORIZATION'].split(':').last
         end
 
+        ##
         # Get encrypted request message
+        #
+        # @return [String] message of current request
+        #
         def request_message
           @request.env['HTTP_AUTHORIZATION'].split(':').first
         end
 
-        # Builds Array of allowed message hashs
-        # @return [Array] hash_array [allowed message hashes as array]
+        ##
+        # Builds Array of allowed message hashs between @tolerance via {#message}
+        #
+        # @return [Array]
         def allowed_messages
           messages = []
 
-          date = Time.now.to_i.freeze
-          (-(@config.tolerance)..@config.tolerance).step(@config.stepsize) do |i|
-            i = i.round(2)
+          # Timestamp with milliseconds as Fixnum
+          date = (Time.now.to_f.freeze * 1000).to_i
+          (-(@config.tolerance)..@config.tolerance).step(1) do |i|
             messages << OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @config.secret, message(date, i))
           end
 
           messages
         end
 
+        ##
         # Get Message for current Request and delay
+        #
         # @param [Fixnum] date [current date in timestamp format]
         # @param [Fixnum] delay [delay in timestamp format]
-        # @return [Hash] message [message which will be encrypted]
+        #
+        # @return [String] message
         def message(date, delay = 0)
           date += delay
-          date = date.to_i if delay.eql?(0.0)
 
-          # Print out Delay and Timestamp for each range step in development environment
-          puts "Delay: #{delay}, Timestamp: #{date}" if ENV['RACK_ENV'].eql?('development')
-
-          { 'method' => @request.request_method, 'date' => date, 'data' => request_data(@config) }.to_json
+          { 'method' => @request.request_method, 'date' => date, 'data' => request_data }.to_json
         end
 
-        # Get Request Data specified by Config
-        # @param [Hash] config [Config Hash containing what type of info is data for each request]
-        # @return [String|Hash] data [Data for each request]
-        def request_data(config)
+        ##
+        # Get Request Data specified by @config.request_config
+        #
+        # @return [String|Hash] data
+        def request_data
           if @config.request_config[@request.request_method] == 'path' || @config.request_config[@request.request_method] == 'params'
             @request.send(@config.request_config[@request.request_method].to_sym)
           else
@@ -135,43 +172,33 @@ module Rack
           end
         end
 
-        # Log to @config.logpath if request is unathorized
+        ##
+        # Log to @config.logpath
         # Contains:
         #   - allowed messages and received message
         #   - time when request was made
         #   - type of request
         #   - requested path
+        #
+        # Note: This is kinda slow under Rubinius 
+        #   (Rack::SimpleAuth::Logger.log has IO action, i think there are some performance issues)
+        #
         def log
           if @config.logpath
-            msg = "#{Time.new} - #{@request.request_method} #{@request.path} - 400 Unauthorized\n"
+            msg =  "#{Time.new} - #{@request.request_method} #{@request.path} - 400 Unauthorized\n"
             msg << "HTTP_AUTHORIZATION: #{@request.env['HTTP_AUTHORIZATION']}\n"
             msg << "Auth Message Config: #{@config.request_config[@request.request_method]}\n"
 
-            if allowed_messages
+            if @allowed_messages
               msg << "Allowed Encrypted Messages:\n"
-              allowed_messages.each do |hash|
+              @allowed_messages.each do |hash|
                 msg << "#{hash}\n"
               end
             end
 
             msg << "Auth Signature: #{@config.signature}"
 
-            Rack::SimpleAuth::Logger.log(@config.logpath, ENV['RACK_ENV'], msg)
-          end
-        end
-
-        # Check if Stepsize is valid, if > min ensure stepsize is min stepsize
-        # @param [float] min [minimum allowed stepsize]
-        # check @config.stepsize < min
-        def valid_stepsize?(min)
-          fail "Minimum allowed stepsize is #{min}" if @config.stepsize < min
-        end
-
-        # Check if tolerance is valid, tolerance must be greater than stepsize
-        # check @config.tolerance < @config.stepsize
-        def valid_tolerance?
-          if @config.tolerance < @config.stepsize
-            fail "Tolerance must be greater than stepsize - Tolerance: #{@config.tolerance}, Stepsize: #{@config.stepsize}"
+            Rack::SimpleAuth::Logger.log(@config.logpath, @config.verbose, ENV['RACK_ENV'], msg)
           end
         end
       end # Middleware

data/lib/rack/simple_auth/logger.rb

@@ -4,14 +4,19 @@ module Rack
     # This class receives a logpath, env and message and
     # prints the message to the specified logpath for the proper env file (eg.: /path/to/file/test_error.log for test env)
     module Logger
-      def self.log(logpath, env = 'development', msg)
+      # Create Logfile
+      #
+      # @param [String] logpath [path to logfile]
+      # @param [TrueClass|FalseClass] verbose [if true print to stdout]
+      # @param [String] msg [Message defined by each Authorization class]
+      #
+      def self.log(logpath, verbose = false, env, msg)
         system("mkdir #{logpath}") unless Dir.exist?("#{logpath}")
         open("#{logpath}/#{env}_error.log", 'a') do |f|
           f << "#{msg}\n"
         end
 
-        # Print out log to stdout for dev env
-        puts msg if ENV['RACK_ENV'].eql?('development')
+        puts msg if verbose
       end
     end # Logger
   end # SimpleAuth

data/lib/rack/simple_auth/version.rb

@@ -2,6 +2,6 @@ module Rack
   # Module which Contains different Authorization / Authentication Classes (HMAC, ..)
   module SimpleAuth
     # Current Gem Version
-    VERSION = '1.0.0rc'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,152 +1,138 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: rack-simple_auth
-version: !ruby/object:Gem::Version
-  version: 1.0.0rc
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
 platform: ruby
-authors:
+authors: 
 - Benny1992
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-04-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rack
-  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
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id006 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.6"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "10.3"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: coveralls
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.7"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rack-test
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+  type: :development
+  version_requirements: *id005
 description: SimpleAuth HMAC authentication
-email:
+email: 
 - r3qnbenni@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
-- Gemfile
+
+files: 
 - LICENSE.txt
 - MANIFEST
-- README.md
-- Rakefile
+- README.rdoc
 - checksum/rack-simple_auth-0.0.9.gem.sha512
 - checksum/rack-simple_auth-0.1.0.gem.sha512
 - checksum/rack-simple_auth-0.1.1.gem.sha512
 - checksum/rack-simple_auth-0.1.2.gem.sha512
+- checksum/rack-simple_auth-1.0.0.gem.sha512
+- checksum/rack-simple_auth-1.0.0rc.gem.sha512
+- doc/Rack.html
+- doc/Rack/SimpleAuth.html
+- doc/Rack/SimpleAuth/HMAC.html
+- doc/Rack/SimpleAuth/HMAC/Config.html
+- doc/Rack/SimpleAuth/HMAC/Middleware.html
+- doc/Rack/SimpleAuth/Logger.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/examples/index.php
+- doc/examples/rack_lobster.ru
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/rack/simple_auth.rb
 - lib/rack/simple_auth/hmac/config.rb
 - lib/rack/simple_auth/hmac/middleware.rb
 - lib/rack/simple_auth/logger.rb
 - lib/rack/simple_auth/version.rb
 - rack-simple_auth.gemspec
-- rubocop-todo.yml
-- task/build.rake
-- task/checksum.rake
-- task/console.rake
-- task/default.rake
-- task/floodtest.rake
-- task/manifest.rake
-- task/test.rake
-- test/rack/simple_auth/hmac/config.ru
-- test/rack/simple_auth/hmac/config_fail.ru
-- test/rack/simple_auth/hmac/config_fail_option.ru
-- test/rack/simple_auth/hmac/config_fail_run.ru
-- test/rack/simple_auth/hmac/config_fail_step.ru
-- test/rack/simple_auth/hmac/config_fail_tolerance.ru
-- test/rack/simple_auth/hmac/hmac_fail_run_test.rb
-- test/rack/simple_auth/hmac/hmac_fail_test.rb
-- test/rack/simple_auth/hmac/hmac_test.rb
-- test/test_helper.rb
 homepage: https://github.com/Benny1992/rack-simple_auth
-licenses:
+licenses: 
 - MIT
 metadata: {}
-post_install_message: 'Please report any issues at: https://github.com/Benny1992/rack-simple_auth/issues/new'
+
+post_install_message: "Please report any issues at: https://github.com/Benny1992/rack-simple_auth/issues/new"
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
+    - !ruby/object:Gem::Version 
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ">"
-    - !ruby/object:Gem::Version
-      version: 1.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id006
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: SimpleAuth HMAC authentication
 test_files: []
-has_rdoc: 
+