omniauth-keycloak-openid 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e4c8ca60a9bacc92dd08c12bd8d96f5b9df0237b87a6f343a0dec89878bfc45
+  data.tar.gz: 8aab3aa10ec9862b607298c53f5147adcd6756f5ceb7c0b323368a3ca7493c4c
+SHA512:
+  metadata.gz: 9c45cda33a12259125c49838c1f7b3795ee58b6c9591b38080a2dc3860f8915ab08b8287cdd58f2641fa1f0076678da96356d2d321432311d50f7f9092832be7
+  data.tar.gz: 80377082507e28c1957615a96784d2eae0991becf54e7c8ea34ab603d5b5c0d19c124e919fea437ad86c706cfa03cfeccd8bd752834e28918e32cfb6efcfff53

data/.gitignore

@@ -0,0 +1,6 @@
+/.projects/
+/.settings/
+/.idea/
+/.bundle/
+/tmp/
+/log/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Cisco Systems, Inc.
+
+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,35 @@
+# OmniAuth::KeycloakOpenID
+
+This is a custom [OmniAuth](https://github.com/omniauth/omniauth) "provider" gem, which authenticates a user via keycloak OIDC protocol.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+    gem 'omniauth-keycloak-openid'
+```
+
+And then execute:
+
+```
+    $ bundle
+```
+
+Or directly install and add to Gemfile it yourself as:
+
+```
+    $ bundle add omniauth-keycloak-openid
+```
+
+In omniauth.rb file
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :keycloak_openid, ENV['CLIENT_ID'], ENV['CLIENT_SECRET'], scope: "openid profile email", redirect_uri: 'http://localhost:3000/auth/keycloak_openid/callback'
+end
+```
+
+
+## License
+
+The gem currently has the [MIT License](http://opensource.org/licenses/MIT) license file included, but todate, has NOT been made available as open source.

data/lib/omniauth-keycloak-openid.rb

@@ -0,0 +1,5 @@
+require 'omniauth-keycloak-openid/version'
+require 'omniauth/strategies/keycloak-openid'
+require 'net/http'
+
+OmniAuth.config.add_camelization('keycloak_openid', 'KeycloakOpenID')

data/lib/omniauth-keycloak-openid/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module KeycloakOpenID
+    VERSION = "1.0.1"
+  end
+end

data/lib/omniauth/strategies/keycloak-openid.rb

@@ -0,0 +1,78 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class KeycloakOpenID < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "openid profile email"
+      DEFAULT_RESPONSE_TYPE = "code"
+
+      option :name, 'keycloak_openid'
+      option :client_options, site: 'http://localhost:8080'
+
+      option :authorize_options, %i[scope response_type redirect_uri]
+      option :provider_ignores_state, true
+
+      uid { raw_info['user'] }
+
+      info do
+        {
+          name: raw_info['name'] || "#{raw_info['given_name']} #{raw_info['family_name']}",
+          email: raw_info['email'],
+          first_name: raw_info['given_name'],
+          last_name: raw_info['family_name'],
+          phone: raw_info['phone_number']
+        }
+      end
+
+      extra do
+        prune!('raw_info' => raw_info)
+      end
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      end
+
+      def raw_info
+        @raw_info ||= load_identity
+      end
+
+      def authorize_params
+        super.tap do |params|
+          params[:scope] ||= DEFAULT_SCOPE
+          params[:response_type] ||= DEFAULT_RESPONSE_TYPE
+        end
+      end
+
+      def build_access_token
+        if options[:grant_type] == 'auth_code'
+          verifier = request.params['code']
+          client.auth_code.get_token(verifier, get_token_options(callback_url), deep_symbolize(options.auth_token_params))
+        else
+          client.password.get_token(request.params[:username],
+                                    request.params[:password],
+                                    scope: DEFAULT_SCOPE)
+        end
+      end
+
+      private
+
+      def load_identity
+        access_token.options[:mode] = :header
+        access_token.options[:param_name] = :access_token
+        access_token.options[:grant_type] = :authorization_code
+        access_token.get(options[:userinfo_url]).parsed || {}
+      end
+
+      def get_token_options(redirect_uri)
+        { redirect_uri: redirect_uri }.merge(token_params.to_hash(symbolize_keys: true))
+      end
+
+      def prune!(hash)
+        hash.delete_if do |_, value|
+          prune!(value) if value.is_a?(Hash)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+    end
+  end
+end

data/omniauth-keycloak-openid.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-keycloak-openid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-keycloak-openid"
+  spec.version       = OmniAuth::KeycloakOpenID::VERSION
+  spec.authors       = ["Dinesh Budhayer"]
+  spec.email         = ["budhayer96d@gmail.com"]
+
+  spec.summary       = %q{Keycloak OpenID Connect supporting strategy for Omniauth.}
+  spec.description   = %q{This gem authenticates a user by Keycloak OpenID connect protocol.}
+  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/ayerdines/omniauth-keycloak-openid"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth', '~> 1.1', '>= 1.1.1'
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.3', '>= 1.3.1'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", '~> 12.3', '>= 12.3.3'
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-keycloak-openid
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Dinesh Budhayer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem authenticates a user by Keycloak OpenID connect protocol.
+email:
+- budhayer96d@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- lib/omniauth-keycloak-openid.rb
+- lib/omniauth-keycloak-openid/version.rb
+- lib/omniauth/strategies/keycloak-openid.rb
+- omniauth-keycloak-openid.gemspec
+homepage: https://github.com/ayerdines/omniauth-keycloak-openid
+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: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Keycloak OpenID Connect supporting strategy for Omniauth.
+test_files: []