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

Kotlin

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

Java

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

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

Kotlin

val getCredRequest = GetCredentialRequest(
    listOf(getPasswordOption)
)

Java

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

3. Lancer le flux de connexion

Kotlin

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

Java

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

Ressources supplémentaires