(PHP Extension) Create Signed SOAP XML for DIAN Colombia WCF Service

Demonstrates how to create a signed SOAP XML document for DIAN Colombia.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// This example will produce a signed SOAP XML message that looks like this:

// <?xml version="1.0" encoding="utf-8"?>
// <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:wcf="http://wcf.dian.colombia">
//     <soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
//         <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
//             <wsu:Timestamp wsu:Id="TS-F25839120CBA3ECDAD68754D0443A667636FDA68">
//                 <wsu:Created>2019-08-23T23:03:01Z</wsu:Created>
//                 <wsu:Expires>2019-08-24T15:43:01Z</wsu:Expires>
//             </wsu:Timestamp>
//             <wsse:BinarySecurityToken EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary" 
// 			ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" 
// 			wsu:Id="ABCXYZ-9F0F7E15A59816E680B4735080A789DC1EED6C9C">MIIG8jCCBd ... zLjGQUB6lcz</wsse:BinarySecurityToken>
//             <ds:Signature Id="SIG-F25839120CBA3ECDAD68754D0443A667636FDA68" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
//                 <ds:SignedInfo>
//                     <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
//                         <ec:InclusiveNamespaces PrefixList="wsa soap wcf" xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#"/>
//                     </ds:CanonicalizationMethod>
//                     <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
//                     <ds:Reference URI="#ID-F25839120CBA3ECDAD68754D0443A667636FDA68">
//                         <ds:Transforms>
//                             <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
//                                 <ec:InclusiveNamespaces PrefixList="soap wcf" xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#"/>
//                             </ds:Transform>
//                         </ds:Transforms>
//                         <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
//                         <ds:DigestValue>gSIKtjS/BKA2bgecXkM8lYVBDqlXcU3juNYT9a+bSnM=</ds:DigestValue>
//                     </ds:Reference>
//                 </ds:SignedInfo>
//                 <ds:SignatureValue>sL7rOdyfkEnKgJja0eWrv ... YqG0T0pflBsGW9zXkjQ9NvAw==</ds:SignatureValue>
//                 <ds:KeyInfo Id="KI-F25839120CBA3ECDAD68754D0443A667636FDA68">
//                     <wsse:SecurityTokenReference wsu:Id="STR-F25839120CBA3ECDAD68754D0443A667636FDA68">
//                         <wsse:Reference URI="#ABCXYZ-9F0F7E15A59816E680B4735080A789DC1EED6C9C" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3"/>
//                     </wsse:SecurityTokenReference>
//                 </ds:KeyInfo>
//             </ds:Signature>
//         </wsse:Security>
//         <wsa:Action>http://wcf.dian.colombia/IWcfDianCustomerServices/GetStatus</wsa:Action>
//         <wsa:To wsu:Id="ID-F25839120CBA3ECDAD68754D0443A667636FDA68" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">https://vpfe-hab.dian.gov.co/WcfDianCustomerServices.svc</wsa:To>
//     </soap:Header>
//     <soap:Body>
//         <wcf:GetStatus>
//             <wcf:trackId>123456666</wcf:trackId>
//         </wcf:GetStatus>
//     </soap:Body>
// </soap:Envelope>

// Use this online tool to generate code from sample Signed XML: 
// Generate Code to Create Signed XML

$success = true;
// Create the XML to be signed...
$xmlToSign = new CkXml();
$xmlToSign->put_Tag('soap:Envelope');
$xmlToSign->AddAttribute('xmlns:soap','http://www.w3.org/2003/05/soap-envelope');
$xmlToSign->AddAttribute('xmlns:wcf','http://wcf.dian.colombia');
$xmlToSign->UpdateAttrAt('soap:Header',true,'xmlns:wsa','http://www.w3.org/2005/08/addressing');
$xmlToSign->UpdateAttrAt('soap:Header|wsse:Security',true,'xmlns:wsse','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd');
$xmlToSign->UpdateAttrAt('soap:Header|wsse:Security',true,'xmlns:wsu','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd');
$xmlToSign->UpdateAttrAt('soap:Header|wsse:Security|wsu:Timestamp',true,'wsu:Id','TS-F25839120CBA3ECDAD68754D0443A667636FDA68');
$xmlToSign->UpdateChildContent('soap:Header|wsse:Security|wsu:Timestamp|wsu:Created','2019-08-23T23:03:01Z');
$xmlToSign->UpdateChildContent('soap:Header|wsse:Security|wsu:Timestamp|wsu:Expires','2019-08-24T15:43:01Z');
$xmlToSign->UpdateAttrAt('soap:Header|wsse:Security|wsse:BinarySecurityToken',true,'EncodingType','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary');
$xmlToSign->UpdateAttrAt('soap:Header|wsse:Security|wsse:BinarySecurityToken',true,'ValueType','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3');
$xmlToSign->UpdateAttrAt('soap:Header|wsse:Security|wsse:BinarySecurityToken',true,'wsu:Id','ABCXYZ-9F0F7E15A59816E680B4735080A789DC1EED6C9C');
$xmlToSign->UpdateChildContent('soap:Header|wsse:Security|wsse:BinarySecurityToken','BinarySecurityToken_Base64Binary_Content');
$xmlToSign->UpdateChildContent('soap:Header|wsa:Action','http://wcf.dian.colombia/IWcfDianCustomerServices/GetStatus');
$xmlToSign->UpdateAttrAt('soap:Header|wsa:To',true,'wsu:Id','ID-F25839120CBA3ECDAD68754D0443A667636FDA68');
$xmlToSign->UpdateAttrAt('soap:Header|wsa:To',true,'xmlns:wsu','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd');
$xmlToSign->UpdateChildContent('soap:Header|wsa:To','https://vpfe-hab.dian.gov.co/WcfDianCustomerServices.svc');
$xmlToSign->UpdateChildContent('soap:Body|wcf:GetStatus|wcf:trackId','123456666');

$gen = new CkXmlDSigGen();

$gen->put_SigLocation('soap:Envelope|soap:Header|wsse:Security');
$gen->put_SigLocationMod(0);
$gen->put_SigId('SIG-F25839120CBA3ECDAD68754D0443A667636FDA68');
$gen->put_SigNamespacePrefix('ds');
$gen->put_SigNamespaceUri('http://www.w3.org/2000/09/xmldsig#');
$gen->put_SignedInfoCanonAlg('EXCL_C14N');
$gen->put_SignedInfoDigestMethod('sha256');

// Set the KeyInfoId before adding references..
$gen->put_KeyInfoId('KI-F25839120CBA3ECDAD68754D0443A667636FDA68');

// -------- Reference 1 --------
$gen->AddSameDocRef('ID-F25839120CBA3ECDAD68754D0443A667636FDA68','sha256','EXCL_C14N','soap wcf','');

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

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

$gen->put_KeyInfoType('Custom');

// Create the custom KeyInfo XML..
$xmlCustomKeyInfo = new CkXml();
$xmlCustomKeyInfo->put_Tag('wsse:SecurityTokenReference');
$xmlCustomKeyInfo->AddAttribute('wsu:Id','STR-F25839120CBA3ECDAD68754D0443A667636FDA68');
$xmlCustomKeyInfo->UpdateAttrAt('wsse:Reference',true,'URI','#ABCXYZ-9F0F7E15A59816E680B4735080A789DC1EED6C9C');
$xmlCustomKeyInfo->UpdateAttrAt('wsse:Reference',true,'ValueType','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3');

$xmlCustomKeyInfo->put_EmitXmlDecl(false);
$gen->put_CustomKeyInfoXml($xmlCustomKeyInfo->getXml());

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

// Update BinarySecurityToken_Base64Binary_Content with the actual X509 of the signing cert.
$bdCert = new CkBinData();
$cert->ExportCertDerBd($bdCert);

$nReplaced = $sbXml->Replace('BinarySecurityToken_Base64Binary_Content',$bdCert->getEncoded('base64'));

$gen->put_Behaviors('IndentedSignature');

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

// -----------------------------------------------

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

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

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

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

    $verifyIdx = $verifyIdx + 1;
}

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

// --------------------------------------------------------------------------------
// Also see Chilkat's Online WSDL Code Generator
// to generate code and SOAP Request and Response XML for each operation in a WSDL.
// --------------------------------------------------------------------------------

?>