Sample code for 30+ languages & platforms
Rust

Sign with BinarySecurityToken

See more XML Digital Signatures Examples

Demonstrates creating an XML signature using a BinarySecurityToken.

Chilkat Rust Downloads

Rust

// 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.
let cert = chilkat::Cert::new();
if cert.load_pfx_file("qa_data/pfx/cert_test123.pfx", "test123").is_err() {
    println!("{}", cert.last_error_text());
    return;
}

// -------------------------------------------------------------------------
// 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.
// 

let xml = chilkat::Xml::new();
xml.set_tag("S:Envelope");
let _ = xml.add_attribute("xmlns:S", "http://www.w3.org/2003/05/soap-envelope");
let _ = xml.add_attribute("xmlns:wsse11", "http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd");
let _ = xml.add_attribute("xmlns:wsse", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd");
let _ = xml.add_attribute("xmlns:wsu", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd");
let _ = xml.add_attribute("xmlns:xs", "http://www.w3.org/2001/XMLSchema");
let _ = xml.add_attribute("xmlns:ds", "http://www.w3.org/2000/09/xmldsig#");
let _ = xml.add_attribute("xmlns:exc14n", "http://www.w3.org/2001/10/xml-exc-c14n#");
let _ = xml.update_attr_at("S:Header|To", true, "xmlns", "http://www.w3.org/2005/08/addressing");
let _ = xml.update_attr_at("S:Header|To", true, "wsu:Id", "_5002");
xml.update_child_content("S:Header|To", "https://XXXXXXXXX");
let _ = xml.update_attr_at("S:Header|Action", true, "xmlns", "http://www.w3.org/2005/08/addressing");
let _ = xml.update_attr_at("S:Header|Action", true, "xmlns:S", "http://www.w3.org/2003/05/soap-envelope");
let _ = xml.update_attr_at("S:Header|Action", true, "S:mustUnderstand", "true");
xml.update_child_content("S:Header|Action", "http://docs.oasis-open.org/ws-sx/ws-trust/200512/RST/Issue");
let _ = xml.update_attr_at("S:Header|ReplyTo", true, "xmlns", "http://www.w3.org/2005/08/addressing");
xml.update_child_content("S:Header|ReplyTo|Address", "http://www.w3.org/2005/08/addressing/anonymous");
let _ = xml.update_attr_at("S:Header|FaultTo", true, "xmlns", "http://www.w3.org/2005/08/addressing");
xml.update_child_content("S:Header|FaultTo|Address", "http://www.w3.org/2005/08/addressing/anonymous");
let _ = xml.update_attr_at("S:Header|MessageID", true, "xmlns", "http://www.w3.org/2005/08/addressing");
xml.update_child_content("S:Header|MessageID", "uuid:e9033251-4ff0-4618-8baf-4952ab5fd207");
let _ = xml.update_attr_at("S:Header|wsse:Security", true, "S:mustUnderstand", "true");
let _ = xml.update_attr_at("S:Header|wsse:Security|wsu:Timestamp", true, "xmlns:ns17", "http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512");
let _ = xml.update_attr_at("S:Header|wsse:Security|wsu:Timestamp", true, "xmlns:ns16", "http://schemas.xmlsoap.org/soap/envelope/");
let _ = xml.update_attr_at("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"
let dt = chilkat::DateTime::new();
let _ = dt.set_from_current_system_time();
xml.update_child_content("S:Header|wsse:Security|wsu:Timestamp|wsu:Created", &dt.get_as_timestamp(false).unwrap_or_default());
// Add 5 minutes.
let _ = dt.add_seconds(300);
xml.update_child_content("S:Header|wsse:Security|wsu:Timestamp|wsu:Expires", &dt.get_as_timestamp(false).unwrap_or_default());

let _ = xml.update_attr_at("S:Header|wsse:Security|wsse:BinarySecurityToken", true, "xmlns:ns17", "http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512");
let _ = xml.update_attr_at("S:Header|wsse:Security|wsse:BinarySecurityToken", true, "xmlns:ns16", "http://schemas.xmlsoap.org/soap/envelope/");
let _ = xml.update_attr_at("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");
let _ = xml.update_attr_at("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");
let _ = xml.update_attr_at("S:Header|wsse:Security|wsse:BinarySecurityToken", true, "wsu:Id", "uuid_43470044-78b4-4b23-926a-b7f590d24cb8");

let bd_cert = chilkat::BinData::new();
let _ = cert.export_cert_der_bd(&bd_cert);

// Get the cert as base64 on one line.
xml.update_child_content("S:Header|wsse:Security|wsse:BinarySecurityToken", &bd_cert.get_encoded("base64").unwrap_or_default());
let _ = xml.update_attr_at("S:Body|RequestSecurityToken", true, "xmlns", "http://docs.oasis-open.org/ws-sx/ws-trust/200512");
xml.update_child_content("S:Body|RequestSecurityToken|RequestType", "http://docs.oasis-open.org/ws-sx/ws-trust/200512/Issue");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|wsp:AppliesTo", true, "xmlns:wsp", "http://schemas.xmlsoap.org/ws/2004/09/policy");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|wsp:AppliesTo|EndpointReference:EndpointReference", true, "xmlns:EndpointReference", "http://www.w3.org/2005/08/addressing");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|wsp:AppliesTo|EndpointReference:EndpointReference", true, "xmlns", "http://www.w3.org/2005/08/addressing");
xml.update_child_content("S:Body|RequestSecurityToken|wsp:AppliesTo|EndpointReference:EndpointReference|Address", "https://XXXXXXXXX/services");
xml.update_child_content("S:Body|RequestSecurityToken|TokenType", "http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV2.0");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims", true, "xmlns:i", "http://schemas.xmlsoap.org/ws/2005/05/identity");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims", true, "Dialect", "http://schemas.xmlsoap.org/ws/2005/05/identity");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType", true, "Optional", "false");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/abn");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[1]", true, "Optional", "false");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[1]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/commonname");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[2]", true, "Optional", "false");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[2]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/credentialtype");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[3]", true, "Optional", "false");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[3]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/samlsubjectid");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[4]", true, "Optional", "false");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[4]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/fingerprint");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[5]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[5]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/sbr_personid");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[6]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[6]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/givennames");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[7]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[7]", true, "Uri", "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[8]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[8]", true, "Uri", "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[9]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[9]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/credentialadministrator");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[10]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[10]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/stalecrlminutes");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[11]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[11]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/subjectdn");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[12]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[12]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/issuerdn");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[13]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[13]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/notafterdate");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[14]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[14]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/certificateserialnumber");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[15]", true, "Optional", "true");
let _ = xml.update_attr_at("S:Body|RequestSecurityToken|Claims|i:ClaimType[15]", true, "Uri", "http://XXXXXXXXX/2008/06/identity/claims/previoussubject");

let _ = dt.set_from_current_system_time();
let _ = xml.update_attr_at("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.update_child_content("S:Body|RequestSecurityToken|Lifetime|wsu:Created", &dt.get_as_timestamp(false).unwrap_or_default());

// Add 40 minutes.
let _ = dt.add_seconds(2400);
let _ = xml.update_attr_at("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.update_child_content("S:Body|RequestSecurityToken|Lifetime|wsu:Expires", &dt.get_as_timestamp(false).unwrap_or_default());

xml.update_child_content("S:Body|RequestSecurityToken|KeyType", "http://docs.oasis-open.org/ws-sx/ws-trust/200512/SymmetricKey");
xml.update_child_content("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>

let key_info_xml = chilkat::Xml::new();
key_info_xml.set_tag("wsse:SecurityTokenReference");
let _ = key_info_xml.update_attr_at("wsse:Reference", true, "URI", "#uuid_43470044-78b4-4b23-926a-b7f590d24cb8");
let _ = key_info_xml.update_attr_at("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.
// 
let gen_ = chilkat::XmlDSigGen::new();
gen_.set_sig_location("S:Envelope|S:Header|wsse:Security");
gen_.set_signed_info_prefix_list("wsse S");

let _ = gen_.add_same_doc_ref("_1", "sha1", "EXCL_C14N", "wsu wsse S", "");
let _ = gen_.add_same_doc_ref("_5002", "sha1", "EXCL_C14N", "S", "");

gen_.set_key_info_type("Custom");
key_info_xml.set_emit_xml_decl(false);
gen_.set_custom_key_info_xml(&key_info_xml.get_xml().unwrap_or_default());

// Specify the cert for signing (which has a private key because it was loaded from a PFX)
let _ = gen_.set_x509_cert(&cert, true);

// Indicated we want an indented signature for easier human reading.
gen_.set_behaviors("IndentedSignature");

// Sign the XML..
let sb_xml = chilkat::StringBuilder::new();
let _ = xml.get_xml_sb(&sb_xml);

if gen_.create_xml_d_sig_sb(&sb_xml).is_err() {
    println!("{}", gen_.last_error_text());
    return;
}

// Examine the signed XML
println!("{}", sb_xml.get_as_string().unwrap_or_default());

// 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>
//