אימות באמצעות OpenID Connect בפלטפורמות של Apple

אם שדרגתם ל-Firebase Authentication with Identity Platform, אתם יכולים לאמת את המשתמשים שלכם ב-Firebase באמצעות ספק שתואם ל-OpenID Connect‏ (OIDC) לבחירתכם. כך אפשר להשתמש בספקי זהויות שלא נתמכים באופן מקורי ב-Firebase.

לפני שמתחילים

כדי להכניס משתמשים באמצעות ספק OIDC, קודם צריך לאסוף כמה פרטים מהספק:

  • מזהה לקוח: מחרוזת ייחודית לספק שמזהה את האפליקציה שלכם. הספק יכול להקצות לכם מזהה לקוח שונה לכל פלטפורמה שאתם תומכים בה. זהו אחד מהערכים של ההצהרה aud בטוקנים של מזהה שהספק הנפיק.

  • סוד לקוח: מחרוזת סודית שהספק משתמש בה כדי לאשר בעלות על מזהה לקוח. לכל מזהה לקוח צריך להיות סוד לקוח תואם. (הערך הזה נדרש רק אם משתמשים בתהליך קוד האימות, שמומלץ מאוד).

  • מנפיק: מחרוזת שמזהה את הספק שלכם. הערך הזה חייב להיות כתובת URL, שאם מוסיפים לה את /.well-known/openid-configuration, היא המיקום של מסמך Discovery של OIDC של הספק. לדוגמה, אם המנפיק הוא https://auth.example.com, מסמך הגילוי חייב להיות זמין בכתובת https://auth.example.com/.well-known/openid-configuration.

אחרי שקיבלתם את המידע שלמעלה, אתם יכולים להפעיל את OpenID Connect כספק כניסה לפרויקט Firebase:

  1. מוסיפים את Firebase לפרויקט ב-iOS.

  2. אם עדיין לא שדרגתם ל-Firebase Authentication with Identity Platform, תצטרכו לעשות את זה. אימות באמצעות OpenID Connect זמין רק בפרויקטים משודרגים.

  3. במסוף Firebase, נכנסים לאבטחה > אימות.

  4. בכרטיסייה Sign-in method, לוחצים על Add new provider ואז על OpenID Connect.

  5. בוחרים אם להשתמש בתהליך הרשאה באמצעות קוד או בתהליך הרשאה מרומז.

    אם הספק תומך בתהליך הקוד, תמיד כדאי להשתמש בו. זרם הענקת הגישה המשתמע פחות מאובטח, ואנחנו ממליצים מאוד לא להשתמש בו.

  6. נותנים שם לספק. שימו לב למזהה הספק שנוצר, למשל oidc.example-provider. המזהה הזה נדרש כשמוסיפים קוד כניסה לאפליקציה.

  7. מציינים את מזהה הלקוח וסוד הלקוח, ואת מחרוזת המנפיק של הספק. הערכים האלה חייבים להיות זהים בדיוק לערכים שהספק הקצה לכם.

  8. שומרים את השינויים.

טיפול בתהליך הכניסה באמצעות Firebase SDK

הדרך הקלה ביותר לאמת את המשתמשים ב-Firebase באמצעות ספק ה-OIDC היא לטפל בכל תהליך הכניסה באמצעות Firebase SDK.

כדי לטפל בתהליך הכניסה באמצעות Firebase Apple platforms SDK, מבצעים את הפעולות הבאות:

  1. מוסיפים סכימות של כתובות URL בהתאמה אישית לפרויקט ב-Xcode:

    1. פותחים את הגדרות הפרויקט: לוחצים לחיצה כפולה על שם הפרויקט בתצוגת העץ שמימין. בקטע TARGETS, בוחרים את האפליקציה, לוחצים על הכרטיסייה Info ומרחיבים את הקטע URL Types.
    2. לוחצים על הלחצן + ומוסיפים את מזהה האפליקציה המקודד כסכמת URL. משאירים את שאר השדות ריקים.

      אפשר למצוא את מזהה האפליקציה המקודד במסוף Firebase: עוברים אל הגדרות > הכרטיסייה כללי, ואז גוללים למטה לקטע האפליקציות שלך כדי לראות פרטים על האפליקציה ל-iOS.

      בסיום התהליך, קובץ התצורה אמור להיראות בערך כך (אבל עם הערכים הספציפיים לאפליקציה שלכם):

      צילום מסך של ממשק ההגדרה של סכמת כתובת URL מותאמת אישית ב-Xcode
  2. יוצרים מכונה של OAuthProvider באמצעות מזהה הספק שקיבלתם במסוף Firebase.

    Swift

    var provider = OAuthProvider(providerID: "oidc.example-provider")
    

    Objective-C

    FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"oidc.example-provider"];
    
  3. אופציונלי: מציינים פרמטרים נוספים בהתאמה אישית של OAuth שרוצים לשלוח עם בקשת ה-OAuth.

    Swift

    provider.customParameters = [
      "login_hint": "user@example.com"
    ]
    

    Objective-C

    [provider setCustomParameters:@{@"login_hint": @"user@example.com"}];
    

    כדי לדעת באילו פרמטרים הספק תומך, צריך לפנות אליו. שימו לב שאי אפשר להעביר פרמטרים שנדרשים על ידי Firebase באמצעות setCustomParameters. הפרמטרים האלה הם client_id,‏ response_type,‏ redirect_uri,‏ state,‏ scope ו-response_mode.

  4. אופציונלי: מציינים היקפי הרשאות נוספים של OAuth 2.0 מעבר לפרופיל הבסיסי שרוצים לבקש מספק האימות.

    Swift

    provider.scopes = ["mail.read", "calendars.read"]
    

    Objective-C

    [provider setScopes:@[@"mail.read", @"calendars.read"]];
    

    כדי לדעת באילו היקפים הספק תומך, צריך לפנות אליו.

  5. אופציונלי: אם רוצים להתאים אישית את האופן שבו האפליקציה מציגה את SFSafariViewController או את UIWebView כשמציגים את reCAPTCHA למשתמש, יוצרים מחלקה בהתאמה אישית שתואמת לפרוטוקול AuthUIDelegate.

  6. מאמתים ב-Firebase באמצעות אובייקט ספק ה-OAuth.

    Swift

    // If you created a custom class that conforms to AuthUIDelegate,
    // pass it instead of nil:
    provider.getCredentialWith(nil) { credential, error in
      if error != nil {
        // Handle error.
      }
      if credential != nil {
        Auth().signIn(with: credential) { authResult, error in
          if error != nil {
            // Handle error.
          }
          // User is signed in.
          // IdP data available in authResult.additionalUserInfo.profile.
          // OAuth access token can also be retrieved:
          // (authResult.credential as? OAuthCredential)?.accessToken
          // OAuth ID token can also be retrieved:
          // (authResult.credential as? OAuthCredential)?.idToken
        }
      }
    }
    

    Objective-C

    // If you created a custom class that conforms to AuthUIDelegate,
    // pass it instead of nil:
    [provider getCredentialWithUIDelegate:nil
                                completion:^(FIRAuthCredential *_Nullable credential, NSError *_Nullable error) {
      if (error) {
        // Handle error.
      }
      if (credential) {
        [[FIRAuth auth] signInWithCredential:credential
                                  completion:^(FIRAuthDataResult *_Nullable authResult, NSError *_Nullable error) {
          if (error) {
            // Handle error.
          }
          // User is signed in.
          // IdP data available in authResult.additionalUserInfo.profile.
          // OAuth access token can also be retrieved:
          // ((FIROAuthCredential *)authResult.credential).accessToken
          // OAuth ID token can also be retrieved:
          // ((FIROAuthCredential *)authResult.credential).idToken
        }];
      }
    }];
    
  7. הדוגמאות שלמעלה מתמקדות בתהליכי כניסה, אבל אפשר גם לקשר ספק OIDC למשתמש קיים באמצעות linkWithCredential. לדוגמה, אפשר לקשר כמה ספקים לאותו משתמש, כדי לאפשר לו להיכנס באמצעות כל אחד מהם.

    Swift

    Auth().currentUser.link(withCredential: credential) { authResult, error in
      if error != nil {
        // Handle error.
      }
      // OIDC credential is linked to the current user.
      // IdP data available in authResult.additionalUserInfo.profile.
      // OAuth access token can also be retrieved:
      // (authResult.credential as? OAuthCredential)?.accessToken
      // OAuth ID token can also be retrieved:
      // (authResult.credential as? OAuthCredential)?.idToken
    }
    

    Objective-C

    [[FIRAuth auth].currentUser
        linkWithCredential:credential
                completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
      if (error) {
        // Handle error.
      }
      // OIDC credential is linked to the current user.
      // IdP data available in authResult.additionalUserInfo.profile.
      // OAuth access token can also be retrieved:
      // ((FIROAuthCredential *)authResult.credential).accessToken
      // OAuth ID token can also be retrieved:
      // ((FIROAuthCredential *)authResult.credential).idToken
    }];
    
  8. אפשר להשתמש באותה תבנית עם reauthenticateWithCredential, כדי לאחזר פרטי כניסה חדשים לפעולות רגישות שדורשות התחברות מהזמן האחרון.

    Swift

    Auth().currentUser.reauthenticateWithCredential(withCredential: credential) { authResult, error in
      if error != nil {
        // Handle error.
      }
      // User is re-authenticated with fresh tokens minted and
      // should be able to perform sensitive operations like account
      // deletion and email or password update.
      // IdP data available in result.additionalUserInfo.profile.
      // Additional OAuth access token can also be retrieved:
      // (authResult.credential as? OAuthCredential)?.accessToken
      // OAuth ID token can also be retrieved:
      // (authResult.credential as? OAuthCredential)?.idToken
    }
    

    Objective-C

    [[FIRAuth auth].currentUser
        reauthenticateWithCredential:credential
                          completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
      if (error) {
        // Handle error.
      }
      // User is re-authenticated with fresh tokens minted and
      // should be able to perform sensitive operations like account
      // deletion and email or password update.
      // IdP data available in result.additionalUserInfo.profile.
      // Additional OAuth access token can also be retrieved:
      // ((FIROAuthCredential *)authResult.credential).accessToken
      // OAuth ID token can also be retrieved:
      // ((FIROAuthCredential *)authResult.credential).idToken
    }];
    

טיפול ידני בתהליך הכניסה

אם כבר הטמעתם באפליקציה את תהליך הכניסה של OpenID Connect, אתם יכולים להשתמש בטוקן של המזהה ישירות כדי לבצע אימות מול Firebase:

Swift

let credential = OAuthProvider.credential(
    withProviderID: "oidc.example-provider",  // As registered in Firebase console.
    idToken: idToken,  // ID token from OpenID Connect flow.
    rawNonce: nil
)
Auth.auth().signIn(with: credential) { authResult, error in
    if error {
        // Handle error.
        return
    }
    // User is signed in.
    // IdP data available in authResult?.additionalUserInfo?.profile
}

Objective-C

FIROAuthCredential *credential =
    [FIROAuthProvider credentialWithProviderID:@"oidc.example-provider"  // As registered in Firebase console.
                                       IDToken:idToken  // ID token from OpenID Connect flow.
                                      rawNonce:nil];
[[FIRAuth auth] signInWithCredential:credential
                          completion:^(FIRAuthDataResult * _Nullable authResult,
                                      NSError * _Nullable error) {
    if (error != nil) {
        // Handle error.
        return;
    }
    // User is signed in.
    // IdP data available in authResult.additionalUserInfo.profile
}];

השלבים הבאים

אחרי שמשתמש נכנס לחשבון בפעם הראשונה, נוצר חשבון משתמש חדש שמקושר לפרטי הכניסה – כלומר, שם המשתמש והסיסמה, מספר הטלפון או פרטי ספק האימות – שאיתם המשתמש נכנס לחשבון. החשבון החדש הזה נשמר כחלק מהפרויקט ב-Firebase, ואפשר להשתמש בו כדי לזהות משתמש בכל אפליקציה בפרויקט, בלי קשר לאופן שבו המשתמש נכנס לחשבון.

  • באפליקציות שלכם, אתם יכולים לקבל את פרטי הפרופיל הבסיסיים של המשתמש מהאובייקט User. מידע נוסף זמין במאמר בנושא ניהול משתמשים.

  • בכללי האבטחה של Firebase Realtime Database ו-Cloud Storage, אפשר לקבל את מזהה המשתמש הייחודי של המשתמש המחובר מהמשתנה auth, ולהשתמש בו כדי לקבוע לאילו נתונים המשתמש יכול לגשת.

אתם יכולים לאפשר למשתמשים להיכנס לאפליקציה באמצעות כמה ספקי אימות, על ידי קישור פרטי הכניסה של ספק האימות לחשבון משתמש קיים.

כדי להוציא משתמש מהחשבון, מפעילים את signOut:.

Swift

let firebaseAuth = Auth.auth()
do {
  try firebaseAuth.signOut()
} catch let signOutError as NSError {
  print("Error signing out: %@", signOutError)
}

Objective-C

NSError *signOutError;
BOOL status = [[FIRAuth auth] signOut:&signOutError];
if (!status) {
  NSLog(@"Error signing out: %@", signOutError);
  return;
}

כדאי גם להוסיף קוד לטיפול בשגיאות לכל מגוון שגיאות האימות. מידע נוסף על טיפול בשגיאות