discourse/lib/s3_cors_rulesets.rb
Martin Brennan 9a72a0945f
FIX: Ensure CORS rules exist for S3 using rake task (#14802)
This commit introduces a new s3:ensure_cors_rules rake task
that is run as a prerequisite to s3:upload_assets. This rake
task calls out to the S3CorsRulesets class to ensure that
the 3 relevant sets of CORS rules are applied, depending on
site settings:

* assets
* direct S3 backups
* direct S3 uploads

This works for both Global S3 settings and Database S3 settings
(the latter set directly via SiteSetting).

As it is, only one rule can be applied, which is generally
the assets rule as it is called first. This commit changes
the ensure_cors! method to be able to apply new rules as
well as the existing ones.

This commit also slightly changes the existing rules to cover
direct S3 uploads via uppy, especially multipart, which requires
some more headers.
2021-11-08 09:16:38 +10:00

71 lines
2.5 KiB
Ruby

# frozen_string_literal: true
require_dependency "s3_helper"
class S3CorsRulesets
ASSETS = {
allowed_headers: ["Authorization"],
allowed_methods: ["GET", "HEAD"],
allowed_origins: ["*"],
max_age_seconds: 3000
}.freeze
BACKUP_DIRECT_UPLOAD = {
allowed_headers: ["*"],
expose_headers: ["ETag"],
allowed_methods: ["GET", "HEAD", "PUT"],
allowed_origins: ["*"],
max_age_seconds: 3000
}.freeze
DIRECT_UPLOAD = {
allowed_headers: ["Authorization", "Content-Disposition", "Content-Type"],
expose_headers: ["ETag"],
allowed_methods: ["GET", "HEAD", "PUT"],
allowed_origins: ["*"],
max_age_seconds: 3000
}.freeze
##
# Used by the s3:ensure_cors_rules rake task to make sure the
# relevant CORS rules are applied to allow for direct uploads to
# S3, and in the case of assets rules so there are fonts and other
# public assets for the site loaded correctly.
#
# The use_db_s3_config param comes from ENV, and if the S3 client
# is not provided it is initialized by the S3Helper.
def self.sync(use_db_s3_config:, s3_client: nil)
return if !SiteSetting.s3_install_cors_rule
return if !(GlobalSetting.use_s3? || SiteSetting.enable_s3_uploads)
assets_rules_applied = false
backup_rules_applied = false
direct_upload_rules_applied = false
s3_helper = S3Helper.build_from_config(
s3_client: s3_client, use_db_s3_config: use_db_s3_config
)
puts "Attempting to apply ASSETS S3 CORS ruleset in bucket #{s3_helper.s3_bucket_name}."
assets_rules_applied = s3_helper.ensure_cors!([S3CorsRulesets::ASSETS])
if SiteSetting.enable_backups? && SiteSetting.backup_location == BackupLocationSiteSetting::S3
backup_s3_helper = S3Helper.build_from_config(
s3_client: s3_client, use_db_s3_config: use_db_s3_config, for_backup: true
)
puts "Attempting to apply BACKUP_DIRECT_UPLOAD S3 CORS ruleset in bucket #{backup_s3_helper.s3_bucket_name}."
backup_rules_applied = backup_s3_helper.ensure_cors!([S3CorsRulesets::BACKUP_DIRECT_UPLOAD])
end
if SiteSetting.enable_direct_s3_uploads
puts "Attempting to apply DIRECT_UPLOAD S3 CORS ruleset in bucket #{s3_helper.s3_bucket_name}."
direct_upload_rules_applied = s3_helper.ensure_cors!([S3CorsRulesets::DIRECT_UPLOAD])
end
{
assets_rules_applied: assets_rules_applied,
backup_rules_applied: backup_rules_applied,
direct_upload_rules_applied: direct_upload_rules_applied
}
end
end