zatca 1.0.0 → 1.0.1

data/einvoicing-sdk/README.md

@@ -1,15 +0,0 @@
-# E-Invoicing SDK
-I could never get the SDK to run on my machine, so I dockerized it instead.
-
-If you have Docker installed, you should be able to run the following command
-to get a shell that's pre-installed with the SDK.
-
-```bash
-docker compose run zatca
-```
-
-The envoicing-sdk is mounted into the container, so any changes you do on the host
-within that folder will appear inside the container.
-
-NOTE: This command has one downside in that it runs `install.sh` every time so
-`Configuration/config.json` will be overridden each time you run the container.

data/einvoicing-sdk/Readme/readme.md

@@ -1,674 +0,0 @@
-## **Welcome to ZATCA E-Invoice Java SDK (CLI)** {#welcome-to-zatca-e-invoice-java-sdk-cli .unnumbered}
-
-This cli is a Java based tool that utilizes ZATCA's SDK jar to perform
-several tasks. Basically, you can use it to validate different e-invoice
-documents including Standard Invoice, Standard Debit Note, Standard
-Credit Note, Simplified Invoice, Simplified Debit Note, and Simplified
-Credit Note. Once validation has run, the tool will display the
-validation results. This can be a PASS if all validations have passed,
-otherwise a NOT PASS messf.net
-
-age is displayed along with a list of errors indicating what has
-happened. Moreover, this tool allows signing invoices, generating
-invoice hash, generating api requests, generating certificate signing
-requests (CSR), and generating QR code .
-
-## **SDK Prerequisite**  {#sdk-prerequisite .unnumbered}
-
-The SDK requires JAVA to run, please make sure you have a valid Java JRE
-or SDK, the version must be between 11 and 15.
-
-## **SDK Installation Steps** {#sdk-installation-steps .unnumbered}
-
-### **Install/Update for Windows** {#installupdate-for-windows .unnumbered}
-
-1.  Download the sdk.zip file
-
-2.  Unzip the sdk.zip file
-
-3.  Now, open a command line and point to the root folder of the sdk.
-
-4.  Run the ***install.bat***
-
-5.  Now, you can start using the fatoora cli. Please run ***fatoora
-    > -help*** to get all supported commands
-
-### **Install/Update for Linux** {#installupdate-for-linux .unnumbered}
-
-1.  Install \[jq\] from
-    > [[https://stedolan.github.io/jq/]{.underline}](https://stedolan.github.io/jq/)
-
-2.  Download the sdk.zip file
-
-3.  Run command ***sh \~/.bash_profile***
-
-4.  Unzip the sdk.zip file
-
-5.  Now, open a command line/terminal and point to the root folder of
-    > the sdk.
-
-6.  Run command ***install.sh***
-
-7.  *Run **sh \~/.bash_profile***
-
-8.  *Run command **cd \$FATOORA_HOME***
-
-9.  *Run command **chmod +x fatoora***
-
-10. Now, you can start using the fatoora cli. Please run ***fatoora
-    > -help*** to get all supported commands
-
-## **Configuration**
-
-### ***fatoora \[ command \] \[ options \]*** {#fatoora-command-options .unnumbered}
-
-  --------- ---------------------- --------------------------------------------
-  **No.**   **Command**            **Description**
-
-  1         \[-csr\]               A flag used to generate csr and private key.
-
-  2         \[-pem\]               A flag used to generate csr and private key
-                                   in pem format.
-
-  3         \[-privateKey          The name of the private key output file.
-            fileName\]             
-
-  4         \[-generatedCsr        The name of the csr output file.
-            fileName\]             
-
-  5         \[-csrConfig           The name of the csr configuration file.
-            fileName\]             
-
-  6         \[-invoice fileName\]  The name of the invoice file.
-
-  7         \[-qr\]                A flag used to generate qr.
-
-  8         \[-sign\]              A flag used to sign an invoice.
-
-  9         \[-signedInvoice       The name of the signed invoice output file.
-            fileName\]             
-
-  10        \[-invoiceRequest\]    A flag used to generate an invoice API
-                                   request.
-
-  11        \[-apiRequest          The name of the invoice json request output
-            fileName\]             file
-
-  12        \[-validate\]          A flag used to validate invoice.
-
-  13        \[-generateHash\]      A flag used to generate new hash for the
-                                   provided invoice.
-
-  14        \[-nonprod\]           A flag pointing to use the csr and private
-                                   key on a non production server.
-
-  15        \[-sim\]               A flag pointing to use the csr and private
-                                   key on a simulation server.
-
-  16        \[-help\]              A flag used to display this help menu and
-                                   exit.
-  --------- ---------------------- --------------------------------------------
-
-## **Generating a Certificate Signing Request (CSR):**
-
-#### **Prerequisite:**  {#prerequisite .unnumbered}
-
--   **Input:**
-
-> There is a CSR configuration properties file which contains all the
-> input needed to generate a CSR. Those include the below:
-
--   common name
-
--   serial number
-
--   organization identifier
-
--   organization unit name
-
--   organization name
-
--   country name
-
--   invoice type
-
--   location address
-
--   industry business category
-
-> Also, please note that:
-
-1.  You can follow the structure of the properties file by checking the
-    > template provided in:
-
-> ***/Data/Input/csr-config-template.properties*.**
-
-2.  Also an example is provided in:
-
-> ***/Data/Input/csr-config-template.properties/csr-config-example.properties***
->
-> Once done you can generate a csr using the config properties file by
-> providing it as an option to the -csrConfig argument. Please see
-> Arguments and Options below.
-
-#### **Arguments and Options:** {#arguments-and-options .unnumbered}
-
-***fatoora -csr -csrConfig fileName -privateKey fileName -generatedCsr
-fileName -pem***
-
-  --------- --------------------------- --------------------------------------------
-  **No.**   **Argument(s)/Option(s)**   **Description**
-
-  1         \[-csr\]                    A flag used to generate csr and private key.
-
-  2         \[-csrConfig \<filename\>\] This is a mandatory argument to provide
-                                        location and name of the csr configuration
-                                        file.
-
-  3         \[-privateKey\]             This is an optional argument to provide
-            \<filename\>                location and name of generated private key
-                                        output file
-
-  4         \[-generatedCsr\]           This is an optional argument to provide
-            \<filename\>                location and name of generated csr output
-                                        file
-
-  5         \[-pem\]                    This is an optional argument used to
-                                        generate csr and private key in pem format
-  --------- --------------------------- --------------------------------------------
-
-**[Notes:]{.underline}**
-
-1.  If the user does not provide \[-privateKey\] argument then the
-    > private key file will be generated in the path of a running
-    > command prompt with file convention name pattern
-    > generated-private-key-yyyyMMddhhmmss.key
-
-2.  If the user does not provide \[-generatedCsr\] argument then the csr
-    > file will be generated in the path of a running command prompt
-    > with file convention name pattern generated-csr-yyyyMMddhhmmss.csr
-
-3.  If the user does not provide \[-pem\] argument then the csr file
-    > will be generated encoded base64 and private key file will be
-    > generated without header \"\-\-\-\--BEGIN EC PRIVATE
-    > KEY\-\-\-\--\" and footer \"\-\-\-\--END EC PRIVATE KEY\-\-\-\--\"
-
-## **Signing and Generating Invoice Hash:**
-
-#### **Prerequisite:**  {#prerequisite-1 .unnumbered}
-
-> Please refer back to the prerequisites section of generating a CSR
-> above.
-
--   Input: The E-Invoice XML file full path.
-
--   Output: an object of type \"Result\" that contains
-
-```{=html}
-<!-- -->
-```
--   IsValid : The final Status of the process.
-
--   ResultValue: XML Hashed Generated if \"IsValid = True\". It should
-    be the same as the one already exists in the E-Invoice XML file.
-
--   ErrorMessage: The error message if \"IsValid = false\".
-
-```{=html}
-<!-- -->
-```
--   Integration with other systems
-
-```{=html}
-<!-- -->
-```
--   Declare object from Class \"HashGenerationService\"
-
-    -   Declare object from class "SigningService"
-
-        -   Call function \"generateInvoiceHash\"
-
-            -   Parameter 1 (xmlFilePath) : E-Invoice XML file full path
-
-#### **Arguments and Options:** {#arguments-and-options-1 .unnumbered}
-
-***fatoora -sign -invoice \<filename\> -signedInvoice \<filename\>***
-
-  --------- --------------------------- ----------------------------------------
-  **No.**   **Argument(s)/Option(s)**   **Description**
-
-  1         \[-sign\]                   A flag used to sign an invoice.
-
-  2         -invoice \<filename\>       This is an optional argument to provide
-                                        the name of the invoice file.
-
-  3         \[-signedInvoice            This is an optional argument to provide
-            \<fileName\>\]              the name of the signed invoice output
-                                        file.
-  --------- --------------------------- ----------------------------------------
-
-**[Notes:]{.underline}**
-
-1.  If the user does not provide \[-signedInvoice\] argument then the
-    > signed invoice file will be generated in the path of a running
-    > command prompt with file convention name pattern \<same input file
-    > name\>\_signed.xml
-
-## **Generating JSON API Request:**
-
-#### **Prerequisite:**  {#prerequisite-2 .unnumbered}
-
-None.
-
-#### **Arguments and Options:** {#arguments-and-options-2 .unnumbered}
-
-***fatoora -invoice \<filename\> -invoiceRequest -apiRequest
-\<fileName\>***
-
-  --------- --------------------------- ----------------------------------------
-  **No.**   **Argument(s)/Option(s)**   **Description**
-
-  1         -invoice \<filename\>       This is a mandatory argument used to
-                                        provide the name of the invoice file.
-
-  2         \[-invoiceRequest\]         A flag used to generate an invoice API
-                                        request.
-
-  3         \[-apiRequest               This is an optional argument used to
-            \<fileName\>\]              provide the name of the invoice json
-                                        request output file
-  --------- --------------------------- ----------------------------------------
-
-**[Notes:]{.underline}**
-
-1.  If the user does not provide \[-apiRequest\] argument then the
-    > invoice request file will be generated in the path of a running
-    > command prompt with file convention name pattern
-    > generated-json-request-yyyyMMddhhmmss.json
-
-## **Generating QR Code:**
-
-#### **Prerequisite:**  {#prerequisite-3 .unnumbered}
-
-> Replace SDK default private key and certificate with the custom
-> values, as mentioned below in [section "Adding the private key and
-> certificate"](#adding-the-private-key-and-certificate).
-
-#### **Arguments and Options:** {#arguments-and-options-3 .unnumbered}
-
-***fatoora -qr -invoice \<filename\>***
-
-  --------- --------------------------- ----------------------------------------
-  **No.**   **Argument(s)/Option(s)**   **Description**
-
-  1         \[-qr\]                     A flag used to generate qr code.
-
-  2         -invoice \<filename\>       This is a mandatory argument used to
-                                        provide the name of the invoice file.
-  --------- --------------------------- ----------------------------------------
-
-## **Validating an invoice:**
-
-#### **Prerequisite:**  {#prerequisite-4 .unnumbered}
-
-> Replace SDK default private key and certificate with the custom
-> values, as mentioned below in [section "Adding the private key and
-> certificate"](#adding-the-private-key-and-certificate).
-
-#### **Arguments and Options:** {#arguments-and-options-4 .unnumbered}
-
-***fatoora -validate -invoice \<filename\>***
-
-  --------- --------------------------- ----------------------------------------
-  **No.**   **Argument(s)/Option(s)**   **Description**
-
-  1         \[-validate\]               A flag used to validate the invoice.
-
-  2         -invoice \<filename\>       This is a mandatory argument used to
-                                        provide the name of the invoice file.
-  --------- --------------------------- ----------------------------------------
-
-## **Generating Invoice Hash:**
-
-#### **Prerequisite:**  {#prerequisite-5 .unnumbered}
-
-> None.
-
-#### **Arguments and Options:** {#arguments-and-options-5 .unnumbered}
-
-***fatoora -generateHash -invoice \<filename\>***
-
-  --------- --------------------------- ----------------------------------------
-  **No.**   **Argument(s)/Option(s)**   **Description**
-
-  1         \[-generateHash\]           A flag used to generate new hash for the
-                                        provided invoice.
-
-  2         -invoice \<filename\>       This is a mandatory argument used to
-                                        provide the name of the invoice file.
-  --------- --------------------------- ----------------------------------------
-
-## **Adding the Private Key and Certificate:**
-
-1.  Replace Data/Certificates/ec-secp256k1-priv-key.pem with your
-    > private key using EC secp256k1 algorithm without header
-    > \"\-\-\-\--BEGIN EC PRIVATE KEY\-\-\-\--\" and footer
-    > \"\-\-\-\--END EC PRIVATE KEY\-\-\-\--\"
-
-2.  Place yourCertificate generated by ZATCA into
-    > Data/Certificates/cert.pem *[without]{.underline}* header, footer
-    > and without any new lines \"\\n\".
-
-3.  Once done, now you can sign your xml invoice using your private key
-    > and matching it on validation with the zatca certificate.
-
-**Please note that the provided certificate**
-
-**and private key in the SDK are dummy and for testing purposes only.**
-
-## **Technical FAQs:**
-
--   **[What JAVA version should I install before using the
-    > SDK?]{.underline}**
-
-> The prerequisite is using the Java SDK (JAR) versions \>=11 and \<15.
-
--   **[What should the user do when faced with a JAVA
-    > error?]{.underline}**
-
-> When faced with a JAVA error, the user needs to install JAVA (versions
-> \>=11 and \<15) before running and using the SDK.
-
-**[Running the SDK inside your application]{.underline}**
-
--   **Prerequisites:**
-
-Make sure to Install the latest SDK version (see section **SDK
-Installation Steps).**
-
--   **Running SDK inside a java application:**
-
-To run any function inside your java application, use the following code
-snippet:
-
-Runtime rt = Runtime.getRuntime();
-
-Process pr = rt.exec(\"***fatoora \<command\> \<args\>*** \");
-
-where \<command\> is any sdk command. For example, **-generateCsr** or
-**-generateHash** as well as any arguments associated as mentioned
-previously in the documentation.
-
-**Please note that the provided certificate**
-
-**and private key in the SDK are dummy and for testing purposes only.**
-
-> **[SDK .NET Framework]{.underline}**
-
-**Target Framework : .NET Framework 4.7.2**
-
-1.  **Generating Hashing**
-
--   Input: The E-Invoice XML file full path.
-
--   Output: an object of type \"Result\" that contains
-
-```{=html}
-<!-- -->
-```
--   IsValid : The final Status of the process.
-
--   ResultValue: XML Hashed Generated if \"IsValid = True\". It should
-    be the same as the one already exists in the E-Invoice XML file.
-
--   ErrorMessage: The error message if \"IsValid = false\".
-
-```{=html}
-<!-- -->
-```
--   Integration with other systems
-
-```{=html}
-<!-- -->
-```
--   Declare object from Class \" HashingValidator\"
-
--   Call function \" GenerateEInvoiceHashing\"
-
-    -   Parameter 1 (xmlFilePath) : E-Invoice XML file full path
-
-2.  **Validating Hashing (Containing Generating Hash and validate it)**
-
--   Input: The E-Invoice XML file full path.
-
--   Output: an object of type \"Result\" that contains
-
-```{=html}
-<!-- -->
-```
--   IsValid : The final Status of the process it should be true if the
-    generated Hash is the same as the one already exists in E-Invoice
-    XML.
-
--   ResultValue: Empty
-
--   ErrorMessage: The error message if \"IsValid = false\".
-
-```{=html}
-<!-- -->
-```
--   Integration with other systems
-
-```{=html}
-<!-- -->
-```
--   Declare object from Class \" HashingValidator \"
-
--   Call function \"ValidateEInvoiceHashing\"
-
-    -   Parameter1 (xmlFilePath): E-Invoice XML file full path
-
-3.  **Generating QR**
-
--   Input: The E-Invoice XML file full path.
-
--   Output: an object of type \"Result\" that contains
-
-```{=html}
-<!-- -->
-```
--   IsValid : The final Status of the process.
-
--   ResultValue: QR code Generated if \"IsValid = True\". It should be
-    the same as the one already exists in the E-Invoice XML file.
-
--   ErrorMessage: The error message if \"IsValid = false\".
-
-```{=html}
-<!-- -->
-```
--   Integration with other systems
-
-```{=html}
-<!-- -->
-```
--   Declare object from Class \"QRValidator\"
-
--   Call function \"GenerateEInvoiceQRCode\"
-
-    -   Parameter1 (xmlFilePath): E-Invoice XML file full path
-
-4.  **Validating QR (Containing Generating QR and validate it)**
-
--   Input: The E-Invoice XML file full path.
-
--   Output: an object of type \"Result\" that contains
-
-```{=html}
-<!-- -->
-```
--   IsValid : The final Status of the process it should be true if the
-    generated QR Code is the same as the one already exists in E-Invoice
-    XML.
-
--   ResultValue: Empty
-
--   ErrorMessage: The error message if \"IsValid = false\".
-
-```{=html}
-<!-- -->
-```
--   Integration with other systems
-
-```{=html}
-<!-- -->
-```
--   Declare object from Class \"QRValidator\"
-
--   Call function \"ValidateEInvoiceQRCode\"
-
-    -   Parameter1 (xmlFilePath): E-Invoice XML file full path
-
-5.  **Validating E-Invoice**
-
--   There are two types of E-Invoices \"Simplified\" & \"Standard\"
-
--   Validation of \"Simplified\" E-Invoice contains the next steps
-
-```{=html}
-<!-- -->
-```
--   Validate XSD
-
--   Validate EN Schema Tron
-
--   Validate KSA Schema Tron
-
--   Validate Signature
-
--   Validate QR
-
--   Validate PIH
-
-```{=html}
-<!-- -->
-```
--   Validation of \"Standard\" E-Invoice contains the next steps
-
-```{=html}
-<!-- -->
-```
--   Validate XSD
-
--   Validate EN Schema Tron
-
--   Validate KSA Schema Tron
-
--   Validate PIH
-
-```{=html}
-<!-- -->
-```
--   Input:
-
-    -   The E-Invoice XML file full path
-
-    -   The content of certificate file.
-
-    -   The Current PIH as string .
-
--   Output: an object of type \"Result\" that contains
-
-```{=html}
-<!-- -->
-```
--   IsValid : The final Status of the process it should be true if all
-    steps of E-Invoice validation \"IsValid\"
-
--   ResultValue: Empty
-
--   ErrorMessage: Empty.
-
--   List of Steps each step is an object of type \"Result\" that
-    contains if this step IsValid or not and the error message if it is
-    not valid.
-
-```{=html}
-<!-- -->
-```
--   Integration with other systems
-
-```{=html}
-<!-- -->
-```
--   Declare object from Class \" EInvoiceValidator\"
-
--   Call function \" ValidateEInvoice\"
-
-    -   Parameter 1 (xmlFilePath): E-Invoice XML file full path
-
-    -   Parameter 2 (certificateContent): Certificate content as string
-
-    -   Parameter 3 (pihContent): PIH content as string
-
-6.  **Signing E-Invoice**
-
--   Signing E-Invoice contains the next steps
-
-```{=html}
-<!-- -->
-```
--   Generating Hashing
-
--   Generating Signature
-
--   Populating Data
-
--   Generating and populating QR
-
-```{=html}
-<!-- -->
-```
--   Input:
-
-    -   The E-Invoice XML file full path.
-
-    -   The content of certificate file as string
-
-    -   The content of private key as string (generated by OpenSSL)
-
--   Output: an object of type \"Result\" that contains
-
-```{=html}
-<!-- -->
-```
--   IsValid : The final Status of the process it should be true if all
-    steps of E-Invoice Signing \"IsValid\"
-
--   ResultValue: XML content after signing if it is valid
-
--   ErrorMessage: Empty.
-
--   List of Steps each step is an object of type \"Result\" that
-    contains if this step IsValid or not and the error message if it is
-    not valid.
-
-```{=html}
-<!-- -->
-```
--   Integration with other systems
-
-```{=html}
-<!-- -->
-```
--   Declare object from Class \" EInvoiceSigningLogic\"
-
--   Call function \" SignDocument\"
-
-    -   Parameter 1 (xmlFilePath): E-Invoice XML file full path
-
-    -   Parameter 2 (certificateContent): Certificate file content as
-        string
-
-    -   Parameter 3 (privateKeyContent): Private key file content as
-        string

data/einvoicing-sdk/docker-compose.yml

@@ -1,12 +0,0 @@
-version: "3.9"
-
-services:
-  zatca:
-    build:
-      context: .
-    image: zatca:1.0.0
-    command: sh -c "(sh ./install.sh && /bin/bash)"
-    volumes:
-      - .:/zatca
-    tty: true
-    stdin_open: true