Sample code for 30+ languages & platforms
Perl

XML-DSig Add Reference with Transforms Specified Explicitly

Demonstrates how to use the new AddSameDocRef2 method to explicitly specify the XML Transforms fragment.

Chilkat Perl Downloads

Perl
use chilkat();

$success = 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 = chilkat::CkXml->new();
$xmlToSign->put_Tag("doc");
$xmlToSign->UpdateAttrAt("s",1,"id","s1");
$xmlToSign->UpdateChildContent("s","Some text...");
$xmlToSign->UpdateChildContent("p","Some text...");
$xmlToSign->UpdateAttrAt("p[1]",1,"class","note");
$xmlToSign->UpdateChildContent("p[1]","A note...");

print $xmlToSign->getXml() . "\r\n";

$gen = chilkat::CkXmlDSigGen->new();

$gen->put_SigLocation("doc");
$gen->put_SigLocationMod(0);
$gen->put_SigId("Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature");
$gen->put_SigNamespacePrefix("ds");
$gen->put_SigNamespaceUri("http://www.w3.org/2000/09/xmldsig#");
$gen->put_SigValueId("Signature-78f29839-06af-448f-b479-ca46457fab1b-SignatureValue");
$gen->put_SignedInfoCanonAlg("C14N");
$gen->put_SignedInfoDigestMethod("sha1");

# Set the KeyInfoId before adding references..
$gen->put_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>

$object1 = chilkat::CkXml->new();
$object1->put_Tag("xades:QualifyingProperties");
$object1->AddAttribute("Id","Signature-78f29839-06af-448f-b479-ca46457fab1b-QualifyingProperties");
$object1->AddAttribute("Target","#Signature-78f29839-06af-448f-b479-ca46457fab1b-Signature");
$object1->AddAttribute("xmlns:ds","http://www.w3.org/2000/09/xmldsig#");
$object1->AddAttribute("xmlns:xades","http://uri.etsi.org/01903/v1.3.2#");
$object1->UpdateAttrAt("xades:SignedProperties",1,"Id","Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties");
$object1->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
$object1->UpdateAttrAt("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod",1,"Algorithm","http://www.w3.org/2000/09/xmldsig#sha1");
$object1->UpdateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue","TO BE GENERATED BY CHILKAT");
$object1->UpdateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2","TO BE GENERATED BY CHILKAT");
$object1->UpdateAttrAt("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat",1,"ObjectReference","#Reference-24eb6003-d41c-442c-a731-d4c58f94790b");
$object1->UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Description","");
$object1->UpdateAttrAt("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier",1,"Qualifier","OIDAsURN");
$object1->UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier","urn:oid:1.2.840.10003.5.109.10");
$object1->UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Description","");
$object1->UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType","text/xml");
$object1->UpdateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Encoding","");

print $object1->getXml() . "\r\n";

$gen->AddObject("",$object1->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>

$xml1 = chilkat::CkXml->new();
$xml1->put_Tag("ds:Transforms");
$xml1->UpdateAttrAt("ds:Transform",1,"Algorithm","http://www.w3.org/TR/2001/REC-xml-c14n-20010315");
$xml1->UpdateAttrAt("ds:Transform[1]",1,"Algorithm","http://www.w3.org/2000/09/xmldsig#enveloped-signature");
$xml1->UpdateAttrAt("ds:Transform[2]",1,"Algorithm","http://www.w3.org/TR/1999/REC-xpath-19991116");
$xml1->UpdateAttrAt("ds:Transform[2]|ds:XPath",1,"xmlns:ds","http://www.w3.org/2000/09/xmldsig#");
$xml1->UpdateChildContent("ds:Transform[2]|ds:XPath","not(ancestor-or-self::ds:Signature)");

# This is the "Transforms" XML fragment passed to AddSameDocRef2.
print $xml1->getXml() . "\r\n";

$gen->AddSameDocRef2("","sha1",$xml1,"");

$gen->SetRefIdAttr("","Reference-24eb6003-d41c-442c-a731-d4c58f94790b");

# -------- Reference 2 --------
$gen->AddObjectRef("Signature-78f29839-06af-448f-b479-ca46457fab1b-SignedProperties","sha1","","","http://uri.etsi.org/01903#SignedProperties");

# -------- Reference 3 --------
$gen->AddSameDocRef("Signature-78f29839-06af-448f-b479-ca46457fab1b-KeyInfo","sha1","","","");

# Provide a certificate + private key. (PFX password is test123)
$cert = chilkat::CkCert->new();
$success = $cert->LoadPfxFile("qa_data/pfx/cert_test123.pfx","test123");
if ($success != 1) {
    print $cert->lastErrorText() . "\r\n";
    exit;
}

$gen->SetX509Cert($cert,1);

$gen->put_KeyInfoType("X509Data+KeyValue");
$gen->put_X509Type("CertChain");

# Load XML to be signed...
$sbXml = chilkat::CkStringBuilder->new();
$xmlToSign->GetXmlSb($sbXml);

$gen->put_Behaviors("IndentedSignature");

# Sign the XML...
$success = $gen->CreateXmlDSigSb($sbXml);
if ($success != 1) {
    print $gen->lastErrorText() . "\r\n";
    exit;
}

# -----------------------------------------------

# Save the signed XML to a file.
$success = $sbXml->WriteFile("qa_output/signedXml.xml","utf-8",0);

print $sbXml->getAsString() . "\r\n";

# ----------------------------------------
# Verify the signatures we just produced...
$verifier = chilkat::CkXmlDSig->new();
$success = $verifier->LoadSignatureSb($sbXml);
if ($success != 1) {
    print $verifier->lastErrorText() . "\r\n";
    exit;
}

$numSigs = $verifier->get_NumSignatures();
$verifyIdx = 0;
while ($verifyIdx < $numSigs) {
    $verifier->put_Selector($verifyIdx);
    $verified = $verifier->VerifySignature(1);
    if ($verified != 1) {
        print $verifier->lastErrorText() . "\r\n";
        exit;
    }

    $verifyIdx = $verifyIdx + 1;
}

print "All signatures were successfully verified." . "\r\n";