Dokumentation der peers Repo

Dieses Dokument beschreibt die Struktur und den Aufbau der Inhalte des peers Repositories, in dem wir unsere fastd Schlüssel verwalten. Die Anleitung, wie man darauf zugreift, gibt es hier.

Dateiname

Die Dateinamen sollten nach Möglichkeit aus einer Kette aussprechbarer Zeichen bestehen, sodass man sich im Zweifel über sie unterhalten kann. Ein unaussprechliches Pre- oder Suffix ist in Ordnung, solange der Schlüssel eindeutig durch die obig genannte Kette identifizierbar ist. Damit die Eindeutigkeit auch bei alten Dateisystemen gegeben bleibt, gelten folgende Einschränkungen:

• keine Umlaute
• keine Sonderzeichen und keine Leerzeichen außer _ - oder .
• nur Kleinschreibung
• 0640 Dateiattribute (keine executable-Bits)

Dateininhalt

Ein key-file folgt zuerst einmal der durch fastd festgelegten Struktur:

    key "1f35ad53d9a5fb9d5834e38912cccfe60d0b52a992a83e53e14994bc378fdd71";

Wobei die Folge in den Anführungszeichen einzigartig und 64 Zeichen lang sein muss.

Weiterführende Kommentare in der Datei sind durch ein "# " am Zeilenanfang zu Kennzeichnen und haben nichts in der ersten Zeile verloren.

Commit-Nachrichten

Von anderen Sprachen als Deutsch und Englisch ist grundsätzlich abzusehen.

Da das Eintragen der Schlüssel ein recht trivialer und häufiger Vorgang ist, reicht etwa

   added $Routername

oder

   $Routername hinzugefügt

Beim Umbenennen von Routern können die Betreiber optional Bescheid sagen.

Diese Info lassen wir in die Nachricht einfließen:

    renamed $Routername1 to $Routername2

oder

    $Routername1 zu $Routername2 umbenannt

Beim Entfernen ist immer ein Grund anzugeben. (Auch bei eigenen Geräten, um die Einheitlichkeit und Übersicht zu wahren.)

Zum Beispiel:

    removed $Routername - because the owners face is unpleasent to my eyes

Das Bannen von Schlüsseln (in der Theorie) bildet die Ausnahme zum Entfernen. Während die Datei genauso gelöscht wird wie beim Entfernen, beginnt die commit-message mit "banned":

    banned $Routername - because its owner belongs to the "Judean People's Front"

Änderungen

Änderungen an dieser Seite sind mit den Lesenden des keys-Verteilers abzustimmen