Skip to content

fix(CrawlService): Validate actual response body size in archiveFile #2579

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
Huge wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(CrawlService): Validate actual response body size in archiveFile #2579

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
47 changes: 26 additions & 21 deletions lib/Service/CrawlService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,28 +129,33 @@ private function archiveFile(Bookmark $bookmark, IResponse $resp): void {

if ($contentType !== null && !str_contains($contentType, 'text/html') && $bookmark->getArchivedFile() === null) {
$contentLengthHeader = $resp->getHeader('Content-Length');
$contentLength = $contentLengthHeader !== '' ? (int)$contentLengthHeader : 0;
if ($contentLengthHeader !== '' && (int)$contentLengthHeader >= self::MAX_BODY_LENGTH) {
return;
}

if ($contentLength < self::MAX_BODY_LENGTH) {
try {
$userFolder = $this->rootFolder->getUserFolder($bookmark->getUserId());
$folderPath = $this->getArchivePath($bookmark, $userFolder);
$name = $bookmark->slugify('title');
$extension = $this->mimey->getExtension($contentType) ?? 'txt';

$i = 0;
do {
$path = $folderPath . '/' . $name . ($i > 0 ? '_' . $i : '') . '.' . $extension;
$i++;
} while ($userFolder->nodeExists($path));

$file = $userFolder->newFile($path);
$file->putContent($resp->getBody());
$bookmark->setArchivedFile($file->getId());
$this->bookmarkMapper->update($bookmark);
} catch (NotPermittedException|NoUserException|GenericFileException|LockedException|UrlParseError|InvalidPathException|NotFoundException $e) {
$this->logger->debug(get_class($e) . ' ' . $e->getMessage() . "\r\n" . $e->getTraceAsString());
}
$body = $resp->getBody();
if (strlen($body) >= self::MAX_BODY_LENGTH) {
return;
}

try {
$userFolder = $this->rootFolder->getUserFolder($bookmark->getUserId());
$folderPath = $this->getArchivePath($bookmark, $userFolder);
$name = $bookmark->slugify('title');
$extension = $this->mimey->getExtension($contentType) ?? 'txt';

$i = 0;
do {
$path = $folderPath . '/' . $name . ($i > 0 ? '_' . $i : '') . '.' . $extension;
$i++;
} while ($userFolder->nodeExists($path));

$file = $userFolder->newFile($path);
$file->putContent($body);
$bookmark->setArchivedFile($file->getId());
$this->bookmarkMapper->update($bookmark);
} catch (NotPermittedException|NoUserException|GenericFileException|LockedException|UrlParseError|InvalidPathException|NotFoundException $e) {
$this->logger->debug(get_class($e) . ' ' . $e->getMessage() . "\r\n" . $e->getTraceAsString());
}
}
}
Expand Down
161 changes: 161 additions & 0 deletions tests/CrawlServiceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
<?php

namespace OCA\Bookmarks\Tests;

use OCA\Bookmarks\Db\Bookmark;
use OCA\Bookmarks\Db\BookmarkMapper;
use OCA\Bookmarks\Service\BookmarkPreviewer;
use OCA\Bookmarks\Service\CrawlService;
use OCA\Bookmarks\Service\FaviconPreviewer;
use OCA\Bookmarks\Service\UserSettingsService;
use OCP\Files\File;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
use OCP\Http\Client\IResponse;
use OCP\IConfig;
use OCP\IL10N;
use Psr\Log\LoggerInterface;

class CrawlServiceTest extends TestCase {
private BookmarkMapper $bookmarkMapper;
private BookmarkPreviewer $bookmarkPreviewer;
private FaviconPreviewer $faviconPreviewer;
private IClientService $clientService;
private IClient $client;
private IConfig $config;
private IRootFolder $rootFolder;
private IL10N $l10n;
private LoggerInterface $logger;
private UserSettingsService $userSettings;
private CrawlService $crawlService;
private Folder $userFolder;
private File $file;

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

$this->bookmarkMapper = $this->createMock(BookmarkMapper::class);
$this->bookmarkPreviewer = $this->createMock(BookmarkPreviewer::class);
$this->faviconPreviewer = $this->createMock(FaviconPreviewer::class);
$this->client = $this->createMock(IClient::class);
$this->clientService = $this->createMock(IClientService::class);
$this->clientService->method('newClient')->willReturn($this->client);
$this->config = $this->createMock(IConfig::class);
$this->rootFolder = $this->createMock(IRootFolder::class);
$this->l10n = $this->createMock(IL10N::class);
$this->logger = $this->createMock(LoggerInterface::class);
$this->userSettings = $this->createMock(UserSettingsService::class);

$this->userFolder = $this->createMock(Folder::class);
$this->file = $this->createMock(File::class);

$this->rootFolder->method('getUserFolder')->with('testuser')->willReturn($this->userFolder);
$this->userSettings->method('get')->with('archive.enabled')->willReturn('true');
$this->config->method('getUserValue')->willReturn('Bookmarks');

$this->crawlService = new CrawlService(
$this->bookmarkMapper,
$this->bookmarkPreviewer,
$this->faviconPreviewer,
$this->clientService,
$this->config,
$this->rootFolder,
$this->l10n,
$this->logger,
$this->userSettings
);
}

public function testArchiveFileRejectsMissingContentLengthWhenBodyOversized(): void {
$bookmark = new Bookmark();
$bookmark->setUrl('https://example.com/oversized.bin');
$bookmark->setUserId('testuser');
$bookmark->setTitle('Oversized File');

$oversizedBody = str_repeat('A', CrawlService::MAX_BODY_LENGTH + 1024);

$response = $this->createMock(IResponse::class);
$response->method('getStatusCode')->willReturn(200);
$response->method('getHeader')->willReturnCallback(function ($header) {
if ($header === 'Content-Type') {
return 'application/octet-stream';
}
if ($header === 'Content-Length') {
return ''; // Missing Content-Length header (chunked)
}
return '';
});
$response->method('getBody')->willReturn($oversizedBody);

$this->client->method('get')->willReturn($response);

// An oversized body MUST NOT be written to user storage
$this->userFolder->expects($this->never())->method('newFile');

$this->crawlService->crawl($bookmark);
}

public function testArchiveFileRejectsSpoofedContentLengthWhenBodyOversized(): void {
$bookmark = new Bookmark();
$bookmark->setUrl('https://example.com/spoofed.bin');
$bookmark->setUserId('testuser');
$bookmark->setTitle('Spoofed Size File');

$oversizedBody = str_repeat('A', CrawlService::MAX_BODY_LENGTH + 1024);

$response = $this->createMock(IResponse::class);
$response->method('getStatusCode')->willReturn(200);
$response->method('getHeader')->willReturnCallback(function ($header) {
if ($header === 'Content-Type') {
return 'application/octet-stream';
}
if ($header === 'Content-Length') {
return '10'; // Falsified small Content-Length header
}
return '';
});
$response->method('getBody')->willReturn($oversizedBody);

$this->client->method('get')->willReturn($response);

// An oversized body MUST NOT be written to user storage
$this->userFolder->expects($this->never())->method('newFile');

$this->crawlService->crawl($bookmark);
}

public function testArchiveFileSavesValidBodyWithinLimit(): void {
$bookmark = new Bookmark();
$bookmark->setUrl('https://example.com/valid.bin');
$bookmark->setUserId('testuser');
$bookmark->setTitle('Valid File');

$validBody = 'small file payload';

$response = $this->createMock(IResponse::class);
$response->method('getStatusCode')->willReturn(200);
$response->method('getHeader')->willReturnCallback(function ($header) {
if ($header === 'Content-Type') {
return 'application/octet-stream';
}
if ($header === 'Content-Length') {
return (string)strlen('small file payload');
}
return '';
});
$response->method('getBody')->willReturn($validBody);

$this->client->method('get')->willReturn($response);

$this->userFolder->method('nodeExists')->willReturn(false);
$this->userFolder->expects($this->once())->method('newFile')->willReturn($this->file);
$this->file->expects($this->once())->method('putContent')->with($validBody);
$this->file->method('getId')->willReturn(12345);

$this->crawlService->crawl($bookmark);

$this->assertEquals(12345, $bookmark->getArchivedFile());
}
}