(Delphi DLL) 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 for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Cert, JsonObject, Crypt2;

...

procedure TForm1.Button1Click(Sender: TObject);
var
crypt: HCkCrypt2;
cert: HCkCert;
success: Boolean;
cmsOptions: HCkJsonObject;
jsonSigningAttrs: HCkJsonObject;
json: HCkJsonObject;
sigBase64: PWideChar;

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

crypt := CkCrypt2_Create();
CkCrypt2_putVerboseLogging(crypt,True);

cert := CkCert_Create();
CkCert_putVerboseLogging(cert,True);

// Set the smart card PIN, which will be needed for signing.
CkCert_putSmartCardPin(cert,'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..
success := CkCert_LoadFromSmartcard(cert,'');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkCert__lastErrorText(cert));
    Exit;
  end;

// Tell the crypt class to use this cert.
success := CkCrypt2_SetSigningCert(crypt,cert);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkCrypt2__lastErrorText(crypt));
    Exit;
  end;

cmsOptions := CkJsonObject_Create();
// Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
CkJsonObject_UpdateBool(cmsOptions,'DigestData',True);
CkJsonObject_UpdateBool(cmsOptions,'OmitAlgorithmIdNull',True);

// Indicate that we are passing normal JSON and we want Chilkat do automatically
// do the ITIDA JSON canonicalization:
CkJsonObject_UpdateBool(cmsOptions,'CanonicalizeITIDA',True);

CkCrypt2_putCmsOptions(crypt,CkJsonObject__emit(cmsOptions));

// The CadesEnabled property applies to all methods that create CMS/PKCS7 signatures. 
// To create a CAdES-BES signature, set this property equal to true. 
CkCrypt2_putCadesEnabled(crypt,True);

CkCrypt2_putHashAlgorithm(crypt,'sha256');

jsonSigningAttrs := CkJsonObject_Create();
CkJsonObject_UpdateInt(jsonSigningAttrs,'contentType',1);
CkJsonObject_UpdateInt(jsonSigningAttrs,'signingTime',1);
CkJsonObject_UpdateInt(jsonSigningAttrs,'messageDigest',1);
CkJsonObject_UpdateInt(jsonSigningAttrs,'signingCertificateV2',1);
CkCrypt2_putSigningAttributes(crypt,CkJsonObject__emit(jsonSigningAttrs));

// 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:
CkCrypt2_putIncludeCertChain(crypt,False);

// 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,
//       }
// 

json := CkJsonObject_Create();
success := CkJsonObject_LoadFile(json,'qa_data/itida/sdk.invoicing.eta.gov.eg/files/one-doc.json');
if (success = False) then
  begin
    Memo1.Lines.Add(CkJsonObject__lastErrorText(json));
    Exit;
  end;
CkJsonObject_putEmitCompact(json,False);

// Create the CAdES-BES signature.
CkCrypt2_putEncodingMode(crypt,'base64');

// Make sure we sign the utf-8 byte representation of the JSON string
CkCrypt2_putCharset(crypt,'utf-8');

sigBase64 := CkCrypt2__signStringENC(crypt,CkJsonObject__emit(json));
if (CkCrypt2_getLastMethodSuccess(crypt) = False) then
  begin
    Memo1.Lines.Add(CkCrypt2__lastErrorText(crypt));
    Exit;
  end;

Memo1.Lines.Add('Base64 signature:');
Memo1.Lines.Add(sigBase64);

// Add the signature to the JSON.
CkJsonObject_UpdateString(json,'signatures[0].signatureType','I');
CkJsonObject_UpdateString(json,'signatures[0].value',sigBase64);

Memo1.Lines.Add('JSON with signature added:');
Memo1.Lines.Add(CkJsonObject__emit(json));

CkCrypt2_Dispose(crypt);
CkCert_Dispose(cert);
CkJsonObject_Dispose(cmsOptions);
CkJsonObject_Dispose(jsonSigningAttrs);
CkJsonObject_Dispose(json);

end;