Module: Keycloak::Client

Defined in:
lib/keycloak.rb

Constant Summary collapse

KEYCLOAK_JSON_FILE = 
'keycloak.json'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.auth_server_url ⇒ Object

Returns the value of attribute auth_server_url.



25
26
27
 
# File 'lib/keycloak.rb', line 25

def auth_server_url
  @auth_server_url
end

.client_id ⇒ Object (readonly)

Returns the value of attribute client_id.



26
27
28
 
# File 'lib/keycloak.rb', line 26

def client_id
  @client_id
end

.configuration ⇒ Object (readonly)

Returns the value of attribute configuration.



26
27
28
 
# File 'lib/keycloak.rb', line 26

def configuration
  @configuration
end

.public_key ⇒ Object (readonly)

Returns the value of attribute public_key.



26
27
28
 
# File 'lib/keycloak.rb', line 26

def public_key
  @public_key
end

.realm ⇒ Object

Returns the value of attribute realm.



25
26
27
 
# File 'lib/keycloak.rb', line 25

def realm
  @realm
end

.secret ⇒ Object (readonly)

Returns the value of attribute secret.



26
27
28
 
# File 'lib/keycloak.rb', line 26

def secret
  @secret
end

Class Method Details

.decoded_access_token(access_token = '') ⇒ Object 



274
275
276
277
 
# File 'lib/keycloak.rb', line 274

def self.decoded_access_token(access_token = '')
  access_token = self.token["access_token"] if access_token.empty?
  JWT.decode access_token, @public_key, false, { :algorithm => 'RS256' }
end

.decoded_refresh_token(refresh_token = '') ⇒ Object 



279
280
281
282
 
# File 'lib/keycloak.rb', line 279

def self.decoded_refresh_token(refresh_token = '')
  refresh_token = self.token["access_token"] if refresh_token.empty?
  JWT.decode refresh_token, @public_key, false, { :algorithm => 'RS256' }
end

.external_attributes ⇒ Object 



266
267
268
269
270
271
272
 
# File 'lib/keycloak.rb', line 266

def self.external_attributes
  if !Keycloak.proc_external_attributes.nil?
    Keycloak.proc_external_attributes.call
  else
    raise Keycloak::ProcExternalAttributesNotDefined
  end
end

.get_attribute(attributeName, access_token = '') ⇒ Object 



251
252
253
254
255
256
 
# File 'lib/keycloak.rb', line 251

def self.get_attribute(attributeName, access_token = '')
  verify_setup

  attr = decoded_access_token(access_token)[0]
  attr[attributeName]
end

.get_token(user, password) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/keycloak.rb', line 31

def self.get_token(user, password)
  setup_module

  payload = { 'client_id' => @client_id,
              'client_secret' => @secret,
              'username' => user,
              'password' => password,
              'grant_type' => 'password' }

  mount_request_token(payload)
end

.get_token_by_client_credentials(client_id = '', secret = '') ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/keycloak.rb', line 103

def self.get_token_by_client_credentials(client_id = '', secret = '')
  setup_module

  client_id = @client_id if client_id.empty?
  secret = @secret if secret.empty?

  payload = { 'client_id' => client_id,
              'client_secret' => secret,
              'grant_type' => 'client_credentials' }

  mount_request_token(payload)
end

.get_token_by_code(code, redirect_uri) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/keycloak.rb', line 43

def self.get_token_by_code(code, redirect_uri)
  verify_setup

  payload = { 'client_id' => @client_id,
              'client_secret' => @secret,
              'code' => code,
              'grant_type' => 'authorization_code',
              'redirect_uri' => redirect_uri }

  mount_request_token(payload)
end

.get_token_by_exchange(issuer, issuer_token) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/keycloak.rb', line 55

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

.get_token_by_refresh_token(refresh_token = '') ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/keycloak.rb', line 90

def self.get_token_by_refresh_token(refresh_token = '')
  verify_setup

  refresh_token = self.token['refresh_token'] if refresh_token.empty?

  payload = { 'client_id' => @client_id,
              'client_secret' => @secret,
              'refresh_token' => refresh_token,
              'grant_type' => 'refresh_token' }

  mount_request_token(payload)
end

.get_token_introspection(token = '', client_id = '', secret = '') ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/keycloak.rb', line 116

def self.get_token_introspection(token = '', client_id = '', secret = '')
  verify_setup

  token = self.token["access_token"] if token.empty?
  payload = { 'token' => token }

  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',
            'authorization' => authorization}

  _request = -> do
    RestClient.post(@configuration['token_introspection_endpoint'], payload, header){|response, request, result|
      case response.code
      when 200..399
        response.body
      else
        response.return!
      end
    }
  end

  exec_request _request
end

.get_userinfo(access_token = '') ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/keycloak.rb', line 189

def self.get_userinfo(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|
      case response.code
      when 200
        response.body
      else
        response.return!
      end
    }
  end

  exec_request _request
end

.get_userinfo_issuer(access_token = '') ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/keycloak.rb', line 75

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

.has_role?(user_role, access_token = '') ⇒ Boolean

Returns:

  • (Boolean) 


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/keycloak.rb', line 218

def self.has_role?(user_role, access_token = '')
  verify_setup

  if user_signed_in?(access_token)
    dt = decoded_access_token(access_token)[0]
    dt = dt["resource_access"][@client_id]
    if dt != nil
      dt["roles"].each do |role|
        return true if role.to_s == user_role.to_s
      end
      false
    else
      false
    end
  else
    false
  end
end

.logout(redirect_uri = '', refresh_token = '') ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/keycloak.rb', line 152

def self.logout(redirect_uri = '', refresh_token = '')
  verify_setup

  if self.token || !refresh_token.empty?

    refresh_token = self.token['refresh_token'] if refresh_token.empty?

    payload = { 'client_id' => @client_id,
                'client_secret' => @secret,
                'refresh_token' => refresh_token
          }

    header = {'Content-Type' => 'application/x-www-form-urlencoded'}

    if redirect_uri.empty?
      final_url = @configuration['end_session_endpoint']
    else
      final_url = "#{@configuration['end_session_endpoint']}?#{URI.encode_www_form({ redirect_uri: redirect_uri })}"
    end

    _request = -> do
      RestClient.post(final_url, payload, header){ |response, request, result|
        case response.code
        when 200..399
          true
        else
          response.return!
        end
      }
    end

    exec_request _request
  else
    true
  end
end

.token ⇒ Object 



258
259
260
261
262
263
264
 
# File 'lib/keycloak.rb', line 258

def self.token
  if !Keycloak.proc_cookie_token.nil?
    JSON Keycloak.proc_cookie_token.call
  else
    raise Keycloak::ProcCookieTokenNotDefined
  end
end

.url_login_redirect(redirect_uri, response_type = 'code') ⇒ Object 



145
146
147
148
149
150
 
# File 'lib/keycloak.rb', line 145

def self.(redirect_uri, response_type = 'code')
  verify_setup

  p = URI.encode_www_form({ response_type: response_type, client_id: @client_id, redirect_uri: redirect_uri })
  "#{@configuration['authorization_endpoint']}?#{p}"
end

.url_user_account ⇒ Object 



212
213
214
215
216
 
# File 'lib/keycloak.rb', line 212

def self.
  verify_setup

  "#{@auth_server_url}/realms/#{@realm}/account"
end

.user_signed_in?(access_token = '') ⇒ Boolean

Returns:

  • (Boolean) 


237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/keycloak.rb', line 237

def self.user_signed_in?(access_token = '')
  verify_setup

  begin
    JSON(get_token_introspection(access_token))['active'] === true
  rescue => e
    if e.class < Keycloak::KeycloakException
      raise
    else
      false
    end
  end
end