(Lianja) 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.)

Note: This example requires Chilkat v9.5.0.87 or greater.

Note: The ScMinidriver functionality is for Windows-only because ScMinidriver DLLs only exist on Windows. In the next version, Chilkat will be releasing a Pkcs11 class to support Linux, MacOSX, and possibly other operating systems.

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loScmd = createobject("CkScMinidriver")

// Reader names (smart card readers or USB tokens) can be discovered
// via List Readers or Find Smart Cards
lcReaderName = "FS USB Token 0"
llSuccess = loScmd.AcquireContext(lcReaderName)
if (llSuccess = .F.) then
    ? loScmd.LastErrorText
    release loScmd
    return
endif

// If successful, the name of the currently inserted smart card is available:
? "Card name: " + loScmd.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
lnRetval = loScmd.PinAuthenticate("user","12345678")
if (lnRetval <> 0) then
    ? "PIN Authentication failed."
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
lcCertPart = "subjectCN"
lcPartValue = "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
loCert = createobject("CkCert")
llSuccess = loScmd.FindCert(lcCertPart,lcPartValue,loCert)
if (llSuccess = .F.) then
    ? "Failed to find the certificate."
    loScmd.DeleteContext()
    release loScmd
    release loCert
    return
endif

? "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..
loCrypt = createobject("CkCrypt2")

// Tell the crypt class to use the cert on the ePass2003 token.
llSuccess = loCrypt.SetSigningCert(loCert)
if (llSuccess <> .T.) then
    ? loCrypt.LastErrorText
    release loScmd
    release loCert
    release loCrypt
    return
endif

loCmsOptions = createobject("CkJsonObject")
// Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
loCmsOptions.UpdateBool("DigestData",.T.)
loCmsOptions.UpdateBool("OmitAlgorithmIdNull",.T.)

// Indicate that we are passing normal JSON and we want Chilkat do automatically
// do the ITIDA JSON canonicalization:
loCmsOptions.UpdateBool("CanonicalizeITIDA",.T.)

loCrypt.CmsOptions = loCmsOptions.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. 
loCrypt.CadesEnabled = .T.

loCrypt.HashAlgorithm = "sha256"

loJsonSigningAttrs = createobject("CkJsonObject")
loJsonSigningAttrs.UpdateInt("contentType",1)
loJsonSigningAttrs.UpdateInt("signingTime",1)
loJsonSigningAttrs.UpdateInt("messageDigest",1)
loJsonSigningAttrs.UpdateInt("signingCertificateV2",1)
loCrypt.SigningAttributes = loJsonSigningAttrs.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:
loCrypt.IncludeCertChain = .F.

// Pass a JSON document such as the following.  Chilkat will do the ITIDA canonicalization.
// (It is the canonicalized JSON that gets signed.)

// {
//    "documents":[
//       {
//          "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,
//       }
//    ]
// }
// 

lcJsonToSign = "{ ... }"

// Create the CAdES-BES signature.
loCrypt.EncodingMode = "base64"

// Make sure we sign the utf-8 byte representation of the JSON string
loCrypt.Charset = "utf-8"

lcSigBase64 = loCrypt.SignStringENC(lcJsonToSign)
if (loCrypt.LastMethodSuccess = .F.) then
    ? loCrypt.LastErrorText
    release loScmd
    release loCert
    release loCrypt
    release loCmsOptions
    release loJsonSigningAttrs
    return
endif

? "Base64 signature:"
? lcSigBase64

// ------------------------------------------------------------------------------------------------------------
// Cleanup our ScMinidriver session...

// When finished with operations that required authentication, you may if you wish, deauthenticate the session.
llSuccess = loScmd.PinDeauthenticate("user")
if (llSuccess = .F.) then
    ? loScmd.LastErrorText
endif

// Delete the context when finished with the card.
llSuccess = loScmd.DeleteContext()
if (llSuccess = .F.) then
    ? loScmd.LastErrorText
endif



release loScmd
release loCert
release loCrypt
release loCmsOptions
release loJsonSigningAttrs