1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 <?php
namespace Alpha\Model;
use Alpha\Model\Type\SmallText;
use Alpha\Util\Logging\Logger;
use Alpha\Util\Config\ConfigProvider;
use Alpha\Exception\AlphaException;
/**
* A HTTP request that resulted in a 400 response. The class is only used when the
* security.client.temp.blacklist.filter.enabled setting is set to true to enable the filter.
*
* @since 1.0
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * 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.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* 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.
* </pre>
*/
class BadRequest extends ActiveRecord
{
/**
* The HTTP user-agent client string.
*
* @var \Alpha\Model\Type\SmallText
*
* @since 1.0
*/
protected $client;
/**
* The IP of the client.
*
* @var \Alpha\Model\Type\SmallText
*
* @since 1.0
*/
protected $IP;
/**
* The resource that the client requested.
*
* @var \Alpha\Model\Type\SmallText
*
* @since 1.0
*/
protected $requestedResource;
/**
* An array of data display labels for the class properties.
*
* @var array
*
* @since 1.0
*/
protected $dataLabels = array('ID' => 'Bad request ID#', 'client' => 'Client string', 'IP' => 'IP', 'requestedResource' => 'Requested resource');
/**
* The name of the database table for the class.
*
* @var string
*
* @since 1.0
*/
const TABLE_NAME = 'BadRequest';
/**
* Trace logger.
*
* @var \Alpha\Util\Logging\Logger
*
* @since 1.0
*/
private static $logger = null;
/**
* Constructor for the class.
*
* @since 1.0
*/
public function __construct()
{
self::$logger = new Logger('BadRequest');
self::$logger->debug('>>__construct()');
// ensure to call the parent constructor
parent::__construct();
$this->client = new SmallText();
$this->IP = new SmallText();
$this->requestedResource = new SmallText();
self::$logger->debug('<<__construct');
}
/**
* Gets the count of bad requests for the client with this IP and client string in the past
* configurable period (security.client.temp.blacklist.filter.period).
*
* @return int
*
* @since 1.0
*
* @throws \Alpha\Exception\AlphaException
*/
public function getBadRequestCount()
{
$config = ConfigProvider::getInstance();
// the datetime interval syntax between MySQL and SQLite3 is a little different
if ($config->get('db.provider.name') == 'Alpha\Model\ActiveRecordProviderMySQL') {
$sqlQuery = 'SELECT COUNT(ID) AS request_count FROM '.$this->getTableName()." WHERE IP = '".$this->IP->getValue()."' AND client = '".$this->client->getValue()."' AND created_ts > NOW()-INTERVAL '".$config->get('security.client.temp.blacklist.filter.period')."' MINUTE";
} else {
$sqlQuery = 'SELECT COUNT(ID) AS request_count FROM '.$this->getTableName()." WHERE IP = '".$this->IP->getValue()."' AND client = '".$this->client->getValue()."' AND created_ts > datetime('now', '-".$config->get('security.client.temp.blacklist.filter.period')." MINUTES')";
}
$result = $this->query($sqlQuery);
if (isset($result[0])) {
$row = $result[0];
} else {
throw new AlphaException('No result set returned when querying the bad request table');
}
if (isset($row['request_count'])) {
return $row['request_count'];
} else {
return 0;
}
}
}