https://github.com/lleny/proton-drive-bridge
A cross-platform FTP server bridge for Proton Drive
https://github.com/lleny/proton-drive-bridge
ftp proton proton-drive protondrive
Last synced: 7 days ago
JSON representation
A cross-platform FTP server bridge for Proton Drive
- Host: GitHub
- URL: https://github.com/lleny/proton-drive-bridge
- Owner: LLeny
- License: gpl-3.0
- Created: 2025-09-13T07:10:46.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2025-09-21T09:44:28.000Z (16 days ago)
- Last Synced: 2025-09-21T10:06:33.303Z (16 days ago)
- Topics: ftp, proton, proton-drive, protondrive
- Language: Rust
- Homepage:
- Size: 214 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Proton Drive Bridge
A FTP server bridge for Proton Drive, built on top of [libunftp](https://github.com/bolcom/libunftp), allowing you to access your Proton Drive files using any FTP client.
**Note**: This software was built empirically, and different account settings or unknown parameters may trigger unplanned behaviors. Use with caution and report any issues you encounter.
**Note**: Currently supports single Proton account access only - multi-user drive support is not yet implemented.
> ⚠️ **IMPORTANT DISCLAIMER**: This is NOT an official Proton application. This is a third-party project not affiliated with or endorsed by Proton AG. Use this
software at your own risk. The developers are not responsible for any data loss, security issues, or other problems that may arise from using this software. Always ensure you understand the security implications before entering your Proton credentials.
---
## FTP Client Recommendations
For best results:
- **Use only one thread** in your FTP client (disable parallel transfers).
- **Set the command timeout** to a sufficiently long period to avoid disconnects during large operations.
## Features
- Secure access to Proton Drive via HTTPS
- Support for 2FA authentication
- **Supported FTP Commands**:
- `LS` - List directory contents
- `MKD` - Make directory
- `RMD` - Remove directory
- `RM` - Delete file
- `MV` - Rename file/directory
- `GET` - Download file
- `PUT` - Upload file
- Proton Drive Photos share mapped
## Prerequisites
- Rust (latest stable version recommended)
- Docker (for containerized deployment)
- Proton account
## Building from Source
1. Clone the repository:
```bash
git clone https://github.com/LLeny/proton-drive-bridge.git
cd proton-drive-bridge
```
2. Build the project:
```bash
cargo build --release
```
The binary will be available at `target/release/proton-drive-bridge`
## Usage
### Command Line
```bash
proton-drive-bridge --cli [OPTIONS]
```
#### Options:
- `-u, --username `: Proton account email (or set `PROTON_USERNAME` environment variable)
- `-p, --password `: Proton account password (or set `PROTON_PASSWORD` environment variable)
- `--auth-file `: Path to JSON file containing user credentials (default: "users.json")
- `--port `: Port to listen on (default: 2121)
- `--greeting `: Server greeting message
- `--tls`: Enable FTPS (requires certificate and key)
- `--cert `: Path to certificate file (PEM format, required with --tls)
- `--key `: Path to private key file (PEM format, required with --tls)
- `-c, --cli`: Run in CLI mode (no UI). Short form `-c` is accepted.
Notes:
- In CLI mode, if `--username/--password` (or `PROTON_USERNAME/PROTON_PASSWORD`) are not provided, you will be prompted interactively on stdin.
- When using `--tls`, both `--cert` and `--key` must be provided.
### Example
```bash
proton-drive-bridge --cli -u ftpusername --port 2121
```
With environment variables:
```bash
PROTON_USERNAME=you@example.com PROTON_PASSWORD='yourpass' proton-drive-bridge --cli --port 2121
```
### Bridge Session Password (CLI)
When running with `--cli`, the application maintains a local encrypted "bridge session" vault so you don’t have to re-enter your Proton username/password every time:
- On first run, you will be prompted to create a bridge session password. This password is used to derive a salted key that encrypts your local session vault (which stores access/refresh tokens and session data). The input is hidden (no echo).
- On subsequent runs, you’ll be prompted only for this bridge session password (hidden). The app will unlock the vault and refresh your Proton tokens automatically. If refresh fails, it falls back to a full login and updates the vault.
- To reset the saved session, delete the key from your OS keyring and/or remove the app’s config file (location depends on your OS), then run again to create a new session.
## User Authentication
The server uses JSON-based authentication. By default, it looks for a `users.json` file in the current directory.
### users.json Format
Default credentials (username: `user`, password: `mypassword`):
```json
[
{
"username": "user",
"pbkdf2_salt": "Nq8roLd6+Tw=",
"pbkdf2_key": "jlfERENxed6K3QuTB9tVIaR/Brrx780sYUuNP8uvVcY=",
"pbkdf2_iter": 500000
}
]
```
> **Security Note**: The default credentials are for testing only. Please change the password before deploying to production.
### Password Hashing
Passwords must be PBKDF2 encoded. You can generate a password using:
```bash
salt=$(dd if=/dev/random bs=1 count=8)
echo -n "mypassword" | nettle-pbkdf2 -i 500000 -l 32 --hex-salt $(echo -n $salt | xxd -p -c 80) --raw |openssl base64 -A
echo -n $salt | openssl base64 -A
```
Details in the unftp_auth_jsonfile documentation: https://docs.rs/unftp-auth-jsonfile/0.3.6/unftp_auth_jsonfile/
### Command Line
Specify a custom users file:
```bash
proton-drive-bridge --cli --auth-file /path/to/users.json
```
### Environment Variables
- `PROTON_USERNAME`: Your Proton account email
- `PROTON_PASSWORD`: Your Proton account password
## Proton Drive Photos Share
- The Proton Drive Photos share is available under the `/drive_photos` directory.
- Any folder you create inside `/drive_photos` will appear as an **album** in Proton Drive.
- **Albums cannot be nested:** You cannot create albums inside other albums (only one level of albums is supported).
- When you upload a photo to an album, it will **also be uploaded to `/drive_photos`**.
- When you delete a photo from an album, it will **also be deleted from `/drive_photos`**.
## Security Notes
- The bridge requires your Proton credentials to function - ensure you trust the environment where you run it
## License
This project is licensed under the [GPLv3 License](LICENSE).
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.