feat: add reason of signature

Signed-off-by: Vitor Mattos <vitor@php.rio>
LibreSign · Feb 1, 2025 · 7fac5d8 · 7fac5d8
1 parent ef7cf8c
commit 7fac5d8
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 1 deletion.
diff --git a/lib/Handler/JSignPdfHandler.php b/lib/Handler/JSignPdfHandler.php
@@ -144,7 +144,12 @@ private function signWrapper(JSignPDF $jSignPDF): string {
 			$param
 				->setJSignParameters(
 					$this->jSignParam->getJSignParameters() .
-					' --hash-algorithm ' . $this->getHashAlgorithm()
+					' --hash-algorithm ' . $this->getHashAlgorithm() .
+					(
+						$this->getReason()
+							? ' --reason "' . $this->getReason() . '"'
+							: ''
+					)
 				);
 			$jSignPDF->setParam($param);
 			return $jSignPDF->sign();

diff --git a/lib/Handler/Pkcs12Handler.php b/lib/Handler/Pkcs12Handler.php
@@ -423,6 +423,7 @@ public function sign(): File {
 			->setInputFile($this->getInputFile())
 			->setPassword($this->getPassword())
 			->setVisibleElements($this->getvisibleElements())
+			->setReason($this->getReason())
 			->sign();
 		$this->getInputFile()->putContent($signedContent);
 		return $this->getInputFile();

diff --git a/lib/Handler/SignEngineHandler.php b/lib/Handler/SignEngineHandler.php
@@ -15,6 +15,7 @@ abstract class SignEngineHandler implements ISignEngineHandler {
 	private File $inputFile;
 	private string $certificate;
 	private string $password = '';
+	private string $reason = '';
 	/** @var VisibleElementAssoc[] */
 	private array $visibleElements = [];
 
@@ -54,6 +55,15 @@ public function getPassword(): string {
 		return $this->password;
 	}
 
+	public function setReason(string $reason): self {
+		$this->reason = $reason;
+		return $this;
+	}
+
+	public function getReason(): string {
+		return $this->reason;
+	}
+
 	/**
 	 * @param VisibleElementAssoc[] $visibleElements
 	 *

diff --git a/lib/Service/SignFileService.php b/lib/Service/SignFileService.php
@@ -266,6 +266,9 @@ public function sign(): File {
 					->setCertificate($pfxFileContent)
 					->setVisibleElements($this->elements)
 					->setPassword($this->password)
+					->setReason($this->l10n->t('Signed by %s with LibreSign.coop', [
+						$this->signRequest->getDisplayName() . ' <' . $this->userUniqueIdentifier . '>'
+					]))
 					->sign();
 				break;
 			default: