Crypt.fyi

<p align="center"> <a href="https://crypt.fyi" target="_blank"> <img src="https://crypt.fyi/logo-light.svg" style="width: 100px;" alt="logo" /> </a> </p> <p align="center"> <a href="https://crypt.fyi" target="_blank">crypt.fyi</a> - A zero-knowledge, end-to-end encrypted secret sharing platform that enables secure and private transmission of sensitive data. </p> <p align="center"> <a href="https://www.osbytes.io" target="_blank" rel="noopener noreferrer" title="osbytes — open source bytes"> <img src="https://www.osbytes.io/badge.svg" alt="osbytes — open source bytes" width="24" height="24" /> </a> <a href="https://github.com/osbytes/crypt.fyi/actions/workflows/ci.yml" target="_blank"> <img src="https://github.com/osbytes/crypt.fyi/actions/workflows/ci.yml/badge.svg" alt="CI" /> </a> <a href="https://securityheaders.com/?q=https://www.crypt.fyi&followRedirects=on" target="_blank"> <img src="https://img.shields.io/badge/Security%20Headers-A-brightgreen" alt="Security Headers" /> </a> <a href="https://developer.mozilla.org/en-US/observatory/analyze?host=crypt.fyi" target="_blank"> <img src="https://img.shields.io/mozilla-observatory/grade-score/crypt.fyi" alt="Mozilla HTTP Observatory Grade" /> </a> <a href="https://bestpractices.coreinfrastructure.org/projects/9850" target="_blank"> <img src="https://bestpractices.coreinfrastructure.org/projects/9850/badge" alt="CII Best Practices" /> </a> <a href="https://github.com/osbytes/crypt.fyi/tree/main/packages/core/src/i18n/locales" target="_blank"> <img src="https://img.shields.io/badge/i18n-✓-blue?logo=translate" alt="i18n" /> </a> </p>

Features

• 🔐 End-to-end encryption using ML-KEM post-quantum cryptography
• 🛡️ 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 for interacting with the API
• 🧩 Chrome Extension
• 🐳 Docker images for the api server and web client
• 🌐 Internationalization support for multiple languages
  • Currently supported: View supported languages
  • Contributions welcome for new translations!

How It Works

1. Encryption key is generated on the client
2. Password is optionally provided
3. Encryption key and password are used to encrypt the secret
4. 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
5. The unique URL containing the decryption key is generated on the client
6. Share the URL with your recipient and separately the password if specified
7. 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
8. Optionally, the secret is automatically destroyed after being read in an atomic read & delete operation guaranteeing only one person can access the secret
9. If retrieval doesn't happen within the TTL, the secret is automatically destroyed

RFC

API Usage

OpenAPI Specification

Deployment

Docker

bashCopy
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

Development

1. Clone the repository
2. Enable Corepack:

   bashCopy
   corepack enable

3. Install dependencies:

   bashCopy
   yarn install

4. Set up environment variables (see .env.example)
5. Start the development server:

   bashCopy
   yarn run dev

Technical Stack

• Noble cryptography
• React
• shadcn/ui
• Node.js
• Fastify
• Redis
• OpenTelemetry

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

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 or Pull Request on GitHub.