https://github.com/osbytes/crypt.fyi
Ephemeral, zero-knowledge, end-to-end encrypted sensitive data sharing
https://github.com/osbytes/crypt.fyi
e2ee encryption-tool extension-chrome file-sharing one-time pastebin privacy privacy-tools railway-template secrets security-tools self-hosted self-hosting zero-knowledge zk
Last synced: 3 months ago
JSON representation
Ephemeral, zero-knowledge, end-to-end encrypted sensitive data sharing
- Host: GitHub
- URL: https://github.com/osbytes/crypt.fyi
- Owner: osbytes
- License: apache-2.0
- Created: 2024-12-15T17:12:31.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-05T01:01:07.000Z (3 months ago)
- Last Synced: 2025-04-05T01:28:47.168Z (3 months ago)
- Topics: e2ee, encryption-tool, extension-chrome, file-sharing, one-time, pastebin, privacy, privacy-tools, railway-template, secrets, security-tools, self-hosted, self-hosting, zero-knowledge, zk
- Language: TypeScript
- Homepage: https://crypt.fyi
- Size: 2.33 MB
- Stars: 95
- Watchers: 0
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-repositories - osbytes/crypt.fyi - Ephemeral, zero-knowledge, end-to-end post-quantum encrypted sensitive data sharing (TypeScript)
README
crypt.fyi - A zero-knowledge, end-to-end encrypted secret sharing platform that enables secure and private transmission of sensitive data.
## Features
- 🔐 End-to-end encryption using AES-256-GCM
- 🛡️ Strict Content Security Policy (CSP) to prevent XSS attacks and unauthorized resource loading
- 🛡️ Strict rate limits to mitigate brute-force attacks
- 🤫 Zero-knowledge architecture - server never sees unencrypted data or decryption keys
- 🔥 Burn after reading w/ provisions to prevent erroneous burns from bots or url introspection
- 🔥 Burn after `n` read failures
- ⏰ Automatic expiration (Time-To-Live)
- 🗝️ Password protection
- 📁 File sharing support w/ drag and drop
- 🪝 Webhook notifications for read success, read failure, and burn events
- 🌐 IP/CIDR allow-listing
- 🔢 Read count limits
- 📱 QR code generation
- ⌨️ [CLI](https://www.npmjs.com/package/@crypt.fyi/cli) for interacting with the API
- 🧩 [Chrome Extension](https://chromewebstore.google.com/detail/cryptfyi/hkmbmkjfjfdbpohlllleaacjkacfhald)
- 🐳 Docker images for the api server and web client
- 🌐 Internationalization support for multiple languages
- Currently supported: [View supported languages](https://github.com/osbytes/crypt.fyi/tree/main/packages/core/src/i18n/locales)
- Contributions welcome for new translations!
## How It Works
1. Encryption key is generated on the client
1. Password is optionally provided
1. Encryption key and password are used to encrypt the secret
1. Encryption key and password are **hashed** and stored along with the encrypted secret for verification on retrieval - the raw key and password are **never** stored or transmitted on/to the server
1. The unique URL containing the decryption key is generated on the client
1. Share the URL with your recipient and separately the password if specified
1. When accessed, only when the decryption key and password match via server-side verification of the hashes, the encrypted secret is shared and decrypted in the recipient's browser
1. Optionally, the secret is automatically destroyed after being read in an atomic read & delete operation guaranteeing only one person can access the secret
1. If retrieval doesn't happen within the TTL, the secret is automatically destroyed
[RFC](./SPECIFICATION.md)
## API Usage
[OpenAPI Specification](https://api.crypt.fyi/docs)
## Deployment
### Docker
```bash
API_URL=https://{your-domain-here} docker compose up --build
```
> [!IMPORTANT]
> `--build` is required if `API_URL` is changed to ensure nginx and the web client are rebuilt with the correct configuration.
### Railway
[](https://railway.com/template/Pmkrsc?referralCode=ToZEjF)
## Development
1. Clone the repository
2. Enable Corepack:
```bash
corepack enable
```
3. Install dependencies:
```bash
yarn install
```
4. Set up environment variables (see `.env.example`)
5. Start the development server:
```bash
yarn run dev
```
## Technical Stack
- [Noble cryptography](https://paulmillr.com/noble/)
- [React](https://react.dev/)
- [shadcn/ui](https://ui.shadcn.com/docs)
- [Node.js](https://nodejs.org/en)
- [Fastify](https://fastify.dev/)
- [Redis](https://redis.io/)
- [OpenTelemetry](https://opentelemetry.io/)
## Known Issues & Development Considerations
### Content Security Policy
- The toast notification library (sonner) requires specific style-src hashes in the CSP configuration
- These hashes are defined in `nginx/nginx.conf`
- Updates to sonner may require updating these hashes
- Reference: [sonner#449](https://github.com/emilkowalski/sonner/issues/449)
### Development Environment
- Ensure Redis is running locally when developing the server
- The web client expects the API to be available at `http://localhost:4321` by default
- CSP headers in development may differ from production configuration
### Security Considerations
- Always test encryption/decryption flows thoroughly when making changes
- Ensure no sensitive data is logged or exposed in error messages
- Maintain strict CSP headers to prevent XSS vulnerabilities
- Keep dependencies updated for security patches
## Contributing
Contributions are welcome! Please feel free to submit an [Issue](https://github.com/osbytes/crypt.fyi/issues) or [Pull Request](https://github.com/osbytes/crypt.fyi/pulls) on [GitHub](https://github.com/osbytes/crypt.fyi).