在 Android 上使用 Apple 進行身份驗證

您可以使用 Firebase SDK 執行端對端 OAuth 2.0 登入流程,讓使用者使用其 Apple ID 透過 Firebase 進行身份驗證。

在你開始之前

若要使用 Apple 登入用戶,請先在 Apple 開發者網站上設定 Sign In with Apple,然後啟用 Apple 作為 Firebase 專案的登入提供者。

加入蘋果開發者計劃

「使用 Apple 登入」只能由Apple 開發者計畫的成員進行設定。

配置使用 Apple 登入

Apple 開發者網站上,執行以下操作:

  1. 依照設定使用 Apple 網頁版登入的第一部分所述將您的網站與應用程式相關聯。出現提示時,將以下 URL 註冊為返回 URL:

    https://YOUR_FIREBASE_PROJECT_ID.firebaseapp.com/__/auth/handler

    您可以在Firebase 控制台設定頁面上取得您的 Firebase 專案 ID。

    完成後,記下新的服務 ID,下一部分將需要它。

  2. 建立使用 Apple 私鑰登入。在下一部分中,您將需要新的私鑰和金鑰 ID。
  3. 如果您使用 Firebase 驗證的任何向使用者發送電子郵件的功能(包括電子郵件連結登入、電子郵件地址驗證、帳戶變更撤銷等),請設定 Apple 私人電子郵件中繼服務並註冊noreply@ YOUR_FIREBASE_PROJECT_ID .firebaseapp.com (或您的自訂電子郵件範本網域),以便 Apple 可以將 Firebase 驗證傳送的電子郵件轉送至匿名 Apple 電子郵件地址。

啟用 Apple 作為登入供應商

  1. 將 Firebase 新增到您的 Android 專案。在 Firebase 控制台中設定應用程式時,請務必註冊應用程式的 SHA-1 簽章。
  2. Firebase 控制台中,開啟「驗證」部分。在「登入方法」標籤上,啟用Apple提供者。指定您在上一部分中建立的服務 ID。另外,在OAuth 程式碼流配置部分中,指定您的 Apple 團隊 ID 以及您在上一部分中建立的私鑰和金鑰 ID。

遵守 Apple 匿名資料要求

「使用 Apple 登入」為使用者提供了在登入時對其資料(包括電子郵件地址)進行匿名化的選項。選擇此選項的使用者的電子郵件地址的網域為privaterelay.appleid.com 。當您在應用程式中使用「透過 Apple 登入」時,您必須遵守 Apple 關於這些匿名 Apple ID 的任何適用的開發者政策或條款。

這包括在將任何直接識別個人資訊與匿名 Apple ID 關聯之前獲得任何所需的用戶同意。使用 Firebase 身份驗證時,這可能包括以下操作:

  • 將電子郵件地址連結到匿名 Apple ID,反之亦然。
  • 將電話號碼連結到匿名 Apple ID,反之亦然
  • 將非匿名社交憑證(Facebook、Google 等)連結到匿名 Apple ID,反之亦然。

上述列表並非詳盡無遺。請參閱開發者帳戶的「會員資格」部分中的 Apple 開發者計畫許可協議,以確保您的應用程式符合 Apple 的要求。

使用 Firebase SDK 處理登入流程

在 Android 上,使用 Apple 帳戶透過 Firebase 對使用者進行身份驗證的最簡單方法是使用 Firebase Android SDK 處理整個登入流程。

若要使用 Firebase Android SDK 處理登入流程,請依照下列步驟操作:

  1. 使用其 Builder 和提供者 ID apple.com建構OAuthProvider的實例:

    Kotlin+KTX

    val provider = OAuthProvider.newBuilder("apple.com")
    

    Java

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("apple.com");
    
  2. 選用:指定您想要從身分驗證提供者要求的預設範圍之外的其他 OAuth 2.0 範圍。

    Kotlin+KTX

    provider.setScopes(arrayOf("email", "name"))
    

    Java

    List<String> scopes =
        new ArrayList<String>() {
          {
            add("email");
            add("name");
          }
        };
    provider.setScopes(scopes);
    

    預設情況下,當啟用「每個電子郵件地址一個帳戶」時,Firebase 會要求電子郵件和名稱範圍。如果您將此設定變更為每個電子郵件地址多個帳戶,Firebase 不會向 Apple 要求任何範圍,除非您指定。

  3. 可選:如果您想以英語以外的語言顯示 Apple 的登入螢幕,請設定locale參數。請參閱「使用 Apple 登入」文件以了解支援的區域設定。

    Kotlin+KTX

    // Localize the Apple authentication screen in French.
    provider.addCustomParameter("locale", "fr")
    

    Java

    // Localize the Apple authentication screen in French.
    provider.addCustomParameter("locale", "fr");
    
  4. 使用 OAuth 提供者物件透過 Firebase 進行身份驗證。請注意,與其他FirebaseAuth操作不同,這將透過開啟自訂 Chrome 標籤來控制您的 UI。因此,請勿在附加的OnSuccessListenerOnFailureListener中引用您的 Activity,因為它們會在操作啟動 UI 時立即分離。

    您應該先檢查是否已收到回覆。使用此方法登入會將您的 Activity 置於後台,這表示系統可以在登入流程中回收它。為了確保發生這種情況時不會讓使用者重試,您應該檢查結果是否已存在。

    若要檢查是否有待處理的結果,請呼叫getPendingAuthResult()

    Kotlin+KTX

    val pending = auth.pendingAuthResult
    if (pending != null) {
        pending.addOnSuccessListener { authResult ->
            Log.d(TAG, "checkPending:onSuccess:$authResult")
            // Get the user profile with authResult.getUser() and
            // authResult.getAdditionalUserInfo(), and the ID
            // token from Apple with authResult.getCredential().
        }.addOnFailureListener { e ->
            Log.w(TAG, "checkPending:onFailure", e)
        }
    } else {
        Log.d(TAG, "pending: null")
    }
    

    Java

    mAuth = FirebaseAuth.getInstance();
    Task<AuthResult> pending = mAuth.getPendingAuthResult();
    if (pending != null) {
        pending.addOnSuccessListener(new OnSuccessListener<AuthResult>() {
            @Override
            public void onSuccess(AuthResult authResult) {
                Log.d(TAG, "checkPending:onSuccess:" + authResult);
                // Get the user profile with authResult.getUser() and
                // authResult.getAdditionalUserInfo(), and the ID
                // token from Apple with authResult.getCredential().
            }
        }).addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                Log.w(TAG, "checkPending:onFailure", e);
            }
        });
    } else {
        Log.d(TAG, "pending: null");
    }
    

    如果沒有待處理的結果,請透過呼叫startActivityForSignInWithProvider()啟動登入流程:

    Kotlin+KTX

    auth.startActivityForSignInWithProvider(this, provider.build())
            .addOnSuccessListener { authResult ->
                // Sign-in successful!
                Log.d(TAG, "activitySignIn:onSuccess:${authResult.user}")
                val user = authResult.user
                // ...
            }
            .addOnFailureListener { e ->
                Log.w(TAG, "activitySignIn:onFailure", e)
            }
    

    Java

    mAuth.startActivityForSignInWithProvider(this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // Sign-in successful!
                            Log.d(TAG, "activitySignIn:onSuccess:" + authResult.getUser());
                            FirebaseUser user = authResult.getUser();
                            // ...
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            Log.w(TAG, "activitySignIn:onFailure", e);
                        }
                    });
    

    與 Firebase Auth 支援的其他提供者不同,Apple 不提供照片 URL。

    此外,當使用者選擇不與應用程式分享其電子郵件時,Apple 會為該使用者提供一個獨特的電子郵件地址(格式為xyz@privaterelay.appleid.com ),並與您的應用程式共用。如果您設定了私人電子郵件轉發服務,Apple 會將發送到匿名地址的電子郵件轉發到使用者的真實電子郵件地址。

    Apple 僅在使用者首次登入時與應用程式共用使用者訊息,例如顯示名稱。通常,Firebase 會在使用者首次登入 Apple 時儲存顯示名稱,您可以透過getCurrentUser().getDisplayName()取得該顯示名稱。但是,如果您之前使用 Apple 將使用者登入應用程式而不使用 Firebase,則 Apple 不會向 Firebase 提供使用者的顯示名稱。

重新驗證和帳戶鏈接

相同的模式可以與startActivityForReauthenticateWithProvider()一起使用,您可以使用它來檢索需要最近登入的敏感操作的新憑證:

Kotlin+KTX

// The user is already signed-in.
val firebaseUser = auth.getCurrentUser()

firebaseUser
    .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build())
    .addOnSuccessListener( 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( e -> {
        // Handle failure.
    })

Java

// The user is already signed-in.
FirebaseUser firebaseUser = mAuth.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.
          }
        });

並且,您可以使用linkWithCredential()將不同的身分提供者連結到現有帳戶。

請注意,Apple 要求您在將用戶的 Apple 帳戶連結到其他資料之前獲得用戶的明確同意。

例如,要將 Facebook 帳戶連結到目前 Firebase 帳戶,請使用使用者登入 Facebook 時獲得的存取權杖:

Kotlin+KTX

// Initialize a Facebook credential with a Facebook access token.
val credential = FacebookAuthProvider.getCredential(token.getToken())

// Assuming the current user is an Apple user linking a Facebook provider.
mAuth.getCurrentUser().linkWithCredential(credential)
    .addOnCompleteListener(this, task -> {
        if (task.isSuccessful()) {
          // Facebook credential is linked to the current Apple user.
          // The user can now sign in to the same account
          // with either Apple or Facebook.
        }
      });

Java

// Initialize a Facebook credential with a Facebook access token.
AuthCredential credential = FacebookAuthProvider.getCredential(token.getToken());

// Assuming the current user is an Apple user linking a Facebook provider.
mAuth.getCurrentUser().linkWithCredential(credential)
    .addOnCompleteListener(this, new OnCompleteListener<AuthResult>() {
      @Override
      public void onComplete(@NonNull Task<AuthResult> task) {
        if (task.isSuccessful()) {
          // Facebook credential is linked to the current Apple user.
          // The user can now sign in to the same account
          // with either Apple or Facebook.
        }
      }
    });

進階:手動處理登入流程

您也可以使用 Apple 帳戶透過 Firebase 進行身份驗證,方法是使用 Apple Sign-In JS SDK、手動建立 OAuth 流程或使用 OAuth 庫(例如AppAuth )處理登入流程。

  1. 對於每個登入請求,產生一個隨機字串(「nonce」),您將使用它來確保您獲得的 ID 令牌是專門為回應您的應用程式的身份驗證請求而授予的。此步驟對於防止重播攻擊很重要。

    您可以使用SecureRandom在 Android 上產生加密安全隨機數,如下例所示:

    Kotlin+KTX

    private fun generateNonce(length: Int): String {
        val generator = SecureRandom()
    
        val charsetDecoder = StandardCharsets.US_ASCII.newDecoder()
        charsetDecoder.onUnmappableCharacter(CodingErrorAction.IGNORE)
        charsetDecoder.onMalformedInput(CodingErrorAction.IGNORE)
    
        val bytes = ByteArray(length)
        val inBuffer = ByteBuffer.wrap(bytes)
        val outBuffer = CharBuffer.allocate(length)
        while (outBuffer.hasRemaining()) {
            generator.nextBytes(bytes)
            inBuffer.rewind()
            charsetDecoder.reset()
            charsetDecoder.decode(inBuffer, outBuffer, false)
        }
        outBuffer.flip()
        return outBuffer.toString()
    }
    

    Java

    private String generateNonce(int length) {
        SecureRandom generator = new SecureRandom();
    
        CharsetDecoder charsetDecoder = StandardCharsets.US_ASCII.newDecoder();
        charsetDecoder.onUnmappableCharacter(CodingErrorAction.IGNORE);
        charsetDecoder.onMalformedInput(CodingErrorAction.IGNORE);
    
        byte[] bytes = new byte[length];
        ByteBuffer inBuffer = ByteBuffer.wrap(bytes);
        CharBuffer outBuffer = CharBuffer.allocate(length);
        while (outBuffer.hasRemaining()) {
            generator.nextBytes(bytes);
            inBuffer.rewind();
            charsetDecoder.reset();
            charsetDecoder.decode(inBuffer, outBuffer, false);
        }
        outBuffer.flip();
        return outBuffer.toString();
    }
    

    然後,取得十六進位字串形式的隨機數的 SHA246 雜湊值:

    Kotlin+KTX

    private fun sha256(s: String): String {
        val md = MessageDigest.getInstance("SHA-256")
        val digest = md.digest(s.toByteArray())
        val hash = StringBuilder()
        for (c in digest) {
            hash.append(String.format("%02x", c))
        }
        return hash.toString()
    }
    

    Java

    private String sha256(String s) throws NoSuchAlgorithmException {
        MessageDigest md = MessageDigest.getInstance("SHA-256");
        byte[] digest = md.digest(s.getBytes());
        StringBuilder hash = new StringBuilder();
        for (byte c: digest) {
            hash.append(String.format("%02x", c));
        }
        return hash.toString();
    }
    

    您將隨登入請求一起傳送隨機數的 SHA256 雜湊值,Apple 將在回應中原封不動地傳遞該雜湊值。 Firebase 透過對原始隨機數進行雜湊處理並將其與 Apple 傳遞的值進行比較來驗證回應。

  2. 使用 OAuth 函式庫或其他方法啟動 Apple 的登入流程。請務必將哈希隨機數作為參數包含在您的請求中。

  3. 收到 Apple 的回應後,從回應中取得 ID 令牌,並使用它和未散列的隨機數來建立AuthCredential

    Kotlin+KTX

    val credential =  OAuthProvider.newCredentialBuilder("apple.com")
        .setIdTokenWithRawNonce(appleIdToken, rawUnhashedNonce)
        .build()
    

    Java

    AuthCredential credential =  OAuthProvider.newCredentialBuilder("apple.com")
        .setIdTokenWithRawNonce(appleIdToken, rawUnhashedNonce)
        .build();
    
  4. 使用 Firebase 憑證進行 Firebase 驗證:

    Kotlin+KTX

    auth.signInWithCredential(credential)
          .addOnCompleteListener(this) { task ->
              if (task.isSuccessful) {
                // User successfully signed in with Apple ID token.
                // ...
              }
          }
    

    Java

    mAuth.signInWithCredential(credential)
        .addOnCompleteListener(this, new OnCompleteListener<AuthResult>() {
          @Override
          public void onComplete(@NonNull Task<AuthResult> task) {
            if (task.isSuccessful()) {
              // User successfully signed in with Apple ID token.
              // ...
            }
          }
        });
    

如果呼叫signInWithCredential成功,您可以使用getCurrentUser方法來取得使用者的帳戶資料。

令牌撤銷

Apple 要求支援帳戶建立的應用程式必須允許使用者在應用程式內發起刪除其帳戶的操作,如應用程式商店審查指南中所述

此外,支援「使用 Apple 登入」的應用程式應使用「使用 Apple 登入」REST API 來撤銷使用者令牌。

為了滿足此要求,請執行下列步驟:

  1. 使用startActivityForSignInWithProvider()方法使用 Apple 登入並取得AuthResult

  2. 取得 Apple 提供者的存取權令牌。

    Kotlin+KTX

    val oauthCredential: OAuthCredential =  authResult.credential
    val accessToken = oauthCredential.accessToken
    

    Java

    OAuthCredential oauthCredential = (OAuthCredential) authResult.getCredential();
    String accessToken = oauthCredential.getAccessToken();
    
  3. 使用revokeAccessToken API 撤銷令牌。

    Kotlin+KTX

    mAuth.revokeAccessToken(accessToken)
      .addOnCompleteListener(this) { task ->
        if (task.isSuccessful) {
          // Access token successfully revoked
          // for the user ...
        }
    }
    

    Java

    mAuth.revokeAccessToken(accessToken)
        .addOnCompleteListener(this, new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
              if (task.isSuccessful()) {
                // Access token successfully revoked
                // for the user ...
              }
            }
      });
    
  1. 最後,刪除使用者帳戶(以及所有關聯資料)

    下一步

    使用者首次登入後,系統會建立新的使用者帳戶,並將其連結到使用者登入時所使用的憑證(即使用者名稱和密碼、電話號碼或驗證提供者資訊)。此新帳戶將作為 Firebase 專案的一部分存儲,並且可用於識別專案中每個應用程式中的用戶,無論用戶如何登入。

    • 在您的應用程式中,您可以從FirebaseUser物件取得使用者的基本個人資料資訊。請參閱管理用戶

    • 在 Firebase 即時資料庫和雲端儲存安全性規則中,您可以從auth變數取得登入使用者的唯一使用者 ID,並使用它來控制使用者可以存取哪些資料。

    您可以透過將身分驗證提供者憑證連結到現有使用者帳戶,允許使用者使用多個驗證提供者登入您的應用程式。

    若要登出用戶,請呼叫signOut

    Kotlin+KTX

    Firebase.auth.signOut()

    Java

    FirebaseAuth.getInstance().signOut();