Smart Lock for Passwords から認証情報マネージャーに移行する

2022 年にサポートが終了した Smart Lock for Passwords は、Google Play 開発者サービス Auth SDK（com.google.android.gms:play-services-auth）から削除されています。既存の統合に影響する可能性がある、互換性を破る変更を最小限に抑えるため、Google Play ストアのすべての既存アプリでの Smart Lock 機能は、引き続き正常に動作します。更新済みの SDK（com.google.android.gms:play-services-auth:21.0.0）でコンパイルされた新しいアプリ バージョンは、Smart Lock for Password API にアクセスできなくなり、正常にビルドされなくなります。すべてのデベロッパーは、できる限り速やかに認証情報マネージャーを使用するよう、Android プロジェクトを移行する必要があります。

Credential Manager API に移行するメリット

認証情報マネージャーはシンプルな Unified API で、最新の機能とプラクティスをサポートすると同時に、ユーザーの認証エクスペリエンスを改善します。

• 認証情報マネージャーは完全にパスワードの保存と認証をサポートしています。つまり、アプリを Smart Lock から認証情報マネージャーに移行しても、ユーザーは中断なくアプリを使用できます。
• 認証情報マネージャーには、パスキーや Google でログインのようなフェデレーション ログイン メソッドなど、複数のログイン メソッドのサポートが統合されています。今度どちらかをサポートする予定の場合には、セキュリティを強化でき、変換が可能です。
• Android 14 以降、認証情報マネージャーはサードパーティのパスワードおよびパスキー プロバイダをサポートしています。
• 認証情報マネージャーは、すべての認証方法で一貫性のある統合されたユーザー エクスペリエンスを実現します。

移行オプション

ユースケース	推奨事項
パスワードを保存し、保存したパスワードを使用してログインする	認証情報マネージャーを使用してユーザーのログインを行うのガイドのパスワード オプションを使用します。パスワードの保存と認証の詳細な手順については、後ほど説明します。
Google でログイン	認証情報マネージャーを「Google でログイン」と統合するのガイドに沿って操作します。
ユーザーに電話番号のヒントを表示する	Google Identity Services の Phone Number Hint API を使用します。

認証情報マネージャーを使用してパスワードでログインする

Credential Manager API を使用するには、認証情報マネージャー ガイドの前提条件セクションに記載されている手順を実施し、次の操作を行ってください。

• 必要な依存関係を追加する
• ProGuard ファイルでクラスを保持する
• デジタル アセット リンクのサポートを追加する（Smart Lock for Passwords を使用している場合は、この手順はすでに実装されています）
• 認証情報マネージャーを設定する
• 認証情報フィールドを指定する
• ユーザーのパスワードを保存する

保存したパスワードでログインする

ユーザーのアカウントに関連付けられているパスワードのオプションを取得する手順は次のとおりです。

1. パスワードと認証オプションを初期化します。

// Retrieves the user's saved password for your app from their
// password provider.
val getPasswordOption = GetPasswordOption()

2. 前の手順で取得したオプションを使用してログイン リクエストを作成します。

val getCredRequest = GetCredentialRequest(
    listOf(getPasswordOption)
)

3. ログインフローを開始します。

fun launchSignInFlow() {
    coroutineScope.launch {
        try {
            // Attempt to retrieve the credential from the Credential Manager.
            val result = credentialManager.getCredential(
                // Use an activity-based context to avoid undefined system UI
                // launching behavior.
                context = activityContext,
                request = getCredRequest
            )

            // Process the successfully retrieved credential.
            handleSignIn(result)
        } catch (e: GetCredentialException) {
            // Handle any errors that occur during the credential retrieval
            // process.
            handleFailure(e)
        }
    }
}

private fun handleSignIn(result: GetCredentialResponse) {
    // Extract the credential from the response.
    val credential = result.credential

    // Determine the type of credential and handle it accordingly.
    when (credential) {
        is PasswordCredential -> {
            val username = credential.id
            val password = credential.password

            // Use the extracted username and password to perform
            // authentication.
        }

        else -> {
            // Handle unrecognized credential types.
            Log.e(TAG, "Unexpected type of credential")
        }
    }
}

private fun handleFailure(e: GetCredentialException) {
    // Handle specific credential retrieval errors.
    when (e) {
        is GetCredentialCancellationException -> {
            /* This exception is thrown when the user intentionally cancels
                the credential retrieval operation. Update the application's state
                accordingly. */
        }

        is GetCredentialCustomException -> {
            /* This exception is thrown when a custom error occurs during the
                credential retrieval flow. Refer to the documentation of the
                third-party SDK used to create the GetCredentialRequest for
                handling this exception. */
        }

        is GetCredentialInterruptedException -> {
            /* This exception is thrown when an interruption occurs during the
                credential retrieval flow. Determine whether to retry the
                operation or proceed with an alternative authentication method. */
        }

        is GetCredentialProviderConfigurationException -> {
            /* This exception is thrown when there is a mismatch in
                configurations for the credential provider. Verify that the
                provider dependency is included in the manifest and that the
                required system services are enabled. */
        }

        is GetCredentialUnknownException -> {
            /* This exception is thrown when the credential retrieval
                operation fails without providing any additional details. Handle
                the error appropriately based on the application's context. */
        }

        is GetCredentialUnsupportedException -> {
            /* This exception is thrown when the device does not support the
                Credential Manager feature. Inform the user that credential-based
                authentication is unavailable and guide them to an alternative
                authentication method. */
        }

        is NoCredentialException -> {
            /* This exception is thrown when there are no viable credentials
                available for the user. Prompt the user to sign up for an account
                or provide an alternative authentication method. Upon successful
                authentication, store the login information using
                androidx.credentials.CredentialManager.createCredential to
                facilitate easier sign-in the next time. */
        }

        else -> {
            // Handle unexpected exceptions.
            Log.w(TAG, "Unexpected exception type: ${e::class.java.name}")
        }
    }
}

参考情報

• 認証情報マネージャーのサンプル リファレンス
• 認証情報マネージャーの Codelab
• 認証情報マネージャーを使用してユーザーのログインを行う