plugins-nextcloud-mirror/libresign
1
0
Fork 0
mirror of https://github.com/LibreSign/libresign.git synced 2025-12-18 05:20:45 +01:00
Code Projects Releases Activity
libresign/tests/php/Unit/Handler/SignEngine/JSignPdfHandlerTest.php
Vitor Mattos fb1e7f5249
chore: fix tests after move files 
Signed-off-by: Vitor Mattos <vitor@php.rio>
2025-05-21 09:34:40 -03:00

453 lines
18 KiB
PHP
Raw Blame History

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2020-2024 LibreCode coop and contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Libresign\Tests\Unit\Service;
use Jeidison\JSignPDF\JSignPDF;
use Jeidison\JSignPDF\Sign\JSignParam;
use OCA\Libresign\AppInfo\Application;
use OCA\Libresign\DataObjects\VisibleElementAssoc;
use OCA\Libresign\Db\FileElement;
use OCA\Libresign\Handler\CertificateEngine\CertificateEngineFactory;
use OCA\Libresign\Handler\SignEngine\JSignPdfHandler;
use OCA\Libresign\Service\SignatureBackgroundService;
use OCA\Libresign\Service\SignatureTextService;
use OCA\Libresign\Service\SignerElementsService;
use OCP\IAppConfig;
use OCP\IDateTimeZone;
use OCP\IRequest;
use OCP\ITempManager;
use OCP\IUserSession;
use OCP\L10N\IFactory as IL10NFactory;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
/**
* @internal
*/
final class JSignPdfHandlerTest extends \OCA\Libresign\Tests\Unit\TestCase {
private IAppConfig $appConfig;
private LoggerInterface&MockObject $loggerInterface;
private ITempManager $tempManager;
private SignatureBackgroundService&MockObject $signatureBackgroundService;
private static CertificateEngineFactory $certificateEngineFactory;
private static string $certificateContent = '';
public static function setUpBeforeClass(): void {
parent::setUpBeforeClass();
self::$certificateEngineFactory = \OCP\Server::get(CertificateEngineFactory::class);
$appConfig = self::getMockAppConfig();
$appConfig->setValueString(Application::APP_ID, 'certificate_engine', 'openssl');
$certificateEngine = self::$certificateEngineFactory->getEngine();
$certificateEngine
->setConfigPath(\OCP\Server::get(ITempManager::class)->getTemporaryFolder('certificate'))
->generateRootCert('', []);
self::$certificateContent = $certificateEngine
->setHosts(['user@email.tld'])
->setCommonName('John Doe')
->setPassword('password')
->generateCertificate();
}
public function setUp(): void {
$this->appConfig = $this->getMockAppConfig();
$this->loggerInterface = $this->createMock(LoggerInterface::class);
$this->tempManager = \OCP\Server::get(ITempManager::class);
$this->signatureBackgroundService = $this->createMock(SignatureBackgroundService::class);
}
private function getInstance(array $methods = []): JSignPdfHandler|MockObject {
$signatureTextService = new SignatureTextService(
$this->appConfig,
\OCP\Server::get(IL10NFactory::class)->get(Application::APP_ID),
\OCP\Server::get(IDateTimeZone::class),
\OCP\Server::get(IRequest::class),
\OCP\Server::get(IUserSession::class),
);
if (empty($methods)) {
return new JSignPdfHandler(
$this->appConfig,
$this->loggerInterface,
$signatureTextService,
$this->tempManager,
$this->signatureBackgroundService,
self::$certificateEngineFactory,
);
}
return $this->getMockBuilder(JSignPdfHandler::class)
->setConstructorArgs([
$this->appConfig,
$this->loggerInterface,
$signatureTextService,
$this->tempManager,
$this->signatureBackgroundService,
self::$certificateEngineFactory,
])
->onlyMethods($methods)
->getMock();
}
#[DataProvider('providerGetHashAlgorithm')]
public function testGetHashAlgorithm(string $setting, string $content, string $expected): void {
$this->appConfig->setValueString('libresign', 'signature_hash_algorithm', $setting);
$instance = $this->getInstance(['getInputFile']);
$file = $this->createMock(\OCP\Files\File::class);
$file->method('getContent')->willReturn($content);
$instance->method('getInputFile')->willReturn($file);
$actual = self::invokePrivate($instance, 'getHashAlgorithm');
$this->assertEquals($expected, $actual);
}
public static function providerGetHashAlgorithm(): array {
return [
'empty setting, PDF 1.6' => ['', '%PDF-1.6', 'SHA256'],
'invalid PDF header' => ['', 'random data', 'SHA256'],
'invalid setting, fallback to SHA256 on PDF 1.7' => ['XYZ', '%PDF-1.7', 'SHA256'],
'null-like setting, PDF 1.5' => ['0', '%PDF-1.5', 'SHA1'],
'default with PDF 1.0' => ['', '%PDF-1', 'SHA1'],
'SHA1 with PDF 1.5' => ['', '%PDF-1.5', 'SHA1'],
'SHA1 with PDF 1.6' => ['', '%PDF-1.6', 'SHA256'],
'SHA1 with PDF 1.7' => ['', '%PDF-1.7', 'SHA256'],
'SHA1 with PDF 2.0' => ['', '%PDF-2.0', 'SHA256'],
'SHA384, PDF 1.6 (fallback)' => ['SHA384', '%PDF-1.6', 'SHA256'],
'SHA384, PDF 1.7' => ['SHA384', '%PDF-1.7', 'SHA384'],
'SHA512, PDF 1.6' => ['SHA512', '%PDF-1.6', 'SHA256'],
'RIPEMD160, PDF 1.6 (unsupported)' => ['RIPEMD160', '%PDF-1.6', 'SHA256'],
'RIPEMD160, PDF 1.7 (supported)' => ['RIPEMD160', '%PDF-1.7', 'RIPEMD160'],
];
}
#[DataProvider('providerSignAffectedParams')]
public function testSignAffectedParams(
array $visibleElements,
float $signatureWidth,
float $signatureHeight,
string $template,
string $signatureBackgroundType,
string $renderMode,
float $templateFontSize,
string $pdfContent,
?string $hashAlgorithm,
string $params,
):void {
$inputFile = $this->createMock(\OC\Files\Node\File::class);
$inputFile->method('getContent')
->willReturn($pdfContent);
$mock = $this->createMock(JSignPDF::class);
$mock->method('sign')->willReturn('content');
$this->signatureBackgroundService->method('getSignatureBackgroundType')->willReturn(
$signatureBackgroundType
);
$this->signatureBackgroundService->method('getImagePath')->willReturn(
realpath(__DIR__ . '/../../../../../img/LibreSign.png')
);
$this->appConfig->setValueFloat('libresign', 'template_font_size', $templateFontSize);
$this->appConfig->setValueString('libresign', 'signature_render_mode', $renderMode);
$this->appConfig->setValueString('libresign', 'signature_text_template', $template);
$this->appConfig->setValueString('libresign', 'signature_hash_algorithm', $hashAlgorithm);
$this->appConfig->setValueString('libresign', 'java_path', __FILE__);
$this->appConfig->setValueString('libresign', 'jsignpdf_temp_path', sys_get_temp_dir());
$this->appConfig->setValueString('libresign', 'jsignpdf_jar_path', __FILE__);
$this->appConfig->setValueFloat('libresign', 'signature_width', $signatureWidth);
$this->appConfig->setValueFloat('libresign', 'signature_height', $signatureHeight);
$jSignPdfHandler = $this->getInstance();
$jSignPdfHandler->setVisibleElements($visibleElements);
$jSignPdfHandler->setJSignPdf($mock);
$jSignPdfHandler->setInputFile($inputFile);
$jSignPdfHandler->setCertificate(self::$certificateContent);
$jSignPdfHandler->setPassword('password');
$actual = $jSignPdfHandler->getSignedContent();
$this->assertEquals('content', $actual);
$jSignParam = $jSignPdfHandler->getJSignParam();
$this->assertEquals('password', $jSignParam->getPassword());
$paramsAsOptions = $jSignParam->getJSignParameters();
$paramsAsOptions = preg_replace('/\\/\S+_merged.png/', 'merged.png', $paramsAsOptions);
$paramsAsOptions = preg_replace('/\\/\S+_text_image.png/', 'text_image.png', $paramsAsOptions);
$paramsAsOptions = preg_replace('/\\/\S+LibreSign.png/', 'background.png', $paramsAsOptions);
$paramsAsOptions = preg_replace('/\\/\S+app-dark.png/', 'signature.png', $paramsAsOptions);
$this->assertEquals($params, $paramsAsOptions);
}
public static function providerSignAffectedParams(): array {
return [
'without visible elements' => [
'visibleElements' => [],
'signatureWidth' => 100,
'signatureHeight' => 100,
'template' => '',
'signatureBackgroundType' => '',
'renderMode' => '',
'templateFontSize' => 0,
'pdfContent' => '%PDF-1',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --hash-algorithm SHA1',
],
'page = 1 is default, do not will set the page' => [
'visibleElements' => [self::getElement([
'page' => 1,
'llx' => 0,
'lly' => 0,
'urx' => 0,
'ury' => 0,
], realpath(__DIR__ . '/../../../../../img/app-dark.png'))],
'signatureWidth' => 100,
'signatureHeight' => 100,
'template' => '',
'signatureBackgroundType' => 'default',
'renderMode' => SignerElementsService::RENDER_MODE_DESCRIPTION_ONLY,
'templateFontSize' => 10,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "" -V -llx 0 -lly 0 -urx 0 -ury 0 --bg-path merged.png --hash-algorithm SHA256'
],
'page != 1: will have pg; without template: l2-text empty' => [
'visibleElements' => [self::getElement([
'page' => 2,
'llx' => 10,
'lly' => 20,
'urx' => 30,
'ury' => 40,
], realpath(__DIR__ . '/../../../../../img/app-dark.png'))],
'signatureWidth' => 20,
'signatureHeight' => 20,
'template' => '',
'signatureBackgroundType' => 'default',
'renderMode' => SignerElementsService::RENDER_MODE_DESCRIPTION_ONLY,
'templateFontSize' => 10,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "" -V -pg 2 -llx 10 -lly 20 -urx 30 -ury 40 --bg-path merged.png --hash-algorithm SHA256'
],
'with template we have the l2-text' => [
'visibleElements' => [self::getElement([
'page' => 2,
'llx' => 10,
'lly' => 20,
'urx' => 30,
'ury' => 40,
], realpath(__DIR__ . '/../../../../../img/app-dark.png'))],
'signatureWidth' => 20,
'signatureHeight' => 20,
'template' => 'aaaaa',
'signatureBackgroundType' => 'default',
'renderMode' => SignerElementsService::RENDER_MODE_DESCRIPTION_ONLY,
'templateFontSize' => 10,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "aaaaa" -V -pg 2 -llx 10 -lly 20 -urx 30 -ury 40 --bg-path background.png --hash-algorithm SHA256'
],
'font size != 10' => [
'visibleElements' => [self::getElement([
'page' => 2,
'llx' => 10,
'lly' => 20,
'urx' => 30,
'ury' => 40,
], realpath(__DIR__ . '/../../../../../img/app-dark.png'))],
'signatureWidth' => 20,
'signatureHeight' => 20,
'template' => 'aaaaa',
'signatureBackgroundType' => 'default',
'renderMode' => SignerElementsService::RENDER_MODE_DESCRIPTION_ONLY,
'templateFontSize' => 11,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "aaaaa" -V -pg 2 -llx 10 -lly 20 -urx 30 -ury 40 --font-size 11 --bg-path background.png --hash-algorithm SHA256'
],
'background = deleted: bg-path = signature' => [
'visibleElements' => [self::getElement([
'page' => 2,
'llx' => 10,
'lly' => 20,
'urx' => 30,
'ury' => 40,
], realpath(__DIR__ . '/../../../../../img/app-dark.png'))],
'signatureWidth' => 20,
'signatureHeight' => 20,
'template' => 'aaaaa',
'signatureBackgroundType' => 'deleted',
'renderMode' => SignerElementsService::RENDER_MODE_DESCRIPTION_ONLY,
'templateFontSize' => 10,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "aaaaa" -V -pg 2 -llx 10 -lly 20 -urx 30 -ury 40 --bg-path signature.png --hash-algorithm SHA256'
],
'background and template, bg-path = background, img-path = signature' => [
'visibleElements' => [self::getElement([
'page' => 2,
'llx' => 10,
'lly' => 20,
'urx' => 30,
'ury' => 40,
], realpath(__DIR__ . '/../../../../../img/app-dark.png'))],
'signatureWidth' => 20,
'signatureHeight' => 20,
'template' => 'aaaaa',
'signatureBackgroundType' => 'default',
'renderMode' => SignerElementsService::RENDER_MODE_GRAPHIC_AND_DESCRIPTION,
'templateFontSize' => 10,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "aaaaa" -V -pg 2 -llx 10 -lly 20 -urx 30 -ury 40 --render-mode GRAPHIC_AND_DESCRIPTION --bg-path background.png --img-path signature.png --hash-algorithm SHA256'
],
'background and template, render mode equals to SIGNAME_AND_DESCRIPTION: bg-path = background, img-path = text_image' => [
'visibleElements' => [self::getElement([
'page' => 2,
'llx' => 1,
'lly' => 100,
'urx' => 351,
'ury' => 200,
], realpath(__DIR__ . '/../../../../../img/app-dark.png'))],
'signatureWidth' => 350,
'signatureHeight' => 100,
'template' => 'aaaaa',
'signatureBackgroundType' => 'default',
'renderMode' => SignerElementsService::RENDER_MODE_SIGNAME_AND_DESCRIPTION,
'templateFontSize' => 10,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "aaaaa" -V -pg 2 -llx 1 -lly 100 -urx 351 -ury 200 --render-mode GRAPHIC_AND_DESCRIPTION --bg-path background.png --img-path text_image.png --hash-algorithm SHA256'
],
'template without background; with signature image; render-mode: SIGNAME_AND_DESCRIPTION' => [
'visibleElements' => [self::getElement([
'page' => 2,
'llx' => 10,
'lly' => 20,
'urx' => 30,
'ury' => 40,
], realpath(__DIR__ . '/../../../../../img/app-dark.png'))],
'signatureWidth' => 20,
'signatureHeight' => 20,
'template' => 'aaaaa',
'signatureBackgroundType' => 'deleted',
'renderMode' => SignerElementsService::RENDER_MODE_SIGNAME_AND_DESCRIPTION,
'templateFontSize' => 10,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "aaaaa" -V -pg 2 -llx 10 -lly 20 -urx 30 -ury 40 --render-mode GRAPHIC_AND_DESCRIPTION --img-path text_image.png --hash-algorithm SHA256'
],
'template without background; without signature image; render-mode: SIGNAME_AND_DESCRIPTION' => [
'visibleElements' => [self::getElement([
'page' => 2,
'llx' => 10,
'lly' => 20,
'urx' => 30,
'ury' => 40,
], '')],
'signatureWidth' => 20,
'signatureHeight' => 20,
'template' => 'aaaaa',
'signatureBackgroundType' => 'deleted',
'renderMode' => SignerElementsService::RENDER_MODE_SIGNAME_AND_DESCRIPTION,
'templateFontSize' => 10,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "aaaaa" -V -pg 2 -llx 10 -lly 20 -urx 30 -ury 40 --render-mode GRAPHIC_AND_DESCRIPTION --img-path text_image.png --hash-algorithm SHA256'
],
'background without template: bg-path = merged with signature, without img-path' => [
'visibleElements' => [self::getElement([
'page' => 2,
'llx' => 10,
'lly' => 20,
'urx' => 30,
'ury' => 40,
], realpath(__DIR__ . '/../../../../../img/app-dark.png'))],
'signatureWidth' => 20,
'signatureHeight' => 20,
'template' => '',
'signatureBackgroundType' => 'default',
'renderMode' => SignerElementsService::RENDER_MODE_GRAPHIC_AND_DESCRIPTION,
'templateFontSize' => 10,
'pdfContent' => '%PDF-1.6',
'hashAlgorithm' => '',
'params' => '-a -kst PKCS12 --l2-text "" -V -pg 2 -llx 10 -lly 20 -urx 30 -ury 40 --bg-path merged.png --hash-algorithm SHA256'
],
];
}
private static function getElement(array $attributes = [], string $imagePath = ''): VisibleElementAssoc {
$element = new FileElement();
foreach ($attributes as $attribute => $value) {
$method = 'set' . ucfirst($attribute);
$element->$method($value);
}
return new VisibleElementAssoc(
$element,
$imagePath,
);
}
#[DataProvider('providerGetJSignParam')]
public function testGetJSignParam(string $temp_path, string $java_path, string $jar_path, bool $throwException): void {
$expected = new JSignParam();
$this->appConfig->setValueString('libresign', 'java_path', $java_path);
$expected->setJavaPath($java_path);
$this->appConfig->setValueString('libresign', 'jsignpdf_temp_path', $temp_path);
$expected->setTempPath($temp_path);
$this->appConfig->setValueString('libresign', 'jsignpdf_jar_path', $jar_path);
$expected->setjSignPdfJarPath($jar_path);
$jSignPdfHandler = $this->getInstance();
if ($throwException) {
$this->expectException(\Exception::class);
$jSignParam = $jSignPdfHandler->getJSignParam();
} else {
$jSignParam = $jSignPdfHandler->getJSignParam();
$this->assertEquals($expected->getPdf(), $jSignParam->getPdf());
$this->assertEquals($expected->getJavaPath(), $jSignParam->getJavaPath());
$this->assertEquals($expected->getTempPath(), $jSignParam->getTempPath());
$this->assertEquals($expected->getjSignPdfJarPath(), $jSignParam->getjSignPdfJarPath());
$this->assertEquals('-a -kst PKCS12', $jSignParam->getJSignParameters());
}
}
public static function providerGetJSignParam(): array {
return [
['', '', __FILE__, true],
['invalid', '', __FILE__, true],
[sys_get_temp_dir(), '', __FILE__, false],
[sys_get_temp_dir(), 'b', __FILE__, true],
[sys_get_temp_dir(), __FILE__, __FILE__, false],
[sys_get_temp_dir(), 'b', __FILE__, true],
[sys_get_temp_dir(), __FILE__, __FILE__, false],
[sys_get_temp_dir(), __FILE__, '', true],
];
}
#[DataProvider('providerGetSignatureText')]
public function testGetSignatureText(string $renderMode, string $template, string $expected): void {
$this->appConfig->setValueString('libresign', 'signature_text_template', $template);
$this->appConfig->setValueString('libresign', 'signature_render_mode', $renderMode);
$jSignPdfHandler = $this->getInstance();
$actual = $jSignPdfHandler->getSignatureText();
$this->assertEquals($expected, $actual);
}
public static function providerGetSignatureText(): array {
return [
['FAKE_RENDER_MODE', '', '""'],
['FAKE_RENDER_MODE', 'a', '"a"'],
['FAKE_RENDER_MODE', "a\na", "\"a\na\""],
['FAKE_RENDER_MODE', 'a"a', '"a\"a"'],
['FAKE_RENDER_MODE', 'a$a', '"a\$a"'],
['GRAPHIC_ONLY', '', '""'],
['GRAPHIC_ONLY', 'a', '""'],
['GRAPHIC_ONLY', "a\na", '""'],
['GRAPHIC_ONLY', 'a"a', '""'],
['GRAPHIC_ONLY', 'a$a', '""'],
];
}
}
View git blame Copy permalink