✅ Firebase Google Login 기능

✅ secrets gradle plugin를 사용하여 local.properties 키 값 숨기기

https://firebase.google.com/docs/auth/android/google-signin?hl=ko

Firebase Authentication 공식 문서를 참고하여 구현하기로 했다.

하지만 해당 문서의 코드의 대부분이 deprecated 되었기에 아래의 공식 문서를 따라가기로 했다.

https://developer.android.com/identity/sign-in/credential-manager-siwg?hl=ko

위 공식 문서에서는 deprecated된 BeginSignInRequest 대신 Credential Manager 를 사용하라고 한다.

Credential Manager 에 대해서는 아래의 Google Developers에서 확인할 수 있었다.

https://developers.googleblog.com/ko/simple-and-secure-sign-in-on-android-with-credential-manager-and-passkeys/

Credential Manager는 Android 플랫폼의 미래형 인증 방식으로, 사용자가 앱과 웹사이트에 로그인하는 방식을 간소화하는 동시에 한층 강화된 보안을 제공한다.

비밀번호와 다양한 로그인 방식으로 인해 사용자와 개발자 모두에게 로그인 과정이 복잡해질 수 있다,

하지만 Credential Manager는 Android에서 패스워드리스 인증 방식(패스키)과 기존 로그인 방식을 하나의 인터페이스로 통합해 지원하고 이를 통해 보안성과 사용자 경험을 향상시키고 개발의 복잡성을 줄일 수 있다.

패스키로 패스워드리스 인증 지원하고 모든 계정을 단순한 인터페이스에서 탭 한 번으로 이용 가능하다.

위 이미지와 같이 동일 계정에 여러 로그인 방법이 있을 때, Credential Manager는 사용자에게 최적의 로그인 방식(패스키, 비밀번호 등)을 자동으로 선택해 제공한다.

사용자는 로그인 방식 대신 계정만 선택하면 나머지 과정이 자동으로 진행되므로 편리한 것이다.

가장 먼저 GetCredentialRequest 를 인스턴스화 한 후 addCredentialOption() 메서드를 사용해 CredentialOption 을 추가할 수 있다.

val request = GetCredentialRequest.Builder()
    .addCredentialOption(googleIdOption)
    .build()

CredentialOption 에 Google 웹 애플리케이션 Key값을 등록하거나 보안 강화, 자동 로그인 등의 옵션을 설정할 수 있다.

val googleIdOption = GetGoogleIdOption.Builder()
    .setFilterByAuthorizedAccounts(false)
    .setServerClientId(BuildConfig.google_web_key) //Web client td
    .setAutoSelectEnabled(false)
    .build()

사용자 인증 정보를 요청하기 위해서 CredentialManager 를 생성하고 getCredential() 메서드를 통해 인증을 요청한다.

해당 메서드의 파라미터 request에는 앞서 만들었던 GetCredentialRequest 를 넣어야 한다.

이 getCredential 함수는 suspendCancellableCoroutine 으로 실행되기에 코루틴으로 호출해야 하는 메서드이다.

suspendCancellableCoroutine 에 대해서는 아래 의문에서 잠깐 짚고 넘어갈 예정이다.

만약 위 API가 성공하면 GoogleIdTokenCredential 데이터의 결과가 포함된 CustomCredential 를 추출한다.

CustomCredential의 유형은 GoogleIdTokenCredential.TYPE_GOOGLE_ID_TOKEN_CREDENTIAL의 값과 같아야 한다. GoogleIdTokenCredential.createFrom 메서드를 사용하여 객체를 GoogleIdTokenCredential로 변환한다.

만약 변환에 성공하면 GoogleIdTokenCredential ID를 추출하고 검증한 후 서버에서 사용자 인증 정보를 인증한다.

GoogleIdTokenParsingException과 함께 변환에 실패하면 Google 계정으로 로그인 라이브러리 버전을 업데이트해야 할 수도 있다.

val googleIdTokenCredential = GoogleIdTokenCredential
    .createFrom(credential.data)
    
val firebaseCredential = GoogleAuthProvider.getCredential(
    googleIdTokenCredential.idToken,
    null
)

사용자가 로그인 한 구글 계정을 Firebase Authentication에 연결하기 위하여 FirebaseAuth를 생성하고 signInWithCredential() 메서드를 통해 연결한다.

이때 해당 인자로 위에서 GoogleAuthProvider.getCredential 메서드를 통해 추출했던 AuthCredential을 넘겨줘야 한다.

auth.signInWithCredential(firebaseCredential)
    .addOnCompleteListener { authResult ->
        if (authResult.isSuccessful) {
            trySend(AuthResponse.Success)
            val user = authResult.result.user
            user?.let { user ->
                Log.d("AuthenticationManager", "${user.email}")
            }

        } else {
            Log.d("AuthenticationManager", "${authResult.exception}")
        }
    }

FirebaseAuth 코드 생성 방법에는 아래와 같이 2가지 방법이 있다.

*private val* auth = FirebaseAuth.getInstance() 

*private val* auth = Firebase.*auth*

두 가지 방법의 차이는 무엇일까?

Firebase Authentication 초기 버전부터 사용되어 온 전통적인 방법이다.

FirebaseAuth.getInstance() 메서드를 호출하면 해당 프로젝트 내에서 유일한 FirebaseAuth 인스턴스를 반환한다.

Firebase SDK v9 버전부터 도입된 새로운 방식이다.

Firebase의 다양한 서비스(Authentication, Realtime Database, Cloud Firestore 등)를 통합적으로 관리하기 위한 Firebase 객체에 바로 접근하여 FireAuth 를 가져오는 방법이다.

💡 즉, Firebase.auth 방식이 최신 버전에서 더 간편하게 사용되는 방식이다.

suspendCancellableCoroutine 는 코루틴에서 비동기 작업을 수행할 때, 작업을 중단하고 결과를 기다리는 기능을 제공한다. 특히 suspendCancellableCoroutine 함수는 작업이 취소 될때 추가적인 처리를 수행하는 invokOnCancellation api를 제공한다.

주로 다른 라이브러리나 시스템에서 제공하는 콜백 기반의 비동기 API를 코루틴과 통합할 때 유용하게 사용된다.

https://firebase.google.com/docs/auth/android/google-signin?hl=ko#kotlin+ktx_1

Firebase Google Authentication 공식 문서를 보고 따라하려 했으나 예시 코드 중 BegingSignInRequest 부분이 deprecated 되었다.

BeginSignInRequest 대신 Credential Manager 를 사용하라는 안내 문구를 통해 수정하였다.

인증 관리자는 단일 API에서 사용자 이름과 비밀번호, 패스키, 제휴 로그인 솔류션(예: Google 계정으로 로그인)과 같은 멀티 로그인 방식을 지원하여 개발자를 위한 통합을 간소화하는 Jetpack API이다.

또한 인증 방식 전반에서 로그인 인터페이스를 통합하므로 사용자는 자신이 선택한 방식과 상관없이 더 명확하고 쉽게 앱에 로그인할 수 있다.

구글 로그인 코드를 작성하고 실행했지만, 앱이 바로 종료되는 문제가 발생

에러코드는 아래와 같다.

공식 문서 코드를 보며 따라하던 중 Cannot find a matching credentail 에러가 발생했다.

어떤 문제인가 검색하던 중 답을 찾을 수 있었다.

따라한 위의 공식 문서 코드 중 setFilterByAuthorizedAccounts(true) 부분에서 에러가 난 것이었다.

해당 함수의 파라미터를 true 로 설정하는 경우, 앱에 이미 인증된, 이전에 로그인한 구글 계정만 로그인할 수 있어, 한번도 인증하지 않은 경우에 위와 같은 에러가 발생하는 것이었다.

반면에, false 로 설정할 경우, 새로운 구글 계정도 앱에 로그인할 수 있도록 지원할 수 있다.

참고

https://stackoverflow.com/questions/61768804/getting-16-cannot-find-a-matching-credential-when-doing-one-tap-sign-in-and-s

https://developers.google.com/identity/one-tap/android/get-saved-credentials?hl=ko

위의 setFilterByAuthorizedAccounts 관련 문제를 해결한 후 실제 구글 로그인 계정을 선택하고 나서 로그인이 진행되던 도중 앱이 종료되고 아래와 같은 에러 메세지가 출력되었다.

https://stackoverflow.com/questions/77717346/androidx-credentials-exceptions-getcredentialcancellationexception-activity-is

https://medium.com/@primo8296/unlocking-doors-harnessing-credential-manager-for-seamless-logins-ebf7a8bcd172

위 참고 자료에서 답을 찾을 수 있었다.

My findings says that, if we use OAuth Client ID generated using application type Android, then it will not work and generate this exception

즉, GetGoogleIdOption.setServerClientId(key: String) 에서 키 값으로 웹 어플리케이션 키 값을 넣어야 한다는 것이다.

이전에는 Google Cloud Console의 유형에서 Android 유형의 클라이언트 ID를 사용했었는데, 이것을 웹 애플리케이션 클라이언트 ID를 사용해야한다는 것이었다.

이는 공식문서에도 나온 내용이다.

공식문서를 꼼꼼히 읽지 않았기에 발생한 문제