DataFlex
DataFlex
Create JPK_VAT XaDES-BES Signed XML
See more XAdES Examples
Demonstrates how to sign XML for JPK_VAT.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoXmlToSign
Handle hoGen
Handle hoObject1
Variant vXml1
Handle hoXml1
Variant vXml2
Handle hoXml2
Variant vCert
Handle hoCert
Variant vSbXml
Handle hoSbXml
Handle hoVerifier
Boolean iVerified
String sTemp1
Move False To iSuccess
// 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
Move True To iSuccess
Get Create (RefClass(cComChilkatXml)) To hoXmlToSign
If (Not(IsComObjectCreated(hoXmlToSign))) Begin
Send CreateComObject of hoXmlToSign
End
Set ComTag Of hoXmlToSign To "InitUpload"
Get ComAddAttribute Of hoXmlToSign "xmlns" "http://e-dokumenty.mf.gov.pl" To iSuccess
Send ComUpdateChildContent To hoXmlToSign "DocumentType" "JPK"
Send ComUpdateChildContent To hoXmlToSign "Version" "01.02.01.20160617"
Get ComUpdateAttrAt Of hoXmlToSign "EncryptionKey" True "algorithm" "RSA" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "EncryptionKey" True "encoding" "Base64" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "EncryptionKey" True "mode" "ECB" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "EncryptionKey" True "padding" "PKCS#1" To iSuccess
Send ComUpdateChildContent To hoXmlToSign "EncryptionKey" "..."
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FormCode" True "schemaVersion" "1-1" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FormCode" True "systemCode" "JPK_VAT (3)" To iSuccess
Send ComUpdateChildContent To hoXmlToSign "DocumentList|Document|FormCode" "JPK_VAT"
Send ComUpdateChildContent To hoXmlToSign "DocumentList|Document|FileName" "JPK_VAT_3_v1-1_20181208.xml"
Send ComUpdateChildContent To hoXmlToSign "DocumentList|Document|ContentLength" "8736"
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|HashValue" True "algorithm" "SHA-256" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|HashValue" True "encoding" "Base64" To iSuccess
Send ComUpdateChildContent To hoXmlToSign "DocumentList|Document|HashValue" "JEEI1pItwh6dj/Xe1uts/x61qnjZ4DLHpkRMhmf1oQQ="
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList" True "filesNumber" "1" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|Packaging|SplitZip" True "mode" "zip" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|Packaging|SplitZip" True "type" "split" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES" True "block" "16" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES" True "mode" "CBC" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES" True "padding" "PKCS#7" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES" True "size" "256" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES|IV" True "bytes" "16" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES|IV" True "encoding" "Base64" To iSuccess
Send ComUpdateChildContent To hoXmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES|IV" "FFsCRAPYJD3J6cRvd44UDA=="
Send ComUpdateChildContent To hoXmlToSign "DocumentList|Document|FileSignatureList|FileSignature|OrdinalNumber" "1"
Send ComUpdateChildContent To hoXmlToSign "DocumentList|Document|FileSignatureList|FileSignature|FileName" "JPK_VAT_3_v1-1_20181208-000.xml.zip.aes"
Send ComUpdateChildContent To hoXmlToSign "DocumentList|Document|FileSignatureList|FileSignature|ContentLength" "16"
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|FileSignature|HashValue" True "algorithm" "MD5" To iSuccess
Get ComUpdateAttrAt Of hoXmlToSign "DocumentList|Document|FileSignatureList|FileSignature|HashValue" True "encoding" "Base64" To iSuccess
Send ComUpdateChildContent To hoXmlToSign "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
Get Create (RefClass(cComChilkatXmlDSigGen)) To hoGen
If (Not(IsComObjectCreated(hoGen))) Begin
Send CreateComObject of hoGen
End
Set ComSigLocation Of hoGen To "InitUpload"
Set ComSigId Of hoGen To "id-1234"
Set ComSigNamespacePrefix Of hoGen To "ds"
Set ComSigNamespaceUri Of hoGen To "http://www.w3.org/2000/09/xmldsig#"
Set ComSignedInfoCanonAlg Of hoGen To "EXCL_C14N"
Set ComSignedInfoDigestMethod Of hoGen To "sha256"
// Create an Object to be added to the Signature.
Get Create (RefClass(cComChilkatXml)) To hoObject1
If (Not(IsComObjectCreated(hoObject1))) Begin
Send CreateComObject of hoObject1
End
Set ComTag Of hoObject1 To "xades:QualifyingProperties"
Get ComAddAttribute Of hoObject1 "Target" "#id-1234" To iSuccess
Get ComAddAttribute Of hoObject1 "xmlns:xades" "http://uri.etsi.org/01903/v1.3.2#" To iSuccess
Get ComUpdateAttrAt Of hoObject1 "xades:SignedProperties" True "Id" "xades-id-1234" To iSuccess
Send ComUpdateChildContent To hoObject1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime" "TO BE GENERATED BY CHILKAT"
Get ComUpdateAttrAt Of hoObject1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod" True "Algorithm" "http://www.w3.org/2001/04/xmlenc#sha256" To iSuccess
Send ComUpdateChildContent To hoObject1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue" "TO BE GENERATED BY CHILKAT"
Send ComUpdateChildContent To hoObject1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2" "TO BE GENERATED BY CHILKAT"
Get ComUpdateAttrAt Of hoObject1 "xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat" True "ObjectReference" "#r-id-1" To iSuccess
Send ComUpdateChildContent To hoObject1 "xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType" "text/xml"
Get ComGetXml Of hoObject1 To sTemp1
Get ComAddObject Of hoGen "" sTemp1 "" "" To iSuccess
// -------- Reference 1 --------
Get Create (RefClass(cComChilkatXml)) To hoXml1
If (Not(IsComObjectCreated(hoXml1))) Begin
Send CreateComObject of hoXml1
End
Set ComTag Of hoXml1 To "ds:Transforms"
Get ComUpdateAttrAt Of hoXml1 "ds:Transform" True "Algorithm" "http://www.w3.org/TR/1999/REC-xpath-19991116" To iSuccess
Send ComUpdateChildContent To hoXml1 "ds:Transform|ds:XPath" "not(ancestor-or-self::ds:Signature)"
Get ComUpdateAttrAt Of hoXml1 "ds:Transform[1]" True "Algorithm" "http://www.w3.org/2001/10/xml-exc-c14n#" To iSuccess
Get pvComObject of hoXml1 to vXml1
Get ComAddSameDocRef2 Of hoGen "" "sha256" vXml1 "" To iSuccess
Get ComSetRefIdAttr Of hoGen "" "r-id-1" To iSuccess
// -------- Reference 2 --------
Get Create (RefClass(cComChilkatXml)) To hoXml2
If (Not(IsComObjectCreated(hoXml2))) Begin
Send CreateComObject of hoXml2
End
Set ComTag Of hoXml2 To "ds:Transforms"
Get ComUpdateAttrAt Of hoXml2 "ds:Transform" True "Algorithm" "http://www.w3.org/2001/10/xml-exc-c14n#" To iSuccess
Get pvComObject of hoXml2 to vXml2
Get ComAddObjectRef2 Of hoGen "xades-id-1234" "sha256" vXml2 "http://uri.etsi.org/01903#SignedProperties" To iSuccess
// 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..
Get Create (RefClass(cComChilkatCert)) To hoCert
If (Not(IsComObjectCreated(hoCert))) Begin
Send CreateComObject of hoCert
End
Get ComLoadPfxFile Of hoCert "qa_data/pfx/cert_test123.pfx" "test123" To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoCert To sTemp1
Showln sTemp1
Procedure_Return
End
Get pvComObject of hoCert to vCert
Get ComSetX509Cert Of hoGen vCert True To iSuccess
Set ComKeyInfoType Of hoGen To "X509Data"
Set ComX509Type Of hoGen To "Certificate"
// Load XML to be signed...
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbXml
If (Not(IsComObjectCreated(hoSbXml))) Begin
Send CreateComObject of hoSbXml
End
Get pvComObject of hoSbXml to vSbXml
Get ComGetXmlSb Of hoXmlToSign vSbXml To iSuccess
Set ComBehaviors Of hoGen To "IndentedSignature,TransformSignatureXPath,IssuerSerialHex"
// Sign the XML...
Get pvComObject of hoSbXml to vSbXml
Get ComCreateXmlDSigSb Of hoGen vSbXml To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoGen To sTemp1
Showln sTemp1
Procedure_Return
End
// Save the signed XMl to a file.
Get ComWriteFile Of hoSbXml "qa_output/signedXml.xml" "utf-8" False To iSuccess
Get ComGetAsString Of hoSbXml To sTemp1
Showln sTemp1
// ----------------------------------------
// Verify the signature we just produced...
Get Create (RefClass(cComChilkatXmlDSig)) To hoVerifier
If (Not(IsComObjectCreated(hoVerifier))) Begin
Send CreateComObject of hoVerifier
End
Get pvComObject of hoSbXml to vSbXml
Get ComLoadSignatureSb Of hoVerifier vSbXml To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoVerifier To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComVerifySignature Of hoVerifier True To iVerified
If (iVerified <> True) Begin
Get ComLastErrorText Of hoVerifier To sTemp1
Showln sTemp1
Procedure_Return
End
Showln "This signature was successfully verified."
End_Procedure