Dart Requires Chilkat v11.0.0+

Create XML Signature using Java KeyStore (.jks)

See more XML Digital Signatures Examples

Demonstrates how to create an XML digital signature using a certificate and private key from a Java KeyStore (.jks) Dart

import 'package:chilkat/chilkat.dart';

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

  // The SOAP XML to be signed in this example contains the following:

  // <?xml version="1.0" encoding="UTF-8" standalone="no" ?>
  // <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  //     <SOAP-ENV:Header>
  //         <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1"></wsse:Security>
  //     </SOAP-ENV:Header>
  //     <SOAP-ENV:Body xmlns:SOAP-SEC="http://schemas.xmlsoap.org/soap/security/2000-12" SOAP-SEC:id="Body">
  //         <z:FooBar xmlns:z="http://example.com" />
  //     </SOAP-ENV:Body>
  // </SOAP-ENV:Envelope>
  // 

  // Build the XML to sign.
  // Use this online tool to generate the code from sample XML: 
  // Generate Code to Create XML

  final xml = CkXml();
  xml.tag = 'SOAP-ENV:Envelope';
  xml.addAttribute('xmlns:SOAP-ENV', 'http://schemas.xmlsoap.org/soap/envelope/');
  xml.updateAttrAt('SOAP-ENV:Header|wsse:Security', true, 'xmlns:wsse', 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd');
  xml.updateAttrAt('SOAP-ENV:Header|wsse:Security', true, 'SOAP-ENV:mustUnderstand', '1');
  xml.updateAttrAt('SOAP-ENV:Body', true, 'xmlns:SOAP-SEC', 'http://schemas.xmlsoap.org/soap/security/2000-12');
  xml.updateAttrAt('SOAP-ENV:Body', true, 'SOAP-SEC:id', 'Body');
  xml.updateAttrAt('SOAP-ENV:Body|z:FooBar', true, 'xmlns:z', 'http://example.com');

  // Load a JavaKeyStore file containing the certificate + private key.
  final jks = CkJavaKeyStore();
  final password = 'secret';
  try {
    jks.loadFile(password, 'qa_data/jks/test_secret.jks');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Make sure we have a private key.
  if (jks.numPrivateKeys < 1) {
    print('No private key available.');
    return;
  }

  // -------------------------------------------------------------------------
  // Get the certificate chain associated with the 1st (and probably only) private key in the JKS.

  final chain = CkCertChain();
  try {
    jks.certChainAt(0, chain);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final cert = CkCert();
  try {
    chain.certAt(0, cert);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Verify again that this cert has a private key.
  if (!cert.hasPrivateKey()) {
    print('Certificate has no associated private key.');
    return;
  }

  // Prepare for signing...
  // Use this online tool to generate the following code from an already-signed XML sample: 
  // Generate Code to Create an XML Signature
  final gen = CkXmlDSigGen();

  // Indicate where the Signature will be inserted.
  gen.sigLocation = 'SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security';

  // Add a reference to the fragment of the XML to be signed.
  gen.addSameDocRef('Body', 'sha1', 'EXCL_C14N', '', '');

  // (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
  gen.signedInfoPrefixList = 'wsse SOAP-ENV';

  // Provide the private key for signing via the certificate, and indicate that
  // we want the base64 of the certificate embedded in the KeyInfo.
  gen.keyInfoType = 'X509Data';
  gen.x509Type = 'Certificate';

  // Note: Because our certificate was loaded from a JKS which also contained the private key,
  // Chilkat automatically knows and has the private key associated with the certificate.
  // We set bUsePrivateKey to tell the SetX509Cert method to automatically use the private key
  // associated with the certificate for signing.
  final bUsePrivateKey = true;
  try {
    gen.setX509Cert(cert, bUsePrivateKey);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Everything's specified.  Now create and insert the Signature
  final sbXml = CkStringBuilder();
  xml.getXmlSb(sbXml);
  try {
    gen.createXmlDSigSb(sbXml);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Examine the XML with the digital signature inserted
  print(sbXml.getAsString());
}