Sample code for 30+ languages & platforms
Dart

Create JPK_VAT XaDES-BES Signed XML

See more XAdES Examples

Demonstrates how to sign XML for JPK_VAT.

Chilkat Dart Downloads

Dart
import 'package:chilkat/chilkat.dart';

void main() {
  // 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

  final xmlToSign = CkXml();
  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', true, 'algorithm', 'RSA');
  xmlToSign.updateAttrAt('EncryptionKey', true, 'encoding', 'Base64');
  xmlToSign.updateAttrAt('EncryptionKey', true, 'mode', 'ECB');
  xmlToSign.updateAttrAt('EncryptionKey', true, 'padding', 'PKCS#1');
  xmlToSign.updateChildContent('EncryptionKey', '...');
  xmlToSign.updateAttrAt('DocumentList|Document|FormCode', true, 'schemaVersion', '1-1');
  xmlToSign.updateAttrAt('DocumentList|Document|FormCode', true, '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', true, 'algorithm', 'SHA-256');
  xmlToSign.updateAttrAt('DocumentList|Document|HashValue', true, 'encoding', 'Base64');
  xmlToSign.updateChildContent('DocumentList|Document|HashValue', 'JEEI1pItwh6dj/Xe1uts/x61qnjZ4DLHpkRMhmf1oQQ=');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList', true, 'filesNumber', '1');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList|Packaging|SplitZip', true, 'mode', 'zip');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList|Packaging|SplitZip', true, 'type', 'split');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES', true, 'block', '16');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES', true, 'mode', 'CBC');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES', true, 'padding', 'PKCS#7');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES', true, 'size', '256');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES|IV', true, 'bytes', '16');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList|Encryption|AES|IV', true, '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', true, 'algorithm', 'MD5');
  xmlToSign.updateAttrAt('DocumentList|Document|FileSignatureList|FileSignature|HashValue', true, '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

  final gen = CkXmlDSigGen();

  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.
  final object1 = CkXml();
  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', true, 'Id', 'xades-id-1234');
  object1.updateChildContent('xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime', 'TO BE GENERATED BY CHILKAT');
  object1.updateAttrAt('xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod', true, 'Algorithm', 'http://www.w3.org/2001/04/xmlenc#sha256');
  object1.updateChildContent('xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue', 'TO BE GENERATED BY CHILKAT');
  object1.updateChildContent('xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2', 'TO BE GENERATED BY CHILKAT');
  object1.updateAttrAt('xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat', true, 'ObjectReference', '#r-id-1');
  object1.updateChildContent('xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType', 'text/xml');

  gen.addObject('', object1.getXml(), '', '');

  // -------- Reference 1 --------
  final xml1 = CkXml();
  xml1.tag = 'ds:Transforms';
  xml1.updateAttrAt('ds:Transform', true, '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]', true, 'Algorithm', 'http://www.w3.org/2001/10/xml-exc-c14n#');

  gen.addSameDocRef2('', 'sha256', xml1, '');
  gen.setRefIdAttr('', 'r-id-1');

  // -------- Reference 2 --------
  final xml2 = CkXml();
  xml2.tag = 'ds:Transforms';
  xml2.updateAttrAt('ds:Transform', true, 'Algorithm', 'http://www.w3.org/2001/10/xml-exc-c14n#');

  gen.addObjectRef2('xades-id-1234', 'sha256', xml2, '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..
  final cert = CkCert();
  try {
    cert.loadPfxFile('qa_data/pfx/cert_test123.pfx', 'test123');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  gen.setX509Cert(cert, true);

  gen.keyInfoType = 'X509Data';
  gen.x509Type = 'Certificate';

  // Load XML to be signed...
  final sbXml = CkStringBuilder();
  xmlToSign.getXmlSb(sbXml);

  gen.behaviors = 'IndentedSignature,TransformSignatureXPath,IssuerSerialHex';

  // Sign the XML...
  try {
    gen.createXmlDSigSb(sbXml);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Save the signed XMl to a file.
  sbXml.writeFile('qa_output/signedXml.xml', 'utf-8', false);

  print(sbXml.getAsString());

  // ----------------------------------------
  // Verify the signature we just produced...
  final verifier = CkXmlDSig();
  try {
    verifier.loadSignatureSb(sbXml);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    verifier.verifySignature(true);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('This signature was successfully verified.');
}