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

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

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

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

1. איך מוסיפים את Firebase לפרויקט Apple
2. במסוף Firebase, עוברים אל Security (אבטחה) > Authentication (אימות).
3. בכרטיסייה שיטת התחברות, מפעילים את ספק הכניסה Yahoo.
4. מוסיפים את מזהה הלקוח ואת סוד הלקוח ממסוף המפתחים של הספק להגדרות הספק:

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

      חשוב לבחור את שתי הרשאות ה-API של OpenID Connect: profile ו-email.

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

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

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

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

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

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

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

      

2. יוצרים מופע של OAuthProvider באמצעות מזהה הספק yahoo.com.

   Swift

   var provider = OAuthProvider(providerID: "yahoo.com")
       

   Objective-C

   FIROAuthProvider *provider = [FIROAuthProvider providerWithProviderID:@"yahoo.com"];
       

3. אופציונלי: מציינים פרמטרים נוספים של OAuth בהתאמה אישית שרוצים לשלוח עם בקשת ה-OAuth.

   Swift

   provider.customParameters = [
   "prompt": "login",
   "language": "fr"
   ]
       

   Objective-C

   [provider setCustomParameters:@{@"prompt": @"login", @"language": @"fr"}];
       

   למידע על הפרמטרים ש-Yahoo תומכת בהם, אפשר לעיין במסמכי התיעוד בנושא Yahoo OAuth. שימו לב: אי אפשר להעביר פרמטרים שנדרשים ב-Firebase באמצעות התג setCustomParameters. הפרמטרים האלה הם client_id,‏ redirect_uri, ‏ response_type, ‏ scope ו-state.

4. אופציונלי: מציינים היקפי הרשאות נוספים של OAuth 2.0 מעבר ל-profile ול-email שרוצים לבקש מספק האימות. אם האפליקציה שלכם דורשת גישה לנתוני משתמש פרטיים מ-Yahoo APIs, תצטרכו לבקש הרשאות ל-Yahoo APIs בקטע API Permissions ב-Yahoo Developer Console. היקפי ה-OAuth המבוקשים חייבים להיות זהים לאלה שהוגדרו מראש בהרשאות ה-API של האפליקציה. לדוגמה, אם נדרשת גישת קריאה/כתיבה לאנשי הקשר של המשתמש והיא מוגדרת מראש בהרשאות ה-API של האפליקציה, צריך להעביר את sdct-w במקום את היקף הגישה לקריאה בלבד של OAuth‏ sdct-r. אחרת, התהליך ייכשל ותוצג שגיאה למשתמש הקצה.

   Swift

   // Request access to Yahoo Mail API.
   // Request read/write access to user contacts.
   // This must be preconfigured in the app's API permissions.
   provider.scopes = ["mail-r", "sdct-w"]
       

   Objective-C

   // Request access to Yahoo Mail API.
   // Request read/write access to user contacts.
   // This must be preconfigured in the app's API permissions.
   [provider setScopes:@[@"mail-r", @"sdct-w"]];
       

   מידע נוסף מופיע במאמרי העזרה בנושא היקפי הרשאות ב-Yahoo.

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

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

   Swift

   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.
     // Yahoo OAuth access token can also be retrieved by:
     // (authResult.credential as? OAuthCredential)?.accessToken
     // Yahoo OAuth ID token can be retrieved by calling:
     // (authResult.credential as? OAuthCredential)?.idToken
   }
   }
   }
       

   Objective-C

   [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.
     // Yahoo OAuth access token can also be retrieved by:
     // ((FIROAuthCredential *)authResult.credential).accessToken
     // Yahoo OAuth ID token can be retrieved by calling:
     // ((FIROAuthCredential *)authResult.credential).idToken
   }];
   }
   }];
       

   באמצעות אסימון הגישה של OAuth, אפשר לקרוא ל-Yahoo API.

   לדוגמה, כדי לקבל את פרטי הפרופיל הבסיסיים, אפשר לקרוא ל-API בארכיטקטורת REST ולהעביר את טוקן הגישה בכותרת Authorization:

   https://social.yahooapis.com/v1/user/YAHOO_USER_UID/profile?format=json

   ‫YAHOO_USER_UID הוא המזהה של המשתמש ב-Yahoo, שאפשר לאחזר מהשדה Auth.auth.currentUser.providerData[0].uid או מ-authResult.additionalUserInfo.profile.

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

   Swift

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

   Objective-C

   [[FIRAuth auth].currentUser
   linkWithCredential:credential
           completion:^(FIRAuthDataResult * _Nullable authResult, NSError * _Nullable error) {
   if (error) {
   // Handle error.
   }
   // Yahoo credential is linked to the current user.
   // IdP data available in authResult.additionalUserInfo.profile.
   // Yahoo OAuth access token is can also be retrieved by:
   // ((FIROAuthCredential *)authResult.credential).accessToken
   // Yahoo OAuth ID token can be retrieved by calling:
   // ((FIROAuthCredential *)authResult.credential).idToken
   }];
       

8. אפשר להשתמש באותו דפוס עם reauthenticateWithPopup/reauthenticateWithRedirect כדי לאחזר פרטי כניסה עדכניים לפעולות רגישות שדורשות התחברות מהזמן האחרון.

   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 is can also be retrieved by:
   // (authResult.credential as? OAuthCredential)?.accessToken
   // Yahoo OAuth ID token can be retrieved by calling:
   // (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 is can also be retrieved by:
   // ((FIROAuthCredential *)authResult.credential).accessToken
   // Yahoo OAuth ID token can be retrieved by calling:
   // ((FIROAuthCredential *)authResult.credential).idToken
   }];
       

  // Sign-in with an OAuth credential.
  provider.getCredentialWith(nil) { credential, error in
    // An account with the same email already exists.
    if (error as NSError?)?.code == AuthErrorCode.accountExistsWithDifferentCredential.rawValue {
      // Get pending credential and email of existing account.
      let existingAcctEmail = (error! as NSError).userInfo[AuthErrorUserInfoEmailKey] as! String
      let pendingCred = (error! as NSError).userInfo[AuthErrorUserInfoUpdatedCredentialKey] as! AuthCredential
      // Lookup existing account identifier by the email.
      Auth.auth().fetchProviders(forEmail:existingAcctEmail) { providers, error in
        // Existing email/password account.
        if (providers?.contains(EmailAuthProviderID))! {
          // Existing password account for email. Ask user to provide the password of the
          // existing account.
          // Sign in with existing account.
          Auth.auth().signIn(withEmail:existingAcctEmail, password:password) { user, error in
            // Successfully signed in.
            if user != nil {
              // Link pending credential to account.
              Auth.auth().currentUser?.linkAndRetrieveData(with: pendingCred) { result, error in
                // ...
              }
            }
          }
        }
      }
      return
    }

    // Other errors.
    if error != nil {
      // handle the error.
      return
    }

    // Sign in with the credential.
    if credential != nil {
      Auth.auth().signInAndRetrieveData(with: credential!) { result, error in
        if error != nil {
          // handle the error.
          return
        }
      }
    }
  }

  

  // Sign-in with an OAuth credential.
  [provider getCredentialWithUIDelegate:nil
                             completion:^(FIRAuthCredential *_Nullable credential, NSError *_Nullable error) {
    // An account with the same email already exists.
    if (error.code == FIRAuthErrorCodeAccountExistsWithDifferentCredential) {
      // Get pending credential and email of existing account.
      NSString *existingAcctEmail = error.userInfo[FIRAuthErrorUserInfoEmailKey];
      FIRAuthCredential *pendingCred = error.userInfo[FIRAuthErrorUserInfoUpdatedCredentialKey];
      // Lookup existing account identifier by the email.
      [[FIRAuth auth] fetchProvidersForEmail:existingAcctEmail
                                 completion:^(NSArray<NSString *> *_Nullable providers,
                                              NSError *_Nullable error) {
        // Existing email/password account.
        if ( [providers containsObject:FIREmailAuthProviderID] ) {
          // Existing password account for email. Ask user to provide the password of the
          // existing account.

          // Sign in with existing account.
          [[FIRAuth auth] signInWithEmail:existingAcctEmail
                                 password:password
                               completion:^(FIRUser *user, NSError *error) {
            // Successfully signed in.
            if (user) {
              // Link pending credential to account.
              [[FIRAuth auth].currentUser linkWithCredential:pendingCred
                                                  completion:^(FIRUser *_Nullable user,
                                                               NSError *_Nullable error) {
                // ...
              }];
            }
          }];
        }
      }];
      return;
    }

    // Other errors.
    if (error) {
      // handle the error.
      return;
    }

    // Sign in with the credential.
    if (credential) {
      [[FIRAuth auth] signInAndRetrieveDataWithCredential:credential
          completion:^(FIRAuthDataResult *_Nullable authResult,
                       NSError *_Nullable error) {
        if (error) {
          // handle the error.
          return;
        }
      }];
    }
  }];
  

השלבים הבאים

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

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

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

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

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

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

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

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