DataFlex
DataFlex
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.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoScmd
String sReaderName
Integer iRetval
String sCertPart
String sPartValue
Variant vCert
Handle hoCert
Handle hoXml
Handle hoGen
Boolean iBUsePrivateKey
Variant vSbXml
Handle hoSbXml
String sTemp1
Move False To iSuccess
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatScMinidriver)) To hoScmd
If (Not(IsComObjectCreated(hoScmd))) Begin
Send CreateComObject of hoScmd
End
// Reader names (smart card readers or USB tokens) can be discovered
// via List Readers or Find Smart Cards
Move "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0" To sReaderName
Get ComAcquireContext Of hoScmd sReaderName To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoScmd To sTemp1
Showln sTemp1
Procedure_Return
End
// If successful, the name of the currently inserted smart card is available:
Get ComCardName Of hoScmd To sTemp1
Showln "Card name: " sTemp1
// If desired, perform regular PIN authentication with the smartcard.
// For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
Get ComPinAuthenticate Of hoScmd "user" "000000" To iRetval
If (iRetval <> 0) Begin
Showln "PIN Authentication failed."
End
// 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
Move "subjectCN" To sCertPart
Move "PIVKey E42D60A759D39147A26E0AF2FB1183C5" To sPartValue
// If the certificate is found, it is loaded into the cert object.
Get Create (RefClass(cComChilkatCert)) To hoCert
If (Not(IsComObjectCreated(hoCert))) Begin
Send CreateComObject of hoCert
End
Get pvComObject of hoCert to vCert
Get ComFindCert Of hoScmd sCertPart sPartValue vCert To iSuccess
If (iSuccess = False) Begin
Showln "Failed to find the certificate."
Get ComDeleteContext Of hoScmd To iSuccess
Procedure_Return
End
Showln "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>
Get Create (RefClass(cComChilkatXml)) To hoXml
If (Not(IsComObjectCreated(hoXml))) Begin
Send CreateComObject of hoXml
End
Set ComTag Of hoXml To "SOAP-ENV:Envelope"
Get ComAddAttribute Of hoXml "xmlns:SOAP-ENV" "http://schemas.xmlsoap.org/soap/envelope/" To iSuccess
Get ComUpdateAttrAt Of hoXml "SOAP-ENV:Header|wsse:Security" True "xmlns:wsse" "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" To iSuccess
Get ComUpdateAttrAt Of hoXml "SOAP-ENV:Header|wsse:Security" True "SOAP-ENV:mustUnderstand" "1" To iSuccess
Get ComUpdateAttrAt Of hoXml "SOAP-ENV:Body" True "xmlns:SOAP-SEC" "http://schemas.xmlsoap.org/soap/security/2000-12" To iSuccess
Get ComUpdateAttrAt Of hoXml "SOAP-ENV:Body" True "SOAP-SEC:id" "Body" To iSuccess
Get ComUpdateAttrAt Of hoXml "SOAP-ENV:Body|z:FooBar" True "xmlns:z" "http://example.com" To iSuccess
// Prepare for signing...
Get Create (RefClass(cComChilkatXmlDSigGen)) To hoGen
If (Not(IsComObjectCreated(hoGen))) Begin
Send CreateComObject of hoGen
End
// Indicate where the Signature will be inserted.
Set ComSigLocation Of hoGen To "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"
Get ComAddSameDocRef Of hoGen "Body" "sha1" "EXCL_C14N" "" "" To iSuccess
// (You can read about the SignedInfoPrefixList in the online reference documentation. It's optional..)
Set ComSignedInfoPrefixList Of hoGen To "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.
Set ComKeyInfoType Of hoGen To "X509Data"
Set ComX509Type Of hoGen To "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.
Move True To iBUsePrivateKey
Get pvComObject of hoCert to vCert
Get ComSetX509Cert Of hoGen vCert iBUsePrivateKey To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoGen To sTemp1
Showln sTemp1
Procedure_Return
End
// Everything's specified. Now create and insert the Signature
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbXml
If (Not(IsComObjectCreated(hoSbXml))) Begin
Send CreateComObject of hoSbXml
End
Get pvComObject of hoSbXml to vSbXml
Get ComGetXmlSb Of hoXml vSbXml To iSuccess
Get pvComObject of hoSbXml to vSbXml
Get ComCreateXmlDSigSb Of hoGen vSbXml To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoGen To sTemp1
Showln sTemp1
Procedure_Return
End
// Examine the XML with the digital signature inserted
Get ComGetAsString Of hoSbXml To sTemp1
Showln sTemp1
// ------------------------------------------------------------------------------------------------------------
// Cleanup our ScMinidriver session...
// When finished with operations that required authentication, you may if you wish, deauthenticate the session.
Get ComPinDeauthenticate Of hoScmd "user" To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoScmd To sTemp1
Showln sTemp1
End
// Delete the context when finished with the card.
Get ComDeleteContext Of hoScmd To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoScmd To sTemp1
Showln sTemp1
End
End_Procedure