composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-12 23:14:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

🎨 N°8231 Code format and comments

Browse Source
This commit is contained in:
Romain Quetiez
2025-03-25 11:48:23 +01:00
parent 90370fce3b
commit 02adca0a1f
3 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
application/applicationextension.inc.php
View File

@@ -1711,6 +1711,11 @@ interface iRestServiceProvider
public function ExecOperation($sVersion, $sVerb, $aParams);
}
/**
* A REST service provider implementing this interface will have its input JSON data sanitized for logging purposes
* @since 2.7.13, 3.2.1-1
* @see \iRestServiceProvider
*/
interface iRestInputSanitizer
{
public function SanitizeJsonInput(string $sJsonInput): string;

14
core/restservices.class.inc.php
View File

@@ -159,16 +159,15 @@ class ObjectResult
$this->fields[$sAttCode] = $this->MakeResultValue($oObject, $sAttCode, $bExtendedOutput);
}
public function SanitizeContent()
public function SanitizeContent()
{
foreach($this->fields as $sFieldAttCode => $fieldValue)
{
foreach($this->fields as $sFieldAttCode => $fieldValue) {
try {
$oAttDef = MetaModel::GetAttributeDef($this->class, $sFieldAttCode);
} catch (Exception $e) { // for special cases like ID
continue;
}
$this->SanitizeFieldIfSensitive($this->fields, $sFieldAttCode, $fieldValue, $oAttDef);
$this->SanitizeFieldIfSensitive($this->fields, $sFieldAttCode, $fieldValue, $oAttDef);
}
}
}
@@ -929,6 +928,10 @@ class CoreServices implements iRestServiceProvider, iRestInputSanitizer
}
}
/**
* Sanitizes sensitive fields on a "json ready" representation of a DBObject
* Useful for logging purposes
*/
trait SanitizeTrait
{
/**
@@ -942,8 +945,7 @@ trait SanitizeTrait
private function SanitizeFieldIfSensitive(array &$fields, string $sFieldAttCode, $fieldValue, $oAttDef): void
{
// for simple attribute
if ($oAttDef instanceof iAttributeNoGroupBy) // iAttributeNoGroupBy is equivalent to sensitive attribute
{
if ($oAttDef instanceof iAttributeNoGroupBy) { // iAttributeNoGroupBy is equivalent to sensitive attribute
$fields[$sFieldAttCode] = '*****';
return;
}

14
tests/php-unit-tests/unitary-tests/core/RestServicesSanitizeOutputTest.php
View File

@@ -24,11 +24,11 @@ class RestServicesSanitizeOutputTest extends ItopCustomDatamodelTestCase
private const SIMPLE_PASSWORD = '123456';
/**
* @throws Exception
* @return string Abs path to the XML delta to use for the tests of that class
*/
protected function setUp(): void
public function GetDatamodelDeltaAbsPath(): string
{
parent::setUp();
return __DIR__.'/Delta/delta_test_sanitize_output.xml';
}
/**
@@ -156,12 +156,4 @@ class RestServicesSanitizeOutputTest extends ItopCustomDatamodelTestCase
json_encode($oRestResultWithObject));
}
/**
* @return string Abs path to the XML delta to use for the tests of that class
*/
public function GetDatamodelDeltaAbsPath(): string
{
return __DIR__.'/Delta/delta_test_sanitize_output.xml';
}
}