Migrer de Smart Lock pour les mots de passe vers le Gestionnaire d'identifiants

Smart Lock pour les mots de passe, obsolète depuis 2022, a été supprimé du SDK Auth des services Google Play (com.google.android.gms:play-services-auth) . Pour limiter les modifications destructives susceptibles d'affecter les intégrations existantes, les fonctionnalités Smart Lock pour toutes les applications existantes du Play Store continueront de fonctionner correctement. Les nouvelles versions de l'application compilées avec le SDK mis à jour (com.google.android.gms:play-services-auth:21.0.0) ne pourront plus accéder à l'API Smart Lock pour les mots de passe et ne pourront plus être compilées. Tous les développeurs doivent migrer leurs projets Android pour utiliser le Gestionnaire d'identifiants dès que possible.

Avantages de la migration vers l'API Gestionnaire d'identifiants

Le Gestionnaire d'identifiants offre une API simple et unifiée qui permet de prendre en charge des fonctionnalités et des pratiques modernes tout en améliorant l'expérience d'authentification de vos utilisateurs :

  • Le Gestionnaire d'identifiants est entièrement compatible avec l'enregistrement des mots de passe et l'authentification. Ainsi, vos utilisateurs ne subiront aucune interruption lors de la migration de Smart Lock vers le Gestionnaire d'identifiants.
  • Le Gestionnaire d'identifiants prend en charge plusieurs méthodes de connexion, y compris les clés d'accès et les méthodes de connexion fédérée comme Se connecter avec Google, afin de renforcer la sécurité et de permettre la conversion si vous envisagez de prendre en charge l'une ou l'autre de ces méthodes à l'avenir.
  • À partir d'Android 14, le Gestionnaire d'identifiants prend en charge les fournisseurs de mots de passe et de clés d'accès tiers.
  • Le Gestionnaire d'identifiants offre une expérience utilisateur cohérente et unifiée pour toutes les méthodes d'authentification.

Options de migration :

Cas d'utilisation Recommandation
Enregistrer le mot de passe et se connecter avec le mot de passe enregistré Utilisez l'option de mot de passe du guide Connecter un utilisateur avec le Gestionnaire d'identifiants. Les étapes détaillées pour l'enregistrement des mots de passe et l'authentification sont décrites plus loin.
Se connecter avec Google Suivez le guide Intégrer le Gestionnaire d'identifiants à la fonctionnalité Se connecter avec Google.
Montrer l'indice de numéro de téléphone aux utilisateurs Utilisez l'API Phone Number Hint de Google Identity Services.

Se connecter avec des mots de passe à l'aide du Gestionnaire d'identifiants

Pour utiliser l'API Gestionnaire d'identifiants, suivez la procédure décrite dans la section Conditions préalables du guide dédié et effectuez les opérations suivantes :

Se connecter avec les mots de passe enregistrés

Pour récupérer les options de mots de passe associées au compte de l'utilisateur, procédez comme suit :

1. Initialiser le mot de passe et l'option d'authentification

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

2. Utiliser les options récupérées à l'étape précédente pour créer la requête de connexion

val getCredRequest = GetCredentialRequest(
    listOf(getPasswordOption)
)

3. Lancer le flux de connexion

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

Ressources supplémentaires