(Unicode C) 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 C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkScMinidriverW.h>
#include <C_CkCertW.h>
#include <C_CkCrypt2W.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkScMinidriverW scmd;
    const wchar_t *readerName;
    BOOL success;
    int retval;
    const wchar_t *certPart;
    const wchar_t *partValue;
    HCkCertW cert;
    HCkCrypt2W crypt;
    HCkJsonObjectW cmsOptions;
    HCkJsonObjectW jsonSigningAttrs;
    HCkJsonObjectW json;
    const wchar_t *sigBase64;

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

    scmd = CkScMinidriverW_Create();

    // Reader names (smart card readers or USB tokens) can be discovered
    // via List Readers or Find Smart Cards
    readerName = L"FS USB Token 0";
    success = CkScMinidriverW_AcquireContext(scmd,readerName);
    if (success == FALSE) {
        wprintf(L"%s\n",CkScMinidriverW_lastErrorText(scmd));
        CkScMinidriverW_Dispose(scmd);
        return;
    }

    // If successful, the name of the currently inserted smart card is available:
    wprintf(L"Card name: %s\n",CkScMinidriverW_cardName(scmd));

    // If desired, perform regular PIN authentication with the smartcard.
    // For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
    retval = CkScMinidriverW_PinAuthenticate(scmd,L"user",L"12345678");
    if (retval != 0) {
        wprintf(L"PIN Authentication failed.\n");
    }

    // 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
    certPart = L"subjectCN";
    partValue = L"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
    cert = CkCertW_Create();
    success = CkScMinidriverW_FindCert(scmd,certPart,partValue,cert);
    if (success == FALSE) {
        wprintf(L"Failed to find the certificate.\n");
        CkScMinidriverW_DeleteContext(scmd);
        CkScMinidriverW_Dispose(scmd);
        CkCertW_Dispose(cert);
        return;
    }

    wprintf(L"Successfully loaded the cert object from the smart card / USB token.\n");

    // 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..
    crypt = CkCrypt2W_Create();

    // Tell the crypt class to use the cert on the ePass2003 token.
    success = CkCrypt2W_SetSigningCert(crypt,cert);
    if (success != TRUE) {
        wprintf(L"%s\n",CkCrypt2W_lastErrorText(crypt));
        CkScMinidriverW_Dispose(scmd);
        CkCertW_Dispose(cert);
        CkCrypt2W_Dispose(crypt);
        return;
    }

    cmsOptions = CkJsonObjectW_Create();
    // Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
    CkJsonObjectW_UpdateBool(cmsOptions,L"DigestData",TRUE);
    CkJsonObjectW_UpdateBool(cmsOptions,L"OmitAlgorithmIdNull",TRUE);

    // Indicate that we are passing normal JSON and we want Chilkat do automatically
    // do the ITIDA JSON canonicalization:
    CkJsonObjectW_UpdateBool(cmsOptions,L"CanonicalizeITIDA",TRUE);

    CkCrypt2W_putCmsOptions(crypt,CkJsonObjectW_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. 
    CkCrypt2W_putCadesEnabled(crypt,TRUE);

    CkCrypt2W_putHashAlgorithm(crypt,L"sha256");

    jsonSigningAttrs = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateInt(jsonSigningAttrs,L"contentType",1);
    CkJsonObjectW_UpdateInt(jsonSigningAttrs,L"signingTime",1);
    CkJsonObjectW_UpdateInt(jsonSigningAttrs,L"messageDigest",1);
    CkJsonObjectW_UpdateInt(jsonSigningAttrs,L"signingCertificateV2",1);
    CkCrypt2W_putSigningAttributes(crypt,CkJsonObjectW_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:
    CkCrypt2W_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 = CkJsonObjectW_Create();
    success = CkJsonObjectW_LoadFile(json,L"qa_data/itida/sdk.invoicing.eta.gov.eg/files/one-doc.json");
    if (success == FALSE) {
        wprintf(L"%s\n",CkJsonObjectW_lastErrorText(json));
        CkScMinidriverW_Dispose(scmd);
        CkCertW_Dispose(cert);
        CkCrypt2W_Dispose(crypt);
        CkJsonObjectW_Dispose(cmsOptions);
        CkJsonObjectW_Dispose(jsonSigningAttrs);
        CkJsonObjectW_Dispose(json);
        return;
    }

    CkJsonObjectW_putEmitCompact(json,FALSE);

    // Create the CAdES-BES signature.
    CkCrypt2W_putEncodingMode(crypt,L"base64");

    // Make sure we sign the utf-8 byte representation of the JSON string
    CkCrypt2W_putCharset(crypt,L"utf-8");

    sigBase64 = CkCrypt2W_signStringENC(crypt,CkJsonObjectW_emit(json));
    if (CkCrypt2W_getLastMethodSuccess(crypt) == FALSE) {
        wprintf(L"%s\n",CkCrypt2W_lastErrorText(crypt));
        CkScMinidriverW_Dispose(scmd);
        CkCertW_Dispose(cert);
        CkCrypt2W_Dispose(crypt);
        CkJsonObjectW_Dispose(cmsOptions);
        CkJsonObjectW_Dispose(jsonSigningAttrs);
        CkJsonObjectW_Dispose(json);
        return;
    }

    wprintf(L"Base64 signature:\n");
    wprintf(L"%s\n",sigBase64);

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

    wprintf(L"JSON with signature added:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(json));

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

    // When finished with operations that required authentication, you may if you wish, deauthenticate the session.
    success = CkScMinidriverW_PinDeauthenticate(scmd,L"user");
    if (success == FALSE) {
        wprintf(L"%s\n",CkScMinidriverW_lastErrorText(scmd));
    }

    // Delete the context when finished with the card.
    success = CkScMinidriverW_DeleteContext(scmd);
    if (success == FALSE) {
        wprintf(L"%s\n",CkScMinidriverW_lastErrorText(scmd));
    }



    CkScMinidriverW_Dispose(scmd);
    CkCertW_Dispose(cert);
    CkCrypt2W_Dispose(crypt);
    CkJsonObjectW_Dispose(cmsOptions);
    CkJsonObjectW_Dispose(jsonSigningAttrs);
    CkJsonObjectW_Dispose(json);

    }