비밀번호 대용 Smart Lock에서 인증 관리자로 이전하기

2022년에 지원 중단된 비밀번호 대용 Smart Lock은 이제 Google Play 서비스 인증 SDK(com.google.android.gms:play-services-auth)에서 삭제됩니다. 기존 통합에 영향을 미칠 수 있는 브레이킹 체인지를 최소화하기 위해 Play 스토어에 있는 모든 기존 앱의 Smart Lock 기능이 계속 올바르게 작동합니다. 업데이트된 SDK(com.google.android.gms:play-services-auth:21.0.0)로 컴파일된 새 앱 버전은 더 이상 Smart Lock for Password API에 액세스할 수 없으며 성공적으로 빌드되지 않습니다. 모든 개발자는 최대한 빨리 인증 관리자를 사용하도록 Android 프로젝트를 이전해야 합니다.

Credential Manager API로 마이그레이션할 때의 이점

인증 관리자는 최신 기능과 관행을 지원하는 동시에 사용자의 인증 환경을 개선하는 단순한 통합 API를 제공합니다.

• 인증 관리자는 비밀번호 저장 및 인증을 완전히 지원합니다. 즉, 앱이 Smart Lock에서 인증 관리자로 이전하더라도 사용자에게 중단이 발생하지 않습니다.
• 인증 관리자는 패스키 및 Google 계정으로 로그인과 같은 제휴 로그인 방법을 포함한 멀티 로그인 방법 지원을 통합하여 보안을 강화하고 향후 지원하려는 경우 전환을 사용 설정합니다.
• Android 14부터 인증 관리자는 서드 파티 비밀번호 및 패스키 제공업체를 지원합니다.
• 인증 관리자는 모든 인증 방식에서 일관되고 통합된 사용자 환경을 제공합니다.

이전 옵션:

인증 관리자를 사용하여 비밀번호로 로그인하기

Credential Manager API를 사용하려면 인증 관리자 가이드의 기본 요건 섹션에 설명된 단계를 완료하고 다음을 실행해야 합니다.

• 필수 종속 항목 추가
• 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());
    }
}

추가 리소스

• 인증 관리자 샘플 참조
• 인증 관리자 Codelab
• 인증 관리자로 사용자 로그인 처리