Xbase++
Xbase++
XML-DSig Add Reference with Transforms Specified Explicitly
Demonstrates how to use the new AddSameDocRef2 method to explicitly specify the XML Transforms fragment.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oXmlToSign
LOCAL oGen
LOCAL oObject1
LOCAL oXml1
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
// Create the following XML to be signed:
// <doc>
// <s id="s1">Some text...</s>
// <p>Some text...</p>
// <p class="note">A note...</p>
// </doc>
// Use this online tool to generate code from sample XML:
// Generate Code to Create XML
oXmlToSign := CreateObject("Chilkat.Xml")
oXmlToSign:Tag := "doc"
oXmlToSign:UpdateAttrAt("s", 1, "id", "s1")
oXmlToSign:UpdateChildContent("s", "Some text...")
oXmlToSign:UpdateChildContent("p", "Some text...")
oXmlToSign:UpdateAttrAt("p[1]", 1, "class", "note")
oXmlToSign:UpdateChildContent("p[1]", "A note...")
? oXmlToSign:GetXml()
oGen := CreateObject("Chilkat.XmlDSigGen")
oGen:SigLocation := "doc"
oGen:SigLocationMod := 0
oGen:SigId := "Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature"
oGen:SigNamespacePrefix := "ds"
oGen:SigNamespaceUri := "http://www.w3.org/2000/09/xmldsig#"
oGen:SigValueId := "Signature-78f29839-06af-448f-b479-ca46457fab1b-SignatureValue"
oGen:SignedInfoCanonAlg := "C14N"
oGen:SignedInfoDigestMethod := "sha1"
// Set the KeyInfoId before adding references..
oGen:KeyInfoId := "Signature-78f29839-06af-448f-b479-ca46457fab1b-KeyInfo"
// The following XML to be added as an Object to the Signature
// Use this online tool to generate code from sample XML:
// Generate Code to Create XML
// <xades:QualifyingProperties Id="Signature-78f29839-06af-448f-b479-ca46457fab1b-QualifyingProperties" Target="#Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:xades="http://uri.etsi.org/01903/v1.3.2#">
// <xades:SignedProperties Id="Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties">
// <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="#Reference-24eb6003-d41c-442c-a731-d4c58f94790b">
// <xades:Description/>
// <xades:ObjectIdentifier>
// <xades:Identifier Qualifier="OIDAsURN">urn:oid:1.2.840.10003.5.109.10</xades:Identifier>
// <xades:Description/>
// </xades:ObjectIdentifier>
// <xades:MimeType>text/xml</xades:MimeType>
// <xades:Encoding/>
// </xades:DataObjectFormat>
// </xades:SignedDataObjectProperties>
// </xades:SignedProperties>
// </xades:QualifyingProperties>
oObject1 := CreateObject("Chilkat.Xml")
oObject1:Tag := "xades:QualifyingProperties"
oObject1:AddAttribute("Id", "Signature-78f29839-06af-448f-b479-ca46457fab1b-QualifyingProperties")
oObject1:AddAttribute("Target", "#Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature")
oObject1:AddAttribute("xmlns:ds", "http://www.w3.org/2000/09/xmldsig#")
oObject1:AddAttribute("xmlns:xades", "http://uri.etsi.org/01903/v1.3.2#")
oObject1:UpdateAttrAt("xades:SignedProperties", 1, "Id", "Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties")
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime", "TO BE GENERATED BY CHILKAT")
// 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: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", "#Reference-24eb6003-d41c-442c-a731-d4c58f94790b")
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Description", "")
oObject1:UpdateAttrAt("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier", 1, "Qualifier", "OIDAsURN")
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier", "urn:oid:1.2.840.10003.5.109.10")
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Description", "")
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType", "text/xml")
oObject1:UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Encoding", "")
? oObject1:GetXml()
oGen:AddObject("", oObject1:GetXml(), "", "")
// -------- Reference 1 --------
// Create the following Transforms fragment:
// Use this online tool to generate code from sample XML:
// Generate Code to Create XML
// <ds:Transforms>
// <ds:Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
// <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
// <ds:Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
// <ds:XPath xmlns:ds="http://www.w3.org/2000/09/xmldsig#">not(ancestor-or-self::ds:Signature)</ds:XPath>
// </ds:Transform>
// </ds:Transforms>
oXml1 := CreateObject("Chilkat.Xml")
oXml1:Tag := "ds:Transforms"
oXml1:UpdateAttrAt("ds:Transform", 1, "Algorithm", "http://www.w3.org/TR/2001/REC-xml-c14n-20010315")
oXml1:UpdateAttrAt("ds:Transform[1]", 1, "Algorithm", "http://www.w3.org/2000/09/xmldsig#enveloped-signature")
oXml1:UpdateAttrAt("ds:Transform[2]", 1, "Algorithm", "http://www.w3.org/TR/1999/REC-xpath-19991116")
oXml1:UpdateAttrAt("ds:Transform[2]|ds:XPath", 1, "xmlns:ds", "http://www.w3.org/2000/09/xmldsig#")
oXml1:UpdateChildContent("ds:Transform[2]|ds:XPath", "not(ancestor-or-self::ds:Signature)")
// This is the "Transforms" XML fragment passed to AddSameDocRef2.
? oXml1:GetXml()
oGen:AddSameDocRef2("", "sha1", oXml1, "")
oGen:SetRefIdAttr("", "Reference-24eb6003-d41c-442c-a731-d4c58f94790b")
// -------- Reference 2 --------
oGen:AddObjectRef("Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties", "sha1", "", "", "http://uri.etsi.org/01903#SignedProperties")
// -------- Reference 3 --------
oGen:AddSameDocRef("Signature-78f29839-06af-448f-b479-ca46457fab1b-KeyInfo", "sha1", "", "", "")
// 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()
oCert:destroy()
RETURN
ENDIF
oGen:SetX509Cert(oCert, 1)
oGen:KeyInfoType := "X509Data+KeyValue"
oGen:X509Type := "CertChain"
// 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()
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()
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()
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()
oCert:destroy()
oSbXml:destroy()
oVerifier:destroy()