Class: SecureHeaders::ReferrerPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/secure_headers/headers/referrer_policy.rb

Constant Summary collapse

HEADER_NAME = 
"Referrer-Policy".freeze
DEFAULT_VALUE = 
"origin-when-cross-origin"
VALID_POLICIES = 
%w(
  no-referrer
  no-referrer-when-downgrade
  same-origin
  strict-origin
  strict-origin-when-cross-origin
  origin
  origin-when-cross-origin
  unsafe-url
)
CONFIG_KEY = 
:referrer_policy

Class Method Summary collapse

Class Method Details

.make_header(config = nil) ⇒ Object

Public: generate an Referrer Policy header.

Returns a default header if no configuration is provided, or a header name and value based on the config.



23
24
25
 
# File 'lib/secure_headers/headers/referrer_policy.rb', line 23

def make_header(config = nil)
  [HEADER_NAME, config || DEFAULT_VALUE]
end

.validate_config!(config) ⇒ Object

Raises:

  • (TypeError) 


27
28
29
30
31
32
33
 
# File 'lib/secure_headers/headers/referrer_policy.rb', line 27

def validate_config!(config)
  return if config.nil? || config == OPT_OUT
  raise TypeError.new("Must be a string. Found #{config.class}: #{config}") unless config.is_a?(String)
  unless VALID_POLICIES.include?(config.downcase)
    raise ReferrerPolicyConfigError.new("Value can only be one of #{VALID_POLICIES.join(', ')}")
  end
end