Firebase Summit에서 발표된 모든 내용을 살펴보고 Firebase로 앱을 빠르게 개발하고 안심하고 앱을 실행하는 방법을 알아보세요. 자세히 알아보기

Android에서 GitHub를 사용하여 인증

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

Firebase SDK를 사용하여 웹 기반 일반 OAuth 로그인을 앱에 통합하여 종단 간 로그인 흐름을 수행함으로써 사용자가 GitHub 계정을 사용하여 Firebase에 인증하도록 할 수 있습니다.

시작하기 전에

GitHub 계정을 사용하여 사용자를 로그인하려면 먼저 GitHub를 Firebase 프로젝트의 로그인 공급자로 활성화해야 합니다.

  1. 아직 Android 프로젝트에 Firebase를 추가 하지 않았다면 추가합니다.

  2. Firebase 콘솔 에서 인증 섹션을 엽니다.
  3. 로그인 방법 탭에서 GitHub 공급자를 활성화합니다.
  4. 해당 공급자의 개발자 콘솔에서 공급자 구성에 클라이언트 ID클라이언트 암호 를 추가합니다.
    1. GitHub에서 앱을 개발자 애플리케이션으로 등록 하고 앱의 OAuth 2.0 클라이언트 ID클라이언트 암호 를 가져옵니다.
    2. Firebase OAuth 리디렉션 URI (예: my-app-12345.firebaseapp.com/__/auth/handler )가 GitHub 앱 구성의 앱 설정 페이지에서 승인 콜백 URL 로 설정되어 있는지 확인합니다.
  5. 저장 을 클릭합니다.
  6. 모듈(앱 수준) Gradle 파일 (일반적으로 <project>/<app-module>/build.gradle )에서 Firebase 인증 Android 라이브러리에 대한 종속성을 추가합니다. Firebase Android BoM 을 사용하여 라이브러리 버전 관리를 제어하는 ​​것이 좋습니다.

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:31.1.0')
    
        // Add the dependency for the Firebase Authentication library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth'
    }
    

    Firebase Android BoM 을 사용하면 앱에서 항상 호환되는 Firebase Android 라이브러리 버전을 사용합니다.

    (또는) BoM을 사용 하지 않고 Firebase 라이브러리 종속성을 추가합니다.

    Firebase BoM을 사용하지 않기로 선택한 경우 종속성 줄에 각 Firebase 라이브러리 버전을 지정해야 합니다.

    앱에서 여러 Firebase 라이브러리를 사용하는 경우 모든 버전이 호환되도록 BoM을 사용하여 라이브러리 버전을 관리하는 것이 좋습니다.

    dependencies {
        // Add the dependency for the Firebase Authentication library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth:21.1.0'
    }
    

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:31.1.0')
    
        // Add the dependency for the Firebase Authentication library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth-ktx'
    }
    

    Firebase Android BoM 을 사용하면 앱에서 항상 호환되는 Firebase Android 라이브러리 버전을 사용합니다.

    (또는) BoM을 사용 하지 않고 Firebase 라이브러리 종속성을 추가합니다.

    Firebase BoM을 사용하지 않기로 선택한 경우 종속성 줄에 각 Firebase 라이브러리 버전을 지정해야 합니다.

    앱에서 여러 Firebase 라이브러리를 사용하는 경우 모든 버전이 호환되도록 BoM을 사용하여 라이브러리 버전을 관리하는 것이 좋습니다.

    dependencies {
        // Add the dependency for the Firebase Authentication library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth-ktx:21.1.0'
    }
    

  7. 앱의 SHA-1 지문을 아직 지정하지 않은 경우 Firebase 콘솔의 설정 페이지 에서 지정합니다. 앱의 SHA-1 지문을 가져오는 방법에 대한 자세한 내용은 클라이언트 인증 을 참조하세요.

Firebase SDK로 로그인 흐름 처리

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

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

  1. 공급자 ID가 github.com인 빌더 를 사용하여 OAuthProvider 의 인스턴스를 구성합니다.

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");
    
  2. 선택 사항 : OAuth 요청과 함께 보낼 추가 사용자 지정 OAuth 매개변수를 지정합니다.

    // Target specific email with login hint.
    provider.addCustomParameter("login", "your-email@gmail.com");
    

    GitHub가 지원하는 매개변수는 GitHub OAuth 문서 를 참조하십시오. setCustomParameters() 를 사용하여 Firebase 필수 매개변수를 전달할 수 없습니다. 이러한 매개변수는 client_id , response_type , redirect_uri , state , scoperesponse_mode 입니다.

  3. 선택 사항 : 인증 제공자에게 요청하고자 하는 기본 프로필 외에 추가 OAuth 2.0 범위를 지정합니다. 애플리케이션이 GitHub API의 비공개 사용자 데이터에 액세스해야 하는 경우 GitHub 개발자 콘솔의 API 권한 에서 GitHub API에 액세스할 수 있는 권한을 요청해야 합니다. 요청된 OAuth 범위는 앱의 API 권한에 미리 구성된 범위와 정확히 일치해야 합니다.

    // 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("user:email");
          }
        };
    provider.setScopes(scopes);
    
  4. OAuth 공급자 개체를 사용하여 Firebase에 인증합니다. 다른 FirebaseAuth 작업과 달리 사용자 정의 Chrome 탭 을 표시하여 UI를 제어합니다. 따라서 작업이 UI를 시작할 때 즉시 분리되므로 연결하는 OnSuccessListenerOnFailureListener 에서 활동을 참조하지 마십시오.

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

    보류 중인 결과가 있는지 확인하려면 getPendingAuthResult 를 호출하십시오.

    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().
                }
              })
          .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 를 호출하십시오.

    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().
              }
            })
        .addOnFailureListener(
            new OnFailureListener() {
              @Override
              public void onFailure(@NonNull Exception e) {
                // Handle failure.
              }
            });
    

    성공적으로 완료되면 반환된 OAuthCredential 개체에서 공급자와 연결된 OAuth 액세스 토큰을 검색할 수 있습니다.

    OAuth 액세스 토큰을 사용하여 GitHub API 를 호출할 수 있습니다.

    예를 들어 기본 프로필 정보를 얻으려면 REST API를 호출하여 Authorization 헤더에 액세스 토큰을 전달하면 됩니다.

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

    // 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) {
                // GitHub 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().
              }
            })
        .addOnFailureListener(
            new OnFailureListener() {
              @Override
              public void onFailure(@NonNull Exception e) {
                // Handle failure.
              }
            });
    
    
  6. 최근 로그인이 필요한 민감한 작업에 대한 새로운 자격 증명을 검색하는 데 사용할 수 있는 startActivityForReauthenticateWithProvider 와 동일한 패턴을 사용할 수 있습니다.

    // 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.
              }
            });
    

다음 단계

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

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

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

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

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

Java

FirebaseAuth.getInstance().signOut();

Kotlin+KTX

Firebase.auth.signOut()