rack-simple-auth 0.0.1

data/README.md

@@ -0,0 +1,35 @@
+# Rack::SimpleAuth
+
+A dead simple rack middleware for cookie authentication.  This middleware enhances an existing auth solution by providing access to multiple apps (which may have their own authentication code) from a single cookie. This was originally created to prevent access to a set of staging apps.  We use our own key/secret and cookie here so that the staging apps can maintain their own cookie secrets and authentication solutions.
+
+### Usage
+
+For rails, create an initializer file with something like:
+
+    MyApp::Application.config.middleware.use Rack::SimpleAuth,
+      key: 'your_cookie_key', # required
+      secret: 'my_long_secret', # required
+      login_url: 'http://url_where_user_will_be_redirected_to_authenticate.com', # required
+      authenticated_with: Proc.new { |value| true } # optional: must return a boolean
+
+By default, the middleware doesn't actually check the value of the cookie, only that the correct key exists and hasn't been tampered with. You can add more complex rules by passing the `authenticated_with` option with a proc that takes the cookie value as its only argument.
+
+For example:
+
+    # assuming you had a User model and the cookie value is a user_id
+    authenticated_with: Proc.new { |value| user = User.find(value) && user.admin? }
+
+### How it Works
+
+The middleware relies on you creating a custom cookie with your own authentication code. Your authentication cookie code can decide which domain this cookie applies to, allowing you to create a universal access token for all apps on a particular subdomain.
+
+Example cookie code:
+
+    # called after a user has authenticated
+    def save_auth_cookie
+      packed_data = [my_cookie_data.to_s].pack('m*')
+      hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA1.new, YOUR_SECRET, packed_data)
+      cookies[YOUR_KEY] = { domain: '.yourdomain.com', value: "#{packed_data}--#{hmac}" }
+    end
+
+If cookie authentication fails in the middleware, it will redirect the user to the url provided in the `login_url` option. The middleware will also send the requested url in the return_to param so that you may redirect the user back to the requested url once they have authenticated.

data/lib/rack-simple-auth.rb

@@ -0,0 +1,38 @@
+require 'rack'
+require 'rack/request'
+
+module Rack
+  class SimpleAuth
+    def initialize(app, options = {})
+      @app = app
+      @key = options[:key]
+      @secret = options[:secret]
+      @login_url = options[:login_url]
+      @authenticated_with = options[:authenticated_with] || Proc.new { |value| true }
+    end
+
+    def call(env)
+      request = Request.new(env)
+      if authenticated? request.cookies
+        @app.call(env)
+      else
+        [302, {'Location' => "#{@login_url}?return_to=#{request.url}"}, ['You must be logged in to see this.']]
+      end
+    end
+
+    def authenticated?(cookies)
+      if data = cookies[@key]
+        packed_data, digest = data.split('--')
+        hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA1.new, @secret, packed_data)
+        begin
+          # false if tampering going on
+          digest == hmac && @authenticated_with.call(packed_data.unpack("m*").first)
+        rescue
+          false
+        end
+      else
+        false
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: rack-simple-auth
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rob Law
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A middleware the prevents access to a rack app without the proper cookie.
+email: rob@robmadethis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack-simple-auth.rb
+- README.md
+homepage: http://robmadethis.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A rack middleware for cookie authentication.
+test_files: []