Geschützer Bereich

Wenn du einen Bereich mit einem Passwort schützen möchtest, dann kannst du das protect-Element verwenden.

Der Inhalt wird beim Bauen mit AES-256-GCM verschlüsselt. Der Schlüssel wird mit PBKDF2 aus dem Passwort abgeleitet. Weder der Inhalt noch das Passwort stehen in der gebauten Seite — der Browser entschlüsselt erst, nachdem das Passwort eingegeben wurde.

Attribute

:::protect{password="hyperbook" description="Das Passwort ist der Name des Projekts."}
 
:smiley:
 
:::

Mit der id kannst du mehrere Bereiche verbinden.

:::protect{id="1" password="hyperbook" description="Das Passwort ist der Name des Projekts."}
 
:smiley:
 
:::
 
:::protect{id="1" password="hyperbook" description="Das Passwort ist der Name des Projekts."}
 
:apple:
 
:::

Benannte Passwörter

Statt ein Passwort überall zu wiederholen, kannst du es in eine Passwortliste schreiben und über seinen Namen verwenden. So änderst du es an einer Stelle, und die Datei mit den Passwörtern muss nicht in dein Repository.

:::protect{use="kapitel-3"}
 
Die Lösung.
 
:::

Ein Schlüssel ohne Wert lässt den Build fehlschlagen. Ein Tippfehler kann deinen Inhalt also nicht versehentlich hinter einem leeren Passwort veröffentlichen. Mit hyperbook passwords check siehst du, was fehlt.

Ganze Seiten und Abschnitte schützen

Ein :::protect-Block schützt einen Teil einer Seite. Um alles zu schützen, setzt du protect im Frontmatter einer Seite oder eines Abschnitts.

---
name: Lösungen
protect: kapitel-3
---

Bei einem Abschnitt — der index.md eines Ordners — erbt jede Seite und jeder Unterabschnitt darin den Schutz. Geschützte Einträge behalten ihren Platz in der Navigation und bekommen ein Schloss neben ihren Namen. So sehen Lesende, dass es die Seite gibt und dass sie ein Passwort braucht.

Ein Passwort öffnet den ganzen Abschnitt: Freigeschaltet wird nach der Seite oder dem Abschnitt, der protect gesetzt hat. Einmal eingegeben, sind alle erbenden Seiten offen. Ein Unterabschnitt mit eigenem protect wird getrennt freigeschaltet und bleibt zu.

Das Passwort für beide Demos unten ist hyperbook.

Zur Demo geschützte Seite →

Zur Demo geschützter Abschnitt →

Verschachtelung

Geschützte Bereiche lassen sich verschachteln. Der innere Bereich wird zuerst verschlüsselt. Das äußere Passwort gibt also nur den äußeren Inhalt frei — der innere fragt weiterhin nach seinem eigenen Passwort.

::::protect{use="schueler"}
 
Für die ganze Klasse sichtbar.
 
:::protect{use="lehrkraefte"}
 
Nur für Lehrkräfte sichtbar.
 
:::
 
::::

Was der Schutz leistet und was nicht

Geschützte Inhalte tauchen nicht im Suchindex und nicht in llms.txt auf. Überschriften innerhalb eines geschützten Bereichs erscheinen nicht im Inhaltsverzeichnis.

Bücher ohne Webserver

Zum Entschlüsseln nutzt der Browser die Web-Crypto-API. Die gibt es nur über https oder auf localhost. Ein Buch, das direkt von der Festplatte über eine file://-Adresse geöffnet wird, kann nichts entschlüsseln.

Wenn du dein Buch als Ordner weitergibst, setze protect.mode in deiner hyperbook.json auf obfuscate. Inhalt und Passwort stehen dann wie früher in der Seite — das versteckt den Inhalt vor einem flüchtigen Blick und vor sonst niemandem.

{
  "protect": {
    "mode": "obfuscate"
  }
}