Skip to content

Escape spreadsheet formulas when exporting visits as CSV #2665

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

Closed
matheuscabral-appx wants to merge 2 commits into from
Closed

Escape spreadsheet formulas when exporting visits as CSV #2665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75807bb
Escape spreadsheet formulas when exporting visits as CSV
matheuscabral-appx Sep 23, 2026
1db12b1
Link PR in changelog entry
matheuscabral-appx Sep 23, 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
17 changes: 17 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).

## [Unreleased]
### Added
* *Nothing*

### Changed
* *Nothing*

### Deprecated
* *Nothing*

### Removed
* *Nothing*

### Fixed
* [#2665](https://github.com/shlinkio/shlink/pull/2665) Escape values that could be interpreted as spreadsheet formulas when exporting visits in CSV format, to address [CVE-2026-18738](https://nvd.nist.gov/vuln/detail/CVE-2026-18738).


## [5.1.7] - 2026-09-21
### Added
* *Nothing*
Expand Down
2 changes: 2 additions & 0 deletions module/CLI/src/Command/Visit/VisitsCommandUtils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Shlinkio\Shlink\CLI\Command\Visit;

use League\Csv\EscapeFormula;
use League\Csv\Writer;
use Shlinkio\Shlink\CLI\Input\VisitsListFormat;
use Shlinkio\Shlink\CLI\Input\VisitsListInput;
Expand Down Expand Up @@ -48,6 +49,7 @@ private static function renderCSVOutput(OutputInterface $output, Paginator $pagi

[$rows, $headers] = self::resolveRowsAndHeaders($paginator);
$csv = Writer::fromString();
$csv->addFormatter(new EscapeFormula()->escapeRecord(...));
if ($page === 1) {
$csv->insertOne($headers);
}
Expand Down
28 changes: 28 additions & 0 deletions module/CLI/test/Command/ShortUrl/GetShortUrlVisitsCommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,34 @@ public function outputIsProperlyGenerated(VisitsListFormat $format, callable $ge
self::assertEquals($getExpectedOutput($visit->date), $output);
}

#[Test]
public function formulasAreEscapedInCsvOutput(): void
{
$maliciousVisit = Visit::forValidShortUrl(ShortUrl::createFake(), Visitor::fromParams('=1+1', '@SUM(A1)'));
$regularVisit = Visit::forValidShortUrl(
ShortUrl::createFake(),
Visitor::fromParams('Mozilla/5.0', 'https://example.com'),
);
$shortCode = 'abc123';
$this->visitsHelper
->expects($this->once())
->method('visitsForShortUrl')
->willReturn(new Paginator(new ArrayAdapter([$maliciousVisit, $regularVisit])));

$this->commandTester->execute(['short-code' => $shortCode, '--format' => VisitsListFormat::CSV->value]);
$output = $this->commandTester->getDisplay();

self::assertEquals(
<<<OUTPUT
Date,"Potential bot","User agent",Referer,Country,Region,City,"Visited URL","Redirect URL",Type
{$maliciousVisit->date->toAtomString()},,'=1+1,'@SUM(A1),Unknown,Unknown,Unknown,,Unknown,valid_short_url
{$regularVisit->date->toAtomString()},,Mozilla/5.0,https://example.com,Unknown,Unknown,Unknown,,Unknown,valid_short_url

OUTPUT,
$output,
);
}

public static function provideOutput(): iterable
{
yield 'regular' => [
Expand Down