Skip to content

fix(security): escape link URLs in activity email templates #2551

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
karlitschek wants to merge 1 commit into
base: master
Choose a base branch
from
+122 −4
Open

fix(security): escape link URLs in activity email templates #2551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions lib/DigestSender.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ public function sendDigestForUser(IUser $user, int $now, string $timezone, strin
$andMoreText = $l10n->n('and %n more…', 'and %n more…', $skippedCount);
$url = $this->urlGenerator->linkToRouteAbsolute('activity.Activities.showList', [ 'filter' => 'all' ]);
$template->addBodyListItem(
'<a href="' . $url . '">' . htmlspecialchars($andMoreText) . '</a>',
'<a href="' . htmlspecialchars($url) . '">' . htmlspecialchars($andMoreText) . '</a>',
plainText: $andMoreText,
);
}
Expand Down Expand Up @@ -235,7 +235,7 @@ protected function getHTMLSubject(IEvent $event): string {
}

if (isset($parameter['link'])) {
$replacements[] = '<a href="' . $parameter['link'] . '">' . htmlspecialchars($replacement) . '</a>';
$replacements[] = '<a href="' . htmlspecialchars((string)$parameter['link']) . '">' . htmlspecialchars($replacement) . '</a>';
} else {
$replacements[] = '<strong>' . htmlspecialchars($replacement) . '</strong>';
}
Expand Down
4 changes: 2 additions & 2 deletions lib/MailQueueHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ function ($event) use ($timezone, $l) {
$template->addHeader();
$template->addHeading($l->t('Hello %s', [$user->getDisplayName()]), $l->t('Hello %s,', [$user->getDisplayName()]));

$homeLink = '<a href="' . $this->urlGenerator->getAbsoluteURL('/') . '">' . htmlspecialchars($this->getSenderData('name')) . '</a>';
$homeLink = '<a href="' . htmlspecialchars($this->urlGenerator->getAbsoluteURL('/')) . '">' . htmlspecialchars($this->getSenderData('name')) . '</a>';
$template->addBodyText(
$l->t('There was some activity at %s', [$homeLink]),
$l->t('There was some activity at %s', [$this->urlGenerator->getAbsoluteURL('/')])
Expand Down Expand Up @@ -394,7 +394,7 @@ protected function getHTMLSubject(IEvent $event): string {
}

if (isset($parameter['link'])) {
$replacements[] = '<a href="' . $parameter['link'] . '">' . htmlspecialchars($replacement) . '</a>';
$replacements[] = '<a href="' . htmlspecialchars((string)$parameter['link']) . '">' . htmlspecialchars($replacement) . '</a>';
} else {
$replacements[] = '<strong>' . htmlspecialchars($replacement) . '</strong>';
}
Expand Down
83 changes: 83 additions & 0 deletions tests/DigestSenderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<?php

declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OCA\Activity\Tests;

use OCA\Activity\Data;
use OCA\Activity\DigestSender;
use OCA\Activity\GroupHelper;
use OCA\Activity\UserSettings;
use OCP\Activity\IEvent;
use OCP\Activity\IManager;
use OCP\Defaults;
use OCP\IConfig;
use OCP\IDateTimeFormatter;
use OCP\IURLGenerator;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use OCP\Mail\IMailer;
use PHPUnit\Framework\Attributes\DataProvider;
use Psr\Log\LoggerInterface;

class DigestSenderTest extends TestCase {
private DigestSender $digestSender;

protected function setUp(): void {
parent::setUp();

$this->digestSender = new DigestSender(
$this->createMock(IConfig::class),
$this->createMock(Data::class),
$this->createMock(UserSettings::class),
$this->createMock(GroupHelper::class),
$this->createMock(IMailer::class),
$this->createMock(IManager::class),
$this->createMock(IUserManager::class),
$this->createMock(IURLGenerator::class),
$this->createMock(Defaults::class),
$this->createMock(IFactory::class),
$this->createMock(IDateTimeFormatter::class),
$this->createMock(LoggerInterface::class),
);
}

public static function provideGetHTMLSubjectData(): array {
return [
'no rich subject escapes parsed subject' => [
'', 'Hello <World>', [],
'Hello &lt;World&gt;',
],
'linked parameter renders anchor' => [
'File {file} was shared', '',
['file' => ['type' => 'file', 'path' => 'photo.jpg', 'name' => 'photo.jpg', 'link' => 'https://cloud.example.com/f/123']],
'File <a href="https://cloud.example.com/f/123">photo.jpg</a> was shared',
],
'double-quote in link is escaped' => [
'File {file} was shared', '',
['file' => ['type' => 'file', 'path' => 'photo.jpg', 'name' => 'photo.jpg', 'link' => 'https://cloud.example.com/f/123"onmouseover="alert(1)']],
'File <a href="https://cloud.example.com/f/123&quot;onmouseover=&quot;alert(1)">photo.jpg</a> was shared',
],
'parameter without link uses strong tag' => [
'File {file} was shared', '',
['file' => ['type' => 'file', 'path' => 'photo.jpg', 'name' => 'photo.jpg']],
'File <strong>photo.jpg</strong> was shared',
],
];
}

#[DataProvider('provideGetHTMLSubjectData')]
public function testGetHTMLSubject(string $richSubject, string $parsedSubject, array $richParams, string $expected): void {
$event = $this->createMock(IEvent::class);
$event->method('getRichSubject')->willReturn($richSubject);
$event->method('getParsedSubject')->willReturn($parsedSubject);
$event->method('getRichSubjectParameters')->willReturn($richParams);

$result = self::invokePrivate($this->digestSender, 'getHTMLSubject', [$event]);
$this->assertSame($expected, $result);
}
}
35 changes: 35 additions & 0 deletions tests/MailQueueHandlerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,41 @@ public function testSendEmailsDeletesQueueOnSendReturnFalse(): void {
* @param int $maxTime
* @param string $explain
*/
public static function provideGetHTMLSubjectData(): array {
return [
'no rich subject escapes parsed subject' => [
'', 'Hello <World>', [],
'Hello &lt;World&gt;',
],
'linked parameter renders anchor' => [
'File {file} was shared', '',
['file' => ['type' => 'file', 'path' => 'photo.jpg', 'name' => 'photo.jpg', 'link' => 'https://cloud.example.com/f/123']],
'File <a href="https://cloud.example.com/f/123">photo.jpg</a> was shared',
],
'double-quote in link is escaped' => [
'File {file} was shared', '',
['file' => ['type' => 'file', 'path' => 'photo.jpg', 'name' => 'photo.jpg', 'link' => 'https://cloud.example.com/f/123"onmouseover="alert(1)']],
'File <a href="https://cloud.example.com/f/123&quot;onmouseover=&quot;alert(1)">photo.jpg</a> was shared',
],
'parameter without link uses strong tag' => [
'File {file} was shared', '',
['file' => ['type' => 'file', 'path' => 'photo.jpg', 'name' => 'photo.jpg']],
'File <strong>photo.jpg</strong> was shared',
],
];
}

#[DataProvider('provideGetHTMLSubjectData')]
public function testGetHTMLSubject(string $richSubject, string $parsedSubject, array $richParams, string $expected): void {
$event = $this->createMock(IEvent::class);
$event->method('getRichSubject')->willReturn($richSubject);
$event->method('getParsedSubject')->willReturn($parsedSubject);
$event->method('getRichSubjectParameters')->willReturn($richParams);

$result = self::invokePrivate($this->mailQueueHandler, 'getHTMLSubject', [$event]);
$this->assertSame($expected, $result);
}

protected function assertRemainingMailEntries(array $users, int $maxTime, string $explain): void {
foreach ($users as $user) {
[$data,] = self::invokePrivate($this->mailQueueHandler, 'getItemsForUser', [$user, $maxTime]);
Expand Down
Loading