احراز هویت بااستفاده از GitHub با جاوا اسکریپت

با ادغام کردن اصالت‌سنجی GitHub در برنامه‌تان، می‌توانید به کاربران اجازه دهید بااستفاده از حساب‌های GitHub خودشان در Firebase اصالت‌سنجی کنند. می‌توانید اصالت‌سنجی GitHub را بااستفاده از Firebase SDK برای اجرای جریان ورود به سیستم یا با اجرای دستی جریان GitHub OAuth 2.0 و ارسال کد دسترسی حاصل به Firebase ادغام کنید.

قبل از شروع

  1. ‫Firebase را به پروژه JavaScript خود اضافه کنید.
  2. در کنسول Firebase، به امنیت > اصالت‌سنجی بروید.
  3. در برگه روش ورود به سیستم، ارائه‌دهنده ورود به سیستم GitHub را فعال کنید.
  4. شناسه کارخواه و رمز کارخواه را از کنسول توسعه‌دهنده آن ارائه‌دهنده به پیکربندی ارائه‌دهنده اضافه کنید:
    1. برنامه‌تان را به‌عنوان برنامه توسعه‌دهنده در GitHub ثبت کنید و شناسه کارخواه و رمز کارخواه OAuth 2.0 برنامه‌تان را دریافت کنید.
    2. مطمئن شوید URI تغییرمسیر OAuth Firebase شما (برای مثال، my-app-12345.firebaseapp.com/__/auth/handler) به‌عنوان نشانی وب فراخوان مجوز در صفحه تنظیمات برنامه‌تان در پیکربندی برنامه GitHub شما تنظیم شده باشد.
  5. روی ذخیره کردن کلیک کنید.

مدیریت جریان ورود به سیستم با کیت توسعه نرم‌افزار Firebase

اگر درحال ساختن برنامه وب هستید، آسان‌ترین راه برای اصالت‌سنجی کاربران با Firebase بااستفاده از حساب GitHub آن‌ها، مدیریت جریان ورود به سیستم با کیت توسعه نرم‌افزار جاوا اسکریپت در Firebase است. (اگر می‌خواهید کاربری را در Node.js یا محیط غیرمرورگر دیگری اصالت‌سنجی کنید، باید جریان ورود به سیستم را به‌صورت دستی مدیریت کنید.)

برای مدیریت جریان ورود به سیستم با کیت توسعه نرم‌افزار جاوا اسکریپت در Firebase، این مراحل را دنبال کنید:

  1. نمونه‌ای از شیء ارائه‌دهنده GitHub ایجاد کنید:

    Web

    import { GithubAuthProvider } from "firebase/auth";
    
    const provider = new GithubAuthProvider();

    Web

    var provider = new firebase.auth.GithubAuthProvider();
  2. اختیاری: دامنه‌های OAuth 2.0 دیگری را که می‌خواهید از ارائه‌دهنده اصالت‌سنجی درخواست کنید مشخص کنید. برای افزودن دامنه، addScope را فراخوانی کنید. برای مثال:

    Web

    provider.addScope('repo');

    Web

    provider.addScope('repo');
    اسناد ارائه‌دهنده اصالت‌سنجی را ببینید.
  3. اختیاری: پارامترهای ارائه‌دهنده OAuth سفارشی دیگری را که می‌خواهید با درخواست OAuth ارسال شود مشخص کنید. برای افزودن پارامتر سفارشی، setCustomParameters را در ارائه‌دهنده مقداردهی‌شده با شیء حاوی کلید همان‌طور که در اسناد ارائه‌دهنده OAuth مشخص شده است و مقدار مربوطه فراخوانی کنید. برای مثال:

    Web

    provider.setCustomParameters({
      'allow_signup': 'false'
    });

    Web

    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    پارامترهای OAuth الزامی رزروشده مجاز نیستند و نادیده گرفته خواهند شد. برای جزئیات بیشتر، به مرجع ارائه‌دهنده اصالت‌سنجی مراجعه کنید.
  4. بااستفاده از شیء ارائه‌دهنده GitHub، با Firebase اصالت‌سنجی کنید. می‌توانید از کاربران بخواهید با حساب GitHub خودشان به سیستم وارد شوند، چه با باز کردن پنجره بالاپر یا با هدایت کردن به صفحه ورود به سیستم. روش هدایت مجدد در دستگاه‌های همراه ترجیح داده می‌شود.
    • برای ورود به سیستم با پنجره بالاپر، signInWithPopup را فراخوانی کنید:

      Web

      import { getAuth, signInWithPopup, GithubAuthProvider } from "firebase/auth";
      
      const auth = getAuth();
      signInWithPopup(auth, provider)
        .then((result) => {
          // This gives you a GitHub Access Token. You can use it to access the GitHub API.
          const credential = GithubAuthProvider.credentialFromResult(result);
          const token = credential.accessToken;
      
          // The signed-in user info.
          const user = result.user;
          // IdP data available using getAdditionalUserInfo(result)
          // ...
        }).catch((error) => {
          // Handle Errors here.
          const errorCode = error.code;
          const errorMessage = error.message;
          // The email of the user's account used.
          const email = error.customData.email;
          // The AuthCredential type that was used.
          const credential = GithubAuthProvider.credentialFromError(error);
          // ...
        });

      Web

      firebase
        .auth()
        .signInWithPopup(provider)
        .then((result) => {
          /** @type {firebase.auth.OAuthCredential} */
          var credential = result.credential;
      
          // This gives you a GitHub Access Token. You can use it to access the GitHub API.
          var token = credential.accessToken;
      
          // The signed-in user info.
          var user = result.user;
          // IdP data available in result.additionalUserInfo.profile.
            // ...
        }).catch((error) => {
          // Handle Errors here.
          var errorCode = error.code;
          var errorMessage = error.message;
          // The email of the user's account used.
          var email = error.email;
          // The firebase.auth.AuthCredential type that was used.
          var credential = error.credential;
          // ...
        });
      همچنین توجه داشته باشید که می‌توانید کد OAuth ارائه‌دهنده GitHub را بازیابی کنید که می‌تواند برای واکشی داده‌های اضافی بااستفاده از GitHub API استفاده شود.

      در اینجا همچنین می‌توانید خطاها را شناسایی و مدیریت کنید. برای مشاهده فهرست کدهای خطا، به اسناد مرجع احراز هویت مراجعه کنید.

    • برای ورود به سیستم با هدایت به صفحه ورود به سیستم، signInWithRedirect را فراخوانی کنید: هنگام استفاده از `signInWithRedirect` روال‌های مطلوب را دنبال کنید.

      Web

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

      Web

      firebase.auth().signInWithRedirect(provider);
      سپس، می‌توانید با فراخوانی getRedirectResult هنگام بار شدن صفحه‌تان، توکن OAuth ارائه‌دهنده GitHub را نیز بازیابی کنید:

      Web

      import { getAuth, getRedirectResult, GithubAuthProvider } from "firebase/auth";
      
      const auth = getAuth();
      getRedirectResult(auth)
        .then((result) => {
          const credential = GithubAuthProvider.credentialFromResult(result);
          if (credential) {
            // This gives you a GitHub Access Token. You can use it to access the GitHub API.
            const token = credential.accessToken;
            // ...
          }
      
          // The signed-in user info.
          const user = result.user;
          // IdP data available using getAdditionalUserInfo(result)
          // ...
        }).catch((error) => {
          // Handle Errors here.
          const errorCode = error.code;
          const errorMessage = error.message;
          // The email of the user's account used.
          const email = error.customData.email;
          // The AuthCredential type that was used.
          const credential = GithubAuthProvider.credentialFromError(error);
          // ...
        });

      Web

      firebase.auth()
        .getRedirectResult()
        .then((result) => {
          if (result.credential) {
            /** @type {firebase.auth.OAuthCredential} */
            var credential = result.credential;
      
            // This gives you a GitHub Access Token. You can use it to access the GitHub API.
            var token = credential.accessToken;
            // ...
          }
      
          // The signed-in user info.
          var user = result.user;
          // IdP data available in result.additionalUserInfo.profile.
            // ...
        }).catch((error) => {
          // Handle Errors here.
          var errorCode = error.code;
          var errorMessage = error.message;
          // The email of the user's account used.
          var email = error.email;
          // The firebase.auth.AuthCredential type that was used.
          var credential = error.credential;
          // ...
        });
      در اینجا همچنین می‌توانید خطاها را شناسایی و مدیریت کنید. برای مشاهده فهرست کدهای خطا، به اسناد مرجع احراز هویت مراجعه کنید.

جریان ورود به سیستم را به‌صورت دستی مدیریت کنید

همچنین می‌توانید بااستفاده از حساب GitHub با Firebase اصالت‌سنجی کنید. برای این کار، جریان ورود به سیستم را با فراخوانی نقطه‌های پایانی GitHub OAuth 2.0 مدیریت کنید:

  1. با دنبال کردن اسناد توسعه‌دهنده، اصالت‌سنجی GitHub را در برنامه‌تان ادغام کنید. در پایان جریان ورود به سیستم GitHub، کد دسترسی OAuth 2.0 دریافت خواهید کرد.
  2. اگر لازم است به سیستم برنامه Node.js وارد شوید، کد دسترسی OAuth را به برنامه Node.js ارسال کنید.
  3. پس‌از اینکه کاربر باموفقیت با GitHub به سیستم وارد شد، کد دسترسی OAuth 2.0 را با اعتبارنامه Firebase مبادله کنید:

    Web

    import { GithubAuthProvider } from "firebase/auth";
    
    const credential = GithubAuthProvider.credential(token);

    Web

    var credential = firebase.auth.GithubAuthProvider.credential(token);
  4. اصالت‌سنجی با Firebase بااستفاده از اعتبارنامه Firebase:

    Web

    import { getAuth, signInWithCredential } from "firebase/auth";
    
    // Sign in with the credential from the user.
    const auth = getAuth();
    signInWithCredential(auth, credential)
      .then((result) => {
        // Signed in 
        // ...
      })
      .catch((error) => {
        // Handle Errors here.
        const errorCode = error.code;
        const errorMessage = error.message;
        // The email of the user's account used.
        const email = error.customData.email;
        // ...
      });

    Web

    // Sign in with the credential from the user.
    firebase.auth()
      .signInWithCredential(credential)
      .then((result) => {
        // Signed in 
        // ...
      })
      .catch((error) => {
        // Handle Errors here.
        const errorCode = error.code;
        const errorMessage = error.message;
        // The email of the user's account used.
        const email = error.email;
        // ...
      });

اصالت‌سنجی با Firebase در افزونه Chrome

اگر درحال ساختن برنامه افزونه Chrome هستید، راهنمای اسناد خارج از صفحه را ببینید.

مراحل بعدی

پس‌از اینکه کاربر برای اولین‌بار به سیستم وارد شد، حساب کاربری جدیدی ایجاد می‌شود و به اطلاعات اعتباری (یعنی نام کاربری و گذرواژه، شماره تلفن، یا اطلاعات ارائه‌دهنده احراز هویت) که کاربر با آن به سیستم وارد شده است پیوند داده می‌شود. این حساب جدید به‌عنوان بخشی از پروژه Firebase شما ذخیره می‌شود و می‌توان از آن برای شناسایی کاربر در هر برنامه در پروژه شما، صرف‌نظر از نحوه ورود کاربر به سیستم، استفاده کرد.

  • در برنامه‌هایتان، روش توصیه‌شده برای اطلاع از وضعیت اصالت‌سنجی کاربرتان این است که ناظری را روی شیء Auth تنظیم کنید. سپس می‌توانید اطلاعات نمایه اصلی کاربر را از شیء User دریافت کنید. مدیریت کاربران را ببینید.

  • در Firebase Realtime Database و Cloud Storage قوانین امنیتی، می‌توانید شناسه کاربر منحصربه‌فرد کاربر واردشده به سیستم را از متغیر auth دریافت کنید، و از آن برای کنترل داده‌هایی که کاربر می‌تواند به آن‌ها دسترسی داشته باشد استفاده کنید.

می‌توانید به کاربران اجازه دهید بااستفاده از چند ارائه‌دهنده اصالت‌سنجی به سیستم برنامه‌تان وارد شوند. برای این کار، اعتبارنامه‌های ارائه‌دهنده اصالت‌سنجی را به حساب کاربری موجود پیوند دهید.

برای خارج کردن کاربر از سیستم، signOut را فراخوانی کنید:

Web

import { getAuth, signOut } from "firebase/auth";

const auth = getAuth();
signOut(auth).then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});

Web

firebase.auth().signOut().then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});