Contextual Escaping

Websites and web applications are vulnerable to XSS attacks and although PHP provides escaping functionality, in some contexts it is not sufficient/appropriate. Phalcon\Escaper provides contextual escaping and is written in Zephir, providing the minimal overhead when escaping different kinds of texts.

We designed this component based on the XSS (Cross Site Scripting) Prevention Cheat Sheet_Prevention_Cheat_Sheet) created by the OWASP.

Additionally, this component relies on mbstring to support almost any charset.

To illustrate how this component works and why it is important, consider the following example:

  1. <?php
  3. use Phalcon\Escaper;
  5. // Document title with malicious extra HTML tags
  6. $maliciousTitle = "</title><script>alert(1)</script>";
  8. // Malicious CSS class name
  9. $className = ";`(";
  11. // Malicious CSS font name
  12. $fontName = "Verdana\"</style>";
  14. // Malicious Javascript text
  15. $javascriptText = "';</script>Hello";
  17. // Create an escaper
  18. $e = new Escaper();
  20. ?>
  22. <html>
  23.     <head>
  24.         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  26.         <title>
  27.             <?php echo $e->escapeHtml($maliciousTitle); ?>
  28.         </title>
  30.         <style type="text/css">
  31.             .<?php echo $e->escapeCss($className); ?> {
  32.                 font-family: "<?php echo $e->escapeCss($fontName); ?>";
  33.                 color: red;
  34.             }
  35.         </style>
  37.     </head>
  39.     <body>
  41.         <div class='<?php echo $e->escapeHtmlAttr($className); ?>'>
  42.             hello
  43.         </div>
  45.         <script>
  46.             var some = '<?php echo $e->escapeJs($javascriptText); ?>';
  47.         </script>
  49.     </body>
  50. </html>

Which produces the following:

  2. <html>
  3.     <head>
  4.         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6.         <title>
  7.             &lt;/title&gt;&lt;script&gt;alert(1)&lt;/script&gt;
  8.         </title>
  10.         <style type="text/css">
  11.             .\3c \2f style\3e {
  12.                 font-family: "Verdana\22 \3c \2f style\3e";
  13.                 color: red;
  14.             }
  15.         </style>
  17.     </head>
  19.     <body>
  21.         <div class='&#x3c &#x2f style&#x3e '>
  22.             hello
  23.         </div>
  25.         <script>
  26.             var some = '\x27\x3b\x3c\2fscript\x3eHello';
  27.         </script>
  29.     </body>
  30. </html>

Every text was escaped according to its context. Use the appropriate context is important to avoid XSS attacks.

Escaping HTML

The most common situation when inserting unsafe data is between HTML tags:

  1. <div class="comments">
  2.     <!-- Escape untrusted data here! -->
  3. </div>

You can escape those data using the escapeHtml method:

  1. <div class="comments">
  2.     <?php echo $e->escapeHtml('></div><h1>myattack</h1>'); ?>
  3. </div>

Which produces:

  1. <div class="comments">
  2.     &gt;&lt;/div&gt;&lt;h1&gt;myattack&lt;/h1&gt;
  3. </div>

Escaping HTML Attributes

Escaping HTML attributes is different from escaping HTML content. The escaper works by changing every non-alphanumericcharacter to the form. This kind of escaping is intended to most simpler attributes excluding complex ones like href or url:

  1. <table width="Escape untrusted data here!">
  2.     <tr>
  3.         <td>
  4.             Hello
  5.         </td>
  6.     </tr>
  7. </table>

You can escape a HTML attribute by using the escapeHtmlAttr method:

  1. <table width="<?php echo $e->escapeHtmlAttr('"><h1>Hello</table'); ?>">
  2.     <tr>
  3.         <td>
  4.             Hello
  5.         </td>
  6.     </tr>
  7. </table>

Which produces:

  1. <table width="&#x22;&#x3e;&#x3c;h1&#x3e;Hello&#x3c;&#x2f;table">
  2.     <tr>
  3.         <td>
  4.             Hello
  5.         </td>
  6.     </tr>
  7. </table>

Escaping URLs

Some HTML attributes like href or url need to be escaped differently:

  1. <a href="Escape untrusted data here!">
  2.     Some link
  3. </a>

You can escape a HTML attribute by using the :code:escapeUrl method:

  1. <a href="<?php echo $e->escapeUrl('"><script>alert(1)</script><a href="#'); ?>">
  2.     Some link
  3. </a>

Which produces:

  1. <a href="%22%3E%3Cscript%3Ealert%281%29%3C%2Fscript%3E%3Ca%20href%3D%22%23">
  2.     Some link
  3. </a>

Escaping CSS

CSS identifiers/values can be escaped too:

  1. <a style="color: Escape untrusted data here">
  2.     Some link
  3. </a>

You can escape a CSS identifiers/value by using the :code:escapeCss method:

  1. <a style="color: <?php echo $e->escapeCss('"><script>alert(1)</script><a href="#'); ?>">
  2.     Some link
  3. </a>

Which produces:

  1. <a style="color: \22 \3e \3c script\3e alert\28 1\29 \3c \2f script\3e \3c a\20 href\3d \22 \23 ">
  2.     Some link
  3. </a>

Escaping JavaScript

Strings to be inserted into JavaScript code also must be properly escaped:

  1. <script>
  2.     document.title = 'Escape untrusted data here';
  3. </script>

You can escape JavaScript code by using the escapeJs method:

  1. <script>
  2.     document.title = '<?php echo $e->escapeJs("'; alert(100); var x='"); ?>';
  3. </script>
  1. <script>
  2.     document.title = '\x27; alert(100); var x\x3d\x27';
  3. </script>