Java

PKCS11 XML Signature using Certificate and Private Key on Smart Card / USB Token

See more PKCS11 Examples

Sample code showing how to use PKCS11 to create an XML digital signature with a certificate and private key stored on a smart card or USB token.

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

Chilkat2 Java

import com.chilkatsoft.chilkat2.Cert;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Pkcs11;
import com.chilkatsoft.chilkat2.StringBuilder;
import com.chilkatsoft.chilkat2.Xml;
import com.chilkatsoft.chilkat2.XmlDSigGen;

public class ChilkatExample {

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

        // Note: Chilkat's PKCS11 implementation runs on Windows, Linux, Mac OS X, and other supported operating systems.

        Pkcs11 pkcs11 = new Pkcs11();

        // This example is tested on Windows using a Giesecke and Devrient Sm@rtCafe Expert 3.2 smart card.
        // You will use the DLL (or shared lib) provided by your smart card vendor, or a DLL compatible with your smart card.
        // On Windows, if the DLL is located in C:\Windows\System32, specify only the filename.
        // Otherwise provide the full path.
        pkcs11.setSharedLibPath("aetpkss1.dll");

        // Make it an authenticated session by calling Login.
        int userType = 1;
        // Make sure to use the correct PIN for your smart card..
        String pin = "0000";

        try {
            pkcs11.quickSession(userType, pin);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Get the certificate (on the smart card) that has a private key.
        Cert cert = new Cert();
        try {
            pkcs11.findCert("privateKey", "", cert);
            System.out.println("Cert with private key: " + cert.getSubjectCN());
        } catch (ChilkatException e) {
            System.out.println("No certificates having a private key were found.");
            pkcs11.closeSession();
            return;
        }

        // --------------------------------------------------------------------------
        // At this point, we have the cert to be used for signing.
        // Our XML signing code is the same as for a cert obtained from any other source..

        // First generate the following XML to be signed:
        // Use this online tool to generate code from sample XML:
        // Generate Code to Create XML

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

        Xml xml = new Xml();
        xml.setTag("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");

        XmlDSigGen gen = new XmlDSigGen();

        // Indicate where the Signature will be inserted.
        gen.setSigLocation("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.setSignedInfoPrefixList("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.setKeyInfoType("X509Data");
        gen.setX509Type("Certificate");

        boolean bUsePrivateKey = true;
        try {
            gen.setX509Cert(cert, bUsePrivateKey);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            pkcs11.closeSession();
            return;
        }

        // Everything's specified.  Now create and insert the Signature
        StringBuilder sbXml = new StringBuilder();
        xml.setEmitCompact(true);
        xml.getXmlSb(sbXml);

        try {
            gen.createXmlDSigSb(sbXml);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            pkcs11.closeSession();
            return;
        }

        // Examine the XML with the digital signature inserted
        System.out.println(sbXml.getAsString());

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

        // Revert to an unauthenticated session by calling Logout.
        try {
            pkcs11.logout();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            pkcs11.closeSession();
            return;
        }

        // When finished, close the session.
        // It is important to close the session (memory leaks will occur if the session is not properly closed).
        try {
            pkcs11.closeSession();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Success.");
    }
}