Xbase++

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.

Xbase++

LOCAL nSuccess
LOCAL oPkcs11
LOCAL nUserType
LOCAL cPin
LOCAL oCert
LOCAL oXml
LOCAL oGen
LOCAL nBUsePrivateKey
LOCAL oSbXml

nSuccess := 0

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

oPkcs11 := CreateObject("Chilkat.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.
oPkcs11:SharedLibPath := "aetpkss1.dll"

//  Make it an authenticated session by calling Login.
nUserType := 1
//  Make sure to use the correct PIN for your smart card..
cPin := "0000"

nSuccess := oPkcs11:QuickSession(nUserType, cPin)
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    RETURN
ENDIF

//  Get the certificate (on the smart card) that has a private key.
oCert := CreateObject("Chilkat.Cert")
nSuccess := oPkcs11:FindCert("privateKey", "", oCert)
IF (nSuccess == 1)
    ? "Cert with private key: " + oCert:SubjectCN
ELSE
    ? "No certificates having a private key were found."
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    oCert:destroy()
    RETURN
ENDIF

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

oXml := CreateObject("Chilkat.Xml")
oXml:Tag := "SOAP-ENV:Envelope"
oXml:AddAttribute("xmlns:SOAP-ENV", "http://schemas.xmlsoap.org/soap/envelope/")
oXml:UpdateAttrAt("SOAP-ENV:Header|wsse:Security", 1, "xmlns:wsse", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
oXml:UpdateAttrAt("SOAP-ENV:Header|wsse:Security", 1, "SOAP-ENV:mustUnderstand", "1")
oXml:UpdateAttrAt("SOAP-ENV:Body", 1, "xmlns:SOAP-SEC", "http://schemas.xmlsoap.org/soap/security/2000-12")
oXml:UpdateAttrAt("SOAP-ENV:Body", 1, "SOAP-SEC:id", "Body")
oXml:UpdateAttrAt("SOAP-ENV:Body|z:FooBar", 1, "xmlns:z", "http://example.com")

oGen := CreateObject("Chilkat.XmlDSigGen")

//  Indicate where the Signature will be inserted.
oGen: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"
oGen:AddSameDocRef("Body", "sha1", "EXCL_C14N", "", "")

//  (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
oGen: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.
oGen:KeyInfoType := "X509Data"
oGen:X509Type := "Certificate"

nBUsePrivateKey := 1
nSuccess := oGen:SetX509Cert(oCert, nBUsePrivateKey)
IF (nSuccess != 1)
    ? oGen:LastErrorText
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    oCert:destroy()
    oXml:destroy()
    oGen:destroy()
    RETURN
ENDIF

//  Everything's specified.  Now create and insert the Signature
oSbXml := CreateObject("Chilkat.StringBuilder")
oXml:EmitCompact := 1
oXml:GetXmlSb(oSbXml)

nSuccess := oGen:CreateXmlDSigSb(oSbXml)
IF (nSuccess != 1)
    ? oGen:LastErrorText
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    oCert:destroy()
    oXml:destroy()
    oGen:destroy()
    oSbXml:destroy()
    RETURN
ENDIF

//  Examine the XML with the digital signature inserted
? oSbXml:GetAsString()

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

//  Revert to an unauthenticated session by calling Logout.
nSuccess := oPkcs11:Logout()
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    nSuccess := oPkcs11:CloseSession()
    oPkcs11:destroy()
    oCert:destroy()
    oXml:destroy()
    oGen:destroy()
    oSbXml:destroy()
    RETURN
ENDIF

//  When finished, close the session.
//  It is important to close the session (memory leaks will occur if the session is not properly closed).
nSuccess := oPkcs11:CloseSession()
IF (nSuccess == 0)
    ? oPkcs11:LastErrorText
    oPkcs11:destroy()
    oCert:destroy()
    oXml:destroy()
    oGen:destroy()
    oSbXml:destroy()
    RETURN
ENDIF

? "Success."

oPkcs11:destroy()
oCert:destroy()
oXml:destroy()
oGen:destroy()
oSbXml:destroy()