Class: Cybertrain::ContentSecurityPolicy

Inherits:
Object
  • Object
show all
Defined in:
cybertrain/content_security_policy.rb

Overview

A Content Security Policy (spec section 5, C-5), declared in config/app.rb and, per controller, with content_security_policy do |p| ... end. One method per directive, each taking its sources:

c.content_security_policy do |p| p.default_src :self p.script_src :self, “https://cdn.jsdelivr.net” p.img_src :self, :data end

Symbols are the keywords: :self, :none, :unsafe_inline, :unsafe_eval, :strict_dynamic and :report_sample become 'self' and so on, :data, :https, :blob, :ws and :wss the schemes data: and so on. A String is written as given; one holding a space, ;, ,, a control character or a non-ASCII byte is refused with ArgumentError, so nothing in a source can end its directive or the header. A directive declared again replaces its sources in place; one declared with no sources is removed. The header lists the directives in declaration order (#header_value); ContentSecurityPolicyHeader writes it on every response.

Instance Method Summary collapse

Instance Method Details

#base_uri(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


122
# File 'cybertrain/content_security_policy.rb', line 122

def base_uri(*sources) = put_directive("base-uri", sources)

#child_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


107
# File 'cybertrain/content_security_policy.rb', line 107

def child_src(*sources) = put_directive("child-src", sources)

#connect_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


82
# File 'cybertrain/content_security_policy.rb', line 82

def connect_src(*sources) = put_directive("connect-src", sources)

#default_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


57
# File 'cybertrain/content_security_policy.rb', line 57

def default_src(*sources) = put_directive("default-src", sources)

#dup_policy ⇒ ContentSecurityPolicy

A copy to change without touching this one (a controller’s policy starts as a copy of the application’s).



163
164
165
166
167
168
169
170
171
# File 'cybertrain/content_security_policy.rb', line 163

def dup_policy
  copy = ContentSecurityPolicy.new
  i = 0
  while i < @names.size
    copy.append_directive(@names[i], @values[i])
    i += 1
  end
  copy
end

#font_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


77
# File 'cybertrain/content_security_policy.rb', line 77

def font_src(*sources) = put_directive("font-src", sources)

#form_action(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


127
# File 'cybertrain/content_security_policy.rb', line 127

def form_action(*sources) = put_directive("form-action", sources)

#frame_ancestors(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


102
# File 'cybertrain/content_security_policy.rb', line 102

def frame_ancestors(*sources) = put_directive("frame-ancestors", sources)

#frame_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


97
# File 'cybertrain/content_security_policy.rb', line 97

def frame_src(*sources) = put_directive("frame-src", sources)

#header_value(nonce, nonce_directives) ⇒ String

The header’s value: the directives in declaration order joined by "; ", with 'nonce-<nonce>' after the sources of each directive named in nonce_directives (when nonce is not “”). “” for a policy with no directive.

Examples:

policy.header_value("abc", ["script-src"])
# => "default-src 'self'; script-src 'self' 'nonce-abc'"

Parameters:

Returns:

  • (String)


145
146
147
148
149
150
151
152
153
154
155
156
157
# File 'cybertrain/content_security_policy.rb', line 145

def header_value(nonce, nonce_directives)
  out = +""
  names = @names
  i = 0
  while i < names.size
    name = names[i]
    out << "; " unless out.empty?
    out << name << " " << @values[i]
    out << " 'nonce-" << nonce << "'" if !nonce.empty? && nonce_directives.include?(name)
    i += 1
  end
  out
end

#img_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


72
# File 'cybertrain/content_security_policy.rb', line 72

def img_src(*sources) = put_directive("img-src", sources)

#manifest_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


117
# File 'cybertrain/content_security_policy.rb', line 117

def manifest_src(*sources) = put_directive("manifest-src", sources)

#media_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


87
# File 'cybertrain/content_security_policy.rb', line 87

def media_src(*sources) = put_directive("media-src", sources)

#object_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


92
# File 'cybertrain/content_security_policy.rb', line 92

def object_src(*sources) = put_directive("object-src", sources)

#report_uri(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>) —

    the report endpoint’s URL

Returns:

  • (nil)


132
# File 'cybertrain/content_security_policy.rb', line 132

def report_uri(*sources) = put_directive("report-uri", sources)

#script_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


62
# File 'cybertrain/content_security_policy.rb', line 62

def script_src(*sources) = put_directive("script-src", sources)

#style_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


67
# File 'cybertrain/content_security_policy.rb', line 67

def style_src(*sources) = put_directive("style-src", sources)

#worker_src(*sources) ⇒ nil

Parameters:

  • sources (Array<Symbol, String>)

Returns:

  • (nil)


112
# File 'cybertrain/content_security_policy.rb', line 112

def worker_src(*sources) = put_directive("worker-src", sources)