From a272a197861b46b8db58bc541e112d8069838525 Mon Sep 17 00:00:00 2001 From: Peter Westin <83552499+pwgit-create@users.noreply.github.com> Date: Sat, 23 May 2026 23:10:14 +0200 Subject: [PATCH 1/2] docs: restructure backend README Improved README structure and clarity for the backend (FIM Engine). Focused on better architecture explanation, reduced redundancy, and clearer separation of system components. No functional changes. --- README.md | 80 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 57 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 94afd6d..4fd895b 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,20 @@ -# File-Integrity Scanner -## Overview - -The **File-Integrity Scanner** is a powerful tool designed to ensure the integrity of files by using cryptographic -hash functions. This application provides peace of mind that files have not been tampered with, which is crucial -for security and data verification purposes. - - +# File-Integrity Scanner Backend (FIM Engine) +This repository contains the backend service for the File Integrity Scanner system. It provides file integrity verification using cryptographic hash functions and detects unauthorized modifications and file corruption, ensuring reliable integrity checks for local systems. ## What is a File Integrity Scanner? - -A file integrity scanner is a software utility that computes cryptographic hashes of files and monitors them for -changes. This process helps in detecting unauthorized modifications or corruption of critical files on a local -machine. - +A file integrity scanner computes cryptographic hashes of files and monitors them for changes over time. It detects tampering, corruption, or unauthorized modifications to critical system and user files. ## Key Features +Different hashing algorithms are supported to allow flexibility between performance and cryptographic strength depending on use case requirements. -- **Hashing Algorithms:** Supports three different hashing algorithms: +- **Hashing Algorithms:** - SHA-256 - SHA-3 (256-bit) - - BLAKE_2b (512-bit) + - BLAKE2b (512-bit) - **Database Storage:** Uses PostgreSQL to store file hashes along with the date of the scan and other relevant file metadata. -- **Local Operation:** The scanner runs exclusively on the user's local machine. No remote services are required -or desired, ensuring full control over data integrity for the end-user. +- **Local Operation:** The scanner runs exclusively on the user's local machine. No remote services are required, ensuring full local control over data and integrity verification. ![File Integrity Scanner Image](https://github.com/pwssOrg/File-Integrity-Scanner/blob/master/.github/assets/images/640x486.jpg?raw=true) @@ -33,7 +23,7 @@ or desired, ensuring full control over data integrity for the end-user. šŸ›”ļø **Zero spyware. Zero tracking. Full respect for your privacy.** -## Basic Setup Instructions +## Basic Setup Instructions (for developers) ### Requirements @@ -41,9 +31,10 @@ or desired, ensuring full control over data integrity for the end-user. - **SSL password** -### Spring Version +### Technology Stack -**Spring 4.0.6** +- Spring Framework 4.0.6 +- PostgreSQL ### Steps @@ -58,11 +49,54 @@ or desired, ensuring full control over data integrity for the end-user. ## Contact Information -For any questions or support, please reach out to: +For questions, support, or contributions: + +- **Peter** ā€” [@pwgit-create](https://github.com/pwgit-create) +- **Stefan** ā€” [@lilstiffy](https://github.com/lilstiffy) - @pwgit-create Peter pwgit-create - @lilstiffy Stefan lilstiffy ### Discussion Forum Please visit our discussion forum for project-related documentation and discussions: [Project Discussion Forum](https://github.com/orgs/pwssOrg/discussions/categories/file-integrity-scanner) + +--- + +## Related Repositories + +### [PWSS Release Repository](https://github.com/pwssOrg/PWSS-Release-File-Integrity-Scanner) + +User-focused distribution of the Integrity Hash platform for Windows and Linux systems. + +Designed for non-developers and system administrators who want a simplified installation and local file integrity monitoring experience without manually configuring backend services. +

+ + Titta pƄ videon + +

+Features: + +* Easy setup +* Local-only operation +* PostgreSQL integration +* Multi-algorithm hashing support +* Privacy-focused design +--- + +## System Architecture + +The system is split into backend services, a GUI client, shared PWSS libraries, and an end-user distribution package. This modular architecture enables independent development of core security logic, user interface components, and deployment tooling for both technical and non-technical users. Each component can be developed and deployed independently while maintaining a shared security and hashing standard through the PWSS libraries. + +### Components + +- **Core Backend (FIM Engine)** ā€“ Handles hashing, integrity verification, and monitoring logic +- **GUI Application** ā€“ User interface for managing scans and viewing results +- **PWSS Libraries** ā€“ Shared components used across all PWSS projects +- **PWSS Release Repository** ā€“ End-user distribution for Windows and Linux + +### Architecture diagram +This repository represents the backend layer of the File Integrity Scanner system and implements the core FIM engine. +``` +GUI ā†’ Local Backend ā†’ PostgreSQL + ā†“ + PWSS Libraries (dependency) +``` From 64b1f62ef56bff31a02793892d10c37f4780040d Mon Sep 17 00:00:00 2001 From: Peter Westin <83552499+pwgit-create@users.noreply.github.com> Date: Sat, 23 May 2026 23:16:20 +0200 Subject: [PATCH 2/2] Add explanation of cryptographic hashes to README Added a section explaining cryptographic hashes and their importance in file integrity. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 4fd895b..376b6dd 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ This repository contains the backend service for the File Integrity Scanner syst ## What is a File Integrity Scanner? A file integrity scanner computes cryptographic hashes of files and monitors them for changes over time. It detects tampering, corruption, or unauthorized modifications to critical system and user files. +## What is a Cryptographic Hash? +A cryptographic hash is a one-way mathematical function that converts data into a fixed-size value known as a hash or digest. Even the smallest change to a file results in a completely different hash value, making hashes useful for integrity verification and tamper detection. + ## Key Features Different hashing algorithms are supported to allow flexibility between performance and cryptographic strength depending on use case requirements.