(Visual FoxPro) Create Egypt ITIDA CAdES-BES Signature with Automatic JSON Canonicalization

See more Egypt ITIDA Examples

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.75 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loCrypt
LOCAL loCert
LOCAL lnSuccess
LOCAL loCmsOptions
LOCAL loJsonSigningAttrs
LOCAL loJson
LOCAL lcSigBase64

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Crypt2')
loCrypt = CreateObject('Chilkat.Crypt2')
loCrypt.VerboseLogging = 1

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Cert')
loCert = CreateObject('Chilkat.Cert')
loCert.VerboseLogging = 1

* Set the smart card PIN, which will be needed for signing.
loCert.SmartCardPin = "12345678"

* There are many ways to load the certificate.  
* This example was created for a customer using an ePass2003 USB token.
* Assuming the USB token is the only source of a hardware-based private key..
lnSuccess = loCert.LoadFromSmartcard("")
IF (lnSuccess <> 1) THEN
    ? loCert.LastErrorText
    RELEASE loCrypt
    RELEASE loCert
    CANCEL
ENDIF

* Tell the crypt class to use this cert.
lnSuccess = loCrypt.SetSigningCert(loCert)
IF (lnSuccess <> 1) THEN
    ? loCrypt.LastErrorText
    RELEASE loCrypt
    RELEASE loCert
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loCmsOptions = CreateObject('Chilkat.JsonObject')
* Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
loCmsOptions.UpdateBool("DigestData",1)
loCmsOptions.UpdateBool("OmitAlgorithmIdNull",1)

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

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 = 1

loCrypt.HashAlgorithm = "sha256"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonSigningAttrs = CreateObject('Chilkat.JsonObject')
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 = 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,
*       }
* 

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
lnSuccess = loJson.LoadFile("qa_data/itida/sdk.invoicing.eta.gov.eg/files/one-doc.json")
IF (lnSuccess = 0) THEN
    ? loJson.LastErrorText
    RELEASE loCrypt
    RELEASE loCert
    RELEASE loCmsOptions
    RELEASE loJsonSigningAttrs
    RELEASE loJson
    CANCEL
ENDIF

loJson.EmitCompact = 0

* 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(loJson.Emit())
IF (loCrypt.LastMethodSuccess = 0) THEN
    ? loCrypt.LastErrorText
    RELEASE loCrypt
    RELEASE loCert
    RELEASE loCmsOptions
    RELEASE loJsonSigningAttrs
    RELEASE loJson
    CANCEL
ENDIF

? "Base64 signature:"
? lcSigBase64

* Add the signature to the JSON.
loJson.UpdateString("signatures[0].signatureType","I")
loJson.UpdateString("signatures[0].value",lcSigBase64)

? "JSON with signature added:"
? loJson.Emit()

RELEASE loCrypt
RELEASE loCert
RELEASE loCmsOptions
RELEASE loJsonSigningAttrs
RELEASE loJson