andreygrin/xades-tools

Sign files, xml content and verify signatures using XAdES

1.0.1 2024-10-30 17:29 UTC

Requires

• php: ^8.1
• ext-dom: *
• ext-json: *
• ext-openssl: *
• krowinski/bcmath-extended: ^6.0
• symfony/uid: >=5.4

Requires (Dev)

• phpunit/phpunit: ^9.5
• symfony/var-dumper: >=5.4

MIT

README

Updated version, includes IssuerSerial information with cert serial number and issuer details.

API:

Signing

use XadesTools\CertificateFactory;
use XadesTools\Signature;
$cert = CertificateFactory::string(
    $privateKeyContents, // .pem
    $certificateContents, // .crt
    $parivateKeyPassword // string
);

$this->signer = new Signature($cert);
$this->signer->signXml('xmlContent') // returns signature, you should add it to the xml file the way you need to have it there.

Verification, content extraction

use XadesTools\Verification;
$xades = new Verification();
$result = $xades->verifyFile($pathToXadesFile);
if ($result) {
    $content = $res->content; // binary content or plain text for xml files
    $signTime = $res->dateSigned; // DateTime object
    $signingSubject = $res->signingSubject; // array
} else {
    // Signature does not match signed content
}

COMMAND LINE USAGE:

Signing file

php bin/sign.php file cert pass [embed] [load-content]

Where:

• file - path to file we want to sign. Signature will be created in the same folder, with .XAdES extension
• cert - certificate in PKCS#12 format (.p12) - with private key
• pass - password for p12 file
• embed - if true, signature will embed given file
• load-content - loads file content into variable and signs it as embedded object

Results in file.XAdES located in the same directory as given file

Verification

php src/verify.php file [verbose]

Where:

• file is path to .XAdES file
• verbose if true print additional info about sign time and
• load-content - loads file content into variable and verifies it as embedded object (can not rely on files on disk)

Verifies content in given XAdES file, prints OK if everything passes, error message otherwise.

Extracting file from XAdES files

php src/extract.php file output

Where:

• file is path to .XAdES file with embedded object
• output path for output file