PureBasic
PureBasic
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 PureBasic Downloads
IncludeFile "CkCert.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkScMinidriver.pb"
IncludeFile "CkCrypt2.pb"
Procedure ChilkatExample()
success.i = 0
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
scmd.i = CkScMinidriver::ckCreate()
If scmd.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Reader names (smart card readers or USB tokens) can be discovered
; via List Readers or Find Smart Cards
readerName.s = "FS USB Token 0"
success = CkScMinidriver::ckAcquireContext(scmd,readerName)
If success = 0
Debug CkScMinidriver::ckLastErrorText(scmd)
CkScMinidriver::ckDispose(scmd)
ProcedureReturn
EndIf
; If successful, the name of the currently inserted smart card is available:
Debug "Card name: " + CkScMinidriver::ckCardName(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.i = CkScMinidriver::ckPinAuthenticate(scmd,"user","12345678")
If retval <> 0
Debug "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
certPart.s = "subjectCN"
partValue.s = "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.i = CkCert::ckCreate()
If cert.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkScMinidriver::ckFindCert(scmd,certPart,partValue,cert)
If success = 0
Debug "Failed to find the certificate."
CkScMinidriver::ckDeleteContext(scmd)
CkScMinidriver::ckDispose(scmd)
CkCert::ckDispose(cert)
ProcedureReturn
EndIf
Debug "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..
crypt.i = CkCrypt2::ckCreate()
If crypt.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Tell the crypt class to use the cert on the ePass2003 token.
success = CkCrypt2::ckSetSigningCert(crypt,cert)
If success <> 1
Debug CkCrypt2::ckLastErrorText(crypt)
CkScMinidriver::ckDispose(scmd)
CkCert::ckDispose(cert)
CkCrypt2::ckDispose(crypt)
ProcedureReturn
EndIf
cmsOptions.i = CkJsonObject::ckCreate()
If cmsOptions.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
CkJsonObject::ckUpdateBool(cmsOptions,"DigestData",1)
CkJsonObject::ckUpdateBool(cmsOptions,"OmitAlgorithmIdNull",1)
; Indicate that we are passing normal JSON and we want Chilkat do automatically
; do the ITIDA JSON canonicalization:
CkJsonObject::ckUpdateBool(cmsOptions,"CanonicalizeITIDA",1)
CkCrypt2::setCkCmsOptions(crypt, CkJsonObject::ckEmit(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::setCkCadesEnabled(crypt, 1)
CkCrypt2::setCkHashAlgorithm(crypt, "sha256")
jsonSigningAttrs.i = CkJsonObject::ckCreate()
If jsonSigningAttrs.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateInt(jsonSigningAttrs,"contentType",1)
CkJsonObject::ckUpdateInt(jsonSigningAttrs,"signingTime",1)
CkJsonObject::ckUpdateInt(jsonSigningAttrs,"messageDigest",1)
CkJsonObject::ckUpdateInt(jsonSigningAttrs,"signingCertificateV2",1)
CkCrypt2::setCkSigningAttributes(crypt, CkJsonObject::ckEmit(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::setCkIncludeCertChain(crypt, 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,
; }
;
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkJsonObject::ckLoadFile(json,"qa_data/itida/sdk.invoicing.eta.gov.eg/files/one-doc.json")
If success = 0
Debug CkJsonObject::ckLastErrorText(json)
CkScMinidriver::ckDispose(scmd)
CkCert::ckDispose(cert)
CkCrypt2::ckDispose(crypt)
CkJsonObject::ckDispose(cmsOptions)
CkJsonObject::ckDispose(jsonSigningAttrs)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
; Create the CAdES-BES signature.
CkCrypt2::setCkEncodingMode(crypt, "base64")
; Make sure we sign the utf-8 byte representation of the JSON string
CkCrypt2::setCkCharset(crypt, "utf-8")
sigBase64.s = CkCrypt2::ckSignStringENC(crypt,CkJsonObject::ckEmit(json))
If CkCrypt2::ckLastMethodSuccess(crypt) = 0
Debug CkCrypt2::ckLastErrorText(crypt)
CkScMinidriver::ckDispose(scmd)
CkCert::ckDispose(cert)
CkCrypt2::ckDispose(crypt)
CkJsonObject::ckDispose(cmsOptions)
CkJsonObject::ckDispose(jsonSigningAttrs)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug "Base64 signature:"
Debug sigBase64
; Add the signature to the JSON.
CkJsonObject::ckUpdateString(json,"signatures[0].signatureType","I")
CkJsonObject::ckUpdateString(json,"signatures[0].value",sigBase64)
Debug "JSON with signature added:"
Debug CkJsonObject::ckEmit(json)
; ------------------------------------------------------------------------------------------------------------
; Cleanup our ScMinidriver session...
; When finished with operations that required authentication, you may if you wish, deauthenticate the session.
success = CkScMinidriver::ckPinDeauthenticate(scmd,"user")
If success = 0
Debug CkScMinidriver::ckLastErrorText(scmd)
EndIf
; Delete the context when finished with the card.
success = CkScMinidriver::ckDeleteContext(scmd)
If success = 0
Debug CkScMinidriver::ckLastErrorText(scmd)
EndIf
CkScMinidriver::ckDispose(scmd)
CkCert::ckDispose(cert)
CkCrypt2::ckDispose(crypt)
CkJsonObject::ckDispose(cmsOptions)
CkJsonObject::ckDispose(jsonSigningAttrs)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure