Class: Immunio::Template

Inherits:
Object
  • Object
show all
Defined in:
lib/immunio/plugins/action_view.rb

Overview

Renders templates by filtering them through Immunio’s hook handlers.

Constant Summary collapse

CHECKSUM_CACHE = 
Hash.new do |cache, template_id|
  template = ObjectSpace._id2ref(template_id)

  if template.respond_to?(:source) && !template.source.nil?
    finalizer = Immunio::Template.finalize_template(template_id)
    ObjectSpace.define_finalizer(template, finalizer)
    cache[template_id] = Digest::SHA1.hexdigest(template.source).freeze
  end
end
ENCODED_IMMUNIO_TOKENS_RE = 
Regexp.compile(/(?:{|%7b)immunio-(var|fragment)(?::|%3a)(\d+)(?::|%3a)([0-9a-f]{1,4})(?:}|%7d)(.*?)(?:{|%7b)(?:\/|%2f)immunio-\1(?::|%3a)\2(?::|%3a)\3(?:}|%7d)/i)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(template) ⇒ Template 



24
25
26
27
28
29
30
 
# File 'lib/immunio/plugins/action_view.rb', line 24

def initialize(template)
  @template = template
  @next_var_id = 0
  @next_template_id = 0
  @vars = {}
  @scheduled_fragments_writes = []
end

Instance Attribute Details

#vars ⇒ Object

Returns the value of attribute vars.



22
23
24
 
# File 'lib/immunio/plugins/action_view.rb', line 22

def vars
  @vars
end

Class Method Details

.current ⇒ Object 



314
315
316
 
# File 'lib/immunio/plugins/action_view.rb', line 314

def self.current
  rendering_stack.last
end

.decode_immunio_tokens(rendered) ⇒ Object 



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
 
# File 'lib/immunio/plugins/action_view.rb', line 273

def self.decode_immunio_tokens(rendered)
  # Look for URI or JS encoded immunio tokens in the rendering and decode them
  # WebConsole incompatibility: `rendered` can be of type `Mime::Type` Which
  # doesn't respond to `gsub!`.
  if rendered.respond_to?(:gsub!)
    was_html_safe = rendered.html_safe?
    was_frozen = rendered.frozen?

    if was_frozen
      # This is not an airtight solution. Object#dup does not copy methods
      # defined on the instance, and may be overridden by subclasses to do
      # things that would cause problems for us. But most likely there is no
      # problem with using dup. We can't use Object#clone because the clone
      # retains the frozen status of the original, preventing us from
      # modifying the string contents.
      rendered = rendered.dup
    end

    rendered.gsub! ENCODED_IMMUNIO_TOKENS_RE, "{immunio-\\1:\\2:\\3}\\4{/immunio-\\1:\\2:\\3}"

    rendered.instance_variable_set(:@html_safe, true) if was_html_safe
    rendered.freeze if was_frozen
  end

  rendered
end

.finalize_template(id) ⇒ Object 



18
19
20
 
# File 'lib/immunio/plugins/action_view.rb', line 18

def self.finalize_template(id)
  proc { CHECKSUM_CACHE.delete(id) if CHECKSUM_CACHE.has_key?(id) }
end

.generate_render_var_code(code, escape) ⇒ Object

Generate code injected in templates to wrap everything inside ‘<%= … %>`.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/immunio/plugins/action_view.rb', line 254

def self.generate_render_var_code(code, escape)
  template = Template.current
  if template
    template_id = template.next_template_id

    handler = template.instance_variable_get(:@template).handler
    handler_name = if handler.is_a? Class
      handler.name
    else
      handler.class.name
    end

    "(__immunio_result = (#{remove_comment(code)}); Immunio::Template.render_var(#{code.strip.inspect}, __immunio_result, #{template_id}, '#{template.template_sha}', __FILE__, __LINE__, #{escape}, #{template.is_text?}, '#{handler_name}'))"
  else
    code
  end
end

.get_nonce ⇒ Object 



326
327
328
 
# File 'lib/immunio/plugins/action_view.rb', line 326

def self.get_nonce
  rendering_stack.first.get_nonce
end

.mark_and_defer_fragment_write(*args) ⇒ Object

Save fragment info to the root template only



331
332
333
 
# File 'lib/immunio/plugins/action_view.rb', line 331

def self.mark_and_defer_fragment_write(*args)
  rendering_stack.first.mark_and_defer_fragment_write(*args)
end

.mark_var(content, code, template_id, template_sha, file, line, escape, is_text, handler) ⇒ Object 



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
 
# File 'lib/immunio/plugins/action_view.rb', line 117

def self.mark_var(content, code, template_id, template_sha, file, line, escape, is_text, handler)
  id = Template.next_var_id
  nonce = Template.get_nonce

  # NOTE: What happens here is pretty funky to preserve the html_safe SafeBuffer behaviour in ruby.
  # If escaped is true we directly concatenate the content between two SafeBuffers. This will cause
  # escaping if content is not itself a SafeBuffer.
  # Otherwise we explicitly convert to a string, and convert that to a SafeBuffer to ensure that
  # for instance no escaping is performed on the contents of a <%== %> Erubis interpolation.
  rendering = if escape && !is_text

    # explicitly convert (w/ escapes) and mark safe things that aren't String (SafeBuffer is_a String also)
    # `to_s` is used to render any object passed to a template.
    # It is called internally when appending to ActionView::OutputBuffer.
    # We force rendering to get the actual string.
    # This has no impact if `rendered` is already a string.
    content = content.to_s.html_safe unless content.is_a? String

    # As a failsafe, just return the content if it already contains our markers. This can occur when
    # a helper calls render partial to generate a component of a page. Both render calls are root level
    # templates from our perspective.
    if content =~ /\{immunio-var:\d+:#{nonce}\}/ then
      # don't add markers.
      Immunio.logger.debug {"WARNING: ActionView not marking interpolation which already contains markers: \"#{content}\""}
      return content
    end

    "{immunio-var:#{id}:#{nonce}}".html_safe + content + "{/immunio-var:#{id}:#{nonce}}".html_safe
  else
    content = "" if content.nil?

    # See comment above
    if content =~ /\{immunio-var:\d+:#{nonce}\}/ then
      # don't add markers.
      Immunio.logger.debug {"WARNING: ActionView not marking interpolation which already contains markers: \"#{content}\""}
      return content.html_safe
    end

    "{immunio-var:#{id}:#{nonce}}".html_safe + content.to_s.html_safe + "{/immunio-var:#{id}:#{nonce}}".html_safe
  end

  # If we got here, the interpolation has been wrapped in our markers and we
  # need to record send data about it to the hook
  Template.vars[id.to_s] = {
    template_sha: template_sha,
    template_id: template_id.to_s,
    nonce: nonce,
    code: wrap_code(code, handler, escape: escape),
    file: file,
    line: line
  }

  rendering
end

.next_var_id ⇒ Object 



318
319
320
 
# File 'lib/immunio/plugins/action_view.rb', line 318

def self.next_var_id
  rendering_stack.first.next_var_id
end

.remove_comment(code) ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/immunio/plugins/action_view.rb', line 241

def self.remove_comment(code)
  *, last_line = code.rpartition("\n")

  comment = Ripper.slice(last_line, "comment")

  if comment
    code = code.sub(Regexp.new(Regexp.escape(comment) + "\\Z"), "")
  end

  code
end

.render_var(code, rendered, template_id, template_sha, file, line, escape, is_text, handler) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/immunio/plugins/action_view.rb', line 300

def self.render_var(code, rendered, template_id, template_sha, file, line, escape, is_text, handler)
  rendered = decode_immunio_tokens rendered

  if rendered.instance_variable_get("@__immunio_processed") then
    # Ignore buffers marked as __immunio_processed in render as these are full templates or partials
    return rendered
  elsif code =~ /yield( .*)?/
    # Ignore yielded blocks inside layouts
    return rendered
  end
  rendered = mark_var rendered, code, template_id, template_sha, file, line, escape, is_text, handler
  rendered.html_safe
end

.rendering_stack ⇒ Object

Stack of the templates currently being rendered.



336
337
338
 
# File 'lib/immunio/plugins/action_view.rb', line 336

def self.rendering_stack
  Thread.current["immunio.rendering_stack"] ||= []
end

.vars ⇒ Object 



322
323
324
 
# File 'lib/immunio/plugins/action_view.rb', line 322

def self.vars
  rendering_stack.first.vars
end

.wrap_code(code, handler, options = {}) ⇒ Object 



340
341
342
343
344
345
346
347
348
349
 
# File 'lib/immunio/plugins/action_view.rb', line 340

def self.wrap_code(code, handler, options = {})
  case
  when handler == 'ActionView::Template::Handlers::ERB'
    modifier = options[:escape] ? '=' : '=='
    "<%#{modifier} #{code} %>"
  when handler == 'Haml::Plugin'
    modifier = options[:escape] ? '=' : '!='
    "#{modifier} #{code}"
  end
end

Instance Method Details

#==(other) ⇒ Object 



36
37
38
 
# File 'lib/immunio/plugins/action_view.rb', line 36

def ==(other)
  self.class === other && id == other.id
end

#compiled? ⇒ Boolean 



93
94
95
 
# File 'lib/immunio/plugins/action_view.rb', line 93

def compiled?
  @template.instance_variable_get :@compiled
end

#get_nonce ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/immunio/plugins/action_view.rb', line 110

def get_nonce
  # Generate a two byte CSRNG nonce to make our substitutions unpreictable
  # Why only 2 bytes? The nonce is per render, so the odds of guessing it are very low
  # and entropy is finite so we don't want to drain the random pool unnecessarily
  @nonce ||= SecureRandom.hex(2)
end

#has_source? ⇒ Boolean 



40
41
42
 
# File 'lib/immunio/plugins/action_view.rb', line 40

def has_source?
  @template.respond_to?(:source) && !@template.source.nil?
end

#id ⇒ Object 



32
33
34
 
# File 'lib/immunio/plugins/action_view.rb', line 32

def id
  (@template.respond_to?(:virtual_path) && @template.virtual_path) || (@template.respond_to?(:source) && @template.source)
end

#is_text? ⇒ Boolean 



44
45
46
 
# File 'lib/immunio/plugins/action_view.rb', line 44

def is_text?
  @template.formats.first == :text
end

#load_source(context) ⇒ Object 



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
 
# File 'lib/immunio/plugins/action_view.rb', line 48

def load_source(context)
  return if !@template.respond_to?(:source) || !@template.source.nil?

  # @template is a virtual template that doesn't contain the source. We need
  # to try to load the source. But, the virtual template doesn't know the
  # original format of the source template file.
  #
  # First, try to load it using the Rails defaults (usually "html" and
  # "txt"). If that doesn't work, try to use the original format from the
  # virtual template.
  #
  # Though one might think the format from the virtual template would always
  # work, unfortunately the format from the template refers to the "type" of
  # the template, which may or may not be the same as the format of the
  # lookup context, which specifies the file extension of the template. Ugh,
  # naming... For example, the lookup context format may be "txt" while the
  # template format is "text".
  #
  # Astute readers may note that there's the possibility the template
  # extension is not in the Rails default list of lookup formats, and also
  # does not match the template type. We are just going to leave that for
  # another day, and hope that day never comes...
  begin
    refreshed = Immunio::IOHooks.paused { @template.refresh(context) }
  rescue
    begin
      old_formats = context.lookup_context.formats
      context.lookup_context.formats = @template.formats
      refreshed = Immunio::IOHooks.paused { @template.refresh(context) }
    rescue
      Immunio.logger.warn { "Failed to refresh template source from #{@template} using contexts #{old_formats} and #{@template.formats}" }
    ensure
      context.lookup_context.formats = old_formats
    end
  end

  return if refreshed.nil?

  @template.instance_variable_set :@source, refreshed.source
end

#mark_and_defer_fragment_write(key, content, options) ⇒ Object 



172
173
174
175
176
177
 
# File 'lib/immunio/plugins/action_view.rb', line 172

def mark_and_defer_fragment_write(key, content, options)
  id = @scheduled_fragments_writes.size
  nonce = Template.get_nonce
  @scheduled_fragments_writes << [key, content, options]
  "{immunio-fragment:#{id}:#{nonce}}#{content}{/immunio-fragment:#{id}:#{nonce}}"
end

#next_template_id ⇒ Object 



104
105
106
107
108
 
# File 'lib/immunio/plugins/action_view.rb', line 104

def next_template_id
  id = @next_template_id
  @next_template_id += 1
  id
end

#next_var_id ⇒ Object

Generate the next var unique ID to be used in a template.



98
99
100
101
102
 
# File 'lib/immunio/plugins/action_view.rb', line 98

def next_var_id
  id = @next_var_id
  @next_var_id += 1
  id
end

#render(context) ⇒ Object 



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
 
# File 'lib/immunio/plugins/action_view.rb', line 179

def render(context)
  load_source context
  # Don't handle templates with no source (inline text templates).
  unless has_source?
    rendered = yield
    rendered.instance_variable_set("@__immunio_processed", true) unless rendered.frozen?
    return rendered
  end

  begin
    root = true if rendering_stack.length == 0

    rendering_stack.push self
    # Calculate SHA1 of this template.
    template_sha
    Immunio.logger.debug {"ActionView rendering template with sha #{@template_sha}, root: #{root}"}
    rendered = yield
    rendered.instance_variable_set("@__immunio_processed", true) unless rendered.frozen?

    if root
      # This is the root template. Let ActionView render it, and then look
      # for XSS.

      # If the rendered result isn't a string, or a string-like, then let's
      # skip it for safety sake.
      unless rendered.respond_to? :to_str
        unless $__immunio_av_rendered_non_string
          Immunio.logger.warn { "ActionView rendered #{@template.inspect} to a non-string-like value: #{rendered.inspect}. This rendering will not be analyzed for XSS. Further warnings will be suppressed." }
          $__immunio_av_rendered_non_string = true
        end
        return rendered
      end

      rendered = rendered.to_str

      result = run_hook!("template_render_done", {
        content_type: Mime::Type.lookup_by_extension(@template.formats.first).to_s,
        rendered: rendered,
        vars: @vars
      })

      # We use the return value from the hook handler if present.
      rendered = result["rendered"] || rendered.dup

      remove_var_markers! rendered

      # If some fragments were marked to be cached, commit their content to cache.
      write_and_remove_fragments! context, rendered

      rendered.html_safe
    else
      # This is a partial template. Just render it.
      rendered
    end
  ensure
    top_template = rendering_stack.pop
    unless top_template == self
      raise Error, "Unexpected Immunio::Template on rendering stack. Expected #{id}, got #{top_template.try :id}."
    end
  end
end

#template_sha ⇒ Object 



89
90
91
 
# File 'lib/immunio/plugins/action_view.rb', line 89

def template_sha
  CHECKSUM_CACHE[@template.object_id]
end