(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set scmd [new_CkScMinidriver]

# Reader names (smart card readers or USB tokens) can be discovered
# via List Readers or Find Smart Cards
set readerName "FS USB Token 0"
set success [CkScMinidriver_AcquireContext $scmd $readerName]
if {$success == 0} then {
    puts [CkScMinidriver_lastErrorText $scmd]
    delete_CkScMinidriver $scmd
    exit
}

# If successful, the name of the currently inserted smart card is available:
puts "Card name: [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
set retval [CkScMinidriver_PinAuthenticate $scmd "user" "12345678"]
if {$retval != 0} then {
    puts "PIN Authentication failed."
}

# 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
set certPart "subjectCN"
set 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
set cert [new_CkCert]

set success [CkScMinidriver_FindCert $scmd $certPart $partValue $cert]
if {$success == 0} then {
    puts "Failed to find the certificate."
    CkScMinidriver_DeleteContext $scmd
    delete_CkScMinidriver $scmd
    delete_CkCert $cert
    exit
}

puts "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..
set crypt [new_CkCrypt2]

# Tell the crypt class to use the cert on the ePass2003 token.
set success [CkCrypt2_SetSigningCert $crypt $cert]
if {$success != 1} then {
    puts [CkCrypt2_lastErrorText $crypt]
    delete_CkScMinidriver $scmd
    delete_CkCert $cert
    delete_CkCrypt2 $crypt
    exit
}

set cmsOptions [new_CkJsonObject]

# Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
CkJsonObject_UpdateBool $cmsOptions "DigestData" 1
CkJsonObject_UpdateBool $cmsOptions "OmitAlgorithmIdNull" 1

# Indicate that we are passing normal JSON and we want Chilkat do automatically
# do the ITIDA JSON canonicalization:
CkJsonObject_UpdateBool $cmsOptions "CanonicalizeITIDA" 1

CkCrypt2_put_CmsOptions $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_put_CadesEnabled $crypt 1

CkCrypt2_put_HashAlgorithm $crypt "sha256"

set jsonSigningAttrs [new_CkJsonObject]

CkJsonObject_UpdateInt $jsonSigningAttrs "contentType" 1
CkJsonObject_UpdateInt $jsonSigningAttrs "signingTime" 1
CkJsonObject_UpdateInt $jsonSigningAttrs "messageDigest" 1
CkJsonObject_UpdateInt $jsonSigningAttrs "signingCertificateV2" 1
CkCrypt2_put_SigningAttributes $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_put_IncludeCertChain $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,
#       }
# 

set json [new_CkJsonObject]

set success [CkJsonObject_LoadFile $json "qa_data/itida/sdk.invoicing.eta.gov.eg/files/one-doc.json"]
if {$success == 0} then {
    puts [CkJsonObject_lastErrorText $json]
    delete_CkScMinidriver $scmd
    delete_CkCert $cert
    delete_CkCrypt2 $crypt
    delete_CkJsonObject $cmsOptions
    delete_CkJsonObject $jsonSigningAttrs
    delete_CkJsonObject $json
    exit
}

CkJsonObject_put_EmitCompact $json 0

# Create the CAdES-BES signature.
CkCrypt2_put_EncodingMode $crypt "base64"

# Make sure we sign the utf-8 byte representation of the JSON string
CkCrypt2_put_Charset $crypt "utf-8"

set sigBase64 [CkCrypt2_signStringENC $crypt [CkJsonObject_emit $json]]
if {[CkCrypt2_get_LastMethodSuccess $crypt] == 0} then {
    puts [CkCrypt2_lastErrorText $crypt]
    delete_CkScMinidriver $scmd
    delete_CkCert $cert
    delete_CkCrypt2 $crypt
    delete_CkJsonObject $cmsOptions
    delete_CkJsonObject $jsonSigningAttrs
    delete_CkJsonObject $json
    exit
}

puts "Base64 signature:"
puts "$sigBase64"

# Add the signature to the JSON.
CkJsonObject_UpdateString $json "signatures[0].signatureType" "I"
CkJsonObject_UpdateString $json "signatures[0].value" $sigBase64

puts "JSON with signature added:"
puts [CkJsonObject_emit $json]

# ------------------------------------------------------------------------------------------------------------
# Cleanup our ScMinidriver session...

# When finished with operations that required authentication, you may if you wish, deauthenticate the session.
set success [CkScMinidriver_PinDeauthenticate $scmd "user"]
if {$success == 0} then {
    puts [CkScMinidriver_lastErrorText $scmd]
}

# Delete the context when finished with the card.
set success [CkScMinidriver_DeleteContext $scmd]
if {$success == 0} then {
    puts [CkScMinidriver_lastErrorText $scmd]
}


delete_CkScMinidriver $scmd
delete_CkCert $cert
delete_CkCrypt2 $crypt
delete_CkJsonObject $cmsOptions
delete_CkJsonObject $jsonSigningAttrs
delete_CkJsonObject $json