quartz-community/encrypted-pages
1
0
Fork 0
mirror of https://github.com/quartz-community/encrypted-pages.git synced 2026-07-22 03:00:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
4 commits 1 branch 0 tags 254 KiB
TypeScript 96.8%
SCSS 3.2%
Find a file
saberzero1 4e26afa5b9
feat: support decryption in popovers 
- Add popover-hint class to encrypted container so popovers pick up the element
- Add MutationObserver to detect encrypted containers injected into the DOM
  (popovers append elements without firing nav/render events)
2026-03-12 20:25:53 +01:00
.github/workflows Initial commit 2026-03-12 19:20:13 +01:00
src feat: support decryption in popovers 2026-03-12 20:25:53 +01:00
test feat: implement encrypted pages plugin with AES-256-GCM encryption 2026-03-12 20:01:13 +01:00
types Initial commit 2026-03-12 19:20:13 +01:00
.eslintrc.json feat: implement encrypted pages plugin with AES-256-GCM encryption 2026-03-12 20:01:13 +01:00
.gitignore Initial commit 2026-03-12 19:20:13 +01:00
.prettierrc Initial commit 2026-03-12 19:20:13 +01:00
CHANGELOG.md Initial commit 2026-03-12 19:20:13 +01:00
LICENSE Initial commit 2026-03-12 19:20:13 +01:00
package-lock.json feat: implement encrypted pages plugin with AES-256-GCM encryption 2026-03-12 20:01:13 +01:00
package.json feat: implement encrypted pages plugin with AES-256-GCM encryption 2026-03-12 20:01:13 +01:00
README.md feat: implement encrypted pages plugin with AES-256-GCM encryption 2026-03-12 20:01:13 +01:00
tsconfig.json Initial commit 2026-03-12 19:20:13 +01:00
tsup.config.ts Initial commit 2026-03-12 19:20:13 +01:00
vitest.config.ts Initial commit 2026-03-12 19:20:13 +01:00

README.md

@quartz-community/encrypted-pages

Password-protected encrypted pages for Quartz v5.

How it works

This plugin uses build-time encryption with AES-256-GCM. Decryption happens on the client side using the Web Crypto API. Key derivation is handled by PBKDF2.

Installation

npx quartz plugin add github:quartz-community/encrypted-pages

Usage

Add a password field to the frontmatter of any page you want to encrypt.

---
title: My Secret Page
password: mysecretpassword
---

Configuration

quartz.config.ts

Import the plugin and add it to your configuration.

import * as ExternalPlugin from "./.quartz/plugins";

// In plugins.transformers:
ExternalPlugin.EncryptedPages({
  visibility: "icon",
  iterations: 600000,
  passwordField: "password",
});

// In plugins.filters:
ExternalPlugin.EncryptedPageFilter({ visibility: "icon" });

quartz.config.yaml

If you use the YAML configuration format:

- source: github:quartz-community/encrypted-pages
  enabled: true
  options:
    visibility: icon
    iterations: 600000
    passwordField: password

Component

Add the EncryptedPage component to your body layout in quartz.layout.ts.

Options

EncryptedPages (Transformer)

Option Type Default Description
visibility "visible" | "icon" | "hidden" "icon" How encrypted pages appear in graph, explorer, and backlinks. visible shows them normally. icon shows them with a lock indicator. hidden hides them.
iterations number 600000 PBKDF2 iteration count for key derivation. Higher counts are more secure but slower to unlock.
passwordField string "password" Frontmatter field name that holds the page password.

EncryptedPageFilter (Filter)

Option Type Default Description
visibility "visible" | "icon" | "hidden" "icon" Controls whether encrypted pages appear in search, RSS, and sitemap. hidden excludes them entirely.

EncryptedPage (Component)

Option Type Default Description
className string "encrypted-page-wrapper" CSS class for the component wrapper.

Security

  • AES-256-GCM encryption with 16-byte salt, 12-byte IV, and 16-byte auth tag.
  • PBKDF2 SHA-256 key derivation with 600,000 iterations by default.
  • No plaintext leakage. The file.data.text and file.data.description fields are stripped.
  • Passwords are stored per-page in frontmatter. Don't commit these to public repositories.
  • Session caching uses sessionStorage. It clears when the browser closes.
  • This is client-side encryption for a static site. The encrypted HTML is in the page source. This protects against casual browsing but not against a determined attacker with access to the source.

Password caching

The plugin uses sessionStorage to cache passwords. It enables an auto-try behavior when navigating between encrypted pages that share the same password.

Render event

After a page is decrypted, a render CustomEvent is dispatched. Other components like the graph, TOC, and explorer can then re-initialize and display the decrypted content.

License

MIT