rcguard.php

<?php

/*
 * rcguard plugin
 * Version HEAD
 *
 * Copyright (c) 2010-2012 Denny Lin. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

define('RCGUARD_RECAPTCHA_SUCCESS', 0);
define('RCGUARD_RECAPTCHA_FAILURE', 1);

class rcguard extends rcube_plugin
{
    public function init()
    {
        $this->load_config();
        $ignore_ips = rcmail::get_instance()->config->get('rcguard_ignore_ips', array());
        $client_ip  = $this->get_client_ip();

        if (!in_array($client_ip, $ignore_ips)) {
            $this->add_hook('template_object_loginform', array($this, 'loginform'));
            $this->add_hook('authenticate', array($this, 'authenticate'));
            $this->add_hook('login_after', array($this, 'login_after'));
            $this->add_hook('login_failed', array($this, 'login_failed'));
        }
    }

    public function loginform($loginform)
    {
        $rcmail = rcmail::get_instance();
        $client_ip = $this->get_client_ip();

        $query = $rcmail->db->query("SELECT " . $this->unixtimestamp('last') . " AS last, " . $this->unixtimestamp('NOW()') . " as time " .
                                    " FROM ".$this->table_name()." WHERE ip = ? AND hits >= ?",
                                    $client_ip, $rcmail->config->get('failed_attempts'));
        $result = $rcmail->db->fetch_assoc($query);

        if ((!$result || $this->delete_rcguard($result, $client_ip)) &&
            $rcmail->config->get('failed_attempts') != 0) {
            return $loginform;
        }

        return $this->show_recaptcha($loginform);
    }

    public function authenticate($args)
    {
        $this->add_texts('localization/');
        $rcmail = rcmail::get_instance();
        $client_ip = $this->get_client_ip();

        $query  = $rcmail->db->query("SELECT ip FROM ".$this->table_name()." WHERE ip = ? AND hits >= ?",
                                    $client_ip, $rcmail->config->get('failed_attempts'));
        $result = $rcmail->db->fetch_assoc($query);

        if (!$result && $rcmail->config->get('failed_attempts') != 0) {
            return $args;
        }

        $msg = 'rcguard.recaptchaempty';

        if ($response = $_POST['g-recaptcha-response']) {
            if ($this->verify_recaptcha($response, $client_ip)) {
                $this->log_recaptcha(RCGUARD_RECAPTCHA_SUCCESS, $args['user']);
                return $args;
            }

            $msg = 'rcguard.recaptchafailed';
        }

        $this->log_recaptcha(RCGUARD_RECAPTCHA_FAILURE, $args['user']);
        $rcmail->output->show_message($msg, 'error');
        $rcmail->output->set_env('task', 'login');
        $rcmail->output->send('login');

        return null;
    }

    public function login_after($args)
    {
        $client_ip = $this->get_client_ip();

        if (rcmail::get_instance()->config->get('rcguard_reset_after_success', true)) {
            $this->delete_rcguard('', $client_ip, true);
        }

        return $args;
    }

    public function login_failed($args)
    {
        $rcmail = rcmail::get_instance();
        $client_ip = $this->get_client_ip();

        $query  = $rcmail->db->query("SELECT hits FROM ".$this->table_name()." WHERE ip = ?", $client_ip);
        $result = $rcmail->db->fetch_assoc($query);

        if ($result) {
            $this->update_rcguard($result['hits'], $client_ip);
        } else {
            $this->insert_rcguard($client_ip);
        }
    }

    private function insert_rcguard($client_ip)
    {
        $rcmail = rcmail::get_instance();
        $query  = $rcmail->db->query("INSERT INTO ".$this->table_name()." (ip, first, last, hits) VALUES (?, ".$this->unixnow().", ".$this->unixnow().", ?)",
                                    $client_ip, 1);
    }

    private function update_rcguard($hits, $client_ip)
    {
        $rcmail = rcmail::get_instance();
        $query  = $rcmail->db->query("UPDATE ".$this->table_name()." SET last = ".$this->unixnow().", hits = ? WHERE ip = ?",
                                    $hits + 1, $client_ip);
    }

    private function delete_rcguard($result, $client_ip, $force = false)
    {
        $rcmail = rcmail::get_instance();

        if ($force) {
            $query = $rcmail->db->query("DELETE FROM ".$this->table_name()." WHERE ip = ?", $client_ip);
            $this->flush_rcguard();
            return true;
        }

        $last = $result['last'];
        $time = $result['time'];

        if ($last + $rcmail->config->get('expire_time') * 60 < $time) {
            $this->flush_rcguard();
            return true;
        }

        return false;
    }

    private function flush_rcguard()
    {
        $rcmail = rcmail::get_instance();

        $query = $rcmail->db->query("DELETE FROM ".$this->table_name()." " .
                                    " WHERE " . $this->unixtimestamp('last') . " + ? < " . $this->unixtimestamp('NOW()'),
                                    $rcmail->config->get('expire_time') * 60);
    }

    private function show_recaptcha($loginform)
    {
        $rcmail = rcmail::get_instance();

        $skin_path = $this->local_skin_path();
        if (!file_exists(INSTALL_PATH . '/plugins/rcguard/'.$skin_path)) {
            $skin_path = 'skins/larry';
        }
        $this->include_stylesheet($skin_path . '/rcguard.css');
        $this->include_script('rcguard.js');

        $recaptcha_api = ($rcmail->config->get('recaptcha_https') || rcube_utils::https_check()) ?
            $rcmail->config->get('recaptcha_api_secure') : $rcmail->config->get('recaptcha_api');

        $src = sprintf("%s?hl=%s", $recaptcha_api, $rcmail->user->language);
        $script = html::tag('script', array('type' => "text/javascript", 'src' => $src));
        $this->include_script($src);

        $tmp = $loginform['content'];
        $tmp = str_ireplace('</tbody>',
                            '<tr><td colspan="2"><div class="g-recaptcha" data-sitekey="'.$rcmail->config->get('recaptcha_publickey').'"></div></td>
</tr>
</tbody>', $tmp);
        $loginform['content'] = $tmp;

        return $loginform;
    }

    private function verify_recaptcha($response, $client_ip=null)
    {
        $rcmail = rcmail::get_instance();

        $privatekey = $rcmail->config->get('recaptcha_privatekey');
        if (! $rcmail->config->get('recaptcha_send_client_ip')) {
            $client_ip = null;
        }

        require_once($this->home . '/lib/recaptchalib.php');
        $reCaptcha = new ReCaptcha($privatekey);
        $resp = $reCaptcha->verify($response, $client_ip);

        return ($resp != null && $resp->success);
    }

    private function log_recaptcha($log_type, $username)
    {
        $rcmail = rcmail::get_instance();
        $client_ip = $this->get_client_ip();
        $username = (empty($username)) ? 'empty username' : $username;

        if (!$rcmail->config->get('recaptcha_log')) {
            return;
        }

        switch ($log_type) {
        case RCGUARD_RECAPTCHA_SUCCESS:
            $log_entry = $rcmail->config->get('recaptcha_log_success');
            break;
        case RCGUARD_RECAPTCHA_FAILURE:
            $log_entry = $rcmail->config->get('recaptcha_log_failure');
            break;
        default:
            $log_entry = $rcmail->config->get('recaptcha_log_unknown');
        }

        if (!empty($log_entry)) {
            $log_entry = str_replace(array('%r', '%u'), array($client_ip, $username), $log_entry);
            rcube::write_log('rcguard', $log_entry);
        }
    }

    private function unixtimestamp($field)
    {
        $rcmail = rcmail::get_instance();
        $ts = '';

        switch ($rcmail->db->db_provider) {
        case 'pgsql':
        case 'postgres':
            $ts = "EXTRACT (EPOCH FROM $field)";
            break;
        case 'sqlite':
            $field = preg_replace('/now\(\)/i', "'now'", $field);
            $ts = "strftime('%s', $field)";
            break;
        default:
            $ts = "UNIX_TIMESTAMP($field)";
        }

        return $ts;
    }

    private function unixnow()
    {
        $rcmail = rcmail::get_instance();
        $now = '';
        switch ($rcmail->db->db_provider) {
        case 'sqlite':
            $now = "strftime('%s', 'now')";
            break;
        default:
            $now = "NOW()";
        }
        return $now;
    }

    private function table_name()
    {
        return rcmail::get_instance()->db->table_name('rcguard', true);
    }

    private function get_client_ip()
    {
        $prefix = rcmail::get_instance()->config->get('rcguard_ipv6_prefix', 128);
        $client_ip = rcube_utils::remote_addr();

        // process only if prefix is sane and it's an IPv6 address
        if (is_int($prefix) && $prefix > 16 && $prefix < 128 &&
            filter_var($client_ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false) {

            // construct subnet mask
            $mask_string = str_repeat('1', $prefix) . str_repeat('0', 128 - $prefix);
            $mask_split = str_split($mask_string, 16);
            foreach ($mask_split as $item) {
                $item = base_convert($item, 2, 16);
            }
            $mask_hex = implode(":", $mask_split);

            // return network part
            return inet_ntop(inet_pton($client_ip) & inet_pton($mask_hex));
        }

         // fall back: return unaltered client IP
         return $client_ip;
    }
}