(Delphi ActiveX) Create JPK_VAT XaDES-BES Signed XML

Demonstrates how to sign XML for JPK_VAT.

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Integer;
xmlToSign: TChilkatXml;
gen: TChilkatXmlDSigGen;
object1: TChilkatXml;
xml1: TChilkatXml;
xml2: TChilkatXml;
cert: TChilkatCert;
sbXml: TChilkatStringBuilder;
verifier: TChilkatXmlDSig;
verified: Integer;

begin
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// This example will sign the following XML document:

// <?xml version="1.0" encoding="utf-8"?>
// <InitUpload xmlns="http://e-dokumenty.mf.gov.pl">
//     <DocumentType>JPK</DocumentType>
//     <Version>01.02.01.20160617</Version>
//     <EncryptionKey algorithm="RSA" encoding="Base64" mode="ECB" padding="PKCS#1">...</EncryptionKey>
//     <DocumentList>
//         <Document>
//             <FormCode schemaVersion="1-1" systemCode="JPK_VAT (3)">JPK_VAT</FormCode>
//             <FileName>JPK_VAT_3_v1-1_20181208.xml</FileName>
//             <ContentLength>8736</ContentLength>
//             <HashValue algorithm="SHA-256" encoding="Base64">JEEI1pItwh6dj/Xe1uts/x61qnjZ4DLHpkRMhmf1oQQ=</HashValue>
//             <FileSignatureList filesNumber="1">
//                 <Packaging>
//                     <SplitZip mode="zip" type="split"/>
//                 </Packaging>
//                 <Encryption>
//                     <AES block="16" mode="CBC" padding="PKCS#7" size="256">
//                         <IV bytes="16" encoding="Base64">FFsCRAPYJD3J6cRvd44UDA==</IV>
//                     </AES>
//                 </Encryption>
//                 <FileSignature>
//                     <OrdinalNumber>1</OrdinalNumber>
//                     <FileName>JPK_VAT_3_v1-1_20181208-000.xml.zip.aes</FileName>
//                     <ContentLength>16</ContentLength>
//                     <HashValue algorithm="MD5" encoding="Base64">BX2DTD3ASC/zF6aq/012Cg==</HashValue>
//                 </FileSignature>
//             </FileSignatureList>
//         </Document>
//     </DocumentList>
// </InitUpload>

// First we build the XML to be signed.
// 
// Use this online tool to generate the code from sample XML: 
// Generate Code to Create XML

success := 1;
xmlToSign := TChilkatXml.Create(Self);
xmlToSign.Tag := 'InitUpload';
xmlToSign.AddAttribute('xmlns','http://e-dokumenty.mf.gov.pl');
xmlToSign.UpdateChildContent('DocumentType','JPK');
xmlToSign.UpdateChildContent('Version','01.02.01.20160617');
xmlToSign.UpdateAttrAt('EncryptionKey',1,'algorithm','RSA');
xmlToSign.UpdateAttrAt('EncryptionKey',1,'encoding','Base64');
xmlToSign.UpdateAttrAt('EncryptionKey',1,'mode','ECB');
xmlToSign.UpdateAttrAt('EncryptionKey',1,'padding','PKCS#1');
xmlToSign.UpdateChildContent('EncryptionKey','...');
xmlToSign.UpdateAttrAt('DocumentList|Document|FormCode',1,'schemaVersion','1-1');
xmlToSign.UpdateAttrAt('DocumentList|Document|FormCode',1,'systemCode','JPK_VAT (3)');
xmlToSign.UpdateChildContent('DocumentList|Document|FormCode','JPK_VAT');
xmlToSign.UpdateChildContent('DocumentList|Document|FileName','JPK_VAT_3_v1-1_20181208.xml');
xmlToSign.UpdateChildContent('DocumentList|Document|ContentLength','8736');
xmlToSign.UpdateAttrAt('DocumentList|Document|HashValue',1,'algorithm','SHA-256');
xmlToSign.UpdateAttrAt('DocumentList|Document|HashValue',1,'encoding','Base64');
xmlToSign.UpdateChildContent('DocumentList|Document|HashValue','JEEI1pItwh6dj/Xe1uts/x61qnjZ4DLHpkRMhmf1oQQ=');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList',1,'filesNumber','1');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|Packaging|SplitZip',1,'mode','zip');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|Packaging|SplitZip',1,'type','split');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES',1,'block','16');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES',1,'mode','CBC');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES',1,'padding','PKCS#7');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES',1,'size','256');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES|IV',1,'bytes','16');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES|IV',1,'encoding','Base64');
xmlToSign.UpdateChildContent('DocumentList|Document|FileSignatureList|Encryption|AES|IV','FFsCRAPYJD3J6cRvd44UDA==');
xmlToSign.UpdateChildContent('DocumentList|Document|FileSignatureList|FileSignature|OrdinalNumber','1');
xmlToSign.UpdateChildContent('DocumentList|Document|FileSignatureList|FileSignature|FileName','JPK_VAT_3_v1-1_20181208-000.xml.zip.aes');
xmlToSign.UpdateChildContent('DocumentList|Document|FileSignatureList|FileSignature|ContentLength','16');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|FileSignature|HashValue',1,'algorithm','MD5');
xmlToSign.UpdateAttrAt('DocumentList|Document|FileSignatureList|FileSignature|HashValue',1,'encoding','Base64');
xmlToSign.UpdateChildContent('DocumentList|Document|FileSignatureList|FileSignature|HashValue','BX2DTD3ASC/zF6aq/012Cg==');

// Also see the online tool to generate the code from sample already-signed XML: 
// Generate XML Signature Creation Code from an Already-Signed XML Sample

gen := TChilkatXmlDSigGen.Create(Self);

gen.SigLocation := 'InitUpload';
gen.SigId := 'id-1234';
gen.SigNamespacePrefix := 'ds';
gen.SigNamespaceUri := 'http://www.w3.org/2000/09/xmldsig#';
gen.SignedInfoCanonAlg := 'EXCL_C14N';
gen.SignedInfoDigestMethod := 'sha256';

// Create an Object to be added to the Signature.
object1 := TChilkatXml.Create(Self);
object1.Tag := 'xades:QualifyingProperties';
object1.AddAttribute('Target','#id-1234');
object1.AddAttribute('xmlns:xades','http://uri.etsi.org/01903/v1.3.2#');
object1.UpdateAttrAt('xades:SignedProperties',1,'Id','xades-id-1234');
object1.UpdateChildContent('xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime','TO BE GENERATED BY CHILKAT');
object1.UpdateAttrAt('xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:CertDigest|ds:DigestMethod',1,'Algorithm','http://www.w3.org/2001/04/xmlenc#sha256');
object1.UpdateChildContent('xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:CertDigest|ds:DigestValue','TO BE GENERATED BY CHILKAT');
object1.UpdateChildContent('xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:IssuerSerial|ds:X509IssuerName','TO BE GENERATED BY CHILKAT');
object1.UpdateChildContent('xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificate|xades:Cert|xades:IssuerSerial|ds:X509SerialNumber','TO BE GENERATED BY CHILKAT');
object1.UpdateAttrAt('xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat',1,'ObjectReference','#r-id-1');
object1.UpdateChildContent('xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType','text/xml');

gen.AddObject('',object1.GetXml(),'','');

// -------- Reference 1 --------
xml1 := TChilkatXml.Create(Self);
xml1.Tag := 'ds:Transforms';
xml1.UpdateAttrAt('ds:Transform',1,'Algorithm','http://www.w3.org/TR/1999/REC-xpath-19991116');
xml1.UpdateChildContent('ds:Transform|ds:XPath','not(ancestor-or-self::ds:Signature)');
xml1.UpdateAttrAt('ds:Transform[1]',1,'Algorithm','http://www.w3.org/2001/10/xml-exc-c14n#');

gen.AddSameDocRef2('','sha256',xml1.ControlInterface,'');
gen.SetRefIdAttr('','r-id-1');

// -------- Reference 2 --------
xml2 := TChilkatXml.Create(Self);
xml2.Tag := 'ds:Transforms';
xml2.UpdateAttrAt('ds:Transform',1,'Algorithm','http://www.w3.org/2001/10/xml-exc-c14n#');

gen.AddObjectRef2('xades-id-1234','sha256',xml2.ControlInterface,'http://uri.etsi.org/01903#SignedProperties');

// Provide a certificate + private key. (PFX password is test123)
// See Load Certificate on Smartcard for an example showing how to load the cert from a smartcard..
cert := TChilkatCert.Create(Self);
success := cert.LoadPfxFile('qa_data/pfx/cert_test123.pfx','test123');
if (success <> 1) then
  begin
    Memo1.Lines.Add(cert.LastErrorText);
    Exit;
  end;
gen.SetX509Cert(cert.ControlInterface,1);

gen.KeyInfoType := 'X509Data';
gen.X509Type := 'Certificate';

// Load XML to be signed...
sbXml := TChilkatStringBuilder.Create(Self);
xmlToSign.GetXmlSb(sbXml.ControlInterface);

gen.Behaviors := 'IndentedSignature,TransformSignatureXPath,IssuerSerialHex';

// Sign the XML...
success := gen.CreateXmlDSigSb(sbXml.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(gen.LastErrorText);
    Exit;
  end;

// Save the signed XMl to a file.
success := sbXml.WriteFile('qa_output/signedXml.xml','utf-8',0);

Memo1.Lines.Add(sbXml.GetAsString());

// ----------------------------------------
// Verify the signature we just produced...
verifier := TChilkatXmlDSig.Create(Self);
success := verifier.LoadSignatureSb(sbXml.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(verifier.LastErrorText);
    Exit;
  end;

verified := verifier.VerifySignature(1);
if (verified <> 1) then
  begin
    Memo1.Lines.Add(verifier.LastErrorText);
    Exit;
  end;
Memo1.Lines.Add('This signature was successfully verified.');
end;