Class: Banzai::Filter::BaseSanitizationFilter

Inherits:
HTML::Pipeline::SanitizationFilter
  • Object
show all
Extended by:
Gitlab::Utils::SanitizeNodeLink
Includes:
Gitlab::Utils::StrongMemoize
Defined in:
lib/banzai/filter/base_sanitization_filter.rb

Overview

Sanitize HTML produced by markup languages (Markdown, AsciiDoc…). Specific rules are implemented in dedicated filters:

  • Banzai::Filter::SanitizationFilter (Markdown)

  • Banzai::Filter::AsciiDocSanitizationFilter (AsciiDoc/Asciidoctor)

  • Banzai::Filter::BroadcastMessageSanitizationFilter (Markdown with styled links and line breaks)

Extends HTML::Pipeline::SanitizationFilter with common rules.

Constant Summary collapse

UNSAFE_PROTOCOLS =
%w(data javascript vbscript).freeze

Constants included from Gitlab::Utils::SanitizeNodeLink

Gitlab::Utils::SanitizeNodeLink::ATTRS_TO_SANITIZE

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Gitlab::Utils::SanitizeNodeLink

remove_unsafe_links, safe_protocol?

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Class Method Details

.remove_relObject


59
60
61
62
63
64
65
# File 'lib/banzai/filter/base_sanitization_filter.rb', line 59

def remove_rel
  lambda do |env|
    if env[:node_name] == 'a'
      env[:node].remove_attribute('rel')
    end
  end
end

Instance Method Details

#customize_whitelist(whitelist) ⇒ Object

Raises:

  • (NotImplementedError)

54
55
56
# File 'lib/banzai/filter/base_sanitization_filter.rb', line 54

def customize_whitelist(whitelist)
  raise NotImplementedError
end

#whitelistObject


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
52
# File 'lib/banzai/filter/base_sanitization_filter.rb', line 19

def whitelist
  strong_memoize(:whitelist) do
    whitelist = super.deep_dup

    # Allow span elements
    whitelist[:elements].push('span')

    # Allow data-math-style attribute in order to support LaTeX formatting
    whitelist[:attributes]['code'] = %w(data-math-style)
    whitelist[:attributes]['pre'] = %w(data-math-style data-mermaid-style)

    # Allow html5 details/summary elements
    whitelist[:elements].push('details')
    whitelist[:elements].push('summary')

    # Allow abbr elements with title attribute
    whitelist[:elements].push('abbr')
    whitelist[:attributes]['abbr'] = %w(title)

    # Disallow `name` attribute globally, allow on `a`
    whitelist[:attributes][:all].delete('name')
    whitelist[:attributes]['a'].push('name')

    # Allow any protocol in `a` elements
    # and then remove links with unsafe protocols
    whitelist[:protocols].delete('a')
    whitelist[:transformers].push(self.class.method(:remove_unsafe_links))

    # Remove `rel` attribute from `a` elements
    whitelist[:transformers].push(self.class.remove_rel)

    customize_whitelist(whitelist)
  end
end