Skip to content

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

SECURITY: Prevent free Patreon members from gaining access to All Patrons-mapped groups

Natalie Tay9200ef7ac93e
diff --git a/plugins/discourse-patreon/app/controllers/patreon/patreon_webhook_controller.rb b/plugins/discourse-patreon/app/controllers/patreon/patreon_webhook_controller.rb
index 26c5eb0bf6e..347d5a751ea 100644
--- a/plugins/discourse-patreon/app/controllers/patreon/patreon_webhook_controller.rb
+++ b/plugins/discourse-patreon/app/controllers/patreon/patreon_webhook_controller.rb
@@ -43,6 +43,9 @@ class Patreon::PatreonWebhookController < ApplicationController
adapter = Patreon::ApiVersion.adapter_for_payload(pledge_data)
patreon_id = Patreon::Pledge.get_patreon_id(pledge_data, adapter: adapter)
+ # Preserve the local account link before a revoked pledge loses its cached email.
+ Patreon::Patron.get_local_user(patreon_id)
+
if SiteSetting.patreon_verbose_log
Rails.logger.warn(
"Patreon verbose log for Webhook:\n Event = #{event}\n Id = #{patreon_id}\n Data = #{pledge_data.inspect}",
diff --git a/plugins/discourse-patreon/lib/api_version/v1.rb b/plugins/discourse-patreon/lib/api_version/v1.rb
index 733d16a2862..ddba166a41a 100644
--- a/plugins/discourse-patreon/lib/api_version/v1.rb
+++ b/plugins/discourse-patreon/lib/api_version/v1.rb
@@ -63,13 +63,14 @@ module Patreon
if uris.blank?
Patreon::Pledge.save!([], false, adapter: self)
- return
+ return true
end
is_first_page = true
uris.each do |uri|
pledge_data = Patreon::Api.get(uri)
+ return false unless pledge_data&.dig("data").is_a?(Array)
if pledge_data["links"] && pledge_data["links"]["next"]
next_page_uri = pledge_data["links"]["next"]
@@ -81,6 +82,12 @@ module Patreon
is_first_page = false
end
end
+
+ true
+ end
+
+ def self.replace_pledge_on_create?
+ false
end
def self.extract(pledge_data)
diff --git a/plugins/discourse-patreon/lib/api_version/v2.rb b/plugins/discourse-patreon/lib/api_version/v2.rb
index 7b1637dce21..99878e517a2 100644
--- a/plugins/discourse-patreon/lib/api_version/v2.rb
+++ b/plugins/discourse-patreon/lib/api_version/v2.rb
@@ -74,7 +74,9 @@ module Patreon
loop do
response = Patreon::Api.get(members_data_url(campaign_id, cursor))
- if response.blank? || response["data"].blank?
+ return false unless response&.dig("data").is_a?(Array)
+
+ if response["data"].blank?
Patreon::Pledge.save!([], false, adapter: self) if is_first_page
break
end
@@ -86,6 +88,12 @@ module Patreon
break if cursor.blank?
end
end
+
+ true
+ end
+
+ def self.replace_pledge_on_create?
+ true
end
def self.extract(member_data)
@@ -99,6 +107,7 @@ module Patreon
patron_id = entry["relationships"]["user"]["data"]["id"]
attrs = entry["attributes"]
+ next if %w[active_patron declined_patron].exclude?(attrs["patron_status"])
(entry.dig("relationships", "currently_entitled_tiers", "data") || []).each do |tier|
(reward_users[tier["id"]] ||= []) << patron_id
@@ -106,12 +115,15 @@ module Patreon
pledges[patron_id] = attrs["currently_entitled_amount_cents"]
users[patron_id] = attrs["email"].downcase if attrs["email"].present?
- declines[patron_id] = attrs["last_charge_date"] if attrs["last_charge_status"] ==
- "Declined"
+ if attrs["patron_status"] == "declined_patron" ||
+ attrs["last_charge_status"] == "Declined"
+ declines[patron_id] = attrs["last_charge_date"]
+ end
end
(member_data["included"] || []).each do |entry|
- if entry["type"] == "user" && entry["attributes"]["email"].present?
+ if entry["type"] == "user" && entry["attributes"]["email"].present? &&
+ pledges.key?(entry["id"])
users[entry["id"]] ||= entry["attributes"]["email"].downcase
end
end
@@ -125,7 +137,7 @@ module Patreon
patron_id = rel["user"]["data"]["id"]
(rel.dig("currently_entitled_tiers", "data") || []).each do |tier|
- (reward_users[tier["id"]] || []).reject! { |i| i == patron_id }
+ (reward_users[tier["id"]] || []).reject! { it == patron_id }
end
patron_id
diff --git a/plugins/discourse-patreon/lib/campaign.rb b/plugins/discourse-patreon/lib/campaign.rb
index bd3b257d891..a9276be6685 100644
--- a/plugins/discourse-patreon/lib/campaign.rb
+++ b/plugins/discourse-patreon/lib/campaign.rb
@@ -36,7 +36,7 @@ module Patreon
Patreon.set("rewards", rewards)
- adapter.pull_pledges!(campaign_data)
+ return false unless adapter.pull_pledges!(campaign_data)
pledges = Patreon.get("pledges") || {}
users = Patreon.get("users") || {}
diff --git a/plugins/discourse-patreon/lib/patron.rb b/plugins/discourse-patreon/lib/patron.rb
index 07ce3cfee56..0761a4392c6 100644
--- a/plugins/discourse-patreon/lib/patron.rb
+++ b/plugins/discourse-patreon/lib/patron.rb
@@ -18,8 +18,7 @@ module Patreon
local_users = get_local_users
reward_users = Patreon::RewardUser.all
- declined_users = Patreon::Pledge::Decline.all
- declined_pledges_grace_period_days = SiteSetting.patreon_declined_pledges_grace_period_days
+ declined_users = Patreon::Pledge::Decline.expired
filters.each_pair do |group_id, rewards|
group = Group.find_by(id: group_id)
@@ -28,20 +27,11 @@ module Patreon
patron_ids = rewards.map { |id| reward_users[id] }.compact.flatten.uniq
- next if patron_ids.blank?
-
user_ids =
local_users
.select do |_, patreon_id|
- is_declined = false
- declined_since = declined_users[patreon_id]
-
- if declined_since.present?
- declined_days_count = Time.now.to_date - declined_since.to_date
- is_declined = declined_days_count > declined_pledges_grace_period_days
- end
-
- patreon_id.present? && patron_ids.include?(patreon_id) && !is_declined
+ patreon_id.present? && patron_ids.include?(patreon_id) &&
+ !declined_users.key?(patreon_id)
end
.pluck(0)
@@ -61,24 +51,14 @@ module Patreon
return if user.blank?
reward_users = Patreon::RewardUser.all
- declined_since = Patreon::Pledge::Decline.all[patreon_id]
- declined_pledges_grace_period_days = SiteSetting.patreon_declined_pledges_grace_period_days
- is_member = true
-
- if declined_since.present?
- declined_days_count = Time.now.to_date - declined_since.to_date
- is_member = false if declined_days_count > declined_pledges_grace_period_days
- end
+ declined_users = Patreon::Pledge::Decline.expired
filters.each_pair do |group_id, rewards|
group = Group.find_by(id: group_id)
next if group.blank?
- if is_member
- patron_ids = rewards.map { |id| reward_users[id] }.compact.flatten.uniq
-
- is_member = false if patron_ids.blank? || patron_ids.exclude?(patreon_id)
- end
+ patron_ids = rewards.map { |id| reward_users[id] }.compact.flatten.uniq
+ is_member = patron_ids.include?(patreon_id) && !declined_users.key?(patreon_id)
is_existing_member = GroupUser.exists?(group: group, user: user)
diff --git a/plugins/discourse-patreon/lib/pledge.rb b/plugins/discourse-patreon/lib/pledge.rb
index b9008f91d41..c1a782719cb 100644
--- a/plugins/discourse-patreon/lib/pledge.rb
+++ b/plugins/discourse-patreon/lib/pledge.rb
@@ -3,6 +3,9 @@
module Patreon
class Pledge
def self.create!(data, adapter: ApiVersion.current)
+ if adapter.replace_pledge_on_create? && all.key?(adapter.get_patreon_id(data))
+ delete!(data, adapter: adapter)
+ end
save!([data], true, adapter: adapter)
end
@@ -68,6 +71,14 @@ module Patreon
def self.set(value)
Patreon.set(KEY, value)
end
+
+ def self.expired
+ grace_period_days = SiteSetting.patreon_declined_pledges_grace_period_days
+
+ all.select do |_, declined_since|
+ declined_since.blank? || Time.now.to_date - declined_since.to_date > grace_period_days
+ end
+ end
end
end
end
diff --git a/plugins/discourse-patreon/plugin.rb b/plugins/discourse-patreon/plugin.rb
index 581600598c9..1bdcf172b8e 100644
--- a/plugins/discourse-patreon/plugin.rb
+++ b/plugins/discourse-patreon/plugin.rb
@@ -62,14 +62,8 @@ after_initialize do
if filters.present? && patreon_id.present?
begin
- reward_id =
- Patreon::RewardUser.all.except("0").detect { |_k, v| v.include? patreon_id }&.first
-
- group_ids = filters.select { |_k, v| v.include?(reward_id) || v.include?("0") }.keys
-
- Group.where(id: group_ids).each { |group| group.add user }
-
Patreon::Patron.update_local_user(user, patreon_id, true)
+ Patreon::Patron.sync_groups_by(patreon_id: patreon_id)
rescue => e
Rails.logger.warn(
"Patreon group membership callback failed for new user #{id} with error: #{e}.\n\n #{e.backtrace.join("\n")}",
diff --git a/plugins/discourse-patreon/spec/lib/campaign_spec.rb b/plugins/discourse-patreon/spec/lib/campaign_spec.rb
index a0fbac90c0f..8ac77362e99 100644
--- a/plugins/discourse-patreon/spec/lib/campaign_spec.rb
+++ b/plugins/discourse-patreon/spec/lib/campaign_spec.rb
@@ -4,7 +4,12 @@ require_relative "../spec_helper"
RSpec.describe Patreon::Campaign do
shared_examples "campaign sync" do
- it "updates campaigns and group membership data" do
+ let(:new_users) { Patreon.get("users").values.map { |email| Fabricate(:user, email: email) } }
+ let(:patreon_accounts) do
+ new_users.to_h { |user| [user.custom_fields["patreon_id"], user.email] }
+ end
+
+ it "updates campaigns and group membership data", :aggregate_failures do
expect { described_class.update! }.to change { Group.count }.by(1)
expect(Group.find_by(name: "patrons")).to be_present
@@ -21,14 +26,8 @@ RSpec.describe Patreon::Campaign do
expect(Patreon.get("reward-users")["0"].count).to eq(3)
expect(Patreon.get("filters").count).to eq(1)
- expect {
- Patreon
- .get("users")
- .each do |id, email|
- cf = Fabricate(:user, email: email).custom_fields
- expect(cf["patreon_id"]).to eq(id)
- end
- }.to change { GroupUser.count }.by(3)
+ expect { new_users }.to change { GroupUser.count }.by(1)
+ expect(patreon_accounts).to eq(Patreon.get("users"))
end
end
diff --git a/plugins/discourse-patreon/spec/requests/patreon_access_spec.rb b/plugins/discourse-patreon/spec/requests/patreon_access_spec.rb
new file mode 100644
index 00000000000..469636bf372
--- /dev/null
+++ b/plugins/discourse-patreon/spec/requests/patreon_access_spec.rb
@@ -0,0 +1,449 @@
+# frozen_string_literal: true
+
+require_relative "../spec_helper"
+
+RSpec.describe "Patreon group access", type: :request do
+ fab!(:group)
+ fab!(:category) { Fabricate(:private_category, group: group) }
+ fab!(:topic) { Fabricate(:topic, category: category) }
+ fab!(:private_post) { Fabricate(:post, topic: topic, raw: "Patron-only content") }
+
+ let(:user) { Fabricate(:user, email: "[email protected]") }
+ let(:patreon_id) { "32187" }
+ let(:reward_ids) { ["0"] }
+ let(:tiers) { [] }
+ let(:member_attributes) do
+ {
+ "patron_status" => nil,
+ "currently_entitled_amount_cents" => 0,
+ "last_charge_status" => nil,
+ "last_charge_date" => nil,
+ }
+ end
+ let(:member) do
+ JSON.parse(get_patreon_response("member.json")).deep_merge(
+ "data" => {
+ "attributes" => member_attributes,
+ "relationships" => {
+ "currently_entitled_tiers" => {
+ "data" => tiers,
+ },
+ },
+ },
+ )
+ end
+ let(:campaign_members) { member.merge("data" => [member.fetch("data")]) }
+ let(:event) { "members:create" }
+ let(:webhook_body) { JSON.generate(member) }
+ let(:webhook_headers) do
+ {
+ "X-Patreon-Event" => event,
+ "X-Patreon-Signature" =>
+ OpenSSL::HMAC.hexdigest("MD5", SiteSetting.patreon_webhook_secret, webhook_body),
+ }
+ end
+
+ before do
+ freeze_time Time.utc(2026, 9, 22)
+ SiteSetting.patreon_enabled = true
+ SiteSetting.patreon_api_version = "2"
+ SiteSetting.patreon_webhook_secret = "WEBHOOK SECRET"
+ SiteSetting.patreon_creator_access_token = "access-token"
+ SiteSetting.patreon_creator_refresh_token = "refresh-token"
+ SiteSetting.patreon_declined_pledges_grace_period_days = 7
+ Jobs.run_immediately!
+ Patreon.set("filters", group.id.to_s => reward_ids)
+ Patreon.set("rewards", "0" => { "title" => "All Patrons", "amount_cents" => 0 })
+ end
+
+ shared_examples "denies patron content" do
+ it "denies access to the private topic" do
+ synchronize
+ sign_in(user)
+ get "/t/#{topic.id}.json"
+
+ aggregate_failures do
+ expect(group.users).not_to include(user)
+ expect(response.status).to eq(404)
+ expect(response.body).not_to include(private_post.raw)
+ end
+ end
+ end
+
+ shared_examples "allows patron content" do
+ it "allows access to the private topic" do
+ synchronize
+ sign_in(user)
+ get "/t/#{topic.id}.json"
+
+ aggregate_failures do
+ expect(group.users).to include(user)
+ expect(response.status).to eq(200)
+ expect(response.body).to include(private_post.raw)
+ end
+ end
+ end
+
+ context "when membership arrives through a webhook" do
+ subject(:synchronize) do
+ post "/patreon/webhook", params: webhook_body, headers: webhook_headers
+ expect(response.status).to eq(200)
+ end
+
+ before { user }
+
+ context "when the member is free" do
+ include_examples "denies patron content"
+ end
+
+ context "when the member is a former patron" do
+ let(:member_attributes) { super().merge("patron_status" => "former_patron") }
+
+ include_examples "denies patron content"
+ end
+
+ context "when the member is active with a zero entitlement amount" do
+ let(:member_attributes) { super().merge("patron_status" => "active_patron") }
+
+ include_examples "allows patron content"
+ end
+
+ context "when the patron is linked through OAuth with a different email" do
+ let(:user) { Fabricate(:user) }
+
+ before do
+ Fabricate(
+ :user_associated_account,
+ user: user,
+ provider_name: "patreon",
+ provider_uid: patreon_id,
+ )
+ end
+
+ include_examples "denies patron content"
+ end
+
+ context "when a free member has cached access" do
+ before do
+ group.add(user)
+ Patreon.set("pledges", patreon_id => 0)
+ Patreon.set("users", patreon_id => user.email)
+ Patreon.set("reward-users", "0" => [patreon_id])
+ end
+
+ include_examples "denies patron content"
+ end
+
+ context "when an update ends the patron's entitlement" do
+ let(:event) { "members:update" }
+
+ before do
+ group.add(user)
+ Patreon::Patron.update_local_user(user, patreon_id)
+ Patreon.set("pledges", patreon_id => 250)
+ Patreon.set("users", patreon_id => user.email)
+ Patreon.set("reward-users", "0" => [patreon_id], "999999" => [patreon_id])
+ Patreon.set("rewards", "999999" => { "title" => "Premium", "amount_cents" => 250 })
+ end
+
+ include_examples "denies patron content"
+ end
+
+ context "when another campaign updates the patron's membership" do
+ let(:event) { "members:update" }
+ let(:reward_ids) { ["999998"] }
+ let(:tiers) { [{ "id" => "999999", "type" => "tier" }] }
+ let(:member_attributes) { super().merge("patron_status" => "active_patron") }
+ let(:member) do
+ super().deep_merge(
+ "data" => {
+ "relationships" => {
+ "campaign" => {
+ "data" => {
+ "id" => "another-campaign",
+ "type" => "campaign",
+ },
+ },
+ },
+ },
+ )
+ end
+
+ before do
+ group.add(user)
+ Patreon.set("pledges", patreon_id => 250)
+ Patreon.set("users", patreon_id => user.email)
+ Patreon.set("rewards", "0" => {}, "999998" => {}, "999999" => {})
+ Patreon.set(
+ "reward-users",
+ "0" => [patreon_id],
+ "999998" => [patreon_id],
+ "999999" => [patreon_id],
+ )
+ end
+
+ include_examples "allows patron content"
+ end
+ end
+
+ context "when an API v1 create event is repeated before its reward is cached" do
+ subject(:synchronize) do
+ post "/patreon/webhook", params: webhook_body, headers: webhook_headers
+ expect(response.status).to eq(200)
+ end
+
+ let(:event) { "pledges:create" }
+ let(:webhook_body) { get_patreon_response("v1/pledge.json") }
+
+ before do
+ user
+ post "/patreon/webhook", params: webhook_body, headers: webhook_headers
+ expect(response.status).to eq(200)
+ end
+
+ include_examples "allows patron content"
+ end
+
+ context "when a member creates a Discourse account" do
+ subject(:synchronize) { user }
+
+ before do
+ post "/patreon/webhook", params: webhook_body, headers: webhook_headers
+ expect(response.status).to eq(200)
+ end
+
+ context "when the member is free" do
+ include_examples "denies patron content"
+ end
+
+ context "when the member is active" do
+ let(:member_attributes) { super().merge("patron_status" => "active_patron") }
+
+ include_examples "allows patron content"
+ end
+
+ context "when an active member qualifies for a later group mapping" do
+ let(:member_attributes) { super().merge("patron_status" => "active_patron") }
+ let(:unmatched_group) { Fabricate(:group) }
+
+ before do
+ Patreon.set("filters", unmatched_group.id.to_s => ["999999"], group.id.to_s => ["0"])
+ end
+
+ include_examples "allows patron content"
+ end
+
+ context "when the declined pledge is beyond its grace period" do
+ let(:member_attributes) do
+ super().merge(
+ "patron_status" => "declined_patron",
+ "last_charge_status" => "Declined",
+ "last_charge_date" => "2026-09-14T00:00:00Z",
+ )
+ end
+
+ include_examples "denies patron content"
+ end
+
+ context "when the declined pledge is on the final grace day" do
+ let(:member_attributes) do
+ super().merge(
+ "patron_status" => "declined_patron",
+ "last_charge_status" => "Declined",
+ "last_charge_date" => "2026-09-15T00:00:00Z",
+ )
+ end
+
+ include_examples "allows patron content"
+ end
+
+ context "when the declined pledge has no charge date" do
+ let(:member_attributes) do
+ super().merge("patron_status" => "declined_patron", "last_charge_status" => "Declined")
+ end
+
+ include_examples "denies patron content"
+ end
+
+ context "when the declined status has no charge details" do
+ let(:member_attributes) { super().merge("patron_status" => "declined_patron") }
+
+ include_examples "denies patron content"
+ end
+ end
+
+ context "when the scheduled job refreshes an existing membership" do
+ subject(:synchronize) { Jobs::PatreonSyncPatronsToGroups.new.execute({}) }
+
+ let(:members_status) { 200 }
+ let(:members_response) { JSON.generate(campaign_members) }
+
+ before do
+ group.add(user)
+ Patreon::Patron.update_local_user(user, patreon_id)
+ Patreon.set("pledges", patreon_id => 0)
+ Patreon.set("users", patreon_id => user.email)
+ Patreon.set("reward-users", "0" => [patreon_id])
+
+ stub_request(
+ :get,
+ "https://www.patreon.com#{Patreon::ApiVersion::V2.campaign_data_url}",
+ ).to_return(status: 200, body: get_patreon_response("campaigns.json"))
+ stub_request(
+ :get,
+ "https://www.patreon.com#{Patreon::ApiVersion::V2.members_data_url("0000000")}",
+ ).to_return(status: members_status, body: members_response)
+ end
+
+ context "when the member is free" do
+ include_examples "denies patron content"
+ end
+
+ context "when the campaign has no members" do
+ let(:campaign_members) { super().merge("data" => [], "included" => []) }
+
+ include_examples "denies patron content"
+ end
+
+ context "when the member is active" do
+ let(:member_attributes) { super().merge("patron_status" => "active_patron") }
+
+ include_examples "allows patron content"
+ end
+
+ context "when the declined pledge is beyond its grace period" do
+ let(:member_attributes) do
+ super().merge(
+ "patron_status" => "declined_patron",
+ "last_charge_status" => "Declined",
+ "last_charge_date" => "2026-09-14T00:00:00Z",
+ )
+ end
+
+ include_examples "denies patron content"
+ end
+
+ context "when the active member appears on a later page" do
+ let(:campaign_members) do
+ super().merge(
+ "data" => [
+ member.fetch("data").deep_merge(
+ "id" => "another-member",
+ "relationships" => {
+ "user" => {
+ "data" => {
+ "id" => "another-patron",
+ },
+ },
+ },
+ ),
+ ],
+ "included" => [],
+ "meta" => {
+ "pagination" => {
+ "cursors" => {
+ "next" => "next-page",
+ },
+ },
+ },
+ )
+ end
+ let(:next_page) do
+ member
+ .deep_merge("data" => { "attributes" => { "patron_status" => "active_patron" } })
+ .then { |response| response.merge("data" => [response.fetch("data")]) }
+ end
+
+ before do
+ stub_request(
+ :get,
+ "https://www.patreon.com#{Patreon::ApiVersion::V2.members_data_url("0000000", "next-page")}",
+ ).to_return(status: 200, body: JSON.generate(next_page))
+ end
+
+ include_examples "allows patron content"
+ end
+
+ context "when the provider rejects the access token" do
+ let(:members_status) { 401 }
+ let(:members_response) { "" }
+
+ include_examples "allows patron content"
+ end
+
+ context "when a webhook revokes membership during a later page request" do
+ let(:event) { "members:pledge:delete" }
+ let(:member_attributes) { super().merge("patron_status" => "active_patron") }
+ let(:campaign_members) do
+ super().merge("meta" => { "pagination" => { "cursors" => { "next" => "next-page" } } })
+ end
+ let(:next_page) do
+ {
+ "data" => [
+ member.fetch("data").deep_merge(
+ "id" => "another-member",
+ "attributes" => {
+ "email" => "[email protected]",
+ },
+ "relationships" => {
+ "user" => {
+ "data" => {
+ "id" => "another-patron",
+ },
+ },
+ },
+ ),
+ ],
+ }
+ end
+
+ before do
+ stub_request(
+ :get,
+ "https://www.patreon.com#{Patreon::ApiVersion::V2.members_data_url("0000000", "next-page")}",
+ ).to_return do
+ post "/patreon/webhook", params: webhook_body, headers: webhook_headers
+ expect(response.status).to eq(200)
+ { status: 200, body: JSON.generate(next_page) }
+ end
+ end
+
+ include_examples "denies patron content"
+ end
+
+ context "when a later page fails" do
+ let(:campaign_members) do
+ super().merge("meta" => { "pagination" => { "cursors" => { "next" => "next-page" } } })
+ end
+
+ before do
+ stub_request(
+ :get,
+ "https://www.patreon.com#{Patreon::ApiVersion::V2.members_data_url("0000000", "next-page")}",
+ ).to_return(status: 401)
+ end
+
+ include_examples "allows patron content"
+ end
+
+ context "when an API v1 member request fails" do
+ before do
+ SiteSetting.patreon_api_version = "1"
+ stub_request(
+ :get,
+ "https://api.patreon.com#{Patreon::ApiVersion::V1.campaign_data_url}",
+ ).to_return(status: 200, body: get_patreon_response("v1/campaigns.json"))
+ stub_request(
+ :get,
+ "https://www.patreon.com/api/oauth2/api/campaigns/70261/pledges?page%5Bcount%5D=100&sort=created",
+ ).to_return(status: 401)
+ end
+
+ include_examples "allows patron content"
+
+ it "preserves the cached membership" do
+ expect { synchronize }.not_to change { Patreon::Pledge.all }
+ end
+ end
+ end
+end