PowerBuilder

Create XML Digital Signature using Certificate on Smart Card

See more ScMinidriver Examples

Demonstrates how to load a certificate located on a smart card or USB token and then use it for creating an XML digital signature such that the cryptographic signing happens on the smart card. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Scmd
string ls_ReaderName
integer li_Retval
string ls_CertPart
string ls_PartValue
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.

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

// Reader names (smart card readers or USB tokens) can be discovered
// via List Readers or Find Smart Cards
ls_ReaderName = "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0"
li_Success = loo_Scmd.AcquireContext(ls_ReaderName)
if li_Success = 0 then
    Write-Debug loo_Scmd.LastErrorText
    destroy loo_Scmd
    return
end if

// If successful, the name of the currently inserted smart card is available:
Write-Debug "Card name: " + loo_Scmd.CardName

// If desired, perform regular PIN authentication with the smartcard.
// For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
li_Retval = loo_Scmd.PinAuthenticate("user","000000")
if li_Retval <> 0 then
    Write-Debug "PIN Authentication failed."
end if

// You can find a cerficate using any of the following certificate parts:
// "subjectDN" -- The full distinguished name of the cert.
// "subjectDN_withTags" -- Same as above, but in a format that includes the subject part tags, such as the "CN=" in "CN=something"
// "subjectCN" -- The common name part (CN) of the certificate's subject.
// "serial" -- The certificate serial number.
// "serial:issuerCN" -- The certificate serial number + the issuer's common name, delimited with a colon char.
// These are the same certificate parts that can be retrieved by listing certificates on the smart card (or USB token).
// See List Certificates on Smart Card Example
ls_CertPart = "subjectCN"
ls_PartValue = "PIVKey E42D60A759D39147A26E0AF2FB1183C5"

// If the certificate is found, it is loaded into the cert object.
loo_Cert = create oleobject
li_rc = loo_Cert.ConnectToNewObject("Chilkat.Cert")

li_Success = loo_Scmd.FindCert(ls_CertPart,ls_PartValue,loo_Cert)
if li_Success = 0 then
    Write-Debug "Failed to find the certificate."
    loo_Scmd.DeleteContext()
    destroy loo_Scmd
    destroy loo_Cert
    return
end if

Write-Debug "Successfully loaded the cert object from the smart card / USB token."

// Note: When successful, the cert object is internally linked to the ScMinidriver object's authenticated session.
// The cert object can now be used to sign or do other cryptographic operations that occur on the smart card / USB token.
// If your application calls PinDeauthenticate or DeleteContext, the cert will no longer be able to sign on the smart card
// because the smart card ScMinidriver session will no longer be authenticated or deleted.

// ------------------------------------------------------------------------------------------------------------
// We have the certificate.  Now let's do the XML digital signature..

// Create the following XML to be signed:

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

// Prepare for signing...
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"

// Note: Our certificate was loaded from the smartcard and is internally linked to the authenticated ScMinidriver session.
// The signing will occur on the smart card using the chosen certificate.
li_BUsePrivateKey = 1
li_Success = loo_Gen.SetX509Cert(loo_Cert,li_BUsePrivateKey)
if li_Success <> 1 then
    Write-Debug loo_Gen.LastErrorText
    destroy loo_Scmd
    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.GetXmlSb(loo_SbXml)
li_Success = loo_Gen.CreateXmlDSigSb(loo_SbXml)
if li_Success <> 1 then
    Write-Debug loo_Gen.LastErrorText
    destroy loo_Scmd
    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()

// ------------------------------------------------------------------------------------------------------------
// Cleanup our ScMinidriver session...

// When finished with operations that required authentication, you may if you wish, deauthenticate the session.
li_Success = loo_Scmd.PinDeauthenticate("user")
if li_Success = 0 then
    Write-Debug loo_Scmd.LastErrorText
end if

// Delete the context when finished with the card.
li_Success = loo_Scmd.DeleteContext()
if li_Success = 0 then
    Write-Debug loo_Scmd.LastErrorText
end if



destroy loo_Scmd
destroy loo_Cert
destroy loo_Xml
destroy loo_Gen
destroy loo_SbXml