PHP Extension
PHP Extension
Sign with BinarySecurityToken
See more XML Digital Signatures Examples
Demonstrates creating an XML signature using a BinarySecurityToken.Chilkat PHP Extension Downloads
<?php
include("chilkat.php");
$success = false;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// -------------------------------------------------------------------------
// Load a cert + private key from a PFX.
$cert = new CkCert();
$success = $cert->LoadPfxFile('qa_data/pfx/cert_test123.pfx','test123');
if ($success != true) {
print $cert->lastErrorText() . "\n";
exit;
}
// -------------------------------------------------------------------------
// Create the XML that is to be signed.
//
// The XML we're creating can be found at Sample Pre-Signed XML with BinarySecurityToken
// The online tool at http://tools.chilkat.io/xmlCreate.cshtml can be used to generate the following XML creation code.
//
$xml = new CkXml();
$xml->put_Tag('S:Envelope');
$xml->AddAttribute('xmlns:S','http://www.w3.org/2003/05/soap-envelope');
$xml->AddAttribute('xmlns:wsse11','http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd');
$xml->AddAttribute('xmlns:wsse','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd');
$xml->AddAttribute('xmlns:wsu','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd');
$xml->AddAttribute('xmlns:xs','http://www.w3.org/2001/XMLSchema');
$xml->AddAttribute('xmlns:ds','http://www.w3.org/2000/09/xmldsig#');
$xml->AddAttribute('xmlns:exc14n','http://www.w3.org/2001/10/xml-exc-c14n#');
$xml->UpdateAttrAt('S:Header|To',true,'xmlns','http://www.w3.org/2005/08/addressing');
$xml->UpdateAttrAt('S:Header|To',true,'wsu:Id','_5002');
$xml->UpdateChildContent('S:Header|To','https://XXXXXXXXX');
$xml->UpdateAttrAt('S:Header|Action',true,'xmlns','http://www.w3.org/2005/08/addressing');
$xml->UpdateAttrAt('S:Header|Action',true,'xmlns:S','http://www.w3.org/2003/05/soap-envelope');
$xml->UpdateAttrAt('S:Header|Action',true,'S:mustUnderstand','true');
$xml->UpdateChildContent('S:Header|Action','http://docs.oasis-open.org/ws-sx/ws-trust/200512/RST/Issue');
$xml->UpdateAttrAt('S:Header|ReplyTo',true,'xmlns','http://www.w3.org/2005/08/addressing');
$xml->UpdateChildContent('S:Header|ReplyTo|Address','http://www.w3.org/2005/08/addressing/anonymous');
$xml->UpdateAttrAt('S:Header|FaultTo',true,'xmlns','http://www.w3.org/2005/08/addressing');
$xml->UpdateChildContent('S:Header|FaultTo|Address','http://www.w3.org/2005/08/addressing/anonymous');
$xml->UpdateAttrAt('S:Header|MessageID',true,'xmlns','http://www.w3.org/2005/08/addressing');
$xml->UpdateChildContent('S:Header|MessageID','uuid:e9033251-4ff0-4618-8baf-4952ab5fd207');
$xml->UpdateAttrAt('S:Header|wsse:Security',true,'S:mustUnderstand','true');
$xml->UpdateAttrAt('S:Header|wsse:Security|wsu:Timestamp',true,'xmlns:ns17','http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512');
$xml->UpdateAttrAt('S:Header|wsse:Security|wsu:Timestamp',true,'xmlns:ns16','http://schemas.xmlsoap.org/soap/envelope/');
$xml->UpdateAttrAt('S:Header|wsse:Security|wsu:Timestamp',true,'wsu:Id','_1');
// Get the current date/time in timestamp format, such as "2018-05-23T02:38:27Z"
$dt = new CkDateTime();
$dt->SetFromCurrentSystemTime();
$xml->UpdateChildContent('S:Header|wsse:Security|wsu:Timestamp|wsu:Created',$dt->getAsTimestamp(false));
// Add 5 minutes.
$dt->AddSeconds(300);
$xml->UpdateChildContent('S:Header|wsse:Security|wsu:Timestamp|wsu:Expires',$dt->getAsTimestamp(false));
$xml->UpdateAttrAt('S:Header|wsse:Security|wsse:BinarySecurityToken',true,'xmlns:ns17','http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512');
$xml->UpdateAttrAt('S:Header|wsse:Security|wsse:BinarySecurityToken',true,'xmlns:ns16','http://schemas.xmlsoap.org/soap/envelope/');
$xml->UpdateAttrAt('S:Header|wsse:Security|wsse:BinarySecurityToken',true,'ValueType','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3');
$xml->UpdateAttrAt('S:Header|wsse:Security|wsse:BinarySecurityToken',true,'EncodingType','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary');
$xml->UpdateAttrAt('S:Header|wsse:Security|wsse:BinarySecurityToken',true,'wsu:Id','uuid_43470044-78b4-4b23-926a-b7f590d24cb8');
$bdCert = new CkBinData();
$cert->ExportCertDerBd($bdCert);
// Get the cert as base64 on one line.
$xml->UpdateChildContent('S:Header|wsse:Security|wsse:BinarySecurityToken',$bdCert->getEncoded('base64'));
$xml->UpdateAttrAt('S:Body|RequestSecurityToken',true,'xmlns','http://docs.oasis-open.org/ws-sx/ws-trust/200512');
$xml->UpdateChildContent('S:Body|RequestSecurityToken|RequestType','http://docs.oasis-open.org/ws-sx/ws-trust/200512/Issue');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|wsp:AppliesTo',true,'xmlns:wsp','http://schemas.xmlsoap.org/ws/2004/09/policy');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|wsp:AppliesTo|EndpointReference:EndpointReference',true,'xmlns:EndpointReference','http://www.w3.org/2005/08/addressing');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|wsp:AppliesTo|EndpointReference:EndpointReference',true,'xmlns','http://www.w3.org/2005/08/addressing');
$xml->UpdateChildContent('S:Body|RequestSecurityToken|wsp:AppliesTo|EndpointReference:EndpointReference|Address','https://XXXXXXXXX/services');
$xml->UpdateChildContent('S:Body|RequestSecurityToken|TokenType','http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV2.0');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims',true,'xmlns:i','http://schemas.xmlsoap.org/ws/2005/05/identity');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims',true,'Dialect','http://schemas.xmlsoap.org/ws/2005/05/identity');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType',true,'Optional','false');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/abn');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[1]',true,'Optional','false');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[1]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/commonname');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[2]',true,'Optional','false');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[2]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/credentialtype');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[3]',true,'Optional','false');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[3]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/samlsubjectid');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[4]',true,'Optional','false');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[4]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/fingerprint');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[5]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[5]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/sbr_personid');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[6]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[6]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/givennames');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[7]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[7]',true,'Uri','http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[8]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[8]',true,'Uri','http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[9]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[9]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/credentialadministrator');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[10]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[10]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/stalecrlminutes');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[11]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[11]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/subjectdn');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[12]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[12]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/issuerdn');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[13]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[13]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/notafterdate');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[14]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[14]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/certificateserialnumber');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[15]',true,'Optional','true');
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Claims|i:ClaimType[15]',true,'Uri','http://XXXXXXXXX/2008/06/identity/claims/previoussubject');
$dt->SetFromCurrentSystemTime();
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Lifetime|wsu:Created',true,'xmlns:wsu','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd');
$xml->UpdateChildContent('S:Body|RequestSecurityToken|Lifetime|wsu:Created',$dt->getAsTimestamp(false));
// Add 40 minutes.
$dt->AddSeconds(2400);
$xml->UpdateAttrAt('S:Body|RequestSecurityToken|Lifetime|wsu:Expires',true,'xmlns:wsu','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd');
$xml->UpdateChildContent('S:Body|RequestSecurityToken|Lifetime|wsu:Expires',$dt->getAsTimestamp(false));
$xml->UpdateChildContent('S:Body|RequestSecurityToken|KeyType','http://docs.oasis-open.org/ws-sx/ws-trust/200512/SymmetricKey');
$xml->UpdateChildContent('S:Body|RequestSecurityToken|KeySize','512');
// Examine the pre-signed XML
// println xml.GetXml();
// Build the custom KeyInfo XML we'll use:
//
// <wsse:SecurityTokenReference>
// <wsse:Reference URI="#uuid_43470044-78b4-4b23-926a-b7f590d24cb8" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" /></wsse:SecurityTokenReference>
$keyInfoXml = new CkXml();
$keyInfoXml->put_Tag('wsse:SecurityTokenReference');
$keyInfoXml->UpdateAttrAt('wsse:Reference',true,'URI','#uuid_43470044-78b4-4b23-926a-b7f590d24cb8');
$keyInfoXml->UpdateAttrAt('wsse:Reference',true,'ValueType','http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3');
// -------------------------------------------------------------------------
// Setup the XML Digital Signature Generator and add the XML Signature.
//
$gen = new CkXmlDSigGen();
$gen->put_SigLocation('S:Envelope|S:Header|wsse:Security');
$gen->put_SignedInfoPrefixList('wsse S');
$gen->AddSameDocRef('_1','sha1','EXCL_C14N','wsu wsse S','');
$gen->AddSameDocRef('_5002','sha1','EXCL_C14N','S','');
$gen->put_KeyInfoType('Custom');
$keyInfoXml->put_EmitXmlDecl(false);
$gen->put_CustomKeyInfoXml($keyInfoXml->getXml());
// Specify the cert for signing (which has a private key because it was loaded from a PFX)
$gen->SetX509Cert($cert,true);
// Indicated we want an indented signature for easier human reading.
$gen->put_Behaviors('IndentedSignature');
// Sign the XML..
$sbXml = new CkStringBuilder();
$xml->GetXmlSb($sbXml);
$success = $gen->CreateXmlDSigSb($sbXml);
if ($success != true) {
print $gen->lastErrorText() . "\n";
exit;
}
// Examine the signed XML
print $sbXml->getAsString() . "\n";
// The resulting signature (extracted from the surrounding XML) looks something like this:
// <ds:Signature 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 xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="wsse S" />
// </ds:CanonicalizationMethod>
// <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" />
// <ds:Reference URI="#_1">
// <ds:Transforms>
// <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
// <ec:InclusiveNamespaces xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="wsu wsse S" />
// </ds:Transform>
// </ds:Transforms>
// <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
// <ds:DigestValue>VAJMC/L/BDvml7Qv5CBMePbKDE8=</ds:DigestValue>
// </ds:Reference>
// <ds:Reference URI="#_5002">
// <ds:Transforms>
// <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
// <ec:InclusiveNamespaces xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="S" />
// </ds:Transform>
// </ds:Transforms>
// <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
// <ds:DigestValue>sW/QFsk6kGv1dzeu0H9Qc/2kvAQ=</ds:DigestValue>
// </ds:Reference>
// </ds:SignedInfo>
// <ds:SignatureValue>....</ds:SignatureValue>
// <ds:KeyInfo>
// <wsse:SecurityTokenReference>
// <wsse:Reference URI="#uuid_43470044-78b4-4b23-926a-b7f590d24cb8" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3" />
// </wsse:SecurityTokenReference>
// </ds:KeyInfo>
// </ds:Signature>
//
?>