webauthn

Web認証仕様

これは、 「Web 認証」仕様の草案を作成する W3C WebAuthn Working Group のリポジトリです。

• 編集者のコピーは、https://w3c.github.io/webauthn/ またはこのリポジトリのgh-pagesブランチから入手できます。
  • 現在公式に公開されている作業草案のスナップショットは、https://www.w3.org/TR/webauthn/ にあります。
• ビルド履歴は、リポジトリの [アクション] タブから利用できます。
• W3C WebAuthn ブログ
• Web プラットフォーム テスト リポジトリ

貢献する

この仕様に実質的に貢献するには、CONTRIBUTING.md に概説されている要件を満たす必要があります。また、フィードバックを送信する前に、現在の問題リストをよく理解し、メーリング リストのディスカッションを確認してください。

草案の作成

ドラフト用にフォーマットされた HTML はbikeshedを使用して構築できます ( bikeshedインストール手順については以下を参照してください)。

 $ bikeshed spec

また、 watch機能を使用して、変更を加えたときに自動的に再生成することもできます。

 $ bikeshed watch

自転車置き場の設置とセットアップ

完全な手順については、https://tabatkins.github.io/bikeshed/#installing を参照してください。

Python 3.7 以降がインストールされている必要があります。 Python 3.7 以降をインストールしたら、Bikeshed 自体をインストールするには、次のコマンドを実行します。

 pip3 install bikeshed && bikeshed update

それが完了すると、Bikeshed がインストールされ、 bikeshedコマンドがシェルで機能するはずです。

継続的インテグレーションとブランチ

https://w3c.github.io/webauthn/ は、https://github.com/w3c/webauthn/blob/main/.github/workflows/ を使用して、 mainブランチにプッシュされるたびにgh-pagesブランチから自動公開されます。 build-validate-publish.yml を使用して自動公開動作を構成します。

新しい作業草案の作成

新しい WD を構築して W3C パブリッシング システムにアップロードするには:

• W3C メンバーとして登録し、Web 認証ワーキング グループに参加してください。以下のコマンドで使用する W3C ユーザー名とパスワードを書き留めてください。どちらかを覚えていない場合は、ここにアクセスして取得してください。
• 作業グループが新しい草案を公開することを決定した会議議事録の URL を、以下で使用する DECISION_URL としてコピーします。
• Bikeshed がローカルにインストールされていることを確認します (上記の Bikeshed のインストールとセットアップのセクションに従ってください)。
• ./bikeshed ディレクトリに移動し、git pull を使用して Bikeshed を更新します。
• 次のコマンドを実行して、Bikeshed のデータファイルを更新します。

 bikeshed update

• Bikeshed メタデータを編集してステータスを ED から WD に変更します (この変更はコミットしないでください)
• 次のコマンドを実行して、Bikeshed がエラーや警告なしでコンパイルできることを確認します。

 bikeshed spec

• 新しいドラフトを作成してアップロードします。

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

上記のコマンドは、HTML と画像の tarball を作成し、W3C の自動公開システムである Echidna にアップロードします。このコマンドは URL を返します。これにより、ドラフトが正常に公開されたかどうかを知ることができます。リクエストのステータスは、メーリング リスト アーカイブを通じて追跡することもできます。 Echidna のドキュメントで説明されているように、W3C API を使用することもできます。 Windows では、一時ファイルが別のプロセスで使用されているために削除できないというエラーが表示されることに注意してください。このエラーは無害です。送信が完了した後に発生します。

このプロセスによる公開が失敗した場合は、仕様準拠チェッカーである Specbreus が原因である可能性があります。 Echidna は Specbreus を介して自動的に実行され、Specbreus によってエラーが報告された場合はパブリケーションを拒否します。 Pubrules を通じてドキュメントを実行すると、ドキュメントが拒否された理由を理解できます。準拠を確保するために、index.bs ファイルまたはindex.html ファイルを変更できます。

多くの場合、Pubrules エラーは Bikeshed または Specbreus のバグが原因であることがわかります。その場合は、コンパイルされたindex.htmlファイルを変更してEchidnaをバイパスし、手動プロセスを使用して公開する必要があります。エラーを避けるために HTML ファイルを編集しているときは、ドキュメントが正しくレンダリングされていることも確認する必要があります。

手動プロセスでは、まず tar ファイルを作成する必要があります。 tar ファイルを作成するには、まず、index.html ファイルをコピーし、コピーしたファイルの名前を Overview.html に変更する必要があります。これはエキドナがindex.htmlを認識していないためです。次に、次のコマンドを使用して tar ファイルを作成できます。

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

次に、次のコマンドcurlを実行してEchidnaに公開します(このコマンドはtarファイルと同じディレクトリで使用します)。

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

行き詰まった場合は、議長または W3C スタッフにお気軽にお問い合わせください。エキドナに関する全体的な情報は、https://github.com/w3c/echidna/wiki および https://labs.w3.org/echidna/ にあります。

会議の議事録を作成する

• W3C ガイドブックの Scribe 手順
• XMLセキュリティWGからの代替指示