@firebase/auth 0.21.5 → 0.21.6-20230329040242

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +20 -0
  3. package/dist/auth-public.d.ts +136 -4
  4. package/dist/auth.d.ts +147 -4
  5. package/dist/browser-cjs/{index-ff477525.js → index-f0c95b47.js} +177 -4
  6. package/dist/browser-cjs/index-f0c95b47.js.map +1 -0
  7. package/dist/browser-cjs/index.d.ts +2 -1
  8. package/dist/browser-cjs/index.js +3 -1
  9. package/dist/browser-cjs/index.js.map +1 -1
  10. package/dist/browser-cjs/internal.js +3 -1
  11. package/dist/browser-cjs/internal.js.map +1 -1
  12. package/dist/browser-cjs/src/api/account_management/mfa.d.ts +38 -4
  13. package/dist/browser-cjs/src/api/authentication/mfa.d.ts +11 -0
  14. package/dist/browser-cjs/src/mfa/assertions/totp.d.ts +124 -0
  15. package/dist/browser-cjs/src/mfa/assertions/totp.test.d.ts +17 -0
  16. package/dist/browser-cjs/src/mfa/mfa_info.d.ts +5 -1
  17. package/dist/browser-cjs/src/model/enum_maps.d.ts +1 -0
  18. package/dist/browser-cjs/src/model/public_types.d.ts +18 -1
  19. package/dist/browser-cjs/test/helpers/integration/helpers.d.ts +3 -0
  20. package/dist/browser-cjs/test/integration/flows/totp.test.d.ts +17 -0
  21. package/dist/cordova/index.d.ts +2 -1
  22. package/dist/cordova/index.js +2 -2
  23. package/dist/cordova/internal.js +179 -3
  24. package/dist/cordova/internal.js.map +1 -1
  25. package/dist/cordova/{popup_redirect-a4d3c436.js → popup_redirect-ea399a63.js} +28 -5
  26. package/dist/cordova/popup_redirect-ea399a63.js.map +1 -0
  27. package/dist/cordova/src/api/account_management/mfa.d.ts +38 -4
  28. package/dist/cordova/src/api/authentication/mfa.d.ts +11 -0
  29. package/dist/cordova/src/mfa/assertions/totp.d.ts +124 -0
  30. package/dist/cordova/src/mfa/assertions/totp.test.d.ts +17 -0
  31. package/dist/cordova/src/mfa/mfa_info.d.ts +5 -1
  32. package/dist/cordova/src/model/enum_maps.d.ts +1 -0
  33. package/dist/cordova/src/model/public_types.d.ts +18 -1
  34. package/dist/cordova/test/helpers/integration/helpers.d.ts +3 -0
  35. package/dist/cordova/test/integration/flows/totp.test.d.ts +17 -0
  36. package/dist/esm2017/{index-3363a72a.js → index-998a92c6.js} +176 -5
  37. package/dist/esm2017/index-998a92c6.js.map +1 -0
  38. package/dist/esm2017/index.d.ts +2 -1
  39. package/dist/esm2017/index.js +1 -1
  40. package/dist/esm2017/internal.js +2 -2
  41. package/dist/esm2017/src/api/account_management/mfa.d.ts +38 -4
  42. package/dist/esm2017/src/api/authentication/mfa.d.ts +11 -0
  43. package/dist/esm2017/src/mfa/assertions/totp.d.ts +124 -0
  44. package/dist/esm2017/src/mfa/assertions/totp.test.d.ts +17 -0
  45. package/dist/esm2017/src/mfa/mfa_info.d.ts +5 -1
  46. package/dist/esm2017/src/model/enum_maps.d.ts +1 -0
  47. package/dist/esm2017/src/model/public_types.d.ts +18 -1
  48. package/dist/esm2017/test/helpers/integration/helpers.d.ts +3 -0
  49. package/dist/esm2017/test/integration/flows/totp.test.d.ts +17 -0
  50. package/dist/esm5/{index-3f05dc7b.js → index-14d0c8cb.js} +204 -5
  51. package/dist/esm5/index-14d0c8cb.js.map +1 -0
  52. package/dist/esm5/index.d.ts +2 -1
  53. package/dist/esm5/index.js +1 -1
  54. package/dist/esm5/internal.js +2 -2
  55. package/dist/esm5/src/api/account_management/mfa.d.ts +38 -4
  56. package/dist/esm5/src/api/authentication/mfa.d.ts +11 -0
  57. package/dist/esm5/src/mfa/assertions/totp.d.ts +124 -0
  58. package/dist/esm5/src/mfa/assertions/totp.test.d.ts +17 -0
  59. package/dist/esm5/src/mfa/mfa_info.d.ts +5 -1
  60. package/dist/esm5/src/model/enum_maps.d.ts +1 -0
  61. package/dist/esm5/src/model/public_types.d.ts +18 -1
  62. package/dist/esm5/test/helpers/integration/helpers.d.ts +3 -0
  63. package/dist/esm5/test/integration/flows/totp.test.d.ts +17 -0
  64. package/dist/index.d.ts +2 -1
  65. package/dist/index.webworker.esm5.js +20 -3
  66. package/dist/index.webworker.esm5.js.map +1 -1
  67. package/dist/node/index.d.ts +2 -1
  68. package/dist/node/index.js +83 -81
  69. package/dist/node/index.js.map +1 -1
  70. package/dist/node/internal.js +144 -142
  71. package/dist/node/internal.js.map +1 -1
  72. package/dist/node/src/api/account_management/mfa.d.ts +38 -4
  73. package/dist/node/src/api/authentication/mfa.d.ts +11 -0
  74. package/dist/node/src/mfa/assertions/totp.d.ts +124 -0
  75. package/dist/node/src/mfa/assertions/totp.test.d.ts +17 -0
  76. package/dist/node/src/mfa/mfa_info.d.ts +5 -1
  77. package/dist/node/src/model/enum_maps.d.ts +1 -0
  78. package/dist/node/src/model/public_types.d.ts +18 -1
  79. package/dist/node/test/helpers/integration/helpers.d.ts +3 -0
  80. package/dist/node/test/integration/flows/totp.test.d.ts +17 -0
  81. package/dist/node/{index-45468d80.js → totp-06ccbed7.js} +240 -5
  82. package/dist/node/totp-06ccbed7.js.map +1 -0
  83. package/dist/node-esm/index.d.ts +2 -1
  84. package/dist/node-esm/index.js +2 -2
  85. package/dist/node-esm/internal.js +3 -3
  86. package/dist/node-esm/src/api/account_management/mfa.d.ts +38 -4
  87. package/dist/node-esm/src/api/authentication/mfa.d.ts +11 -0
  88. package/dist/node-esm/src/mfa/assertions/totp.d.ts +124 -0
  89. package/dist/node-esm/src/mfa/assertions/totp.test.d.ts +17 -0
  90. package/dist/node-esm/src/mfa/mfa_info.d.ts +5 -1
  91. package/dist/node-esm/src/model/enum_maps.d.ts +1 -0
  92. package/dist/node-esm/src/model/public_types.d.ts +18 -1
  93. package/dist/node-esm/test/helpers/integration/helpers.d.ts +3 -0
  94. package/dist/node-esm/test/integration/flows/totp.test.d.ts +17 -0
  95. package/dist/node-esm/{index-1f9492de.js → totp-412ade8c.js} +210 -6
  96. package/dist/node-esm/totp-412ade8c.js.map +1 -0
  97. package/dist/rn/index.d.ts +2 -1
  98. package/dist/rn/index.js +1 -1
  99. package/dist/rn/internal.js +176 -1
  100. package/dist/rn/internal.js.map +1 -1
  101. package/dist/rn/{phone-e7bf48a1.js → phone-e85f18b7.js} +34 -4
  102. package/dist/rn/phone-e85f18b7.js.map +1 -0
  103. package/dist/rn/src/api/account_management/mfa.d.ts +38 -4
  104. package/dist/rn/src/api/authentication/mfa.d.ts +11 -0
  105. package/dist/rn/src/mfa/assertions/totp.d.ts +124 -0
  106. package/dist/rn/src/mfa/assertions/totp.test.d.ts +17 -0
  107. package/dist/rn/src/mfa/mfa_info.d.ts +5 -1
  108. package/dist/rn/src/model/enum_maps.d.ts +1 -0
  109. package/dist/rn/src/model/public_types.d.ts +18 -1
  110. package/dist/rn/test/helpers/integration/helpers.d.ts +3 -0
  111. package/dist/rn/test/integration/flows/totp.test.d.ts +17 -0
  112. package/dist/src/api/account_management/mfa.d.ts +38 -4
  113. package/dist/src/api/authentication/mfa.d.ts +11 -0
  114. package/dist/src/mfa/assertions/totp.d.ts +124 -0
  115. package/dist/src/mfa/assertions/totp.test.d.ts +17 -0
  116. package/dist/src/mfa/mfa_info.d.ts +5 -1
  117. package/dist/src/model/enum_maps.d.ts +1 -0
  118. package/dist/src/model/public_types.d.ts +18 -1
  119. package/dist/test/helpers/integration/helpers.d.ts +3 -0
  120. package/dist/test/integration/flows/totp.test.d.ts +17 -0
  121. package/package.json +5 -3
  122. package/dist/browser-cjs/index-ff477525.js.map +0 -1
  123. package/dist/cordova/popup_redirect-a4d3c436.js.map +0 -1
  124. package/dist/esm2017/index-3363a72a.js.map +0 -1
  125. package/dist/esm5/index-3f05dc7b.js.map +0 -1
  126. package/dist/node/index-45468d80.js.map +0 -1
  127. package/dist/node-esm/index-1f9492de.js.map +0 -1
  128. package/dist/rn/phone-e7bf48a1.js.map +0 -1
@@ -18,7 +18,7 @@ import { SignInWithPhoneNumberRequest } from '../authentication/sms';
18
18
  import { FinalizeMfaResponse } from '../authentication/mfa';
19
19
  import { AuthInternal } from '../../model/auth';
20
20
  /**
21
- * MFA Info as returned by the API
21
+ * MFA Info as returned by the API.
22
22
  */
23
23
  interface BaseMfaEnrollment {
24
24
  mfaEnrollmentId: string;
@@ -26,15 +26,20 @@ interface BaseMfaEnrollment {
26
26
  displayName?: string;
27
27
  }
28
28
  /**
29
- * An MFA provided by SMS verification
29
+ * An MFA provided by SMS verification.
30
30
  */
31
31
  export interface PhoneMfaEnrollment extends BaseMfaEnrollment {
32
32
  phoneInfo: string;
33
33
  }
34
34
  /**
35
- * MfaEnrollment can be any subtype of BaseMfaEnrollment, currently only PhoneMfaEnrollment is supported
35
+ * An MFA provided by TOTP (Time-based One Time Password).
36
36
  */
37
- export declare type MfaEnrollment = PhoneMfaEnrollment;
37
+ export interface TotpMfaEnrollment extends BaseMfaEnrollment {
38
+ }
39
+ /**
40
+ * MfaEnrollment can be any subtype of BaseMfaEnrollment, currently only PhoneMfaEnrollment and TotpMfaEnrollment are supported.
41
+ */
42
+ export declare type MfaEnrollment = PhoneMfaEnrollment | TotpMfaEnrollment;
38
43
  export interface StartPhoneMfaEnrollmentRequest {
39
44
  idToken: string;
40
45
  phoneEnrollmentInfo: {
@@ -58,6 +63,35 @@ export interface FinalizePhoneMfaEnrollmentRequest {
58
63
  export interface FinalizePhoneMfaEnrollmentResponse extends FinalizeMfaResponse {
59
64
  }
60
65
  export declare function finalizeEnrollPhoneMfa(auth: AuthInternal, request: FinalizePhoneMfaEnrollmentRequest): Promise<FinalizePhoneMfaEnrollmentResponse>;
66
+ export interface StartTotpMfaEnrollmentRequest {
67
+ idToken: string;
68
+ totpEnrollmentInfo: {};
69
+ tenantId?: string;
70
+ }
71
+ export interface StartTotpMfaEnrollmentResponse {
72
+ totpSessionInfo: {
73
+ sharedSecretKey: string;
74
+ verificationCodeLength: number;
75
+ hashingAlgorithm: string;
76
+ periodSec: number;
77
+ sessionInfo: string;
78
+ finalizeEnrollmentTime: number;
79
+ };
80
+ }
81
+ export declare function startEnrollTotpMfa(auth: AuthInternal, request: StartTotpMfaEnrollmentRequest): Promise<StartTotpMfaEnrollmentResponse>;
82
+ export interface TotpVerificationInfo {
83
+ sessionInfo: string;
84
+ verificationCode: string;
85
+ }
86
+ export interface FinalizeTotpMfaEnrollmentRequest {
87
+ idToken: string;
88
+ totpVerificationInfo: TotpVerificationInfo;
89
+ displayName?: string | null;
90
+ tenantId?: string;
91
+ }
92
+ export interface FinalizeTotpMfaEnrollmentResponse extends FinalizeMfaResponse {
93
+ }
94
+ export declare function finalizeEnrollTotpMfa(auth: AuthInternal, request: FinalizeTotpMfaEnrollmentRequest): Promise<FinalizeTotpMfaEnrollmentResponse>;
61
95
  export interface WithdrawMfaRequest {
62
96
  idToken: string;
63
97
  mfaEnrollmentId: string;
@@ -49,9 +49,20 @@ export interface FinalizePhoneMfaSignInRequest {
49
49
  phoneVerificationInfo: SignInWithPhoneNumberRequest;
50
50
  tenantId?: string;
51
51
  }
52
+ export interface FinalizeTotpMfaSignInRequest {
53
+ mfaPendingCredential: string;
54
+ totpVerificationInfo: {
55
+ verificationCode: string;
56
+ };
57
+ tenantId?: string;
58
+ mfaEnrollmentId: string;
59
+ }
52
60
  export interface FinalizePhoneMfaSignInResponse extends FinalizeMfaResponse {
53
61
  }
62
+ export interface FinalizeTotpMfaSignInResponse extends FinalizeMfaResponse {
63
+ }
54
64
  export declare function finalizeSignInPhoneMfa(auth: Auth, request: FinalizePhoneMfaSignInRequest): Promise<FinalizePhoneMfaSignInResponse>;
65
+ export declare function finalizeSignInTotpMfa(auth: Auth, request: FinalizeTotpMfaSignInRequest): Promise<FinalizeTotpMfaSignInResponse>;
55
66
  /**
56
67
  * @internal
57
68
  */
@@ -0,0 +1,124 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2022 Google LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */
17
+ import { TotpMultiFactorAssertion, MultiFactorSession, FactorId } from '../../model/public_types';
18
+ import { AuthInternal } from '../../model/auth';
19
+ import { StartTotpMfaEnrollmentResponse, TotpVerificationInfo } from '../../api/account_management/mfa';
20
+ import { FinalizeMfaResponse } from '../../api/authentication/mfa';
21
+ import { MultiFactorAssertionImpl } from '../../mfa/mfa_assertion';
22
+ /**
23
+ * Provider for generating a {@link TotpMultiFactorAssertion}.
24
+ *
25
+ * @public
26
+ */
27
+ export declare class TotpMultiFactorGenerator {
28
+ /**
29
+ * Provides a {@link TotpMultiFactorAssertion} to confirm ownership of
30
+ * the TOTP (time-based one-time password) second factor.
31
+ * This assertion is used to complete enrollment in TOTP second factor.
32
+ *
33
+ * @param secret A {@link TotpSecret} containing the shared secret key and other TOTP parameters.
34
+ * @param oneTimePassword One-time password from TOTP App.
35
+ * @returns A {@link TotpMultiFactorAssertion} which can be used with
36
+ * {@link MultiFactorUser.enroll}.
37
+ */
38
+ static assertionForEnrollment(secret: TotpSecret, oneTimePassword: string): TotpMultiFactorAssertion;
39
+ /**
40
+ * Provides a {@link TotpMultiFactorAssertion} to confirm ownership of the TOTP second factor.
41
+ * This assertion is used to complete signIn with TOTP as the second factor.
42
+ *
43
+ * @param enrollmentId identifies the enrolled TOTP second factor.
44
+ * @param oneTimePassword One-time password from TOTP App.
45
+ * @returns A {@link TotpMultiFactorAssertion} which can be used with
46
+ * {@link MultiFactorResolver.resolveSignIn}.
47
+ */
48
+ static assertionForSignIn(enrollmentId: string, oneTimePassword: string): TotpMultiFactorAssertion;
49
+ /**
50
+ * Returns a promise to {@link TotpSecret} which contains the TOTP shared secret key and other parameters.
51
+ * Creates a TOTP secret as part of enrolling a TOTP second factor.
52
+ * Used for generating a QR code URL or inputting into a TOTP app.
53
+ * This method uses the auth instance corresponding to the user in the multiFactorSession.
54
+ *
55
+ * @param session The {@link MultiFactorSession} that the user is part of.
56
+ * @returns A promise to {@link TotpSecret}.
57
+ */
58
+ static generateSecret(session: MultiFactorSession): Promise<TotpSecret>;
59
+ /**
60
+ * The identifier of the TOTP second factor: `totp`.
61
+ */
62
+ static FACTOR_ID: FactorId;
63
+ }
64
+ export declare class TotpMultiFactorAssertionImpl extends MultiFactorAssertionImpl implements TotpMultiFactorAssertion {
65
+ readonly otp: string;
66
+ readonly enrollmentId?: string | undefined;
67
+ readonly secret?: TotpSecret | undefined;
68
+ constructor(otp: string, enrollmentId?: string | undefined, secret?: TotpSecret | undefined);
69
+ /** @internal */
70
+ static _fromSecret(secret: TotpSecret, otp: string): TotpMultiFactorAssertionImpl;
71
+ /** @internal */
72
+ static _fromEnrollmentId(enrollmentId: string, otp: string): TotpMultiFactorAssertionImpl;
73
+ /** @internal */
74
+ _finalizeEnroll(auth: AuthInternal, idToken: string, displayName?: string | null): Promise<FinalizeMfaResponse>;
75
+ /** @internal */
76
+ _finalizeSignIn(auth: AuthInternal, mfaPendingCredential: string): Promise<FinalizeMfaResponse>;
77
+ }
78
+ /**
79
+ * Provider for generating a {@link TotpMultiFactorAssertion}.
80
+ *
81
+ * Stores the shared secret key and other parameters to generate time-based OTPs.
82
+ * Implements methods to retrieve the shared secret key and generate a QR code URL.
83
+ * @public
84
+ */
85
+ export declare class TotpSecret {
86
+ private readonly sessionInfo;
87
+ private readonly auth;
88
+ /**
89
+ * Shared secret key/seed used for enrolling in TOTP MFA and generating OTPs.
90
+ */
91
+ readonly secretKey: string;
92
+ /**
93
+ * Hashing algorithm used.
94
+ */
95
+ readonly hashingAlgorithm: string;
96
+ /**
97
+ * Length of the one-time passwords to be generated.
98
+ */
99
+ readonly codeLength: number;
100
+ /**
101
+ * The interval (in seconds) when the OTP codes should change.
102
+ */
103
+ readonly codeIntervalSeconds: number;
104
+ /**
105
+ * The timestamp (UTC string) by which TOTP enrollment should be completed.
106
+ */
107
+ readonly enrollmentCompletionDeadline: string;
108
+ private constructor();
109
+ /** @internal */
110
+ static _fromStartTotpMfaEnrollmentResponse(response: StartTotpMfaEnrollmentResponse, auth: AuthInternal): TotpSecret;
111
+ /** @internal */
112
+ _makeTotpVerificationInfo(otp: string): TotpVerificationInfo;
113
+ /**
114
+ * Returns a QR code URL as described in
115
+ * https://github.com/google/google-authenticator/wiki/Key-Uri-Format
116
+ * This can be displayed to the user as a QR code to be scanned into a TOTP app like Google Authenticator.
117
+ * If the optional parameters are unspecified, an accountName of <userEmail> and issuer of <firebaseAppName> are used.
118
+ *
119
+ * @param accountName the name of the account/app along with a user identifier.
120
+ * @param issuer issuer of the TOTP (likely the app name).
121
+ * @returns A QR code URL string.
122
+ */
123
+ generateQrCodeUrl(accountName?: string, issuer?: string): string;
124
+ }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2022 Google LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */
17
+ export {};
@@ -14,7 +14,7 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
- import { FactorId, MultiFactorInfo, PhoneMultiFactorInfo } from '../model/public_types';
17
+ import { FactorId, MultiFactorInfo, PhoneMultiFactorInfo, TotpMultiFactorInfo } from '../model/public_types';
18
18
  import { MfaEnrollment } from '../api/account_management/mfa';
19
19
  import { AuthInternal } from '../model/auth';
20
20
  export declare abstract class MultiFactorInfoImpl implements MultiFactorInfo {
@@ -30,3 +30,7 @@ export declare class PhoneMultiFactorInfoImpl extends MultiFactorInfoImpl implem
30
30
  private constructor();
31
31
  static _fromServerResponse(_auth: AuthInternal, enrollment: MfaEnrollment): PhoneMultiFactorInfoImpl;
32
32
  }
33
+ export declare class TotpMultiFactorInfoImpl extends MultiFactorInfoImpl implements TotpMultiFactorInfo {
34
+ private constructor();
35
+ static _fromServerResponse(_auth: AuthInternal, enrollment: MfaEnrollment): TotpMultiFactorInfoImpl;
36
+ }
@@ -22,6 +22,7 @@
22
22
  export declare const FactorId: {
23
23
  /** Phone as second factor */
24
24
  readonly PHONE: "phone";
25
+ readonly TOTP: "totp";
25
26
  };
26
27
  /**
27
28
  * Enumeration of supported providers.
@@ -502,7 +502,8 @@ export interface AuthProvider {
502
502
  */
503
503
  export declare const enum FactorId {
504
504
  /** Phone as second factor */
505
- PHONE = "phone"
505
+ PHONE = "phone",
506
+ TOTP = "totp"
506
507
  }
507
508
  /**
508
509
  * A result from a phone number sign-in, link, or reauthenticate call.
@@ -609,6 +610,13 @@ export interface PhoneMultiFactorInfo extends MultiFactorInfo {
609
610
  /** The phone number associated with the current second factor. */
610
611
  readonly phoneNumber: string;
611
612
  }
613
+ /**
614
+ * The subclass of the {@link MultiFactorInfo} interface for TOTP
615
+ * second factors. The `factorId` of this second factor is {@link FactorId}.TOTP.
616
+ * @public
617
+ */
618
+ export interface TotpMultiFactorInfo extends MultiFactorInfo {
619
+ }
612
620
  /**
613
621
  * The class used to facilitate recovery from {@link MultiFactorError} when a user needs to
614
622
  * provide a second factor to sign in.
@@ -1160,3 +1168,12 @@ export interface Dependencies {
1160
1168
  */
1161
1169
  errorMap?: AuthErrorMap;
1162
1170
  }
1171
+ /**
1172
+ * The class for asserting ownership of a TOTP second factor. Provided by
1173
+ * {@link TotpMultiFactorGenerator.assertionForEnrollment} and
1174
+ * {@link TotpMultiFactorGenerator.assertionForSignIn}.
1175
+ *
1176
+ * @public
1177
+ */
1178
+ export interface TotpMultiFactorAssertion extends MultiFactorAssertion {
1179
+ }
@@ -18,3 +18,6 @@ import { Auth } from '../../../src/model/public_types';
18
18
  export declare function randomEmail(): string;
19
19
  export declare function getTestInstance(requireEmulator?: boolean): Auth;
20
20
  export declare function cleanUpTestInstance(auth: Auth): Promise<void>;
21
+ export declare function getTotpCode(sharedSecretKey: string, periodSec: number, verificationCodeLength: number, timestamp: Date): string;
22
+ export declare const email = "totpuser-donotdelete@test.com";
23
+ export declare const incorrectTotpCode = "1000000";
@@ -0,0 +1,17 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2022 Google LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */
17
+ export {};
@@ -27,7 +27,8 @@ import { Component } from '@firebase/component';
27
27
  */
28
28
  const FactorId = {
29
29
  /** Phone as second factor */
30
- PHONE: 'phone'
30
+ PHONE: 'phone',
31
+ TOTP: 'totp'
31
32
  };
32
33
  /**
33
34
  * Enumeration of supported providers.
@@ -981,7 +982,10 @@ async function _performFetchWithErrorHandling(auth, customErrorMap, fetchFn) {
981
982
  if (e instanceof FirebaseError) {
982
983
  throw e;
983
984
  }
984
- _fail(auth, "internal-error" /* AuthErrorCode.INTERNAL_ERROR */, { 'message': String(e) });
985
+ // Changing this to a different error code will log user out when there is a network error
986
+ // because we treat any error other than NETWORK_REQUEST_FAILED as token is invalid.
987
+ // https://github.com/firebase/firebase-js-sdk/blob/4fbc73610d70be4e0852e7de63a39cb7897e8546/packages/auth/src/core/auth/auth_impl.ts#L309-L316
988
+ _fail(auth, "network-request-failed" /* AuthErrorCode.NETWORK_REQUEST_FAILED */, { 'message': String(e) });
985
989
  }
986
990
  }
987
991
  async function _performSignInRequest(auth, method, path, request, customErrorMap = {}) {
@@ -4859,6 +4863,9 @@ class MultiFactorInfoImpl {
4859
4863
  if ('phoneInfo' in enrollment) {
4860
4864
  return PhoneMultiFactorInfoImpl._fromServerResponse(auth, enrollment);
4861
4865
  }
4866
+ else if ('totpInfo' in enrollment) {
4867
+ return TotpMultiFactorInfoImpl._fromServerResponse(auth, enrollment);
4868
+ }
4862
4869
  return _fail(auth, "internal-error" /* AuthErrorCode.INTERNAL_ERROR */);
4863
4870
  }
4864
4871
  }
@@ -4870,6 +4877,14 @@ class PhoneMultiFactorInfoImpl extends MultiFactorInfoImpl {
4870
4877
  static _fromServerResponse(_auth, enrollment) {
4871
4878
  return new PhoneMultiFactorInfoImpl(enrollment);
4872
4879
  }
4880
+ }
4881
+ class TotpMultiFactorInfoImpl extends MultiFactorInfoImpl {
4882
+ constructor(response) {
4883
+ super("totp" /* FactorId.TOTP */, response);
4884
+ }
4885
+ static _fromServerResponse(_auth, enrollment) {
4886
+ return new TotpMultiFactorInfoImpl(enrollment);
4887
+ }
4873
4888
  }
4874
4889
 
4875
4890
  /**
@@ -5906,6 +5921,12 @@ function startEnrollPhoneMfa(auth, request) {
5906
5921
  function finalizeEnrollPhoneMfa(auth, request) {
5907
5922
  return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaEnrollment:finalize" /* Endpoint.FINALIZE_MFA_ENROLLMENT */, _addTidIfNecessary(auth, request));
5908
5923
  }
5924
+ function startEnrollTotpMfa(auth, request) {
5925
+ return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaEnrollment:start" /* Endpoint.START_MFA_ENROLLMENT */, _addTidIfNecessary(auth, request));
5926
+ }
5927
+ function finalizeEnrollTotpMfa(auth, request) {
5928
+ return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaEnrollment:finalize" /* Endpoint.FINALIZE_MFA_ENROLLMENT */, _addTidIfNecessary(auth, request));
5929
+ }
5909
5930
  function withdrawMfa(auth, request) {
5910
5931
  return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaEnrollment:withdraw" /* Endpoint.WITHDRAW_MFA */, _addTidIfNecessary(auth, request));
5911
5932
  }
@@ -7001,6 +7022,9 @@ function startSignInPhoneMfa(auth, request) {
7001
7022
  }
7002
7023
  function finalizeSignInPhoneMfa(auth, request) {
7003
7024
  return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaSignIn:finalize" /* Endpoint.FINALIZE_MFA_SIGN_IN */, _addTidIfNecessary(auth, request));
7025
+ }
7026
+ function finalizeSignInTotpMfa(auth, request) {
7027
+ return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaSignIn:finalize" /* Endpoint.FINALIZE_MFA_SIGN_IN */, _addTidIfNecessary(auth, request));
7004
7028
  }
7005
7029
 
7006
7030
  /**
@@ -9311,8 +9335,155 @@ class PhoneMultiFactorGenerator {
9311
9335
  */
9312
9336
  PhoneMultiFactorGenerator.FACTOR_ID = 'phone';
9313
9337
 
9338
+ /**
9339
+ * Provider for generating a {@link TotpMultiFactorAssertion}.
9340
+ *
9341
+ * @public
9342
+ */
9343
+ class TotpMultiFactorGenerator {
9344
+ /**
9345
+ * Provides a {@link TotpMultiFactorAssertion} to confirm ownership of
9346
+ * the TOTP (time-based one-time password) second factor.
9347
+ * This assertion is used to complete enrollment in TOTP second factor.
9348
+ *
9349
+ * @param secret A {@link TotpSecret} containing the shared secret key and other TOTP parameters.
9350
+ * @param oneTimePassword One-time password from TOTP App.
9351
+ * @returns A {@link TotpMultiFactorAssertion} which can be used with
9352
+ * {@link MultiFactorUser.enroll}.
9353
+ */
9354
+ static assertionForEnrollment(secret, oneTimePassword) {
9355
+ return TotpMultiFactorAssertionImpl._fromSecret(secret, oneTimePassword);
9356
+ }
9357
+ /**
9358
+ * Provides a {@link TotpMultiFactorAssertion} to confirm ownership of the TOTP second factor.
9359
+ * This assertion is used to complete signIn with TOTP as the second factor.
9360
+ *
9361
+ * @param enrollmentId identifies the enrolled TOTP second factor.
9362
+ * @param oneTimePassword One-time password from TOTP App.
9363
+ * @returns A {@link TotpMultiFactorAssertion} which can be used with
9364
+ * {@link MultiFactorResolver.resolveSignIn}.
9365
+ */
9366
+ static assertionForSignIn(enrollmentId, oneTimePassword) {
9367
+ return TotpMultiFactorAssertionImpl._fromEnrollmentId(enrollmentId, oneTimePassword);
9368
+ }
9369
+ /**
9370
+ * Returns a promise to {@link TotpSecret} which contains the TOTP shared secret key and other parameters.
9371
+ * Creates a TOTP secret as part of enrolling a TOTP second factor.
9372
+ * Used for generating a QR code URL or inputting into a TOTP app.
9373
+ * This method uses the auth instance corresponding to the user in the multiFactorSession.
9374
+ *
9375
+ * @param session The {@link MultiFactorSession} that the user is part of.
9376
+ * @returns A promise to {@link TotpSecret}.
9377
+ */
9378
+ static async generateSecret(session) {
9379
+ const mfaSession = session;
9380
+ _assert(typeof mfaSession.auth !== 'undefined', "internal-error" /* AuthErrorCode.INTERNAL_ERROR */);
9381
+ const response = await startEnrollTotpMfa(mfaSession.auth, {
9382
+ idToken: mfaSession.credential,
9383
+ totpEnrollmentInfo: {}
9384
+ });
9385
+ return TotpSecret._fromStartTotpMfaEnrollmentResponse(response, mfaSession.auth);
9386
+ }
9387
+ }
9388
+ /**
9389
+ * The identifier of the TOTP second factor: `totp`.
9390
+ */
9391
+ TotpMultiFactorGenerator.FACTOR_ID = "totp" /* FactorId.TOTP */;
9392
+ class TotpMultiFactorAssertionImpl extends MultiFactorAssertionImpl {
9393
+ constructor(otp, enrollmentId, secret) {
9394
+ super("totp" /* FactorId.TOTP */);
9395
+ this.otp = otp;
9396
+ this.enrollmentId = enrollmentId;
9397
+ this.secret = secret;
9398
+ }
9399
+ /** @internal */
9400
+ static _fromSecret(secret, otp) {
9401
+ return new TotpMultiFactorAssertionImpl(otp, undefined, secret);
9402
+ }
9403
+ /** @internal */
9404
+ static _fromEnrollmentId(enrollmentId, otp) {
9405
+ return new TotpMultiFactorAssertionImpl(otp, enrollmentId);
9406
+ }
9407
+ /** @internal */
9408
+ async _finalizeEnroll(auth, idToken, displayName) {
9409
+ _assert(typeof this.secret !== 'undefined', auth, "argument-error" /* AuthErrorCode.ARGUMENT_ERROR */);
9410
+ return finalizeEnrollTotpMfa(auth, {
9411
+ idToken,
9412
+ displayName,
9413
+ totpVerificationInfo: this.secret._makeTotpVerificationInfo(this.otp)
9414
+ });
9415
+ }
9416
+ /** @internal */
9417
+ async _finalizeSignIn(auth, mfaPendingCredential) {
9418
+ _assert(this.enrollmentId !== undefined && this.otp !== undefined, auth, "argument-error" /* AuthErrorCode.ARGUMENT_ERROR */);
9419
+ const totpVerificationInfo = { verificationCode: this.otp };
9420
+ return finalizeSignInTotpMfa(auth, {
9421
+ mfaPendingCredential,
9422
+ mfaEnrollmentId: this.enrollmentId,
9423
+ totpVerificationInfo
9424
+ });
9425
+ }
9426
+ }
9427
+ /**
9428
+ * Provider for generating a {@link TotpMultiFactorAssertion}.
9429
+ *
9430
+ * Stores the shared secret key and other parameters to generate time-based OTPs.
9431
+ * Implements methods to retrieve the shared secret key and generate a QR code URL.
9432
+ * @public
9433
+ */
9434
+ class TotpSecret {
9435
+ // The public members are declared outside the constructor so the docs can be generated.
9436
+ constructor(secretKey, hashingAlgorithm, codeLength, codeIntervalSeconds, enrollmentCompletionDeadline, sessionInfo, auth) {
9437
+ this.sessionInfo = sessionInfo;
9438
+ this.auth = auth;
9439
+ this.secretKey = secretKey;
9440
+ this.hashingAlgorithm = hashingAlgorithm;
9441
+ this.codeLength = codeLength;
9442
+ this.codeIntervalSeconds = codeIntervalSeconds;
9443
+ this.enrollmentCompletionDeadline = enrollmentCompletionDeadline;
9444
+ }
9445
+ /** @internal */
9446
+ static _fromStartTotpMfaEnrollmentResponse(response, auth) {
9447
+ return new TotpSecret(response.totpSessionInfo.sharedSecretKey, response.totpSessionInfo.hashingAlgorithm, response.totpSessionInfo.verificationCodeLength, response.totpSessionInfo.periodSec, new Date(response.totpSessionInfo.finalizeEnrollmentTime).toUTCString(), response.totpSessionInfo.sessionInfo, auth);
9448
+ }
9449
+ /** @internal */
9450
+ _makeTotpVerificationInfo(otp) {
9451
+ return { sessionInfo: this.sessionInfo, verificationCode: otp };
9452
+ }
9453
+ /**
9454
+ * Returns a QR code URL as described in
9455
+ * https://github.com/google/google-authenticator/wiki/Key-Uri-Format
9456
+ * This can be displayed to the user as a QR code to be scanned into a TOTP app like Google Authenticator.
9457
+ * If the optional parameters are unspecified, an accountName of <userEmail> and issuer of <firebaseAppName> are used.
9458
+ *
9459
+ * @param accountName the name of the account/app along with a user identifier.
9460
+ * @param issuer issuer of the TOTP (likely the app name).
9461
+ * @returns A QR code URL string.
9462
+ */
9463
+ generateQrCodeUrl(accountName, issuer) {
9464
+ var _a;
9465
+ let useDefaults = false;
9466
+ if (_isEmptyString(accountName) || _isEmptyString(issuer)) {
9467
+ useDefaults = true;
9468
+ }
9469
+ if (useDefaults) {
9470
+ if (_isEmptyString(accountName)) {
9471
+ accountName = ((_a = this.auth.currentUser) === null || _a === void 0 ? void 0 : _a.email) || 'unknownuser';
9472
+ }
9473
+ if (_isEmptyString(issuer)) {
9474
+ issuer = this.auth.name;
9475
+ }
9476
+ }
9477
+ return `otpauth://totp/${issuer}:${accountName}?secret=${this.secretKey}&issuer=${issuer}&algorithm=${this.hashingAlgorithm}&digits=${this.codeLength}`;
9478
+ }
9479
+ }
9480
+ /** @internal */
9481
+ function _isEmptyString(input) {
9482
+ return typeof input === 'undefined' || (input === null || input === void 0 ? void 0 : input.length) === 0;
9483
+ }
9484
+
9314
9485
  var name = "@firebase/auth";
9315
- var version = "0.21.5";
9486
+ var version = "0.21.6-20230329040242";
9316
9487
 
9317
9488
  /**
9318
9489
  * @license
@@ -9537,5 +9708,5 @@ function getAuth(app = getApp()) {
9537
9708
  }
9538
9709
  registerAuth("Browser" /* ClientPlatform.BROWSER */);
9539
9710
 
9540
- export { signInWithCustomToken as $, ActionCodeOperation as A, debugErrorMap as B, prodErrorMap as C, AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY as D, initializeAuth as E, FactorId as F, connectAuthEmulator as G, AuthCredential as H, EmailAuthCredential as I, OAuthCredential as J, PhoneAuthCredential as K, inMemoryPersistence as L, EmailAuthProvider as M, FacebookAuthProvider as N, OperationType as O, PhoneAuthProvider as P, GoogleAuthProvider as Q, RecaptchaVerifier as R, SignInMethod as S, GithubAuthProvider as T, OAuthProvider as U, SAMLAuthProvider as V, TwitterAuthProvider as W, signInAnonymously as X, signInWithCredential as Y, linkWithCredential as Z, reauthenticateWithCredential as _, browserSessionPersistence as a, sendPasswordResetEmail as a0, confirmPasswordReset as a1, applyActionCode as a2, checkActionCode as a3, verifyPasswordResetCode as a4, createUserWithEmailAndPassword as a5, signInWithEmailAndPassword as a6, sendSignInLinkToEmail as a7, isSignInWithEmailLink as a8, signInWithEmailLink as a9, _persistenceKeyName as aA, _getRedirectResult as aB, _overrideRedirectResult as aC, _clearRedirectOutcomes as aD, _castAuth as aE, UserImpl as aF, AuthImpl as aG, _getClientVersion as aH, _generateEventId as aI, AuthPopup as aJ, FetchProvider as aK, SAMLAuthCredential as aL, fetchSignInMethodsForEmail as aa, sendEmailVerification as ab, verifyBeforeUpdateEmail as ac, ActionCodeURL as ad, parseActionCodeURL as ae, updateProfile as af, updateEmail as ag, updatePassword as ah, getIdToken as ai, getIdTokenResult as aj, unlink as ak, getAdditionalUserInfo as al, reload as am, getMultiFactorResolver as an, multiFactor as ao, debugAssert as ap, _isIOS as aq, _isAndroid as ar, _fail as as, _getRedirectUrl as at, _getProjectConfig as au, _isIOS7Or8 as av, _createError as aw, _assert as ax, AuthEventManager as ay, _getInstance as az, browserLocalPersistence as b, signInWithPopup as c, linkWithPopup as d, reauthenticateWithPopup as e, signInWithRedirect as f, linkWithRedirect as g, reauthenticateWithRedirect as h, indexedDBLocalPersistence as i, getRedirectResult as j, browserPopupRedirectResolver as k, linkWithPhoneNumber as l, PhoneMultiFactorGenerator as m, getAuth as n, ProviderId as o, setPersistence as p, onIdTokenChanged as q, reauthenticateWithPhoneNumber as r, signInWithPhoneNumber as s, beforeAuthStateChanged as t, updatePhoneNumber as u, onAuthStateChanged as v, useDeviceLanguage as w, updateCurrentUser as x, signOut as y, deleteUser as z };
9541
- //# sourceMappingURL=index-3363a72a.js.map
9711
+ export { linkWithCredential as $, ActionCodeOperation as A, deleteUser as B, debugErrorMap as C, prodErrorMap as D, AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY as E, FactorId as F, initializeAuth as G, connectAuthEmulator as H, AuthCredential as I, EmailAuthCredential as J, OAuthCredential as K, PhoneAuthCredential as L, inMemoryPersistence as M, EmailAuthProvider as N, OperationType as O, PhoneAuthProvider as P, FacebookAuthProvider as Q, RecaptchaVerifier as R, SignInMethod as S, TotpMultiFactorGenerator as T, GoogleAuthProvider as U, GithubAuthProvider as V, OAuthProvider as W, SAMLAuthProvider as X, TwitterAuthProvider as Y, signInAnonymously as Z, signInWithCredential as _, browserSessionPersistence as a, reauthenticateWithCredential as a0, signInWithCustomToken as a1, sendPasswordResetEmail as a2, confirmPasswordReset as a3, applyActionCode as a4, checkActionCode as a5, verifyPasswordResetCode as a6, createUserWithEmailAndPassword as a7, signInWithEmailAndPassword as a8, sendSignInLinkToEmail as a9, AuthEventManager as aA, _getInstance as aB, _persistenceKeyName as aC, _getRedirectResult as aD, _overrideRedirectResult as aE, _clearRedirectOutcomes as aF, _castAuth as aG, UserImpl as aH, AuthImpl as aI, _getClientVersion as aJ, _generateEventId as aK, AuthPopup as aL, FetchProvider as aM, SAMLAuthCredential as aN, isSignInWithEmailLink as aa, signInWithEmailLink as ab, fetchSignInMethodsForEmail as ac, sendEmailVerification as ad, verifyBeforeUpdateEmail as ae, ActionCodeURL as af, parseActionCodeURL as ag, updateProfile as ah, updateEmail as ai, updatePassword as aj, getIdToken as ak, getIdTokenResult as al, unlink as am, getAdditionalUserInfo as an, reload as ao, getMultiFactorResolver as ap, multiFactor as aq, debugAssert as ar, _isIOS as as, _isAndroid as at, _fail as au, _getRedirectUrl as av, _getProjectConfig as aw, _isIOS7Or8 as ax, _createError as ay, _assert as az, browserLocalPersistence as b, signInWithPopup as c, linkWithPopup as d, reauthenticateWithPopup as e, signInWithRedirect as f, linkWithRedirect as g, reauthenticateWithRedirect as h, indexedDBLocalPersistence as i, getRedirectResult as j, browserPopupRedirectResolver as k, linkWithPhoneNumber as l, PhoneMultiFactorGenerator as m, TotpSecret as n, getAuth as o, ProviderId as p, setPersistence as q, reauthenticateWithPhoneNumber as r, signInWithPhoneNumber as s, onIdTokenChanged as t, updatePhoneNumber as u, beforeAuthStateChanged as v, onAuthStateChanged as w, useDeviceLanguage as x, updateCurrentUser as y, signOut as z };
9712
+ //# sourceMappingURL=index-998a92c6.js.map