File: css.rb

package info (click to toggle)
ruby-sanitize 4.6.6-2.1~deb10u1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 528 kB
  • sloc: ruby: 2,837; makefile: 5
file content (348 lines) | stat: -rw-r--r-- 9,146 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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# encoding: utf-8

require 'crass'
require 'set'

class Sanitize; class CSS
  attr_reader :config

  # -- Class Methods -----------------------------------------------------------

  # Sanitizes inline CSS style properties.
  #
  # This is most useful for sanitizing non-stylesheet fragments of CSS like you
  # would find in the `style` attribute of an HTML element. To sanitize a full
  # CSS stylesheet, use {.stylesheet}.
  #
  # @example
  #   Sanitize::CSS.properties("background: url(foo.png); color: #fff;")
  #
  # @return [String] Sanitized CSS properties.
  def self.properties(css, config = {})
    self.new(config).properties(css)
  end

  # Sanitizes a full CSS stylesheet.
  #
  # A stylesheet may include selectors, at-rules, and comments. To sanitize only
  # inline style properties such as the contents of an HTML `style` attribute,
  # use {.properties}.
  #
  # @example
  #   css = %[
  #     .foo {
  #       background: url(foo.png);
  #       color: #fff;
  #     }
  #
  #     #bar {
  #       font: 42pt 'Comic Sans MS';
  #     }
  #   ]
  #
  #   Sanitize::CSS.stylesheet(css, Sanitize::Config::RELAXED)
  #
  # @return [String] Sanitized CSS stylesheet.
  def self.stylesheet(css, config = {})
    self.new(config).stylesheet(css)
  end

  # Sanitizes the given Crass CSS parse tree and all its children, modifying it
  # in place.
  #
  # @example
  #   css = %[
  #     .foo {
  #       background: url(foo.png);
  #       color: #fff;
  #     }
  #
  #     #bar {
  #       font: 42pt 'Comic Sans MS';
  #     }
  #   ]
  #
  #   tree = Crass.parse(css)
  #   Sanitize::CSS.tree!(tree, Sanitize::Config::RELAXED)
  #
  # @return [Array] Sanitized Crass CSS parse tree.
  def self.tree!(tree, config = {})
    self.new(config).tree!(tree)
  end

  # -- Instance Methods --------------------------------------------------------

  # Returns a new Sanitize::CSS object initialized with the settings in
  # _config_.
  def initialize(config = {})
    @config = Config.merge(Config::DEFAULT[:css], config[:css] || config)

    @at_rules                 = Set.new(@config[:at_rules])
    @at_rules_with_properties = Set.new(@config[:at_rules_with_properties])
    @at_rules_with_styles     = Set.new(@config[:at_rules_with_styles])
    @import_url_validator     = @config[:import_url_validator]
  end

  # Sanitizes inline CSS style properties.
  #
  # This is most useful for sanitizing non-stylesheet fragments of CSS like you
  # would find in the `style` attribute of an HTML element. To sanitize a full
  # CSS stylesheet, use {#stylesheet}.
  #
  # @example
  #   scss = Sanitize::CSS.new(Sanitize::Config::RELAXED)
  #   scss.properties("background: url(foo.png); color: #fff;")
  #
  # @return [String] Sanitized CSS properties.
  def properties(css)
    tree = Crass.parse_properties(css,
      :preserve_comments => @config[:allow_comments],
      :preserve_hacks    => @config[:allow_hacks])

    tree!(tree)
    Crass::Parser.stringify(tree)
  end

  # Sanitizes a full CSS stylesheet.
  #
  # A stylesheet may include selectors, at-rules, and comments. To sanitize only
  # inline style properties such as the contents of an HTML `style` attribute,
  # use {#properties}.
  #
  # @example
  #   css = %[
  #     .foo {
  #       background: url(foo.png);
  #       color: #fff;
  #     }
  #
  #     #bar {
  #       font: 42pt 'Comic Sans MS';
  #     }
  #   ]
  #
  #   scss = Sanitize::CSS.new(Sanitize::Config::RELAXED)
  #   scss.stylesheet(css)
  #
  # @return [String] Sanitized CSS stylesheet.
  def stylesheet(css)
    tree = Crass.parse(css,
      :preserve_comments => @config[:allow_comments],
      :preserve_hacks    => @config[:allow_hacks])

    tree!(tree)
    Crass::Parser.stringify(tree)
  end

  # Sanitizes the given Crass CSS parse tree and all its children, modifying it
  # in place.
  #
  # @example
  #   css = %[
  #     .foo {
  #       background: url(foo.png);
  #       color: #fff;
  #     }
  #
  #     #bar {
  #       font: 42pt 'Comic Sans MS';
  #     }
  #   ]
  #
  #   scss = Sanitize::CSS.new(Sanitize::Config::RELAXED)
  #   tree = Crass.parse(css)
  #
  #   scss.tree!(tree)
  #
  # @return [Array] Sanitized Crass CSS parse tree.
  def tree!(tree)
    preceded_by_property = false

    tree.map! do |node|
      next nil if node.nil?

      case node[:node]
      when :at_rule
        preceded_by_property = false
        next at_rule!(node)

      when :comment
        next node if @config[:allow_comments]

      when :property
        prop = property!(node)
        preceded_by_property = !prop.nil?
        next prop

      when :semicolon
        # Only preserve the semicolon if it was preceded by a whitelisted
        # property. Otherwise, omit it in order to prevent redundant semicolons.
        if preceded_by_property
          preceded_by_property = false
          next node
        end

      when :style_rule
        preceded_by_property = false
        tree!(node[:children])
        next node

      when :whitespace
        next node
      end

      nil
    end

    tree
  end

  # -- Protected Instance Methods ----------------------------------------------
  protected

  # Sanitizes a CSS at-rule node. Returns the sanitized node, or `nil` if the
  # current config doesn't allow this at-rule.
  def at_rule!(rule)
    name = rule[:name].downcase

    if @at_rules_with_styles.include?(name)
      styles = Crass::Parser.parse_rules(rule[:block],
        :preserve_comments => @config[:allow_comments],
        :preserve_hacks    => @config[:allow_hacks])

      rule[:block] = tree!(styles)

    elsif @at_rules_with_properties.include?(name)
      props = Crass::Parser.parse_properties(rule[:block],
        :preserve_comments => @config[:allow_comments],
        :preserve_hacks    => @config[:allow_hacks])

      rule[:block] = tree!(props)

    elsif @at_rules.include?(name)
      return nil if name == "import" && !import_url_allowed?(rule)
      return nil if rule.has_key?(:block)
    else
      return nil
    end

    rule
  end

  # Passes the URL value of an @import rule to a block to ensure
  # it's an allowed URL
  def import_url_allowed?(rule)
    return true unless @import_url_validator

    url_token = rule[:tokens].detect { |t| t[:node] == :url || t[:node] == :string }

    # don't allow @imports with no URL value
    return false unless url_token && (import_url = url_token[:value])

    @import_url_validator.call(import_url)
  end

  # Sanitizes a CSS property node. Returns the sanitized node, or `nil` if the
  # current config doesn't allow this property.
  def property!(prop)
    name = prop[:name].downcase

    # Preserve IE * and _ hacks if desired.
    if @config[:allow_hacks]
      name.slice!(0) if name =~ /\A[*_]/
    end

    return nil unless @config[:properties].include?(name)

    nodes          = prop[:children].dup
    combined_value = String.new

    nodes.each do |child|
      value = child[:value]

      case child[:node]
      when :ident
        combined_value << value.downcase if String === value

      when :function
        if child.key?(:name)
          name = child[:name].downcase

          if name == 'url'
            return nil unless valid_url?(child)
          end

          combined_value << name
          return nil if name == 'expression' || combined_value == 'expression'
        end

        if Array === value
          nodes.concat(value)
        elsif String === value
          lowercase_value = value.downcase
          combined_value << lowercase_value
          return nil if lowercase_value == 'expression' || combined_value == 'expression'
        end

      when :url
        return nil unless valid_url?(child)

      when :bad_url
        return nil
      end
    end

    prop
  end

  # Returns `true` if the given node (which may be of type `:url` or
  # `:function`, since the CSS syntax can produce both) uses a whitelisted
  # protocol.
  def valid_url?(node)
    type = node[:node]

    if type == :function
      return false unless node.key?(:name) && node[:name].downcase == 'url'
      return false unless Array === node[:value]

      # A URL function's `:value` should be an array containing no more than one
      # `:string` node and any number of `:whitespace` nodes.
      #
      # If it contains more than one `:string` node, or if it contains any other
      # nodes except `:whitespace` nodes, it's not valid.
      url_string_node = nil

      node[:value].each do |token|
        return false unless Hash === token

        case token[:node]
          when :string
            return false unless url_string_node.nil?
            url_string_node = token

          when :whitespace
            next

          else
            return false
        end
      end

      return false if url_string_node.nil?
      url = url_string_node[:value]
    elsif type == :url
      url = node[:value]
    else
      return false
    end

    if url =~ Sanitize::REGEX_PROTOCOL
      return @config[:protocols].include?($1.downcase)
    else
      return @config[:protocols].include?(:relative)
    end

    false
  end

end; end