Skip to content

A platform for community discussion. Free, open, simple.

FEATURE: Enable group sync for OpenID Connect plugin (#39082)

David Taylor21670341725c
diff --git a/plugins/discourse-openid-connect/config/locales/server.en.yml b/plugins/discourse-openid-connect/config/locales/server.en.yml
index 662476d5064..95872b6f72a 100644
--- a/plugins/discourse-openid-connect/config/locales/server.en.yml
+++ b/plugins/discourse-openid-connect/config/locales/server.en.yml
@@ -15,6 +15,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 `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_match_by_email: "Use email address to match OpenID Connect authentications to existing Discourse user accounts."
openid_connect_use_pkce: "Enable Proof Key for Code Exchange (PKCE) for OpenID Connect authentication."
login:
diff --git a/plugins/discourse-openid-connect/config/settings.yml b/plugins/discourse-openid-connect/config/settings.yml
index 1da076420bc..dbd8c77c340 100644
--- a/plugins/discourse-openid-connect/config/settings.yml
+++ b/plugins/discourse-openid-connect/config/settings.yml
@@ -53,6 +53,9 @@ discourse_openid_connect:
openid_connect_match_by_email:
default: true
area: "oidc"
+ openid_connect_groups_claim:
+ default: ""
+ area: "oidc"
openid_connect_use_pkce:
default: false
area: "oidc"
diff --git a/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb b/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb
index 7bb870a3e07..4dd753452be 100644
--- a/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb
+++ b/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb
@@ -31,6 +31,29 @@ class OpenIDConnectAuthenticator < Auth::ManagedAuthenticator
end
end
+ def provides_groups?
+ SiteSetting.openid_connect_groups_claim.present?
+ end
+
+ def after_authenticate(auth_token, existing_account: nil)
+ result = super
+
+ if provides_groups?
+ claim = SiteSetting.openid_connect_groups_claim
+ groups = auth_token.extra&.dig(:raw_info, claim)
+
+ 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)
+ else
+ oidc_log("groups claim '#{claim}' not found in auth token")
+ end
+ end
+
+ result
+ end
+
def always_update_user_email?
SiteSetting.openid_connect_overrides_email
end
diff --git a/plugins/discourse-openid-connect/spec/lib/openid_connect_authenticator_spec.rb b/plugins/discourse-openid-connect/spec/lib/openid_connect_authenticator_spec.rb
index 7c67246f6dc..517f48cd918 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
@@ -74,6 +74,66 @@ describe OpenIDConnectAuthenticator do
end
end
+ describe "group syncing" do
+ context "when openid_connect_groups_claim is blank" do
+ it "does not provide groups" do
+ expect(authenticator.provides_groups?).to eq(false)
+ end
+
+ it "does not set associated_groups" do
+ hash[:extra][:raw_info][:groups] = %w[group1 group2]
+ result = authenticator.after_authenticate(hash)
+ expect(result.associated_groups).to be_nil
+ end
+ end
+
+ context "when openid_connect_groups_claim is set" do
+ before { SiteSetting.openid_connect_groups_claim = "groups" }
+
+ it "provides groups" do
+ expect(authenticator.provides_groups?).to eq(true)
+ end
+
+ it "extracts groups from the claim" do
+ hash[:extra][:raw_info][:groups] = %w[group1 group2]
+ result = authenticator.after_authenticate(hash)
+ expect(result.associated_groups).to eq(
+ [{ id: "group1", name: "group1" }, { id: "group2", name: "group2" }],
+ )
+ end
+
+ it "handles an empty groups array" do
+ hash[:extra][:raw_info][:groups] = []
+ result = authenticator.after_authenticate(hash)
+ expect(result.associated_groups).to eq([])
+ end
+
+ it "does not set associated_groups when the claim is missing" do
+ result = authenticator.after_authenticate(hash)
+ expect(result.associated_groups).to be_nil
+ end
+
+ it "logs an error when the claim is not an array" do
+ hash[:extra][:raw_info][:groups] = "not_an_array"
+ Rails.logger.expects(:error).with(includes("not an array"))
+ result = authenticator.after_authenticate(hash)
+ expect(result.associated_groups).to be_nil
+ end
+ end
+
+ context "with a custom claim name" do
+ before { SiteSetting.openid_connect_groups_claim = "cognito:groups" }
+
+ it "reads from the correct claim" do
+ hash[:extra][:raw_info]["cognito:groups"] = %w[admins editors]
+ result = authenticator.after_authenticate(hash)
+ expect(result.associated_groups).to eq(
+ [{ id: "admins", name: "admins" }, { id: "editors", name: "editors" }],
+ )
+ end
+ end
+ end
+
describe "discovery document fetching" do
let(:document_url) do
SiteSetting.openid_connect_discovery_document =