Xbase++
Xbase++
XML-DSig Add Object Reference with Transforms Specified Explicitly
Demonstrates how to use the new AddObjectRef2 method to explicitly specify the XML Transforms fragment.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oXmlToSign
LOCAL oGen
LOCAL oObject1
LOCAL oXml1
LOCAL oXml2
LOCAL oCert
LOCAL oSbXml
LOCAL oVerifier
LOCAL nNumSigs
LOCAL nVerifyIdx
LOCAL nVerified
nSuccess := 0
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
nSuccess := 1
// Build the following XML to be signed:
// <?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">xxxx</EncryptionKey>
// <DocumentList>
// <Document>
// <FormCode schemaVersion="1-1" systemCode="JPK_VAT (3)">JPK_VAT</FormCode>
// <FileName>JPK_VAT_3_v1-1_20181201.xml</FileName>
// <ContentLength>8736</ContentLength>
// <HashValue algorithm="SHA-256" encoding="Base64">JEDI1pItwh6dj/Xx1uts/x61qnjZ4DLHpkZMhmf1oKQ=</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">z64oN9zXHt1+S3XACRSCYw==</IV>
// </AES>
// </Encryption>
// <FileSignature>
// <OrdinalNumber>1</OrdinalNumber>
// <FileName>JPK_VAT_3_v1-1_20181201-000.xml.zip.aes</FileName>
// <ContentLength>16</ContentLength>
// <HashValue algorithm="MD5" encoding="Base64">5MX0q1935fvMjLFV7E1yDw==</HashValue>
// </FileSignature>
// </FileSignatureList>
// </Document>
// </DocumentList>
// </InitUpload>
// Use this online tool to generate code from sample XML:
// Generate Code to Create XML
oXmlToSign := CreateObject("Chilkat.Xml")
oXmlToSign:Tag := "InitUpload"
oXmlToSign:AddAttribute("xmlns", "http://e-dokumenty.mf.gov.pl")
oXmlToSign:UpdateChildContent("DocumentType", "JPK")
oXmlToSign:UpdateChildContent("Version", "01.02.01.20160617")
oXmlToSign:UpdateAttrAt("EncryptionKey", 1, "algorithm", "RSA")
oXmlToSign:UpdateAttrAt("EncryptionKey", 1, "encoding", "Base64")
oXmlToSign:UpdateAttrAt("EncryptionKey", 1, "mode", "ECB")
oXmlToSign:UpdateAttrAt("EncryptionKey", 1, "padding", "PKCS#1")
oXmlToSign:UpdateChildContent("EncryptionKey", "xxxx")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FormCode", 1, "schemaVersion", "1-1")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FormCode", 1, "systemCode", "JPK_VAT (3)")
oXmlToSign:UpdateChildContent("DocumentList|Document|FormCode", "JPK_VAT")
oXmlToSign:UpdateChildContent("DocumentList|Document|FileName", "JPK_VAT_3_v1-1_20181201.xml")
oXmlToSign:UpdateChildContent("DocumentList|Document|ContentLength", "8736")
oXmlToSign:UpdateAttrAt("DocumentList|Document|HashValue", 1, "algorithm", "SHA-256")
oXmlToSign:UpdateAttrAt("DocumentList|Document|HashValue", 1, "encoding", "Base64")
oXmlToSign:UpdateChildContent("DocumentList|Document|HashValue", "JEDI1pItwh6dj/Xx1uts/x61qnjZ4DLHpkZMhmf1oKQ=")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList", 1, "filesNumber", "1")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|Packaging|SplitZip", 1, "mode", "zip")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|Packaging|SplitZip", 1, "type", "split")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|Encryption|AES", 1, "block", "16")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|Encryption|AES", 1, "mode", "CBC")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|Encryption|AES", 1, "padding", "PKCS#7")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|Encryption|AES", 1, "size", "256")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|Encryption|AES|IV", 1, "bytes", "16")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|Encryption|AES|IV", 1, "encoding", "Base64")
oXmlToSign:UpdateChildContent("DocumentList|Document|FileSignatureList|Encryption|AES|IV", "z64oN9zXHt1+S3XACRSCYw==")
oXmlToSign:UpdateChildContent("DocumentList|Document|FileSignatureList|FileSignature|OrdinalNumber", "1")
oXmlToSign:UpdateChildContent("DocumentList|Document|FileSignatureList|FileSignature|FileName", "JPK_VAT_3_v1-1_20181201-000.xml.zip.aes")
oXmlToSign:UpdateChildContent("DocumentList|Document|FileSignatureList|FileSignature|ContentLength", "16")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|FileSignature|HashValue", 1, "algorithm", "MD5")
oXmlToSign:UpdateAttrAt("DocumentList|Document|FileSignatureList|FileSignature|HashValue", 1, "encoding", "Base64")
oXmlToSign:UpdateChildContent("DocumentList|Document|FileSignatureList|FileSignature|HashValue", "5MX0q1935fvMjLFV7E1yDw==")
oGen := CreateObject("Chilkat.XmlDSigGen")
oGen:SigLocation := "InitUpload"
oGen:SigLocationMod := 0
oGen:SigId := "id-1234"
oGen:SigNamespacePrefix := "ds"
oGen:SigNamespaceUri := "http://www.w3.org/2000/09/xmldsig#"
oGen:SignedInfoCanonAlg := "EXCL_C14N"
oGen:SignedInfoDigestMethod := "sha256"
// Create an Object to be added to the Signature.
// <xades:QualifyingProperties Target="#id-1234" xmlns:xades="http://uri.etsi.org/01903/v1.3.2#">
// <xades:SignedProperties Id="xades-id-1234">
// <xades:SignedSignatureProperties>
// <xades:SigningTime>TO BE GENERATED BY CHILKAT</xades:SigningTime>
// <xades:SigningCertificate>
// <xades:Cert>
// <xades:CertDigest>
// <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
// <ds:DigestValue>TO BE GENERATED BY CHILKAT</ds:DigestValue>
// </xades:CertDigest>
// <xades:IssuerSerial>
// <ds:X509IssuerName>TO BE GENERATED BY CHILKAT</ds:X509IssuerName>
// <ds:X509SerialNumber>TO BE GENERATED BY CHILKAT</ds:X509SerialNumber>
// </xades:IssuerSerial>
// </xades:Cert>
// </xades:SigningCertificate>
// </xades:SignedSignatureProperties>
// <xades:SignedDataObjectProperties>
// <xades:DataObjectFormat ObjectReference="#r-id-1">
// <xades:MimeType>text/xml</xades:MimeType>
// </xades:DataObjectFormat>
// </xades:SignedDataObjectProperties>
// </xades:SignedProperties>
// </xades:QualifyingProperties>
oObject1 := CreateObject("Chilkat.Xml")
oObject1:Tag := "xades:QualifyingProperties"
oObject1:AddAttribute("xmlns:xades", "http://uri.etsi.org/01903/v1.3.2#")
oObject1:AddAttribute("Target", "#id-1234")
oObject1:UpdateAttrAt("xades:SignedProperties", 1, "Id", "xades-id-1234")
// Note: It may be that http://www.w3.org/2001/04/xmlenc#sha256 is needed in the following line instead of http://www.w3.org/2000/09/xmldsig#sha1
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime", "TO BE GENERATED BY CHILKAT")
oObject1:UpdateAttrAt("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod", 1, "Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1")
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue", "TO BE GENERATED BY CHILKAT")
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2", "TO BE GENERATED BY CHILKAT")
oObject1:UpdateAttrAt("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat", 1, "ObjectReference", "#r-id-1")
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType", "text/xml")
oGen:AddObject("", oObject1:GetXml(), "", "")
// -------- Reference 1 --------
// Build the following Transforms fragment:
// <ds:Transforms>
// <ds:Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
// <ds:XPath>not(ancestor-or-self::ds:Signature)</ds:XPath>
// </ds:Transform>
// <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
// </ds:Transforms>
oXml1 := CreateObject("Chilkat.Xml")
oXml1:Tag := "ds:Transforms"
oXml1:UpdateAttrAt("ds:Transform", 1, "Algorithm", "http://www.w3.org/TR/1999/REC-xpath-19991116")
oXml1:UpdateChildContent("ds:Transform|ds:XPath", "not(ancestor-or-self::ds:Signature)")
oXml1:UpdateAttrAt("ds:Transform[1]", 1, "Algorithm", "http://www.w3.org/2001/10/xml-exc-c14n#")
oGen:AddSameDocRef2("", "sha256", oXml1, "")
oGen:SetRefIdAttr("", "r-id-1")
// -------- Reference 2 --------
// Build the following Transforms fragment:
// <ds:Transforms>
// <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
// </ds:Transforms>
oXml2 := CreateObject("Chilkat.Xml")
oXml2:Tag := "ds:Transforms"
oXml2:UpdateAttrAt("ds:Transform", 1, "Algorithm", "http://www.w3.org/2001/10/xml-exc-c14n#")
oGen:AddObjectRef2("xades-id-1234", "sha256", oXml2, "http://uri.etsi.org/01903#SignedProperties")
// Provide a certificate + private key. (PFX password is test123)
oCert := CreateObject("Chilkat.Cert")
nSuccess := oCert:LoadPfxFile("qa_data/pfx/cert_test123.pfx", "test123")
IF (nSuccess != 1)
? oCert:LastErrorText
oXmlToSign:destroy()
oGen:destroy()
oObject1:destroy()
oXml1:destroy()
oXml2:destroy()
oCert:destroy()
RETURN
ENDIF
oGen:SetX509Cert(oCert, 1)
oGen:KeyInfoType := "X509Data"
oGen:X509Type := "Certificate"
// Load XML to be signed...
oSbXml := CreateObject("Chilkat.StringBuilder")
oXmlToSign:GetXmlSb(oSbXml)
oGen:Behaviors := "IndentedSignature"
// Sign the XML...
nSuccess := oGen:CreateXmlDSigSb(oSbXml)
IF (nSuccess != 1)
? oGen:LastErrorText
oXmlToSign:destroy()
oGen:destroy()
oObject1:destroy()
oXml1:destroy()
oXml2:destroy()
oCert:destroy()
oSbXml:destroy()
RETURN
ENDIF
// -----------------------------------------------
// Save the signed XML to a file.
nSuccess := oSbXml:WriteFile("qa_output/signedXml.xml", "utf-8", 0)
? oSbXml:GetAsString()
// ----------------------------------------
// Verify the signatures we just produced...
oVerifier := CreateObject("Chilkat.XmlDSig")
nSuccess := oVerifier:LoadSignatureSb(oSbXml)
IF (nSuccess != 1)
? oVerifier:LastErrorText
oXmlToSign:destroy()
oGen:destroy()
oObject1:destroy()
oXml1:destroy()
oXml2:destroy()
oCert:destroy()
oSbXml:destroy()
oVerifier:destroy()
RETURN
ENDIF
nNumSigs := oVerifier:NumSignatures
nVerifyIdx := 0
DO WHILE nVerifyIdx < nNumSigs
oVerifier:Selector := nVerifyIdx
nVerified := oVerifier:VerifySignature(1)
IF (nVerified != 1)
? oVerifier:LastErrorText
oXmlToSign:destroy()
oGen:destroy()
oObject1:destroy()
oXml1:destroy()
oXml2:destroy()
oCert:destroy()
oSbXml:destroy()
oVerifier:destroy()
RETURN
ENDIF
nVerifyIdx := nVerifyIdx + 1
ENDDO
? "All signatures were successfully verified."
oXmlToSign:destroy()
oGen:destroy()
oObject1:destroy()
oXml1:destroy()
oXml2:destroy()
oCert:destroy()
oSbXml:destroy()
oVerifier:destroy()