File: clear_site_data.rb

package info (click to toggle)
ruby-secure-headers 7.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 556 kB
  • sloc: ruby: 4,196; makefile: 5
file content (51 lines) | stat: -rw-r--r-- 1,581 bytes parent folder | download
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
# frozen_string_literal: true
module SecureHeaders
  class ClearSiteDataConfigError < StandardError; end
  class ClearSiteData
    HEADER_NAME = "clear-site-data".freeze

    # Valid `types`
    CACHE = "cache".freeze
    COOKIES = "cookies".freeze
    STORAGE = "storage".freeze
    EXECUTION_CONTEXTS = "executionContexts".freeze
    ALL_TYPES = [CACHE, COOKIES, STORAGE, EXECUTION_CONTEXTS]

    # Public: make an clear-site-data header name, value pair
    #
    # Returns nil if not configured, returns header name and value if configured.
    def self.make_header(config = nil, user_agent = nil)
      case config
      when nil, OPT_OUT, []
        # noop
      when Array
        [HEADER_NAME, make_header_value(config)]
      when true
        [HEADER_NAME, make_header_value(ALL_TYPES)]
      end
    end

    def self.validate_config!(config)
      case config
      when nil, OPT_OUT, true
        # valid
      when Array
        unless config.all? { |t| t.is_a?(String) }
          raise ClearSiteDataConfigError.new("types must be Strings")
        end
      else
        raise ClearSiteDataConfigError.new("config must be an Array of Strings or `true`")
      end
    end

    # Public: Transform a clear-site-data config (an Array of Strings) into a
    # String that can be used as the value for the clear-site-data header.
    #
    # types - An Array of String of types of data to clear.
    #
    # Returns a String of quoted values that are comma separated.
    def self.make_header_value(types)
      types.map { |t| %("#{t}") }.join(", ")
    end
  end
end