devise_ssl_authenticatable 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9aabe09042c17ab46f34ca84410ca34bd1aca31
+  data.tar.gz: 34478d97131ce969cf17a69cfeb0cece04b53754
+SHA512:
+  metadata.gz: 31dc97125d2be30722f55687046fba201ac00654859ef0e8e27883c94650324b937522cfc71816e9cd430197d756813d55e1fa72f3afa6091ff122e378198b58
+  data.tar.gz: b00dd8a3f688c921be74c2bbc8252295d4590c90fed41fbd1ffc5990db981243a7a8c8adb52f3b0a86000a3882bc4d7b90bfbb625e51bed3471f57b385acffd5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devise_ssl_authenticatable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brilligent Solutions, Inc.
+
+MIT License
+
+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,31 @@
+# Devise SSL Authenticatable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise_ssl_authenticatable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise_ssl_authenticatable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/szechyjs/devise_ssl_authenticatable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/devise_ssl_authenticatable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devise/ssl_authenticatable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise_ssl_authenticatable"
+  spec.version       = Devise::SslAuthenticatable::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Jared Szechy"]
+  spec.email         = ["jared.szechy@gmail.com"]
+  spec.summary       = %q{Implements SSL client authentication for Devise.}
+  spec.description   = %q{Reads the SSL client authentication headers from your webserver.}
+  spec.homepage      = "http://github.com/szechyjs/devise_ssl_authenticatable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'devise', '~> 4'
+
+  spec.add_development_dependency "rails",  "~> 5"
+  spec.add_development_dependency "rspec-rails", "~> 3.7"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/devise/models/ssl_authenticatable.rb

@@ -0,0 +1,22 @@
+module Devise
+  module Models
+    module SslAuthenticatable
+      extend ActiveSupport::Concern
+
+      # Hook called after ssl authentication
+      def after_ssl_authentication
+      end
+
+      module ClassMethods
+        def find_for_ssl_authentication(authentication_hash)
+          dn_field = ssl_client_dn_field.to_sym
+          dn = authentication_hash[dn_field]
+          resource = find_for_authentication(dn_field: dn) || new(dn_field: dn, email: authentication_hash[:email])
+          resource
+        end
+
+        Devise::Models.config(self, :ssl_client_dn_field)
+      end
+    end
+  end
+end

data/lib/devise/ssl_authenticatable.rb

@@ -0,0 +1,13 @@
+require 'devise'
+
+require 'devise/strategies/ssl_authenticatable'
+
+module Devise
+  # The database column that holds the DN of the user
+  mattr_accessor :ssl_client_dn_field
+  @@ssl_client_dn_field = :ssl_client_dn
+
+end
+
+Devise.add_module(:ssl_authenticatable, strategy: true,
+                  model: true, no_input: true)

data/lib/devise/ssl_authenticatable/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module SslAuthenticatable
+    VERSION = "0.1.0.pre"
+  end
+end

data/lib/devise/strategies/ssl_authenticatable.rb

@@ -0,0 +1,64 @@
+require 'devise/strategies/authenticatable'
+
+module Devise
+  module Strategies
+    #
+    # Strategy for signing in a user, based on a SSL certificate.
+    #
+    class SslAuthenticatable < Authenticatable
+      def authenticate!
+        resource = mapping.to.find_for_ssl_authentication(authentication_hash)
+        return fail(:invalid_ssl) unless resource
+
+        if validate(resource)
+          resource.after_ssl_authentication
+          success!(resource)
+        end
+      end
+
+      def store?
+        false
+      end
+
+      def valid?
+        super || valid_for_ssl_auth?
+      end
+
+      private
+
+      # Check if this strategy is valid for ssl authentication by:
+      #
+      #   * If the request contians valid SSL headers
+      #   * If all authentication keys are present
+      #
+      def valid_for_ssl_auth?
+        client_verify? && with_authentication_hash(:ssl_auth, ssl_auth_hash)
+      end
+
+      def ssl_auth_hash
+        { authentication_keys.first => client_dn, email: client_email }
+      end
+
+      # Does the request contain a valid SSL cert?
+      def client_verify?
+        request.headers['puma.peercert'] || request.headers['X-SSL-Client-Verify'] == 'SUCCESS'
+      end
+
+      # The DN of the client certificate
+      def client_dn
+        request.headers['puma.peercert'].subject.to_s
+      end
+
+      def client_email
+        request.headers['puma.peercert'].subject.to_s.match(/emailAddress=([^\/]*)/)[0]
+      end
+
+      # Overwrite authentication keys to use ssl_client_dn_field.
+      def authentication_keys
+        @authentication_keys ||= [Devise::ssl_client_dn_field]
+      end
+    end
+  end
+end
+
+Warden::Strategies.add(:ssl_authenticatable, Devise::Strategies::SslAuthenticatable)

data/lib/devise_ssl_authenticatable.rb

@@ -0,0 +1,7 @@
+require 'devise/ssl_authenticatable'
+
+module Devise
+  module SslAuthenticatable
+    # Your ddcode goes here...
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: devise_ssl_authenticatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Jared Szechy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Reads the SSL client authentication headers from your webserver.
+email:
+- jared.szechy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- devise_ssl_authenticatable.gemspec
+- lib/devise/models/ssl_authenticatable.rb
+- lib/devise/ssl_authenticatable.rb
+- lib/devise/ssl_authenticatable/version.rb
+- lib/devise/strategies/ssl_authenticatable.rb
+- lib/devise_ssl_authenticatable.rb
+homepage: http://github.com/szechyjs/devise_ssl_authenticatable
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Implements SSL client authentication for Devise.
+test_files: []