dotcrypt 0.0.0-stage → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project follows
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-11-10
+
+### Added
+
+- `init`, `encrypt`, `decrypt`, `rotate-key` and `diff` commands for AES-256-GCM (scrypt) encrypted
+  `.env` files that are safe to commit to Git.
+- `ui` command: a local, token-protected web dashboard bound to `127.0.0.1`.
+- Overwrite protection with key-level diffs (values are never printed).
+- `encrypt --replace` to deliberately discard a vault file that is unreadable, belongs to another
+  environment, or uses a different password.
+- Passwords via interactive prompt, `DOTCRYPT_PASSWORD` / `DOTCRYPT_NEW_PASSWORD`, or flags.
+
+[Unreleased]: https://github.com/zubayerhimel/dotcrypt/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/zubayerhimel/dotcrypt/releases/tag/v1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 zubayerhimel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,347 @@
-# Temporary Holding Version
+# dotcrypt
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Securely sync multiple `.env` environments across machines **through your existing Git repository**.
+Plaintext env files stay local and git-ignored; only AES-256-GCM encrypted `.enc` files and a shared
+`.dotcrypt.json` configuration are committed.
+
+```
+.dotcrypt.json             <- committed: environments + file mappings (no secrets)
+.env.development           <- local only (git-ignored)
+.env.development.enc       <- committed: encrypted with AES-256-GCM
+.env.production            <- local only (git-ignored)
+.env.production.enc        <- committed
+```
+
+## Installation
+
+```bash
+npm install -g dotcrypt
+dotcrypt --help
+```
+
+### From source
+
+Requires Node.js **20.19+** (needed to build the dashboard; the CLI alone runs on 18.17+).
+
+```bash
+git clone https://github.com/zubayerhimel/dotcrypt.git
+cd dotcrypt
+npm run setup       # installs CLI + dashboard dependencies and builds the dashboard
+npm link            # exposes the `dotcrypt` command globally
+dotcrypt --help
+```
+
+`npm run setup` is the same as running these one by one:
+
+```bash
+npm install                 # CLI dependencies
+npm --prefix ui install     # dashboard dependencies
+npm run build:ui            # builds the dashboard into ui/dist
+```
+
+Re-run `npm run build:ui` after pulling changes to the dashboard code.
+
+> **Windows PowerShell:** if you get "running scripts is disabled on this system", use `npm.cmd`
+> instead of `npm` (e.g. `npm.cmd run setup`, `npm.cmd link`), or run the commands from Command Prompt.
+
+To uninstall the global link: `npm unlink -g dotcrypt`.
+
+## Quick start
+
+```bash
+cd path/to/your-project
+dotcrypt init        # creates .dotcrypt.json and updates .gitignore
+dotcrypt ui          # opens the dashboard in your browser
+```
+
+Prefer the terminal? Everything in the dashboard is also available as a CLI command (see below).
+
+## Commands
+
+| Command | Description |
+| --- | --- |
+| `init [-n name] [--envs a,b,c] [-d env] [-y] [-f]` | Create `.dotcrypt.json` and add ignore rules for plaintext env files to `.gitignore`. |
+| `encrypt [-e env] [-p password] [-f] [--replace]` | Encrypt the mapped local file (e.g. `.env.staging`) into its `.enc` file. |
+| `decrypt [-e env] [-p password] [-f]` | Decrypt the `.enc` file into the mapped local file. |
+| `rotate-key [-e env] [-o old] [-n new]` | Re-encrypt with a new password, a fresh salt and a fresh IV. |
+| `diff [-e env] [-p password] [--exit-code]` | Show **key names** that were added / removed / changed. Values are never printed. |
+| `ui [--port n] [--no-open]` | Open the local web dashboard (see below). |
+
+If `-e` is omitted you are prompted to pick an environment (non-interactive runs fall back to
+`defaultEnvironment`).
+
+### Supplying passwords
+
+Passwords are resolved in this order:
+
+1. CLI flag (`-p`, `-o`, `-n`) — works, but prints a warning because flags leak into shell
+   history and process listings.
+2. Environment variable — `DOTCRYPT_PASSWORD` (and `DOTCRYPT_NEW_PASSWORD` for the new
+   password in `rotate-key`). Recommended for CI.
+3. Interactive masked prompt (recommended for humans). New passwords must be at least 12
+   characters and are asked twice.
+
+### Overwrite protection
+
+- `decrypt` never silently replaces a local file that differs from the vault: it shows which keys
+  would be lost/changed and asks for confirmation. Use `--force` to skip the prompt.
+- `encrypt` shows a key-level summary of what will change in the vault and asks before
+  overwriting. If the files are identical, nothing is written (no Git churn).
+- `encrypt` **verifies your password against the existing `.enc` file**. This prevents a
+  teammate from accidentally re-encrypting a shared vault with a different password. Change
+  passwords with `rotate-key`. To deliberately discard a vault file that is unreadable, belongs to
+  another environment, or uses a different password, pass `--replace` (`--force` alone never does
+  this). When the password was typed at a prompt, you must re-enter it before the vault is replaced.
+- `init` refuses to overwrite an existing `.dotcrypt.json` without confirmation or `--force`.
+- Non-interactive sessions (CI, pipes) never prompt; they fail safely unless `--force` is given.
+
+### Exit codes
+
+| Code | Meaning |
+| --- | --- |
+| `0` | Success |
+| `1` | General error, aborted, or (`diff --exit-code`) differences found |
+| `2` | Wrong password or corrupted / tampered encrypted file |
+| `130` | Cancelled at a prompt (Ctrl+C) |
+
+## `.dotcrypt.json`
+
+```json
+{
+  "version": 1,
+  "vault": {
+    "name": "my-app",
+    "createdAt": "2026-11-07T06:00:00.000Z",
+    "cipher": "aes-256-gcm",
+    "kdf": "scrypt"
+  },
+  "defaultEnvironment": "development",
+  "environments": {
+    "development": { "file": ".env.development", "encryptedFile": ".env.development.enc" },
+    "staging":     { "file": ".env.staging",     "encryptedFile": ".env.staging.enc" },
+    "production":  { "file": ".env.production",  "encryptedFile": ".env.production.enc" }
+  }
+}
+```
+
+You may edit mappings by hand (e.g. `"file": "apps/api/.env"`). Validation rules:
+
+- Environment names: 1–64 chars of letters, digits, `-`, `_`.
+- Paths must be relative and stay inside the project (no absolute paths, no `..` escapes).
+- `encryptedFile` must end in `.enc`; `file` must not.
+- No two mappings may share a path (compared case-insensitively).
+
+Custom plaintext paths that the default `.env` / `.env.*` rules don't cover are added to
+`.gitignore` explicitly the next time you run `init`.
+
+## Team workflow
+
+**Project owner (once):**
+
+```bash
+dotcrypt init                     # creates .dotcrypt.json, updates .gitignore
+# create .env.development, .env.staging, ...
+dotcrypt encrypt -e development   # choose a strong password
+dotcrypt encrypt -e production    # use a *different* password per environment
+git add .dotcrypt.json .gitignore *.enc
+git commit -m "Add encrypted environments"
+```
+
+Share each environment's password **out of band** (password manager, not chat or the repo).
+
+**Teammate on a new machine:**
+
+```bash
+git pull
+dotcrypt decrypt -e development
+```
+
+**Changing a secret:**
+
+```bash
+git pull                                  # always start from the latest vault
+dotcrypt diff -e development       # see what differs before acting
+# edit .env.development
+dotcrypt encrypt -e development
+git add .env.development.enc && git commit -m "Update dev env" && git push
+```
+
+**Someone leaves the team / password leaked:**
+
+```bash
+dotcrypt rotate-key -e production
+git commit -am "Rotate production vault password" && git push
+```
+
+> ⚠️ Rotating the password does **not** revoke secrets. Anyone who had the old password can still
+> decrypt old versions of the `.enc` file from Git history. After a departure or leak, rotate the
+> **underlying secrets** (API keys, DB passwords) too, then re-encrypt.
+
+**Merge conflicts in `.enc` files:** encrypted files can't be merged textually. Resolve by taking
+one side (`git checkout --theirs .env.x.enc`), running `decrypt`, re-applying your changes to the
+plaintext file, and running `encrypt` again.
+
+**CI usage:**
+
+```bash
+DOTCRYPT_PASSWORD="$VAULT_PASSWORD_PRODUCTION" dotcrypt decrypt -e production --force
+```
+
+## Security architecture
+
+### Encrypted file format
+
+Each `.enc` file is a JSON envelope:
+
+```json
+{
+  "version": 1,
+  "algorithm": "aes-256-gcm",
+  "kdf": { "name": "scrypt", "N": 32768, "r": 8, "p": 1, "salt": "<base64, 32 bytes>" },
+  "iv": "<base64, 16 bytes>",
+  "metadata": {
+    "environment": "production",
+    "sourceFile": ".env.production",
+    "encryptedAt": "2026-11-07T06:00:00.000Z"
+  },
+  "authTag": "<base64, 16 bytes>",
+  "ciphertext": "<base64>"
+}
+```
+
+### Cryptographic design
+
+- **Cipher:** AES-256-GCM (authenticated encryption) via `node:crypto`, 128-bit auth tag
+  enforced with `authTagLength` on both encrypt and decrypt.
+- **Key derivation:** `crypto.scryptSync` → 256-bit key. Default cost `N=2^15, r=8, p=1`
+  (~32 MiB, OWASP baseline). Passwords are Unicode NFC-normalized so the same password works on
+  every OS/keyboard.
+- **Fresh randomness every run:** a new 32-byte salt and new 16-byte IV come from the CSPRNG
+  (`crypto.randomBytes`) on every `encrypt` and `rotate-key`. IVs are never fixed, reused, or
+  derived; because the key is also fresh per salt, (key, IV) reuse is cryptographically
+  negligible.
+- **Authenticated header (AAD):** the format version, algorithm, all KDF parameters, salt, IV,
+  and metadata (environment, source file, timestamp) are bound to the ciphertext as GCM
+  Additional Authenticated Data. Any modification — including swapping `staging.enc` into
+  `production.enc` or editing the environment label — fails authentication.
+- **Environment binding:** on decrypt, the authenticated `metadata.environment` must match the
+  requested environment.
+- **Downgrade / DoS resistance:** KDF parameters read from files are bounds-checked (N must be a
+  power of two in `[2^14, 2^20]`, `r ∈ [8, 32]`, `p ∈ [1, 16]`, memory ≤ 256 MiB). Base64 fields,
+  salt/IV/tag lengths, and file sizes (5 MiB) are strictly validated before any crypto runs.
+- **Uniform failure:** a wrong password and a tampered file produce the same error (GCM cannot and
+  should not distinguish them); no partial plaintext is ever written.
+- **Key hygiene:** derived keys, password byte buffers and plaintext buffers are zeroed after use
+  (best-effort in a garbage-collected runtime).
+
+### Filesystem safety
+
+- **Atomic writes:** output is written to an exclusive (`wx`) temp file, `fsync`ed, then renamed
+  over the target, so crashes never leave truncated `.env` or `.enc` files.
+- **Restrictive permissions:** decrypted plaintext files are created with mode `0600`.
+- **Path confinement:** all paths from `.dotcrypt.json` must resolve inside the project root.
+- **Symlink protection:** the tool refuses to read or write through symlinks, or through
+  symlinked directories that resolve outside the project. A malicious repository therefore can't
+  make `decrypt` overwrite e.g. `~/.bashrc`, or make `encrypt` pull `~/.ssh/id_rsa` into a
+  committed file.
+- **Git hygiene:** `init` appends `.env`, `.env.*` and `!.env.*.enc` (plus explicit entries for
+  custom paths) to `.gitignore` without touching existing rules. `encrypt`/`decrypt` warn loudly if
+  a plaintext file is tracked by Git or not ignored.
+- **No secret output:** `diff` and the overwrite summaries print key names only; key names are
+  sanitized of control characters to prevent terminal escape injection.
+
+### Threat model & limitations
+
+- Protects secrets **at rest in Git** (hosting provider, forks, leaked clones) against anyone
+  without the password.
+- Does **not** protect against a compromised developer machine, or against someone who holds the
+  password. Old ciphertexts in Git history remain decryptable with old passwords.
+- Security depends on password strength. Use long random passphrases from a password manager and a
+  separate password per environment.
+- Not a replacement for a full secrets manager (per-user access control, audit logs, automatic
+  rotation). It is designed for small, trusted teams.
+
+## Web dashboard
+
+### Opening the dashboard
+
+1. Make sure you ran `npm run setup` (or `npm run build:ui`) once in this repository.
+2. In a terminal, go to the project whose env files you want to manage (the folder with
+   `.dotcrypt.json`, or any folder if you want to create one from the dashboard).
+3. Run:
+
+   ```bash
+   dotcrypt ui                      # random free port, opens your browser
+   dotcrypt ui --port 4600          # fixed port
+   dotcrypt ui --no-open            # just print the URL
+   ```
+
+4. The terminal prints a URL like `http://127.0.0.1:53412/?token=3f9c…`. Your browser opens it
+   automatically; if it does not, copy the **full** URL (including `?token=`) into your browser.
+5. Leave the terminal open while you use the dashboard. Press **Ctrl+C** to stop it.
+
+Each run creates a new token, so old URLs stop working after a restart. If the page says
+"Session token missing or expired", open the URL from the current run again. If it says the
+dashboard assets are not built, run `npm run build:ui` in this repository.
+
+### What it does
+
+A local dashboard built with React, [shadcn/ui](https://ui.shadcn.com) (Base UI primitives) and
+Tailwind. It shows:
+
+- every environment in `.dotcrypt.json`: local file and vault file status, sizes, last-modified /
+  last-encrypted times, and the default environment
+- a health badge per environment (Synced, Local changed, Not encrypted, Not decrypted, Vault
+  unreadable, Plaintext tracked)
+- Git safety: whether plaintext files are ignored or (dangerously) tracked, whether `.enc` files are
+  committed, and a one-click fix for missing `.gitignore` rules
+- an activity log for the session
+
+You can initialize a vault, add environments, set the default, and run encrypt, decrypt, diff and
+rotate-key from the dashboard. Overwrites show the key-name diff and need confirmation, just like
+the CLI. The dashboard refreshes every 5 seconds, so changes made in the terminal or by `git pull`
+show up automatically.
+
+### Dashboard security model
+
+- **Loopback only.** The server binds to `127.0.0.1` and never to `0.0.0.0`.
+- **Per-run secret token.** A random 256-bit token is generated on every start and required as a
+  bearer token on every API call, compared in constant time. The browser moves it from the URL into
+  `sessionStorage` and removes it from the address bar. Do not share the printed URL.
+- **DNS-rebinding and CSRF protection.** Requests whose `Host` is not `127.0.0.1:<port>` or
+  `localhost:<port>` are rejected (421). Writes require `Content-Type: application/json`, a matching
+  `Origin`, and a same-origin `Sec-Fetch-Site`.
+- **Strict headers.** A restrictive CSP (`script-src 'self'`, `frame-ancestors 'none'`, …),
+  `X-Frame-Options: DENY`, `nosniff`, `no-referrer`, and `Cache-Control: no-store` on API responses.
+- **No secret values leave the server.** The API returns metadata and key names only. Passwords are
+  sent per request, held only in the tab's memory (the **Lock** button clears them), and never
+  stored in `localStorage` or on disk. Request bodies are capped at 64 KB.
+
+### Developing the dashboard
+
+```bash
+# terminal 1, inside any project with a vault
+dotcrypt ui --port 4600 --no-open        # note the token it prints
+# terminal 2, in this repository
+VAULT_API_PORT=4600 npm run dev:ui               # Vite on http://localhost:5173, /api is proxied
+# open http://localhost:5173/?token=<token>
+```
+
+UI code lives in `ui/src` (`App.tsx`, `components/`, `lib/api.ts`). Add more shadcn components with
+`npx shadcn@latest add <component>` from the `ui/` directory.
+
+## Development
+
+```bash
+npm install
+npm test
+```
+
+Source layout: `src/crypto.js` (envelope format and AES-256-GCM/scrypt), `src/config.js`
+(`.dotcrypt.json`), `src/utils.js` (filesystem and Git safety), `src/vault.js` (operations shared
+by the CLI and dashboard), `src/server.js` (dashboard server), `bin/cli.js` (Commander CLI) and
+`ui/` (dashboard).
+
+## License
+
+MIT