(Android™) Sign XML (XAdES) in the Cloud using AWS KMS

See more Signing in the Cloud Examples

Note: This example requires Chilkat v9.5.0.96 or greater.

Chilkat Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    // Create the XML to be signed.
    CkStringBuilder sbXml = new CkStringBuilder();

    boolean bCrlf = true;
    sbXml.AppendLine("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\" ?>",bCrlf);
    sbXml.AppendLine("<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\">",bCrlf);
    sbXml.AppendLine("    <SOAP-ENV:Header>",bCrlf);
    sbXml.AppendLine("        <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>",bCrlf);
    sbXml.AppendLine("    </SOAP-ENV:Header>",bCrlf);
    sbXml.AppendLine("    <SOAP-ENV:Body xmlns:SOAP-SEC=\"http://schemas.xmlsoap.org/soap/security/2000-12\" SOAP-SEC:id=\"Body\">",bCrlf);
    sbXml.AppendLine("        <z:FooBar xmlns:z=\"http://example.com\" />",bCrlf);
    sbXml.AppendLine("    </SOAP-ENV:Body>",bCrlf);
    sbXml.AppendLine("</SOAP-ENV:Envelope>",bCrlf);

    // Load the certificate used for signing.  The certificate's private key is stored in AWS KMS
    // However, we still need the certificate locally (without private key).
    CkCert cert = new CkCert();
    boolean success = cert.LoadFromFile("qa_data/certs/myCert.cer");
    if (success == false) {
        Log.i(TAG, cert.lastErrorText());
        return;
        }

    // Here's a screenshot of our private key AWS KMS:
    

    // To sign using AWS KMS, 
    // add the following lines of code to specify your AWS authentication credentials,
    // and the ID of the KMS private key.
    CkJsonObject jsonAwsKms = new CkJsonObject();
    // Set the "service" equal to "aws_kms" to tell Chilkat to use AWS KMS for signing.
    jsonAwsKms.UpdateString("service","aws_kms");
    jsonAwsKms.UpdateString("access_key","ACCESS_KEY");
    jsonAwsKms.UpdateString("secret_key","SECRET_KEY");
    // Make sure to specify the correct region for your case.
    jsonAwsKms.UpdateString("region","us-west-2");
    // In the above screenshot, our key ID is "187012e8-008f-4fc7-b100-5efe6146dff2".  You will use your key ID.
    jsonAwsKms.UpdateString("key_id","187012e8-008f-4fc7-b100-5efe6146dff2");

    success = cert.SetCloudSigner(jsonAwsKms);

    // Prepare for signing...
    CkXmlDSigGen gen = new CkXmlDSigGen();

    // Indicate where the Signature will be inserted.
    gen.put_SigLocation("SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security");

    // Add a reference to the fragment of the XML to be signed.

    // Note: "Body" refers to the XML element having an "id" equal to "Body", where "id" is case insensitive
    // and where any namespace might qualify the attribute.  In this case, the SOAP-ENV:Body fragment is signed
    // NOT because the tag = "Body", but because it has SOAP-SEC:id="Body"
    gen.AddSameDocRef("Body","sha1","EXCL_C14N","","");

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

    gen.put_KeyInfoType("X509Data");
    gen.put_X509Type("IssuerSerial");

    boolean bUsePrivateKey = true;
    success = gen.SetX509Cert(cert,bUsePrivateKey);
    if (success != true) {
        Log.i(TAG, gen.lastErrorText());

        return;
        }

    // Everything's specified.  Now create and insert the Signature
    // (The actual signing of the hash will happen on the AWS KMS server.)
    success = gen.CreateXmlDSigSb(sbXml);
    if (success != true) {
        Log.i(TAG, gen.lastErrorText());
        return;
        }

    // Examine the XML with the digital signature inserted
    Log.i(TAG, sbXml.getAsString());

    // --------------------------------------------------------------------------------
    // Also see Chilkat's Online WSDL Code Generator
    // to generate code and SOAP Request and Response XML for each operation in a WSDL.
    // --------------------------------------------------------------------------------

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}