PureBasic
PureBasic
XML-DSig Add Reference with Transforms Specified Explicitly
Demonstrates how to use the new AddSameDocRef2 method to explicitly specify the XML Transforms fragment.Chilkat PureBasic Downloads
IncludeFile "CkCert.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkXmlDSigGen.pb"
IncludeFile "CkXmlDSig.pb"
IncludeFile "CkStringBuilder.pb"
Procedure ChilkatExample()
success.i = 0
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
success = 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
xmlToSign.i = CkXml::ckCreate()
If xmlToSign.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xmlToSign, "doc")
CkXml::ckUpdateAttrAt(xmlToSign,"s",1,"id","s1")
CkXml::ckUpdateChildContent(xmlToSign,"s","Some text...")
CkXml::ckUpdateChildContent(xmlToSign,"p","Some text...")
CkXml::ckUpdateAttrAt(xmlToSign,"p[1]",1,"class","note")
CkXml::ckUpdateChildContent(xmlToSign,"p[1]","A note...")
Debug CkXml::ckGetXml(xmlToSign)
gen.i = CkXmlDSigGen::ckCreate()
If gen.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXmlDSigGen::setCkSigLocation(gen, "doc")
CkXmlDSigGen::setCkSigLocationMod(gen, 0)
CkXmlDSigGen::setCkSigId(gen, "Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature")
CkXmlDSigGen::setCkSigNamespacePrefix(gen, "ds")
CkXmlDSigGen::setCkSigNamespaceUri(gen, "http://www.w3.org/2000/09/xmldsig#")
CkXmlDSigGen::setCkSigValueId(gen, "Signature-78f29839-06af-448f-b479-ca46457fab1b-SignatureValue")
CkXmlDSigGen::setCkSignedInfoCanonAlg(gen, "C14N")
CkXmlDSigGen::setCkSignedInfoDigestMethod(gen, "sha1")
; Set the KeyInfoId before adding references..
CkXmlDSigGen::setCkKeyInfoId(gen, "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>
object1.i = CkXml::ckCreate()
If object1.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(object1, "xades:QualifyingProperties")
CkXml::ckAddAttribute(object1,"Id","Signature-78f29839-06af-448f-b479-ca46457fab1b-QualifyingProperties")
CkXml::ckAddAttribute(object1,"Target","#Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature")
CkXml::ckAddAttribute(object1,"xmlns:ds","http://www.w3.org/2000/09/xmldsig#")
CkXml::ckAddAttribute(object1,"xmlns:xades","http://uri.etsi.org/01903/v1.3.2#")
CkXml::ckUpdateAttrAt(object1,"xades:SignedProperties",1,"Id","Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties")
CkXml::ckUpdateChildContent(object1,"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
CkXml::ckUpdateAttrAt(object1,"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod",1,"Algorithm","http://www.w3.org/2000/09/xmldsig#sha1")
CkXml::ckUpdateChildContent(object1,"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue","TO BE GENERATED BY CHILKAT")
CkXml::ckUpdateChildContent(object1,"xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2","TO BE GENERATED BY CHILKAT")
CkXml::ckUpdateAttrAt(object1,"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat",1,"ObjectReference","#Reference-24eb6003-d41c-442c-a731-d4c58f94790b")
CkXml::ckUpdateChildContent(object1,"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Description","")
CkXml::ckUpdateAttrAt(object1,"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier",1,"Qualifier","OIDAsURN")
CkXml::ckUpdateChildContent(object1,"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier","urn:oid:1.2.840.10003.5.109.10")
CkXml::ckUpdateChildContent(object1,"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Description","")
CkXml::ckUpdateChildContent(object1,"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType","text/xml")
CkXml::ckUpdateChildContent(object1,"xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Encoding","")
Debug CkXml::ckGetXml(object1)
CkXmlDSigGen::ckAddObject(gen,"",CkXml::ckGetXml(object1),"","")
; -------- 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>
xml1.i = CkXml::ckCreate()
If xml1.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml1, "ds:Transforms")
CkXml::ckUpdateAttrAt(xml1,"ds:Transform",1,"Algorithm","http://www.w3.org/TR/2001/REC-xml-c14n-20010315")
CkXml::ckUpdateAttrAt(xml1,"ds:Transform[1]",1,"Algorithm","http://www.w3.org/2000/09/xmldsig#enveloped-signature")
CkXml::ckUpdateAttrAt(xml1,"ds:Transform[2]",1,"Algorithm","http://www.w3.org/TR/1999/REC-xpath-19991116")
CkXml::ckUpdateAttrAt(xml1,"ds:Transform[2]|ds:XPath",1,"xmlns:ds","http://www.w3.org/2000/09/xmldsig#")
CkXml::ckUpdateChildContent(xml1,"ds:Transform[2]|ds:XPath","not(ancestor-or-self::ds:Signature)")
; This is the "Transforms" XML fragment passed to AddSameDocRef2.
Debug CkXml::ckGetXml(xml1)
CkXmlDSigGen::ckAddSameDocRef2(gen,"","sha1",xml1,"")
CkXmlDSigGen::ckSetRefIdAttr(gen,"","Reference-24eb6003-d41c-442c-a731-d4c58f94790b")
; -------- Reference 2 --------
CkXmlDSigGen::ckAddObjectRef(gen,"Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties","sha1","","","http://uri.etsi.org/01903#SignedProperties")
; -------- Reference 3 --------
CkXmlDSigGen::ckAddSameDocRef(gen,"Signature-78f29839-06af-448f-b479-ca46457fab1b-KeyInfo","sha1","","","")
; Provide a certificate + private key. (PFX password is test123)
cert.i = CkCert::ckCreate()
If cert.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkCert::ckLoadPfxFile(cert,"qa_data/pfx/cert_test123.pfx","test123")
If success <> 1
Debug CkCert::ckLastErrorText(cert)
CkXml::ckDispose(xmlToSign)
CkXmlDSigGen::ckDispose(gen)
CkXml::ckDispose(object1)
CkXml::ckDispose(xml1)
CkCert::ckDispose(cert)
ProcedureReturn
EndIf
CkXmlDSigGen::ckSetX509Cert(gen,cert,1)
CkXmlDSigGen::setCkKeyInfoType(gen, "X509Data+KeyValue")
CkXmlDSigGen::setCkX509Type(gen, "CertChain")
; Load XML to be signed...
sbXml.i = CkStringBuilder::ckCreate()
If sbXml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckGetXmlSb(xmlToSign,sbXml)
CkXmlDSigGen::setCkBehaviors(gen, "IndentedSignature")
; Sign the XML...
success = CkXmlDSigGen::ckCreateXmlDSigSb(gen,sbXml)
If success <> 1
Debug CkXmlDSigGen::ckLastErrorText(gen)
CkXml::ckDispose(xmlToSign)
CkXmlDSigGen::ckDispose(gen)
CkXml::ckDispose(object1)
CkXml::ckDispose(xml1)
CkCert::ckDispose(cert)
CkStringBuilder::ckDispose(sbXml)
ProcedureReturn
EndIf
; -----------------------------------------------
; Save the signed XML to a file.
success = CkStringBuilder::ckWriteFile(sbXml,"qa_output/signedXml.xml","utf-8",0)
Debug CkStringBuilder::ckGetAsString(sbXml)
; ----------------------------------------
; Verify the signatures we just produced...
verifier.i = CkXmlDSig::ckCreate()
If verifier.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkXmlDSig::ckLoadSignatureSb(verifier,sbXml)
If success <> 1
Debug CkXmlDSig::ckLastErrorText(verifier)
CkXml::ckDispose(xmlToSign)
CkXmlDSigGen::ckDispose(gen)
CkXml::ckDispose(object1)
CkXml::ckDispose(xml1)
CkCert::ckDispose(cert)
CkStringBuilder::ckDispose(sbXml)
CkXmlDSig::ckDispose(verifier)
ProcedureReturn
EndIf
numSigs.i = CkXmlDSig::ckNumSignatures(verifier)
verifyIdx.i = 0
While verifyIdx < numSigs
CkXmlDSig::setCkSelector(verifier, verifyIdx)
verified.i = CkXmlDSig::ckVerifySignature(verifier,1)
If verified <> 1
Debug CkXmlDSig::ckLastErrorText(verifier)
CkXml::ckDispose(xmlToSign)
CkXmlDSigGen::ckDispose(gen)
CkXml::ckDispose(object1)
CkXml::ckDispose(xml1)
CkCert::ckDispose(cert)
CkStringBuilder::ckDispose(sbXml)
CkXmlDSig::ckDispose(verifier)
ProcedureReturn
EndIf
verifyIdx = verifyIdx + 1
Wend
Debug "All signatures were successfully verified."
CkXml::ckDispose(xmlToSign)
CkXmlDSigGen::ckDispose(gen)
CkXml::ckDispose(object1)
CkXml::ckDispose(xml1)
CkCert::ckDispose(cert)
CkStringBuilder::ckDispose(sbXml)
CkXmlDSig::ckDispose(verifier)
ProcedureReturn
EndProcedure