Contents

# frozen_string_literal: true
module SecureHeaders
  class ReferrerPolicyConfigError < StandardError; end
  class ReferrerPolicy
    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 << self
      # 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.
      def make_header(config = nil)
        [HEADER_NAME, config || DEFAULT_VALUE]
      end

      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
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version	Path
secure_headers-4.0.2	lib/secure_headers/headers/referrer_policy.rb
secure_headers-5.0.1	lib/secure_headers/headers/referrer_policy.rb
secure_headers-5.0.0.alpha01	lib/secure_headers/headers/referrer_policy.rb
secure_headers-4.0.1	lib/secure_headers/headers/referrer_policy.rb
secure_headers-4.0.0	lib/secure_headers/headers/referrer_policy.rb
secure_headers-4.0.0.alpha04	lib/secure_headers/headers/referrer_policy.rb
secure_headers-4.0.0.alpha03	lib/secure_headers/headers/referrer_policy.rb
secure_headers-4.0.0.alpha02	lib/secure_headers/headers/referrer_policy.rb
secure_headers-4.0.0.alpha01	lib/secure_headers/headers/referrer_policy.rb