AutoIt

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

Local $bSuccess = False

; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oScmd = ObjCreate("Chilkat.ScMinidriver")

; Reader names (smart card readers or USB tokens) can be discovered
; via List Readers or Find Smart Cards
Local $sReaderName = "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0"
$bSuccess = $oScmd.AcquireContext($sReaderName)
If ($bSuccess = False) Then
    ConsoleWrite($oScmd.LastErrorText & @CRLF)
    Exit
EndIf

; If successful, the name of the currently inserted smart card is available:
ConsoleWrite("Card name: " & $oScmd.CardName & @CRLF)

; If desired, perform regular PIN authentication with the smartcard.
; For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
Local $iRetval = $oScmd.PinAuthenticate("user","000000")
If ($iRetval <> 0) Then
    ConsoleWrite("PIN Authentication failed." & @CRLF)
EndIf

; 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
Local $sCertPart = "subjectCN"
Local $sPartValue = "PIVKey E42D60A759D39147A26E0AF2FB1183C5"

; If the certificate is found, it is loaded into the cert object.
$oCert = ObjCreate("Chilkat.Cert")
$bSuccess = $oScmd.FindCert($sCertPart,$sPartValue,$oCert)
If ($bSuccess = False) Then
    ConsoleWrite("Failed to find the certificate." & @CRLF)
    $oScmd.DeleteContext()
    Exit
EndIf

ConsoleWrite("Successfully loaded the cert object from the smart card / USB token." & @CRLF)

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

$oXml = ObjCreate("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",True,"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",True,"SOAP-ENV:mustUnderstand","1")
$oXml.UpdateAttrAt("SOAP-ENV:Body",True,"xmlns:SOAP-SEC","http://schemas.xmlsoap.org/soap/security/2000-12")
$oXml.UpdateAttrAt("SOAP-ENV:Body",True,"SOAP-SEC:id","Body")
$oXml.UpdateAttrAt("SOAP-ENV:Body|z:FooBar",True,"xmlns:z","http://example.com")

; Prepare for signing...
$oGen = ObjCreate("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"

; 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.
Local $bUsePrivateKey = True
$bSuccess = $oGen.SetX509Cert($oCert,$bUsePrivateKey)
If ($bSuccess <> True) Then
    ConsoleWrite($oGen.LastErrorText & @CRLF)
    Exit
EndIf

; Everything's specified.  Now create and insert the Signature
$oSbXml = ObjCreate("Chilkat.StringBuilder")
$oXml.GetXmlSb($oSbXml)
$bSuccess = $oGen.CreateXmlDSigSb($oSbXml)
If ($bSuccess <> True) Then
    ConsoleWrite($oGen.LastErrorText & @CRLF)
    Exit
EndIf

; Examine the XML with the digital signature inserted
ConsoleWrite($oSbXml.GetAsString() & @CRLF)

; ------------------------------------------------------------------------------------------------------------
; Cleanup our ScMinidriver session...

; When finished with operations that required authentication, you may if you wish, deauthenticate the session.
$bSuccess = $oScmd.PinDeauthenticate("user")
If ($bSuccess = False) Then
    ConsoleWrite($oScmd.LastErrorText & @CRLF)
EndIf

; Delete the context when finished with the card.
$bSuccess = $oScmd.DeleteContext()
If ($bSuccess = False) Then
    ConsoleWrite($oScmd.LastErrorText & @CRLF)
EndIf