security.py 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. # -*- coding: utf-8 -*-
  2. """
  3. jinja2.testsuite.security
  4. ~~~~~~~~~~~~~~~~~~~~~~~~~
  5. Checks the sandbox and other security features.
  6. :copyright: (c) 2010 by the Jinja Team.
  7. :license: BSD, see LICENSE for more details.
  8. """
  9. import unittest
  10. from jinja2.testsuite import JinjaTestCase
  11. from jinja2 import Environment
  12. from jinja2.sandbox import SandboxedEnvironment, \
  13. ImmutableSandboxedEnvironment, unsafe
  14. from jinja2 import Markup, escape
  15. from jinja2.exceptions import SecurityError, TemplateSyntaxError, \
  16. TemplateRuntimeError
  17. from jinja2._compat import text_type
  18. class PrivateStuff(object):
  19. def bar(self):
  20. return 23
  21. @unsafe
  22. def foo(self):
  23. return 42
  24. def __repr__(self):
  25. return 'PrivateStuff'
  26. class PublicStuff(object):
  27. bar = lambda self: 23
  28. _foo = lambda self: 42
  29. def __repr__(self):
  30. return 'PublicStuff'
  31. class SandboxTestCase(JinjaTestCase):
  32. def test_unsafe(self):
  33. env = SandboxedEnvironment()
  34. self.assert_raises(SecurityError, env.from_string("{{ foo.foo() }}").render,
  35. foo=PrivateStuff())
  36. self.assert_equal(env.from_string("{{ foo.bar() }}").render(foo=PrivateStuff()), '23')
  37. self.assert_raises(SecurityError, env.from_string("{{ foo._foo() }}").render,
  38. foo=PublicStuff())
  39. self.assert_equal(env.from_string("{{ foo.bar() }}").render(foo=PublicStuff()), '23')
  40. self.assert_equal(env.from_string("{{ foo.__class__ }}").render(foo=42), '')
  41. self.assert_equal(env.from_string("{{ foo.func_code }}").render(foo=lambda:None), '')
  42. # security error comes from __class__ already.
  43. self.assert_raises(SecurityError, env.from_string(
  44. "{{ foo.__class__.__subclasses__() }}").render, foo=42)
  45. def test_immutable_environment(self):
  46. env = ImmutableSandboxedEnvironment()
  47. self.assert_raises(SecurityError, env.from_string(
  48. '{{ [].append(23) }}').render)
  49. self.assert_raises(SecurityError, env.from_string(
  50. '{{ {1:2}.clear() }}').render)
  51. def test_restricted(self):
  52. env = SandboxedEnvironment()
  53. self.assert_raises(TemplateSyntaxError, env.from_string,
  54. "{% for item.attribute in seq %}...{% endfor %}")
  55. self.assert_raises(TemplateSyntaxError, env.from_string,
  56. "{% for foo, bar.baz in seq %}...{% endfor %}")
  57. def test_markup_operations(self):
  58. # adding two strings should escape the unsafe one
  59. unsafe = '<script type="application/x-some-script">alert("foo");</script>'
  60. safe = Markup('<em>username</em>')
  61. assert unsafe + safe == text_type(escape(unsafe)) + text_type(safe)
  62. # string interpolations are safe to use too
  63. assert Markup('<em>%s</em>') % '<bad user>' == \
  64. '<em>&lt;bad user&gt;</em>'
  65. assert Markup('<em>%(username)s</em>') % {
  66. 'username': '<bad user>'
  67. } == '<em>&lt;bad user&gt;</em>'
  68. # an escaped object is markup too
  69. assert type(Markup('foo') + 'bar') is Markup
  70. # and it implements __html__ by returning itself
  71. x = Markup("foo")
  72. assert x.__html__() is x
  73. # it also knows how to treat __html__ objects
  74. class Foo(object):
  75. def __html__(self):
  76. return '<em>awesome</em>'
  77. def __unicode__(self):
  78. return 'awesome'
  79. assert Markup(Foo()) == '<em>awesome</em>'
  80. assert Markup('<strong>%s</strong>') % Foo() == \
  81. '<strong><em>awesome</em></strong>'
  82. # escaping and unescaping
  83. assert escape('"<>&\'') == '&#34;&lt;&gt;&amp;&#39;'
  84. assert Markup("<em>Foo &amp; Bar</em>").striptags() == "Foo & Bar"
  85. assert Markup("&lt;test&gt;").unescape() == "<test>"
  86. def test_template_data(self):
  87. env = Environment(autoescape=True)
  88. t = env.from_string('{% macro say_hello(name) %}'
  89. '<p>Hello {{ name }}!</p>{% endmacro %}'
  90. '{{ say_hello("<blink>foo</blink>") }}')
  91. escaped_out = '<p>Hello &lt;blink&gt;foo&lt;/blink&gt;!</p>'
  92. assert t.render() == escaped_out
  93. assert text_type(t.module) == escaped_out
  94. assert escape(t.module) == escaped_out
  95. assert t.module.say_hello('<blink>foo</blink>') == escaped_out
  96. assert escape(t.module.say_hello('<blink>foo</blink>')) == escaped_out
  97. def test_attr_filter(self):
  98. env = SandboxedEnvironment()
  99. tmpl = env.from_string('{{ cls|attr("__subclasses__")() }}')
  100. self.assert_raises(SecurityError, tmpl.render, cls=int)
  101. def test_binary_operator_intercepting(self):
  102. def disable_op(left, right):
  103. raise TemplateRuntimeError('that operator so does not work')
  104. for expr, ctx, rv in ('1 + 2', {}, '3'), ('a + 2', {'a': 2}, '4'):
  105. env = SandboxedEnvironment()
  106. env.binop_table['+'] = disable_op
  107. t = env.from_string('{{ %s }}' % expr)
  108. assert t.render(ctx) == rv
  109. env.intercepted_binops = frozenset(['+'])
  110. t = env.from_string('{{ %s }}' % expr)
  111. try:
  112. t.render(ctx)
  113. except TemplateRuntimeError as e:
  114. pass
  115. else:
  116. self.fail('expected runtime error')
  117. def test_unary_operator_intercepting(self):
  118. def disable_op(arg):
  119. raise TemplateRuntimeError('that operator so does not work')
  120. for expr, ctx, rv in ('-1', {}, '-1'), ('-a', {'a': 2}, '-2'):
  121. env = SandboxedEnvironment()
  122. env.unop_table['-'] = disable_op
  123. t = env.from_string('{{ %s }}' % expr)
  124. assert t.render(ctx) == rv
  125. env.intercepted_unops = frozenset(['-'])
  126. t = env.from_string('{{ %s }}' % expr)
  127. try:
  128. t.render(ctx)
  129. except TemplateRuntimeError as e:
  130. pass
  131. else:
  132. self.fail('expected runtime error')
  133. def suite():
  134. suite = unittest.TestSuite()
  135. suite.addTest(unittest.makeSuite(SandboxTestCase))
  136. return suite