React Native
React Native
Sign SOAP XML for New Zealand Customs Service
See more XAdES Examples
Demonstrates how to create an XAdES signed SOAP XML pertaining to the New Zealand Customs Service.Note: This example requires Chilkat v9.5.0.96 or later.
Chilkat React Native Downloads
import { Cert, CkDateTime, StringBuilder, Xml, XmlDSigGen } from '@chilkat/react-native'
async function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// Create the following XML to be signed:
// <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
// xmlns:v1="http://customs.govt.nz/jbms/msggate/reqresp/v1">
// <soapenv:Header>
// <wsse:Security soapenv:mustUnderstand="1"
// 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-037E78514E9B9132CB16817563559151">
// <wsu:Created>2023-04-17T18:32:35.913Z</wsu:Created>
// <wsu:Expires>2023-04-17T19:32:35.913Z</wsu:Expires>
// </wsu:Timestamp>
// </wsse:Security>
// </soapenv:Header>
// <soapenv:Body wsu:Id="id-8"
// xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
// <v1:RequestResponse>
// <v1:Submitter>TEST1234</v1:Submitter>
// <v1:MailboxMsgId>999999</v1:MailboxMsgId>
// </v1:RequestResponse>
// </soapenv:Body>
// </soapenv:Envelope>
// Create a random ID like this: TS-037E78514E9B9132CB16817563559151
const tsId = new StringBuilder();
tsId.append('TS-');
tsId.appendRandom(16, 'hex');
// STR-037E78514E9B9132CB16817563559614
const strId = new StringBuilder();
strId.append('STR-');
strId.appendRandom(16, 'hex');
// KI-037E78514E9B9132CB16817563559583
const keyInfoId = new StringBuilder();
keyInfoId.append('KI-');
keyInfoId.appendRandom(16, 'hex');
// Create a date/time for the current time with this format: 2023-04-17T18:32:35.913Z
const dt = new CkDateTime();
dt.setFromCurrentSystemTime();
const sbNow = new StringBuilder();
sbNow.append(dt.getAsTimestamp(false));
// If we really need the milliseconds, we can replace the "Z" with ".000Z"
// The server will also likely accept a timestamp without milliseconds, such as 2023-04-17T18:32:35Z
let n = sbNow.replace('Z', '.000Z');
const sbNowPlusOneHour = new StringBuilder();
dt.addSeconds(3600);
sbNowPlusOneHour.append(dt.getAsTimestamp(false));
n = sbNowPlusOneHour.replace('Z', '.000Z');
const xmlToSign = new Xml();
xmlToSign.tag = 'soapenv:Envelope';
xmlToSign.addAttribute('xmlns:soapenv', 'http://schemas.xmlsoap.org/soap/envelope/');
xmlToSign.addAttribute('xmlns:v1', 'http://customs.govt.nz/jbms/msggate/reqresp/v1');
xmlToSign.updateAttrAt('soapenv:Header|wsse:Security', true, 'soapenv:mustUnderstand', '1');
xmlToSign.updateAttrAt('soapenv:Header|wsse:Security', true, 'xmlns:wsse', 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd');
xmlToSign.updateAttrAt('soapenv:Header|wsse:Security', true, 'xmlns:wsu', 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd');
xmlToSign.updateAttrAt('soapenv:Header|wsse:Security|wsu:Timestamp', true, 'wsu:Id', tsId.getAsString());
xmlToSign.updateChildContent('soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Created', sbNow.getAsString());
xmlToSign.updateChildContent('soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Expires', sbNowPlusOneHour.getAsString());
xmlToSign.updateAttrAt('soapenv:Body', true, 'wsu:Id', 'id-8');
xmlToSign.updateAttrAt('soapenv:Body', true, 'xmlns:wsu', 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd');
xmlToSign.updateChildContent('soapenv:Body|v1:RequestResponse|v1:Submitter', 'TEST1234');
xmlToSign.updateChildContent('soapenv:Body|v1:RequestResponse|v1:MailboxMsgId', '999999');
const gen = new XmlDSigGen();
gen.sigLocation = 'soapenv:Envelope|soapenv:Header|wsse:Security';
gen.sigLocationMod = 0;
gen.sigId = 'SIG-037E78514E9B9132CB16817563559695';
gen.sigNamespacePrefix = 'ds';
gen.sigNamespaceUri = 'http://www.w3.org/2000/09/xmldsig#';
gen.signedInfoPrefixList = 'soapenv v1';
gen.incNamespacePrefix = 'ec';
gen.incNamespaceUri = 'http://www.w3.org/2001/10/xml-exc-c14n#';
gen.signedInfoCanonAlg = 'EXCL_C14N';
gen.signedInfoDigestMethod = 'sha256';
// Set the KeyInfoId before adding references..
gen.keyInfoId = keyInfoId.getAsString();
// -------- Reference 1 --------
const xml1 = new Xml();
xml1.tag = 'ds:Transforms';
xml1.updateAttrAt('ds:Transform', true, 'Algorithm', 'http://www.w3.org/2001/10/xml-exc-c14n#');
xml1.updateAttrAt('ds:Transform|ec:InclusiveNamespaces', true, 'PrefixList', 'wsse soapenv v1');
xml1.updateAttrAt('ds:Transform|ec:InclusiveNamespaces', true, 'xmlns:ec', 'http://www.w3.org/2001/10/xml-exc-c14n#');
gen.addSameDocRef2(tsId.getAsString(), 'sha256', xml1, '');
// -------- Reference 2 --------
const xml2 = new Xml();
xml2.tag = 'ds:Transforms';
xml2.updateAttrAt('ds:Transform', true, 'Algorithm', 'http://www.w3.org/2001/10/xml-exc-c14n#');
xml2.updateAttrAt('ds:Transform|ec:InclusiveNamespaces', true, 'PrefixList', 'v1');
xml2.updateAttrAt('ds:Transform|ec:InclusiveNamespaces', true, 'xmlns:ec', 'http://www.w3.org/2001/10/xml-exc-c14n#');
gen.addSameDocRef2('id-8', 'sha256', xml2, '');
// Provide a certificate + private key. (PFX password is test123)
const cert = new Cert();
try {
cert.loadPfxFile('qa_data/pfx/cert_test123.pfx', 'test123');
} catch {
console.log(cert.lastErrorText);
return;
}
gen.setX509Cert(cert, true);
gen.keyInfoType = 'Custom';
// Create the custom KeyInfo XML..
const xmlCustomKeyInfo = new Xml();
xmlCustomKeyInfo.tag = 'wsse:SecurityTokenReference';
xmlCustomKeyInfo.addAttribute('wsu:Id', strId.getAsString());
xmlCustomKeyInfo.updateAttrAt('wsse:KeyIdentifier', true, 'EncodingType', 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary');
xmlCustomKeyInfo.updateAttrAt('wsse:KeyIdentifier', true, 'ValueType', 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3');
// Insert the single-line base64 of the signing certificate's DER
cert.uncommonOptions = 'Base64CertNoCRLF';
xmlCustomKeyInfo.updateChildContent('wsse:KeyIdentifier', cert.getEncoded());
xmlCustomKeyInfo.emitXmlDecl = false;
gen.customKeyInfoXml = xmlCustomKeyInfo.getXml();
// Load XML to be signed...
const sbXml = new StringBuilder();
xmlToSign.getXmlSb(sbXml);
gen.behaviors = 'IndentedSignature';
// Sign the XML...
gen.verboseLogging = true;
try {
await gen.createXmlDSigSbAsync(sbXml);
} catch {
console.log(gen.lastErrorText);
return;
}
// Save the signed XML to a file.
sbXml.writeFile('c:/temp/qa_output/signedXml.xml', 'utf-8', false);
console.log(sbXml.getAsString());
}