A platform for community discussion. Free, open, simple.
FIX: Allow blank OAuth2 secrets and redact debug credentials (#44049)
Keegan George87b72dd64418
diff --git a/plugins/discourse-oauth2-basic/lib/oauth2_basic_authenticator.rb b/plugins/discourse-oauth2-basic/lib/oauth2_basic_authenticator.rbindex 906b4f0c35c..6ce82ed0f89 100644--- a/plugins/discourse-oauth2-basic/lib/oauth2_basic_authenticator.rb+++ b/plugins/discourse-oauth2-basic/lib/oauth2_basic_authenticator.rb@@ -1,5 +1,7 @@# frozen_string_literal: true+require_relative "oauth2_faraday_formatter"+class OAuth2BasicAuthenticator < Auth::ManagedAuthenticatordef name"oauth2_basic"@@ -10,7 +12,7 @@ class OAuth2BasicAuthenticator < Auth::ManagedAuthenticatorenddef required_settings- %i[oauth2_client_id oauth2_client_secret oauth2_authorize_url oauth2_token_url]+ %i[oauth2_client_id oauth2_authorize_url oauth2_token_url]enddef can_revoke?@@ -200,6 +202,7 @@ class OAuth2BasicAuthenticator < Auth::ManagedAuthenticatordef fetch_user_details(token, id)user_json_url = SiteSetting.oauth2_user_json_url.sub(":token", token.to_s).sub(":id", id.to_s)+ user_json_log_url = OAuth2LogRedactor.url(user_json_url, sensitive_values: [token, id])user_json_method = SiteSetting.oauth2_user_json_url_method.downcase.to_symbearer_token = "Bearer #{token}"@@ -210,9 +213,9 @@ class OAuth2BasicAuthenticator < Auth::ManagedAuthenticatorheaders = { "Authorization" => bearer_token, "Accept" => "application/json" }log <<-LOG- user_json request: #{user_json_method} #{user_json_url}+ user_json request: #{user_json_method} #{user_json_log_url}- request headers: #{headers}+ request headers: #{OAuth2LogRedactor.headers(headers)}LOGbegin@@ -221,7 +224,7 @@ class OAuth2BasicAuthenticator < Auth::ManagedAuthenticatorfailure_detail =e.is_a?(Faraday::TimeoutError) ? "timed out after #{request_timeout_seconds}s" : "failed"Rails.logger.warn(- "OAuth2 Basic: user_json request to #{user_json_url} #{failure_detail}: #{e.class} #{e.message}",+ "OAuth2 Basic: user_json request to #{user_json_log_url} #{failure_detail}: #{e.class}",)return nilend@@ -230,13 +233,13 @@ class OAuth2BasicAuthenticator < Auth::ManagedAuthenticatoruser_json response: #{user_json_response.status}response body:- #{user_json_response.body}+ #{OAuth2LogRedactor::OMITTED}LOGif user_json_response.status == 200user_json = JSON.parse(user_json_response.body)- log("user_json:\n#{user_json.to_yaml}")+ log("user_json parsed successfully")result = {}if user_json.present?@@ -276,16 +279,13 @@ class OAuth2BasicAuthenticator < Auth::ManagedAuthenticatorlog <<-LOGafter_authenticate response:- creds:- #{auth["credentials"].to_hash.to_yaml}+ credentials: #{OAuth2LogRedactor::FILTERED}- uid: #{auth["uid"]}+ uid: #{OAuth2LogRedactor::FILTERED}- info:- #{auth["info"].to_hash.to_yaml}+ info: #{OAuth2LogRedactor::FILTERED}- extra:- #{auth["extra"].to_hash.to_yaml}+ extra: #{OAuth2LogRedactor::FILTERED}LOGif SiteSetting.oauth2_fetch_user_details? && SiteSetting.oauth2_user_json_url.present?diff --git a/plugins/discourse-oauth2-basic/lib/oauth2_faraday_formatter.rb b/plugins/discourse-oauth2-basic/lib/oauth2_faraday_formatter.rbindex f9be55a6225..ac5bada6c6c 100644--- a/plugins/discourse-oauth2-basic/lib/oauth2_faraday_formatter.rb+++ b/plugins/discourse-oauth2-basic/lib/oauth2_faraday_formatter.rb@@ -1,17 +1,66 @@# frozen_string_literal: truerequire "faraday/logging/formatter"+require "uri"++class OAuth2LogRedactor+ FILTERED = "[FILTERED]"+ OMITTED = "[OMITTED]"++ SENSITIVE_NAME_PATTERN = /authorization|cookie|secret|token|password|assertion|api[-_]?key|code/i++ def self.headers(headers)+ headers+ .to_h+ .each_with_object({}) do |(name, value), redacted|+ redacted[name] = sensitive_name?(name) ? FILTERED : value+ end+ end++ def self.url(url, sensitive_values: [])+ uri = URI.parse(url.to_s)+ has_userinfo = uri.userinfo.present?+ uri.userinfo = "FILTERED" if has_userinfo+ uri.fragment = FILTERED if uri.fragment.present?++ if uri.query.present?+ uri.query =+ URI.encode_www_form(+ URI+ .decode_www_form(uri.query)+ .map { |name, value| [name, sensitive_name?(name) ? FILTERED : value] },+ )+ end++ redacted_url = uri.to_s+ redacted_url.sub!("FILTERED@", "#{FILTERED}@") if has_userinfo++ sensitive_values+ .compact_blank+ .reduce(redacted_url) do |redacted, sensitive_value|+ raw_value = sensitive_value.to_s+ encoded_value = URI.encode_www_form_component(raw_value)+ redacted.gsub(raw_value, FILTERED).gsub(encoded_value, FILTERED)+ end+ rescue ArgumentError, URI::Error+ FILTERED+ end++ def self.sensitive_name?(name)+ name.to_s.match?(SENSITIVE_NAME_PATTERN)+ end+endclass OAuth2FaradayFormatter < Faraday::Logging::Formatterdef request(env)warn <<~LOG- OAuth2 Debugging: request #{env.method.upcase} #{env.url}+ OAuth2 Debugging: request #{env.method.upcase} #{OAuth2LogRedactor.url(env.url)}Headers:- #{env.request_headers.to_yaml}+ #{OAuth2LogRedactor.headers(env.request_headers).to_yaml}Body:- #{env[:body].to_yaml}+ #{OAuth2LogRedactor::OMITTED if env[:body].present?}LOGend@@ -19,13 +68,13 @@ class OAuth2FaradayFormatter < Faraday::Logging::Formatterwarn <<~LOGOAuth2 Debugging: response status #{env.status}- From #{env.method.upcase} #{env.url}+ From #{env.method.upcase} #{OAuth2LogRedactor.url(env.url)}Headers:- #{env.request_headers.to_yaml}+ #{OAuth2LogRedactor.headers(env.request_headers).to_yaml}Body:- #{env[:body].to_yaml}+ #{OAuth2LogRedactor::OMITTED if env[:body].present?}LOGendenddiff --git a/plugins/discourse-oauth2-basic/lib/omniauth/strategies/oauth2_basic.rb b/plugins/discourse-oauth2-basic/lib/omniauth/strategies/oauth2_basic.rbindex 0e8d44261b0..8e759847a52 100644--- a/plugins/discourse-oauth2-basic/lib/omniauth/strategies/oauth2_basic.rb+++ b/plugins/discourse-oauth2-basic/lib/omniauth/strategies/oauth2_basic.rb@@ -35,7 +35,7 @@ class OmniAuth::Strategies::Oauth2Basic < ::OmniAuth::Strategies::OAuth2else"failed"end- Rails.logger.warn("OAuth2 Basic: token request #{detail}: #{e.class} #{e.message}")+ Rails.logger.warn("OAuth2 Basic: token request #{detail}: #{e.class}")fail!(:oauth2_basic_request_failed, e)enddiff --git a/plugins/discourse-oauth2-basic/spec/integration/token_request_failure_spec.rb b/plugins/discourse-oauth2-basic/spec/integration/token_request_failure_spec.rbindex cca29f57d8f..ec0c70d52e3 100644--- a/plugins/discourse-oauth2-basic/spec/integration/token_request_failure_spec.rb+++ b/plugins/discourse-oauth2-basic/spec/integration/token_request_failure_spec.rb@@ -1,16 +1,57 @@# frozen_string_literal: true-describe "OAuth2 Basic token request failures" do+describe "OAuth2 Basic token requests" do+ fab!(:user)+before doSiteSetting.oauth2_client_id = "client"- SiteSetting.oauth2_client_secret = "secret"SiteSetting.oauth2_authorize_url = "https://id.example.com/authorize"SiteSetting.oauth2_token_url = "https://id.example.com/token"+ SiteSetting.oauth2_callback_user_id_path = "params.uid"+ SiteSetting.oauth2_callback_user_info_paths = "email:params.email"+ SiteSetting.oauth2_fetch_user_details = false+ SiteSetting.oauth2_email_verified = true+ end++ it "completes authentication with an empty client secret" do+ SiteSetting.oauth2_client_secret = ""SiteSetting.oauth2_enabled = true- stub_request(:post, "https://id.example.com/token").to_timeout++ token_request =+ stub_request(:post, "https://id.example.com/token").with(+ headers: {+ "Authorization" => "Basic #{Base64.strict_encode64("client:")}",+ },+ body: hash_including("client_id" => "client", "client_secret" => "", "code" => "code"),+ ).to_return(+ status: 200,+ body: {+ access_token: "access-token",+ token_type: "Bearer",+ uid: "provider-uid",+ email: user.email,+ }.to_json,+ headers: {+ "Content-Type" => "application/json",+ },+ )++ post "/auth/oauth2_basic"+ expect(response.status).to eq(302)+ expect(response.location).to start_with("https://id.example.com/authorize?")++ post "/auth/oauth2_basic/callback", params: { state: session["omniauth.state"], code: "code" }++ expect(response.status).to eq(302)+ expect(session[:current_user_id]).to eq(user.id)+ expect(token_request).to have_been_requested.onceendit "reports the plugin's own failure when the token request times out" do+ SiteSetting.oauth2_client_secret = "secret"+ SiteSetting.oauth2_enabled = true+ stub_request(:post, "https://id.example.com/token").to_timeout+post "/auth/oauth2_basic"expect(response.status).to eq(302)expect(response.location).to start_with("https://id.example.com/authorize?")@@ -21,4 +62,24 @@ describe "OAuth2 Basic token request failures" do"/auth/failure?message=oauth2_basic_request_failed&strategy=oauth2_basic",)end++ it "does not include provider error details in warning logs" do+ SiteSetting.oauth2_client_secret = "client-secret"+ SiteSetting.oauth2_enabled = true+ provider_error = "provider payload included access-token-value"+ messages = []+ allow(Rails.logger).to receive(:warn) { |message| messages << message }+ stub_request(:post, "https://id.example.com/token").to_raise(+ Faraday::ConnectionFailed.new(provider_error),+ )++ post "/auth/oauth2_basic"+ post "/auth/oauth2_basic/callback", params: { state: session["omniauth.state"], code: "code" }++ expect(response.location).to eq(+ "/auth/failure?message=oauth2_basic_request_failed&strategy=oauth2_basic",+ )+ expect(messages.join).to include("OAuth2 Basic: token request failed:")+ expect(messages.join).not_to include(provider_error, "access-token-value", "client-secret")+ endenddiff --git a/plugins/discourse-oauth2-basic/spec/lib/oauth2_faraday_formatter_spec.rb b/plugins/discourse-oauth2-basic/spec/lib/oauth2_faraday_formatter_spec.rbnew file mode 100644index 00000000000..c732190a200--- /dev/null+++ b/plugins/discourse-oauth2-basic/spec/lib/oauth2_faraday_formatter_spec.rb@@ -0,0 +1,95 @@+# frozen_string_literal: true++RSpec.describe OAuth2FaradayFormatter do+ subject(:formatter) { described_class.new(logger:, options: {}) }++ let(:logger) { instance_double(Logger) }+ let(:messages) { [] }++ before { allow(logger).to receive(:warn) { |message| messages << message } }++ def faraday_env(method:, url:, headers:, body:, status: nil)+ OpenStruct.new(method:, url: URI(url), request_headers: headers, body:, status:)+ end++ it "redacts credentials from request metadata without mutating the request" do+ basic_credentials = "Basic #{Base64.strict_encode64("client:client-secret")}"+ request_body = {+ client_secret: "client-secret",+ code: "authorization-code",+ access_token: "access-token",+ }.to_json+ headers = {+ "Authorization" => basic_credentials,+ "X-Refresh-Token" => "refresh-token",+ "Accept" => "application/json",+ }+ url =+ "https://id.example.com/token?code=authorization-code&client_secret=client-secret&request_id=request-123"+ env = faraday_env(method: :post, url:, headers:, body: request_body)++ formatter.request(env)++ message = messages.join+ expect(message).to include("request_id=request-123", "Accept", "application/json", "[FILTERED]")+ expect(message).not_to include(+ basic_credentials,+ "client-secret",+ "authorization-code",+ "access-token",+ "refresh-token",+ )+ expect(env.url.to_s).to eq(url)+ expect(env.request_headers).to eq(headers)+ expect(env.body).to eq(request_body)+ end++ it "redacts URL userinfo and rejects invalid URLs" do+ url = "https://client:[email protected]/token?request_id=request-123"++ redacted_url = OAuth2LogRedactor.url(url)++ expect(redacted_url).to eq("https://[FILTERED]@id.example.com/token?request_id=request-123")+ expect(redacted_url).not_to include("client", "secret")+ expect(OAuth2LogRedactor.url("https://invalid.example.com/%zz")).to eq("[FILTERED]")+ end++ it "omits JSON, form-encoded, and malformed response bodies and redacts bearer credentials" do+ bearer_credentials = "Bearer access-token"+ response_bodies = [+ {+ access_token: "access-token",+ refresh_token: "refresh-token",+ id_token: "id-token",+ }.to_json,+ URI.encode_www_form(access_token: "access-token", refresh_token: "refresh-token"),+ "malformed access-token response",+ ]++ response_bodies.each do |body|+ env =+ faraday_env(+ method: :post,+ url: "https://id.example.com/token?access_token=access-token&request_id=request-123",+ headers: {+ "Authorization" => bearer_credentials,+ "Accept" => "application/json",+ },+ body:,+ status: 200,+ )++ formatter.response(env)+ end++ message = messages.join+ expect(message).to include("response status 200", "request_id=request-123", "[OMITTED]")+ expect(message).not_to include(+ bearer_credentials,+ "access-token",+ "refresh-token",+ "id-token",+ "malformed",+ )+ end+enddiff --git a/plugins/discourse-oauth2-basic/spec/plugin_spec.rb b/plugins/discourse-oauth2-basic/spec/plugin_spec.rbindex 1dbff39858a..05f2d1e5c03 100644--- a/plugins/discourse-oauth2-basic/spec/plugin_spec.rb+++ b/plugins/discourse-oauth2-basic/spec/plugin_spec.rb@@ -1,6 +1,41 @@# frozen_string_literal: truedescribe OAuth2BasicAuthenticator do+ describe "configuration" do+ let(:authenticator) { described_class.new }++ before do+ SiteSetting.oauth2_client_id = "client"+ SiteSetting.oauth2_client_secret = ""+ SiteSetting.oauth2_authorize_url = "https://id.example.com/authorize"+ SiteSetting.oauth2_token_url = "https://id.example.com/token"+ end++ it "allows the provider to be enabled with an empty client secret" do+ SiteSetting.oauth2_enabled = true++ expect(authenticator.required_settings).to eq(+ %i[oauth2_client_id oauth2_authorize_url oauth2_token_url],+ )+ expect(authenticator).to be_configured+ expect(authenticator).to be_enabled+ end++ it "still requires the client ID and endpoint URLs" do+ SiteSetting.oauth2_enabled = true++ authenticator.required_settings.each do |setting|+ value = SiteSetting.public_send(setting)+ SiteSetting.public_send("#{setting}=", "")++ expect(authenticator).not_to be_configured+ expect(authenticator).not_to be_enabled++ SiteSetting.public_send("#{setting}=", value)+ end+ end+ end+describe "after_authenticate" dobefore { SiteSetting.oauth2_user_json_url = "https://provider.com/user" }@@ -436,6 +471,91 @@ describe OAuth2BasicAuthenticator doexpect(result).to eq falseend+ describe "debug logging" do+ let(:authenticator) { described_class.new }+ let(:messages) { [] }++ before do+ SiteSetting.oauth2_debug_auth = true+ allow(Rails.logger).to receive(:warn) { |message| messages << message }+ end++ it "redacts bearer credentials and URL substitutions and omits the user response" do+ access_token = "access-token-value"+ provider_id = "provider-user-id"+ response_secret = "response-client-secret"+ response_email = "[email protected]"+ SiteSetting.oauth2_user_json_url =+ "https://provider.com/users/:id/tokens/:token?access_token=query-token-value&view=profile"+ SiteSetting.oauth2_json_email_path = "account.email"+ response_body = {+ account: {+ email: response_email,+ client_secret: response_secret,+ refresh_token: "response-refresh-token",+ },+ }.to_json+ user_json_url =+ "https://provider.com/users/#{provider_id}/tokens/#{access_token}?access_token=query-token-value&view=profile"+ request =+ stub_request(:get, user_json_url).with(+ headers: {+ "Authorization" => "Bearer #{access_token}",+ },+ ).to_return(status: 200, body: response_body)++ result = authenticator.fetch_user_details(access_token, provider_id)++ expect(result[:email]).to eq(response_email)+ expect(request).to have_been_requested.once+ expect(messages.join).to include("view=profile", "[FILTERED]", "[OMITTED]")+ expect(messages.join).not_to include(+ access_token,+ "query-token-value",+ provider_id,+ response_secret,+ response_email,+ "response-refresh-token",+ )+ end++ it "redacts credentials, identity information, and extra authentication data" do+ auth =+ OmniAuth::AuthHash.new(+ "provider" => "oauth2_basic",+ "credentials" => {+ "token" => "access-token-value",+ "refresh_token" => "refresh-token-value",+ },+ "uid" => "provider-user-id",+ "info" => {+ "name" => "Private Name",+ "email" => "[email protected]",+ },+ "extra" => {+ "id_token" => "id-token-value",+ },+ )+ original_auth = auth.deep_dup+ SiteSetting.oauth2_callback_user_id_path = "uid"+ SiteSetting.oauth2_fetch_user_details = false+ SiteSetting.oauth2_email_verified = true++ authenticator.after_authenticate(auth)++ expect(messages.join).to include("after_authenticate response", "[FILTERED]")+ expect(messages.join).not_to include(+ "access-token-value",+ "refresh-token-value",+ "provider-user-id",+ "Private Name",+ "[email protected]",+ "id-token-value",+ )+ expect(auth).to eq(original_auth)+ end+ end+describe "token_callback" dolet(:user) { Fabricate(:user) }let(:strategy) { OmniAuth::Strategies::Oauth2Basic.new({}) }