A platform for community discussion. Free, open, simple.
FEATURE: Support comma-separated OIDC group claims (#44198)
Natalie Tayf4114a2811bb
diff --git a/plugins/discourse-openid-connect/config/locales/server.en.yml b/plugins/discourse-openid-connect/config/locales/server.en.ymlindex e3716f870ea..b443e91172e 100644--- a/plugins/discourse-openid-connect/config/locales/server.en.yml+++ b/plugins/discourse-openid-connect/config/locales/server.en.yml@@ -16,7 +16,7 @@ en:openid_connect_authorize_parameters: "URL parameters which will be included in the redirect from /auth/oidc to the IDP's authorize endpoint"openid_connect_overrides_email: "On every login, override the user's email using the openid-connect value. Works the same as the {{setting:auth_overrides_email}} setting, but is specific to OpenID Connect logins."openid_connect_claims: "Explicitly define the claims for use with providers that don't pass data back based on scopes. (JSON)"- openid_connect_groups_claim: "The name of the claim in the OIDC token that contains the user's groups as an array of strings. Leave blank to disable group syncing."+ openid_connect_groups_claim: "The name of the claim in the userinfo response or ID token that contains the user's groups as an array of strings or a comma-separated string. For string values, surrounding whitespace and empty entries are ignored. Use an array if group names contain commas. Leave blank to disable group syncing."openid_connect_user_field_mappings: "Map OIDC claims onto Discourse user fields. Each entry pairs an OIDC claim name with the numeric ID of a Discourse user field."openid_connect_match_by_email: "Use email address to match OpenID Connect authentications to existing Discourse user accounts."openid_connect_email_claim: "The claim containing the user's email address. Defaults to email. Only select a claim containing an email address verified by your identity provider, as it can link users to existing accounts."diff --git a/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb b/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rbindex cfe6500a19e..bad9d79581b 100644--- a/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb+++ b/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb@@ -53,11 +53,12 @@ class OpenIDConnectAuthenticator < Auth::ManagedAuthenticatorresult.associated_groups = []groups =auth_token.extra&.dig(:raw_info, claim) || auth_token.extra&.dig(:id_token_info, claim)+ groups = groups.split(",").map(&:strip).reject(&:empty?) if groups.is_a?(String)if groups.is_a?(Array)result.associated_groups = groups.map { |group_name| { id: group_name, name: group_name } }elsif groups.present?- oidc_log("groups claim '#{claim}' is not an array: #{groups.class}", error: true)+ oidc_log("groups claim '#{claim}' is not an array or string: #{groups.class}", error: true)elseoidc_log("groups claim '#{claim}' not found in auth token")enddiff --git a/plugins/discourse-openid-connect/spec/lib/openid_connect_authenticator_spec.rb b/plugins/discourse-openid-connect/spec/lib/openid_connect_authenticator_spec.rbindex fa24ae6b909..94ec256f253 100644--- a/plugins/discourse-openid-connect/spec/lib/openid_connect_authenticator_spec.rb+++ b/plugins/discourse-openid-connect/spec/lib/openid_connect_authenticator_spec.rb@@ -113,8 +113,73 @@ describe OpenIDConnectAuthenticator doexpect(result.associated_groups).to eq([])end- it "logs an error and clears groups when the claim is not an array" do- hash[:extra][:raw_info][:groups] = "not_an_array"+ it "extracts groups from comma-separated strings, ignoring whitespace and empty entries" do+ hash[:extra][:raw_info][:groups] = " group1, ,group2, "+ result = authenticator.after_authenticate(hash)+ expect(result.associated_groups).to eq(+ [{ id: "group1", name: "group1" }, { id: "group2", name: "group2" }],+ )+ end++ it "preserves commas in array entries" do+ hash[:extra][:raw_info][:groups] = ["group1,group2"]+ result = authenticator.after_authenticate(hash)+ expect(result.associated_groups).to eq([{ id: "group1,group2", name: "group1,group2" }])+ end++ it "extracts a string claim from the id_token" do+ hash[:extra][:id_token_info] = { "groups" => "group1,group2" }+ result = authenticator.after_authenticate(hash)+ expect(result.associated_groups).to eq(+ [{ id: "group1", name: "group1" }, { id: "group2", name: "group2" }],+ )+ end++ it "treats blank strings as empty groups lists without falling back to the id_token" do+ hash[:extra][:id_token_info] = { "groups" => ["group1"] }++ ["", " ", ", ,"].each do |claim|+ hash[:extra][:raw_info][:groups] = claim+ expect(authenticator.after_authenticate(hash).associated_groups).to eq([])+ end+ end++ it "syncs memberships as a string claim loses groups" do+ SiteSetting.openid_connect_discovery_document =+ "https://example.com/.well-known/openid-configuration"+ SiteSetting.openid_connect_client_id = "client_id"+ SiteSetting.openid_connect_client_secret = "client_secret"+ SiteSetting.openid_connect_enabled = true+ groups =+ %w[group1 group2].map do |name|+ group = Fabricate(:group)+ associated_group =+ Fabricate(:associated_group, name: name, provider_id: name, provider_name: "oidc")+ GroupAssociatedGroup.create!(group: group, associated_group: associated_group)+ group+ end++ hash[:extra][:raw_info][:groups] = "group1,group2"+ result = authenticator.after_authenticate(hash)+ result.authenticator_name = authenticator.name+ result.apply_associated_attributes!+ expect(user.groups.where(automatic: false)).to contain_exactly(*groups)++ hash[:extra][:raw_info][:groups] = "group2"+ result = authenticator.after_authenticate(hash)+ result.authenticator_name = authenticator.name+ result.apply_associated_attributes!+ expect(user.groups.where(automatic: false)).to contain_exactly(groups.last)++ hash[:extra][:raw_info][:groups] = ""+ result = authenticator.after_authenticate(hash)+ result.authenticator_name = authenticator.name+ result.apply_associated_attributes!+ expect(user.groups.where(automatic: false)).to be_empty+ end++ it "logs an error and clears groups when the claim is not an array or string" do+ hash[:extra][:raw_info][:groups] = 123Rails.logger.expects(:error).with(includes("not an array"))result = authenticator.after_authenticate(hash)expect(result.associated_groups).to eq([])