Class: SecureHeaders::XXssProtection

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

Constant Summary collapse

HEADER_NAME = 
'X-XSS-Protection'.freeze
DEFAULT_VALUE = 
"1; mode=block"
VALID_X_XSS_HEADER = 
/\A[01](; mode=block)?(; report=.*)?\z/i
CONFIG_KEY = 
:x_xss_protection

Class Method Summary collapse

Class Method Details

.make_header(config = nil) ⇒ Object

Public: generate an X-Xss-Protection header.

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



14
15
16
 
# File 'lib/secure_headers/headers/x_xss_protection.rb', line 14

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

.validate_config!(config) ⇒ Object

Raises:

  • (TypeError) 


18
19
20
21
22
 
# File 'lib/secure_headers/headers/x_xss_protection.rb', line 18

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)
  raise XXssProtectionConfigError.new("Invalid format (see VALID_X_XSS_HEADER)") unless config.to_s =~ VALID_X_XSS_HEADER
end