אימות באמצעות Yahoo ב-Android

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

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

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

1. מוסיפים את Firebase לפרויקט Android.

2. במסוף Firebase, פותחים את הקטע Auth.
3. בכרטיסייה שיטת כניסה, מפעילים את הספק Yahoo.
4. מוסיפים את מזהה הלקוח ואת סוד הלקוח ממסוף הפיתוח של הספק להגדרות הספק:

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

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

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

6. אם עדיין לא ציינת את טביעת האצבע של SHA-1 של האפליקציה, צריך לעשות זאת דרך דף ההגדרות במסוף Firebase. פרטים נוספים אימות הלקוח לפרטים על קבלת טביעת האצבע SHA-1 של האפליקציה שלך.

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

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

כדי לבצע את תהליך הכניסה באמצעות ה-Android SDK של Firebase, צריך לבצע את השלבים הבאים:

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

   Kotlin+KTX

   val provider = OAuthProvider.newBuilder("yahoo.com")
   GenericIdpActivity.kt

   Java

   OAuthProvider.Builder provider = OAuthProvider.newBuilder("yahoo.com");
   GenericIdpActivity.java

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

   Kotlin+KTX

   // Prompt user to re-authenticate to Yahoo.
   provider.addCustomParameter("prompt", "login")
   
   // Localize to French.
   provider.addCustomParameter("language", "fr")
   GenericIdpActivity.kt

   Java

   // Prompt user to re-authenticate to Yahoo.
   provider.addCustomParameter("prompt", "login");
   
   // Localize to French.
   provider.addCustomParameter("language", "fr");
   GenericIdpActivity.java

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

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

   Kotlin+KTX

   // Request read access to a user's email addresses.
   // This must be preconfigured in the app's API permissions.
   provider.scopes = listOf("mail-r", "sdct-w")
   GenericIdpActivity.kt

   Java

   // 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>() {
               {
                   // Request access to Yahoo Mail API.
                   add("mail-r");
                   // This must be preconfigured in the app's API permissions.
                   add("sdct-w");
               }
           };
   provider.setScopes(scopes);
   GenericIdpActivity.java

   למידע נוסף, אפשר לעיין במסמכי התיעוד בנושא היקפי הרשאה ב-Yahoo.

4. מבצעים אימות עם Firebase באמצעות אובייקט של ספק OAuth. שימו לב שבניגוד ל- פעולות אחרות של FirebaseAuth – הן יכולות לשלוט בממשק המשתמש שלכם על ידי הקפצה כרטיסייה מותאמת אישית ב-Chrome. כתוצאה מכך, אין להפנות לפעילות שלך ב-OnSuccessListeners OnFailureListeners שתחבר כי הם יתנתקו מיד כאשר הפעולה מפעילה את ממשק המשתמש.

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

   כדי לבדוק אם יש תוצאה בהמתנה, קוראים לפונקציה getPendingAuthResult:

   Kotlin+KTX

   val pendingResultTask = firebaseAuth.pendingAuthResult
   if (pendingResultTask != null) {
       // There's something already here! Finish the sign-in for your user.
       pendingResultTask
           .addOnSuccessListener {
               // User is signed in.
               // IdP data available in
               // authResult.getAdditionalUserInfo().getProfile().
               // The OAuth access token can also be retrieved:
               // ((OAuthCredential)authResult.getCredential()).getAccessToken().
               // The OAuth secret can be retrieved by calling:
               // ((OAuthCredential)authResult.getCredential()).getSecret().
           }
           .addOnFailureListener {
               // Handle failure.
           }
   } else {
       // There's no pending result so you need to start the sign-in flow.
       // See below.
   }
   GenericIdpActivity.kt

   Java

   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().
                               // The OAuth secret can be retrieved by calling:
                               // ((OAuthCredential)authResult.getCredential()).getSecret().
                           }
                       })
               .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.
   }
   GenericIdpActivity.java

   כדי להתחיל את תהליך הכניסה, צריך לקרוא ל-startActivityForSignInWithProvider:

   Kotlin+KTX

   firebaseAuth
       .startActivityForSignInWithProvider(activity, provider.build())
       .addOnSuccessListener {
           // User is signed in.
           // IdP data available in
           // authResult.getAdditionalUserInfo().getProfile().
           // The OAuth access token can also be retrieved:
           // ((OAuthCredential)authResult.getCredential()).getAccessToken().
           // The OAuth secret can be retrieved by calling:
           // ((OAuthCredential)authResult.getCredential()).getSecret().
       }
       .addOnFailureListener {
           // Handle failure.
       }
   GenericIdpActivity.kt

   Java

   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().
                           // The OAuth secret can be retrieved by calling:
                           // ((OAuthCredential)authResult.getCredential()).getSecret().
                       }
                   })
           .addOnFailureListener(
                   new OnFailureListener() {
                       @Override
                       public void onFailure(@NonNull Exception e) {
                           // Handle failure.
                       }
                   });
   GenericIdpActivity.java

   בסיום התהליך, אסימון הגישה מסוג OAuth שמשויך אל אפשר לאחזר את הספק מהאובייקט OAuthCredential שמוחזר.

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

   כאשר YAHOO_USER_UID הוא מזהה המשתמש ב-Yahoo, שאפשר לנתח מהשדה firebaseAuth.getCurrentUser().getProviderData().get(0).getUid() או מ-authResult.getAdditionalUserInfo().getProfile().

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

   Kotlin+KTX

   // The user is already signed-in.
   val firebaseUser = firebaseAuth.currentUser!!
   firebaseUser
       .startActivityForLinkWithProvider(activity, provider.build())
       .addOnSuccessListener {
           // Provider 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().
           // The OAuth secret can be retrieved by calling:
           // authResult.getCredential().getSecret().
       }
       .addOnFailureListener {
           // Handle failure.
       }
   GenericIdpActivity.kt

   Java

   // 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) {
                           // Provider 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().
                           // The OAuth secret can be retrieved by calling:
                           // authResult.getCredential().getSecret().
                       }
                   })
           .addOnFailureListener(
                   new OnFailureListener() {
                       @Override
                       public void onFailure(@NonNull Exception e) {
                           // Handle failure.
                       }
                   });
   GenericIdpActivity.java

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

   Kotlin+KTX

   // The user is already signed-in.
   val firebaseUser = firebaseAuth.currentUser!!
   firebaseUser
       .startActivityForReauthenticateWithProvider(activity, provider.build())
       .addOnSuccessListener {
           // User is re-authenticated with fresh tokens and
           // should be able to perform sensitive operations
           // like account deletion and email or password
           // update.
       }
       .addOnFailureListener {
           // Handle failure.
       }
   GenericIdpActivity.kt

   Java

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

מתקדם: טיפול בתהליך הכניסה באופן ידני

בניגוד לספקי OAuth אחרים שנתמכים על ידי Firebase, כמו Google, Facebook, וב-Twitter, שבהם אפשר להיכנס ישירות לחשבון באמצעות אסימון גישה ל-OAuth שמבוססים על פרטי כניסה, אימות Firebase לא תומך באותה יכולת עבור כמו Yahoo בגלל חוסר היכולת של Firebase שרת אימות לאימות הקהל של אסימוני הגישה של Yahoo OAuth. זוהי דרישת אבטחה קריטית, והיא עלולה לחשוף אפליקציות ואתרים למתקפות של שחזור, שבהן אפשר להשתמש באסימון גישה של Yahoo OAuth שנוצר לפרויקט אחד (תוקף) כדי להיכנס לפרויקט אחר (קורבן). במקום זאת, Firebase Auth מאפשר לטפל בכל תהליך OAuth החלפה של קוד ההרשאה באמצעות מזהה וסוד הלקוח של OAuth שהוגדר במסוף Firebase. מאחר שניתן להשתמש רק בקוד ההרשאה יחד עם מזהה/סוד לקוח ספציפי, קוד הרשאה שהתקבלו עבור פרויקט אחד, לא יכולות לשמש בפרויקט אחר.

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

השלבים הבאים

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

• באפליקציות שלכם, אתם יכולים לקבל את פרטי הפרופיל הבסיסיים של המשתמש מהאובייקט FirebaseUser. ראו ניהול משתמשים.

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

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

כדי לנתק משתמש מהחשבון, יש להתקשר אל signOut

Kotlin+KTX

Firebase.auth.signOut()
MainActivity.kt

Java

FirebaseAuth.getInstance().signOut();
MainActivity.java