Tcl
Tcl
Create JPK_VAT XaDES-BES Signed XML
See more XAdES Examples
Demonstrates how to sign XML for JPK_VAT.Chilkat Tcl Downloads
load ./chilkat.dll
set success 0
# 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
set success 1
set xmlToSign [new_CkXml]
CkXml_put_Tag $xmlToSign "InitUpload"
CkXml_AddAttribute $xmlToSign "xmlns" "http://e-dokumenty.mf.gov.pl"
CkXml_UpdateChildContent $xmlToSign "DocumentType" "JPK"
CkXml_UpdateChildContent $xmlToSign "Version" "01.02.01.20160617"
CkXml_UpdateAttrAt $xmlToSign "EncryptionKey" 1 "algorithm" "RSA"
CkXml_UpdateAttrAt $xmlToSign "EncryptionKey" 1 "encoding" "Base64"
CkXml_UpdateAttrAt $xmlToSign "EncryptionKey" 1 "mode" "ECB"
CkXml_UpdateAttrAt $xmlToSign "EncryptionKey" 1 "padding" "PKCS#1"
CkXml_UpdateChildContent $xmlToSign "EncryptionKey" "..."
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FormCode" 1 "schemaVersion" "1-1"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FormCode" 1 "systemCode" "JPK_VAT (3)"
CkXml_UpdateChildContent $xmlToSign "DocumentList|Document|FormCode" "JPK_VAT"
CkXml_UpdateChildContent $xmlToSign "DocumentList|Document|FileName" "JPK_VAT_3_v1-1_20181208.xml"
CkXml_UpdateChildContent $xmlToSign "DocumentList|Document|ContentLength" "8736"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|HashValue" 1 "algorithm" "SHA-256"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|HashValue" 1 "encoding" "Base64"
CkXml_UpdateChildContent $xmlToSign "DocumentList|Document|HashValue" "JEEI1pItwh6dj/Xe1uts/x61qnjZ4DLHpkRMhmf1oQQ="
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList" 1 "filesNumber" "1"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|Packaging|SplitZip" 1 "mode" "zip"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|Packaging|SplitZip" 1 "type" "split"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES" 1 "block" "16"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES" 1 "mode" "CBC"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES" 1 "padding" "PKCS#7"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES" 1 "size" "256"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES|IV" 1 "bytes" "16"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES|IV" 1 "encoding" "Base64"
CkXml_UpdateChildContent $xmlToSign "DocumentList|Document|FileSignatureList|Encryption|AES|IV" "FFsCRAPYJD3J6cRvd44UDA=="
CkXml_UpdateChildContent $xmlToSign "DocumentList|Document|FileSignatureList|FileSignature|OrdinalNumber" "1"
CkXml_UpdateChildContent $xmlToSign "DocumentList|Document|FileSignatureList|FileSignature|FileName" "JPK_VAT_3_v1-1_20181208-000.xml.zip.aes"
CkXml_UpdateChildContent $xmlToSign "DocumentList|Document|FileSignatureList|FileSignature|ContentLength" "16"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|FileSignature|HashValue" 1 "algorithm" "MD5"
CkXml_UpdateAttrAt $xmlToSign "DocumentList|Document|FileSignatureList|FileSignature|HashValue" 1 "encoding" "Base64"
CkXml_UpdateChildContent $xmlToSign "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
set gen [new_CkXmlDSigGen]
CkXmlDSigGen_put_SigLocation $gen "InitUpload"
CkXmlDSigGen_put_SigId $gen "id-1234"
CkXmlDSigGen_put_SigNamespacePrefix $gen "ds"
CkXmlDSigGen_put_SigNamespaceUri $gen "http://www.w3.org/2000/09/xmldsig#"
CkXmlDSigGen_put_SignedInfoCanonAlg $gen "EXCL_C14N"
CkXmlDSigGen_put_SignedInfoDigestMethod $gen "sha256"
# Create an Object to be added to the Signature.
set object1 [new_CkXml]
CkXml_put_Tag $object1 "xades:QualifyingProperties"
CkXml_AddAttribute $object1 "Target" "#id-1234"
CkXml_AddAttribute $object1 "xmlns:xades" "http://uri.etsi.org/01903/v1.3.2#"
CkXml_UpdateAttrAt $object1 "xades:SignedProperties" 1 "Id" "xades-id-1234"
CkXml_UpdateChildContent $object1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime" "TO BE GENERATED BY CHILKAT"
CkXml_UpdateAttrAt $object1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod" 1 "Algorithm" "http://www.w3.org/2001/04/xmlenc#sha256"
CkXml_UpdateChildContent $object1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue" "TO BE GENERATED BY CHILKAT"
CkXml_UpdateChildContent $object1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2" "TO BE GENERATED BY CHILKAT"
CkXml_UpdateAttrAt $object1 "xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat" 1 "ObjectReference" "#r-id-1"
CkXml_UpdateChildContent $object1 "xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType" "text/xml"
CkXmlDSigGen_AddObject $gen "" [CkXml_getXml $object1] "" ""
# -------- Reference 1 --------
set xml1 [new_CkXml]
CkXml_put_Tag $xml1 "ds:Transforms"
CkXml_UpdateAttrAt $xml1 "ds:Transform" 1 "Algorithm" "http://www.w3.org/TR/1999/REC-xpath-19991116"
CkXml_UpdateChildContent $xml1 "ds:Transform|ds:XPath" "not(ancestor-or-self::ds:Signature)"
CkXml_UpdateAttrAt $xml1 "ds:Transform[1]" 1 "Algorithm" "http://www.w3.org/2001/10/xml-exc-c14n#"
CkXmlDSigGen_AddSameDocRef2 $gen "" "sha256" $xml1 ""
CkXmlDSigGen_SetRefIdAttr $gen "" "r-id-1"
# -------- Reference 2 --------
set xml2 [new_CkXml]
CkXml_put_Tag $xml2 "ds:Transforms"
CkXml_UpdateAttrAt $xml2 "ds:Transform" 1 "Algorithm" "http://www.w3.org/2001/10/xml-exc-c14n#"
CkXmlDSigGen_AddObjectRef2 $gen "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..
set cert [new_CkCert]
set success [CkCert_LoadPfxFile $cert "qa_data/pfx/cert_test123.pfx" "test123"]
if {$success != 1} then {
puts [CkCert_lastErrorText $cert]
delete_CkXml $xmlToSign
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkXml $xml1
delete_CkXml $xml2
delete_CkCert $cert
exit
}
CkXmlDSigGen_SetX509Cert $gen $cert 1
CkXmlDSigGen_put_KeyInfoType $gen "X509Data"
CkXmlDSigGen_put_X509Type $gen "Certificate"
# Load XML to be signed...
set sbXml [new_CkStringBuilder]
CkXml_GetXmlSb $xmlToSign $sbXml
CkXmlDSigGen_put_Behaviors $gen "IndentedSignature,TransformSignatureXPath,IssuerSerialHex"
# Sign the XML...
set success [CkXmlDSigGen_CreateXmlDSigSb $gen $sbXml]
if {$success != 1} then {
puts [CkXmlDSigGen_lastErrorText $gen]
delete_CkXml $xmlToSign
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkXml $xml1
delete_CkXml $xml2
delete_CkCert $cert
delete_CkStringBuilder $sbXml
exit
}
# Save the signed XMl to a file.
set success [CkStringBuilder_WriteFile $sbXml "qa_output/signedXml.xml" "utf-8" 0]
puts [CkStringBuilder_getAsString $sbXml]
# ----------------------------------------
# Verify the signature we just produced...
set verifier [new_CkXmlDSig]
set success [CkXmlDSig_LoadSignatureSb $verifier $sbXml]
if {$success != 1} then {
puts [CkXmlDSig_lastErrorText $verifier]
delete_CkXml $xmlToSign
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkXml $xml1
delete_CkXml $xml2
delete_CkCert $cert
delete_CkStringBuilder $sbXml
delete_CkXmlDSig $verifier
exit
}
set verified [CkXmlDSig_VerifySignature $verifier 1]
if {$verified != 1} then {
puts [CkXmlDSig_lastErrorText $verifier]
delete_CkXml $xmlToSign
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkXml $xml1
delete_CkXml $xml2
delete_CkCert $cert
delete_CkStringBuilder $sbXml
delete_CkXmlDSig $verifier
exit
}
puts "This signature was successfully verified."
delete_CkXml $xmlToSign
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkXml $xml1
delete_CkXml $xml2
delete_CkCert $cert
delete_CkStringBuilder $sbXml
delete_CkXmlDSig $verifier