Переход с Smart Lock для паролей на Диспетчер учетных данных

Функция Smart Lock for Passwords , устаревшая в 2022 году, теперь удалена из SDK Google Play Services Auth SDK ( com.google.android.gms:play-services-auth ). Чтобы свести к минимуму критические изменения, которые могут повлиять на существующие интеграции, возможности Smart Lock для всех существующих приложений в Play Store продолжат работать правильно. Новые версии приложений, скомпилированные с использованием обновленного SDK ( com.google.android.gms:play-services-auth:21.0.0 ), больше не имеют доступа к API Smart Lock для пароля и не будут успешно собраны. Всем разработчикам следует как можно скорее перенести свои проекты Android на использование Credential Manager .

Преимущества перехода на Credential Manager API

Диспетчер учетных данных предлагает простой унифицированный API, который обеспечивает поддержку современных функций и методов, одновременно улучшая процесс аутентификации для ваших пользователей:

• Credential Manager полностью поддерживает сохранение паролей и аутентификацию . Это означает, что ваши пользователи не будут прерывать работу при переходе вашего приложения с Smart Lock на Credential Manager.
• Диспетчер учетных данных интегрирует поддержку нескольких методов входа, включая ключи доступа и методы федеративного входа, такие как «Вход через Google» , чтобы повысить безопасность и включить преобразование, если вы планируете поддерживать любой из них в будущем.
• Начиная с Android 14, Credential Manager поддерживает сторонних поставщиков паролей и ключей доступа.
• Диспетчер учетных данных обеспечивает единообразный и унифицированный пользовательский интерфейс для всех методов аутентификации.

Варианты миграции :

Войдите в систему с помощью паролей с помощью диспетчера учетных данных.

Чтобы использовать Credential Manager API, выполните действия, описанные в разделе «Предварительные требования» руководства Credential Manager, и обязательно выполните следующие действия:

• Добавьте необходимые зависимости
• Сохранять классы в файле ProGuard
• Добавьте поддержку ссылок на цифровые активы (этот шаг должен быть уже реализован, если вы используете Smart Lock для паролей).
• Настройка диспетчера учетных данных
• Укажите поля учетных данных
• Сохраните пароль пользователя

Войдите с сохраненными паролями

Чтобы получить параметры пароля, связанные с учетной записью пользователя, выполните следующие действия:

1. Инициализируйте пароль и опцию аутентификации.

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

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

2. Используйте параметры, полученные на предыдущем шаге, для создания запроса на вход.

val getCredRequest = GetCredentialRequest(
    listOf(getPasswordOption)
)

GetCredentialRequest getCredRequest = new GetCredentialRequest.Builder()
    .addCredentialOption(getPasswordOption)
    .build();

3. Запустите процесс входа.

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)
    }
}

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}")
        }
    }
}

credentialManager.getCredentialAsync(
    // Use activity based context to avoid undefined
    // system UI launching behavior
    activity,
    getCredRequest,
    cancellationSignal,
    <executor>,
    new CredentialManagerCallback<GetCredentialResponse, GetCredentialException>() {
        @Override
        public void onSuccess(GetCredentialResponse result) {
            handleSignIn(result);
        }

        @Override
        public void onFailure(GetCredentialException e) {
            handleFailure(e);
        }
    }
);

public void handleSignIn(GetCredentialResponse result) {
    // Handle the successfully returned credential.
    Credential credential = result.getCredential();
    if (credential instanceof PasswordCredential) {
        String username = ((PasswordCredential) credential).getId();
        String password = ((PasswordCredential) credential).getPassword();
        // Use ID and password to send to your server to validate and
        // authenticate
    } else {
        // Catch any unrecognized credential type here.
        Log.e(TAG, "Unexpected type of credential");
    }
}

public void handleFailure(GetCredentialException e) {
    if (e instanceof GetCredentialCancellationException) {
        /* During the get credential flow, this is thrown when a user
        intentionally cancels an operation. When this happens, the application
        should handle logic accordingly, typically under indication the user
        does not want to see Credential Manager anymore. */
    } else if (e instanceof GetCredentialCustomException) {
        /* Represents a custom error thrown during a get flow with
        CredentialManager. If you get this custom exception, you should match
        its type against exception constants defined in any third-party sdk
        with which you used to make the
        androidx.credentials.GetCredentialRequest, and then handle it
        according to the sdk recommendation. */
    } else if (e instanceof GetCredentialInterruptedException) {
        /* During the get credential flow, this is thrown when some
        interruption occurs that may warrant retrying or at least does not
        indicate a purposeful desire to close or tap away from Credential
        Manager. */
    } else if (e instanceof GetCredentialProviderConfigurationException) {
        /* During the get credential flow, this is thrown when configurations
        are mismatched for the provider, typically indicating the provider
        dependency is missing in the manifest or some system service is not
        enabled. */
    } else if (e instanceof GetCredentialUnknownException) {
        // This is thrown when the get credential operation failed with no
        // more details.
    } else if (e instanceof GetCredentialUnsupportedException) {
        /* During the get credential flow, this is thrown when credential
        manager is unsupported, typically because the device has disabled it
        or did not ship with this feature enabled. */
    } else if (e instanceof NoCredentialException) {
        /* During the get credential flow, this is returned when no viable
        credential is available for the user. This can be caused by various
        scenarios such as that the user doesn't have any credential or the
        user doesn't grant consent to using any available credential. Upon
        this exception, your app should navigate to use the regular app
        sign-up or sign-in screen. When that succeeds, you should invoke
        androidx.credentials.CredentialManager.createCredentialAsync to store
        the login info, so that your user can sign in more easily through
        Credential Manager the next time. */
    } else {
        Log.w(TAG, "Unexpected exception type " + e.getClass().getName());
    }
}

Дополнительные ресурсы

• Образец справочника по диспетчеру учетных данных
• Кодовая лаборатория диспетчера учетных данных
• Войдите в систему с помощью Credential Manager.