FIRAuthErrorUtils.m 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993
  1. /*
  2. * Copyright 2017 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import "FIRAuthErrorUtils.h"
  17. #import "FIRAuthCredential.h"
  18. #import "FIRAuthInternalErrors.h"
  19. NS_ASSUME_NONNULL_BEGIN
  20. NSString *const FIRAuthErrorDomain = @"FIRAuthErrorDomain";
  21. NSString *const FIRAuthInternalErrorDomain = @"FIRAuthInternalErrorDomain";
  22. NSString *const FIRAuthErrorUserInfoDeserializedResponseKey =
  23. @"FIRAuthErrorUserInfoDeserializedResponseKey";
  24. NSString *const FIRAuthErrorUserInfoDataKey = @"FIRAuthErrorUserInfoDataKey";
  25. NSString *const FIRAuthErrorUserInfoEmailKey = @"FIRAuthErrorUserInfoEmailKey";
  26. NSString *const FIRAuthErrorNameKey = @"error_name";
  27. NSString *const FIRAuthUpdatedCredentialKey = @"FIRAuthUpdatedCredentialKey";
  28. /** @var kServerErrorDetailMarker
  29. @brief This marker indicates that the server error message contains a detail error message which
  30. should be used instead of the hardcoded client error message.
  31. */
  32. static NSString *const kServerErrorDetailMarker = @" : ";
  33. #pragma mark - URL response error codes
  34. /** @var kURLResponseErrorCodeInvalidClientID
  35. @brief Error code that indicates that the client ID provided was invalid.
  36. */
  37. static NSString *const kURLResponseErrorCodeInvalidClientID = @"auth/invalid-oauth-client-id";
  38. /** @var kURLResponseErrorCodeNetworkRequestFailed
  39. @brief Error code that indicates that a network request within the SFSafariViewController or
  40. UIWebView failed.
  41. */
  42. static NSString *const kURLResponseErrorCodeNetworkRequestFailed = @"auth/network-request-failed";
  43. /** @var kURLResponseErrorCodeInternalError
  44. @brief Error code that indicates that an internal error occured within the
  45. SFSafariViewController or UIWebView failed.
  46. */
  47. static NSString *const kURLResponseErrorCodeInternalError = @"auth/internal-error";
  48. #pragma mark - Standard Error Messages
  49. /** @var kFIRAuthErrorMessageInvalidCustomToken
  50. @brief Message for @c FIRAuthErrorCodeInvalidCustomToken error code.
  51. */
  52. static NSString *const kFIRAuthErrorMessageInvalidCustomToken = @"The custom token format is "
  53. "incorrect. Please check the documentation.";
  54. /** @var kFIRAuthErrorMessageCustomTokenMismatch
  55. @brief Message for @c FIRAuthErrorCodeCustomTokenMismatch error code.
  56. */
  57. static NSString *const kFIRAuthErrorMessageCustomTokenMismatch = @"The custom token corresponds to "
  58. "a different audience.";
  59. /** @var kFIRAuthErrorMessageInvalidEmail
  60. @brief Message for @c FIRAuthErrorCodeInvalidEmail error code.
  61. */
  62. static NSString *const kFIRAuthErrorMessageInvalidEmail = @"The email address is badly formatted.";
  63. /** @var kFIRAuthErrorMessageInvalidCredential
  64. @brief Message for @c FIRAuthErrorCodeInvalidCredential error code.
  65. */
  66. static NSString *const kFIRAuthErrorMessageInvalidCredential = @"The supplied auth credential is "
  67. "malformed or has expired.";
  68. /** @var kFIRAuthErrorMessageUserDisabled
  69. @brief Message for @c FIRAuthErrorCodeUserDisabled error code.
  70. */
  71. static NSString *const kFIRAuthErrorMessageUserDisabled = @"The user account has been disabled by "
  72. "an administrator.";
  73. /** @var kFIRAuthErrorMessageEmailAlreadyInUse
  74. @brief Message for @c FIRAuthErrorCodeEmailAlreadyInUse error code.
  75. */
  76. static NSString *const kFIRAuthErrorMessageEmailAlreadyInUse = @"The email address is already in "
  77. "use by another account.";
  78. /** @var kFIRAuthErrorMessageWrongPassword
  79. @brief Message for @c FIRAuthErrorCodeWrongPassword error code.
  80. */
  81. static NSString *const kFIRAuthErrorMessageWrongPassword = @"The password is invalid or the user "
  82. "does not have a password.";
  83. /** @var kFIRAuthErrorMessageTooManyRequests
  84. @brief Message for @c FIRAuthErrorCodeTooManyRequests error code.
  85. */
  86. static NSString *const kFIRAuthErrorMessageTooManyRequests = @"We have blocked all requests from "
  87. "this device due to unusual activity. Try again later.";
  88. /** @var kFIRAuthErrorMessageAccountExistsWithDifferentCredential
  89. @brief Message for @c FIRAuthErrorCodeAccountExistsWithDifferentCredential error code.
  90. */
  91. static NSString *const kFIRAuthErrorMessageAccountExistsWithDifferentCredential = @"An account "
  92. "already exists with the same email address but different sign-in credentials. Sign in using a "
  93. "provider associated with this email address.";
  94. /** @var kFIRAuthErrorMessageRequiresRecentLogin
  95. @brief Message for @c FIRAuthErrorCodeRequiresRecentLogin error code.
  96. */
  97. static NSString *const kFIRAuthErrorMessageRequiresRecentLogin= @"This operation is sensitive and "
  98. "requires recent authentication. Log in again before retrying this request.";
  99. /** @var kFIRAuthErrorMessageProviderAlreadyLinked
  100. @brief Message for @c FIRAuthErrorCodeProviderAlreadyExists error code.
  101. */
  102. static NSString *const kFIRAuthErrorMessageProviderAlreadyLinked =
  103. @"[ERROR_PROVIDER_ALREADY_LINKED] - User can only be linked to one identity for the given "
  104. "provider.";
  105. /** @var kFIRAuthErrorMessageNoSuchProvider
  106. @brief Message for @c FIRAuthErrorCodeNoSuchProvider error code.
  107. */
  108. static NSString *const kFIRAuthErrorMessageNoSuchProvider = @"User was not linked to an account "
  109. "with the given provider.";
  110. /** @var kFIRAuthErrorMessageInvalidUserToken
  111. @brief Message for @c FIRAuthErrorCodeInvalidUserToken error code.
  112. */
  113. static NSString *const kFIRAuthErrorMessageInvalidUserToken = @"The user's credential is no longer "
  114. "valid. The user must sign in again.";
  115. /** @var kFIRAuthErrorMessageNetworkError
  116. @brief Message for @c FIRAuthErrorCodeNetworkError error code.
  117. */
  118. static NSString *const kFIRAuthErrorMessageNetworkError = @"Network error (such as timeout, "
  119. "interrupted connection or unreachable host) has occurred.";
  120. /** @var kFIRAuthErrorMessageKeychainError
  121. @brief Message for @c FIRAuthErrorCodeKeychainError error code.
  122. */
  123. static NSString *const kFIRAuthErrorMessageKeychainError = @"An error occurred when accessing the "
  124. "keychain. The @c NSLocalizedFailureReasonErrorKey field in the @c NSError.userInfo dictionary "
  125. "will contain more information about the error encountered";
  126. /** @var kFIRAuthErrorMessageUserTokenExpired
  127. @brief Message for @c FIRAuthErrorCodeTokenExpired error code.
  128. */
  129. static NSString *const kFIRAuthErrorMessageUserTokenExpired = @"The user's credential is no longer "
  130. "valid. The user must sign in again.";
  131. /** @var kFIRAuthErrorMessageUserNotFound
  132. @brief Message for @c FIRAuthErrorCodeUserNotFound error code.
  133. */
  134. static NSString *const kFIRAuthErrorMessageUserNotFound = @"There is no user record corresponding "
  135. "to this identifier. The user may have been deleted.";
  136. /** @var kFIRAuthErrorMessageInvalidAPIKey
  137. @brief Message for @c FIRAuthErrorCodeInvalidAPIKey error code.
  138. @remarks This error is not thrown by the server.
  139. */
  140. static NSString *const kFIRAuthErrorMessageInvalidAPIKey = @"An invalid API Key was supplied in "
  141. "the request.";
  142. /** @var kFIRAuthErrorMessageUserMismatch.
  143. @brief Message for @c FIRAuthErrorCodeInvalidAPIKey error code.
  144. */
  145. static NSString *const FIRAuthErrorMessageUserMismatch = @"The supplied credentials do not "
  146. "correspond to the previously signed in user.";
  147. /** @var kFIRAuthErrorMessageCredentialAlreadyInUse
  148. @brief Message for @c FIRAuthErrorCodeCredentialAlreadyInUse error code.
  149. */
  150. static NSString *const kFIRAuthErrorMessageCredentialAlreadyInUse = @"This credential is already "
  151. "associated with a different user account.";
  152. /** @var kFIRAuthErrorMessageOperationNotAllowed
  153. @brief Message for @c FIRAuthErrorCodeOperationNotAllowed error code.
  154. */
  155. static NSString *const kFIRAuthErrorMessageOperationNotAllowed = @"The given sign-in provider is "
  156. "disabled for this Firebase project. Enable it in the Firebase console, under the sign-in "
  157. "method tab of the Auth section.";
  158. /** @var kFIRAuthErrorMessageWeakPassword
  159. @brief Message for @c FIRAuthErrorCodeWeakPassword error code.
  160. */
  161. static NSString *const kFIRAuthErrorMessageWeakPassword = @"The password must be 6 characters long "
  162. "or more.";
  163. /** @var kFIRAuthErrorMessageAppNotAuthorized
  164. @brief Message for @c FIRAuthErrorCodeAppNotAuthorized error code.
  165. */
  166. static NSString *const kFIRAuthErrorMessageAppNotAuthorized = @"This app is not authorized to use "
  167. "Firebase Authentication with the provided API key. Review your key configuration in the "
  168. "Google API console and ensure that it accepts requests from your app's bundle ID.";
  169. /** @var kFIRAuthErrorMessageExpiredActionCode
  170. @brief Message for @c FIRAuthErrorCodeExpiredActionCode error code.
  171. */
  172. static NSString *const kFIRAuthErrorMessageExpiredActionCode = @"The action code has expired.";
  173. /** @var kFIRAuthErrorMessageInvalidActionCode
  174. @brief Message for @c FIRAuthErrorCodeInvalidActionCode error code.
  175. */
  176. static NSString *const kFIRAuthErrorMessageInvalidActionCode = @"The action code is invalid. This "
  177. "can happen if the code is malformed, expired, or has already been used.";
  178. /** @var kFIRAuthErrorMessageInvalidMessagePayload
  179. @brief Message for @c FIRAuthErrorCodeInvalidMessagePayload error code.
  180. */
  181. static NSString *const kFIRAuthErrorMessageInvalidMessagePayload = @"The action code is invalid. "
  182. "This can happen if the code is malformed, expired, or has already been used.";
  183. /** @var kFIRAuthErrorMessageInvalidSender
  184. @brief Message for @c FIRAuthErrorCodeInvalidSender error code.
  185. */
  186. static NSString *const kFIRAuthErrorMessageInvalidSender = @"The email template corresponding to "
  187. "this action contains invalid characters in its message. Please fix by going to the Auth email "
  188. "templates section in the Firebase Console.";
  189. /** @var kFIRAuthErrorMessageInvalidRecipientEmail
  190. @brief Message for @c FIRAuthErrorCodeInvalidRecipient error code.
  191. */
  192. static NSString *const kFIRAuthErrorMessageInvalidRecipientEmail = @"The action code is invalid. "
  193. "This can happen if the code is malformed, expired, or has already been used.";
  194. /** @var kFIRAuthErrorMessageMissingIosBundleID
  195. @brief Message for @c FIRAuthErrorCodeMissingIosbundleID error code.
  196. */
  197. static NSString *const kFIRAuthErrorMessageMissingIosBundleID =
  198. @"An iOS Bundle ID must be provided if an App Store ID is provided.";
  199. /** @var kFIRAuthErrorMessageMissingAndroidPackageName
  200. @brief Message for @c FIRAuthErrorCodeMissingAndroidPackageName error code.
  201. */
  202. static NSString *const kFIRAuthErrorMessageMissingAndroidPackageName =
  203. @"An Android Package Name must be provided if the Android App is required to be installed.";
  204. /** @var kFIRAuthErrorMessageUnauthorizedDomain
  205. @brief Message for @c FIRAuthErrorCodeUnauthorizedDomain error code.
  206. */
  207. static NSString *const kFIRAuthErrorMessageUnauthorizedDomain = @"The domain of the continue URL "
  208. "is not whitelisted. Please whitelist the domain in the Firebase console.";
  209. /** @var kFIRAuthErrorMessageInvalidContinueURI
  210. @brief Message for @c FIRAuthErrorCodeInvalidContinueURI error code.
  211. */
  212. static NSString *const kFIRAuthErrorMessageInvalidContinueURI =
  213. @"The continue URL provided in the request is invalid.";
  214. /** @var kFIRAuthErrorMessageMissingEmail
  215. @brief Message for @c FIRAuthErrorCodeMissingEmail error code.
  216. */
  217. static NSString *const kFIRAuthErrorMessageMissingEmail = @"An email address must be provided.";
  218. /** @var kFIRAuthErrorMessageMissingContinueURI
  219. @brief Message for @c FIRAuthErrorCodeMissingContinueURI error code.
  220. */
  221. static NSString *const kFIRAuthErrorMessageMissingContinueURI =
  222. @"A continue URL must be provided in the request.";
  223. /** @var kFIRAuthErrorMessageMissingPhoneNumber
  224. @brief Message for @c FIRAuthErrorCodeMissingPhoneNumber error code.
  225. */
  226. static NSString *const kFIRAuthErrorMessageMissingPhoneNumber =
  227. @"To send verification codes, provide a phone number for the recipient.";
  228. /** @var kFIRAuthErrorMessageInvalidPhoneNumber
  229. @brief Message for @c FIRAuthErrorCodeInvalidPhoneNumber error code.
  230. */
  231. static NSString *const kFIRAuthErrorMessageInvalidPhoneNumber =
  232. @"The format of the phone number provided is incorrect. Please enter the phone number in a "
  233. "format that can be parsed into E.164 format. E.164 phone numbers are written in the format "
  234. "[+][country code][subscriber number including area code].";
  235. /** @var kFIRAuthErrorMessageMissingVerificationCode
  236. @brief Message for @c FIRAuthErrorCodeMissingVerificationCode error code.
  237. */
  238. static NSString *const kFIRAuthErrorMessageMissingVerificationCode =
  239. @"The phone auth credential was created with an empty SMS verification Code.";
  240. /** @var kFIRAuthErrorMessageInvalidVerificationCode
  241. @brief Message for @c FIRAuthErrorCodeInvalidVerificationCode error code.
  242. */
  243. static NSString *const kFIRAuthErrorMessageInvalidVerificationCode =
  244. @"The SMS verification code used to create the phone auth credential is invalid. Please resend "
  245. "the verification code SMS and be sure to use the verification code provided by the user.";
  246. /** @var kFIRAuthErrorMessageMissingVerificationID
  247. @brief Message for @c FIRAuthErrorCodeInvalidVerificationID error code.
  248. */
  249. static NSString *const kFIRAuthErrorMessageMissingVerificationID =
  250. @"The phone auth credential was created with an empty verification ID.";
  251. /** @var kFIRAuthErrorMessageInvalidVerificationID
  252. @brief Message for @c FIRAuthErrorCodeInvalidVerificationID error code.
  253. */
  254. static NSString *const kFIRAuthErrorMessageInvalidVerificationID =
  255. @"The verification ID used to create the phone auth credential is invalid.";
  256. /** @var kFIRAuthErrorMessageSessionExpired
  257. @brief Message for @c FIRAuthErrorCodeSessionExpired error code.
  258. */
  259. static NSString *const kFIRAuthErrorMessageSessionExpired = @"The SMS code has expired. Please "
  260. @"re-send the verification code to try again.";
  261. /** @var kFIRAuthErrorMessageMissingAppCredential
  262. @brief Message for @c FIRAuthErrorCodeMissingAppCredential error code.
  263. */
  264. static NSString *const kFIRAuthErrorMessageMissingAppCredential = @"The phone verification request "
  265. "is missing an APNs Device token. Firebase Auth automatically detects APNs Device Tokens, "
  266. "however, if method swizzling is disabled, the APNs token must be set via the APNSToken "
  267. "property on FIRAuth or by calling setAPNSToken:type on FIRAuth.";
  268. /** @var kFIRAuthErrorMessageInvalidAppCredential
  269. @brief Message for @c FIRAuthErrorCodeInvalidAppCredential error code.
  270. */
  271. static NSString *const kFIRAuthErrorMessageInvalidAppCredential = @"The APNs device token provided "
  272. "is either incorrect or does not match the private certificate uploaded to the Firebase "
  273. "Console.";
  274. /** @var kFIRAuthErrorMessageQuotaExceeded
  275. @brief Message for @c FIRAuthErrorCodeQuotaExceeded error code.
  276. */
  277. static NSString *const kFIRAuthErrorMessageQuotaExceeded = @"The phone verification quota for this "
  278. "project has been exceeded.";
  279. /** @var kFIRAuthErrorMessageMissingAppToken
  280. @brief Message for @c FIRAuthErrorCodeMissingAppToken error code.
  281. */
  282. static NSString *const kFIRAuthErrorMessageMissingAppToken = @"There seems to be a problem with "
  283. "your project's Firebase phone number authentication set-up, please make sure to follow the "
  284. "instructions found at https://firebase.google.com/docs/auth/ios/phone-auth";
  285. /** @var kFIRAuthErrorMessageMissingAppToken
  286. @brief Message for @c FIRAuthErrorCodeMissingAppToken error code.
  287. */
  288. static NSString *const kFIRAuthErrorMessageNotificationNotForwarded = @"If app delegate swizzling "
  289. "is disabled, remote notifications received by UIApplicationDelegate need to be forwarded to "
  290. "FIRAuth's canHandleNotificaton: method.";
  291. /** @var kFIRAuthErrorMessageAppNotVerified
  292. @brief Message for @c FIRAuthErrorCodeMissingAppToken error code.
  293. */
  294. static NSString *const kFIRAuthErrorMessageAppNotVerified = @"Firebase could not retrieve the "
  295. "silent push notification and therefore could not verify your app. Ensure that you configured "
  296. "your app correctly to recieve push notifications.";
  297. /** @var kFIRAuthErrorMessageCaptchaCheckFailed
  298. @brief Message for @c FIRAuthErrorCodeCaptchaCheckFailed error code.
  299. */
  300. static NSString *const kFIRAuthErrorMessageCaptchaCheckFailed = @"The reCAPTCHA response token "
  301. "provided is either invalid, expired or already";
  302. /** @var kFIRAuthErrorMessageWebContextAlreadyPresented
  303. @brief Message for @c FIRAuthErrorCodeWebContextAlreadyPresented error code.
  304. */
  305. static NSString *const kFIRAuthErrorMessageWebContextAlreadyPresented = @"User interaction is "
  306. "still ongoing, another view cannot be presented.";
  307. /** @var kFIRAuthErrorMessageWebContextCancelled
  308. @brief Message for @c FIRAuthErrorCodeWebContextCancelled error code.
  309. */
  310. static NSString *const kFIRAuthErrorMessageWebContextCancelled = @"The interaction was cancelled "
  311. "by the user.";
  312. /** @var kFIRAuthErrorMessageInvalidClientID
  313. @brief Message for @c FIRAuthErrorCodeInvalidClientID error code.
  314. */
  315. static NSString *const kFIRAuthErrorMessageInvalidClientID = @"The OAuth client ID provided is "
  316. "either invalid or does not match the specified API key.";
  317. /** @var kFIRAuthErrorMessageWebRequestFailed
  318. @brief Message for @c FIRAuthErrorCodeWebRequestFailed error code.
  319. */
  320. static NSString *const kFIRAuthErrorMessageWebRequestFailed = @"A network error (such as timeout, "
  321. "interrupted connection, or unreachable host) has occurred within the web context.";
  322. /** @var kFIRAuthErrorMessageWebInternalError
  323. @brief Message for @c FIRAuthErrorCodeWebInternalError error code.
  324. */
  325. static NSString *const kFIRAuthErrorMessageWebInternalError = @"An internal error has occurred "
  326. "within the SFSafariViewController or UIWebView.";
  327. /** @var kFIRAuthErrorMessageAppVerificationUserInteractionFailure
  328. @brief Message for @c FIRAuthErrorCodeInvalidClientID error code.
  329. */
  330. static NSString *const kFIRAuthErrorMessageAppVerificationUserInteractionFailure = @"The app "
  331. "verification process has failed, print and inspect the error details for more information";
  332. /** @var kFIRAuthErrorMessageInternalError
  333. @brief Message for @c FIRAuthErrorCodeInternalError error code.
  334. */
  335. static NSString *const kFIRAuthErrorMessageInternalError = @"An internal error has occurred, "
  336. "print and inspect the error details for more information.";
  337. /** @var FIRAuthErrorDescription
  338. @brief The error descrioption, based on the error code.
  339. @remarks No default case so that we get a compiler warning if a new value was added to the enum.
  340. */
  341. static NSString *FIRAuthErrorDescription(FIRAuthErrorCode code) {
  342. switch (code) {
  343. case FIRAuthErrorCodeInvalidCustomToken:
  344. return kFIRAuthErrorMessageInvalidCustomToken;
  345. case FIRAuthErrorCodeCustomTokenMismatch:
  346. return kFIRAuthErrorMessageCustomTokenMismatch;
  347. case FIRAuthErrorCodeInvalidEmail:
  348. return kFIRAuthErrorMessageInvalidEmail;
  349. case FIRAuthErrorCodeInvalidCredential:
  350. return kFIRAuthErrorMessageInvalidCredential;
  351. case FIRAuthErrorCodeUserDisabled:
  352. return kFIRAuthErrorMessageUserDisabled;
  353. case FIRAuthErrorCodeEmailAlreadyInUse:
  354. return kFIRAuthErrorMessageEmailAlreadyInUse;
  355. case FIRAuthErrorCodeWrongPassword:
  356. return kFIRAuthErrorMessageWrongPassword;
  357. case FIRAuthErrorCodeTooManyRequests:
  358. return kFIRAuthErrorMessageTooManyRequests;
  359. case FIRAuthErrorCodeAccountExistsWithDifferentCredential:
  360. return kFIRAuthErrorMessageAccountExistsWithDifferentCredential;
  361. case FIRAuthErrorCodeRequiresRecentLogin:
  362. return kFIRAuthErrorMessageRequiresRecentLogin;
  363. case FIRAuthErrorCodeProviderAlreadyLinked:
  364. return kFIRAuthErrorMessageProviderAlreadyLinked;
  365. case FIRAuthErrorCodeNoSuchProvider:
  366. return kFIRAuthErrorMessageNoSuchProvider;
  367. case FIRAuthErrorCodeInvalidUserToken:
  368. return kFIRAuthErrorMessageInvalidUserToken;
  369. case FIRAuthErrorCodeNetworkError:
  370. return kFIRAuthErrorMessageNetworkError;
  371. case FIRAuthErrorCodeKeychainError:
  372. return kFIRAuthErrorMessageKeychainError;
  373. case FIRAuthErrorCodeUserTokenExpired:
  374. return kFIRAuthErrorMessageUserTokenExpired;
  375. case FIRAuthErrorCodeUserNotFound:
  376. return kFIRAuthErrorMessageUserNotFound;
  377. case FIRAuthErrorCodeInvalidAPIKey:
  378. return kFIRAuthErrorMessageInvalidAPIKey;
  379. case FIRAuthErrorCodeCredentialAlreadyInUse:
  380. return kFIRAuthErrorMessageCredentialAlreadyInUse;
  381. case FIRAuthErrorCodeInternalError:
  382. return kFIRAuthErrorMessageInternalError;
  383. case FIRAuthErrorCodeUserMismatch:
  384. return FIRAuthErrorMessageUserMismatch;
  385. case FIRAuthErrorCodeOperationNotAllowed:
  386. return kFIRAuthErrorMessageOperationNotAllowed;
  387. case FIRAuthErrorCodeWeakPassword:
  388. return kFIRAuthErrorMessageWeakPassword;
  389. case FIRAuthErrorCodeAppNotAuthorized:
  390. return kFIRAuthErrorMessageAppNotAuthorized;
  391. case FIRAuthErrorCodeExpiredActionCode:
  392. return kFIRAuthErrorMessageExpiredActionCode;
  393. case FIRAuthErrorCodeInvalidActionCode:
  394. return kFIRAuthErrorMessageInvalidActionCode;
  395. case FIRAuthErrorCodeInvalidSender:
  396. return kFIRAuthErrorMessageInvalidSender;
  397. case FIRAuthErrorCodeInvalidMessagePayload:
  398. return kFIRAuthErrorMessageInvalidMessagePayload;
  399. case FIRAuthErrorCodeInvalidRecipientEmail:
  400. return kFIRAuthErrorMessageInvalidRecipientEmail;
  401. case FIRAuthErrorCodeMissingIosBundleID:
  402. return kFIRAuthErrorMessageMissingIosBundleID;
  403. case FIRAuthErrorCodeMissingAndroidPackageName:
  404. return kFIRAuthErrorMessageMissingAndroidPackageName;
  405. case FIRAuthErrorCodeUnauthorizedDomain:
  406. return kFIRAuthErrorMessageUnauthorizedDomain;
  407. case FIRAuthErrorCodeInvalidContinueURI:
  408. return kFIRAuthErrorMessageInvalidContinueURI;
  409. case FIRAuthErrorCodeMissingContinueURI:
  410. return kFIRAuthErrorMessageMissingContinueURI;
  411. case FIRAuthErrorCodeMissingEmail:
  412. return kFIRAuthErrorMessageMissingEmail;
  413. case FIRAuthErrorCodeMissingPhoneNumber:
  414. return kFIRAuthErrorMessageMissingPhoneNumber;
  415. case FIRAuthErrorCodeInvalidPhoneNumber:
  416. return kFIRAuthErrorMessageInvalidPhoneNumber;
  417. case FIRAuthErrorCodeMissingVerificationCode:
  418. return kFIRAuthErrorMessageMissingVerificationCode;
  419. case FIRAuthErrorCodeInvalidVerificationCode:
  420. return kFIRAuthErrorMessageInvalidVerificationCode;
  421. case FIRAuthErrorCodeMissingVerificationID:
  422. return kFIRAuthErrorMessageMissingVerificationID;
  423. case FIRAuthErrorCodeInvalidVerificationID:
  424. return kFIRAuthErrorMessageInvalidVerificationID;
  425. case FIRAuthErrorCodeSessionExpired:
  426. return kFIRAuthErrorMessageSessionExpired;
  427. case FIRAuthErrorCodeMissingAppCredential:
  428. return kFIRAuthErrorMessageMissingAppCredential;
  429. case FIRAuthErrorCodeInvalidAppCredential:
  430. return kFIRAuthErrorMessageInvalidAppCredential;
  431. case FIRAuthErrorCodeQuotaExceeded:
  432. return kFIRAuthErrorMessageQuotaExceeded;
  433. case FIRAuthErrorCodeMissingAppToken:
  434. return kFIRAuthErrorMessageMissingAppToken;
  435. case FIRAuthErrorCodeNotificationNotForwarded:
  436. return kFIRAuthErrorMessageNotificationNotForwarded;
  437. case FIRAuthErrorCodeAppNotVerified:
  438. return kFIRAuthErrorMessageAppNotVerified;
  439. case FIRAuthErrorCodeCaptchaCheckFailed:
  440. return kFIRAuthErrorMessageCaptchaCheckFailed;
  441. case FIRAuthErrorCodeWebContextAlreadyPresented:
  442. return kFIRAuthErrorMessageWebContextAlreadyPresented;
  443. case FIRAuthErrorCodeWebContextCancelled:
  444. return kFIRAuthErrorMessageWebContextCancelled;
  445. case FIRAuthErrorCodeInvalidClientID:
  446. return kFIRAuthErrorMessageInvalidClientID;
  447. case FIRAuthErrorCodeAppVerificationUserInteractionFailure:
  448. return kFIRAuthErrorMessageAppVerificationUserInteractionFailure;
  449. case FIRAuthErrorCodeWebNetworkRequestFailed:
  450. return kFIRAuthErrorMessageWebRequestFailed;
  451. case FIRAuthErrorCodeWebInternalError:
  452. return kFIRAuthErrorMessageWebInternalError;
  453. }
  454. }
  455. /** @var FIRAuthErrorCodeString
  456. @brief The the error short string, based on the error code.
  457. @remarks No default case so that we get a compiler warning if a new value was added to the enum.
  458. */
  459. static NSString *const FIRAuthErrorCodeString(FIRAuthErrorCode code) {
  460. switch (code) {
  461. case FIRAuthErrorCodeInvalidCustomToken:
  462. return @"ERROR_INVALID_CUSTOM_TOKEN";
  463. case FIRAuthErrorCodeCustomTokenMismatch:
  464. return @"ERROR_CUSTOM_TOKEN_MISMATCH";
  465. case FIRAuthErrorCodeInvalidEmail:
  466. return @"ERROR_INVALID_EMAIL";
  467. case FIRAuthErrorCodeInvalidCredential:
  468. return @"ERROR_INVALID_CREDENTIAL";
  469. case FIRAuthErrorCodeUserDisabled:
  470. return @"ERROR_USER_DISABLED";
  471. case FIRAuthErrorCodeEmailAlreadyInUse:
  472. return @"ERROR_EMAIL_ALREADY_IN_USE";
  473. case FIRAuthErrorCodeWrongPassword:
  474. return @"ERROR_WRONG_PASSWORD";
  475. case FIRAuthErrorCodeTooManyRequests:
  476. return @"ERROR_TOO_MANY_REQUESTS";
  477. case FIRAuthErrorCodeAccountExistsWithDifferentCredential:
  478. return @"ERROR_ACCOUNT_EXISTS_WITH_DIFFERENT_CREDENTIAL";
  479. case FIRAuthErrorCodeRequiresRecentLogin:
  480. return @"ERROR_REQUIRES_RECENT_LOGIN";
  481. case FIRAuthErrorCodeProviderAlreadyLinked:
  482. return @"ERROR_PROVIDER_ALREADY_LINKED";
  483. case FIRAuthErrorCodeNoSuchProvider:
  484. return @"ERROR_NO_SUCH_PROVIDER";
  485. case FIRAuthErrorCodeInvalidUserToken:
  486. return @"ERROR_INVALID_USER_TOKEN";
  487. case FIRAuthErrorCodeNetworkError:
  488. return @"ERROR_NETWORK_REQUEST_FAILED";
  489. case FIRAuthErrorCodeKeychainError:
  490. return @"ERROR_KEYCHAIN_ERROR";
  491. case FIRAuthErrorCodeUserTokenExpired:
  492. return @"ERROR_USER_TOKEN_EXPIRED";
  493. case FIRAuthErrorCodeUserNotFound:
  494. return @"ERROR_USER_NOT_FOUND";
  495. case FIRAuthErrorCodeInvalidAPIKey:
  496. return @"ERROR_INVALID_API_KEY";
  497. case FIRAuthErrorCodeCredentialAlreadyInUse:
  498. return @"ERROR_CREDENTIAL_ALREADY_IN_USE";
  499. case FIRAuthErrorCodeInternalError:
  500. return @"ERROR_INTERNAL_ERROR";
  501. case FIRAuthErrorCodeUserMismatch:
  502. return @"ERROR_USER_MISMATCH";
  503. case FIRAuthErrorCodeOperationNotAllowed:
  504. return @"ERROR_OPERATION_NOT_ALLOWED";
  505. case FIRAuthErrorCodeWeakPassword:
  506. return @"ERROR_WEAK_PASSWORD";
  507. case FIRAuthErrorCodeAppNotAuthorized:
  508. return @"ERROR_APP_NOT_AUTHORIZED";
  509. case FIRAuthErrorCodeExpiredActionCode:
  510. return @"ERROR_EXPIRED_ACTION_CODE";
  511. case FIRAuthErrorCodeInvalidActionCode:
  512. return @"ERROR_INVALID_ACTION_CODE";
  513. case FIRAuthErrorCodeInvalidMessagePayload:
  514. return @"ERROR_INVALID_MESSAGE_PAYLOAD";
  515. case FIRAuthErrorCodeInvalidSender:
  516. return @"ERROR_INVALID_SENDER";
  517. case FIRAuthErrorCodeInvalidRecipientEmail:
  518. return @"ERROR_INVALID_RECIPIENT_EMAIL";
  519. case FIRAuthErrorCodeMissingIosBundleID:
  520. return @"ERROR_MISSING_IOS_BUNDLE_ID";
  521. case FIRAuthErrorCodeMissingAndroidPackageName:
  522. return @"ERROR_MISSING_ANDROID_PKG_NAME";
  523. case FIRAuthErrorCodeUnauthorizedDomain:
  524. return @"ERROR_UNAUTHORIZED_DOMAIN";
  525. case FIRAuthErrorCodeInvalidContinueURI:
  526. return @"ERROR_INVALID_CONTINUE_URI";
  527. case FIRAuthErrorCodeMissingContinueURI:
  528. return @"ERROR_MISSING_CONTINUE_URI";
  529. case FIRAuthErrorCodeMissingEmail:
  530. return @"ERROR_MISSING_EMAIL";
  531. case FIRAuthErrorCodeMissingPhoneNumber:
  532. return @"ERROR_MISSING_PHONE_NUMBER";
  533. case FIRAuthErrorCodeInvalidPhoneNumber:
  534. return @"ERROR_INVALID_PHONE_NUMBER";
  535. case FIRAuthErrorCodeMissingVerificationCode:
  536. return @"ERROR_MISSING_VERIFICATION_CODE";
  537. case FIRAuthErrorCodeInvalidVerificationCode:
  538. return @"ERROR_INVALID_VERIFICATION_CODE";
  539. case FIRAuthErrorCodeMissingVerificationID:
  540. return @"ERROR_MISSING_VERIFICATION_ID";
  541. case FIRAuthErrorCodeInvalidVerificationID:
  542. return @"ERROR_INVALID_VERIFICATION_ID";
  543. case FIRAuthErrorCodeSessionExpired:
  544. return @"ERROR_SESSION_EXPIRED";
  545. case FIRAuthErrorCodeMissingAppCredential:
  546. return @"MISSING_APP_CREDENTIAL";
  547. case FIRAuthErrorCodeInvalidAppCredential:
  548. return @"INVALID_APP_CREDENTIAL";
  549. case FIRAuthErrorCodeQuotaExceeded:
  550. return @"ERROR_QUOTA_EXCEEDED";
  551. case FIRAuthErrorCodeMissingAppToken:
  552. return @"ERROR_MISSING_APP_TOKEN";
  553. case FIRAuthErrorCodeNotificationNotForwarded:
  554. return @"ERROR_NOTIFICATION_NOT_FORWARDED";
  555. case FIRAuthErrorCodeAppNotVerified:
  556. return @"ERROR_APP_NOT_VERIFIED";
  557. case FIRAuthErrorCodeCaptchaCheckFailed:
  558. return @"ERROR_CAPTCHA_CHECK_FAILED";
  559. case FIRAuthErrorCodeWebContextAlreadyPresented:
  560. return @"ERROR_WEB_CONTEXT_ALREADY_PRESENTED";
  561. case FIRAuthErrorCodeWebContextCancelled:
  562. return @"ERROR_WEB_CONTEXT_CANCELLED";
  563. case FIRAuthErrorCodeInvalidClientID:
  564. return @"ERROR_INVALID_CLIENT_ID";
  565. case FIRAuthErrorCodeAppVerificationUserInteractionFailure:
  566. return @"ERROR_APP_VERIFICATION_FAILED";
  567. case FIRAuthErrorCodeWebNetworkRequestFailed:
  568. return @"ERROR_WEB_NETWORK_REQUEST_FAILED";
  569. case FIRAuthErrorCodeWebInternalError:
  570. return @"ERROR_WEB_INTERNAL_ERROR";
  571. }
  572. }
  573. @implementation FIRAuthErrorUtils
  574. + (NSError *)errorWithCode:(FIRAuthInternalErrorCode)code {
  575. return [self errorWithCode:code message:nil];
  576. }
  577. + (NSError *)errorWithCode:(FIRAuthInternalErrorCode)code
  578. message:(nullable NSString *)message {
  579. NSDictionary *userInfo = nil;
  580. if (message.length) {
  581. userInfo = @{
  582. NSLocalizedDescriptionKey : message
  583. };
  584. }
  585. return [self errorWithCode:code userInfo:userInfo];
  586. }
  587. + (NSError *)errorWithCode:(FIRAuthInternalErrorCode)code
  588. underlyingError:(nullable NSError *)underlyingError {
  589. NSDictionary *errorUserInfo = nil;
  590. if (underlyingError) {
  591. errorUserInfo = @{
  592. NSUnderlyingErrorKey : underlyingError
  593. };
  594. }
  595. return [self errorWithCode:code userInfo:errorUserInfo];
  596. }
  597. + (NSError *)errorWithCode:(FIRAuthInternalErrorCode)code userInfo:(NSDictionary *)userInfo {
  598. BOOL isPublic = (code & FIRAuthPublicErrorCodeFlag) == FIRAuthPublicErrorCodeFlag;
  599. if (isPublic) {
  600. // This is a public error. Return it as a public error and add a description.
  601. NSInteger errorCode = code & ~FIRAuthPublicErrorCodeFlag;
  602. NSMutableDictionary *errorUserInfo = [NSMutableDictionary dictionaryWithDictionary:userInfo];
  603. if (!errorUserInfo[NSLocalizedDescriptionKey]) {
  604. errorUserInfo[NSLocalizedDescriptionKey] = FIRAuthErrorDescription(errorCode);
  605. }
  606. errorUserInfo[FIRAuthErrorNameKey] = FIRAuthErrorCodeString(errorCode);
  607. return [NSError errorWithDomain:FIRAuthErrorDomain code:errorCode userInfo:errorUserInfo];
  608. } else {
  609. // This is an internal error. Wrap it in an internal error.
  610. NSError *error =
  611. [NSError errorWithDomain:FIRAuthInternalErrorDomain code:code userInfo:userInfo];
  612. return [self errorWithCode:FIRAuthInternalErrorCodeInternalError underlyingError:error];
  613. }
  614. }
  615. + (NSError *)RPCRequestEncodingErrorWithUnderlyingError:(NSError *)underlyingError {
  616. return [self errorWithCode:FIRAuthInternalErrorCodeRPCRequestEncodingError
  617. underlyingError:underlyingError];
  618. }
  619. + (NSError *)JSONSerializationErrorForUnencodableType {
  620. return [self errorWithCode:FIRAuthInternalErrorCodeJSONSerializationError];
  621. }
  622. + (NSError *)JSONSerializationErrorWithUnderlyingError:(NSError *)underlyingError {
  623. return [self errorWithCode:FIRAuthInternalErrorCodeJSONSerializationError
  624. underlyingError:underlyingError];
  625. }
  626. + (NSError *)networkErrorWithUnderlyingError:(NSError *)underlyingError {
  627. return [self errorWithCode:FIRAuthInternalErrorCodeNetworkError
  628. underlyingError:underlyingError];
  629. }
  630. + (NSError *)unexpectedErrorResponseWithData:(NSData *)data
  631. underlyingError:(NSError *)underlyingError {
  632. return [self errorWithCode:FIRAuthInternalErrorCodeUnexpectedErrorResponse userInfo:@{
  633. FIRAuthErrorUserInfoDataKey : data,
  634. NSUnderlyingErrorKey : underlyingError
  635. }];
  636. }
  637. + (NSError *)unexpectedErrorResponseWithDeserializedResponse:(id)deserializedResponse {
  638. return [self errorWithCode:FIRAuthInternalErrorCodeUnexpectedErrorResponse userInfo:@{
  639. FIRAuthErrorUserInfoDeserializedResponseKey : deserializedResponse
  640. }];
  641. }
  642. + (NSError *)unexpectedResponseWithData:(NSData *)data
  643. underlyingError:(NSError *)underlyingError {
  644. return [self errorWithCode:FIRAuthInternalErrorCodeUnexpectedResponse userInfo:@{
  645. FIRAuthErrorUserInfoDataKey : data,
  646. NSUnderlyingErrorKey : underlyingError
  647. }];
  648. }
  649. + (NSError *)unexpectedResponseWithDeserializedResponse:(id)deserializedResponse {
  650. return [self errorWithCode:FIRAuthInternalErrorCodeUnexpectedResponse userInfo:@{
  651. FIRAuthErrorUserInfoDeserializedResponseKey : deserializedResponse
  652. }];
  653. }
  654. + (NSError *)unexpectedResponseWithDeserializedResponse:(nullable id)deserializedResponse
  655. underlyingError:(NSError *)underlyingError {
  656. NSMutableDictionary *userInfo =
  657. [NSMutableDictionary dictionaryWithDictionary:@{ NSUnderlyingErrorKey : underlyingError }];
  658. if (deserializedResponse) {
  659. userInfo[FIRAuthErrorUserInfoDeserializedResponseKey] = deserializedResponse;
  660. }
  661. return [self errorWithCode:FIRAuthInternalErrorCodeUnexpectedResponse userInfo:userInfo];
  662. }
  663. + (NSError *)RPCResponseDecodingErrorWithDeserializedResponse:(id)deserializedResponse
  664. underlyingError:(NSError *)underlyingError {
  665. return [self errorWithCode:FIRAuthInternalErrorCodeRPCResponseDecodingError userInfo:@{
  666. FIRAuthErrorUserInfoDeserializedResponseKey : deserializedResponse,
  667. NSUnderlyingErrorKey : underlyingError
  668. }];
  669. }
  670. + (NSError *)emailAlreadyInUseErrorWithEmail:(nullable NSString *)email {
  671. NSMutableDictionary *userInfo = [[NSMutableDictionary alloc] init];
  672. if (email.length) {
  673. userInfo[FIRAuthErrorUserInfoEmailKey] = email;
  674. }
  675. return [self errorWithCode:FIRAuthInternalErrorCodeEmailAlreadyInUse userInfo:userInfo];
  676. }
  677. + (NSError *)userDisabledErrorWithMessage:(nullable NSString *)message {
  678. return [self errorWithCode:FIRAuthInternalErrorCodeUserDisabled message:message];
  679. }
  680. + (NSError *)wrongPasswordErrorWithMessage:(nullable NSString *)message {
  681. return [self errorWithCode:FIRAuthInternalErrorCodeWrongPassword message:message];
  682. }
  683. + (NSError *)tooManyRequestsErrorWithMessage:(nullable NSString *)message {
  684. return [self errorWithCode:FIRAuthInternalErrorCodeTooManyRequests message:message];
  685. }
  686. + (NSError *)invalidCustomTokenErrorWithMessage:(nullable NSString *)message {
  687. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidCustomToken message:message];
  688. }
  689. + (NSError *)customTokenMistmatchErrorWithMessage:(nullable NSString *)message {
  690. return [self errorWithCode:FIRAuthInternalErrorCodeCustomTokenMismatch message:message];
  691. }
  692. + (NSError *)invalidCredentialErrorWithMessage:(nullable NSString *)message {
  693. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidCredential message:message];
  694. }
  695. + (NSError *)requiresRecentLoginErrorWithMessage:(nullable NSString *)message {
  696. return [self errorWithCode:FIRAuthInternalErrorCodeRequiresRecentLogin message:message];
  697. }
  698. + (NSError *)invalidUserTokenErrorWithMessage:(nullable NSString *)message {
  699. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidUserToken message:message];
  700. }
  701. + (NSError *)invalidEmailErrorWithMessage:(nullable NSString *)message {
  702. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidEmail message:message];
  703. }
  704. + (NSError *)accountExistsWithDifferentCredentialErrorWithEmail:(nullable NSString *)email {
  705. return [self errorWithCode:FIRAuthInternalErrorCodeAccountExistsWithDifferentCredential
  706. userInfo:@{ FIRAuthErrorUserInfoEmailKey : email }];
  707. }
  708. + (NSError *)providerAlreadyLinkedError {
  709. return [self errorWithCode:FIRAuthInternalErrorCodeProviderAlreadyLinked];
  710. }
  711. + (NSError *)noSuchProviderError {
  712. return [self errorWithCode:FIRAuthInternalErrorCodeNoSuchProvider];
  713. }
  714. + (NSError *)userTokenExpiredErrorWithMessage:(nullable NSString *)message {
  715. return [self errorWithCode:FIRAuthInternalErrorCodeUserTokenExpired message:message];
  716. }
  717. + (NSError *)userNotFoundErrorWithMessage:(nullable NSString *)message {
  718. return [self errorWithCode:FIRAuthInternalErrorCodeUserNotFound message:message];
  719. }
  720. + (NSError *)invalidAPIKeyError {
  721. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidAPIKey];
  722. }
  723. + (NSError *)userMismatchError {
  724. return [self errorWithCode:FIRAuthInternalErrorCodeUserMismatch];
  725. }
  726. + (NSError *)credentialAlreadyInUseErrorWithMessage:(nullable NSString *)message
  727. credential:(nullable FIRPhoneAuthCredential *)credential {
  728. if (credential) {
  729. return [self errorWithCode:FIRAuthInternalErrorCodeCredentialAlreadyInUse
  730. userInfo:@{ FIRAuthUpdatedCredentialKey : credential }];
  731. }
  732. return [self errorWithCode:FIRAuthInternalErrorCodeCredentialAlreadyInUse message:message];
  733. }
  734. + (NSError *)operationNotAllowedErrorWithMessage:(nullable NSString *)message {
  735. return [self errorWithCode:FIRAuthInternalErrorCodeOperationNotAllowed message:message];
  736. }
  737. + (NSError *)weakPasswordErrorWithServerResponseReason:(NSString *)reason {
  738. return [self errorWithCode:FIRAuthInternalErrorCodeWeakPassword userInfo:@{
  739. NSLocalizedFailureReasonErrorKey : reason
  740. }];
  741. }
  742. + (NSError *)appNotAuthorizedError {
  743. return [self errorWithCode:FIRAuthInternalErrorCodeAppNotAuthorized];
  744. }
  745. + (NSError *)expiredActionCodeErrorWithMessage:(nullable NSString *)message {
  746. return [self errorWithCode:FIRAuthInternalErrorCodeExpiredActionCode message:message];
  747. }
  748. + (NSError *)invalidActionCodeErrorWithMessage:(nullable NSString *)message {
  749. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidActionCode message:message];
  750. }
  751. + (NSError *)invalidMessagePayloadErrorWithMessage:(nullable NSString *)message {
  752. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidMessagePayload message:message];
  753. }
  754. + (NSError *)invalidSenderErrorWithMessage:(nullable NSString *)message {
  755. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidSender message:message];
  756. }
  757. + (NSError *)invalidRecipientEmailErrorWithMessage:(nullable NSString *)message {
  758. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidRecipientEmail message:message];
  759. }
  760. + (NSError *)missingIosBundleIDErrorWithMessage:(nullable NSString *)message {
  761. return [self errorWithCode:FIRAuthinternalErrorCodeMissingIosBundleID message:message];
  762. }
  763. + (NSError *)missingAndroidPackageNameErrorWithMessage:(nullable NSString *)message {
  764. return [self errorWithCode:FIRAuthInternalErrorCodeMissingAndroidPackageName message:message];
  765. }
  766. + (NSError *)unauthorizedDomainErrorWithMessage:(nullable NSString *)message {
  767. return [self errorWithCode:FIRAuthInternalErrorCodeUnauthorizedDomain message:message];
  768. }
  769. + (NSError *)invalidContinueURIErrorWithMessage:(nullable NSString *)message {
  770. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidContinueURI message:message];
  771. }
  772. + (NSError *)missingContinueURIErrorWithMessage:(nullable NSString *)message {
  773. return[self errorWithCode:FIRAuthInternalErrorCodeMissingContinueURI message:message];
  774. }
  775. + (NSError *)missingEmailErrorWithMessage:(nullable NSString *)message {
  776. return [self errorWithCode:FIRAuthInternalErrorCodeMissingEmail message:message];
  777. }
  778. + (NSError *)missingPhoneNumberErrorWithMessage:(nullable NSString *)message {
  779. return [self errorWithCode:FIRAuthInternalErrorCodeMissingPhoneNumber message:message];
  780. }
  781. + (NSError *)invalidPhoneNumberErrorWithMessage:(nullable NSString *)message {
  782. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidPhoneNumber message:message];
  783. }
  784. + (NSError *)missingVerificationCodeErrorWithMessage:(nullable NSString *)message {
  785. return [self errorWithCode:FIRAuthInternalErrorCodeMissingVerificationCode message:message];
  786. }
  787. + (NSError *)invalidVerificationCodeErrorWithMessage:(nullable NSString *)message {
  788. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidVerificationCode message:message];
  789. }
  790. + (NSError *)missingVerificationIDErrorWithMessage:(nullable NSString *)message {
  791. return [self errorWithCode:FIRAuthInternalErrorCodeMissingVerificationID message:message];
  792. }
  793. + (NSError *)invalidVerificationIDErrorWithMessage:(nullable NSString *)message {
  794. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidVerificationID message:message];
  795. }
  796. + (NSError *)sessionExpiredErrorWithMessage:(nullable NSString *)message {
  797. return [self errorWithCode:FIRAuthInternalErrorCodeSessionExpired message:message];
  798. }
  799. + (NSError *)missingAppCredentialWithMessage:(nullable NSString *)message {
  800. return [self errorWithCode:FIRAuthInternalErrorCodeMissingAppCredential message:message];
  801. }
  802. + (NSError *)invalidAppCredentialWithMessage:(nullable NSString *)message {
  803. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidAppCredential message:message];
  804. }
  805. + (NSError *)quotaExceededErrorWithMessage:(nullable NSString *)message {
  806. return [self errorWithCode:FIRAuthInternalErrorCodeQuotaExceeded message:message];
  807. }
  808. + (NSError *)missingAppTokenErrorWithUnderlyingError:(nullable NSError *)underlyingError {
  809. return [self errorWithCode:FIRAuthInternalErrorCodeMissingAppToken
  810. underlyingError:underlyingError];
  811. }
  812. + (NSError *)notificationNotForwardedError {
  813. return [self errorWithCode:FIRAuthInternalErrorCodeNotificationNotForwarded];
  814. }
  815. + (NSError *)appNotVerifiedErrorWithMessage:(nullable NSString *)message {
  816. return [self errorWithCode:FIRAuthInternalErrorCodeAppNotVerified message:message];
  817. }
  818. + (NSError *)captchaCheckFailedErrorWithMessage:(nullable NSString *)message {
  819. return [self errorWithCode:FIRAuthInternalErrorCodeCaptchaCheckFailed message:message];
  820. }
  821. + (NSError *)webContextAlreadyPresentedErrorWithMessage:(nullable NSString *)message {
  822. return [self errorWithCode:FIRAuthInternalErrorCodeWebContextAlreadyPresented message:message];
  823. }
  824. + (NSError *)webContextCancelledErrorWithMessage:(nullable NSString *)message {
  825. return [self errorWithCode:FIRAuthInternalErrorCodeWebContextCancelled message:message];
  826. }
  827. + (NSError *)appVerificationUserInteractionFailureWithReason:(NSString *)reason {
  828. return [self errorWithCode:FIRAuthInternalErrorCodeAppVerificationUserInteractionFailure
  829. userInfo:@{
  830. NSLocalizedFailureReasonErrorKey : reason
  831. }];
  832. }
  833. + (NSError *)URLResponseErrorWithCode:(NSString *)code message:(nullable NSString *)message {
  834. if ([code isEqualToString:kURLResponseErrorCodeInvalidClientID]) {
  835. return [self errorWithCode:FIRAuthInternalErrorCodeInvalidClientID message:message];
  836. }
  837. if ([code isEqualToString:kURLResponseErrorCodeNetworkRequestFailed]) {
  838. return [self errorWithCode:FIRAuthInternalErrorCodeWebNetworkRequestFailed message:message];
  839. }
  840. if ([code isEqualToString:kURLResponseErrorCodeInternalError]) {
  841. return [self errorWithCode:FIRAuthInternalErrorCodeWebInternalError message:message];
  842. }
  843. return nil;
  844. }
  845. + (NSError *)keychainErrorWithFunction:(NSString *)keychainFunction status:(OSStatus)status {
  846. NSString *failureReason = [NSString stringWithFormat:@"%@ (%li)", keychainFunction, (long)status];
  847. return [self errorWithCode:FIRAuthInternalErrorCodeKeychainError userInfo:@{
  848. NSLocalizedFailureReasonErrorKey : failureReason,
  849. }];
  850. }
  851. @end
  852. NS_ASSUME_NONNULL_END