class PregSecuritySniff in Coder 8.3.x

Check the usage of the preg functions to ensure the insecure /e flag isn't used: https://www.drupal.org/node/750148

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

• class \Drupal\Sniffs\Semantics\FunctionCall implements \PHP_CodeSniffer\Sniffs\Sniff
  • class \Drupal\Sniffs\Semantics\PregSecuritySniff

File

coder_sniffer/Drupal/Sniffs/Semantics/PregSecuritySniff.php, line 22

Namespace

Drupal\Sniffs\Semantics

class PregSecuritySniff extends FunctionCall {

  /**
   * Returns an array of function names this test wants to listen for.
   *
   * @return array<string>
   */
  public function registerFunctionNames() {
    return [
      'preg_filter',
      'preg_grep',
      'preg_match',
      'preg_match_all',
      'preg_replace',
      'preg_replace_callback',
      'preg_split',
    ];
  }

  //end registerFunctionNames()

  /**
   * Processes this function call.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile    The file being scanned.
   * @param int                         $stackPtr     The position of the function call in
   *                                                  the stack.
   * @param int                         $openBracket  The position of the opening
   *                                                  parenthesis in the stack.
   * @param int                         $closeBracket The position of the closing
   *                                                  parenthesis in the stack.
   *
   * @return void
   */
  public function processFunctionCall(File $phpcsFile, $stackPtr, $openBracket, $closeBracket) {
    $tokens = $phpcsFile
      ->getTokens();
    $argument = $this
      ->getArgument(1);
    if ($argument === false) {
      return;
    }
    if ($tokens[$argument['start']]['code'] !== T_CONSTANT_ENCAPSED_STRING) {

      // Not a string literal.
      // @TODO: Extend code to recognize patterns in variables.
      return;
    }
    $pattern = $tokens[$argument['start']]['content'];
    $quote = substr($pattern, 0, 1);

    // Check that the pattern is a string.
    if ($quote === '"' || $quote === "'") {

      // Get the delimiter - first char after the enclosing quotes.
      $delimiter = preg_quote(substr($pattern, 1, 1), '/');

      // Check if there is the evil e flag.
      if (preg_match('/' . $delimiter . '[\\w]{0,}e[\\w]{0,}$/', substr($pattern, 0, -1)) === 1) {
        $warn = 'Using the e flag in %s is a possible security risk. For details see https://www.drupal.org/node/750148';
        $phpcsFile
          ->addError($warn, $argument['start'], 'PregEFlag', [
          $tokens[$stackPtr]['content'],
        ]);
        return;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FunctionCall::$arguments	protected	property	Internal cache to save the calculated arguments of the function call.
FunctionCall::$closeBracket	protected	property	The token position of the closing bracket of the function call.
FunctionCall::$functionCall	protected	property	The token position of the function call.
FunctionCall::$includeMethodCalls	protected	property	Whether method invocations with the same function name should be processed, too.	1
FunctionCall::$openBracket	protected	property	The token position of the opening bracket of the function call.
FunctionCall::$phpcsFile	protected	property	The currently processed file.
FunctionCall::getArgument	public	function	Returns start and end token for a given argument number.
FunctionCall::isFunctionCall	protected	function	Checks if this is a function call.
FunctionCall::process	public	function	Processes this test, when one of its tokens is encountered.	2
FunctionCall::register	public	function	Returns an array of tokens this test wants to listen for.
PregSecuritySniff::processFunctionCall	public	function	Processes this function call.
PregSecuritySniff::registerFunctionNames	public	function	Returns an array of function names this test wants to listen for.