אימות באמצעות OpenID Connect באפליקציות אינטרנט

אם שדרגתם ל-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 לפרויקט ב-JavaScript.

  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 JavaScript SDK, מבצעים את הפעולות הבאות:

  1. יוצרים מכונה של OAuthProvider באמצעות מזהה הספק שקיבלתם במסוף Firebase.

    Web

    import { OAuthProvider } from "firebase/auth";
    
    const provider = new OAuthProvider('oidc.example-provider');
    

    Web

    var provider = new firebase.auth.OAuthProvider('oidc.example-provider');
    
  2. אופציונלי: מציינים פרמטרים נוספים בהתאמה אישית של OAuth שרוצים לשלוח עם בקשת ה-OAuth.

    Web

    provider.setCustomParameters({
      // Target specific email with login hint.
      login_hint: 'user@example.com'
    });
    

    Web

    provider.setCustomParameters({
      // Target specific email with login hint.
      login_hint: 'user@example.com'
    });
    

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

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

    Web

    provider.addScope('mail.read');
    provider.addScope('calendars.read');
    

    Web

    provider.addScope('mail.read');
    provider.addScope('calendars.read');
    

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

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

    אתם יכולים להפנות את המשתמש לדף הכניסה של הספק או לפתוח את דף הכניסה בחלון קופץ בדפדפן.

    תהליך ההפניה לכתובת אחרת

    מפנים לדף הכניסה של הספק באמצעות קריאה ל-signInWithRedirect():

    Web

    import { getAuth, signInWithRedirect } from "firebase/auth";
    
    const auth = getAuth();
    signInWithRedirect(auth, provider);
    

    Web

    firebase.auth().signInWithRedirect(provider);
    

    אחרי שהמשתמש משלים את הכניסה וחוזר לאפליקציה, אפשר לקבל את תוצאת הכניסה באמצעות קריאה ל-getRedirectResult().

    Web

    import { getAuth, getRedirectResult, OAuthProvider } from "firebase/auth";
    
    const auth = getAuth();
    getRedirectResult(auth)
      .then((result) => {
        // User is signed in.
        // IdP data available in result.additionalUserInfo.profile.
    
        // Get the OAuth access token and ID Token
        const credential = OAuthProvider.credentialFromResult(result);
        const accessToken = credential.accessToken;
        const idToken = credential.idToken;
      })
      .catch((error) => {
        // Handle error.
      });
    

    Web

    firebase.auth().getRedirectResult()
      .then((result) => {
        // IdP data available in result.additionalUserInfo.profile.
        // ...
    
        /** @type {firebase.auth.OAuthCredential} */
        var credential = result.credential;
    
        // OAuth access and id tokens can also be retrieved:
        var accessToken = credential.accessToken;
        var idToken = credential.idToken;
      })
      .catch((error) => {
        // Handle error.
      });
    

    תהליך בחלון קופץ

    Web

    import { getAuth, signInWithPopup, OAuthProvider } from "firebase/auth";
    
    const auth = getAuth();
    signInWithPopup(auth, provider)
      .then((result) => {
        // User is signed in.
        // IdP data available using getAdditionalUserInfo(result)
    
        // Get the OAuth access token and ID Token
        const credential = OAuthProvider.credentialFromResult(result);
        const accessToken = credential.accessToken;
        const idToken = credential.idToken;
      })
      .catch((error) => {
        // Handle error.
      });
    

    Web

    firebase.auth().signInWithPopup(provider)
      .then((result) => {
        // IdP data available in result.additionalUserInfo.profile.
        // ...
    
        /** @type {firebase.auth.OAuthCredential} */
        var credential = result.credential;
    
        // OAuth access and id tokens can also be retrieved:
        var accessToken = credential.accessToken;
        var idToken = credential.idToken;
      })
      .catch((error) => {
        // Handle error.
      });
    
  5. הדוגמאות שלמעלה מתמקדות בתהליכי כניסה, אבל אפשר להשתמש באותו דפוס כדי לקשר ספק OIDC למשתמש קיים באמצעות linkWithRedirect() ו-linkWithPopup(), ולאמת מחדש משתמש באמצעות reauthenticateWithRedirect() ו-reauthenticateWithPopup(), שבהם אפשר להשתמש כדי לאחזר פרטי כניסה חדשים לפעולות רגישות שדורשות כניסה מהזמן האחרון.

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

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

Web

import { getAuth, signInWithCredential, OAuthProvider } from "firebase/auth";

const provider = new OAuthProvider("oidc.example-provider");
const credential = provider.credential({
    idToken: idToken,
});
signInWithCredential(getAuth(), credential)
    .then((result) => {
        // User is signed in.
        // IdP data available in result.additionalUserInfo.profile.

        // Get the OAuth access token and ID Token
        const credential = OAuthProvider.credentialFromResult(result);
        const accessToken = credential.accessToken;
        const idToken = credential.idToken;
    })
    .catch((error) => {
        // Handle error.
    });

Web

const provider = new OAuthProvider("oidc.example-provider");
const credential = provider.credential({
    idToken: idToken,
});
firebase.auth().signInWithCredential(credential)
    .then((result) => {
        // User is signed in.
        // IdP data available in result.additionalUserInfo.profile.

        // Get the OAuth access token and ID Token
        const credential = OAuthProvider.credentialFromResult(result);
        const accessToken = credential.accessToken;
        const idToken = credential.idToken;
    })
    .catch((error) => {
        // Handle error.
    });