Android で GitHub を使用して認証する

GitHub 認証をアプリに統合して、ユーザーが Firebase での認証に GitHub アカウントを使用できるようにすることができます。

準備

  1. Firebase を Android プロジェクトに追加します
  2. アプリを Firebase プロジェクトに接続していない場合は、Firebase console で接続します。
  3. Firebase Authentication の依存関係をアプリレベルの build.gradle ファイルに追加します。
    compile 'com.google.firebase:firebase-auth:10.0.1'
  4. GitHub でデベロッパー アプリケーションとしてアプリを登録し、アプリの OAuth 2.0 クライアント IDクライアント シークレットを取得します。
  5. GitHub 認証を有効にします。
    1. Firebase console で [Authentication] を開きます。
    2. [ログイン方法] タブで [GitHub] を有効にし、GitHub から取得した OAuth 2.0 の [クライアント ID] と [クライアント シークレット] を指定します。
    3. 次に、Firebase OAuth リダイレクト URImy-app-12345.firebaseapp.com/__/auth/handler など)を、GitHub アプリの設定にあるアプリ設定ページで [Authorization callback URL] として設定します。

Firebase で認証する

  1. デベロッパー向けドキュメントに沿って GitHub 認証をアプリに統合します。ウェブ アプリケーション フローを使用して、GitHub からの OAuth 2.0 コールバックを処理するインテント フィルタをアプリに設定します。 GitHub のログインフローの最後に OAuth 2.0 アクセス トークンを受け取ります。
  2. ログイン アクティビティの onCreate メソッドで、FirebaseAuth オブジェクトの共有インスタンスを取得します。
     verbatim 69458c03986c585598dcf97060ca7ee3 private FirebaseAuth mAuth; endverbatim 69458c03986c585598dcf97060ca7ee3 
    // ...
     verbatim 0b3d48191477527941c34cc6f363cba6 // Initialize Firebase Auth
    mAuth = FirebaseAuth.getInstance(); endverbatim 0b3d48191477527941c34cc6f363cba6 
    
  3. ユーザーのログイン状態の変更に対応する AuthStateListener を設定します。
     verbatim 1838d6d325e04b143330f8a7018182b6 private FirebaseAuth.AuthStateListener mAuthListener; endverbatim 1838d6d325e04b143330f8a7018182b6 
    
    // ...
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        // ...
     verbatim 5454ba2482913c48b3e75b4cbf106037     mAuthListener = new FirebaseAuth.AuthStateListener() {
            @Override
            public void onAuthStateChanged(@NonNull FirebaseAuth firebaseAuth) {
                FirebaseUser user = firebaseAuth.getCurrentUser();
                if (user != null) {
                    // User is signed in
                    Log.d(TAG, "onAuthStateChanged:signed_in:" + user.getUid());
                } else {
                    // User is signed out
                    Log.d(TAG, "onAuthStateChanged:signed_out");
                }
                // ...
            }
        }; endverbatim 5454ba2482913c48b3e75b4cbf106037 
        // ...
    }
    
     verbatim 9c619571164ac208e64b26a9c153377a @Override
    public void onStart() {
        super.onStart();
        mAuth.addAuthStateListener(mAuthListener);
    } endverbatim 9c619571164ac208e64b26a9c153377a 
    
     verbatim 7d1e3bfe5b688235a6eaee2487a9e50d @Override
    public void onStop() {
        super.onStop();
        if (mAuthListener != null) {
            mAuth.removeAuthStateListener(mAuthListener);
        }
    } endverbatim 7d1e3bfe5b688235a6eaee2487a9e50d 
    
  4. ユーザーが GitHub でのログインに成功したら、OAuth 2.0 アクセス トークンを Firebase 認証情報と交換し、Firebase 認証情報を使用して Firebase での認証を行います。
     verbatim e7023905832c8c6e0b7af3a022b1c3d2 String token = "<GITHUB-ACCESS-TOKEN>";
    AuthCredential credential = GithubAuthProvider.getCredential(token);
    mAuth.signInWithCredential(credential)
            .addOnCompleteListener(this, new OnCompleteListener<AuthResult>() {
                @Override
                public void onComplete(@NonNull Task<AuthResult> task) {
                    Log.d(TAG, "signInWithCredential:onComplete:" + task.isSuccessful());
    
                    // If sign in fails, display a message to the user. If sign in succeeds
                    // the auth state listener will be notified and logic to handle the
                    // signed in user can be handled in the listener.
                    if (!task.isSuccessful()) {
                        Log.w(TAG, "signInWithCredential", task.getException());
                        Toast.makeText(MainActivity.this, "Authentication failed.",
                                Toast.LENGTH_SHORT).show();
                    }
    
                    // ...
                }
            }); endverbatim e7023905832c8c6e0b7af3a022b1c3d2 
    
    signInWithCredential の呼び出しが成功すると、AuthStateListener によって onAuthStateChanged コールバックが実行されます。このコールバックでは、getCurrentUser メソッドを使用してユーザーのアカウント データを取得できます。

次のステップ

ユーザーが初めてログインすると新しいユーザー アカウントが作成され、ユーザーがログインに使用した認証情報(ユーザー名とパスワードや認証プロバイダ情報)にリンクされます。この新しいアカウントは Firebase プロジェクトの一部として保存され、ユーザーのログイン方法にかかわらず、プロジェクトのすべてのアプリでユーザーを識別するために使用できます。

  • アプリでは、FirebaseUser オブジェクトからユーザーの基本的なプロフィール情報を取得できます。ユーザーの管理についての記事をご覧ください。

  • Firebase Realtime Database と Firebase Storage のセキュリティ ルールで、ログイン済みユーザーに固有のユーザー ID を auth 変数から取得し、これを使用してユーザーがアクセスできるデータを制御できます。

既存のユーザー アカウントに認証プロバイダの認証情報をリンクすることで、ユーザーが複数の認証プロバイダを使用してアプリにログインできるようになります。

ユーザーのログアウトを行うには signOut を呼び出します。

FirebaseAuth.getInstance().signOut();

フィードバックを送信...