المصادقة باستخدام GitHub باستخدام JavaScript

يمكنك السماح للمستخدمين بالمصادقة مع Firebase باستخدام حساباتهم على GitHub من خلال دمج مصادقة GitHub في تطبيقك. يمكنك دمج مصادقة GitHub إما باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase لتنفيذ إجراءات تسجيل الدخول، أو من خلال تنفيذ مسار GitHub 2.0 يدويًا وتمرير رمز الدخول الناتج إلى Firebase.

قبل البدء

1. أضِف Firebase إلى مشروع JavaScript.
2. في وحدة تحكُّم Firebase، افتح قسم المصادقة.
3. في علامة التبويب طريقة تسجيل الدخول، فعِّل موفّر خدمة GitHub.
4. أضِف Client ID وClient Secret من وحدة تحكّم المطوّرين الخاصة بالموفّر إلى إعدادات الموفّر:
   1. سجِّل تطبيقك كتطبيق مطوِّر على GitHub واحصل على Client ID OAuth 2.0 وClient Secret لتطبيقك.
   2. تأكَّد من ضبط معرّف الموارد المنتظم (URI) لإعادة توجيه OAuth في Firebase (مثل my-app-12345.firebaseapp.com/__/auth/handler) باعتباره عنوان URL لمعاودة الاتصال بالتفويض في صفحة إعدادات تطبيقك ضمن إعدادات تطبيق GitHub.
5. انقر على حفظ.

معالجة عملية تسجيل الدخول باستخدام حزمة تطوير البرامج (SDK) لمنصّة Firebase

إذا كنت تنشئ تطبيق ويب، فإن أسهل طريقة لمصادقة المستخدمين من خلال Firebase باستخدام حساباتهم على GitHub هي التعامل مع تدفق تسجيل الدخول باستخدام حزمة تطوير البرامج (SDK) لـ Firebase JavaScript. (إذا كنت تريد مصادقة مستخدم في Node.js أو بيئة أخرى لا تستخدم المتصفح، يجب معالجة عملية تسجيل الدخول يدويًا.)

للتعامل مع عملية تسجيل الدخول باستخدام حزمة SDK لـ Firebase JavaScript، اتّبِع الخطوات التالية:

1. إنشاء مثيل لكائن موفر GitHub:

   واجهة برمجة التطبيقات Web modular API

   مزيد من المعلومات حول واجهة برمجة تطبيقات الويب النموذجية التي يمكن تغيير عناصر التحكّم فيها والترقية من واجهة برمجة التطبيقات المخصّصة لمساحة الاسم

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

   واجهة برمجة التطبيقات لمساحة الاسم على الويب

   var provider = new firebase.auth.GithubAuthProvider();
   github.js

2. اختياري: حدِّد نطاقات OAuth 2.0 الإضافية التي تريد أن تطلبها من موفّر المصادقة. لإضافة نطاق، يمكنك طلب addScope. على سبيل المثال:

   واجهة برمجة التطبيقات Web modular API

   مزيد من المعلومات حول واجهة برمجة تطبيقات الويب النموذجية التي يمكن تغيير عناصر التحكّم فيها والترقية من واجهة برمجة التطبيقات المخصّصة لمساحة الاسم

   provider.addScope('repo');
   auth_github_provider_scopes.js

   واجهة برمجة التطبيقات لمساحة الاسم على الويب

   provider.addScope('repo');
   github.js

   راجِع مستندات موفِّر المصادقة.
3. اختياري: حدِّد المزيد من مَعلمات موفّر OAuth المخصّصة التي تريد إرسالها مع طلب OAuth. لإضافة مَعلمة مخصّصة، يمكنك استدعاء setCustomParameters في موفّر الخدمة الذي تم إعداده باستخدام عنصر يحتوي على المفتاح كما هو محدّد في مستندات موفّر OAuth والقيمة المقابلة. على سبيل المثال:

   واجهة برمجة التطبيقات Web modular API

   مزيد من المعلومات حول واجهة برمجة تطبيقات الويب النموذجية التي يمكن تغيير عناصر التحكّم فيها والترقية من واجهة برمجة التطبيقات المخصّصة لمساحة الاسم

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

   واجهة برمجة التطبيقات لمساحة الاسم على الويب

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

   غير مسموح بمعلمات OAuth المطلوبة المحجوزة وسيتم تجاهلها. يُرجى الاطّلاع على مرجع موفّر المصادقة لمزيد من التفاصيل.
4. يمكنك المصادقة مع Firebase باستخدام كائن موفِّر GitHub. يمكنك أن تطلب من المستخدمين تسجيل الدخول باستخدام حساباتهم على GitHub إما من خلال فتح نافذة منبثقة أو إعادة التوجيه إلى صفحة تسجيل الدخول. وننصح باستخدام طريقة إعادة التوجيه على الأجهزة الجوّالة.
   • لتسجيل الدخول عبر نافذة منبثقة، اتصل بالرقم signInWithPopup:

     واجهة برمجة التطبيقات Web modular API

     مزيد من المعلومات حول واجهة برمجة تطبيقات الويب النموذجية التي يمكن تغيير عناصر التحكّم فيها والترقية من واجهة برمجة التطبيقات المخصّصة لمساحة الاسم

     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);
         // ...
       });
     auth_github_signin_popup.js

     واجهة برمجة التطبيقات لمساحة الاسم على الويب

     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;
         // ...
       });
     github.js

     لاحظ أيضًا أنه يمكنك استرداد رمز OAuth المميز لموفر GitHub، والذي يمكن استخدامه لجلب بيانات إضافية باستخدام واجهات برمجة تطبيقات GitHub.

     ويمكنك هنا أيضًا رصد الأخطاء ومعالجتها. للحصول على قائمة برموز الأخطاء، يمكنك الاطّلاع على المستندات المرجعية للمصادقة.

   • لتسجيل الدخول من خلال إعادة التوجيه إلى صفحة تسجيل الدخول، عليك طلب رقم signInWithRedirect: اتّبِع أفضل الممارسات عند استخدام "signInWithRedirect".

     واجهة برمجة التطبيقات Web modular API

     مزيد من المعلومات حول واجهة برمجة تطبيقات الويب النموذجية التي يمكن تغيير عناصر التحكّم فيها والترقية من واجهة برمجة التطبيقات المخصّصة لمساحة الاسم

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

     واجهة برمجة التطبيقات لمساحة الاسم على الويب

     firebase.auth().signInWithRedirect(provider);
     index.js

     يمكنك بعد ذلك أيضًا استرداد رمز OAuth المميز لموفِّر GitHub من خلال طلب getRedirectResult عند تحميل صفحتك:

     واجهة برمجة التطبيقات Web modular API

     مزيد من المعلومات حول واجهة برمجة تطبيقات الويب النموذجية التي يمكن تغيير عناصر التحكّم فيها والترقية من واجهة برمجة التطبيقات المخصّصة لمساحة الاسم

     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);
         // ...
       });
     auth_github_signin_redirect_result.js

     واجهة برمجة التطبيقات لمساحة الاسم على الويب

     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.js

     ويمكنك هنا أيضًا رصد الأخطاء ومعالجتها. للحصول على قائمة برموز الأخطاء، يمكنك الاطّلاع على المستندات المرجعية للمصادقة.

التعامل مع أخطاء بيانات اعتماد الحساب المتوفّرة ومختلفة

في حال تفعيل الإعداد حساب واحد لكل عنوان بريد إلكتروني ضمن وحدة تحكُّم Firebase، عندما يحاول المستخدم تسجيل الدخول إلى أحد مقدِّمي الخدمة (مثل GitHub) باستخدام عنوان بريد إلكتروني متوفّر من قبل لموفّر مستخدم Firebase آخر (مثل Google)، تظهر رسالة الخطأ auth/account-exists-with-different-credential مع عنصر AuthCredential (رمز دخول إلى GitHub). لإكمال عملية تسجيل الدخول إلى الموفّر المقصود، على المستخدم التوقيع أولاً إلى مزوّد الخدمة الحالي (Google) ثم الربط بحساب AuthCredential السابق (رمز الدخول إلى GitHub).

وضع النافذة المنبثقة

إذا كنت تستخدم signInWithPopup، يمكنك التعامل مع أخطاء auth/account-exists-with-different-credential التي تتضمّن رموزًا، مثل المثال التالي:

import {
  getAuth,
  linkWithCredential,
  signInWithPopup,
  GitHubAuthProvider,
} from "firebase/auth";

try {
  // Step 1: User tries to sign in using GitHub.
  let result = await signInWithPopup(getAuth(), new GitHubAuthProvider());
} catch (error) {
  // Step 2: User's email already exists.
  if (error.code === "auth/account-exists-with-different-credential") {
    // The pending GitHub credential.
    let pendingCred = error.credential;

    // Step 3: Save the pending credential in temporary storage,

    // Step 4: Let the user know that they already have an account
    // but with a different provider, and let them choose another
    // sign-in method.
  }
}

// ...

try {
  // Step 5: Sign the user in using their chosen method.
  let result = await signInWithPopup(getAuth(), userSelectedProvider);

  // Step 6: Link to the GitHub credential.
  // TODO: implement `retrievePendingCred` for your app.
  let pendingCred = retrievePendingCred();

  if (pendingCred !== null) {
    // As you have access to the pending credential, you can directly call the
    // link method.
    let user = await linkWithCredential(result.user, pendingCred);
  }

  // Step 7: Continue to app.
} catch (error) {
  // ...
}

وضع إعادة التوجيه

تتم معالجة هذا الخطأ بطريقة مشابهة في وضع إعادة التوجيه، مع الاختلاف في أنّ بيانات الاعتماد التي تنتظر المراجعة يجب أن يتم تخزينها مؤقتًا بين عمليات إعادة توجيه الصفحات (على سبيل المثال، استخدام تخزين الجلسة).

معالجة عملية تسجيل الدخول يدويًا

يمكنك أيضًا المصادقة مع Firebase باستخدام حساب GitHub من خلال معالجة عملية تسجيل الدخول من خلال طلب نقاط نهاية GitHub OAuth 2.0:

1. ادمج مصادقة GitHub في تطبيقك باتّباع مستندات المطوّرين. وفي نهاية عملية تسجيل الدخول إلى GitHub، ستتلقّى رمز الدخول OAuth 2.0.
2. إذا كنت بحاجة إلى تسجيل الدخول على تطبيق Node.js، أرسِل رمز الدخول OAuth إلى تطبيق Node.js.
3. بعد أن يسجّل المستخدم الدخول بنجاح من خلال GitHub، يمكنك استبدال رمز الدخول OAuth 2.0 ببيانات اعتماد Firebase:

   واجهة برمجة التطبيقات Web modular API

   مزيد من المعلومات حول واجهة برمجة تطبيقات الويب النموذجية التي يمكن تغيير عناصر التحكّم فيها والترقية من واجهة برمجة التطبيقات المخصّصة لمساحة الاسم

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

   واجهة برمجة التطبيقات لمساحة الاسم على الويب

   var credential = firebase.auth.GithubAuthProvider.credential(token);
   github.js

4. يمكنك المصادقة مع Firebase باستخدام بيانات اعتماد Firebase:

   واجهة برمجة التطبيقات Web modular API

   مزيد من المعلومات حول واجهة برمجة تطبيقات الويب النموذجية التي يمكن تغيير عناصر التحكّم فيها والترقية من واجهة برمجة التطبيقات المخصّصة لمساحة الاسم

   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;
       // ...
     });
   auth_signin_credential.js

   واجهة برمجة التطبيقات لمساحة الاسم على الويب

   // 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;
       // ...
     });
   index.js

المصادقة باستخدام Firebase في إحدى إضافات Chrome

إذا كنت تنشئ تطبيقًا لإضافة Chrome، يمكنك الاطّلاع على دليل المستندات خارج الشاشة.

تخصيص نطاق إعادة التوجيه لتسجيل الدخول إلى GitHub

عند إنشاء المشروع، سيوفّر Firebase نطاقًا فرعيًا فريدًا لمشروعك: https://my-app-12345.firebaseapp.com.

سيتم استخدام هذه الطريقة أيضًا كآلية إعادة توجيه لتسجيل الدخول عبر بروتوكول OAuth. ويجب أن يكون هذا النطاق مسموحًا به لجميع موفّري OAuth المعتمَدين. ومع ذلك، قد يظهر للمستخدمين ذلك النطاق أثناء تسجيل الدخول إلى GitHub قبل إعادة التوجيه إلى التطبيق: المتابعة إلى: https://my-app-12345.firebaseapp.com

لتجنّب عرض نطاقك الفرعي، يمكنك إعداد نطاق خاص باستخدام "استضافة Firebase":

1. اتّبِع الخطوات من 1 إلى 3 في إعداد نطاقك للاستضافة. عند إثبات ملكية نطاقك، توفّر الاستضافة شهادة طبقة المقابس الآمنة (SSL) لنطاقك الخاص.
2. أضِف نطاقك الخاص إلى قائمة النطاقات المُصرَّح بها في وحدة تحكُّم Firebase: auth.custom.domain.com.
3. في وحدة تحكم مطوّري البرامج في GitHub أو صفحة إعداد OAuth، أضِف عنوان URL لصفحة إعادة التوجيه إلى القائمة البيضاء، والذي يمكن الوصول إليه من خلال نطاقك الخاص: https://auth.custom.domain.com/__/auth/handler.
4. عند إعداد مكتبة JavaScript، يجب تحديد نطاقك الخاص باستخدام الحقل authDomain:

   var config = {
     apiKey: '...',
     // Changed from 'my-app-12345.firebaseapp.com'.
     authDomain: 'auth.custom.domain.com',
     databaseURL: 'https://my-app-12345.firebaseio.com',
     projectId: 'my-app-12345',
     storageBucket: 'my-app-12345.appspot.com',
     messagingSenderId: '1234567890'
   };
   firebase.initializeApp(config);
   

الخطوات اللاحقة

بعد تسجيل دخول المستخدم للمرة الأولى، يتم إنشاء حساب مستخدم جديد وربطه ببيانات الاعتماد، أي اسم المستخدم وكلمة المرور، أو رقم الهاتف، أو معلومات مقدم خدمة المصادقة. يتم تخزين هذا الحساب الجديد كجزء من مشروعك في Firebase، ويمكن استخدامه لتحديد مستخدم على مستوى كل تطبيق في مشروعك، بغض النظر عن كيفية تسجيل المستخدم للدخول.

• الطريقة التي ننصح بها في تطبيقاتك لمعرفة حالة المصادقة للمستخدم هي ضبط مراقب على كائن Auth. يمكنك بعد ذلك الحصول على معلومات الملف الشخصي الأساسية للمستخدم من كائن User. يُرجى الاطّلاع على إدارة المستخدمين.

• في قاعدة بيانات Firebase في الوقت الفعلي وقواعد أمان Cloud Storage، يمكنك الحصول على رقم تعريف المستخدم الفريد للمستخدم الذي سجّل الدخول من المتغيّر auth واستخدامه للتحكّم في البيانات التي يمكن للمستخدم الوصول إليها.

يمكنك السماح للمستخدمين بتسجيل الدخول إلى تطبيقك باستخدام عدة موفِّري مصادقة من خلال ربط بيانات اعتماد موفِّر المصادقة بحساب مستخدم حالي.

لتسجيل خروج مستخدم، يمكنك الاتصال بالرقم signOut:

واجهة برمجة التطبيقات Web modular API

مزيد من المعلومات حول واجهة برمجة تطبيقات الويب النموذجية التي يمكن تغيير عناصر التحكّم فيها والترقية من واجهة برمجة التطبيقات المخصّصة لمساحة الاسم

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

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

واجهة برمجة التطبيقات لمساحة الاسم على الويب

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