Skip to content

A Bitwarden-compatible server for Cloudflare Workers

License

Notifications You must be signed in to change notification settings

sdsdsdff/warden-worker

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

110 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Warden: A Bitwarden-compatible server for Cloudflare Workers

Powered by Cloudflare License Deploy to Cloudflare Workers

This project provides a self-hosted, Bitwarden-compatible server that can be deployed to Cloudflare Workers for free. It's designed to be low-maintenance, allowing you to "deploy and forget" without worrying about server management or recurring costs.

Why another Bitwarden server?

While projects like Vaultwarden provide excellent self-hosted solutions, they still require you to manage a server or VPS. This can be a hassle, and if you forget to pay for your server, you could lose access to your passwords.

Warden aims to solve this problem by leveraging the Cloudflare Workers ecosystem. By deploying Warden to a Cloudflare Worker and using Cloudflare D1 for storage, you can have a completely free, serverless, and low-maintenance Bitwarden server.

Features

  • Core Vault Functionality: Create, read, update, and delete ciphers and folders.
  • File Attachments: Optional Cloudflare R2 storage for attachments.
  • TOTP Support: Store and generate Time-based One-Time Passwords.
  • Bitwarden Compatible: Works with official Bitwarden clients.
  • Free to Host: Runs on Cloudflare's free tier.
  • Low Maintenance: Deploy it once and forget about it.
  • Secure: Your encrypted data lives in your Cloudflare D1 database.
  • Easy to Deploy: Get up and running in minutes with the Wrangler CLI.

Attachments Support

Warden supports file attachments using Cloudflare R2 storage. Attachments are optional and require manual configuration to enable. See the deployment guide for setup details. Be aware that R2 may incur additional costs; see Cloudflare R2 pricing.

Current Status

This project is not yet feature-complete, and it may never be. It currently supports the core functionality of a personal vault, including TOTP. However, it does not support the following features:

  • Sharing
  • 2FA login (except TOTP)
  • Bitwarden Send
  • Device and session management
  • Emergency access
  • Admin operations
  • Organizations
  • Other Bitwarden advanced features

There are no immediate plans to implement these features. The primary goal of this project is to provide a simple, free, and low-maintenance personal password manager.

Compatibility

  • Browser Extensions: Chrome, Firefox, Safari, etc. (Tested 2025.11.1 on Chrome)
  • Android App: The official Bitwarden Android app. (Tested 2025.11.0)
  • iOS App: The official Bitwarden iOS app. (Tested 2025.11.0)

Demo

A demo instance is available at warden.qqnt.de.

You can register a new account using an email ending with @warden-worker.demo (The email does not need verification).

If you decide to stop using the demo instance, please delete your account to make space for others.

It's highly recommended to deploy your own instance since the demo can hit the rate limit and be disabled by Cloudflare.

Getting Started

Frontend (Web Vault)

The frontend is bundled with the Worker using Cloudflare Workers Static Assets. The GitHub Actions workflow automatically downloads the latest bw_web_builds (Vaultwarden web vault) and deploys it together with the backend.

How it works:

  • Static files (HTML, CSS, JS) are served directly by Cloudflare's edge network.
  • API requests (/api/*, /identity/*) are routed to the Rust Worker.
  • No separate Pages deployment or domain configuration needed.

Note

Migrating from separate frontend deployment? If you previously deployed the frontend separately to Cloudflare Pages, you can delete the warden-frontend Pages project and re-setup the router for the worker. The frontend is now bundled with the Worker and no longer requires a separate deployment.

[!WARNING] The web vault frontend comes from Vaultwarden and therefore exposes many advanced UI features, but most of them are non-functional. See Current Status.

Configure Custom Domain (Optional)

The default *.workers.dev domain is disabled by default, since it may throw 1101 error. You can enable it by setting workers_dev = true in wrangler.toml.

If you want to use a custom domain instead of the default *.workers.dev domain, follow these steps:

Step 1: Add DNS Record

  1. Log in to Cloudflare Dashboard
  2. Select your domain (e.g., example.com)
  3. Go to DNSRecords
  4. Click Add record:
    • Type: A (or AAAA for IPv6)
    • Name: your subdomain (e.g., vault for vault.example.com)
    • IPv4 address: 192.0.2.1 (this is a placeholder, the actual routing is handled by Worker)
    • Proxy status: Proxied (orange cloud icon - this is required!)
    • TTL: Auto
  5. Click Save

⚠️ Important: The Proxy status must be "Proxied" (orange cloud). If it shows "DNS only" (gray cloud), Worker routes will not work.

Step 2: Add Worker Route

  1. Go to Workers & Pages → Select your warden-worker
  2. Click SettingsDomains & Routes
  3. Click AddRoute
  4. Configure the route:
    • Route: vault.example.com/* (replace with your domain)
    • Zone: Select your domain zone
    • Worker: warden-worker
  5. Click Add route

Built-in Rate Limiting

This project includes rate limiting powered by Cloudflare's Rate Limiting API. Sensitive endpoints are protected:

Endpoint Rate Limit Key Type Purpose
/identity/connect/token 5 req/min Email address Prevent password brute force
/api/accounts/register 5 req/min IP address Prevent mass registration & email enumeration
/api/accounts/prelogin 5 req/min IP address Prevent email enumeration

You can adjust the rate limit settings in wrangler.toml:

[[ratelimits]]
name = "LOGIN_RATE_LIMITER"
namespace_id = "1001"
# Adjust limit (requests) and period (10 or 60 seconds)
simple = { limit = 5, period = 60 }

[!NOTE] The period must be either 10 or 60 seconds. See Cloudflare documentation for details.

If the binding is missing, requests proceed without rate limiting (graceful degradation).

Configuration

Configure environment variables in wrangler.toml under [vars], or set them via Cloudflare Dashboard:

  • TRASH_AUTO_DELETE_DAYS (Optional, Default: 30):
    • Days to keep soft-deleted items before purge.
    • Set to 0 or negative to disable.
  • IMPORT_BATCH_SIZE (Optional, Default: 30):
    • Batch size for import/delete operations.
    • 0 disables batching.
  • DISABLE_USER_REGISTRATION (Optional, Default: true):
    • Controls showing the registration button in the client UI (server behavior unchanged).
  • AUTHENTICATOR_DISABLE_TIME_DRIFT (Optional, Default: false):
    • Set to true to disable ±1 time step drift for TOTP validation.
  • ATTACHMENT_MAX_BYTES (Optional):
    • Max size for individual attachment files.
    • Example: 104857600 for 100MB.
  • ATTACHMENT_TOTAL_LIMIT_KB (Optional):
    • Max total attachment storage per user in KB.
    • Example: 1048576 for 1GB.
  • ATTACHMENT_TTL_SECS (Optional, Default: 300):
    • TTL for attachment upload/download URLs.

Scheduled Tasks (Cron)

The worker runs a scheduled task to clean up soft-deleted items. By default, it runs daily at 03:00 UTC (wrangler.toml [triggers] cron "0 3 * * *"). Adjust as needed; see Cloudflare Cron Triggers documentation for cron expression syntax.

Database Operations

  • Backup & restore: See Database Backup & Restore for automated backups and manual restoration steps.
  • Time Travel: See D1 Time Travel to restore to a point in time.
  • Local dev with D1:
    • Quick start: wrangler dev --persist
    • Full stack (with web vault): download frontend assets as in deployment doc, then wrangler dev --persist
    • Import a backup locally: wrangler d1 execute vault1 --file=backup.sql
    • Inspect local DB: SQLite file under .wrangler/state/v3/d1/

Local Development with D1

Run the Worker locally with D1 support using Wrangler.

Quick start (API-only):

wrangler dev --persist

Full stack (with Web Vault):

  1. Download the frontend assets (see deployment doc).

  2. Start locally:

    wrangler dev --persist
  3. Access the vault at http://localhost:8787.

Using production data temporarily:

  1. Download and decrypt a backup (see backup doc).

  2. Import locally without --remote:

    wrangler d1 execute vault1 --file=backup.sql
  3. Start wrangler dev --persist and point clients to http://localhost:8787.

Inspect local SQLite:

ls .wrangler/state/v3/d1/
sqlite3 .wrangler/state/v3/d1/miniflare-D1DatabaseObject/*.sqlite

[!NOTE] Local dev requires Node.js and Wrangler. The Worker runs in a simulated environment via workerd.

Contributing

Issues and PRs are welcome. Please run cargo fmt and cargo clippy --target wasm32-unknown-unknown --no-deps before submitting.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

A Bitwarden-compatible server for Cloudflare Workers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 92.9%
  • JavaScript 7.1%