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

[#65747] Make SCIM /Schemas reflect real behavior.

Pavel Balashou061592af7d5f
diff --git a/app/controllers/scim_v2/base_controller_actions.rb b/app/controllers/scim_v2/base_controller_actions.rb
index e343384665b..01b3448478c 100644
--- a/app/controllers/scim_v2/base_controller_actions.rb
+++ b/app/controllers/scim_v2/base_controller_actions.rb
@@ -92,15 +92,13 @@ module ScimV2
def raise_result_errors_for_scim(result)
result.on_failure do |result|
- uniqueness_error = result.errors.find { |e| e.type == :taken }
- unauthorized_error = result.errors.find { |e| e.type == :error_unauthorized }
- if uniqueness_error.present?
+ if uniqueness_error?(result)
raise Scimitar::ErrorResponse.new(
status: 409,
scimType: "uniqueness",
detail: "Operation failed due to a uniqueness constraint: #{result.message}"
)
- elsif unauthorized_error.present?
+ elsif authorization_error?(result)
raise Scimitar::ErrorResponse.new(
status: 403,
detail: "Action forbidden: insufficient permissions."
@@ -110,6 +108,14 @@ module ScimV2
end
end
end
+
+ def uniqueness_error?(result)
+ result.errors.any? { |e| e.type == :taken }
+ end
+
+ def authorization_error?(result)
+ result.errors.any? { |e| e.type == :error_unauthorized }
+ end
end
end
end
diff --git a/lib/scimitar_schema_extension.rb b/lib/scimitar_schema_extension.rb
index 66620f142a1..93b43ddc96b 100644
--- a/lib/scimitar_schema_extension.rb
+++ b/lib/scimitar_schema_extension.rb
@@ -31,8 +31,14 @@
class OpenProjectNameSchema < Scimitar::Schema::Base
def self.scim_attributes
@scim_attributes ||= [
- Scimitar::Schema::Attribute.new(name: "familyName", caseExact: true, type: "string", required: true),
- Scimitar::Schema::Attribute.new(name: "givenName", caseExact: true, type: "string", required: true)
+ Scimitar::Schema::Attribute.new(name: "familyName",
+ caseExact: false,
+ type: "string",
+ required: true),
+ Scimitar::Schema::Attribute.new(name: "givenName",
+ caseExact: false,
+ type: "string",
+ required: true)
]
end
end
@@ -45,10 +51,23 @@ module ScimitarSchemaExtension
module Group
def scim_attributes
[
- Scimitar::Schema::Attribute.new(name: "displayName", caseExact: true, type: "string", required: true),
- Scimitar::Schema::Attribute.new(name: "members", multiValued: true, complexType: Scimitar::ComplexTypes::ReferenceMember,
+ Scimitar::Schema::Attribute.new(name: "displayName",
+ type: "string",
+ required: true),
+ Scimitar::Schema::Attribute.new(name: "members",
+ multiValued: true,
+ complexType: Scimitar::ComplexTypes::ReferenceMember,
mutability: "readWrite"),
- Scimitar::Schema::Attribute.new(name: "externalId", type: "string", caseExact: true, required: true)
+ Scimitar::Schema::Attribute.new(name: "externalId",
+ type: "string",
+ uniqueness: "server",
+ caseExact: true,
+ required: true),
+ Scimitar::Schema::Attribute.new(name: "id",
+ caseExact: true,
+ type: "string",
+ uniqueness: "server",
+ mutability: "readOnly")
]
end
end
@@ -56,14 +75,33 @@ module ScimitarSchemaExtension
module User
def scim_attributes
[
- Scimitar::Schema::Attribute.new(name: "userName", caseExact: true, type: "string", uniqueness: "server", required: true),
- Scimitar::Schema::Attribute.new(name: "name", caseExact: true, complexType: OpenProjectNameComplexType, required: true),
- Scimitar::Schema::Attribute.new(name: "active", type: "boolean"),
- Scimitar::Schema::Attribute.new(name: "emails", multiValued: true, complexType: Scimitar::ComplexTypes::Email,
+ Scimitar::Schema::Attribute.new(name: "userName",
+ type: "string",
+ uniqueness: "server",
+ required: true),
+ Scimitar::Schema::Attribute.new(name: "name",
+ complexType: OpenProjectNameComplexType,
required: true),
- Scimitar::Schema::Attribute.new(name: "groups", multiValued: true, complexType: Scimitar::ComplexTypes::ReferenceGroup,
+ Scimitar::Schema::Attribute.new(name: "active",
+ type: "boolean"),
+ Scimitar::Schema::Attribute.new(name: "emails",
+ multiValued: true,
+ complexType: Scimitar::ComplexTypes::Email,
+ required: true),
+ Scimitar::Schema::Attribute.new(name: "groups",
+ multiValued: true,
+ complexType: Scimitar::ComplexTypes::ReferenceGroup,
mutability: "readOnly"),
- Scimitar::Schema::Attribute.new(name: "externalId", type: "string", caseExact: true, required: true)
+ Scimitar::Schema::Attribute.new(name: "externalId",
+ type: "string",
+ uniqueness: "server",
+ caseExact: true,
+ required: true),
+ Scimitar::Schema::Attribute.new(name: "id",
+ caseExact: true,
+ type: "string",
+ uniqueness: "server",
+ mutability: "readOnly")
]
end
end
diff --git a/spec/requests/scim_v2/schemas_spec.rb b/spec/requests/scim_v2/schemas_spec.rb
index ffd097fb85a..f098543d663 100644
--- a/spec/requests/scim_v2/schemas_spec.rb
+++ b/spec/requests/scim_v2/schemas_spec.rb
@@ -42,7 +42,6 @@ RSpec.describe "SCIM API Schemas", with_ee: [:scim_api] do
describe "GET /scim_v2/Schemas" do
context "with the feature flag enabled", with_flag: { scim_api: true } do
- # rubocop:disable Layout/LineLength
it "responds with supported schemas" do
get "/scim_v2/Schemas", {}, headers
@@ -59,7 +58,14 @@ RSpec.describe "SCIM API Schemas", with_ee: [:scim_api] do
"meta" => { "resourceType" => "Schema",
"location" => "http://test.host/scim_v2/Schemas?name=urn%3Aietf%3Aparams%3Ascim%3Aschemas%3Acore%3A2.0%3AGroup" },
"attributes" => [
- { "multiValued" => false, "required" => true, "caseExact" => true, "mutability" => "readWrite", "uniqueness" => "none", "returned" => "default", "name" => "displayName", "type" => "string" },
+ { "multiValued" => false,
+ "required" => true,
+ "caseExact" => false,
+ "mutability" => "readWrite",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "displayName",
+ "type" => "string" },
{ "multiValued" => true,
"required" => false,
"caseExact" => false,
@@ -68,12 +74,47 @@ RSpec.describe "SCIM API Schemas", with_ee: [:scim_api] do
"returned" => "default",
"type" => "complex",
"subAttributes" => [
- { "multiValued" => false, "required" => true, "caseExact" => false, "mutability" => "immutable", "uniqueness" => "none", "returned" => "default", "name" => "value", "type" => "string" },
- { "multiValued" => false, "required" => false, "caseExact" => false, "mutability" => "immutable", "uniqueness" => "none", "returned" => "default", "name" => "type", "type" => "string" },
- { "multiValued" => false, "required" => false, "caseExact" => false, "mutability" => "immutable", "uniqueness" => "none", "returned" => "default", "name" => "display", "type" => "string" }
+ { "multiValued" => false,
+ "required" => true,
+ "caseExact" => false,
+ "mutability" => "immutable",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "value",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => false,
+ "mutability" => "immutable",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "type",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => false,
+ "mutability" => "immutable",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "display", "type" => "string" }
],
"name" => "members" },
- { "multiValued" => false, "required" => true, "caseExact" => true, "mutability" => "readWrite", "uniqueness" => "none", "returned" => "default", "name" => "externalId", "type" => "string" }
+ { "multiValued" => false,
+ "required" => true,
+ "caseExact" => true,
+ "mutability" => "readWrite",
+ "uniqueness" => "server",
+ "returned" => "default",
+ "name" => "externalId",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => true,
+ "mutability" => "readOnly",
+ "uniqueness" => "server",
+ "returned" => "default",
+ "name" => "id",
+ "type" => "string" }
]
)
expect(user_schema).to eq(
@@ -83,20 +124,48 @@ RSpec.describe "SCIM API Schemas", with_ee: [:scim_api] do
"meta" => { "resourceType" => "Schema",
"location" => "http://test.host/scim_v2/Schemas?name=urn%3Aietf%3Aparams%3Ascim%3Aschemas%3Acore%3A2.0%3AUser" },
"attributes" => [
- { "multiValued" => false, "required" => true, "caseExact" => true, "mutability" => "readWrite", "uniqueness" => "server", "returned" => "default", "name" => "userName", "type" => "string" },
{ "multiValued" => false,
"required" => true,
- "caseExact" => true,
+ "caseExact" => false,
+ "mutability" => "readWrite",
+ "uniqueness" => "server",
+ "returned" => "default",
+ "name" => "userName",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => true,
+ "caseExact" => false,
"mutability" => "readWrite",
"uniqueness" => "none",
"returned" => "default",
"type" => "complex",
"subAttributes" => [
- { "multiValued" => false, "required" => true, "caseExact" => true, "mutability" => "readWrite", "uniqueness" => "none", "returned" => "default", "name" => "familyName", "type" => "string" },
- { "multiValued" => false, "required" => true, "caseExact" => true, "mutability" => "readWrite", "uniqueness" => "none", "returned" => "default", "name" => "givenName", "type" => "string" }
+ { "multiValued" => false,
+ "required" => true,
+ "caseExact" => false,
+ "mutability" => "readWrite",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "familyName",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => true,
+ "caseExact" => false,
+ "mutability" => "readWrite",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "givenName",
+ "type" => "string" }
],
"name" => "name" },
- { "multiValued" => false, "required" => false, "caseExact" => false, "mutability" => "readWrite", "uniqueness" => "none", "returned" => "default", "name" => "active", "type" => "boolean" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => false,
+ "mutability" => "readWrite",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "active",
+ "type" => "boolean" },
{ "multiValued" => true,
"required" => true,
"caseExact" => false,
@@ -105,10 +174,38 @@ RSpec.describe "SCIM API Schemas", with_ee: [:scim_api] do
"returned" => "default",
"type" => "complex",
"subAttributes" => [
- { "multiValued" => false, "required" => true, "caseExact" => false, "mutability" => "readWrite", "uniqueness" => "none", "returned" => "default", "name" => "value", "type" => "string" },
- { "multiValued" => false, "required" => false, "caseExact" => false, "mutability" => "readOnly", "uniqueness" => "none", "returned" => "default", "name" => "display", "type" => "string" },
- { "multiValued" => false, "required" => false, "caseExact" => false, "mutability" => "readWrite", "uniqueness" => "none", "returned" => "default", "name" => "type", "type" => "string" },
- { "multiValued" => false, "required" => false, "caseExact" => false, "mutability" => "readWrite", "uniqueness" => "none", "returned" => "default", "name" => "primary", "type" => "boolean" }
+ { "multiValued" => false,
+ "required" => true,
+ "caseExact" => false,
+ "mutability" => "readWrite",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "value",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => false,
+ "mutability" => "readOnly",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "display",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => false,
+ "mutability" => "readWrite",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "type",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => false,
+ "mutability" => "readWrite",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "primary",
+ "type" => "boolean" }
],
"name" => "emails" },
{ "multiValued" => true,
@@ -119,16 +216,51 @@ RSpec.describe "SCIM API Schemas", with_ee: [:scim_api] do
"returned" => "default",
"type" => "complex",
"subAttributes" => [
- { "multiValued" => false, "required" => true, "caseExact" => false, "mutability" => "readOnly", "uniqueness" => "none", "returned" => "default", "name" => "value", "type" => "string" },
- { "multiValued" => false, "required" => false, "caseExact" => false, "mutability" => "readOnly", "uniqueness" => "none", "returned" => "default", "name" => "display", "type" => "string" },
- { "multiValued" => false, "required" => false, "caseExact" => false, "mutability" => "readOnly", "uniqueness" => "none", "returned" => "default", "name" => "type", "type" => "string" }
+ { "multiValued" => false,
+ "required" => true,
+ "caseExact" => false,
+ "mutability" => "readOnly",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "value",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => false,
+ "mutability" => "readOnly",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "display",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => false,
+ "mutability" => "readOnly",
+ "uniqueness" => "none",
+ "returned" => "default",
+ "name" => "type",
+ "type" => "string" }
],
"name" => "groups" },
- { "multiValued" => false, "required" => true, "caseExact" => true, "mutability" => "readWrite", "uniqueness" => "none", "returned" => "default", "name" => "externalId", "type" => "string" }
+ { "multiValued" => false,
+ "required" => true,
+ "caseExact" => true,
+ "mutability" => "readWrite",
+ "uniqueness" => "server",
+ "returned" => "default",
+ "name" => "externalId",
+ "type" => "string" },
+ { "multiValued" => false,
+ "required" => false,
+ "caseExact" => true,
+ "mutability" => "readOnly",
+ "uniqueness" => "server",
+ "returned" => "default",
+ "name" => "id",
+ "type" => "string" }
]
)
end
- # rubocop:enable Layout/LineLength
end
context "with the feature flag disabled", with_flag: { scim_api: false } do
diff --git a/spec/requests/scim_v2/users_spec.rb b/spec/requests/scim_v2/users_spec.rb
index 12eec2793d3..10d9b0096dd 100644
--- a/spec/requests/scim_v2/users_spec.rb
+++ b/spec/requests/scim_v2/users_spec.rb
@@ -93,30 +93,37 @@ RSpec.describe "SCIM API Users", with_ee: [:scim_api] do
"totalResults" => 4)
end
- it "filters results by familyName" do
- filter_with_existing_rows = ERB::Util.url_encode("familyName Eq \"#{user.lastname}\"")
+ it "filters results by familyName case-insensitively" do
+ expected_body = { "Resources" => [{ "active" => true,
+ "emails" => [{ "primary" => true,
+ "type" => "work",
+ "value" => user.mail }],
+ "externalId" => external_user_id,
+ "groups" => [{ "value" => group.id.to_s }],
+ "id" => user.id.to_s,
+ "meta" => { "created" => user.created_at.iso8601,
+ "lastModified" => user.updated_at.iso8601,
+ "location" => "http://test.host/scim_v2/Users/#{user.id}",
+ "resourceType" => "User" },
+ "name" => { "familyName" => user.lastname,
+ "givenName" => user.firstname },
+ "schemas" => ["urn:ietf:params:scim:schemas:core:2.0:User"],
+ "userName" => user.login }],
+ "itemsPerPage" => 100,
+ "schemas" => ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
+ "startIndex" => 1,
+ "totalResults" => 1 }
+ filter_with_existing_rows = ERB::Util.url_encode("familyName Eq \"#{user.lastname.upcase}\"")
get "/scim_v2/Users?filter=#{filter_with_existing_rows}", {}, headers
response_body = JSON.parse(last_response.body)
- expect(response_body).to eq("Resources" => [{ "active" => true,
- "emails" => [{ "primary" => true,
- "type" => "work",
- "value" => user.mail }],
- "externalId" => external_user_id,
- "groups" => [{ "value" => group.id.to_s }],
- "id" => user.id.to_s,
- "meta" => { "created" => user.created_at.iso8601,
- "lastModified" => user.updated_at.iso8601,
- "location" => "http://test.host/scim_v2/Users/#{user.id}",
- "resourceType" => "User" },
- "name" => { "familyName" => user.lastname,
- "givenName" => user.firstname },
- "schemas" => ["urn:ietf:params:scim:schemas:core:2.0:User"],
- "userName" => user.login }],
- "itemsPerPage" => 100,
- "schemas" => ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
- "startIndex" => 1,
- "totalResults" => 1)
+ expect(response_body).to eq(expected_body)
+
+ filter_with_existing_rows = ERB::Util.url_encode("familyName Eq \"#{user.lastname.downcase}\"")
+ get "/scim_v2/Users?filter=#{filter_with_existing_rows}", {}, headers
+
+ response_body = JSON.parse(last_response.body)
+ expect(response_body).to eq(expected_body)
filter_with_nonexisting_rows = ERB::Util.url_encode('familyName Eq "NONEXISTENT USER LASTNAME"')
get "/scim_v2/Users?filter=#{filter_with_nonexisting_rows}", {}, headers
@@ -129,7 +136,7 @@ RSpec.describe "SCIM API Users", with_ee: [:scim_api] do
"totalResults" => 0)
end
- it "filters results by externalId" do
+ it "filters results by externalId case-sesitively" do
filter_with_existing_rows = ERB::Util.url_encode("externalId Eq \"#{external_user_id}\"")
get "/scim_v2/Users?filter=#{filter_with_existing_rows}", {}, headers
@@ -154,7 +161,7 @@ RSpec.describe "SCIM API Users", with_ee: [:scim_api] do
"startIndex" => 1,
"totalResults" => 1)
- filter_with_nonexisting_rows = ERB::Util.url_encode('externalId Eq "NONEXISTENT EXTERNAL ID"')
+ filter_with_nonexisting_rows = ERB::Util.url_encode("externalId Eq \"#{external_user_id.upcase}\"")
get "/scim_v2/Users?filter=#{filter_with_nonexisting_rows}", {}, headers
response_body = JSON.parse(last_response.body)
@@ -262,7 +269,7 @@ RSpec.describe "SCIM API Users", with_ee: [:scim_api] do
request_body = {
"schemas" => ["urn:ietf:params:scim:schemas:core:2.0:User"],
"externalId" => external_user_id,
- "userName" => user.login,
+ "userName" => "NewUserName",
"name" => {
"givenName" => "John",
"familyName" => "Doe"
@@ -288,7 +295,7 @@ RSpec.describe "SCIM API Users", with_ee: [:scim_api] do
request_body = {
"schemas" => ["urn:ietf:params:scim:schemas:core:2.0:User"],
"externalId" => external_user_id,
- "userName" => user.login,
+ "userName" => "NewUserName",
"name" => {
"givenName" => "John"
},