1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
|
# frozen_string_literal: true
require "yaml"
module SecureHeaders
class Configuration
DEFAULT_CONFIG = :default
NOOP_OVERRIDE = "secure_headers_noop_override"
class AlreadyConfiguredError < StandardError; end
class NotYetConfiguredError < StandardError; end
class IllegalPolicyModificationError < StandardError; end
class << self
# Public: Set the global default configuration.
#
# Optionally supply a block to override the defaults set by this library.
#
# Returns the newly created config.
def default(&block)
if defined?(@default_config)
raise AlreadyConfiguredError, "Policy already configured"
end
# Define a built-in override that clears all configuration options and
# results in no security headers being set.
override(NOOP_OVERRIDE) do |config|
CONFIG_ATTRIBUTES.each do |attr|
config.instance_variable_set("@#{attr}", OPT_OUT)
end
end
new_config = new(&block).freeze
new_config.validate_config!
@default_config = new_config
end
alias_method :configure, :default
# Public: create a named configuration that overrides the default config.
#
# name - use an idenfier for the override config.
# base - override another existing config, or override the default config
# if no value is supplied.
#
# Returns: the newly created config
def override(name, &block)
@overrides ||= {}
raise "Provide a configuration block" unless block_given?
if named_append_or_override_exists?(name)
raise AlreadyConfiguredError, "Configuration already exists"
end
@overrides[name] = block
end
def overrides(name)
@overrides ||= {}
@overrides[name]
end
def named_appends(name)
@appends ||= {}
@appends[name]
end
def named_append(name, &block)
@appends ||= {}
raise "Provide a configuration block" unless block_given?
if named_append_or_override_exists?(name)
raise AlreadyConfiguredError, "Configuration already exists"
end
@appends[name] = block
end
def dup
default_config.dup
end
private
def named_append_or_override_exists?(name)
(defined?(@appends) && @appends.key?(name)) ||
(defined?(@overrides) && @overrides.key?(name))
end
# Public: perform a basic deep dup. The shallow copy provided by dup/clone
# can lead to modifying parent objects.
def deep_copy(config)
return unless config
config.each_with_object({}) do |(key, value), hash|
hash[key] = if value.is_a?(Array)
value.dup
else
value
end
end
end
# Private: Returns the internal default configuration. This should only
# ever be called by internal callers (or tests) that know the semantics
# of ensuring that the default config is never mutated and is dup(ed)
# before it is used in a request.
def default_config
unless defined?(@default_config)
raise NotYetConfiguredError, "Default policy not yet configured"
end
@default_config
end
# Private: convenience method purely DRY things up. The value may not be a
# hash (e.g. OPT_OUT, nil)
def deep_copy_if_hash(value)
if value.is_a?(Hash)
deep_copy(value)
else
value
end
end
end
CONFIG_ATTRIBUTES_TO_HEADER_CLASSES = {
hsts: StrictTransportSecurity,
x_frame_options: XFrameOptions,
x_content_type_options: XContentTypeOptions,
x_xss_protection: XXssProtection,
x_download_options: XDownloadOptions,
x_permitted_cross_domain_policies: XPermittedCrossDomainPolicies,
referrer_policy: ReferrerPolicy,
clear_site_data: ClearSiteData,
expect_certificate_transparency: ExpectCertificateTransparency,
csp: ContentSecurityPolicy,
csp_report_only: ContentSecurityPolicy,
cookies: Cookie,
}.freeze
CONFIG_ATTRIBUTES = CONFIG_ATTRIBUTES_TO_HEADER_CLASSES.keys.freeze
# The list of attributes that must respond to a `validate_config!` method
VALIDATABLE_ATTRIBUTES = CONFIG_ATTRIBUTES
# The list of attributes that must respond to a `make_header` method
HEADERABLE_ATTRIBUTES = (CONFIG_ATTRIBUTES - [:cookies]).freeze
attr_writer(*(CONFIG_ATTRIBUTES_TO_HEADER_CLASSES.reject { |key| [:csp, :csp_report_only].include?(key) }.keys))
attr_reader(*(CONFIG_ATTRIBUTES_TO_HEADER_CLASSES.keys))
@script_hashes = nil
@style_hashes = nil
HASH_CONFIG_FILE = ENV["secure_headers_generated_hashes_file"] || "config/secure_headers_generated_hashes.yml"
if File.exist?(HASH_CONFIG_FILE)
config = YAML.safe_load(File.open(HASH_CONFIG_FILE))
@script_hashes = config["scripts"]
@style_hashes = config["styles"]
end
def initialize(&block)
@cookies = self.class.send(:deep_copy_if_hash, Cookie::COOKIE_DEFAULTS)
@clear_site_data = nil
@csp = nil
@csp_report_only = nil
@hsts = nil
@x_content_type_options = nil
@x_download_options = nil
@x_frame_options = nil
@x_permitted_cross_domain_policies = nil
@x_xss_protection = nil
@expect_certificate_transparency = nil
self.referrer_policy = OPT_OUT
self.csp = ContentSecurityPolicyConfig.new(ContentSecurityPolicyConfig::DEFAULT)
self.csp_report_only = OPT_OUT
instance_eval(&block) if block_given?
end
# Public: copy everything
#
# Returns a deep-dup'd copy of this configuration.
def dup
copy = self.class.new
copy.cookies = self.class.send(:deep_copy_if_hash, @cookies)
copy.csp = @csp.dup if @csp
copy.csp_report_only = @csp_report_only.dup if @csp_report_only
copy.x_content_type_options = @x_content_type_options
copy.hsts = @hsts
copy.x_frame_options = @x_frame_options
copy.x_xss_protection = @x_xss_protection
copy.x_download_options = @x_download_options
copy.x_permitted_cross_domain_policies = @x_permitted_cross_domain_policies
copy.clear_site_data = @clear_site_data
copy.expect_certificate_transparency = @expect_certificate_transparency
copy.referrer_policy = @referrer_policy
copy
end
# Public: Apply a named override to the current config
#
# Returns self
def override(name = nil, &block)
if override = self.class.overrides(name)
instance_eval(&override)
else
raise ArgumentError.new("no override by the name of #{name} has been configured")
end
self
end
def generate_headers
headers = {}
HEADERABLE_ATTRIBUTES.each do |attr|
klass = CONFIG_ATTRIBUTES_TO_HEADER_CLASSES[attr]
header_name, value = klass.make_header(instance_variable_get("@#{attr}"))
if header_name && value
headers[header_name] = value
end
end
headers
end
def opt_out(header)
send("#{header}=", OPT_OUT)
end
def update_x_frame_options(value)
@x_frame_options = value
end
# Public: validates all configurations values.
#
# Raises various configuration errors if any invalid config is detected.
#
# Returns nothing
def validate_config!
VALIDATABLE_ATTRIBUTES.each do |attr|
klass = CONFIG_ATTRIBUTES_TO_HEADER_CLASSES[attr]
klass.validate_config!(instance_variable_get("@#{attr}"))
end
end
def secure_cookies=(secure_cookies)
raise ArgumentError, "#{Kernel.caller.first}: `#secure_cookies=` is no longer supported. Please use `#cookies=` to configure secure cookies instead."
end
def csp=(new_csp)
case new_csp
when OPT_OUT
@csp = new_csp
when ContentSecurityPolicyConfig
@csp = new_csp
when Hash
@csp = ContentSecurityPolicyConfig.new(new_csp)
else
raise ArgumentError, "Must provide either an existing CSP config or a CSP config hash"
end
end
# Configures the Content-Security-Policy-Report-Only header. `new_csp` cannot
# contain `report_only: false` or an error will be raised.
#
# NOTE: if csp has not been configured/has the default value when
# configuring csp_report_only, the code will assume you mean to only use
# report-only mode and you will be opted-out of enforce mode.
def csp_report_only=(new_csp)
case new_csp
when OPT_OUT
@csp_report_only = new_csp
when ContentSecurityPolicyReportOnlyConfig
@csp_report_only = new_csp.dup
when ContentSecurityPolicyConfig
@csp_report_only = new_csp.make_report_only
when Hash
@csp_report_only = ContentSecurityPolicyReportOnlyConfig.new(new_csp)
else
raise ArgumentError, "Must provide either an existing CSP config or a CSP config hash"
end
end
end
end
|