PureBasic
PureBasic
EuroCert Cloud Sign XML
See more Signing in the Cloud Examples
Demonstrates how to sign XML using the EuroCert cloud provider. The signing of the hash happens on a hardware token on the EuroCert server. Everything else involving the updating the XML to add the signature happens locally within Chilkat.Note: This example requires Chilkat v9.5.0.96 or later.
Chilkat PureBasic Downloads
IncludeFile "CkPkcs11.pb"
IncludeFile "CkCert.pb"
IncludeFile "CkXmlDSigGen.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkStringBuilder.pb"
Procedure ChilkatExample()
success.i = 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.
pkcs11.i = CkPkcs11::ckCreate()
If pkcs11.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Provide the path to the EuroCert Cloud PKCS11 driver.
; If your application runs as a 64-bit process, use the path to the 64-bit ECSPKCS11.dll
CkPkcs11::setCkSharedLibPath(pkcs11, "C:\Users\Public\ECSIGNER\PKCS11\32\ECSPKCS11.dll")
; At this time, we don't know what should be used for the PIN.
; Perhaps it is documented online by EuroCert?
pin.s = "user:password"
userType.i = 1
success = CkPkcs11::ckQuickSession(pkcs11,userType,pin)
If success = 0
Debug CkPkcs11::ckLastErrorText(pkcs11)
CkPkcs11::ckDispose(pkcs11)
ProcedureReturn
EndIf
cert.i = CkCert::ckCreate()
If cert.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkCert::ckLoadFromFile(cert,"qa_data/certs/myCert.cer")
If success = 0
Debug CkCert::ckLastErrorText(cert)
CkPkcs11::ckDispose(pkcs11)
CkCert::ckDispose(cert)
ProcedureReturn
EndIf
; Tell the certificate to link with the PKCS11 session.
; The cert's private key should be installed on the CloudHSM.
; If there are multiple private keys on the CloudHSM, then Chilkat will automatically
; locate and use the private key corresponding to the certificate.
success = CkCert::ckLinkPkcs11(cert,pkcs11)
If success = 0
Debug CkCert::ckLastErrorText(cert)
CkPkcs11::ckDispose(pkcs11)
CkCert::ckDispose(cert)
ProcedureReturn
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>
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml, "SOAP-ENV:Envelope")
CkXml::ckAddAttribute(xml,"xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/")
CkXml::ckUpdateAttrAt(xml,"SOAP-ENV:Header|wsse:Security",1,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
CkXml::ckUpdateAttrAt(xml,"SOAP-ENV:Header|wsse:Security",1,"SOAP-ENV:mustUnderstand","1")
CkXml::ckUpdateAttrAt(xml,"SOAP-ENV:Body",1,"xmlns:SOAP-SEC","http://schemas.xmlsoap.org/soap/security/2000-12")
CkXml::ckUpdateAttrAt(xml,"SOAP-ENV:Body",1,"SOAP-SEC:id","Body")
CkXml::ckUpdateAttrAt(xml,"SOAP-ENV:Body|z:FooBar",1,"xmlns:z","http://example.com")
gen.i = CkXmlDSigGen::ckCreate()
If gen.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Indicate where the Signature will be inserted.
CkXmlDSigGen::setCkSigLocation(gen, "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"
CkXmlDSigGen::ckAddSameDocRef(gen,"Body","sha1","EXCL_C14N","","")
; (You can read about the SignedInfoPrefixList in the online reference documentation. It's optional..)
CkXmlDSigGen::setCkSignedInfoPrefixList(gen, "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.
CkXmlDSigGen::setCkKeyInfoType(gen, "X509Data")
CkXmlDSigGen::setCkX509Type(gen, "Certificate")
bUsePrivateKey.i = 1
success = CkXmlDSigGen::ckSetX509Cert(gen,cert,bUsePrivateKey)
If success <> 1
Debug CkXmlDSigGen::ckLastErrorText(gen)
success = CkPkcs11::ckCloseSession(pkcs11)
CkPkcs11::ckDispose(pkcs11)
CkCert::ckDispose(cert)
CkXml::ckDispose(xml)
CkXmlDSigGen::ckDispose(gen)
ProcedureReturn
EndIf
; Everything's specified. Now create and insert the Signature
sbXml.i = CkStringBuilder::ckCreate()
If sbXml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkEmitCompact(xml, 1)
CkXml::ckGetXmlSb(xml,sbXml)
success = CkXmlDSigGen::ckCreateXmlDSigSb(gen,sbXml)
If success <> 1
Debug CkXmlDSigGen::ckLastErrorText(gen)
success = CkPkcs11::ckCloseSession(pkcs11)
CkPkcs11::ckDispose(pkcs11)
CkCert::ckDispose(cert)
CkXml::ckDispose(xml)
CkXmlDSigGen::ckDispose(gen)
CkStringBuilder::ckDispose(sbXml)
ProcedureReturn
EndIf
; Examine the XML with the digital signature inserted
Debug CkStringBuilder::ckGetAsString(sbXml)
; --------------------------------------------------------------------------
; Revert to an unauthenticated session by calling Logout.
success = CkPkcs11::ckLogout(pkcs11)
If success = 0
Debug CkPkcs11::ckLastErrorText(pkcs11)
success = CkPkcs11::ckCloseSession(pkcs11)
CkPkcs11::ckDispose(pkcs11)
CkCert::ckDispose(cert)
CkXml::ckDispose(xml)
CkXmlDSigGen::ckDispose(gen)
CkStringBuilder::ckDispose(sbXml)
ProcedureReturn
EndIf
; When finished, close the session.
; It is important to close the session (memory leaks will occur if the session is not properly closed).
success = CkPkcs11::ckCloseSession(pkcs11)
If success = 0
Debug CkPkcs11::ckLastErrorText(pkcs11)
CkPkcs11::ckDispose(pkcs11)
CkCert::ckDispose(cert)
CkXml::ckDispose(xml)
CkXmlDSigGen::ckDispose(gen)
CkStringBuilder::ckDispose(sbXml)
ProcedureReturn
EndIf
Debug "Success."
CkPkcs11::ckDispose(pkcs11)
CkCert::ckDispose(cert)
CkXml::ckDispose(xml)
CkXmlDSigGen::ckDispose(gen)
CkStringBuilder::ckDispose(sbXml)
ProcedureReturn
EndProcedure