keycloak 2.2.9 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 56a336f456ac6997524a6c4f7579ca04c6be6f27
-  data.tar.gz: e30bc3b08c799a7b76192bc08093ca0caa58f71e
+SHA256:
+  metadata.gz: bed7a57a922cce701d2a97abfe58dc2a9424a6744bf9756f2abdc99e0f8fe9a4
+  data.tar.gz: c133a6162ad571e0e224145524430991e94d09333f24a8cc40302b48562087bf
 SHA512:
-  metadata.gz: 4f1f1adfc4d758cee7d2d4f4b258155a10191365a974e4ea0b5018d660441763394abe21974847f505f318bb44b58714951ce689b2dc4e593f1ba7abbf335692
-  data.tar.gz: 8441e469f2fd48df0d83298ab9e8a4b27dbca74b2d0f14fe1b25c1e3b1cf6b5a2bdcaacf189613453b4b77bf24e462c5bc5572505980d822230d3cf1a0d82c8a
+  metadata.gz: d123f765a14329ac0078f14b252563b34b8955abc63b1c65aa2a466fc2382fc3d7eb0ecf158e08362c96bea3c81d0244b28df2ece20faf92280193840f5c855e
+  data.tar.gz: 785c56cfce98cf957c2c83a16143599e226ddf521d0fbaa629413f1bd9bb95f1072f3e753c19cbac8aa5d931ed2942d4f269f9a2c542f60411d4794e65824d84

data/.vscode/launch.json

@@ -0,0 +1,65 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+    
+        {
+            "name": "Debug Local File",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/main.rb"
+        },
+        {
+            "name": "Listen for rdebug-ide",
+            "type": "Ruby",
+            "request": "attach",
+            "cwd": "${workspaceRoot}",
+            "remoteHost": "127.0.0.1",
+            "remotePort": "1234",
+            "remoteWorkspaceRoot": "${workspaceRoot}"
+        },
+        {
+            "name": "Rails server",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/rails",
+            "args": [
+                "server"
+            ]
+        },
+        {
+            "name": "RSpec - all",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/rspec",
+            "args": [
+                "-I",
+                "${workspaceRoot}"
+            ]
+        },
+        {
+            "name": "RSpec - active spec file only",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/rspec",
+            "args": [
+                "-I",
+                "${workspaceRoot}",
+                "${file}"
+            ]
+        },
+        {
+            "name": "Cucumber",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/bin/cucumber"
+        }
+    ]
+}

data/README.pt-BR.md

@@ -33,7 +33,7 @@ Para adicionar o arquivo de configuração:
 
 Considerando que você já possua um ambiente do Keycloak configurado e a gem já instalada, o próximo passo é definir como será a autenticação da aplicação. O Keycloak trabalha com os principais protocolos de autenticação, tais como o OpenID Connect, Oauth 2.0 e SAML 2.0, integrando acesso a sistemas via Single-Sign On, podendo inclusive disponibilizar acessos a usuários LDAP ou Active Directory.
 
-Ao cadastrar um Reino e também um Client no seu ambiente Keycloak, será necessário fazer o download do arquivo de instalação do Client para dentro da pasta raiz da aplicação, para que a gem obtenha as informações necessárias para interagir com o Keycloak. Para fazer esse download, basta acessar o cadastro de seu Client, clicar na aba <b>Installation</b>, selecionar <b>Keycloak OIDC JSON</b> no campo <b>Format option</b> e clicar em <b>Download</b>.
+Ao cadastrar um Reino e também um Client no seu ambiente Keycloak, você poderá fazer o download do arquivo de instalação do Client para dentro da pasta raiz da aplicação, para que a gem obtenha as informações necessárias para interagir com o Keycloak. Para fazer esse download, basta acessar o cadastro de seu Client, clicar na aba <b>Installation</b>, selecionar <b>Keycloak OIDC JSON</b> no campo <b>Format option</b> e clicar em <b>Download</b>. Caso a sua aplicação não trabalhe apenas com um client específico (aplicação servidora de APIs, por exemplo), então você poderá informar o reino que a gem irá interagir no arquivo de configuração `keycloak.rb`.
 
 A gem possui um módulo principal chamado <b>Keycloak</b>. Dentro desse módulo há três outros módulos: <b>Client</b>, <b>Admin</b> e <b>Internal</b>.
 
@@ -41,6 +41,20 @@ A gem possui um módulo principal chamado <b>Keycloak</b>. Dentro desse módulo
 
 O módulo Keycloak possui alguns atributos e suas definições são fundamentais para o perfeito funcionamento da gem na aplicação.
 
+```ruby
+Keycloak.realm
+```
+
+Se a sua aplicação não trabalha apenas com um client específico (aplicação servidora de APIs, por exemplo), então você poderá informar o nome reino que a gem irá interagir nesse atributo. Ao ser instalada, a gem cria o arquivo `keycloak.rb` em `config/initializers`. Este atributo pode ser encontrado e definido nesse arquivo.
+
+
+```ruby
+Keycloak.auth_server_url
+```
+
+Para o mesmo cenário do atributo acima, você poderá informar a url reino que a gem irá interagir nesse atributo. Ao ser instalada, a gem cria o arquivo `keycloak.rb` em `config/initializers`. Este atributo pode ser encontrado e definido nesse arquivo.
+
+
 ```ruby
 Keycloak.proxy
 ```

data/lib/generators/keycloak.rb

@@ -4,3 +4,7 @@ Keycloak.proxy = ''
 Keycloak.generate_request_exception = true
 # controller that manage the user session
 Keycloak.keycloak_controller = 'session'
+# relm name (only if the installation file is not present)
+Keycloak.realm = ''
+# relm url (only if the installation file is not present)
+Keycloak.auth_server_url = ''

data/lib/keycloak.rb

@@ -8,7 +8,8 @@ require 'uri'
 module Keycloak
   class << self
     attr_accessor :proxy, :generate_request_exception, :keycloak_controller,
-                  :proc_cookie_token, :proc_external_attributes
+                  :proc_cookie_token, :proc_external_attributes,
+                  :realm, :auth_server_url
   end
 
 
@@ -21,8 +22,8 @@ module Keycloak
 
   module Client
     class << self
-      attr_reader :realm, :url, :client_id, :auth_server_url,
-                  :secret, :configuration, :public_key
+      attr_accessor :realm, :auth_server_url
+      attr_reader :client_id, :secret, :configuration, :public_key
     end
 
     KEYCLOAK_JSON_FILE = 'keycloak.json'
@@ -51,6 +52,41 @@ module Keycloak
       mount_request_token(payload)
     end
 
+    def self.get_token_by_exchange(issuer, issuer_token)
+      setup_module 
+      
+      payload = { 'client_id' => @client_id, 'client_secret' => @secret, 'audience' => @client_id, 'grant_type' => 'urn:ietf:params:oauth:grant-type:token-exchange', 'subject_token_type' => 'urn:ietf:params:oauth:token-type:access_token', 'subject_issuer' => issuer, 'subject_token' => issuer_token }
+      header = {'Content-Type' => 'application/x-www-form-urlencoded'} 
+     _request = -> do
+        RestClient.post(@configuration['token_endpoint'], payload, header){|response, request, result| 
+        # case response.code 
+        # when 200 
+        # response.body 
+        # else 
+        # response.return! 
+        # end 
+        response.body 
+      }
+      end
+       
+        exec_request _request 
+    end
+
+    def self.get_userinfo_issuer(access_token = '')
+      verify_setup
+      
+      access_token = self.token["access_token"] if access_token.empty?
+      payload = { 'access_token' => access_token }
+      header = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      _request = -> do
+        RestClient.post(@configuration['userinfo_endpoint'], payload, header){ |response, request, result|
+          response.body 
+        } 
+      end
+      
+      exec_request _request 
+    end
+
     def self.get_token_by_refresh_token(refresh_token = '')
       verify_setup
 
@@ -77,14 +113,16 @@ module Keycloak
       mount_request_token(payload)
     end
 
-    def self.get_token_introspection(token = '')
+    def self.get_token_introspection(token = '', client_id = '', secret = '')
       verify_setup
 
       token = self.token["access_token"] if token.empty?
-
       payload = { 'token' => token }
 
-      authorization = Base64.strict_encode64("#{@client_id}:#{@secret}")
+      client_id = @client_id if client_id.empty?
+      secret = @secret if secret.empty?
+
+      authorization = Base64.strict_encode64("#{client_id}:#{secret}")
       authorization = "Basic #{authorization}"
 
       header = {'Content-Type' => 'application/x-www-form-urlencoded',
@@ -95,7 +133,6 @@ module Keycloak
           case response.code
           when 200..399
             response.body
-
           else
             response.return!
           end
@@ -175,7 +212,7 @@ module Keycloak
     def self.url_user_account
       verify_setup
 
-      "#{@url}/realms/#{@realm}/account"
+      "#{@auth_server_url}/realms/#{@realm}/account"
     end
 
     def self.has_role?(user_role, access_token = '')
@@ -242,14 +279,19 @@ module Keycloak
         if File.exists?(KEYCLOAK_JSON_FILE)
           installation = JSON File.read(KEYCLOAK_JSON_FILE)
           @realm = installation["realm"]
-          @url = installation["auth-server-url"]
           @client_id = installation["resource"]
           @secret = installation["credentials"]["secret"]
           @public_key = installation["realm-public-key"]
           @auth_server_url = installation["auth-server-url"]
           openid_configuration
         else
-          raise "#{KEYCLOAK_JSON_FILE} not found."
+          if Keycloak.realm.blank? || Keycloak.auth_server_url.blank?
+            raise "#{KEYCLOAK_JSON_FILE} and relm settings not found."
+          else
+            @realm = Keycloak.realm
+            @auth_server_url = Keycloak.auth_server_url
+            openid_configuration
+          end
         end
       end
 
@@ -277,7 +319,7 @@ module Keycloak
 
       def self.openid_configuration
         RestClient.proxy = Keycloak.proxy unless Keycloak.proxy.empty?
-        config_url = "#{@url}/realms/#{@realm}/.well-known/openid-configuration"
+        config_url = "#{@auth_server_url}/realms/#{@realm}/.well-known/openid-configuration"
         _request = -> do
           RestClient.get config_url
         end
@@ -827,6 +869,12 @@ module Keycloak
         else
           response.body
         end
+      when 400..499
+        begin
+          response.return!
+        rescue RestClient::ExceptionWithResponse => err
+          raise ActionController::RoutingError.new(err.response)
+        end
       else
         if Keycloak.explode_exception
           response.return!

data/lib/keycloak/version.rb

@@ -1,3 +1,3 @@
 module Keycloak
-  VERSION = "2.2.9"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak
 version: !ruby/object:Gem::Version
-  version: 2.2.9
+  version: 2.3.0
 platform: ruby
 authors:
 - Guilherme Portugues
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".vscode/launch.json"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Add authentication to applications and secure services with Keycloak