Electronic Document System

A highly secure and simple document management system, written in Java. Every document is unmodifiable, and issued a 9-digit code. If you want to know more about the API, please head to docs/API.md

• Electronic Document System
  • Use cases
  • Example Usage
  • Build and Run
  • Technologies used
  • Legal Information
  • Security Measures
  • Backup and Restore
  • Class List
  • Configuration and Database Directory List
  • Command Prompt Help
  • Database Columns
  • Author Information

Use cases

1. Replace the official government seal with a 9-digit code acting as a digital signature.
2. Store documents and share them in a highly secured system across a network.
3. Integrating EDS API in a larger high-security system for document archival and secure storage.

Example Usage

1. A verifier inserts a document through a 2-step process in 'Submit A document' tab.
2. The system generates a 9-digit code for the inserted document and displays it to the verifier.
3. Any member of the public can download the document, view information about who wrote it and the date of publication, or compare it with another file using the 9-digit code.
4. The verifier can access the list of documents and their 9-digit codes later in the 'Board' tab.

Build and Run

The main instance of the application is APp.java.

• In order to run it in linux systems: $ javac App.java && sudo java App
• In order to run it in windows systems: > javac -encoding iso8859_1 App.java && java App

Technologies used

• Backend: Java Native
• Frontend: NextJS

Legal Information

This software is an intellectual property in all of the WIPO member states (Egypt Deposit number: 4123). The repository inherits all of its legal statements from the Egyptian Intellectual Property Protection Law No. 82 of 2002.

Security Measures

1. We do not use common architecture (eg. Apache, nginx, SQL-based solutions). Instead, we built the backend from scratch. This means that EDS will not be hit by any CVE attack.
2. Verifiers' credentials are encrypted by AES256/CBC/PKCS5 algorithm and hashed with SHA3-512.
3. All databases, users' credentials, configurations, and Frontend files are encrypted to limit the impact of physical attacks.
4. SO_Timeout is limited to 60 seconds.
5. We implemented Time-based One time passwords for verifiers' authentication.
6. The maximum number of documents that can exist in the system at any given time is 10 Million documents with FIFO insertion system.

Backup and Restore

To move your data in another system, just copy data/ folder in server/src/ and paste the folder in server/src/ of the new system. Note that older versions (< 4.0) would need to group conf/ and docs/ into a new folder data/ to migrate to version (>= 4.0).

Class List

• www/
  • Content is generated using GitHub Actions.
• Endpoints/
  • about.java : Handles 'api.about' response.
  • DataDoc.java : Handles 'api.DataDoc' response.
  • DownloadDoc.java : Handles 'api.DownloadDoc' response.
  • generate.java : Handles 'api.generate' response.
  • login.java : Handles 'api.login' response.
  • logout.java : Handles 'api.logout' response.
  • name.java : Handles 'api.name' response.
  • SearchDoc.java : Handles 'api.SearchDoc' response.
  • Table.java : Handles 'api.table' response.
  • VerifyDoc.java : Handles 'api.VerifyDoc' response.
• lib/
  • AES.java : AES256/CBC/PKCS5 Encryption and Decryption Class.
  • ArraySplit.java : Splits a byte array based on a specific byte sequence as a delimiter.
  • EntropyCalc.java : Calculation of entropy for a given passphrase.
  • FileToAL.java : Converts a file content to an arraylist of lines based on '\n' delimiter, used for 'WWWFiles.db'.
  • HeaderToHashmap.java : Converts the HTTP(S) Headers to a HashMap structure.
  • HTTPCode.java : An enum of String values to map HTTP(S) statuses to their corresponding header with the status code.
  • FilePaths.java : An enum of all configuration and database directories.
  • IO.java : Reads and Writes data to Disk.
  • JSON.java : Converts JSON String to a HashMap structure, and vice versa.
  • log.java : Prints different log statements with colors.
  • MaxSizeHashMap.java : A HashMap with a fixed size where it deletes the eldest entry if the HashMap is full.
  • MemMonitor.java : A thread object that calls Garbage Collection every 100ms if the memory usage went above 2GB.
  • Network.java : Handles GZIP Compression, read from TCP socket and write HTTP(S) responses to TCP socket.
  • PathFilter.java : Provides LFI Protection and handles different path typos.
  • PostRequestMerge.java : Reads the whole HTTPS POST request beyond TLS record limitation (16kb).
  • RandomGenerator.java : Generates Random String values.
  • SHA.java : SHA3-512 UTF8 Hashing Class.
  • SparkDB.java : CSV to in-memory structure, see the main project for more information.
  • TOTP.java : Handles Time-based One Time Passwords generation and validation algorithms.
  • URIDecode.java : Decodes URI (HTML) format.
  • CommandPrompt.java : An abstract Command Prompt Object.
  • CommandExecutor.java : Executes System commands.
• API.java : The intermediate point that maps API requests from the main HTTPS instance to individual API Classes.
• Engine.java : The main HTTPS Instance, called by main application instance 'main.java'.
• App.java : The main Application instance, configures the server if it is first-time run, or calls the HTTPS Instance 'Engine.java' if the inserted Server Key is correct.
• Server.java : TCP HTTPS Handler Class, used by main HTTPS Instance 'Engine.java'.
• mime.db : A list of MIME types and their corresponding file extensions.
• WWWFiles.db : A white-list of files in www/ to access via HTTPS protocol.
• ConfigMode.java : The configuration mode instance, called by main application instance 'main.java' if the user requested the configuration mode.

Configuration and Database Directory List

• data/
  • conf/
    • users.db : Contains Usernames, Full names, Passwords, and OTPs for all verifiers.
    • server.key : Contains self-encrypted server key.
    • keystore.jks : The TLS Self-signed certificate for HTTPS Protocol.
    • docs.db : Main Database Shard List.
    • metadata.db : School name, Number of Queries, Number of Documents
    • Table.db : List of all Documents with Writer, Document Number, Verifier.
    • doc/
      • 000.db : Metadata of all documents with document number with 000 as prefix.
      • 001.db : Metadata of all documents with document number with 001 as prefix.
      • ...
      • 999.db : Metadata of all documents with document number with 999 as prefix.
  • docs/
    • Contains all uploaded encrypted documents.

Command Prompt Help

After Running 'App.java', a command prompt will appear. Running 'help' command will display available commands, and 'exit' will exit the current command prompt instance.

Database Columns

• Metadata.db:
  • entityName: The name of the entity using the system.
  • numQueries: Number of queries processed.
  • numDocs: Number of documents on the system.
• users.db:
  • full_name: The full name of the verifier user.
  • user: The username of the verifier user, hashed with SHA3-512, used in login.
  • pass: The password of the verifier user, hashed with SHA3-512, used in login.
  • otp: The OTP Secret key of the verifier user, used in login.
• Table.db (used for 'Board' feature for the verifier):
  • DocName: The name of the document.
  • Verifier: The full name of the verifier of the document.
  • Writer: The name of the document author.
  • DocNum: The document serial number (consists of 9 digits).
• docs.db (Shards List):
  • prefix: The document code prefix (000 till 999).
  • size: The number of documents with the specified prefix.
  • min_query: The age of the earliest document present.
• 000.db/001.db/../999.db (Database Shard):
  • code: The document code.
  • path: The path of the encrypted document.
  • doc_name: The document name.
  • verifier: The full name of the verifier of the document.
  • writer: The name of the document author.
  • sha: The SHA3-512 Checksum of the file.
  • age: The age of the document.
  • date: The document date of insertion.

Author Information

• Morad Abdelrasheed Mokhtar Ali Gill ([email protected])
• Mohammed Emad Mohamed Ahmed Elsawy ([email protected])
• Mustafa Anwar Hamza Selim ([email protected])
• Andrew Roshdy Morad Yousef ([email protected])