PowerBuilder
PowerBuilder
CADES-BES Signature using ePass2003 Token
See more Egypt ITIDA Examples
Demonstrates using a certificate and private key located on an ePass2003 USB token to create a CADES-BES signature.(Demonstrates how to create a .p7s signature that fits Egypt's ITIDA requirements where Chilkat automatically does the ITIDA JSON canonicalization.)
Chilkat PowerBuilder Downloads
integer li_rc
long li_Success
oleobject loo_Scmd
string ls_ReaderName
long li_Retval
string ls_CertPart
string ls_PartValue
oleobject loo_Cert
oleobject loo_Crypt
oleobject loo_CmsOptions
oleobject loo_JsonSigningAttrs
oleobject loo_Json
string ls_SigBase64
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 = "FS USB Token 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","12345678")
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 = "Matt"
// If the certificate is found, it is loaded into the cert object.
// Note: We imported this certificate from a .p12/.pfx using code such as this Example to Import a .pfx/.p12 onto a Smart Card
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.
// ------------------------------------------------------------------------------------------------------------
// Here we have to code to create the CADES-BES signature using Chilkat Crypt2..
loo_Crypt = create oleobject
li_rc = loo_Crypt.ConnectToNewObject("Chilkat.Crypt2")
// Tell the crypt class to use the cert on the ePass2003 token.
li_Success = loo_Crypt.SetSigningCert(loo_Cert)
if li_Success <> 1 then
Write-Debug loo_Crypt.LastErrorText
destroy loo_Scmd
destroy loo_Cert
destroy loo_Crypt
return
end if
loo_CmsOptions = create oleobject
li_rc = loo_CmsOptions.ConnectToNewObject("Chilkat.JsonObject")
// Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
loo_CmsOptions.UpdateBool("DigestData",1)
loo_CmsOptions.UpdateBool("OmitAlgorithmIdNull",1)
// Indicate that we are passing normal JSON and we want Chilkat do automatically
// do the ITIDA JSON canonicalization:
loo_CmsOptions.UpdateBool("CanonicalizeITIDA",1)
loo_Crypt.CmsOptions = loo_CmsOptions.Emit()
// The CadesEnabled property applies to all methods that create CMS/PKCS7 signatures.
// To create a CAdES-BES signature, set this property equal to true.
loo_Crypt.CadesEnabled = 1
loo_Crypt.HashAlgorithm = "sha256"
loo_JsonSigningAttrs = create oleobject
li_rc = loo_JsonSigningAttrs.ConnectToNewObject("Chilkat.JsonObject")
loo_JsonSigningAttrs.UpdateInt("contentType",1)
loo_JsonSigningAttrs.UpdateInt("signingTime",1)
loo_JsonSigningAttrs.UpdateInt("messageDigest",1)
loo_JsonSigningAttrs.UpdateInt("signingCertificateV2",1)
loo_Crypt.SigningAttributes = loo_JsonSigningAttrs.Emit()
// By default, all the certs in the chain of authentication are included in the signature.
// If desired, we can choose to only include the signing certificate:
loo_Crypt.IncludeCertChain = 0
// Pass a JSON document such as the following. Chilkat will do the ITIDA canonicalization.
// (It is the canonicalized JSON that gets signed.)
// {
// "issuer":{
// "address":{
// "branchID":"0",
// "country":"EG",
// "regionCity":"Cairo",
// "postalCode":"",
// "buildingNumber":"0",
// "street":"123rd Street",
// "governate":"GOVERNATE"
// },
// "type":"B",
// "id":"209999899",
// "name":"Xyz SAE"
// },
// "receiver":{
// "address":{
// "country":"EG",
// "regionCity":"CAIRO",
// "postalCode":"11435",
// "buildingNumber":"0",
// "street":"Autostrad Road Abc",
// "governate":"GOVERNATE"
// },
// "type":"B",
// "id":"999999999",
// "name":"XYZ EGYPT FOR TRADE"
// },
// "documentType":"I",
// "documentTypeVersion":"1.0",
// "dateTimeIssued":"2020-11-15T11:04:53Z",
// "taxpayerActivityCode":"1073",
// "internalID":"ZZZZ999",
// "purchaseOrderReference":"2009199918",
// "salesOrderReference":"",
// "payment":{
// "bankName":"",
// "bankAddress":"",
// "bankAccountNo":"",
// "bankAccountIBAN":"",
// "swiftCode":"",
// "terms":""
// },
// "delivery":{
// "approach":"",
// "packaging":"",
// "dateValidity":"",
// "exportPort":"",
// "countryOfOrigin":"EG",
// "grossWeight":0,
// "netWeight":0,
// "terms":""
// },
// "invoiceLines":[
// {
// "description":"CDM Widget 48GX99X12BA",
// "itemType":"GS1",
// "itemCode":"7622213335056",
// "unitType":"CS",
// "quantity":1.00,
// "unitValue":{
// "currencySold":"EGP",
// "amountEGP":588.67,
// "amountSold":0,
// "currencyExchangeRate":0
// },
// "salesTotal":588.67,
// "total":603.97,
// "valueDifference":0,
// "totalTaxableFees":0,
// "netTotal":529.8,
// "itemsDiscount":0,
// "discount":{
// "rate":10.00,
// "amount":58.87
// },
// "taxableItems":[
// {
// "taxType":"T1",
// "amount":74.17,
// "subType":"No sub",
// "rate":14.00
// }
// ],
// "internalCode":"9099994"
// }
// ],
// "totalSales":588.67,
// "totalSalesAmount":588.67,
// "totalDiscountAmount":58.87,
// "netAmount":529.80,
// "taxTotals":[
// {
// "taxType":"T1",
// "amount":74.17
// }
// ],
// "extraDiscountAmount":0,
// "totalItemsDiscountAmount":0,
// "totalAmount":603.97,
// }
//
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
li_Success = loo_Json.LoadFile("qa_data/itida/sdk.invoicing.eta.gov.eg/files/one-doc.json")
if li_Success = 0 then
Write-Debug loo_Json.LastErrorText
destroy loo_Scmd
destroy loo_Cert
destroy loo_Crypt
destroy loo_CmsOptions
destroy loo_JsonSigningAttrs
destroy loo_Json
return
end if
loo_Json.EmitCompact = 0
// Create the CAdES-BES signature.
loo_Crypt.EncodingMode = "base64"
// Make sure we sign the utf-8 byte representation of the JSON string
loo_Crypt.Charset = "utf-8"
ls_SigBase64 = loo_Crypt.SignStringENC(loo_Json.Emit())
if loo_Crypt.LastMethodSuccess = 0 then
Write-Debug loo_Crypt.LastErrorText
destroy loo_Scmd
destroy loo_Cert
destroy loo_Crypt
destroy loo_CmsOptions
destroy loo_JsonSigningAttrs
destroy loo_Json
return
end if
Write-Debug "Base64 signature:"
Write-Debug ls_SigBase64
// Add the signature to the JSON.
loo_Json.UpdateString("signatures[0].signatureType","I")
loo_Json.UpdateString("signatures[0].value",ls_SigBase64)
Write-Debug "JSON with signature added:"
Write-Debug loo_Json.Emit()
// ------------------------------------------------------------------------------------------------------------
// 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_Crypt
destroy loo_CmsOptions
destroy loo_JsonSigningAttrs
destroy loo_Json