اصالت‌سنجی بااستفاده از Yahoo در پلاتفرم‌های Apple

می‌توانید بااستفاده از ارائه‌دهندگان OAuth مثل Yahoo به کاربران اجازه دهید با Firebase اصالت‌سنجی کنند. برای این کار، بااستفاده از «کیت توسعه نرم‌افزار Firebase»، «ورود به سیستم OAuth عمومی» را در برنامه‌تان ادغام کنید تا جریان ورود به سیستم سرتاسری را انجام دهید.

قبل از شروع

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

1. ‫Firebase را به پروژه Apple خود اضافه کنید.
2. در کنسول Firebase، به امنیت > اصالت‌سنجی بروید.
3. در زبانه روش ورود به سیستم، ارائه‌دهنده ورود به سیستم Yahoo را فعال کنید.
4. شناسه کارخواه و رمز کارخواه را از کنسول توسعه‌دهنده آن ارائه‌دهنده به پیکربندی ارائه‌دهنده اضافه کنید:

   1. برای ثبت کارخواه Yahoo OAuth، مستندات توسعه‌دهنده Yahoo را درباره ثبت برنامه وب با Yahoo دنبال کنید.

      حتماً دو اجازه OpenID Connect API را انتخاب کنید: profile و email.

   2. هنگام ثبت برنامه‌ها با این ارائه‌دهندگان، حتماً دامنه *.firebaseapp.com را برای پروژه خود به‌عنوان دامنه هدایت مجدد برای برنامه خود ثبت کنید.
5. روی ذخیره کردن کلیک کنید.

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

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

1. طرح‌های نشانی وب سفارشی را به پروژه Xcode خود اضافه کنید:

   1. پیکربندی پروژه را باز کنید: روی نام پروژه در نمای درختی سمت راست دوکلیک کنید. برنامه‌تان را از بخش هدف‌ها انتخاب کنید، سپس برگه اطلاعات را انتخاب کنید و بخش انواع نشانی وب را ازهم باز کنید.
   2. روی دکمه + کلیک کنید و «شناسه برنامه کدبندی‌شده» خود را به‌عنوان طرح نشانی وب اضافه کنید. بقیه فیلدها را خالی بگذارید.

      می‌توانید «شناسه برنامه کدبندی‌شده» را در کنسول Firebase پیدا کنید: به settings تنظیمات > برگه کلی بروید، سپس به بخش برنامه‌های شما پیمایش کنید تا جزئیات مربوط به برنامه iOS خود را ببینید.

      وقتی تکمیل شد، پیکربندی شما باید چیزی شبیه به موارد زیر باشد (اما با مقادیر ویژه برنامه شما):

      

2. بااستفاده از شناسه ارائه‌دهنده yahoo.com، نمونه‌ای از OAuthProvider ایجاد کنید.

   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 دارد، باید در اجازه‌های API در کنسول توسعه‌دهندگان Yahoo، اجازه‌های Yahoo APIs را درخواست کنید. محدوده‌های 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. بااستفاده از شیء ارائه‌دهنده OAuth، با Firebase اصالت‌سنجی کنید.

   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 را فراخوانی کنید.

   برای مثال، برای دریافت اطلاعات نمایه پایه، می‌توانید با REST API تماس بگیرید و گذر دسترسی را در سرایند 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. اگرچه مثال‌های بالا بر جریان‌های ورود به سیستم تمرکز دارند، شما همچنین می‌توانید بااستفاده از linkWithPopup ارائه‌دهنده Yahoo را به کاربر موجود پیوند دهید. برای مثال، می‌توانید چندین ارائه‌دهنده را به یک کاربر پیوند دهید و به او اجازه دهید با هرکدام از آن‌ها وارد سیستم شود.

   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;
}

همچنین ممکن است بخواهید کد مدیریت خطا را برای طیف کامل خطاهای اصالت‌سنجی اضافه کنید. مدیریت خطاها را ببینید.