A platform for community discussion. Free, open, simple.
FEATURE: Make OIDC email verification fallback configurable (#44287)
Natalie Tay249309b992e7
diff --git a/db/structure.sql b/db/structure.sqlindex 37c370bc09b..cfd2e30d497 100644--- a/db/structure.sql+++ b/db/structure.sql@@ -25568,6 +25568,7 @@ ALTER TABLE ONLY public.ad_plugin_house_ads_groupsSET search_path TO "$user", public;INSERT INTO "schema_migrations" (version) VALUES+('20261006113418'),('20261005091527'),('20261005091447'),('20261001073226'),diff --git a/plugins/discourse-openid-connect/config/locales/server.en.yml b/plugins/discourse-openid-connect/config/locales/server.en.ymlindex b443e91172e..83ccf4c9eaa 100644--- a/plugins/discourse-openid-connect/config/locales/server.en.yml+++ b/plugins/discourse-openid-connect/config/locales/server.en.yml@@ -19,6 +19,7 @@ en: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_verified_claim_fallback: "Value to use for email_verified when the provider omits the claim."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."openid_connect_use_pkce: "Enable Proof Key for Code Exchange (PKCE) for OpenID Connect authentication."openid_connect_mtls_client_cert: "X.509 client certificate for mTLS client authentication with the OIDC provider. To enable mTLS, {{setting:openid_connect_mtls_client_key}} must also be set."diff --git a/plugins/discourse-openid-connect/config/settings.yml b/plugins/discourse-openid-connect/config/settings.ymlindex e8975170a7c..334855c3859 100644--- a/plugins/discourse-openid-connect/config/settings.yml+++ b/plugins/discourse-openid-connect/config/settings.yml@@ -57,6 +57,9 @@ discourse_openid_connect:openid_connect_match_by_email:default: truearea: "oidc"+ openid_connect_email_verified_claim_fallback:+ default: false+ area: "oidc"openid_connect_email_claim:default: "email"validator: "RegexPresenceValidator"diff --git a/plugins/discourse-openid-connect/db/migrate/20261006113418_preserve_oidc_email_verified_claim_fallback.rb b/plugins/discourse-openid-connect/db/migrate/20261006113418_preserve_oidc_email_verified_claim_fallback.rbnew file mode 100644index 00000000000..ccbb2be9d53--- /dev/null+++ b/plugins/discourse-openid-connect/db/migrate/20261006113418_preserve_oidc_email_verified_claim_fallback.rb@@ -0,0 +1,20 @@+# frozen_string_literal: true++class PreserveOidcEmailVerifiedClaimFallback < ActiveRecord::Migration[8.1]+ def up+ return if !Migration::Helpers.existing_site?++ execute <<~SQL+ INSERT INTO site_settings (name, data_type, value, created_at, updated_at)+ SELECT 'openid_connect_email_verified_claim_fallback', 5, 't', NOW(), NOW()+ WHERE EXISTS (+ SELECT 1 FROM site_settings WHERE name = 'openid_connect_enabled' AND value = 't'+ )+ ON CONFLICT (name) DO NOTHING+ SQL+ end++ def down+ raise ActiveRecord::IrreversibleMigration+ end+enddiff --git a/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb b/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rbindex bad9d79581b..101132b990f 100644--- a/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb+++ b/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb@@ -31,9 +31,8 @@ class OpenIDConnectAuthenticator < Auth::ManagedAuthenticatordef primary_email_verified?(auth)supplied_verified_boolean = auth["extra"]["raw_info"]["email_verified"]- # If the payload includes the email_verified boolean, use it. Otherwise assume trueif supplied_verified_boolean.nil?- true+ SiteSetting.openid_connect_email_verified_claim_fallbackelse# Many providers violate the spec, and send this as a string rather than a booleansupplied_verified_boolean == true ||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.rbindex 94ec256f253..a590f836ac4 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@@ -15,6 +15,7 @@ describe OpenIDConnectAuthenticator do},extra: {raw_info: {+ email_verified: true,email: user.email,name: "John Doe",},@@ -23,12 +24,41 @@ describe OpenIDConnectAuthenticator doendcontext "when email_verified is not supplied" do- # Some IDPs do not supply this information- # In this case we trust that they have verified the address- it "matches the user" do+ before { hash[:extra][:raw_info].delete(:email_verified) }++ it "uses a true fallback to verify the email and match the user" do+ SiteSetting.openid_connect_email_verified_claim_fallback = trueresult = authenticator.after_authenticate(hash)expect(result.user).to eq(user)+ expect(result.email_valid).to eq(true)+ end++ it "uses the default false fallback and does not match the user" do+ result = authenticator.after_authenticate(hash)++ expect(result.user).to be_nil+ expect(result.email_valid).to eq(false)+ end+ end++ context "when the fallback is true and email_verified is supplied" do+ before { SiteSetting.openid_connect_email_verified_claim_fallback = true }++ {+ true => true,+ "true" => true,+ "True" => true,+ false => false,+ "false" => false,+ }.each do |claim, verified|+ it "uses the supplied #{claim.inspect} value instead of the fallback" do+ hash[:extra][:raw_info][:email_verified] = claim+ result = authenticator.after_authenticate(hash)++ expect(result.email_valid).to eq(verified)+ expect(result.user).to eq(verified ? user : nil)+ endendend