C
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 Downloads
#include <C_CkScMinidriver.h>
#include <C_CkCert.h>
#include <C_CkCrypt2.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
BOOL success;
HCkScMinidriver scmd;
const char *readerName;
int retval;
const char *certPart;
const char *partValue;
HCkCert cert;
HCkCrypt2 crypt;
HCkJsonObject cmsOptions;
HCkJsonObject jsonSigningAttrs;
HCkJsonObject json;
const char *sigBase64;
success = FALSE;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
scmd = CkScMinidriver_Create();
// Reader names (smart card readers or USB tokens) can be discovered
// via List Readers or Find Smart Cards
readerName = "FS USB Token 0";
success = CkScMinidriver_AcquireContext(scmd,readerName);
if (success == FALSE) {
printf("%s\n",CkScMinidriver_lastErrorText(scmd));
CkScMinidriver_Dispose(scmd);
return;
}
// If successful, the name of the currently inserted smart card is available:
printf("Card name: %s\n",CkScMinidriver_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 = CkScMinidriver_PinAuthenticate(scmd,"user","12345678");
if (retval != 0) {
printf("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 = "subjectCN";
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
cert = CkCert_Create();
success = CkScMinidriver_FindCert(scmd,certPart,partValue,cert);
if (success == FALSE) {
printf("Failed to find the certificate.\n");
CkScMinidriver_DeleteContext(scmd);
CkScMinidriver_Dispose(scmd);
CkCert_Dispose(cert);
return;
}
printf("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 = CkCrypt2_Create();
// Tell the crypt class to use the cert on the ePass2003 token.
success = CkCrypt2_SetSigningCert(crypt,cert);
if (success != TRUE) {
printf("%s\n",CkCrypt2_lastErrorText(crypt));
CkScMinidriver_Dispose(scmd);
CkCert_Dispose(cert);
CkCrypt2_Dispose(crypt);
return;
}
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) {
printf("%s\n",CkJsonObject_lastErrorText(json));
CkScMinidriver_Dispose(scmd);
CkCert_Dispose(cert);
CkCrypt2_Dispose(crypt);
CkJsonObject_Dispose(cmsOptions);
CkJsonObject_Dispose(jsonSigningAttrs);
CkJsonObject_Dispose(json);
return;
}
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) {
printf("%s\n",CkCrypt2_lastErrorText(crypt));
CkScMinidriver_Dispose(scmd);
CkCert_Dispose(cert);
CkCrypt2_Dispose(crypt);
CkJsonObject_Dispose(cmsOptions);
CkJsonObject_Dispose(jsonSigningAttrs);
CkJsonObject_Dispose(json);
return;
}
printf("Base64 signature:\n");
printf("%s\n",sigBase64);
// Add the signature to the JSON.
CkJsonObject_UpdateString(json,"signatures[0].signatureType","I");
CkJsonObject_UpdateString(json,"signatures[0].value",sigBase64);
printf("JSON with signature added:\n");
printf("%s\n",CkJsonObject_emit(json));
// ------------------------------------------------------------------------------------------------------------
// Cleanup our ScMinidriver session...
// When finished with operations that required authentication, you may if you wish, deauthenticate the session.
success = CkScMinidriver_PinDeauthenticate(scmd,"user");
if (success == FALSE) {
printf("%s\n",CkScMinidriver_lastErrorText(scmd));
}
// Delete the context when finished with the card.
success = CkScMinidriver_DeleteContext(scmd);
if (success == FALSE) {
printf("%s\n",CkScMinidriver_lastErrorText(scmd));
}
CkScMinidriver_Dispose(scmd);
CkCert_Dispose(cert);
CkCrypt2_Dispose(crypt);
CkJsonObject_Dispose(cmsOptions);
CkJsonObject_Dispose(jsonSigningAttrs);
CkJsonObject_Dispose(json);
}