webauthn

Web-Authentifizierungsspezifikation

Dies ist das Repository der W3C-WebAuthn-Arbeitsgruppe, die den Entwurf der „Web Authentication“ -Spezifikation erstellt.

• Die Kopie des Herausgebers ist unter https://w3c.github.io/webauthn/ oder im gh-pages -Zweig dieses Repositorys verfügbar.
  • Der aktuelle offiziell veröffentlichte Schnappschuss des Arbeitsentwurfs ist hier: https://www.w3.org/TR/webauthn/.
• Der Build-Verlauf ist auf der Registerkarte „Repo-Aktionen“ verfügbar
• W3C WebAuthn-Blog
• Repository für Webplattformtests

Mitwirken

Um einen wesentlichen Beitrag zu dieser Spezifikation zu leisten, müssen Sie die in CONTRIBUTING.md aufgeführten Anforderungen erfüllen. Bevor Sie Feedback absenden, machen Sie sich bitte außerdem mit unserer aktuellen Problemliste vertraut und lesen Sie die Diskussion in der Mailingliste.

Den Entwurf erstellen

Formatiertes HTML für den Entwurf kann mit bikeshed erstellt werden (Anweisungen zur bikeshed Installation finden Sie unten):

 $ bikeshed spec

Möglicherweise möchten Sie auch die watch nutzen, um automatisch neu zu generieren, wenn Sie Änderungen vornehmen:

 $ bikeshed watch

Installation und Einrichtung des Fahrradschuppens

Die vollständigen Anweisungen finden Sie unter https://tabatkins.github.io/bikeshed/#installing.

Sie müssen Python 3.7 oder höher installiert haben. Sobald Sie Python 3.7 oder höher installiert haben, führen Sie Folgendes aus, um Bikeshed selbst zu installieren:

 pip3 install bikeshed && bikeshed update

Wenn dies abgeschlossen ist, sollte Bikeshed installiert sein und der bikeshed -Befehl sollte in Ihrer Shell funktionieren.

Kontinuierliche Integration und Verzweigungen

https://w3c.github.io/webauthn/ wird bei jedem Push zum main mithilfe von https://github.com/w3c/webauthn/blob/main/.github/workflows/ automatisch vom gh-pages -Zweig veröffentlicht. build-validate-publish.yml, um das automatische Veröffentlichungsverhalten zu konfigurieren.

Erstellen eines neuen Arbeitsentwurfs

So erstellen Sie ein neues WD und laden es in das W3C-Veröffentlichungssystem hoch:

• Registrieren Sie sich als W3C-Mitglied und treten Sie der Arbeitsgruppe Webauthentifizierung bei. Notieren Sie sich Ihren W3C-BENUTZERNAMEN und Ihr W3C-PASSWORT, um sie im folgenden Befehl zu verwenden. Wenn Sie sich an keines davon erinnern, können Sie es hier abrufen.
• Kopieren Sie die URL des Sitzungsprotokolls, in dem die Arbeitsgruppe beschlossen hat, einen neuen Entwurf zu veröffentlichen, als DECISION_URL, um sie unten zu verwenden
• Stellen Sie sicher, dass Bikeshed lokal installiert ist (befolgen Sie den Abschnitt „Installation und Einrichtung von Bikeshed“ oben).
• Gehen Sie in das Verzeichnis ./bikeshed und aktualisieren Sie Bikeshed mit git pull.
• Führen Sie den folgenden Befehl aus, um die Datendateien von Bikeshed zu aktualisieren:

 bikeshed update

• Bearbeiten Sie die Bikeshed-Metadaten, um den Status von ED in WD zu ändern (diese Änderung nicht festschreiben)
• Stellen Sie sicher, dass Bikeshed ohne Fehler oder Warnungen kompiliert werden kann, indem Sie den folgenden Befehl ausführen:

 bikeshed spec

• Erstellen Sie den neuen Entwurf und laden Sie ihn hoch

 bikeshed echidna --u USERNAME --p PASSWORD --d DECISION_URL

Mit dem obigen Befehl wird ein Tarball des HTML-Codes und der Bilder erstellt und auf Echidna, das automatisierte Veröffentlichungssystem des W3C, hochgeladen. Der Befehl sollte eine URL zurückgeben, über die Sie erkennen können, ob Sie den Entwurf erfolgreich veröffentlicht haben. Der Status der Anfrage kann auch über das Mailinglistenarchiv verfolgt werden. Sie können auch die W3C-API verwenden, wie in der Echidna-Dokumentation beschrieben. Beachten Sie, dass dies unter Windows zu einer Fehlermeldung führt, dass eine temporäre Datei nicht gelöscht werden kann, weil sie von einem anderen Prozess verwendet wird. Dieser Fehler ist harmlos; Dies geschieht, nachdem die Übermittlung abgeschlossen ist.

Wenn die Veröffentlichung durch den Prozess nicht erfolgreich ist, liegt das wahrscheinlich an Specbreus, einem Prüfer für die Einhaltung von Spezifikationen. Echidna läuft automatisch über Specbreus und lehnt die Veröffentlichung ab, wenn Specbreus einen Fehler meldet. Sie können Ihr Dokument über Pubrules laufen lassen, um herauszufinden, warum Ihr Dokument abgelehnt wurde. Sie können entweder die Datei index.bs oder die Datei index.html ändern, um die Konformität sicherzustellen.

In den meisten Fällen werden Sie feststellen, dass die Pubrules-Fehler auf Fehler in Bikeshed oder Specbreus zurückzuführen sind. Wenn dies der Fall ist, müssen Sie die kompilierte Datei index.html ändern, um Echidna zu umgehen und den manuellen Prozess zum Veröffentlichen zu verwenden. Während Sie die HTML-Datei bearbeiten, um Fehler zu vermeiden, sollten Sie auch überprüfen, ob das Dokument weiterhin korrekt gerendert wird.

Für den manuellen Vorgang müssen Sie zunächst eine TAR-Datei erstellen. Um die TAR-Datei zu erstellen, müssen Sie zunächst die Datei index.html kopieren und die kopierte Datei in Overview.html umbenennen. Dies liegt daran, dass Echidna index.html nicht erkennt. Anschließend können Sie mit dem folgenden Befehl eine TAR-Datei erstellen:

 tar -cvf WD.tar Overview.html image1 image2 image3

Anschließend können Sie den folgenden Befehl „curl“ ausführen, um ihn auf Echidna zu veröffentlichen (verwenden Sie den Befehl im selben Verzeichnis wie Ihre TAR-Datei):

 curl 'https://labs.w3.org/echidna/api/request' --user '<username>:<password>' -F "[email protected]" -F "decision=<decisionUrl>"

Wenn Sie nicht weiterkommen, wenden Sie sich bitte an Ihren Lehrstuhl oder an einen W3C-Mitarbeiter. Allgemeine Informationen zu Echidna finden Sie hier: https://github.com/w3c/echidna/wiki und hier https://labs.w3.org/echidna/.

Sitzungsprotokolle führen

• Schreibanweisungen aus dem W3C-Handbuch
• Alternative Anweisungen der XML Security WG