class Path2ban in path2ban 7.2

@class Path2ban The Path2ban class contains the core functionality to assess and block visitors who violate rules.

Hierarchy

• class \Path2ban

File

src/Path2ban.php, line 13

path2ban core functionality file.

class Path2ban {

  /**
   * This function compare real path and restricted, and takes action if necessary.
   *
   * @return bool whether path2ban action was taken.
   */
  public static function destinationCheck() {

    // Convert the Drupal path to lowercase.
    $destination = '';
    if (array_key_exists('destination', $_GET)) {
      $destination = drupal_strtolower($_GET['destination']);
    }

    // Don't accidentally error because of an empty string.
    if (empty($destination)) {
      return FALSE;
    }

    // Compare the lowercase paths.
    $pages = drupal_strtolower(variable_get('path2ban_list', ''));
    $page_match = drupal_match_path($destination, $pages);
    if (!$page_match) {
      return FALSE;
    }
    $should_block_user = self::shouldBlockUser();
    if (!$should_block_user) {
      return FALSE;
    }
    self::blockUser();
    return TRUE;
  }

  /**
   * Registers the infraction and considers blocking the user.
   *
   * @return bool true if should block the user.
   */
  private static function shouldBlockUser() {
    global $user;
    if ($user->uid == 1) {
      drupal_set_message(t('Hi User One! Use another account and another IP for testing path2ban module. Your IP not banned.'));
      return FALSE;
    }
    $bypass = user_access('bypass path2ban');
    $window = intval(variable_get('path2ban_threshold_window', 3600));
    $limit = intval(variable_get('path2ban_threshold_limit', 5));
    $limit = $limit < 1 ? 1 : $limit;
    if ($bypass) {
      watchdog('path2ban', 'Permitting IP address %ip as they have the \'bypass path2ban\' role.', array(
        '%ip' => ip_address(),
      ));
      return FALSE;
    }
    flood_register_event('path2ban', $window);

    // When flood_is_allowed returns false, the user has run out of chances.
    if (flood_is_allowed('path2ban', $limit, $window)) {
      if (variable_get('path2ban_warn_user')) {
        drupal_set_message(variable_get('path2ban_warn_user_message'), 'warning');
      }
      return FALSE;
    }

    // We should block the user.
    return TRUE;
  }

  /**
   * This function bans IP addresses of web scanners and sends a notification
   * email to User One.
   */
  private static function blockUser() {

    // Actually ban.
    $ip = ip_address();
    db_insert('blocked_ips')
      ->fields(array(
      'ip' => $ip,
    ))
      ->execute();
    watchdog('path2ban', 'Banned IP address %ip', array(
      '%ip' => $ip,
    ));
    drupal_set_message(t('Sorry, your IP has been banned.'), 'error');

    // Notify user one.
    if (variable_get('path2ban_notify', 0)) {
      $user1 = user_load(1);
      $url = url('admin/config/people/ip-blocking', array(
        'absolute' => TRUE,
      ));
      $params['subject'] = variable_get('site_name') . t(': Blocked IP due to web-scanner attack');
      $params['body'][] = t("Hi User One,\n        There were suspected web-scanner activities.\n        Associated IP (@ip) has been blocked.\n        You can review the list of blocked IPs at @url\n        Thank you.\n        Sent by path2ban module.\n      ", array(
        '@ip' => $ip,
        '@url' => $url,
      ));
      drupal_mail('path2ban', 'blocked-ip', $user1->mail, user_preferred_language($user1), $params);
    }
  }

  /**
   * A utility function to add new entries to the restricted paths list.
   *
   * @param array $new_entries
   */
  public static function addNewEntries($new_entries) {
    $list = variable_get('path2ban_list', path2ban_get_default_paths_to_ban());
    $list = $list . "\n";

    // Check that the user hasn't already added them before adding.
    foreach ($new_entries as $each_new_entry) {
      if (FALSE === strpos($list, $each_new_entry)) {
        $list .= $each_new_entry . "\n";
      }
    }
    variable_set('path2ban_list', $list);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Path2ban::addNewEntries	public static	function	A utility function to add new entries to the restricted paths list.
Path2ban::blockUser	private static	function	This function bans IP addresses of web scanners and sends a notification email to User One.
Path2ban::destinationCheck	public static	function	This function compare real path and restricted, and takes action if necessary.
Path2ban::shouldBlockUser	private static	function	Registers the infraction and considers blocking the user.