Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

[#65855] Fix group membership management for Keycloak SCIM plugin.

Pavel Balashou89ada61e151c
diff --git a/app/controllers/scim_v2/groups_controller.rb b/app/controllers/scim_v2/groups_controller.rb
index 685a10cb928..2aa488c9691 100644
--- a/app/controllers/scim_v2/groups_controller.rb
+++ b/app/controllers/scim_v2/groups_controller.rb
@@ -32,6 +32,8 @@ module ScimV2
class GroupsController < Scimitar::ResourcesController
include BaseControllerActions
+ before_action :remove_breaking_fields_from_params, only: %i[create replace]
+
def create
super do |scim_resource|
storage_class.transaction do
@@ -67,7 +69,7 @@ module ScimV2
raise_result_errors_for_scim(
Groups::UpdateService
.new(user: User.current, model: group)
- .call(user_ids: scim_resource.members.map(&:value))
+ .call(user_ids: scim_resource.members&.map(&:value))
)
group.reload
group.to_scim(
@@ -121,5 +123,20 @@ module ScimV2
.includes(:users, :user_auth_provider_links)
.not_builtin
end
+
+ private
+
+ # There is a bug in scimitar gem.
+ # When "$ref" sub-attribute is present then scim_reosource cannot be intialized
+ # Firstly it fails because $ref is not part of the schema.
+ # Secondly if it has been added to the schema then "$ref" cannot be a parameter for `attr_accessor` call.
+ # Hopefully helpful code links:
+ # 1. https://github.com/pond/scimitar/blob/09b284778340ee067df9e5140d0230386afb9992/app/controllers/scimitar/resources_controller.rb#L176C25-L176C38
+ # 2. https://github.com/pond/scimitar/blob/09b284778340ee067df9e5140d0230386afb9992/app/models/scimitar/schema/derived_attributes.rb#L13C13-L13C42
+ #
+ # Therefore, before scimitar accepts "$ref" sub-attributes we just remove them from payload.
+ def remove_breaking_fields_from_params
+ params[:members]&.each { |member| member.delete("$ref") }
+ end
end
end
diff --git a/spec/requests/scim_v2/groups_spec.rb b/spec/requests/scim_v2/groups_spec.rb
index 14c8507fc18..cead0ee0df9 100644
--- a/spec/requests/scim_v2/groups_spec.rb
+++ b/spec/requests/scim_v2/groups_spec.rb
@@ -186,7 +186,8 @@ RSpec.describe "SCIM API Groups", with_ee: [:scim_api] do
user
request_body = { "displayName" => group_name,
"externalId" => external_group_id,
- "members" => [{ "value" => user.id.to_s }],
+ "members" => [{ "value" => user.id.to_s,
+ "$ref" => "/Users/#{user.id}" }],
"schemas" => ["urn:ietf:params:scim:schemas:core:2.0:Group"] }
expect do
post "/scim_v2/Groups/", request_body.to_json, headers
@@ -296,10 +297,14 @@ RSpec.describe "SCIM API Groups", with_ee: [:scim_api] do
describe "PUT /scim_v2/Groups/:id" do
context "with the feature flag enabled", with_flag: { scim_api: true } do
- it "updates specific group by replacing it with newly provided data" do
+ let(:new_external_group_id) { "new_idp_group_id_123asdqwe12345" }
+
+ before do
admin
group
- new_external_group_id = "new_idp_group_id_123asdqwe12345"
+ end
+
+ it "updates specific group by replacing it with newly provided data" do
request_body = {
"schemas" => ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"active" => true,
@@ -325,6 +330,60 @@ RSpec.describe "SCIM API Groups", with_ee: [:scim_api] do
"members" => contain_exactly({ "value" => user.id.to_s }, { "value" => admin.id.to_s }),
"schemas" => ["urn:ietf:params:scim:schemas:core:2.0:Group"])
end
+
+ it "updates members if there is $ref field present for every member(Keycloak plugin adds it for example)" do
+ request_body = {
+ "schemas" => ["urn:ietf:params:scim:schemas:core:2.0:Group"],
+ "externalId" => new_external_group_id,
+ "displayName" => group.name,
+ "members" => [
+ {
+ "value" => user.id.to_s,
+ "$ref" => "/Users/#{user.id}"
+ },
+ {
+ "value" => admin.id.to_s,
+ "$ref" => "/Users/#{admin.id}"
+ }
+ ]
+ }
+
+ put "/scim_v2/Groups/#{group.id}", request_body.to_json, headers
+
+ response_body = JSON.parse(last_response.body)
+ group.reload
+ expect(response_body).to match("displayName" => group.name,
+ "externalId" => new_external_group_id,
+ "id" => group.id.to_s,
+ "meta" => { "location" => "http://test.host/scim_v2/Groups/#{group.id}",
+ "created" => group.created_at.iso8601,
+ "lastModified" => group.updated_at.iso8601,
+ "resourceType" => "Group" },
+ "members" => contain_exactly({ "value" => user.id.to_s }, { "value" => admin.id.to_s }),
+ "schemas" => ["urn:ietf:params:scim:schemas:core:2.0:Group"])
+ end
+
+ it "updates members if there is no members field(Keycloak plugin sends memberless group request like that)" do
+ request_body = {
+ "schemas" => ["urn:ietf:params:scim:schemas:core:2.0:Group"],
+ "externalId" => new_external_group_id,
+ "displayName" => group.name
+ }
+
+ put "/scim_v2/Groups/#{group.id}", request_body.to_json, headers
+
+ response_body = JSON.parse(last_response.body)
+ group.reload
+ expect(response_body).to match("displayName" => group.name,
+ "externalId" => new_external_group_id,
+ "id" => group.id.to_s,
+ "meta" => { "location" => "http://test.host/scim_v2/Groups/#{group.id}",
+ "created" => group.created_at.iso8601,
+ "lastModified" => group.updated_at.iso8601,
+ "resourceType" => "Group" },
+ "members" => [],
+ "schemas" => ["urn:ietf:params:scim:schemas:core:2.0:Group"])
+ end
end
context "with the feature flag disabled", with_flag: { scim_api: false } do
@@ -382,7 +441,8 @@ RSpec.describe "SCIM API Groups", with_ee: [:scim_api] do
"op" => "replace",
"path" => "members",
"value" => [{
- "value" => user2.id.to_s
+ "value" => user2.id.to_s,
+ "$ref" => "/Users/#{user2.id}"
}]
}]
}
diff --git a/spec/requests/scim_v2/schemas_spec.rb b/spec/requests/scim_v2/schemas_spec.rb
index f098543d663..51aff9178b1 100644
--- a/spec/requests/scim_v2/schemas_spec.rb
+++ b/spec/requests/scim_v2/schemas_spec.rb
@@ -96,7 +96,8 @@ RSpec.describe "SCIM API Schemas", with_ee: [:scim_api] do
"mutability" => "immutable",
"uniqueness" => "none",
"returned" => "default",
- "name" => "display", "type" => "string" }
+ "name" => "display",
+ "type" => "string" }
],
"name" => "members" },
{ "multiValued" => false,