Google은 흑인 공동체를 위한 인종적 평등을 추구하기 위해 노력하고 있습니다. 자세히 알아보기

Android에서 OpenID Connect를 사용하여 인증

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

Identity Platform을 사용한 Firebase 인증으로 업그레이드한 경우 선택한 OIDC(OpenID Connect) 호환 제공업체를 사용하여 Firebase로 사용자를 인증할 수 있습니다. 이렇게 하면 Firebase에서 기본적으로 지원하지 않는 ID 공급자를 사용할 수 있습니다.

시작하기 전에

OIDC 공급자를 사용하여 사용자를 로그인하려면 먼저 공급자로부터 몇 가지 정보를 수집해야 합니다.

  • 클라이언트 ID : 앱을 식별하는 공급자 고유의 문자열입니다. 공급자는 지원하는 각 플랫폼에 대해 다른 클라이언트 ID를 할당할 수 있습니다. 이는 공급자가 발급한 ID 토큰의 aud 클레임 값 중 하나입니다.

  • Client secret : 공급자가 클라이언트 ID의 소유권을 확인하는 데 사용하는 비밀 문자열입니다. 모든 클라이언트 ID에 대해 일치하는 클라이언트 암호가 필요합니다. (이 값은 인증 코드 흐름 을 사용하는 경우에만 필요하며 강력히 권장됩니다.)

  • Issuer : 공급자를 식별하는 문자열입니다. 이 값은 /.well-known/openid-configuration 이 추가될 때 공급자의 OIDC 검색 문서의 위치인 URL이어야 합니다. 예를 들어 발급자가 https://auth.example.com 인 경우 검색 문서는 https://auth.example.com/.well-known/openid-configuration 에서 사용할 수 있어야 합니다.

위의 정보를 얻은 후 Firebase 프로젝트의 로그인 공급자로 OpenID Connect를 활성화합니다.

  1. Android 프로젝트에 Firebase를 추가합니다 .

  2. Identity Platform을 사용한 Firebase 인증으로 업그레이드하지 않았다면 업그레이드하세요. OpenID Connect 인증은 업그레이드된 프로젝트에서만 사용할 수 있습니다.

  3. Firebase 콘솔의 로그인 공급자 페이지에서 새 공급자 추가 를 클릭한 다음 OpenID Connect 를 클릭합니다.

  4. 인증 코드 흐름 또는 암시적 권한 부여 흐름 을 사용할지 여부를 선택합니다.

    공급자가 지원하는 경우 항상 코드 흐름을 사용해야 합니다 . 암시적 흐름은 덜 안전하며 사용하지 않는 것이 좋습니다.

  5. 이 제공자에게 이름을 지정하십시오. oidc.example-provider 와 같이 생성된 공급자 ID를 확인합니다. 앱에 로그인 코드를 추가할 때 이 ID가 필요합니다.

  6. 클라이언트 ID와 클라이언트 암호, 공급자의 발급자 문자열을 지정합니다. 이러한 값은 공급자가 할당한 값과 정확히 일치해야 합니다.

  7. 변경 사항을 저장합니다.

Firebase SDK로 로그인 흐름 처리

Android 앱을 빌드하는 경우 OIDC 공급자를 사용하여 Firebase에서 사용자를 인증하는 가장 쉬운 방법은 Firebase Android SDK로 전체 로그인 흐름을 처리하는 것입니다.

Firebase Android SDK로 로그인 흐름을 처리하려면 다음 단계를 따르세요.

  1. 제공자의 ID와 함께 빌더 를 사용하여 OAuthProvider 의 인스턴스를 생성합니다.

    Kotlin+KTX

    val providerBuilder = OAuthProvider.newBuilder("oidc.example-provider")

    Java

    OAuthProvider.Builder providerBuilder = OAuthProvider.newBuilder("oidc.example-provider");

  2. 선택사항 : OAuth 요청과 함께 전송하려는 추가 사용자 정의 OAuth 매개변수를 지정하십시오.

    Kotlin+KTX

    // Target specific email with login hint.
    providerBuilder.addCustomParameter("login_hint", "user@example.com")

    Java

    // Target specific email with login hint.
    providerBuilder.addCustomParameter("login_hint", "user@example.com");

    OIDC 제공업체에서 지원하는 매개변수를 확인하세요. Firebase 필수 매개변수는 setCustomParameters() 로 전달할 수 없습니다. 이러한 매개변수는 client_id , response_type , redirect_uri , state , scoperesponse_mode 입니다.

  3. 선택 사항 : 인증 공급자에게 요청하려는 기본 프로필 외에 추가 OAuth 2.0 범위를 지정합니다.

    Kotlin+KTX

    // Request read access to a user's email addresses.
    // This must be preconfigured in the app's API permissions.
    providerBuilder.scopes = listOf("mail.read", "calendars.read")

    Java

    // Request read access to a user's email addresses.
    // This must be preconfigured in the app's API permissions.
    List<String> scopes =
            new ArrayList<String>() {
                {
                    add("mail.read");
                    add("calendars.read");
                }
            };
    providerBuilder.setScopes(scopes);

    OIDC 공급자가 사용하는 범위를 확인하십시오.

  4. OAuth 공급자 개체를 사용하여 Firebase에 인증합니다. 다른 FirebaseAuth 작업과 달리 맞춤 Chrome 탭 을 팝업하여 UI를 제어합니다. 결과적으로 작업이 UI를 시작할 때 즉시 분리되므로 OnSuccessListenerOnFailureListener 에서 활동을 참조하지 마십시오.

    이미 응답을 받았는지 먼저 확인해야 합니다. 이 방법으로 로그인하면 활동이 백그라운드에 있으므로 로그인 흐름 중에 시스템에서 회수할 수 있습니다. 이 경우 사용자가 다시 시도하지 않도록 하려면 결과가 이미 있는지 확인해야 합니다.

    보류 중인 결과가 있는지 확인하려면 getPendingAuthResult 를 호출합니다.

    Kotlin+KTX

    val pendingResultTask = firebaseAuth.pendingAuthResult
    if (pendingResultTask != null) {
        // There's something already here! Finish the sign-in for your user.
        pendingResultTask
            .addOnSuccessListener {
                // User is signed in.
                // IdP data available in
                // authResult.getAdditionalUserInfo().getProfile().
                // The OAuth access token can also be retrieved:
                // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                // The OAuth secret can be retrieved by calling:
                // ((OAuthCredential)authResult.getCredential()).getSecret().
            }
            .addOnFailureListener {
                // Handle failure.
            }
    } else {
        // There's no pending result so you need to start the sign-in flow.
        // See below.
    }

    Java

    Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult();
    if (pendingResultTask != null) {
        // There's something already here! Finish the sign-in for your user.
        pendingResultTask
                .addOnSuccessListener(
                        new OnSuccessListener<AuthResult>() {
                            @Override
                            public void onSuccess(AuthResult authResult) {
                                // User is signed in.
                                // IdP data available in
                                // authResult.getAdditionalUserInfo().getProfile().
                                // The OAuth access token can also be retrieved:
                                // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                                // The OAuth secret can be retrieved by calling:
                                // ((OAuthCredential)authResult.getCredential()).getSecret().
                            }
                        })
                .addOnFailureListener(
                        new OnFailureListener() {
                            @Override
                            public void onFailure(@NonNull Exception e) {
                                // Handle failure.
                            }
                        });
    } else {
        // There's no pending result so you need to start the sign-in flow.
        // See below.
    }

    로그인 흐름을 시작하려면 startActivityForSignInWithProvider 를 호출합니다.

    Kotlin+KTX

    firebaseAuth
        .startActivityForSignInWithProvider( /* activity = */this, provider.build())
        .addOnSuccessListener {
            // User is signed in.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // ((OAuthCredential)authResult.getCredential()).getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    firebaseAuth
            .startActivityForSignInWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // User is signed in.
                            // IdP data available in
                            // authResult.getAdditionalUserInfo().getProfile().
                            // The OAuth access token can also be retrieved:
                            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                            // The OAuth secret can be retrieved by calling:
                            // ((OAuthCredential)authResult.getCredential()).getSecret().
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

  5. 위의 예는 로그인 흐름에 중점을 두지만 startActivityForLinkWithProvider 를 사용하여 OIDC 공급자를 기존 사용자에 연결할 수도 있습니다. 예를 들어 동일한 사용자에게 여러 공급자를 연결하여 둘 중 하나로 로그인할 수 있습니다.

    Kotlin+KTX

    // The user is already signed-in.
    val firebaseUser = firebaseAuth.currentUser!!
    firebaseUser
        .startActivityForLinkWithProvider( /* activity = */this, provider.build())
        .addOnSuccessListener {
            // Provider credential is linked to the current user.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // authResult.getCredential().getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // authResult.getCredential().getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
            .startActivityForLinkWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // Provider credential is linked to the current user.
                            // IdP data available in
                            // authResult.getAdditionalUserInfo().getProfile().
                            // The OAuth access token can also be retrieved:
                            // authResult.getCredential().getAccessToken().
                            // The OAuth secret can be retrieved by calling:
                            // authResult.getCredential().getSecret().
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

  6. 최근 로그인이 필요한 중요한 작업에 대한 새로운 자격 증명을 검색하는 데 사용할 수 있는 startActivityForReauthenticateWithProvider 와 동일한 패턴을 사용할 수 있습니다.

    Kotlin+KTX

    // The user is already signed-in.
    val firebaseUser = firebaseAuth.currentUser!!
    firebaseUser
        .startActivityForReauthenticateWithProvider( /* activity = */this, provider.build())
        .addOnSuccessListener {
            // User is re-authenticated with fresh tokens and
            // should be able to perform sensitive operations
            // like account deletion and email or password
            // update.
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
            .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // User is re-authenticated with fresh tokens and
                            // should be able to perform sensitive operations
                            // like account deletion and email or password
                            // update.
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

로그인 흐름을 수동으로 처리

앱에 OpenID Connect 로그인 흐름을 이미 구현한 경우 ID 토큰을 직접 사용하여 Firebase에 인증할 수 있습니다.

Kotlin+KTX

val providerId = "oidc.example-provider" // As registered in Firebase console.
val credential = oAuthCredential(providerId) {
    setIdToken(idToken) // ID token from OpenID Connect flow.
}
Firebase.auth
    .signInWithCredential(credential)
    .addOnSuccessListener { authResult ->
        // User is signed in.

        // IdP data available in:
        //    authResult.additionalUserInfo.profile
    }
    .addOnFailureListener { e ->
        // Handle failure.
    }

Java

AuthCredential credential = OAuthProvider
        .newCredentialBuilder("oidc.example-provider")  // As registered in Firebase console.
        .setIdToken(idToken)  // ID token from OpenID Connect flow.
        .build();
FirebaseAuth.getInstance()
        .signInWithCredential(credential)
        .addOnSuccessListener(new OnSuccessListener<AuthResult>() {
            @Override
            public void onSuccess(AuthResult authResult) {
                // User is signed in.

                // IdP data available in:
                //    authResult.getAdditionalUserInfo().getProfile()
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Handle failure.
            }
        });

다음 단계

사용자가 처음으로 로그인하면 새 사용자 계정이 생성되고 사용자가 로그인할 때 사용한 자격 증명(즉, 사용자 이름과 암호, 전화 번호 또는 인증 공급자 정보)에 연결됩니다. 이 새 계정은 Firebase 프로젝트의 일부로 저장되며 사용자 로그인 방법에 관계없이 프로젝트의 모든 앱에서 사용자를 식별하는 데 사용할 수 있습니다.

  • 앱에서 FirebaseUser 개체에서 사용자의 기본 프로필 정보를 가져올 수 있습니다. 사용자 관리 를 참조하십시오.

  • Firebase 실시간 데이터베이스 및 Cloud Storage 보안 규칙 에서 auth 변수에서 로그인한 사용자의 고유한 사용자 ID를 가져와 사용자가 액세스할 수 있는 데이터를 제어하는 ​​데 사용할 수 있습니다.

인증 공급자 자격 증명을 기존 사용자 계정에 연결하여 사용자가 여러 인증 공급자를 사용하여 앱에 로그인하도록 허용할 수 있습니다.

사용자를 로그아웃하려면 signOut 을 호출합니다.

Kotlin+KTX

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();