Skip to content

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

FEATURE: Allow a custom email claim for OpenID Connect (#44179)

Natalie Tay74c44fbebe39
diff --git a/plugins/discourse-openid-connect/config/locales/server.en.yml b/plugins/discourse-openid-connect/config/locales/server.en.yml
index ea699d84711..e3716f870ea 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 OIDC token that contains the user's groups as an array of strings. 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."
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."
openid_connect_mtls_client_key: "X.509 private key for the mTLS client certificate. To enable mTLS, {{setting:openid_connect_mtls_client_cert}} must also be set."
diff --git a/plugins/discourse-openid-connect/config/settings.yml b/plugins/discourse-openid-connect/config/settings.yml
index cb3092dd856..e8975170a7c 100644
--- a/plugins/discourse-openid-connect/config/settings.yml
+++ b/plugins/discourse-openid-connect/config/settings.yml
@@ -57,6 +57,11 @@ discourse_openid_connect:
openid_connect_match_by_email:
default: true
area: "oidc"
+ openid_connect_email_claim:
+ default: "email"
+ validator: "RegexPresenceValidator"
+ regex_error: "errors.messages.blank"
+ area: "oidc"
openid_connect_groups_claim:
default: ""
area: "oidc"
diff --git a/plugins/discourse-openid-connect/lib/omniauth_open_id_connect.rb b/plugins/discourse-openid-connect/lib/omniauth_open_id_connect.rb
index 62bd9468a91..4568e6b1461 100644
--- a/plugins/discourse-openid-connect/lib/omniauth_open_id_connect.rb
+++ b/plugins/discourse-openid-connect/lib/omniauth_open_id_connect.rb
@@ -25,6 +25,7 @@ module OmniAuth
option :passthrough_authorize_options, [:p]
option :passthrough_token_options, [:p]
option :claims, nil
+ option :email_claim, "email"
option :client_options,
site: nil,
@@ -207,9 +208,10 @@ module OmniAuth
info do
data_source = options.use_userinfo ? userinfo_response : id_token_info
+ email = data_source[options.email_claim]
prune!(
name: data_source["name"],
- email: data_source["email"],
+ email: email.is_a?(String) ? email : nil,
first_name: data_source["given_name"],
last_name: data_source["family_name"],
nickname: data_source["preferred_username"],
diff --git a/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb b/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb
index 603a9716d1b..cfe6500a19e 100644
--- a/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb
+++ b/plugins/discourse-openid-connect/lib/openid_connect_authenticator.rb
@@ -173,6 +173,7 @@ class OpenIDConnectAuthenticator < Auth::ManagedAuthenticator
passthrough_authorize_options:
SiteSetting.openid_connect_authorize_parameters.split("|"),
claims: SiteSetting.openid_connect_claims,
+ email_claim: SiteSetting.openid_connect_email_claim,
pkce: SiteSetting.openid_connect_use_pkce,
pkce_options: {
code_verifier: -> { generate_code_verifier },
diff --git a/plugins/discourse-openid-connect/spec/lib/omniauth_open_id_connect_spec.rb b/plugins/discourse-openid-connect/spec/lib/omniauth_open_id_connect_spec.rb
index 0f69ec54b42..fc1bc4f8da1 100644
--- a/plugins/discourse-openid-connect/spec/lib/omniauth_open_id_connect_spec.rb
+++ b/plugins/discourse-openid-connect/spec/lib/omniauth_open_id_connect_spec.rb
@@ -33,6 +33,47 @@ describe OmniAuth::Strategies::OpenIDConnect do
after { OmniAuth.config.test_mode = false }
+ describe "#info" do
+ let(:userinfo) { { "email" => "[email protected]", "mail" => "[email protected]" } }
+ let(:id_token) { { "email" => "[email protected]", "mail" => "[email protected]" } }
+
+ before do
+ strategy.stubs(:userinfo_response).returns(userinfo)
+ strategy.stubs(:id_token_info).returns(id_token)
+ end
+
+ it "uses the standard email claim by default" do
+ expect(strategy.info[:email]).to eq(userinfo["email"])
+ end
+
+ it "uses the configured claim from UserInfo" do
+ strategy.options.email_claim = "mail"
+
+ expect(strategy.info[:email]).to eq(userinfo["mail"])
+ end
+
+ it "uses the configured claim from the ID token when UserInfo is disabled" do
+ strategy.options.email_claim = "mail"
+ strategy.options.use_userinfo = false
+
+ expect(strategy.info[:email]).to eq(id_token["mail"])
+ end
+
+ it "omits a missing configured claim without falling back to another email" do
+ strategy.options.email_claim = "mail"
+ userinfo.delete("mail")
+
+ expect(strategy.info).not_to have_key(:email)
+ end
+
+ it "omits a non-string email claim" do
+ strategy.options.email_claim = "mail"
+ userinfo["mail"] = ["[email protected]"]
+
+ expect(strategy.info).not_to have_key(:email)
+ end
+ end
+
context "when discovery document is missing" do
let(:discovery_document) { nil }
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 67f81681ec2..fa24ae6b909 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
@@ -203,6 +203,22 @@ describe OpenIDConnectAuthenticator do
end
end
+ describe "#register_middleware" do
+ it "configures the strategy with the selected email claim" do
+ SiteSetting.openid_connect_email_claim = "mail"
+ SiteSetting.openid_connect_discovery_document =
+ "https://id.example.com/.well-known/openid-configuration"
+ stub_request(:get, SiteSetting.openid_connect_discovery_document).to_return(body: "{}")
+ builder = OmniAuth::Builder.new(->(_env) { [200, {}, []] })
+ authenticator.register_middleware(builder)
+ strategy = builder.to_app
+
+ strategy.options.setup.call("omniauth.strategy" => strategy)
+
+ expect(strategy.options.email_claim).to eq("mail")
+ end
+ end
+
describe "#required_settings" do
it "requires a client secret by default" do
expect(authenticator.required_settings).to contain_exactly(
diff --git a/plugins/discourse-openid-connect/spec/models/site_setting_spec.rb b/plugins/discourse-openid-connect/spec/models/site_setting_spec.rb
new file mode 100644
index 00000000000..56c27a079f5
--- /dev/null
+++ b/plugins/discourse-openid-connect/spec/models/site_setting_spec.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+describe SiteSetting do
+ describe "openid_connect_email_claim" do
+ it "rejects empty and whitespace-only claim names" do
+ ["", " \t\n"].each do |value|
+ expect { SiteSetting.openid_connect_email_claim = value }.to raise_error(
+ Discourse::InvalidParameters,
+ )
+ end
+ end
+
+ it "accepts a custom claim name" do
+ SiteSetting.openid_connect_email_claim = "mail"
+
+ expect(SiteSetting.openid_connect_email_claim).to eq("mail")
+ end
+ end
+end