Merge pull request #1715 from PrivateBin/i18n/soften-html-encoding

fix: do not encode source JSON translation string resulting in wrong display of special characters like '
This commit is contained in:
El RIDO 2025-12-03 19:07:17 +01:00 committed by GitHub
commit 4f28c357ae
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 8 deletions

View file

@ -127,14 +127,13 @@ class I18n
} else {
$args[0] = self::$_translations[$messageId];
}
// encode any non-integer arguments and the message ID, if it doesn't contain a link or keyboard input
// encode any non-integer arguments, but not the message itself
// The message ID comes from trusted sources (code or translation JSON files),
// while parameters may come from untrusted sources and need HTML entity encoding
// to prevent XSS attacks when the message is inserted into HTML context
$argsCount = count($args);
for ($i = 0; $i < $argsCount; ++$i) {
if ($i === 0) {
if (str_contains($args[0], '<a') || str_contains($args[0], '<kbd>')) {
continue;
}
} elseif (is_int($args[$i])) {
for ($i = 1; $i < $argsCount; ++$i) {
if (is_int($args[$i])) {
continue;
}
$args[$i] = self::encode($args[$i]);

View file

@ -38,6 +38,7 @@ class I18nTest extends TestCase
public function tearDown(): void
{
unset($_COOKIE['lang'], $_SERVER['HTTP_ACCEPT_LANGUAGE']);
I18n::loadTranslations();
}
public function testTranslationFallback()
@ -183,7 +184,19 @@ class I18nTest extends TestCase
$result = htmlspecialchars($input, ENT_QUOTES | ENT_HTML5 | ENT_DISALLOWED, 'UTF-8', false);
$this->assertEquals($result, I18n::encode($input), 'encodes HTML entities');
$this->assertEquals('<a>some ' . $result . ' + 1</a>', I18n::_('<a>some %s + %d</a>', $input, 1), 'encodes parameters in translations');
$this->assertEquals($result . $result, I18n::_($input . '%s', $input), 'encodes message ID as well, when no link');
// Message ID should NOT be encoded (it comes from trusted source), only the parameter should be
$this->assertEquals($input . $result, I18n::_($input . '%s', $input), 'encodes only parameters, not message ID');
}
public function testApostropheEncodngInMessage()
{
$_SERVER['HTTP_ACCEPT_LANGUAGE'] = 'fr';
I18n::loadTranslations();
// For example, the French translation should not have the apostrophe encoded
// See https://github.com/PrivateBin/PrivateBin/issues/1712
$message = I18n::_('Document does not exist, has expired or has been deleted.');
$this->assertFalse(strpos($message, '&apos;') !== false, 'French apostrophe should not be encoded in translation message');
$this->assertTrue(strpos($message, "n'existe") !== false, 'French apostrophe should be present as literal character');
}
public function testFallbackAlwaysPresent()