FlashPass

A secure P2P solution for sharing sensitive data without leaving traces
Read the docs »

Try Demo · Report Bug · Request Feature

Table of Contents

1. About
   • Key Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Security
5. Roadmap
6. Contributing
7. License
8. Contact

About

FlashPass is a modern, secure solution for sharing sensitive information like passwords between users. Using peer-to-peer technology and end-to-end encryption, FlashPass ensures your data is transmitted directly between devices without being stored on any servers.

Key Features

🔒 End-to-End Encryption

• All data is encrypted before transmission
• Only the recipient can decrypt the information

🔥 One time reading

• Once the link is opened once, the connexion is done.
• Password can only be red one time.

👥 Peer-to-Peer Architecture

• Direct device-to-device communication
• No intermediate servers storing your data

🌐 Easy to Use

• Clean, intuitive interface
• No account required
• Works in any modern browser

Built With

• - Global technology
• - Frontend framework
• - Encryption
• - P2P communication
• - Styling

(back to top)

Getting Started

To run FlashPass locally, follow these steps:

Prerequisites

• Node.js (v16 or higher)
• npm

  npm install npm@latest -g

Installation

1. Clone the repository

   git clone https://github.com/Naorah/flashpass.git

2. Install dependencies

   npm install

3. Create a .env file based on .env.example

   cp .env.example .env

4. Start the development server

   npm run dev

5. Start the development P2P signaling server

   node src/lib/signaling.js
   

(back to top)

Usage

1. Open FlashPass in your browser
2. Enter the sensitive data you want to share
3. Share the generated link with the recipient
4. Data is automatically destroyed after being read

For detailed examples and API documentation, please refer to the Documentation

(back to top)

Security

FlashPass takes security seriously:

• All encryption/decryption happens in the browser
• Uses modern cryptographic standards
• No data persistence
• Open source for security auditing

(back to top)

Roadmap

• Basic P2P password sharing
• End-to-end encryption
• One reader messages
• Homepage
• Contact page
• Privacy page
• Mobile apps
• Enterprise features

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Naorah - @Naorah

Project Link: https://github.com/Naorah/flashpass

Discord: lov3box

(back to top)