https://github.com/markeljan/webterm
Web based decentralized terminal secured with FHE
https://github.com/markeljan/webterm
encryption fhe terminal web webterm webterminal
Last synced: 4 months ago
JSON representation
Web based decentralized terminal secured with FHE
- Host: GitHub
- URL: https://github.com/markeljan/webterm
- Owner: Markeljan
- License: mit
- Created: 2024-08-31T19:54:39.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-08T20:12:14.000Z (8 months ago)
- Last Synced: 2024-11-25T21:24:28.062Z (6 months ago)
- Topics: encryption, fhe, terminal, web, webterm, webterminal
- Language: Solidity
- Homepage: https://webterm.app
- Size: 785 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebTerm: Confidential Decentralized File System
ETHGlobal 2024 ETHOnline Hackathon Submission
## Project Concept
This project implements a decentralized, privacy-preserving file system using Web3 technologies, Fully Homomorphic Encryption (FHE), and IPFS. It provides users with a familiar file system interface while leveraging blockchain for authentication and secure metadata storage, and IPFS for decentralized file storage.
## Key Features:
Web3 Authentication: Users connect and sign in using their blockchain wallet.
Privacy-Preserving: Utilizes FHENIX FHE for encrypting user data on the blockchain.
Decentralized Storage: Files are stored on IPFS, with encrypted references on the blockchain.
Familiar Interface: Mimics a traditional file system with directories and files.
Access Control: Supports both public and private files/directories.
Confidential String Storage: Demonstrates encrypted string storage and retrieval.
Author Verification: Verify content creators without revealing identities.
# [Youtube Demo](https://www.youtube.com/watch?v=v-gEywUzMeE) | [Live Demo](https://webterm.app)
# System Flow
The following diagram illustrates the high-level flow of the system:
```mermaid
sequenceDiagram
participant User
participant Frontend
participant Smart Contract
participant IPFS
User->>Frontend: Connect wallet
Frontend->>User: Request signature
User->>Frontend: Sign message
Frontend->>Smart Contract: Verify signature
Smart Contract->>Frontend: Authentication success
Frontend->>Smart Contract: Request encrypted user data
Smart Contract->>Frontend: Return encrypted data
Frontend->>User: Decrypt data locally
User->>Frontend: Request file operation
Frontend->>IPFS: Store/Retrieve file
IPFS->>Frontend: File data
Frontend->>User: Display file/directory
```
## How It Works
1. **Authentication**: Users connect their Web3 wallet and sign a message to prove ownership.
2. **Data Retrieval**: Upon successful authentication, encrypted user data is fetched from the blockchain.
3. **Local Decryption**: User data is decrypted client-side using the user's private key.
4. **File Operations**:
- File metadata and structure are stored on the blockchain using FHE.
- Actual file contents are stored on IPFS.
- Encrypted IPFS CIDs are stored on the blockchain.
5. **Access Control**: The smart contract manages file ownership and public/private status.
## Getting Started
- Visit [WebTerm](https://webterm.app) and connect your wallet.
- Register to store and access FHE encrypted files.
- Upload files to IPFS and store the encrypted CIDs on the blockchain.
- Setup public or private directories and files. Manage access permissions directly onchain.
## Technologies Used
- Blockchain: FHENIX Helium Testnet
- Smart Contract: Solidity
- Frontend: Next.js
- Fully Homomorphic Encryption: FHENIXs
- Decentralized Storage: IPFS (not implemented)