Pascal (Lazarus/Delphi)

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) Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.XmlDSigGen,
  Chilkat.JavaKeyStore,
  Chilkat.StringBuilder,
  Chilkat.CertChain,
  Chilkat.Cert,
  Chilkat.Xml;

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

procedure RunDemo;
var
  success: Boolean;
  xml: TXml;
  jks: TJavaKeyStore;
  password: string;
  chain: TCertChain;
  cert: TCert;
  gen: TXmlDSigGen;
  bUsePrivateKey: Boolean;
  sbXml: TStringBuilder;

begin
  success := False;

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

  xml := TXml.Create;
  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.
  jks := TJavaKeyStore.Create;
  password := 'secret';
  success := jks.LoadFile(password,'qa_data/jks/test_secret.jks');
  if (success = False) then
    begin
      WriteLn(jks.LastErrorText);
      Exit;
    end;

  //  Make sure we have a private key.
  if (jks.NumPrivateKeys < 1) then
    begin
      WriteLn('No private key available.');
      Exit;
    end;

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

  chain := TCertChain.Create;
  success := jks.CertChainAt(0,chain);
  if (success = False) then
    begin
      WriteLn(jks.LastErrorText);
      Exit;
    end;

  cert := TCert.Create;
  success := chain.CertAt(0,cert);
  if (success = False) then
    begin
      WriteLn(chain.LastErrorText);
      Exit;
    end;

  //  Verify again that this cert has a private key.
  if (cert.HasPrivateKey() <> True) then
    begin
      WriteLn('Certificate has no associated private key.');
      Exit;
    end;

  //  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
  gen := TXmlDSigGen.Create;

  //  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.
  bUsePrivateKey := True;
  success := gen.SetX509Cert(cert,bUsePrivateKey);
  if (success <> True) then
    begin
      WriteLn(gen.LastErrorText);
      Exit;
    end;

  //  Everything's specified.  Now create and insert the Signature
  sbXml := TStringBuilder.Create;
  xml.GetXmlSb(sbXml);
  success := gen.CreateXmlDSigSb(sbXml);
  if (success = False) then
    begin
      WriteLn(gen.LastErrorText);
      Exit;
    end;

  //  Examine the XML with the digital signature inserted
  WriteLn(sbXml.GetAsString());


  xml.Free;
  jks.Free;
  chain.Free;
  cert.Free;
  gen.Free;
  sbXml.Free;

end;

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

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.