Swift
Swift
Create ITIDA Signed JSON and Send to ETA (Egypt Tax Authority) Portal
See more Egypt ITIDA Examples
Demonstrates how to create a .p7s signature that fits Egypt's ITIDA requirements where Chilkat automatically does the ITIDA JSON canonicalization. Also shows the code to send to the ETA Portal.Chilkat Swift Downloads
func chilkatTest() {
var success: Bool = false
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let crypt = CkoCrypt2()!
crypt.verboseLogging = true
let cert = CkoCert()!
cert.verboseLogging = true
// Set the smart card PIN, which will be needed for signing.
cert.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.load(fromSmartcard: "")
if success == false {
print("\(cert.lastErrorText!)")
return
}
// Tell the crypt class to use this cert.
success = crypt.setSigningCert(cert: cert)
if success == false {
print("\(crypt.lastErrorText!)")
return
}
let cmsOptions = CkoJsonObject()!
// Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
cmsOptions.updateBool(jsonPath: "DigestData", value: true)
cmsOptions.updateBool(jsonPath: "OmitAlgorithmIdNull", value: true)
// Indicate that we are passing normal JSON and we want Chilkat do automatically
// do the ITIDA JSON canonicalization:
cmsOptions.updateBool(jsonPath: "CanonicalizeITIDA", value: true)
crypt.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.cadesEnabled = true
crypt.hashAlgorithm = "sha256"
let jsonSigningAttrs = CkoJsonObject()!
jsonSigningAttrs.updateInt(jsonPath: "contentType", value: 1)
jsonSigningAttrs.updateInt(jsonPath: "signingTime", value: 1)
jsonSigningAttrs.updateInt(jsonPath: "messageDigest", value: 1)
jsonSigningAttrs.updateInt(jsonPath: "signingCertificateV2", value: 1)
crypt.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.includeCertChain = 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,
// }
// Build the above JSON..
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON
let json = CkoJsonObject()!
json.updateString(jsonPath: "issuer.address.branchID", value: "0")
json.updateString(jsonPath: "issuer.address.country", value: "EG")
json.updateString(jsonPath: "issuer.address.regionCity", value: "Cairo")
json.updateString(jsonPath: "issuer.address.postalCode", value: "")
json.updateString(jsonPath: "issuer.address.buildingNumber", value: "0")
json.updateString(jsonPath: "issuer.address.street", value: "123rd Street")
json.updateString(jsonPath: "issuer.address.governate", value: "GOVERNATE")
json.updateString(jsonPath: "issuer.type", value: "B")
json.updateString(jsonPath: "issuer.id", value: "209999899")
json.updateString(jsonPath: "issuer.name", value: "Xyz SAE")
json.updateString(jsonPath: "receiver.address.country", value: "EG")
json.updateString(jsonPath: "receiver.address.regionCity", value: "CAIRO")
json.updateString(jsonPath: "receiver.address.postalCode", value: "11435")
json.updateString(jsonPath: "receiver.address.buildingNumber", value: "0")
json.updateString(jsonPath: "receiver.address.street", value: "Autostrad Road Abc")
json.updateString(jsonPath: "receiver.address.governate", value: "GOVERNATE")
json.updateString(jsonPath: "receiver.type", value: "B")
json.updateString(jsonPath: "receiver.id", value: "999999999")
json.updateString(jsonPath: "receiver.name", value: "XYZ EGYPT FOR TRADE")
json.updateString(jsonPath: "documentType", value: "I")
json.updateString(jsonPath: "documentTypeVersion", value: "1.0")
json.updateString(jsonPath: "dateTimeIssued", value: "2020-11-15T11:04:53Z")
json.updateString(jsonPath: "taxpayerActivityCode", value: "1073")
json.updateString(jsonPath: "internalID", value: "ZZZZ999")
json.updateString(jsonPath: "purchaseOrderReference", value: "2009199918")
json.updateString(jsonPath: "salesOrderReference", value: "")
json.updateString(jsonPath: "payment.bankName", value: "")
json.updateString(jsonPath: "payment.bankAddress", value: "")
json.updateString(jsonPath: "payment.bankAccountNo", value: "")
json.updateString(jsonPath: "payment.bankAccountIBAN", value: "")
json.updateString(jsonPath: "payment.swiftCode", value: "")
json.updateString(jsonPath: "payment.terms", value: "")
json.updateString(jsonPath: "delivery.approach", value: "")
json.updateString(jsonPath: "delivery.packaging", value: "")
json.updateString(jsonPath: "delivery.dateValidity", value: "")
json.updateString(jsonPath: "delivery.exportPort", value: "")
json.updateString(jsonPath: "delivery.countryOfOrigin", value: "EG")
json.updateInt(jsonPath: "delivery.grossWeight", value: 0)
json.updateInt(jsonPath: "delivery.netWeight", value: 0)
json.updateString(jsonPath: "delivery.terms", value: "")
json.updateString(jsonPath: "invoiceLines[0].description", value: "CDM Widget 48GX99X12BA")
json.updateString(jsonPath: "invoiceLines[0].itemType", value: "GS1")
json.updateString(jsonPath: "invoiceLines[0].itemCode", value: "7622213335056")
json.updateString(jsonPath: "invoiceLines[0].unitType", value: "CS")
json.updateNumber(jsonPath: "invoiceLines[0].quantity", numericStr: "1.00")
json.updateString(jsonPath: "invoiceLines[0].unitValue.currencySold", value: "EGP")
json.updateNumber(jsonPath: "invoiceLines[0].unitValue.amountEGP", numericStr: "588.67")
json.updateInt(jsonPath: "invoiceLines[0].unitValue.amountSold", value: 0)
json.updateInt(jsonPath: "invoiceLines[0].unitValue.currencyExchangeRate", value: 0)
json.updateNumber(jsonPath: "invoiceLines[0].salesTotal", numericStr: "588.67")
json.updateNumber(jsonPath: "invoiceLines[0].total", numericStr: "603.97")
json.updateInt(jsonPath: "invoiceLines[0].valueDifference", value: 0)
json.updateInt(jsonPath: "invoiceLines[0].totalTaxableFees", value: 0)
json.updateNumber(jsonPath: "invoiceLines[0].netTotal", numericStr: "529.8")
json.updateInt(jsonPath: "invoiceLines[0].itemsDiscount", value: 0)
json.updateNumber(jsonPath: "invoiceLines[0].discount.rate", numericStr: "10.00")
json.updateNumber(jsonPath: "invoiceLines[0].discount.amount", numericStr: "58.87")
json.updateString(jsonPath: "invoiceLines[0].taxableItems[0].taxType", value: "T1")
json.updateNumber(jsonPath: "invoiceLines[0].taxableItems[0].amount", numericStr: "74.17")
json.updateString(jsonPath: "invoiceLines[0].taxableItems[0].subType", value: "No sub")
json.updateNumber(jsonPath: "invoiceLines[0].taxableItems[0].rate", numericStr: "14.00")
json.updateString(jsonPath: "invoiceLines[0].internalCode", value: "9099994")
json.updateNumber(jsonPath: "totalSales", numericStr: "588.67")
json.updateNumber(jsonPath: "totalSalesAmount", numericStr: "588.67")
json.updateNumber(jsonPath: "totalDiscountAmount", numericStr: "58.87")
json.updateNumber(jsonPath: "netAmount", numericStr: "529.80")
json.updateString(jsonPath: "taxTotals[0].taxType", value: "T1")
json.updateNumber(jsonPath: "taxTotals[0].amount", numericStr: "74.17")
json.updateInt(jsonPath: "extraDiscountAmount", value: 0)
json.updateInt(jsonPath: "totalItemsDiscountAmount", value: 0)
json.updateNumber(jsonPath: "totalAmount", numericStr: "603.97")
json.emitCompact = true
var jsonToSign: String? = json.emit()
// Create the CAdES-BES signature.
crypt.encodingMode = "base64"
// Make sure we sign the utf-8 byte representation of the JSON string
crypt.charset = "utf-8"
var sigBase64: String? = crypt.signStringENC(str: jsonToSign)
if crypt.lastMethodSuccess == false {
print("\(crypt.lastErrorText!)")
return
}
print("Base64 signature:")
print("\(sigBase64!)")
// Insert the base64 signature into the JSON to be sent
json.updateString(jsonPath: "signatures[0].signatureType", value: "I")
json.updateString(jsonPath: "signatures[0].value", value: sigBase64)
// Wrap the JSON in {"documents":[ ... ]}
let sbToSend = CkoStringBuilder()!
sbToSend.append(value: "{\"documents\":[")
sbToSend.append(value: json.emit())
sbToSend.append(value: "]}")
// ------------------------------------------------------------------------
// Get an access token using our client ID and client secret key
var clientId: String? = "abc999ff-1234"
var clientSecretKey: String? = "123fff22-1234-abcd"
let http = CkoHttp()!
// Causes the Authorization: Basic header to be added..
http.login = clientId
http.password = clientSecretKey
http.basicAuth = true
let req = CkoHttpRequest()!
req.httpVerb = "POST"
req.path = "/connect/token"
req.contentType = "application/x-www-form-urlencoded"
req.addParam(name: "grant_type", value: "client_credentials")
req.addHeader(name: "Connection", value: "close")
http.accept = "application/json"
let resp = CkoHttpResponse()!
success = http.httpReq(url: "https://id.preprod.eta.gov.eg/connect/token", request: req, response: resp)
if success == false {
print("\(http.lastErrorText!)")
return
}
http.closeAllConnections()
print("Response status code: \(resp.statusCode.intValue)")
print("Response body:")
print("\(resp.bodyStr!)")
if resp.statusCode.intValue != 200 {
print("Failed.")
return
}
let jsonToken = CkoJsonObject()!
success = jsonToken.load(json: resp.bodyStr)
var accessToken: String? = jsonToken.string(of: "access_token")
print("access_token = \(accessToken!)")
// ------------------------------------------------------------------------
// Submit the signed JSON to the ETA (Egypt Tax Authority) Portal
// No longer sending basic authentication...
http.login = ""
http.password = ""
http.basicAuth = false
// Setting the AuthToken property causes the "Authorization: Bearer <token>" header to be added to each request.
http.authToken = accessToken
var jsonStr: String? = sbToSend.getAsString()
var url: String? = "https://api.preprod.invoicing.eta.gov.eg/api/v1/documentsubmissions"
success = http.httpStr(verb: "POST", url: url, bodyStr: jsonStr, charset: "utf-8", contentType: "application/json; charset=utf-8", response: resp)
if success == false {
print("\(http.lastErrorText!)")
return
}
print("Response status code: \(resp.statusCode.intValue)")
print("Response body:")
print("\(resp.bodyStr!)")
}