auther 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 093c3e3b89c2368100edded3b52d2d3a11461031
+  data.tar.gz: 7e351f9e60c11c0e4336c4795dff68e4f0fdd5dd
+SHA512:
+  metadata.gz: 40258f7e43264a953509038a46472a43f1ee56acd71818cda863446bbdc356aae0dba2ac70672cd042ea9917a346eec42b03669d7ce00607fa014b4a700fe85d
+  data.tar.gz: 3e8a937baaa20506299883b701f35aeb268200c318d468ddc0fb66c993026f989ba6a0843b0ec167c83a32d18733d1a23e33bfe00f09fcb0d5cd10fb3aa28285

data.tar.gz.sig

@@ -0,0 +1,2 @@
+2��B��.��f���q�<�͠�%�m��)e��\��9�+�k�ʙ邽\ޅ��JLs�A�X��0=�,�=	D{�D��$�4�[����.m�9�Ӝ����sߴ�ѻ�������]q`�s##��-��)��љ�G�VT���m/�ڢ�h���.��
6�#B+)�Hj9�h�_$A1�k�_�7A�'�[�ff���
+�u����Ƿ�]�

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2014 [Red Alchemist](http://www.redalchemist.com).
+
+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,100 @@
+# Overview
+
+Provides simple, form-based authentication for apps that need security but don't want to use the clunky UI of
+HTTP Basic Authentication and/or want to be compatible with password managers.
+
+[![Gem Version](https://badge.fury.io/rb/auther.png)](http://badge.fury.io/rb/auther)
+[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/auther.png)](https://codeclimate.com/github/bkuhlmann/auther)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/auther.png)](http://travis-ci.org/bkuhlmann/auther)
+
+# Features
+
+* Form-based authentication compatible with password managers like [1Password](https://agilebits.com/onepassword).
+* Multiple account support with account specific blacklisted paths.
+* Auto-redirection to blacklisted path (once credentials have been verified).
+* Customizable session view.
+* Customizable session controller.
+
+# Requirements
+
+0. [Ruby 2.x.x](http://www.ruby-lang.org).
+0. [Ruby on Rails 4.x.x](http://rubyonrails.org).
+
+# Setup
+
+Type the following from the command line to securely install (recommended):
+
+    gem cert --add <(curl -Ls http://www.redalchemist.com/gem-public.pem)
+    gem install auther -P HighSecurity
+
+...or type the following to insecurely install (not recommended):
+
+    gem install auther
+
+Add the following to your Gemfile:
+
+    gem "auther"
+
+# Usage
+
+Edit your routes.rb as follows:
+
+    Rails.application.routes.draw do
+      mount Auther::Engine => "/auther"
+    end
+
+Edit your application.rb as follows:
+
+    module Example
+      class Application < Rails::Application
+        config.auther_settings = {
+          accounts: [
+            {
+              name: "test",
+              login: "test@test.com",
+              password: "password",
+              paths: ["/admin"]
+            }
+          ],
+          auth_url: "/auther/session/new"
+        }
+      end
+    end
+
+# Customization
+
+Don't like the default authorization form? No problem, simply create the following file within your Rails application
+to override the form provided by this engine and customize as you see fit:
+
+    app/views/auther/session/new.html
+
+# Tests
+
+To test, do the following:
+
+0. cd to the gem root.
+0. bundle install
+0. bundle exec rspec spec
+
+# Resources
+
+* [Simplest Auth](https://github.com/vigetlabs/simplest_auth) - For situations where you need user and email reset
+  support beyond what this engine can provide.
+
+# Contributions
+
+Read CONTRIBUTING for details.
+
+# Credits
+
+Developed by [Brooke Kuhlmann](http://www.redalchemist.com) at [Red Alchemist](http://www.redalchemist.com).
+
+# License
+
+Copyright (c) 2014 [Red Alchemist](http://www.redalchemist.com).
+Read the LICENSE for details.
+
+# History
+
+Read the CHANGELOG for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).

data/app/assets/stylesheets/auther/application.css.scss

@@ -0,0 +1,45 @@
+.auther-form {
+  font-family: "Helvetica","Times New Roman","Georgia","Serif";
+  background-color: rgba(198,198,198,1);
+  border: solid black 0.1em;
+  width: 20em;
+  margin: 0 auto;
+  padding: 1em;
+  -webkit-border-radius: 0.5em; -moz-border-radius: 0.5em; border-radius: 0.5em;
+
+  .row {
+    &:after {
+      content: "";
+      display: table;
+      clear: both;
+    }
+  }
+
+  .title {
+    margin-top: 0;
+    text-align: center;
+  }
+
+  .label {
+    margin: 0 0 1em 0;
+    float: left;
+  }
+
+  .input {
+    margin: 0 0 1em 0;
+    float: right;
+    input {
+      width: 15em;
+    }
+  }
+
+  .actions {
+    text-align: center;
+    input {
+      color: rgba(255,255,255,1);
+      background-color: rgba(0,140,186,1);
+      width: 15em;
+    }
+  }
+}
+

data/app/controllers/auther/application_controller.rb

@@ -0,0 +1,4 @@
+module Auther
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/auther/session_controller.rb

@@ -0,0 +1,31 @@
+class Auther::SessionController < ApplicationController
+  layout "auther/auth"
+
+  def show
+    redirect_to action: :new
+  end
+
+  def new
+  end
+
+  def create
+    settings = Rails.application.config.auther_settings
+    account = settings.fetch(:accounts).select { |account| account.fetch(:login) == params[:login] }.first
+
+    if account
+      keymaster = Auther::Keymaster.new account[:name]
+      session[keymaster.login_key] = params[:login]
+      session[keymaster.password_key] = params[:password]
+      redirect_to session["auther_redirect_url"] || '/'
+    else
+      render template: "auther/session/new"
+    end
+  end
+
+  def destroy
+    keymaster = Auther::Keymaster.new params[:account_name]
+    session.delete keymaster.login_key
+    session.delete keymaster.password_key
+    redirect_to action: :new
+  end
+end

data/app/helpers/auther/application_helper.rb

@@ -0,0 +1,4 @@
+module Auther
+  module ApplicationHelper
+  end
+end

data/app/views/auther/session/new.html.slim

@@ -0,0 +1,19 @@
+= form_tag "/auther/session", class: "auther-form"
+  .row
+    h1.title Authorization
+
+  .row
+    .label
+      = label_tag :login, "Login:"
+    .input
+      = text_field_tag :login, nil
+
+  .row
+    .label
+      = label_tag :password, "Password:"
+    .input
+      = password_field_tag :password, nil
+
+  .row
+    .actions
+      = submit_tag "Login", class: "btn btn-primary"

data/app/views/layouts/auther/auth.html.slim

@@ -0,0 +1,10 @@
+head
+  meta charset="utf-8"
+  meta name="viewport" content="width=device-width, initial-scale=1.0"
+  title Authorization
+
+  = stylesheet_link_tag "auther/application", media: "all"
+  = csrf_meta_tags
+body
+  = yield
+  = javascript_include_tag "auther/application"

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/auther/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,4 @@
+Auther::Engine.routes.draw do
+  root to: "session#new"
+  resource :session, controller: "session", only: [:show, :new, :create, :destroy]
+end

data/lib/auther.rb

@@ -0,0 +1,4 @@
+require "slim-rails"
+require "auther/keymaster"
+require "auther/gatekeeper"
+require "auther/engine"

data/lib/auther/engine.rb

@@ -0,0 +1,13 @@
+module Auther
+  class Engine < ::Rails::Engine
+    isolate_namespace Auther
+
+    # Set defaults. Can be overwritten in app config.
+    config.auther_settings = {}
+
+    initializer "auther.initialize" do |app|
+      # Initialize Gatekeeper middleware.
+      app.config.app_middleware.use Auther::Gatekeeper, app.config.auther_settings
+    end
+  end
+end

data/lib/auther/gatekeeper.rb

@@ -0,0 +1,57 @@
+module Auther
+  class Gatekeeper
+    attr_reader :application, :settings
+
+    def initialize application, settings = []
+      @application = application
+      @settings = settings
+    end
+
+    def call env
+      session = env.fetch "rack.session"
+      request_path = env["PATH_INFO"]
+
+      if authorized?(env, request_path)
+        application.call env
+      else
+        session[Auther::Keymaster.redirect_url_key] = request_path
+        response = Rack::Response.new
+        response.redirect settings[:auth_url]
+        response.finish
+      end
+    end
+
+    private
+
+    def find_account env
+      session = env.fetch "rack.session"
+      session["auther_init"] = true # Force session to initialize.
+      account_name = Auther::Keymaster.get_account_name session
+      settings.fetch(:accounts).select { |account| account.fetch(:name) == account_name }.first
+    end
+
+    def blacklisted_path? path
+      blacklisted_paths = settings.fetch(:accounts).map {|account| account.fetch :paths }.flatten
+      blacklisted_paths.map { |blacklisted_path| path.include? blacklisted_path }.any?
+    end
+
+    def blacklisted_account? account, path
+      account.fetch(:paths).include? path
+    end
+
+    def authenticated? env, account
+      session = env.fetch "rack.session"
+      keymaster = Auther::Keymaster.new account.fetch(:name)
+      session[keymaster.login_key] == account.fetch(:login) && session[keymaster.password_key] == account.fetch(:password)
+    end
+
+    def authorized? env, path
+      if blacklisted_path?(path)
+        account = find_account env
+        account && authenticated?(env, account) && !blacklisted_account?(account, path)
+      else
+        true
+      end
+    end
+  end
+end

data/lib/auther/keymaster.rb

@@ -0,0 +1,42 @@
+module Auther
+  class Keymaster
+    attr_reader :account_name
+
+    def self.namespace
+      "auther"
+    end
+
+    def self.redirect_url_key delimiter: '_'
+      [namespace, "redirect", "url"] * delimiter
+    end
+
+    def self.get_account_name session = {}
+      matching_keys = session.keys.select { |key| key.to_s =~ /auther.+login/ }
+      key = matching_keys.first || ''
+      key.gsub("#{namespace}_", '').gsub "_login", ''
+    end
+
+    def self.get_account_login session = {}
+      account_name = get_account_name session
+      session[new(account_name).login_key]
+    end
+
+    def initialize account_name = nil
+      @account_name = account_name
+    end
+
+    def login_key
+      build_key "login"
+    end
+
+    def password_key
+      build_key "password"
+    end
+
+    private
+
+    def build_key key_name, delimiter: '_'
+      [self.class.namespace, account_name, key_name].compact * delimiter
+    end
+  end
+end

data/lib/auther/version.rb

@@ -0,0 +1,3 @@
+module Auther
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,296 @@
+--- !ruby/object:Gem::Specification
+name: auther
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDhTCCAm2gAwIBAgIBATANBgkqhkiG9w0BAQUFADBEMQ8wDQYDVQQDDAZicm9v
+  a2UxHDAaBgoJkiaJk/IsZAEZFgxyZWRhbGNoZW1pc3QxEzARBgoJkiaJk/IsZAEZ
+  FgNjb20wHhcNMTMwNjI1MDEzOTUyWhcNMTQwNjI1MDEzOTUyWjBEMQ8wDQYDVQQD
+  DAZicm9va2UxHDAaBgoJkiaJk/IsZAEZFgxyZWRhbGNoZW1pc3QxEzARBgoJkiaJ
+  k/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCoICuy
+  DEfASTaScwJxS+wuGY729rx9X6KWktpiee5UT0hSZ8RBum1PU5pfgXdZcZ9rOiGC
+  66qjTN7I08FWpnoz/11M9Wcqd5k1aJXnXeCKRjWmgrnqY2ecbM6CR2OhSIe63l1I
+  wNg9ZTx6h2S8AcdJa2cs1kGO0/NZ5PqKn8ZSFUfByJIIP6ygas7MFIh9EuDs+bTU
+  OVrOAtfC8rZKZ7iFhPwMeRfn4PnR/q0xfK6UXjjr7ES67/qjAbioZaNfubbe+bc7
+  aRcWYGTG8cFuM0PnX4dr2p3ZRXmOYwt+dcZxRZxG099v4IsC0hwttgES64BfDiQc
+  PrqZFq63Lzc/j+eBAgMBAAGjgYEwfzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAd
+  BgNVHQ4EFgQU43tA2HIdqx0YsONzs1fL6z8l4WQwIgYDVR0RBBswGYEXYnJvb2tl
+  QHJlZGFsY2hlbWlzdC5jb20wIgYDVR0SBBswGYEXYnJvb2tlQHJlZGFsY2hlbWlz
+  dC5jb20wDQYJKoZIhvcNAQEFBQADggEBADZi/zTFe3ZJ87QbGmqIadqGeqy27/KZ
+  tIO5rX7kPoFwIdFyW8XekozEPaWDpwRQ/E0LVz1f/7U6VEmp30tpOgXqHS7GkAlz
+  Q1bZjlDMkosXIYd737LfjaQB5YqzoUMWdbPmX5oKXmQMy416GrcLZXW22u5HtrHN
+  AT6fTCYrKaY9LWcugrGU7puOo0itBjLUC0YxtBnDGV8h0Fop9DHQ6gATPweQ7R1j
+  SJpzzzZ8gO6BKn4fhd+ENNQ333Qy3nuNk07TVIaNnlgeHhowUDuD9T7Z8Lka0pt3
+  4PteiTppsf0SSVAM9zSO5IuFngXMRwWgvjOfXE70f43RDuUVTCSyylc=
+  -----END CERTIFICATE-----
+date: 2014-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: slim-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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: pry-remote
+  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: pry-rescue
+  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: pry-stack_explorer
+  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: pry-vterm_aliases
+  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: pry-git
+  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: pry-doc
+  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-rails
+  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: rb-fsevent
+  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: guard-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: A Rails Engine with simple, form-based authentication, session, and blacklist
+  route support.
+email:
+- brooke@redalchemist.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- app/assets/javascripts/auther/application.js
+- app/assets/stylesheets/auther/application.css.scss
+- app/controllers/auther/application_controller.rb
+- app/controllers/auther/session_controller.rb
+- app/helpers/auther/application_helper.rb
+- app/views/auther/session/new.html.slim
+- app/views/layouts/auther/auth.html.slim
+- bin/rails
+- config/routes.rb
+- lib/auther.rb
+- lib/auther/engine.rb
+- lib/auther/gatekeeper.rb
+- lib/auther/keymaster.rb
+- lib/auther/version.rb
+homepage: http://www.redalchemist.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A Rails Engine with simple, form-based authentication support.
+test_files: []
+has_rdoc: