PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Pkcs11
integer li_UserType
string ls_Pin
oleobject loo_Cert
oleobject loo_Xml
oleobject loo_Gen
integer li_BUsePrivateKey
oleobject loo_SbXml

li_Success = 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.

loo_Pkcs11 = create oleobject
li_rc = loo_Pkcs11.ConnectToNewObject("Chilkat.Pkcs11")
if li_rc < 0 then
    destroy loo_Pkcs11
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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.
loo_Pkcs11.SharedLibPath = "aetpkss1.dll"

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

li_Success = loo_Pkcs11.QuickSession(li_UserType,ls_Pin)
if li_Success = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    destroy loo_Pkcs11
    return
end if

// Get the certificate (on the smart card) that has a private key.
loo_Cert = create oleobject
li_rc = loo_Cert.ConnectToNewObject("Chilkat.Cert")

li_Success = loo_Pkcs11.FindCert("privateKey","",loo_Cert)
if li_Success = 1 then
    Write-Debug "Cert with private key: " + loo_Cert.SubjectCN
else
    Write-Debug "No certificates having a private key were found."
    li_Success = loo_Pkcs11.CloseSession()
    destroy loo_Pkcs11
    destroy loo_Cert
    return
end if

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

loo_Xml = create oleobject
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")

loo_Xml.Tag = "SOAP-ENV:Envelope"
loo_Xml.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/")
loo_Xml.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")
loo_Xml.UpdateAttrAt("SOAP-ENV:Header|wsse:Security",1,"SOAP-ENV:mustUnderstand","1")
loo_Xml.UpdateAttrAt("SOAP-ENV:Body",1,"xmlns:SOAP-SEC","http://schemas.xmlsoap.org/soap/security/2000-12")
loo_Xml.UpdateAttrAt("SOAP-ENV:Body",1,"SOAP-SEC:id","Body")
loo_Xml.UpdateAttrAt("SOAP-ENV:Body|z:FooBar",1,"xmlns:z","http://example.com")

loo_Gen = create oleobject
li_rc = loo_Gen.ConnectToNewObject("Chilkat.XmlDSigGen")

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

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

li_BUsePrivateKey = 1
li_Success = loo_Gen.SetX509Cert(loo_Cert,li_BUsePrivateKey)
if li_Success <> 1 then
    Write-Debug loo_Gen.LastErrorText
    li_Success = loo_Pkcs11.CloseSession()
    destroy loo_Pkcs11
    destroy loo_Cert
    destroy loo_Xml
    destroy loo_Gen
    return
end if

// Everything's specified.  Now create and insert the Signature
loo_SbXml = create oleobject
li_rc = loo_SbXml.ConnectToNewObject("Chilkat.StringBuilder")

loo_Xml.EmitCompact = 1
loo_Xml.GetXmlSb(loo_SbXml)

li_Success = loo_Gen.CreateXmlDSigSb(loo_SbXml)
if li_Success <> 1 then
    Write-Debug loo_Gen.LastErrorText
    li_Success = loo_Pkcs11.CloseSession()
    destroy loo_Pkcs11
    destroy loo_Cert
    destroy loo_Xml
    destroy loo_Gen
    destroy loo_SbXml
    return
end if

// Examine the XML with the digital signature inserted
Write-Debug loo_SbXml.GetAsString()

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

// Revert to an unauthenticated session by calling Logout.
li_Success = loo_Pkcs11.Logout()
if li_Success = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    li_Success = loo_Pkcs11.CloseSession()
    destroy loo_Pkcs11
    destroy loo_Cert
    destroy loo_Xml
    destroy loo_Gen
    destroy loo_SbXml
    return
end if

// When finished, close the session.
// It is important to close the session (memory leaks will occur if the session is not properly closed).
li_Success = loo_Pkcs11.CloseSession()
if li_Success = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    destroy loo_Pkcs11
    destroy loo_Cert
    destroy loo_Xml
    destroy loo_Gen
    destroy loo_SbXml
    return
end if

Write-Debug "Success."


destroy loo_Pkcs11
destroy loo_Cert
destroy loo_Xml
destroy loo_Gen
destroy loo_SbXml