Add DiscoverCredentials method

オープン
#136 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
linux, rust

調査の方向性

issue ではソースファイルもテストも指定されていません。まず、ここで参照されている WebAuthn silent-discovery のリファレンスと、ここで引用されている Android、Apple、Windows の credential API を確認し、次に cross-origin ルール、返されるメタデータ、D-Bus メソッドのコントラクトを明らかにしてください。提案された DiscoverCredentials API でこれらの設計上の問題が解決されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

enhancement

In order to support autofill scenarios, we need to provide a method that allows a user to silently discover the existence of credentials.

Some considerations on the design:

  • should we allow cross-origin requests (probably specific to credential type)? Is that even meaningful?
  • what data should we return?

Prior art

WebAuthn

DiscoverableCredentialMetadata includes the following fields:

{
  "type": "public-key",
  "id": "credentialID",
  "rpId": "example.com"
  "userHandle": "abcdefghi1n",
  "otherUI": ??
}

Android

I have no idea how Android allows browsers to do credential discovery.
docs

Apple

Browser API:

platformCredentials(
    forRelyingParty relyingParty: String
) async -> [ASAuthorizationWebBrowserPlatformPublicKeyCredential]

struct ASAuthorizationWebBrowserPlatformPublicKeyCredential {
  /// A string the person can supply to describe this credential.
  let customTitle: String

  /// The user name for the account associated with this credential.
  let name: String

  /// The name of the app that manages this credential, or “iCloud Keychain” if it’s the operating system.
  let providerName: String

  /// The relying party that issues challenges for this credential.
  let relyingParty: String

  /// A unique identifier for the user account at the relying party.
  let userHandle: Data

  /// The identifier the operating system uses for this credential.  
  let credentialID: Data
}

Returns metadata for passkey. Returns credential ID, RP ID, user ID, user name and provider name.

docs

Credential provider side:

ASCredentialProviderViewController.prepareCredentialList(
    for: [ASCredentialServiceIdentifier],
    requestParameters: ASPasskeyCredentialRequestParameters
)

docs

Receives a list of "service identifiers" (URL, domain or app ID), which the credential provider should use to pull up a list of for display.

Windows

typedef struct _WEBAUTHN_CREDENTIAL_DETAILS {
    // Version of this structure, to allow for modifications in the future.
    DWORD dwVersion;

    // Size of pbCredentialID.
    DWORD cbCredentialID;
    _Field_size_bytes_(cbCredentialID)
    PBYTE pbCredentialID;

    // RP Info
    PWEBAUTHN_RP_ENTITY_INFORMATION     pRpInformation;

    // User Info
    PWEBAUTHN_USER_ENTITY_INFORMATION   pUserInformation;

    // Removable or not.
    BOOL bRemovable;

    //
    // The following fields have been added in WEBAUTHN_CREDENTIAL_DETAILS_VERSION_2
    //

    // Backed Up or not.
    BOOL bBackedUp;

    //
    // The following fields have been added in WEBAUTHN_CREDENTIAL_DETAILS_VERSION_3
    //
    PCWSTR pwszAuthenticatorName;

    // The logo is expected to be in the svg format
    DWORD cbAuthenticatorLogo;
    _Field_size_bytes_(cbAuthenticatorLogo)
    PBYTE pbAuthenticatorLogo;

    // ThirdPartyPayment Credential or not.
    BOOL bThirdPartyPayment;

    //
    // The following fields have been added in WEBAUTHN_CREDENTIAL_DETAILS_VERSION_4
    //

    // Applicable Transports
    DWORD dwTransports;

} WEBAUTHN_CREDENTIAL_DETAILS, *PWEBAUTHN_CREDENTIAL_DETAILS;
typedef const WEBAUTHN_CREDENTIAL_DETAILS *PCWEBAUTHN_CREDENTIAL_DETAILS;

typedef struct _WEBAUTHN_GET_CREDENTIALS_OPTIONS {
    // Version of this structure, to allow for modifications in the future.
    DWORD dwVersion;

    // Optional.
    LPCWSTR pwszRpId;

    // Optional. BrowserInPrivate Mode. Defaulting to FALSE.
    BOOL bBrowserInPrivateMode;
} WEBAUTHN_GET_CREDENTIALS_OPTIONS, *PWEBAUTHN_GET_CREDENTIALS_OPTIONS;
typedef const WEBAUTHN_GET_CREDENTIALS_OPTIONS *PCWEBAUTHN_GET_CREDENTIALS_OPTIONS;


HRESULT
WINAPI
WebAuthNGetPlatformCredentialList(
    _In_    PCWEBAUTHN_GET_CREDENTIALS_OPTIONS                  pGetCredentialsOptions,
    _Outptr_result_maybenull_ PWEBAUTHN_CREDENTIAL_DETAILS_LIST *ppCredentialDetailsList);

docs

Allows retrieving credential metadata by RP ID, with flag for browser private mode. Returns credential ID, RP ID, user ID and other information.

主要言語
Rust
スター
310
フォーク
22
平均マージ
1日 15時間
マージ済み PR(30日)
13

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

linux-credentials/credentialsd のほかの issue

linux-credentials/credentialsd の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。