diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 10 insertions, 9 deletions
@@ -1,5 +1,5 @@ -# Golang Backend API for FIC (File Integrity Checker) Application -Developing a simple Golang backend API with the [Echo framework](https://github.com/labstack/echo) for FIC(File Integrity Checker) application. 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 is secured using TLS encryption(HTTPS). +# Golang Backend API for FIS (File Integrity Surveillance) Application +Developing a simple Golang backend API with the [Echo framework](https://github.com/labstack/echo) for FIS(File Integrity Surveillance) application which can be found [here](https://github.com/ayato91/Fair-Files). 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 is 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 @@ -9,15 +9,15 @@ To get started with this project, follow these steps: ### Prerequisites - Go installed on your machine. -- A SQL database server to store IDs and hashes. +- A SQL database server(sqlite) to store IDs and hashes. ### Installation 1. Clone this repository to your local machine: ```bash - git clone https://github.com/justsaumit/go-fic-api.git - cd go-fic-api + git clone https://github.com/justsaumit/go-fis-api.git + cd go-fis-api ``` 2. Initialize and install project dependencies using Go modules: @@ -42,10 +42,11 @@ Once the server is running, you can access the API endpoints to add file hashes - 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 +- [x] Handle Uploaded files (API) +- [x] Perform short ID Generation (API) +- [x] Perform Hashing (API) +- [x] Connect with DB +- [x] Store JSON data to DB - [ ] Perform verification ## License |