Objective-C
Objective-C
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 Objective-C Downloads
#import <CkoCrypt2.h>
#import <CkoCert.h>
#import <CkoJsonObject.h>
#import <NSString.h>
#import <CkoStringBuilder.h>
#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoHttpResponse.h>
BOOL success = NO;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoCrypt2 *crypt = [[CkoCrypt2 alloc] init];
crypt.VerboseLogging = YES;
CkoCert *cert = [[CkoCert alloc] init];
cert.VerboseLogging = YES;
// 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 LoadFromSmartcard: @""];
if (success == NO) {
NSLog(@"%@",cert.LastErrorText);
return;
}
// Tell the crypt class to use this cert.
success = [crypt SetSigningCert: cert];
if (success == NO) {
NSLog(@"%@",crypt.LastErrorText);
return;
}
CkoJsonObject *cmsOptions = [[CkoJsonObject alloc] init];
// Setting "DigestData" causes OID 1.2.840.113549.1.7.5 (digestData) to be used.
[cmsOptions UpdateBool: @"DigestData" value: YES];
[cmsOptions UpdateBool: @"OmitAlgorithmIdNull" value: YES];
// Indicate that we are passing normal JSON and we want Chilkat do automatically
// do the ITIDA JSON canonicalization:
[cmsOptions UpdateBool: @"CanonicalizeITIDA" value: YES];
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 = YES;
crypt.HashAlgorithm = @"sha256";
CkoJsonObject *jsonSigningAttrs = [[CkoJsonObject alloc] init];
[jsonSigningAttrs UpdateInt: @"contentType" value: [NSNumber numberWithInt: 1]];
[jsonSigningAttrs UpdateInt: @"signingTime" value: [NSNumber numberWithInt: 1]];
[jsonSigningAttrs UpdateInt: @"messageDigest" value: [NSNumber numberWithInt: 1]];
[jsonSigningAttrs UpdateInt: @"signingCertificateV2" value: [NSNumber numberWithInt: 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 = NO;
// 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
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"issuer.address.branchID" value: @"0"];
[json UpdateString: @"issuer.address.country" value: @"EG"];
[json UpdateString: @"issuer.address.regionCity" value: @"Cairo"];
[json UpdateString: @"issuer.address.postalCode" value: @""];
[json UpdateString: @"issuer.address.buildingNumber" value: @"0"];
[json UpdateString: @"issuer.address.street" value: @"123rd Street"];
[json UpdateString: @"issuer.address.governate" value: @"GOVERNATE"];
[json UpdateString: @"issuer.type" value: @"B"];
[json UpdateString: @"issuer.id" value: @"209999899"];
[json UpdateString: @"issuer.name" value: @"Xyz SAE"];
[json UpdateString: @"receiver.address.country" value: @"EG"];
[json UpdateString: @"receiver.address.regionCity" value: @"CAIRO"];
[json UpdateString: @"receiver.address.postalCode" value: @"11435"];
[json UpdateString: @"receiver.address.buildingNumber" value: @"0"];
[json UpdateString: @"receiver.address.street" value: @"Autostrad Road Abc"];
[json UpdateString: @"receiver.address.governate" value: @"GOVERNATE"];
[json UpdateString: @"receiver.type" value: @"B"];
[json UpdateString: @"receiver.id" value: @"999999999"];
[json UpdateString: @"receiver.name" value: @"XYZ EGYPT FOR TRADE"];
[json UpdateString: @"documentType" value: @"I"];
[json UpdateString: @"documentTypeVersion" value: @"1.0"];
[json UpdateString: @"dateTimeIssued" value: @"2020-11-15T11:04:53Z"];
[json UpdateString: @"taxpayerActivityCode" value: @"1073"];
[json UpdateString: @"internalID" value: @"ZZZZ999"];
[json UpdateString: @"purchaseOrderReference" value: @"2009199918"];
[json UpdateString: @"salesOrderReference" value: @""];
[json UpdateString: @"payment.bankName" value: @""];
[json UpdateString: @"payment.bankAddress" value: @""];
[json UpdateString: @"payment.bankAccountNo" value: @""];
[json UpdateString: @"payment.bankAccountIBAN" value: @""];
[json UpdateString: @"payment.swiftCode" value: @""];
[json UpdateString: @"payment.terms" value: @""];
[json UpdateString: @"delivery.approach" value: @""];
[json UpdateString: @"delivery.packaging" value: @""];
[json UpdateString: @"delivery.dateValidity" value: @""];
[json UpdateString: @"delivery.exportPort" value: @""];
[json UpdateString: @"delivery.countryOfOrigin" value: @"EG"];
[json UpdateInt: @"delivery.grossWeight" value: [NSNumber numberWithInt: 0]];
[json UpdateInt: @"delivery.netWeight" value: [NSNumber numberWithInt: 0]];
[json UpdateString: @"delivery.terms" value: @""];
[json UpdateString: @"invoiceLines[0].description" value: @"CDM Widget 48GX99X12BA"];
[json UpdateString: @"invoiceLines[0].itemType" value: @"GS1"];
[json UpdateString: @"invoiceLines[0].itemCode" value: @"7622213335056"];
[json UpdateString: @"invoiceLines[0].unitType" value: @"CS"];
[json UpdateNumber: @"invoiceLines[0].quantity" numericStr: @"1.00"];
[json UpdateString: @"invoiceLines[0].unitValue.currencySold" value: @"EGP"];
[json UpdateNumber: @"invoiceLines[0].unitValue.amountEGP" numericStr: @"588.67"];
[json UpdateInt: @"invoiceLines[0].unitValue.amountSold" value: [NSNumber numberWithInt: 0]];
[json UpdateInt: @"invoiceLines[0].unitValue.currencyExchangeRate" value: [NSNumber numberWithInt: 0]];
[json UpdateNumber: @"invoiceLines[0].salesTotal" numericStr: @"588.67"];
[json UpdateNumber: @"invoiceLines[0].total" numericStr: @"603.97"];
[json UpdateInt: @"invoiceLines[0].valueDifference" value: [NSNumber numberWithInt: 0]];
[json UpdateInt: @"invoiceLines[0].totalTaxableFees" value: [NSNumber numberWithInt: 0]];
[json UpdateNumber: @"invoiceLines[0].netTotal" numericStr: @"529.8"];
[json UpdateInt: @"invoiceLines[0].itemsDiscount" value: [NSNumber numberWithInt: 0]];
[json UpdateNumber: @"invoiceLines[0].discount.rate" numericStr: @"10.00"];
[json UpdateNumber: @"invoiceLines[0].discount.amount" numericStr: @"58.87"];
[json UpdateString: @"invoiceLines[0].taxableItems[0].taxType" value: @"T1"];
[json UpdateNumber: @"invoiceLines[0].taxableItems[0].amount" numericStr: @"74.17"];
[json UpdateString: @"invoiceLines[0].taxableItems[0].subType" value: @"No sub"];
[json UpdateNumber: @"invoiceLines[0].taxableItems[0].rate" numericStr: @"14.00"];
[json UpdateString: @"invoiceLines[0].internalCode" value: @"9099994"];
[json UpdateNumber: @"totalSales" numericStr: @"588.67"];
[json UpdateNumber: @"totalSalesAmount" numericStr: @"588.67"];
[json UpdateNumber: @"totalDiscountAmount" numericStr: @"58.87"];
[json UpdateNumber: @"netAmount" numericStr: @"529.80"];
[json UpdateString: @"taxTotals[0].taxType" value: @"T1"];
[json UpdateNumber: @"taxTotals[0].amount" numericStr: @"74.17"];
[json UpdateInt: @"extraDiscountAmount" value: [NSNumber numberWithInt: 0]];
[json UpdateInt: @"totalItemsDiscountAmount" value: [NSNumber numberWithInt: 0]];
[json UpdateNumber: @"totalAmount" numericStr: @"603.97"];
json.EmitCompact = YES;
NSString *jsonToSign = [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";
NSString *sigBase64 = [crypt SignStringENC: jsonToSign];
if (crypt.LastMethodSuccess == NO) {
NSLog(@"%@",crypt.LastErrorText);
return;
}
NSLog(@"%@",@"Base64 signature:");
NSLog(@"%@",sigBase64);
// Insert the base64 signature into the JSON to be sent
[json UpdateString: @"signatures[0].signatureType" value: @"I"];
[json UpdateString: @"signatures[0].value" value: sigBase64];
// Wrap the JSON in {"documents":[ ... ]}
CkoStringBuilder *sbToSend = [[CkoStringBuilder alloc] init];
[sbToSend Append: @"{\"documents\":["];
[sbToSend Append: [json Emit]];
[sbToSend Append: @"]}"];
// ------------------------------------------------------------------------
// Get an access token using our client ID and client secret key
NSString *clientId = @"abc999ff-1234";
NSString *clientSecretKey = @"123fff22-1234-abcd";
CkoHttp *http = [[CkoHttp alloc] init];
// Causes the Authorization: Basic header to be added..
http.Login = clientId;
http.Password = clientSecretKey;
http.BasicAuth = YES;
CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
req.Path = @"/connect/token";
req.ContentType = @"application/x-www-form-urlencoded";
[req AddParam: @"grant_type" value: @"client_credentials"];
[req AddHeader: @"Connection" value: @"close"];
http.Accept = @"application/json";
CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpReq: @"https://id.preprod.eta.gov.eg/connect/token" request: req response: resp];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
[http CloseAllConnections];
NSLog(@"%@%d",@"Response status code: ",[resp.StatusCode intValue]);
NSLog(@"%@",@"Response body:");
NSLog(@"%@",resp.BodyStr);
if ([resp.StatusCode intValue] != 200) {
NSLog(@"%@",@"Failed.");
return;
}
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
success = [jsonToken Load: resp.BodyStr];
NSString *accessToken = [jsonToken StringOf: @"access_token"];
NSLog(@"%@%@",@"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 = NO;
// Setting the AuthToken property causes the "Authorization: Bearer <token>" header to be added to each request.
http.AuthToken = accessToken;
NSString *jsonStr = [sbToSend GetAsString];
NSString *url = @"https://api.preprod.invoicing.eta.gov.eg/api/v1/documentsubmissions";
success = [http HttpStr: @"POST" url: url bodyStr: jsonStr charset: @"utf-8" contentType: @"application/json; charset=utf-8" response: resp];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
NSLog(@"%@%d",@"Response status code: ",[resp.StatusCode intValue]);
NSLog(@"%@",@"Response body:");
NSLog(@"%@",resp.BodyStr);