# raaaj07/pmrse-final-project architecture

> Architecture diagram of the GitHub repository raaaj07/pmrse-final-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/raaaj07/pmrse-final-project
- Repository: https://github.com/raaaj07/pmrse-final-project

## Overview

P-MRSE provides role-based cloud file storage and privacy-preserving ranked search. Owners upload files through compression, encryption, integrity signing and encrypted-index creation; searchers submit queries that become trapdoors, optionally use fuzzy matching, and receive ATEES-ranked results. Authorized users request shares and download files, while authentication/OTP, notifications and administration support the workflows. The graph combines sampled route calls and module references with README-documented pipeline behavior; unsampled implementation details are not inferred.

Main entry points: [`pmrse-backend/server.js`](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/server.js) (HTTP and socket server), [`pmrse-backend/routes/upload.js`](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/upload.js) (Upload pipeline), [`pmrse-backend/routes/search.js`](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/search.js) (Secure search), [`pmrse-backend/routes/share.js`](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/share.js) (Sharing and access)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Role-based client"]
  node_app["Role router<br/>[App.jsx]"]
  node_session["Session state<br/>[AuthContext.jsx]"]
  node_clientapi["API client<br/>[api.js]"]
  node_ownerui["Owner dashboard<br/>[OwnerDashboard.jsx]"]
  node_searchui["Searcher dashboard"]
  node_sharedui["Shared files<br/>[SharedFiles.jsx]"]
  node_adminui["Admin dashboard<br/>[AdminDashboard.jsx]"]
end

subgraph group_api["API workflows"]
  node_uploads["Upload pipeline<br/>[upload.js]"]
  node_search["Secure search<br/>[search.js]"]
  node_sharing["Sharing and access<br/>[share.js]"]
  node_auth["Authentication routes<br/>[auth.js]"]
  node_admin["Administration routes<br/>[admin.js]"]
  node_notify["Notifications API<br/>[notify.js]"]
end

subgraph group_security["Security services"]
  node_crypto["Cryptographic operations<br/>[crypto.js]"]
  node_compression["Compression<br/>[compress.js]"]
  node_fuzzy["Fuzzy matching<br/>[fuzzy.js]"]
  node_ranking["ATEES ranking<br/>[atees.js]"]
  node_otp["TOTP service<br/>[otp.js]"]
  node_email["Email delivery<br/>[email.js]"]
end

subgraph group_data["Persistent records"]
  node_users[("User records<br/>[User.js]")]
  node_files[("File records<br/>[File.js]")]
  node_index[("Encrypted index<br/>[EncryptedIndex.js]")]
  node_shares[("Share records<br/>[FileShare.js]")]
  node_requests[("Access requests")]
  node_searchlogs[("Search logs<br/>[SearchLog.js]")]
  node_notifications[("Notification records<br/>[Notification.js]")]
  node_auditrecords[("Audit records<br/>[AuditLog.js]")]
end

subgraph group_ops["Operations"]
  node_audit["Audit logging<br/>[audit.js]"]
  node_server["HTTP and socket server<br/>[server.js]"]
end

node_people(("Users"))
node_mongo[("MongoDB")]

node_people -->|"use"| node_app
node_app -->|"provides session"| node_session
node_session -->|"fetch profile"| node_clientapi
node_ownerui -->|"request APIs"| node_clientapi
node_searchui -->|"request APIs"| node_clientapi
node_sharedui -->|"request APIs"| node_clientapi
node_adminui -->|"request APIs"| node_clientapi
node_clientapi -.->|"HTTP requests"| node_server
node_server -->|"mounts route"| node_auth
node_server -->|"mounts route"| node_uploads
node_server -->|"mounts route"| node_search
node_server -->|"mounts route"| node_sharing
node_server -->|"mounts route"| node_admin
node_server -->|"mounts route"| node_notify
node_auth -->|"reads and updates"| node_users
node_auth -->|"generates and wraps keys"| node_crypto
node_auth -->|"verifies TOTP"| node_otp
node_auth -->|"creates alerts"| node_notifications
node_auth -->|"logs actions"| node_audit
node_uploads -->|"compresses content"| node_compression
node_uploads -->|"encrypts and indexes"| node_crypto
node_uploads -->|"stores file metadata"| node_files
node_uploads -->|"writes trapdoors"| node_index
node_uploads -->|"reads owner keys"| node_users
node_uploads -->|"audits requests"| node_audit
node_search -->|"generates trapdoors"| node_crypto
node_search -->|"matches fuzzy terms"| node_fuzzy
node_search -->|"queries trapdoors"| node_index
node_search -->|"counts and reads metadata"| node_files
node_search -->|"ranks matches"| node_ranking
node_search -->|"records hashed query"| node_searchlogs
node_sharing -->|"checks file access"| node_files
node_sharing -->|"manages shares"| node_shares
node_sharing -->|"manages requests"| node_requests
node_sharing -->|"creates notifications"| node_notifications
node_sharing -->|"sends email"| node_email
node_sharing -->|"audits requests"| node_audit
node_admin -->|"manages accounts"| node_users
node_admin -->|"reads file records"| node_files
node_admin -->|"reads index"| node_index
node_admin -->|"reads search activity"| node_searchlogs
node_admin -->|"reads audit history"| node_auditrecords
node_admin -->|"manages alerts"| node_notifications
node_notify -->|"reads and updates"| node_notifications
node_audit -->|"writes events"| node_auditrecords
node_server -->|"connects database"| node_mongo

click node_app "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/App.jsx"
click node_session "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/context/AuthContext.jsx"
click node_clientapi "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/api/api.js"
click node_ownerui "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/pages/OwnerDashboard.jsx"
click node_searchui "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/pages/SearcherDashboard.jsx"
click node_sharedui "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/pages/SharedFiles.jsx"
click node_adminui "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/pages/AdminDashboard.jsx"
click node_uploads "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/upload.js"
click node_search "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/search.js"
click node_sharing "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/share.js"
click node_auth "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/auth.js"
click node_admin "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/admin.js"
click node_notify "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/notify.js"
click node_crypto "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/crypto.js"
click node_compression "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/compress.js"
click node_fuzzy "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/fuzzy.js"
click node_ranking "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/atees.js"
click node_otp "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/otp.js"
click node_email "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/email.js"
click node_users "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/User.js"
click node_files "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/File.js"
click node_index "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/EncryptedIndex.js"
click node_shares "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/FileShare.js"
click node_requests "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/FileAccessRequest.js"
click node_searchlogs "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/SearchLog.js"
click node_notifications "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/Notification.js"
click node_audit "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/middleware/audit.js"
click node_auditrecords "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/AuditLog.js"
click node_server "https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/server.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_session,node_clientapi,node_ownerui,node_searchui,node_sharedui,node_adminui,node_people toneBlue
class node_uploads,node_search,node_sharing,node_auth,node_admin,node_notify,node_mongo toneAmber
class node_crypto,node_compression,node_fuzzy,node_ranking,node_otp,node_email toneMint
class node_users,node_files,node_index,node_shares,node_requests,node_searchlogs,node_notifications,node_auditrecords toneRose
class node_audit,node_server toneIndigo
```

## Components

### Role-based client

- [Role router](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/App.jsx): `pmrse-frontend/src/App.jsx`
- [Session state](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/context/AuthContext.jsx): `pmrse-frontend/src/context/AuthContext.jsx`
- [API client](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/api/api.js): `pmrse-frontend/src/api/api.js`
- [Owner dashboard](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/pages/OwnerDashboard.jsx): `pmrse-frontend/src/pages/OwnerDashboard.jsx`
- [Searcher dashboard](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/pages/SearcherDashboard.jsx): `pmrse-frontend/src/pages/SearcherDashboard.jsx`
- [Shared files](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/pages/SharedFiles.jsx): `pmrse-frontend/src/pages/SharedFiles.jsx`
- [Admin dashboard](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-frontend/src/pages/AdminDashboard.jsx): `pmrse-frontend/src/pages/AdminDashboard.jsx`

### API workflows

- [Upload pipeline](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/upload.js): `pmrse-backend/routes/upload.js`
- [Secure search](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/search.js): `pmrse-backend/routes/search.js`
- [Sharing and access](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/share.js): `pmrse-backend/routes/share.js`
- [Authentication routes](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/auth.js): `pmrse-backend/routes/auth.js`
- [Administration routes](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/admin.js): `pmrse-backend/routes/admin.js`
- [Notifications API](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/routes/notify.js): `pmrse-backend/routes/notify.js`

### Security services

- [Cryptographic operations](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/crypto.js): `pmrse-backend/utils/crypto.js`
- [Compression](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/compress.js): `pmrse-backend/utils/compress.js`
- [Fuzzy matching](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/fuzzy.js): `pmrse-backend/utils/fuzzy.js`
- [ATEES ranking](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/atees.js): `pmrse-backend/utils/atees.js`
- [TOTP service](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/otp.js): `pmrse-backend/utils/otp.js`
- [Email delivery](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/utils/email.js): `pmrse-backend/utils/email.js`

### Persistent records

- [User records](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/User.js): `pmrse-backend/models/User.js`
- [File records](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/File.js): `pmrse-backend/models/File.js`
- [Encrypted index](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/EncryptedIndex.js): `pmrse-backend/models/EncryptedIndex.js`
- [Share records](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/FileShare.js): `pmrse-backend/models/FileShare.js`
- [Access requests](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/FileAccessRequest.js): `pmrse-backend/models/FileAccessRequest.js`
- [Search logs](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/SearchLog.js): `pmrse-backend/models/SearchLog.js`
- [Notification records](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/Notification.js): `pmrse-backend/models/Notification.js`
- [Audit records](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/models/AuditLog.js): `pmrse-backend/models/AuditLog.js`

### Operations

- [Audit logging](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/middleware/audit.js): `pmrse-backend/middleware/audit.js`
- [HTTP and socket server](https://github.com/raaaj07/pmrse-final-project/blob/main/pmrse-backend/server.js): `pmrse-backend/server.js`

### Other components

- **Users**
- **MongoDB**

## Connections

- Users → Role router: use (evidence: `pmrse-frontend/src/App.jsx`)
- Role router → Session state: provides session (evidence: `pmrse-frontend/src/App.jsx`)
- Session state → API client: fetch profile (evidence: `pmrse-frontend/src/context/AuthContext.jsx`)
- Owner dashboard → API client: request APIs (evidence: `pmrse-frontend/src/pages/OwnerDashboard.jsx`)
- Searcher dashboard → API client: request APIs (evidence: `pmrse-frontend/src/pages/SearcherDashboard.jsx`)
- Shared files → API client: request APIs (evidence: `pmrse-frontend/src/pages/SharedFiles.jsx`)
- Admin dashboard → API client: request APIs (evidence: `pmrse-frontend/src/pages/AdminDashboard.jsx`)
- API client → HTTP and socket server: HTTP requests (evidence: `README.md`)
- HTTP and socket server → Authentication routes: mounts route (evidence: `pmrse-backend/server.js`)
- HTTP and socket server → Upload pipeline: mounts route (evidence: `pmrse-backend/server.js`)
- HTTP and socket server → Secure search: mounts route (evidence: `pmrse-backend/server.js`)
- HTTP and socket server → Sharing and access: mounts route (evidence: `pmrse-backend/server.js`)
- HTTP and socket server → Administration routes: mounts route (evidence: `pmrse-backend/server.js`)
- HTTP and socket server → Notifications API: mounts route (evidence: `pmrse-backend/server.js`)
- Authentication routes → User records: reads and updates (evidence: `pmrse-backend/routes/auth.js`)
- Authentication routes → Cryptographic operations: generates and wraps keys (evidence: `pmrse-backend/routes/auth.js`)
- Authentication routes → TOTP service: verifies TOTP (evidence: `pmrse-backend/routes/auth.js`)
- Authentication routes → Notification records: creates alerts (evidence: `pmrse-backend/routes/auth.js`)
- Authentication routes → Audit logging: logs actions (evidence: `pmrse-backend/routes/auth.js`)
- Upload pipeline → Compression: compresses content (evidence: `pmrse-backend/routes/upload.js`)
- Upload pipeline → Cryptographic operations: encrypts and indexes (evidence: `pmrse-backend/routes/upload.js`)
- Upload pipeline → File records: stores file metadata (evidence: `pmrse-backend/routes/upload.js`)
- Upload pipeline → Encrypted index: writes trapdoors (evidence: `pmrse-backend/routes/upload.js`)
- Upload pipeline → User records: reads owner keys (evidence: `pmrse-backend/routes/upload.js`)
- Upload pipeline → Audit logging: audits requests (evidence: `pmrse-backend/routes/upload.js`)
- Secure search → Cryptographic operations: generates trapdoors (evidence: `pmrse-backend/routes/search.js`)
- Secure search → Fuzzy matching: matches fuzzy terms (evidence: `pmrse-backend/routes/search.js`)
- Secure search → Encrypted index: queries trapdoors (evidence: `pmrse-backend/routes/search.js`)
- Secure search → File records: counts and reads metadata (evidence: `pmrse-backend/routes/search.js`)
- Secure search → ATEES ranking: ranks matches (evidence: `pmrse-backend/routes/search.js`)
- Secure search → Search logs: records hashed query (evidence: `pmrse-backend/routes/search.js`)
- Sharing and access → File records: checks file access (evidence: `pmrse-backend/routes/share.js`)
- Sharing and access → Share records: manages shares (evidence: `pmrse-backend/routes/share.js`)
- Sharing and access → Access requests: manages requests (evidence: `pmrse-backend/routes/share.js`)
- Sharing and access → Notification records: creates notifications (evidence: `pmrse-backend/routes/share.js`)
- Sharing and access → Email delivery: sends email (evidence: `pmrse-backend/routes/share.js`)
- Sharing and access → Audit logging: audits requests (evidence: `pmrse-backend/routes/share.js`)
- Administration routes → User records: manages accounts (evidence: `pmrse-backend/routes/admin.js`)
- Administration routes → File records: reads file records (evidence: `pmrse-backend/routes/admin.js`)
- Administration routes → Encrypted index: reads index (evidence: `pmrse-backend/routes/admin.js`)
- Administration routes → Search logs: reads search activity (evidence: `pmrse-backend/routes/admin.js`)
- Administration routes → Audit records: reads audit history (evidence: `pmrse-backend/routes/admin.js`)
- Administration routes → Notification records: manages alerts (evidence: `pmrse-backend/routes/admin.js`)
- Notifications API → Notification records: reads and updates (evidence: `pmrse-backend/routes/notify.js`)
- Audit logging → Audit records: writes events (evidence: `pmrse-backend/middleware/audit.js`)
- HTTP and socket server → MongoDB: connects database (evidence: `pmrse-backend/server.js`)
