Module: Keycloak::Client

Defined in:
lib/keycloak.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.auth_server_url ⇒ Object

Returns the value of attribute auth_server_url.



37
38
39
 
# File 'lib/keycloak.rb', line 37

def auth_server_url
  @auth_server_url
end

.client_id ⇒ Object

Returns the value of attribute client_id.



37
38
39
 
# File 'lib/keycloak.rb', line 37

def client_id
  @client_id
end

.configuration ⇒ Object

Returns the value of attribute configuration.



37
38
39
 
# File 'lib/keycloak.rb', line 37

def configuration
  @configuration
end

.public_key ⇒ Object

Returns the value of attribute public_key.



37
38
39
 
# File 'lib/keycloak.rb', line 37

def public_key
  @public_key
end

.realm ⇒ Object

Returns the value of attribute realm.



37
38
39
 
# File 'lib/keycloak.rb', line 37

def realm
  @realm
end

.secret ⇒ Object

Returns the value of attribute secret.



37
38
39
 
# File 'lib/keycloak.rb', line 37

def secret
  @secret
end

Class Method Details

.decoded_access_token(access_token = '') ⇒ Object 



294
295
296
297
 
# File 'lib/keycloak.rb', line 294

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 



299
300
301
302
 
# File 'lib/keycloak.rb', line 299

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 



286
287
288
289
290
291
292
 
# File 'lib/keycloak.rb', line 286

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 



271
272
273
274
275
276
 
# File 'lib/keycloak.rb', line 271

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

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

.get_token(user, password) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/keycloak.rb', line 40

def self.get_token(user, password)
  setup_module

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

  res = mount_request_token(payload)
  json = JSON.parse(res)
  Keycloak::Token.new(
    access_token: json["access_token"],
    expires_in: json["expires_in"],
    refresh_expires_in: json["refresh_expires_in"],
    refresh_token: json["refresh_token"],
    token_type: json["token_type"],
    not_before_policy: json["not-before-policy"],
    session_state: json["session_state"],
    scope: json["scope"]
  )
end

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



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/keycloak.rb', line 123

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 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/keycloak.rb', line 63

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 



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

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 



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/keycloak.rb', line 110

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 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/keycloak.rb', line 136

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 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/keycloak.rb', line 209

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 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/keycloak.rb', line 95

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) 


238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/keycloak.rb', line 238

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 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/keycloak.rb', line 172

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 



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

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 



165
166
167
168
169
170
 
# File 'lib/keycloak.rb', line 165

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 



232
233
234
235
236
 
# File 'lib/keycloak.rb', line 232

def self.
  verify_setup

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

.user_signed_in?(access_token = '') ⇒ Boolean

Returns:

  • (Boolean) 


257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/keycloak.rb', line 257

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