summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSaumit Dinesan <justsaumit@protonmail.com>2023-09-04 16:19:32 +0530
committerSaumit Dinesan <justsaumit@protonmail.com>2023-09-04 16:19:32 +0530
commit117d461c4944f189576f0c4967851de458ba6f32 (patch)
tree7248b4bde0cf03e06920bf3622228652cc71b5ba /README.md
parent1f61825e4b0b46d65b0a379c6b87e50d1467cfdc (diff)
Updating README + Creating idgen package and importing it
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4ab0c58..546c993 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
# Golang Backend API using Echo for FSI(File System Integrity) Application
-Developing a simple Golang backend API using the [Echo framework](https://github.com/labstack/echo). This API stores IDs and their corresponding hashes in a SQL server and provides functionality to verify if a given hash matches the stored hash for a specific ID, thereby providing integrity service that aligns with the CIA (Confidentiality, Integrity, Availability) triad for data security.
+Developing a simple Golang backend API using the [Echo framework](https://github.com/labstack/echo). This API stores IDs and their corresponding hashes in a SQL server and provides functionality to verify if a given hash matches the stored hash for a specific ID. All the communication between the Application and API will secured using TLS encryption(HTTPS).
+Thereby providing both confidentiality and integrity service that aligns with the CIA (Confidentiality, Integrity, Availability) triad for data security.
## Getting Started
@@ -40,6 +41,13 @@ Once the server is running, you can access the API endpoints to add file hashes
- To add a file hash, make a POST request to `/add` with JSON data containing the ID and hash.
- To verify a file hash, make a POST request to `/verify` with JSON data containing the ID and hash.
+## To-Do-List
+- [x] Perform short ID Generation (API/Application)
+- [ ] Perform Hashing (API/Application)
+- [ ] Connect with DB
+- [ ] Add JSON data to DB
+- [ ] Perform verification
+
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.