devise_auth_proxy 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8846af07e2b4f12a6c281145c42e735a9fcd0ce03ea977616183451c73aeb08e
-  data.tar.gz: d018490c545869580150831ffddb5bc2b16525d2efc366834ad6d3dd4a27f5df
+  metadata.gz: fb482273df7b5210882d40b4baa9a524f8981a885a4165d57ff1e12255ad057f
+  data.tar.gz: 2d452531bc30dcf873834a9412ec111d14eac314c28ae20939da5451a388f066
 SHA512:
-  metadata.gz: c769602495ca09310aa056dcdb21260f975d38321e077e4e77eec66b5ce842c85e368e51dfe0b2225ccdbcb0d9f855da392100abb872ecf705b19d52cbfdd3fc
-  data.tar.gz: 3dfb5e2f40dc920369e984f4c23f43d48d5a3e0d3550732d66436b048c6f787274e411e02ee6d913e5e20c87b3486547349316054ce6751e87bece076f09c906
+  metadata.gz: 3c3430f08cd3f30e177905833fa01140257383a826f5403077c13603494a35789bae094b7ae0bd0fdceabc9b8ae6abfa09aec6a2e5bb198aa1e07ede468342a4
+  data.tar.gz: dd23d00047233114e3cda97f6bc93094a020670927a6bf728fdd14ba30dadf1f985f82e57fd2afbb5b4cfecdfc01f2ae70cf6a9c98f49623b063f5da3eb30215

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tkquang@fossil.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in devise-auth_proxy.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "devise"

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    devise_auth_proxy (0.1.14)
+      devise
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.3)
+      actionview (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.3)
+      activesupport (= 6.0.3.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    bcrypt (3.1.16)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    devise (4.7.3)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0)
+      responders
+      warden (~> 1.2.3)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.7.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    orm_adapter (0.5.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.3)
+      actionpack (= 6.0.3.3)
+      activesupport (= 6.0.3.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (12.3.3)
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    warden (1.2.9)
+      rack (>= 2.0.9)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  devise
+  devise_auth_proxy!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 QuangTK
+
+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,44 @@
+# Devise::AuthProxy
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/devise/auth_proxy`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise-auth_proxy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install devise-auth_proxy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devise-auth_proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/devise-auth_proxy/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Devise::AuthProxy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/devise-auth_proxy/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "devise_auth_proxy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/devise_auth_proxy.gemspec

@@ -0,0 +1,30 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require_relative 'lib/devise_auth_proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise_auth_proxy"
+  spec.version       = DeviseAuthProxy::VERSION
+  spec.authors       = ["QuangTK"]
+  spec.email         = ["tkquang@fossil.com"]
+
+  spec.summary       = "For authentication through proxy auth"
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/me0den/devise_auth_proxy"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "devise"
+end

data/lib/devise_auth_proxy.rb

@@ -0,0 +1,50 @@
+require 'devise'
+require 'devise_auth_proxy/version'
+
+module DeviseAuthProxy
+  class << self
+    attr_accessor :env_key, :auto_create, :auto_update, :auth_key, :attribute_map, :logout_url
+  end
+
+  # request.env key for remote user name
+  # Set to 'HTTP_AUTH_PROXY' in config/initializers/devise.rb if behind reverse proxy
+  self.env_key = 'AUTH_PROXY'
+
+  # Enable user auto-creation of user from proxy user attributes
+  self.auto_create = false
+
+  # Enable user auto-update of user attributes from proxy user attributes
+  self.auto_update = false
+
+  # User attribute used for lookup of proxy user
+  # Defaults to Devise.authentication_keys.first
+  self.auth_key = nil
+
+  # Map of User model attributes to request.env keys for updating a local user when auto-creation is enabled.
+  self.attribute_map = {}
+
+  # Settings for redirecting to the remote user logout URL
+  # Enable by including DeviseAuthProxy::Controllers::Helpers in ApplicationController
+  # (it overrides Devise's after_sign_out_path_for method).
+  self.logout_url = '/'
+
+  def self.configure
+    yield self
+  end
+
+  def self.remote_user_id env
+    case env_key
+    when Proc
+      env_key.call(env)
+    else
+      env[env_key]
+    end
+  end
+
+  class Error < StandardError; end
+end
+
+Devise.add_module(:auth_proxy_authenticatable,
+                  :strategy => true,
+                  :controller => :sessions,
+                  :model => 'devise_auth_proxy/model')

data/lib/devise_auth_proxy/manager.rb

@@ -0,0 +1,61 @@
+module DeviseAuthProxy
+
+  #
+  # The Manager class is responsible for connecting the appliation's User
+  # class with proxy user information in the request environment.
+  #
+  class Manager
+
+    attr_reader :klass, :env
+
+    def initialize(klass, env)
+      @klass = klass
+      @env = env
+    end
+
+    def find_or_create_user
+      user = find_user
+      if !user && DeviseAuthProxy.auto_create
+        user = create_user
+      end
+      update_user(user) if user && DeviseAuthProxy.auto_update
+      user
+    end
+
+    def find_user
+      klass.where(user_criterion).first
+    end
+
+    def create_user
+      unless Devise.mappings[:user].strategies.include?(:database_authenticatable)
+        return klass.create(user_criterion)
+      end
+
+      random_password = SecureRandom.hex(16)
+      attrs = user_criterion.merge({password: random_password, password_confirmation: random_password})
+      klass.create(attrs)
+    end
+
+    def update_user(user)
+      user.update_attributes(remote_user_attributes)
+    end
+
+    protected
+
+    def remote_user_attributes
+      DeviseAuthProxy.attribute_map.inject({}) { |h, (k, v)| h[k] = env[v] if env.has_key?(v); h }
+    end
+
+    def user_criterion
+      {auth_key => remote_user_id}
+    end
+
+    def remote_user_id
+      DeviseAuthProxy.remote_user_id(env)
+    end
+
+    def auth_key
+      DeviseAuthProxy.auth_key || Devise.authentication_keys.first
+    end
+  end
+end

data/lib/devise_auth_proxy/model.rb

@@ -0,0 +1,21 @@
+require 'devise_auth_proxy/strategy'
+require 'devise_auth_proxy/manager'
+
+module Devise
+  module Models
+    module AuthProxyAuthenticatable
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :current_password, :password
+      end
+
+      module ClassMethod
+        def self.find_for_auth_proxy_authentication(env)
+          manager = DeviseAuthProxy::Manager.new(self, env)
+          manager.find_or_create_user
+        end
+      end
+    end
+  end
+end

data/lib/devise_auth_proxy/strategy.rb

@@ -0,0 +1,20 @@
+require 'devise/strategies/authenticatable'
+
+module Devise
+  module Strategies
+    class AuthProxyAuthenticatable < Authenticatable
+
+      def valid?
+        DeviseAuthProxy.remote_user_id(env).present?
+      end
+
+      def authenticate!
+        resource = mapping.to.find_for_auth_proxy_authentication(env)
+        resource ? success!(resource) : fail
+      end
+
+    end
+  end
+end
+
+Warden::Strategies.add(:auth_proxy_authenticatable, Devise::Strategies::AuthProxyAuthenticatable)

data/lib/devise_auth_proxy/version.rb

@@ -0,0 +1,3 @@
+module DeviseAuthProxy
+  VERSION = "0.1.14"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_auth_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - QuangTK
@@ -30,8 +30,25 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: 
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- devise_auth_proxy.gemspec
+- lib/devise_auth_proxy.rb
+- lib/devise_auth_proxy/manager.rb
+- lib/devise_auth_proxy/model.rb
+- lib/devise_auth_proxy/strategy.rb
+- lib/devise_auth_proxy/version.rb
+homepage: https://github.com/me0den/devise_auth_proxy
 licenses:
 - MIT
 metadata: {}