FailedLogins.php in Security Review 8

Namespace

Drupal\security_review\Checks

File

src/Checks/FailedLogins.php

<?php

namespace Drupal\security_review\Checks;

use Drupal\Core\Logger\RfcLogLevel;
use Drupal\security_review\Check;
use Drupal\security_review\CheckResult;

/**
 * Checks for abundant failed logins.
 */
class FailedLogins extends Check {

  /**
   * {@inheritdoc}
   */
  public function getNamespace() {
    return 'Security Review';
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return 'Failed logins';
  }

  /**
   * {@inheritdoc}
   */
  public function run() {

    // If dblog is not enabled return with hidden INFO.
    if (!$this
      ->moduleHandler()
      ->moduleExists('dblog')) {
      return $this
        ->createResult(CheckResult::INFO, [], FALSE);
    }
    $result = CheckResult::SUCCESS;
    $findings = [];
    $last_result = $this
      ->lastResult();
    $visible = FALSE;

    // Prepare the query.
    $query = $this
      ->database()
      ->select('watchdog', 'w');
    $query
      ->fields('w', [
      'severity',
      'type',
      'timestamp',
      'message',
      'variables',
      'hostname',
    ]);
    $query
      ->condition('type', 'user')
      ->condition('severity', RfcLogLevel::NOTICE)
      ->condition('message', 'Login attempt failed from %ip.');
    if ($last_result instanceof CheckResult) {

      // Only check entries that got recorded since the last run of the check.
      $query
        ->condition('timestamp', $last_result
        ->time(), '>=');
    }

    // Execute the query.
    $db_result = $query
      ->execute();

    // Count the number of failed logins per IP.
    $entries = [];
    foreach ($db_result as $row) {
      $ip = unserialize($row->variables)['%ip'];
      $entry_for_ip =& $entries[$ip];
      if (!isset($entry_for_ip)) {
        $entry_for_ip = 0;
      }
      $entry_for_ip++;
    }

    // Filter the IPs with more than 10 failed logins.
    if (!empty($entries)) {
      foreach ($entries as $ip => $count) {
        if ($count > 10) {
          $findings[] = $ip;
        }
      }
    }
    if (!empty($findings)) {
      $result = CheckResult::FAIL;
      $visible = TRUE;
    }
    return $this
      ->createResult($result, $findings, $visible);
  }

  /**
   * {@inheritdoc}
   */
  public function help() {
    $paragraphs = [];
    $paragraphs[] = $this
      ->t('Failed login attempts from the same IP may be an artifact of a malicious user attempting to brute-force their way onto your site as an authenticated user to carry out nefarious deeds.');
    return [
      '#theme' => 'check_help',
      '#title' => $this
        ->t('Abundant failed logins from the same IP'),
      '#paragraphs' => $paragraphs,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate(CheckResult $result) {
    $findings = $result
      ->findings();
    if (empty($findings)) {
      return [];
    }
    $paragraphs = [];
    $paragraphs[] = $this
      ->t('The following IPs were observed with an abundance of failed login attempts.');
    return [
      '#theme' => 'check_evaluation',
      '#paragraphs' => $paragraphs,
      '#items' => $result
        ->findings(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function evaluatePlain(CheckResult $result) {
    $findings = $result
      ->findings();
    if (empty($findings)) {
      return '';
    }
    $output = $this
      ->t('Suspicious IP addresses:') . ":\n";
    foreach ($findings as $ip) {
      $output .= "\t" . $ip . "\n";
    }
    return $output;
  }

  /**
   * {@inheritdoc}
   */
  public function getMessage($result_const) {
    switch ($result_const) {
      case CheckResult::FAIL:
        return $this
          ->t('Failed login attempts from the same IP. These may be a brute-force attack to gain access to your site.');
      default:
        return $this
          ->t('Unexpected result.');
    }
  }

}

Classes

Name	Description
FailedLogins	Checks for abundant failed logins.