AutoIt

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.

AutoIt

Local $bSuccess = False

; 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 = ObjCreate("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.
Local $iUserType = 1
; Make sure to use the correct PIN for your smart card..
Local $sPin = "0000"

$bSuccess = $oPkcs11.QuickSession($iUserType,$sPin)
If ($bSuccess = False) Then
    ConsoleWrite($oPkcs11.LastErrorText & @CRLF)
    Exit
EndIf

; Get the certificate (on the smart card) that has a private key.
$oCert = ObjCreate("Chilkat.Cert")
$bSuccess = $oPkcs11.FindCert("privateKey","",$oCert)
If ($bSuccess = True) Then
    ConsoleWrite("Cert with private key: " & $oCert.SubjectCN & @CRLF)
Else
    ConsoleWrite("No certificates having a private key were found." & @CRLF)
    $bSuccess = $oPkcs11.CloseSession()
    Exit
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 = 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")

$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"

Local $bUsePrivateKey = True
$bSuccess = $oGen.SetX509Cert($oCert,$bUsePrivateKey)
If ($bSuccess <> True) Then
    ConsoleWrite($oGen.LastErrorText & @CRLF)
    $bSuccess = $oPkcs11.CloseSession()
    Exit
EndIf

; Everything's specified.  Now create and insert the Signature
$oSbXml = ObjCreate("Chilkat.StringBuilder")
$oXml.EmitCompact = True
$oXml.GetXmlSb($oSbXml)

$bSuccess = $oGen.CreateXmlDSigSb($oSbXml)
If ($bSuccess <> True) Then
    ConsoleWrite($oGen.LastErrorText & @CRLF)
    $bSuccess = $oPkcs11.CloseSession()
    Exit
EndIf

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

; --------------------------------------------------------------------------

; Revert to an unauthenticated session by calling Logout.
$bSuccess = $oPkcs11.Logout()
If ($bSuccess = False) Then
    ConsoleWrite($oPkcs11.LastErrorText & @CRLF)
    $bSuccess = $oPkcs11.CloseSession()
    Exit
EndIf

; When finished, close the session.
; It is important to close the session (memory leaks will occur if the session is not properly closed).
$bSuccess = $oPkcs11.CloseSession()
If ($bSuccess = False) Then
    ConsoleWrite($oPkcs11.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("Success." & @CRLF)