(Ruby) ITIDA Debug Signed JSON and HTTP POST

See more Egypt ITIDA Examples

Explains how to debug when problems are encountered with ITIDA canonicalization, signing, and posting to api.preprod.invoicing.eta.gov.eg.

The most common error response from the api.preprod.invoicing.eta.gov.eg server is:

ITIDA Signature Invalid Signature * 4043 4043:message-digest attribute value does not match the calculated value[message-digest attribute value does not match the calculated value]

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

crypt = Chilkat::CkCrypt2.new()
crypt.put_VerboseLogging(true)

cert = Chilkat::CkCert.new()
cert.put_VerboseLogging(true)

# Set the smart card PIN, which will be needed for signing.
cert.put_SmartCardPin("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 = cert.LoadFromSmartcard("")
if (success != true)
    print cert.lastErrorText() + "\n";
    exit
end

# Tell the crypt class to use this cert.
success = crypt.SetSigningCert(cert)
if (success != true)
    print crypt.lastErrorText() + "\n";
    exit
end

cmsOptions = Chilkat::CkJsonObject.new()
# Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
cmsOptions.UpdateBool("DigestData",true)
cmsOptions.UpdateBool("OmitAlgorithmIdNull",true)

# Indicate that we are passing normal JSON and we want Chilkat do automatically
# do the ITIDA JSON canonicalization:
cmsOptions.UpdateBool("CanonicalizeITIDA",true)

crypt.put_CmsOptions(cmsOptions.emit())

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

crypt.put_HashAlgorithm("sha256")

jsonSigningAttrs = Chilkat::CkJsonObject.new()
jsonSigningAttrs.UpdateInt("contentType",1)
jsonSigningAttrs.UpdateInt("signingTime",1)
jsonSigningAttrs.UpdateInt("messageDigest",1)
jsonSigningAttrs.UpdateInt("signingCertificateV2",1)
crypt.put_SigningAttributes(jsonSigningAttrs.emit())

# 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:
crypt.put_IncludeCertChain(false)

# First, load the JSON file that is to be canonicalized and signed.
# The JSON file should look like this:
# NOTE: The JSON should not begin with "{ "documents" : [ ..."
# We want to send a single signed document like this:

#       {
#          "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,
#       }
# 

# Please include this JSON file as an attachment in your support email to Chilkat.
json = Chilkat::CkJsonObject.new()
success = json.LoadFile("c:/someDir/jsonToSignAndSend.json")
if (success == false)
    print "Failed to load input JSON file." + "\n";
    exit
end

json.put_EmitCompact(true)
jsonToSign = json.emit()

# Create the CAdES-BES signature.
crypt.put_EncodingMode("base64")

# Make sure we sign the utf-8 byte representation of the JSON string
crypt.put_Charset("utf-8")

# Turn on verbose logging.
crypt.put_VerboseLogging(true)

sigBase64 = crypt.signStringENC(jsonToSign)
if (crypt.get_LastMethodSuccess() == false)
    print crypt.lastErrorText() + "\n";
    exit
end

# The LastErrorText property still contains information when the method succeeds.
# Send the contents of this LastErrorText as an attachment in your support email to Chilkat.
print crypt.lastErrorText() + "\n";

# Insert the base64 signature into the JSON to be sent
json.UpdateString("signatures[0].signatureType","I")
json.UpdateString("signatures[0].value",sigBase64)

# Wrap the JSON in  {"documents":[ ... ]}
sbToSend = Chilkat::CkStringBuilder.new()
sbToSend.Append("{\"documents\":[")
sbToSend.Append(json.emit())
sbToSend.Append("]}")

# ------------------------------------------------------------------------
# Submit the signed JSON to Chilkat's URL for simply echoing back the contents of the HTTP POST it receives:
# 
# We just want to see what actually gets sent.  To do this, we can send to https://www.chilkatsoft.com/echoPostBody.asp
# which will echo in the response that data and headers it received.

http = Chilkat::CkHttp.new()

# Also, set the SessionLogFilename property so we can see the exact bytes of the HTTP request sent from your end.
# Please include this session log file as an attachment in your support email to Chilkat.
http.put_SessionLogFilename("c:/someDir/sessionLog.txt")

# resp is a CkHttpResponse
resp = http.PostJson2("https://www.chilkatsoft.com/echoPostBody.asp","application/json; charset=utf-8",sbToSend.getAsString())
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

# Save the exact contents of Chilkat's response to a file.
# The server at https://www.chilkatsoft.com/echoPostBody.asp is simply echoing back the headers and POST body it received.
# Please include the responseBody.txt as an attachment in your support email to Chilkat.
success = resp.SaveBodyBinary("c:/someDir/responseBody.txt")

print "Response status code: " + resp.get_StatusCode().to_s() + "\n";

# -------------------------------------------------
# In summary, please include the following in your support email to Chilkat
# 1. The original JSON file before signing and before canonicalization (i.e. c:/someDir/jsonToSignAndSend.json)
# 2. The contents of the LastErrorText for the successful call to SignStringENC.
# 3. The HTTP session log file (i.e. c:/someDir/sessionLog.txt)
# 4. The responseBody.txt file.