Class: CF::UAA::Scim

Inherits:
Object
  • Object
show all
Includes:
Http
Defined in:
lib/uaa/scim.rb

Overview

This class is for apps that need to manage User Accounts, Groups, or OAuth Client Registrations. It provides access to the SCIM endpoints on the UAA. For more information about SCIM – the IETF’s System for Cross-domain Identity Management (formerly known as Simple Cloud Identity Management) – see http://www.simplecloud.info.

The types of objects and links to their schema are as follows:

Naming attributes by type of object:

  • :user is “username”

  • :group is “displayname”

  • :client is “client_id”

Constant Summary

Constants included from Http

Http::FORM_UTF8, Http::JSON_UTF8

Instance Method Summary collapse

Methods included from Http

basic_auth, #logger, #logger=, #set_request_handler, #trace?

Methods included from ProxyOptions

#proxy_options_for

Constructor Details

#initialize(target, auth_header, options = {}) ⇒ Scim

Returns a new instance of Scim.

Parameters:

  • auth_header (String) —

    a string that can be used in an authorization header. For OAuth2 with JWT tokens this would be something like “bearer xxxx.xxxx.xxxx”. The TokenInfo class provides TokenInfo#auth_header for this purpose.

  • options (Hash) (defaults to: {}) —

    can be

    • :symbolize_keys, if true, returned hash keys are symbols.



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/uaa/scim.rb', line 106

def initialize(target, auth_header, options = {})
  @target, @auth_header = target, auth_header
  @key_style = options[:symbolize_keys] ? :downsym : :down
  self.skip_ssl_validation = options[:skip_ssl_validation]
  self.ssl_ca_file = options[:ssl_ca_file]
  self.ssl_cert_store = options[:ssl_cert_store]
  self.http_proxy = options[:http_proxy]
  self.https_proxy = options[:https_proxy]
  @zone = options[:zone]
end

Instance Method Details

#add(type, info) ⇒ Hash

Creates a SCIM resource.

Parameters:

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

  • info (Hash) —

    converted to json and sent to the scim endpoint. For schema of each type of object see CF::UAA::Scim.

Returns:

  • (Hash) —

    contents of the object, including its id and meta-data.



128
129
130
131
132
133
134
 
# File 'lib/uaa/scim.rb', line 128

def add(type, info)
  path, info = type_info(type, :path), force_case(info)
  reply = json_parse_reply(@key_style, *json_post(@target, path, info,
      headers))
  fake_client_id(reply) if type == :client # hide client reply, not quite scim
  reply
end

#all_pages(type, query = {}) ⇒ Array

Collects all pages of entries from a query

Parameters:

  • query (Hash) (defaults to: {}) —

    may contain the following keys:

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

Returns:

  • (Array) —

    results



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

def all_pages(type, query = {})
  query = force_case(query).reject {|k, v| v.nil? }
  query["startindex"], info, rk = 1, [], jkey(:resources)
  while true
    qinfo = query(type, query)
    raise BadResponse unless qinfo[rk]
    return info if qinfo[rk].empty?
    info.concat(qinfo[rk])
    total = qinfo[jkey :totalresults]
    return info unless total && total > info.length
    unless qinfo[jkey :startindex] && qinfo[jkey :itemsperpage]
      raise BadResponse, "incomplete #{type} pagination data from #{@target}"
    end
    query["startindex"] = info.length + 1
  end
end

#change_password(user_id, new_password, old_password = nil) ⇒ Hash

Change password.

  • For a user to change their own password, the token in @auth_header must contain “password.write” scope and the correct old_password must be given.

  • For an admin to set a user’s password, the token in @auth_header must contain “uaa.admin” scope.

Parameters:

  • user_id (String) —

    the CF::UAA::Scim id attribute of the user

Returns:

  • (Hash) —

    success message from server

See Also:



295
296
297
298
299
300
 
# File 'lib/uaa/scim.rb', line 295

def change_password(user_id, new_password, old_password = nil)
  req = {"password" => new_password}
  req["oldPassword"] = old_password if old_password
  json_parse_reply(@key_style, *json_put(@target,
      "#{type_info(:user, :path)}/#{URI.encode(user_id)}/password", req, headers))
end

#change_secret(client_id, new_secret, old_secret = nil) ⇒ Hash

Change client secret.

  • For a client to change its own secret, the token in @auth_header must contain “client.secret” scope and the correct old_secret must be given.

  • For an admin to set a client secret, the token in @auth_header must contain “uaa.admin” scope.

Parameters:

  • client_id (String) —

    the CF::UAA::Scim id attribute of the client

Returns:

  • (Hash) —

    success message from server

See Also:



311
312
313
314
315
316
 
# File 'lib/uaa/scim.rb', line 311

def change_secret(client_id, new_secret, old_secret = nil)
  req = {"secret" => new_secret }
  req["oldSecret"] = old_secret if old_secret
  json_parse_reply(@key_style, *json_put(@target,
      "#{type_info(:client, :path)}/#{URI.encode(client_id)}/secret", req, headers))
end

#delete(type, id) ⇒ nil

Deletes a SCIM resource

Parameters:

  • id (String) —

    the id attribute of the SCIM object

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

Returns:

  • (nil) 


140
141
142
 
# File 'lib/uaa/scim.rb', line 140

def delete(type, id)
  http_delete @target, "#{type_info(type, :path)}/#{URI.encode(id)}", @auth_header, @zone
end

#get(type, id) ⇒ Hash

Get information about a specific object.

Parameters:

  • id (String) —

    the id attribute of the SCIM object

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

Returns:

  • (Hash) —

    contents of the object, including its id and meta-data.



221
222
223
224
225
226
227
 
# File 'lib/uaa/scim.rb', line 221

def get(type, id)
  info = json_get(@target, "#{type_info(type, :path)}/#{URI.encode(id)}",
      @key_style, headers)

  fake_client_id(info) if type == :client # hide client reply, not quite scim
  info
end

#id(type, name) ⇒ String

Convenience method to query for single object by name.

Parameters:

  • name (String) —

    Value of the Scim object’s name attribue. For naming attribute of each type of object see CF::UAA::Scim.

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

Returns:

  • (String) —

    the id attribute of the object



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/uaa/scim.rb', line 269

def id(type, name)
  res = ids(type, name)

  # hide client endpoints that are not scim compatible
  ik, ck = jkey(:id), jkey(:client_id)
  if type == :client && res && res.length > 0 && (res.length > 1 || res[0][ik].nil?)
    cr = res.find { |o| o[ck] && name.casecmp(o[ck]) == 0 }
    return cr[ik] || cr[ck] if cr
  end

  unless res && res.is_a?(Array) && res.length == 1 &&
      res[0].is_a?(Hash) && (id = res[0][jkey :id])
    raise NotFound, "#{name} not found in #{@target}#{type_info(type, :path)}"
  end
  id
end

#ids(type, *names) ⇒ Array

Gets id/name pairs for given names. For naming attribute of each object type see CF::UAA::Scim

Parameters:

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

Returns:

  • (Array) —

    array of name/id hashes for each object found



258
259
260
261
262
 
# File 'lib/uaa/scim.rb', line 258

def ids(type, *names)
  na = type_info(type, :name_attr)
  filter = names.map { |n| "#{na} eq \"#{n}\""}
  all_pages(type, :attributes => "id,#{na}", :filter => filter.join(" or "))
end

#list_group_mappings(start = nil, count = nil) ⇒ Object 



332
333
334
 
# File 'lib/uaa/scim.rb', line 332

def list_group_mappings(start = nil, count = nil)
  json_get(@target, "#{type_info(:group_mapping, :path)}/list?startIndex=#{start}&count=#{count}", @key_style, headers)
end

#map_group(group, is_id, external_group) ⇒ Object 



318
319
320
321
322
323
324
325
 
# File 'lib/uaa/scim.rb', line 318

def map_group(group, is_id, external_group)
  key_name = is_id ? :groupId : :displayName
  request = {key_name => group, :externalGroup => external_group, :schemas => ["urn:scim:schemas:core:1.0"] }
  result = json_parse_reply(@key_style, *json_post(@target,
                                                   "#{type_info(:group_mapping, :path)}", request,
                                                   headers))
  result
end

#name_attr(type) ⇒ String

Convenience method to get the naming attribute, e.g. userName for user, displayName for group, client_id for client.

Parameters:

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

Returns:

  • (String) —

    naming attribute



121
 
# File 'lib/uaa/scim.rb', line 121

def name_attr(type) type_info(type, :name_attr) end

#patch(type, info) ⇒ Hash

Modifies the contents of a SCIM object.

Parameters:

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

  • info (Hash) —

    converted to json and sent to the scim endpoint. For schema of each type of object see CF::UAA::Scim.

Returns:

  • (Hash) —

    contents of the object, including its id and meta-data.

Raises:

  • (ArgumentError) 


165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/uaa/scim.rb', line 165

def patch(type, info)
  path, info = type_info(type, :path), force_case(info)
  ida = type == :client ? 'client_id' : 'id'
  raise ArgumentError, "info must include #{ida}" unless id = info[ida]
  hdrs = headers
  if info && info['meta'] && (etag = info['meta']['version'])
    hdrs.merge!('if-match' => etag)
  end
  reply = json_parse_reply(@key_style,
      *json_patch(@target, "#{path}/#{URI.encode(id)}", info, hdrs))

  # hide client endpoints that are not quite scim compatible
  type == :client && !reply ? get(type, info['client_id']): reply
end

#put(type, info) ⇒ Hash

Replaces the contents of a SCIM object.

Parameters:

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

  • info (Hash) —

    converted to json and sent to the scim endpoint. For schema of each type of object see CF::UAA::Scim.

Returns:

  • (Hash) —

    contents of the object, including its id and meta-data.

Raises:

  • (ArgumentError) 


147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/uaa/scim.rb', line 147

def put(type, info)
  path, info = type_info(type, :path), force_case(info)
  ida = type == :client ? 'client_id' : 'id'
  raise ArgumentError, "info must include #{ida}" unless id = info[ida]
 hdrs = headers
  if info && info['meta'] && (etag = info['meta']['version'])
    hdrs.merge!('if-match' => etag)
  end
  reply = json_parse_reply(@key_style,
      *json_put(@target, "#{path}/#{URI.encode(id)}", info, hdrs))

  # hide client endpoints that are not quite scim compatible
  type == :client && !reply ? get(type, info['client_id']): reply
end

#query(type, query = {}) ⇒ Hash

Gets a set of attributes for each object that matches a given filter.

Parameters:

  • query (Hash) (defaults to: {}) —

    may contain the following keys:

    • attributes: a comma or space separated list of attribute names to be returned for each object that matches the filter. If no attribute list is given, all attributes are returned.

    • filter: a filter to select which objects are returned. See http://www.simplecloud.info/specs/draft-scim-api-01.html#query-resources

    • startIndex: for paged output, start index of requested result set.

    • count: maximum number of results per reply

  • type (Symbol) —

    can be :user, :group, :client, :user_id.

  • info (Hash) —

    converted to json and sent to the scim endpoint. For schema of each type of object see CF::UAA::Scim.

Returns:

  • (Hash) —

    including a resources array of results and pagination data.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/uaa/scim.rb', line 192

def query(type, query = {})
  query = force_case(query).reject {|k, v| v.nil? }
  if attrs = query['attributes']
    attrs = Util.arglist(attrs).map {|a| force_attr(a)}
    query['attributes'] = Util.strlist(attrs, ",")
  end
  qstr = query.empty?? '': "?#{Util.encode_form(query)}"
  info = json_get(@target, "#{type_info(type, :path)}#{qstr}",
      @key_style,  headers)
  unless info.is_a?(Hash) && info[rk = jkey(:resources)].is_a?(Array)

    # hide client endpoints that are not yet scim compatible
    if type == :client && info.is_a?(Hash)
      info = info.each{ |k, v| fake_client_id(v) }.values
      if m = /^client_id\s+eq\s+"([^"]+)"$/i.match(query['filter'])
        idk = jkey(:client_id)
        info = info.select { |c| c[idk].casecmp(m[1]) == 0 }
      end
      return {rk => info}
    end

    raise BadResponse, "invalid reply to #{type} query of #{@target}"
  end
  info
end

#unmap_group(group_id, external_group) ⇒ Object 



327
328
329
330
 
# File 'lib/uaa/scim.rb', line 327

def unmap_group(group_id, external_group)
  http_delete(@target, "#{type_info(:group_mapping, :path)}/id/#{group_id}/#{URI.encode(external_group)}",
                        @auth_header, @zone)
end