keycloak 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63b392f7ae7445fd2bda51f7880df14e9263a08dd50787fb554cf74b09f2518e
-  data.tar.gz: 4dc43914776becc510b6e13631e822b6c01464a618cb0477464ff396fe98c778
+  metadata.gz: d366d68dc864faaeede6c0ec859981bb1d9b6f559140da47ae843f99a4f36b06
+  data.tar.gz: 66a2a5c8226d3f92530bdf370ffce5c5112da6acc2060d1c4e3b6196f62e2142
 SHA512:
-  metadata.gz: 14cb6e916705ff2bf1013bfc9b58b776cf6bfbba2734f92a7fed3f1a9232de5345d2fea69302941461c2a69d2cea28cfb2a68e8fd473b1c526cc9351a5bdaa3d
-  data.tar.gz: 5bed97dd414124844fce9c36fcf7b3488ec34ba6ffc42ac15cf77587987404a3556f610ef2b2b7e85186abb8581c13293022676bb3573da61384907b837f9eec
+  metadata.gz: f0dec0f4ec59e6f9435d015f664dbd6ce58e3bd40d2a3e27dbeb6b59f16cb5ed49edc090f7a272276ed2536af9fc10772f4acee4bb9b61d50b47bf6b5d9bc621
+  data.tar.gz: 4ddb3742850851d8c1fbf66b4a0e29d1e4343e165e56ce7ba868bac655b8836ed22f9d30e2edb23d23a496afcff8e3d91935b518a90864b3d05c2ed1e5007fa5

data/Gemfile.lock

@@ -1,57 +1,57 @@
 PATH
   remote: .
   specs:
-    keycloak (3.0.0)
-      json (= 2.3.0)
-      jwt (= 2.2.1)
-      rest-client (= 2.1.0)
+    keycloak (3.3.0)
+      json (~> 2.6)
+      jwt (~> 2.4)
+      rest-client (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
+    diff-lcs (1.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     http-accept (1.7.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
-    json (2.3.0)
-    jwt (2.2.1)
-    mime-types (3.3.1)
+    json (2.6.2)
+    jwt (2.4.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    mime-types-data (3.2022.0105)
     netrc (0.11.0)
-    rake (13.0.1)
+    rake (13.0.6)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.8.2)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.15)
+  bundler (~> 2.3)
   keycloak!
   rake (~> 13.0)
-  rspec (~> 3.0)
+  rspec (~> 3.7)
 
 BUNDLED WITH
-   1.16.2
+   2.5.11

data/README.md

@@ -8,7 +8,8 @@ Its development was based on version 3.2 of Keycloak, whose documentation can be
 
 Publication of gem: https://rubygems.org/gems/keycloak
 
-Exemple: https://github.com/imagov/example-gem-keycloak
+Example: https://github.com/imagov/example-gem-keycloak
+
 
 ## Installation
 
@@ -152,7 +153,10 @@ To authenticate the users of your application using a template configured in Key
 Keycloak::Client.get_token_by_code(code, redirect_uri, client_id = '', secret = '')
 ```
 
-When using the `Keycloak::Client.url_login_redirect` method to get a `code`, pass it as a parameter in this method so that Keycloak returns a token, thus logging the user in the application. The second parameter (`redirect_uri`) must be passed so that when a token is made available, Keycloak redirects to the url informed.
+When using the `Keycloak::Client.url_login_redirect` method to get a `code`, pass it as a parameter in this method so that Keycloak returns a token, thus logging the user in the application. The second parameter (`redirect_uri`) must be the same one used in the call for `Keycloak::Client.url_login_redirect(redirect_uri, response_type = 'code')`.
+
+> If `redirect_uri` are not equal on both calls,  `Keycloak::Client.url_login_redirect` and `Keycloak::Client.get_token_by_code` you will receive the following error:
+> `{"error":"invalid_grant","error_description":"Incorrect redirect_uri"}`
 
 
 ```ruby
@@ -177,7 +181,7 @@ When the user is already logged in and your application internally tracks the to
 
 
 ```ruby
-Keycloak::Client.get_token_introspection(token = '', client_id = '', secret = '', token_introspection_endpoint = '')
+Keycloak::Client.get_token_introspection(token = '', client_id = '', secret = '', introspection_endpoint = '')
 ```
 
 This method returns the information from the `token` session passed as parameter. Among the information returned, the most important is the `active` field, since it informs whether the token session passed in the parameter is active or not. This will help your application control whether the logged-in user session has expired or not. If no token is passed as a parameter, gem will use the last `access_token` stored in the application's cookie.
@@ -212,14 +216,14 @@ Returns the <b>url</b> for access to the realm user registry of the installation
 
 
 ```ruby
-Keycloak::Client.has_role?(user_role, access_token = '', client_id = '', secret = '', token_introspection_endpoint = '')
+Keycloak::Client.has_role?(user_role, access_token = '', client_id = '', secret = '', introspection_endpoint = '')
 ```
 
 The `has_role?` method decodes the JWT `access_token` and verifies that the user who owns the token has the <b>role</b> informed in the `user_role` parameter. If `access_token` is not informed then gem will use the `access_token` of the cookie.
 
 
 ```ruby
-Keycloak::Client.user_signed_in?(access_token = '', client_id = '', secret = '', token_introspection_endpoint = '')
+Keycloak::Client.user_signed_in?(access_token = '', client_id = '', secret = '', introspection_endpoint = '')
 ```
 
 This method checks whether the `access_token` passed in the parameter is still active. To check whether the user is active or not, the gem invokes the `get_token_introspection` method internally. If `access_token` is not informed then gem will use the `access_token` of the cookie.

data/README.pt-BR.md

@@ -173,7 +173,7 @@ Quando o usuário já estiver logado e a sua aplicação acompanhar internamente
 
 
 ```ruby
-Keycloak::Client.get_token_introspection(token = '', client_id = '', secret = '', token_introspection_endpoint = '')
+Keycloak::Client.get_token_introspection(token = '', client_id = '', secret = '', introspection_endpoint = '')
 ```
 
 Esse método retorna a as informações da sessão do `token` passado como parâmetro. Entre as informações retornadas, a mais importante é o campo `active`, pois ele informa se a sessão do token passado no parâmetro é ativo ou não. Isso auxiliará a sua aplicação a controlar se a sessão do usuário logado expirou ou não. Caso nenhum token seja passado como parâmetro, a gem utilizará o último `access_token` armazenado no cookie da aplicação.
@@ -208,14 +208,14 @@ Retorna a <b>url</b> para acesso ao cadastro de usuários do Reino do arquivo de
 
 
 ```ruby
-Keycloak::Client.has_role?(user_role, access_token = '', client_id = '', secret = '', token_introspection_endpoint = '')
+Keycloak::Client.has_role?(user_role, access_token = '', client_id = '', secret = '', introspection_endpoint = '')
 ```
 
 O método `has_role?` decodifica o JWT `access_token` e verifica se o usuário dono do token possui o <b>role</b> informado no parâmetro `user_role`. Caso o `access_token` não seja informado, então a gem utilizará o `access_token` do cookie.
 
 
 ```ruby
-Keycloak::Client.user_signed_in?(access_token = '', client_id = '', secret = '', token_introspection_endpoint = '')
+Keycloak::Client.user_signed_in?(access_token = '', client_id = '', secret = '', introspection_endpoint = '')
 ```
 
 Esse método verifica se o `access_token` passado no parâmetro ainda está ativo. Para verificar se o usuário está ativo ou não, internamente a gem invoca o método `get_token_introspection`. Caso o `access_token` não seja informado, então a gem utilizará o `access_token` do cookie.

data/keycloak.gemspec

@@ -6,8 +6,8 @@ require "keycloak/version"
 Gem::Specification.new do |spec|
   spec.name          = "keycloak"
   spec.version       = Keycloak::VERSION
-  spec.authors       = ["Guilherme Portugues"]
-  spec.email         = ["g_portugues@hotmail.com"]
+  spec.authors       = ["Guilherme Portugues", "Leandro Vital Catarin"]
+  spec.email         = ["g_portugues@hotmail.com", "leavitals@gmail.com"]
 
   spec.summary       = %q{Add authentication to applications and secure services with Keycloak}
   #spec.description   = %q{TODO: Write a longer description or delete this line.}
@@ -30,10 +30,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_runtime_dependency "rest-client", "2.1.0"
-  spec.add_runtime_dependency "jwt", "2.2.1"
-  spec.add_runtime_dependency "json", "2.3.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_runtime_dependency "rest-client", "~> 2.1"
+  spec.add_runtime_dependency "jwt", "~> 2.4"
+  spec.add_runtime_dependency "json", "~> 2.6"
 end

data/lib/keycloak/version.rb

@@ -1,3 +1,3 @@
 module Keycloak
-  VERSION = '3.2.1'.freeze
+  VERSION = '3.3.0'.freeze
 end

data/lib/keycloak.rb

@@ -15,9 +15,37 @@ module Keycloak
   OLD_KEYCLOAK_JSON_FILE = 'keycloak.json'.freeze
   KEYCLOAK_JSON_FILE = 'config/keycloak.json'.freeze
 
+  class Config
+    attr_accessor :proc_cookie_token,
+                  :proc_external_attributes
+  end
+
+  module Base
+    def config
+      Thread.current[:keycloak_config] ||= Keycloak::Config.new
+    end
+
+    def proc_cookie_token
+      config.proc_cookie_token
+    end
+
+    def proc_cookie_token=(value)
+      config.proc_cookie_token = value
+    end
+
+    def proc_external_attributes
+      config.proc_external_attributes
+    end
+
+    def proc_external_attributes=(value)
+      config.proc_external_attributes = value
+    end
+  end
+
+  extend Base
+
   class << self
     attr_accessor :proxy, :generate_request_exception, :keycloak_controller,
-                  :proc_cookie_token, :proc_external_attributes,
                   :realm, :auth_server_url, :validate_token_when_call_has_role,
                   :secret, :resource
   end
@@ -152,13 +180,13 @@ module Keycloak
       mount_request_token(payload)
     end
 
-    def self.get_token_introspection(token = '', client_id = '', secret = '', token_introspection_endpoint = '')
+    def self.get_token_introspection(token = '', client_id = '', secret = '', introspection_endpoint = '')
       verify_setup
 
       client_id = @client_id if isempty?(client_id)
       secret = @secret if isempty?(secret)
       token = self.token['access_token'] if isempty?(token)
-      token_introspection_endpoint = @configuration['token_introspection_endpoint'] if isempty?(token_introspection_endpoint)
+      introspection_endpoint = @configuration['introspection_endpoint'] if isempty?(introspection_endpoint)
 
       payload = { 'token' => token }
 
@@ -169,7 +197,7 @@ module Keycloak
                  'authorization' => authorization }
 
       _request = -> do
-        RestClient.post(token_introspection_endpoint, payload, header){|response, request, result|
+        RestClient.post(introspection_endpoint, payload, header){|response, request, result|
           case response.code
           when 200..399
             response.body
@@ -182,14 +210,16 @@ module Keycloak
       exec_request _request
     end
 
-    def self.url_login_redirect(redirect_uri, response_type = 'code', client_id = '', authorization_endpoint = '')
+    def self.url_login_redirect(redirect_uri, response_type = 'code', client_id = '', authorization_endpoint = '', scope: [])
       verify_setup
 
       client_id = @client_id if isempty?(client_id)
       authorization_endpoint = @configuration['authorization_endpoint'] if isempty?(authorization_endpoint)
 
-      p = URI.encode_www_form(response_type: response_type, client_id: client_id, redirect_uri: redirect_uri)
-      "#{authorization_endpoint}?#{p}"
+      params = { response_type: response_type, client_id: client_id, redirect_uri: redirect_uri }
+      params[:scope] = scope.join(',') if scope.any?
+      encoded_uri = URI.encode_www_form(params)
+      "#{authorization_endpoint}?#{encoded_uri}"
     end
 
     def self.logout(redirect_uri = '', refresh_token = '', client_id = '', secret = '', end_session_endpoint = '')
@@ -261,14 +291,14 @@ module Keycloak
       "#{@auth_server_url}/realms/#{@realm}/account"
     end
 
-    def self.has_role?(user_role, access_token = '', client_id = '', secret = '', token_introspection_endpoint = '')
+    def self.has_role?(user_role, access_token = '', client_id = '', secret = '', introspection_endpoint = '')
       verify_setup
 
       client_id = @client_id if isempty?(client_id)
       secret = @secret if isempty?(secret)
-      token_introspection_endpoint = @configuration['token_introspection_endpoint'] if isempty?(token_introspection_endpoint)
+      introspection_endpoint = @configuration['introspection_endpoint'] if isempty?(introspection_endpoint)
 
-      if !Keycloak.validate_token_when_call_has_role || user_signed_in?(access_token, client_id, secret, token_introspection_endpoint)
+      if !Keycloak.validate_token_when_call_has_role || user_signed_in?(access_token, client_id, secret, introspection_endpoint)
         dt = decoded_access_token(access_token)[0]
         dt = dt['resource_access'][client_id]
         unless dt.nil?
@@ -280,15 +310,15 @@ module Keycloak
       false
     end
 
-    def self.user_signed_in?(access_token = '', client_id = '', secret = '', token_introspection_endpoint = '')
+    def self.user_signed_in?(access_token = '', client_id = '', secret = '', introspection_endpoint = '')
       verify_setup
 
       client_id = @client_id if isempty?(client_id)
       secret = @secret if isempty?(secret)
-      token_introspection_endpoint = @configuration['token_introspection_endpoint'] if isempty?(token_introspection_endpoint)
+      introspection_endpoint = @configuration['introspection_endpoint'] if isempty?(introspection_endpoint)
 
       begin
-        JSON(get_token_introspection(access_token, client_id, secret, token_introspection_endpoint))['active'] === true
+        JSON(get_token_introspection(access_token, client_id, secret, introspection_endpoint))['active'] === true
       rescue => e
         if e.class < Keycloak::KeycloakException
           raise
@@ -336,7 +366,7 @@ module Keycloak
       KEYCLOACK_CONTROLLER_DEFAULT = 'session'.freeze
 
       def self.get_installation
-        if File.exists?(Keycloak.installation_file)
+        if File.exist?(Keycloak.installation_file)
           installation = JSON File.read(Keycloak.installation_file)
           @realm = installation["realm"]
           @client_id = installation["resource"]

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: keycloak
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Guilherme Portugues
-autorequire: 
+- Leandro Vital Catarin
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-06 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,59 +45,60 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
-description: 
+        version: '2.6'
+description:
 email:
 - g_portugues@hotmail.com
+- leavitals@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -124,7 +126,7 @@ homepage: https://github.com/imagov/keycloak.git
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Add authentication to applications and secure services with Keycloak
 test_files: []