Skip to content

fix(metrics): truncate header-derived values and validate location length on metrics enter/leave #631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
romanetar wants to merge 3 commits into
base: main
Choose a base branch
from
+145 −6
Open

fix(metrics): truncate header-derived values and validate location length on metrics enter/leave #631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f1f264
fix(metrics): truncate header-derived values and validate location le…
romanetar Oct 12, 2026
4af7c1b
fix(metrics): truncate location server-side instead of rejecting it w…
romanetar Oct 19, 2026
afa542e
fix(metrics): keep location untruncated, its column is TEXT
romanetar Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions app/Models/Foundation/Summit/Metrics/SummitMetric.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ class SummitMetric extends SilverstripeBaseModel
{
use SummitOwned;

/**
* max length (in characters) of the Ip, Origin and Browser VARCHAR columns
*/
const MaxStringColumnLength = 255;

/**
* @var \DateTime
*/
Expand All @@ -44,7 +49,7 @@ class SummitMetric extends SilverstripeBaseModel
/**
* @var string|null
*/
#[ORM\Column(name: 'Ip', type: 'string')]
#[ORM\Column(name: 'Ip', type: 'string', length: self::MaxStringColumnLength)]
protected $ip;

/**
Expand All @@ -56,7 +61,7 @@ class SummitMetric extends SilverstripeBaseModel
/**
* @var string|null
*/
#[ORM\Column(name: 'Origin', type: 'string')]
#[ORM\Column(name: 'Origin', type: 'string', length: self::MaxStringColumnLength)]
protected $origin;

/**
Expand All @@ -68,7 +73,7 @@ class SummitMetric extends SilverstripeBaseModel
/**
* @var string|null
*/
#[ORM\Column(name: 'Browser', type: 'string')]
#[ORM\Column(name: 'Browser', type: 'string', length: self::MaxStringColumnLength)]
protected $browser;

/**
Expand Down Expand Up @@ -164,12 +169,24 @@ public static function build(?Member $member = null){
$metric = new static();
$metric->member = $member;
$metric->ingress_date = new \DateTime('now', new \DateTimeZone('UTC'));
$metric->ip = UserClientHelper::getUserIp();
$metric->origin = UserClientHelper::getUserOrigin();
$metric->browser = UserClientHelper::getUserBrowser();
$metric->ip = self::truncate(UserClientHelper::getUserIp());
$metric->origin = self::truncate(UserClientHelper::getUserOrigin());
$metric->browser = self::truncate(UserClientHelper::getUserBrowser());
return $metric;
}

/**
* Header derived values are client controlled, cut them to the column length
* (characters, not bytes) so the INSERT never fails with "Data too long".
* @param string|null $value
* @return string|null
*/
private static function truncate(?string $value): ?string
{
if (is_null($value)) return null;
return mb_substr($value, 0, self::MaxStringColumnLength);
}

/**
* @return int
*/
Expand Down
122 changes: 122 additions & 0 deletions tests/oauth2/OAuth2SummitMetricsApiControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,30 @@ class OAuth2SummitMetricsApiControllerTest extends ProtectedApiTestCase

use InsertMemberTestData;

/**
* @var array original $_SERVER values overridden by the tests
*/
private $original_server = [];

private const OverriddenServerKeys = ['HTTP_USER_AGENT', 'HTTP_REFERER', 'HTTP_X_FORWARDED_FOR'];

protected function setUp():void
{
parent::setUp();
foreach (self::OverriddenServerKeys as $key) {
$this->original_server[$key] = array_key_exists($key, $_SERVER) ? $_SERVER[$key] : null;
}
self::insertMemberTestData(IGroup::TrackChairs);
self::$defaultMember = self::$member;
self::insertSummitTestData();
}

protected function tearDown():void
{
foreach ($this->original_server as $key => $value) {
if (is_null($value)) unset($_SERVER[$key]);
else $_SERVER[$key] = $value;
}
self::clearSummitTestData();
self::clearMemberTestData();
parent::tearDown();
Expand Down Expand Up @@ -71,6 +85,114 @@ public function testEnter(){
return $metric;
}

private function enterMetric(array $extra = [])
{
$params = [
'id' => self::$summit->getId(),
];

$data = array_merge(['type' => \models\summit\ISummitMetricType::General], $extra);

$headers = [
"HTTP_Authorization" => " Bearer " . $this->access_token,
"CONTENT_TYPE" => "application/json",
];

return $this->action(
"PUT",
"OAuth2SummitMetricsApiController@enter",
$params,
[],
[],
[],
$headers,
json_encode($data)
);
}

public function testEnterTruncatesLongHeaders(){
$_SERVER['HTTP_USER_AGENT'] = str_repeat('a', 300);
$_SERVER['HTTP_REFERER'] = str_repeat('b', 300);
$_SERVER['HTTP_X_FORWARDED_FOR'] = str_repeat('1', 300);

$response = $this->enterMetric();
$this->assertResponseStatus(201);
$metric = json_decode($response->getContent());
$this->assertEquals(str_repeat('a', 255), $metric->browser);
$this->assertEquals(str_repeat('b', 255), $metric->origin);
$this->assertEquals(str_repeat('1', 255), $metric->ip);
}

public function testEnterTruncatesMultibyteUserAgent(){
$ua = str_repeat('é', 300);
$_SERVER['HTTP_USER_AGENT'] = $ua;

$response = $this->enterMetric();
$this->assertResponseStatus(201);
$metric = json_decode($response->getContent());
$this->assertEquals(mb_substr($ua, 0, 255), $metric->browser);
$this->assertEquals(255, mb_strlen($metric->browser));
$this->assertTrue(mb_check_encoding($metric->browser, 'UTF-8'));
}

public function testEnterKeepsShortUserAgent(){
$ua = str_repeat('a', 255);
$_SERVER['HTTP_USER_AGENT'] = $ua;

$response = $this->enterMetric();
$this->assertResponseStatus(201);
$metric = json_decode($response->getContent());
$this->assertEquals($ua, $metric->browser);
}

private function getStoredLocation(int $metric_id): ?string
{
$em = \LaravelDoctrine\ORM\Facades\Registry::getManager(\models\utils\SilverstripeBaseModel::EntityManager);
$em->clear();
return $em->find(\models\summit\SummitMetric::class, $metric_id)->getLocation();
}

public function testEnterKeepsLongLocation(){
$response = $this->enterMetric(['location' => str_repeat('l', 300)]);
$this->assertResponseStatus(201);
$metric = json_decode($response->getContent());
$this->assertEquals(str_repeat('l', 300), $this->getStoredLocation($metric->id));
}

public function testEnterStoresDecodedLocation(){
$location = str_repeat('é', 200);
$encoded = rawurlencode($location);
$this->assertGreaterThan(255, strlen($encoded));

$response = $this->enterMetric(['location' => $encoded]);
$this->assertResponseStatus(201);
$metric = json_decode($response->getContent());
$this->assertEquals($location, $this->getStoredLocation($metric->id));
}

public function testLeaveLongLocationIsAccepted(){
$this->enterMetric();
$this->assertResponseStatus(201);

$this->action(
"POST",
"OAuth2SummitMetricsApiController@leave",
['id' => self::$summit->getId()],
[],
[],
[],
[
"HTTP_Authorization" => " Bearer " . $this->access_token,
"CONTENT_TYPE" => "application/json",
],
json_encode([
'type' => \models\summit\ISummitMetricType::General,
'location' => str_repeat('l', 300),
])
);
$this->assertResponseStatus(201);
}

public function testEnterEvent(){

$params = [
Expand Down
Loading