@firebase/auth 0.21.5-canary.ce79f7fe2 → 0.21.5-canary.f8a2c5865

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 (143) hide show
  1. package/README.md +25 -0
  2. package/dist/auth-public.d.ts +137 -4
  3. package/dist/auth.d.ts +149 -4
  4. package/dist/browser-cjs/{index-da3cf52f.js → index-aeaeb040.js} +176 -4
  5. package/dist/browser-cjs/index-aeaeb040.js.map +1 -0
  6. package/dist/browser-cjs/index.d.ts +2 -1
  7. package/dist/browser-cjs/index.js +3 -1
  8. package/dist/browser-cjs/index.js.map +1 -1
  9. package/dist/browser-cjs/internal.js +3 -1
  10. package/dist/browser-cjs/internal.js.map +1 -1
  11. package/dist/browser-cjs/src/api/account_management/mfa.d.ts +38 -4
  12. package/dist/browser-cjs/src/api/authentication/mfa.d.ts +11 -0
  13. package/dist/browser-cjs/src/core/errors.d.ts +1 -0
  14. package/dist/browser-cjs/src/core/index.d.ts +1 -0
  15. package/dist/browser-cjs/src/mfa/assertions/totp.d.ts +124 -0
  16. package/dist/browser-cjs/src/mfa/assertions/totp.test.d.ts +17 -0
  17. package/dist/browser-cjs/src/mfa/mfa_info.d.ts +5 -1
  18. package/dist/browser-cjs/src/model/enum_maps.d.ts +1 -0
  19. package/dist/browser-cjs/src/model/public_types.d.ts +18 -1
  20. package/dist/browser-cjs/test/helpers/integration/helpers.d.ts +3 -0
  21. package/dist/browser-cjs/test/integration/flows/totp.test.d.ts +17 -0
  22. package/dist/cordova/index.d.ts +2 -1
  23. package/dist/cordova/index.js +2 -2
  24. package/dist/cordova/internal.js +179 -3
  25. package/dist/cordova/internal.js.map +1 -1
  26. package/dist/cordova/{popup_redirect-5b6894c2.js → popup_redirect-5d90c99d.js} +27 -5
  27. package/dist/cordova/popup_redirect-5d90c99d.js.map +1 -0
  28. package/dist/cordova/src/api/account_management/mfa.d.ts +38 -4
  29. package/dist/cordova/src/api/authentication/mfa.d.ts +11 -0
  30. package/dist/cordova/src/core/errors.d.ts +1 -0
  31. package/dist/cordova/src/core/index.d.ts +1 -0
  32. package/dist/cordova/src/mfa/assertions/totp.d.ts +124 -0
  33. package/dist/cordova/src/mfa/assertions/totp.test.d.ts +17 -0
  34. package/dist/cordova/src/mfa/mfa_info.d.ts +5 -1
  35. package/dist/cordova/src/model/enum_maps.d.ts +1 -0
  36. package/dist/cordova/src/model/public_types.d.ts +18 -1
  37. package/dist/cordova/test/helpers/integration/helpers.d.ts +3 -0
  38. package/dist/cordova/test/integration/flows/totp.test.d.ts +17 -0
  39. package/dist/esm2017/{index-c0585610.js → index-9467e58b.js} +175 -5
  40. package/dist/esm2017/index-9467e58b.js.map +1 -0
  41. package/dist/esm2017/index.d.ts +2 -1
  42. package/dist/esm2017/index.js +1 -1
  43. package/dist/esm2017/internal.js +2 -2
  44. package/dist/esm2017/src/api/account_management/mfa.d.ts +38 -4
  45. package/dist/esm2017/src/api/authentication/mfa.d.ts +11 -0
  46. package/dist/esm2017/src/core/errors.d.ts +1 -0
  47. package/dist/esm2017/src/core/index.d.ts +1 -0
  48. package/dist/esm2017/src/mfa/assertions/totp.d.ts +124 -0
  49. package/dist/esm2017/src/mfa/assertions/totp.test.d.ts +17 -0
  50. package/dist/esm2017/src/mfa/mfa_info.d.ts +5 -1
  51. package/dist/esm2017/src/model/enum_maps.d.ts +1 -0
  52. package/dist/esm2017/src/model/public_types.d.ts +18 -1
  53. package/dist/esm2017/test/helpers/integration/helpers.d.ts +3 -0
  54. package/dist/esm2017/test/integration/flows/totp.test.d.ts +17 -0
  55. package/dist/esm5/{index-281afa15.js → index-de7cac5b.js} +203 -5
  56. package/dist/esm5/index-de7cac5b.js.map +1 -0
  57. package/dist/esm5/index.d.ts +2 -1
  58. package/dist/esm5/index.js +1 -1
  59. package/dist/esm5/internal.js +2 -2
  60. package/dist/esm5/src/api/account_management/mfa.d.ts +38 -4
  61. package/dist/esm5/src/api/authentication/mfa.d.ts +11 -0
  62. package/dist/esm5/src/core/errors.d.ts +1 -0
  63. package/dist/esm5/src/core/index.d.ts +1 -0
  64. package/dist/esm5/src/mfa/assertions/totp.d.ts +124 -0
  65. package/dist/esm5/src/mfa/assertions/totp.test.d.ts +17 -0
  66. package/dist/esm5/src/mfa/mfa_info.d.ts +5 -1
  67. package/dist/esm5/src/model/enum_maps.d.ts +1 -0
  68. package/dist/esm5/src/model/public_types.d.ts +18 -1
  69. package/dist/esm5/test/helpers/integration/helpers.d.ts +3 -0
  70. package/dist/esm5/test/integration/flows/totp.test.d.ts +17 -0
  71. package/dist/index.d.ts +2 -1
  72. package/dist/index.webworker.esm5.js +19 -3
  73. package/dist/index.webworker.esm5.js.map +1 -1
  74. package/dist/node/index.d.ts +2 -1
  75. package/dist/node/index.js +83 -81
  76. package/dist/node/index.js.map +1 -1
  77. package/dist/node/internal.js +144 -142
  78. package/dist/node/internal.js.map +1 -1
  79. package/dist/node/src/api/account_management/mfa.d.ts +38 -4
  80. package/dist/node/src/api/authentication/mfa.d.ts +11 -0
  81. package/dist/node/src/core/errors.d.ts +1 -0
  82. package/dist/node/src/core/index.d.ts +1 -0
  83. package/dist/node/src/mfa/assertions/totp.d.ts +124 -0
  84. package/dist/node/src/mfa/assertions/totp.test.d.ts +17 -0
  85. package/dist/node/src/mfa/mfa_info.d.ts +5 -1
  86. package/dist/node/src/model/enum_maps.d.ts +1 -0
  87. package/dist/node/src/model/public_types.d.ts +18 -1
  88. package/dist/node/test/helpers/integration/helpers.d.ts +3 -0
  89. package/dist/node/test/integration/flows/totp.test.d.ts +17 -0
  90. package/dist/node/{index-37042dd3.js → totp-bee43d8c.js} +239 -5
  91. package/dist/node/totp-bee43d8c.js.map +1 -0
  92. package/dist/node-esm/index.d.ts +2 -1
  93. package/dist/node-esm/index.js +2 -2
  94. package/dist/node-esm/internal.js +3 -3
  95. package/dist/node-esm/src/api/account_management/mfa.d.ts +38 -4
  96. package/dist/node-esm/src/api/authentication/mfa.d.ts +11 -0
  97. package/dist/node-esm/src/core/errors.d.ts +1 -0
  98. package/dist/node-esm/src/core/index.d.ts +1 -0
  99. package/dist/node-esm/src/mfa/assertions/totp.d.ts +124 -0
  100. package/dist/node-esm/src/mfa/assertions/totp.test.d.ts +17 -0
  101. package/dist/node-esm/src/mfa/mfa_info.d.ts +5 -1
  102. package/dist/node-esm/src/model/enum_maps.d.ts +1 -0
  103. package/dist/node-esm/src/model/public_types.d.ts +18 -1
  104. package/dist/node-esm/test/helpers/integration/helpers.d.ts +3 -0
  105. package/dist/node-esm/test/integration/flows/totp.test.d.ts +17 -0
  106. package/dist/node-esm/{index-1cab2ca1.js → totp-9075bbc1.js} +209 -6
  107. package/dist/node-esm/totp-9075bbc1.js.map +1 -0
  108. package/dist/rn/index.d.ts +2 -1
  109. package/dist/rn/index.js +1 -1
  110. package/dist/rn/internal.js +176 -1
  111. package/dist/rn/internal.js.map +1 -1
  112. package/dist/rn/{phone-2c66b31d.js → phone-4275321a.js} +33 -4
  113. package/dist/rn/phone-4275321a.js.map +1 -0
  114. package/dist/rn/src/api/account_management/mfa.d.ts +38 -4
  115. package/dist/rn/src/api/authentication/mfa.d.ts +11 -0
  116. package/dist/rn/src/core/errors.d.ts +1 -0
  117. package/dist/rn/src/core/index.d.ts +1 -0
  118. package/dist/rn/src/mfa/assertions/totp.d.ts +124 -0
  119. package/dist/rn/src/mfa/assertions/totp.test.d.ts +17 -0
  120. package/dist/rn/src/mfa/mfa_info.d.ts +5 -1
  121. package/dist/rn/src/model/enum_maps.d.ts +1 -0
  122. package/dist/rn/src/model/public_types.d.ts +18 -1
  123. package/dist/rn/test/helpers/integration/helpers.d.ts +3 -0
  124. package/dist/rn/test/integration/flows/totp.test.d.ts +17 -0
  125. package/dist/src/api/account_management/mfa.d.ts +38 -4
  126. package/dist/src/api/authentication/mfa.d.ts +11 -0
  127. package/dist/src/core/errors.d.ts +1 -0
  128. package/dist/src/core/index.d.ts +1 -0
  129. package/dist/src/mfa/assertions/totp.d.ts +124 -0
  130. package/dist/src/mfa/assertions/totp.test.d.ts +17 -0
  131. package/dist/src/mfa/mfa_info.d.ts +5 -1
  132. package/dist/src/model/enum_maps.d.ts +1 -0
  133. package/dist/src/model/public_types.d.ts +18 -1
  134. package/dist/test/helpers/integration/helpers.d.ts +3 -0
  135. package/dist/test/integration/flows/totp.test.d.ts +17 -0
  136. package/package.json +10 -8
  137. package/dist/browser-cjs/index-da3cf52f.js.map +0 -1
  138. package/dist/cordova/popup_redirect-5b6894c2.js.map +0 -1
  139. package/dist/esm2017/index-c0585610.js.map +0 -1
  140. package/dist/esm5/index-281afa15.js.map +0 -1
  141. package/dist/node/index-37042dd3.js.map +0 -1
  142. package/dist/node-esm/index-1cab2ca1.js.map +0 -1
  143. package/dist/rn/phone-2c66b31d.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
  */
@@ -86,6 +86,7 @@ export declare const enum AuthErrorCode {
86
86
  MISSING_MFA_INFO = "missing-multi-factor-info",
87
87
  MISSING_MFA_SESSION = "missing-multi-factor-session",
88
88
  MISSING_PHONE_NUMBER = "missing-phone-number",
89
+ MISSING_PASSWORD = "missing-password",
89
90
  MISSING_SESSION_INFO = "missing-verification-id",
90
91
  MODULE_DESTROYED = "app-deleted",
91
92
  NEED_CONFIRMATION = "account-exists-with-different-credential",
@@ -43,6 +43,7 @@ export declare function setPersistence(auth: Auth, persistence: Persistence): Pr
43
43
  *
44
44
  * @remarks
45
45
  * This includes sign-in, sign-out, and token refresh events.
46
+ * This will not be triggered automatically upon ID token expiration. Use {@link User.getIdToken} to refresh the ID token.
46
47
  *
47
48
  * @param auth - The {@link Auth} instance.
48
49
  * @param nextOrObserver - callback triggered on change.
@@ -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 {};
@@ -3,9 +3,9 @@
3
3
  var tslib = require('tslib');
4
4
  var util = require('@firebase/util');
5
5
  var app = require('@firebase/app');
6
- var logger = require('@firebase/logger');
7
6
  var component = require('@firebase/component');
8
7
  var fetchImpl = require('node-fetch');
8
+ var logger = require('@firebase/logger');
9
9
 
10
10
  function _interopNamespace(e) {
11
11
  if (e && e.__esModule) return e;
@@ -50,7 +50,8 @@ var fetchImpl__namespace = /*#__PURE__*/_interopNamespace(fetchImpl);
50
50
  */
51
51
  var FactorId = {
52
52
  /** Phone as second factor */
53
- PHONE: 'phone'
53
+ PHONE: 'phone',
54
+ TOTP: 'totp'
54
55
  };
55
56
  /**
56
57
  * Enumeration of supported providers.
@@ -235,6 +236,7 @@ function _debugErrorMap() {
235
236
  _a["missing-or-invalid-nonce" /* AuthErrorCode.MISSING_OR_INVALID_NONCE */] = 'The request does not contain a valid nonce. This can occur if the ' +
236
237
  'SHA-256 hash of the provided raw nonce does not match the hashed nonce ' +
237
238
  'in the ID token payload.',
239
+ _a["missing-password" /* AuthErrorCode.MISSING_PASSWORD */] = 'A non-empty password must be provided',
238
240
  _a["missing-multi-factor-info" /* AuthErrorCode.MISSING_MFA_INFO */] = 'No second factor identifier is provided.',
239
241
  _a["missing-multi-factor-session" /* AuthErrorCode.MISSING_MFA_SESSION */] = 'The request is missing proof of first factor successful sign-in.',
240
242
  _a["missing-phone-number" /* AuthErrorCode.MISSING_PHONE_NUMBER */] = 'To send verification codes, provide a phone number for the recipient.',
@@ -879,7 +881,7 @@ var SERVER_ERROR_MAP = (_a$1 = {},
879
881
  // Sign in with email and password errors (some apply to sign up too).
880
882
  _a$1["INVALID_PASSWORD" /* ServerError.INVALID_PASSWORD */] = "wrong-password" /* AuthErrorCode.INVALID_PASSWORD */,
881
883
  // This can only happen if the SDK sends a bad request.
882
- _a$1["MISSING_PASSWORD" /* ServerError.MISSING_PASSWORD */] = "internal-error" /* AuthErrorCode.INTERNAL_ERROR */,
884
+ _a$1["MISSING_PASSWORD" /* ServerError.MISSING_PASSWORD */] = "missing-password" /* AuthErrorCode.MISSING_PASSWORD */,
883
885
  // Sign up with email and password errors.
884
886
  _a$1["EMAIL_EXISTS" /* ServerError.EMAIL_EXISTS */] = "email-already-in-use" /* AuthErrorCode.EMAIL_EXISTS */,
885
887
  _a$1["PASSWORD_LOGIN_DISABLED" /* ServerError.PASSWORD_LOGIN_DISABLED */] = "operation-not-allowed" /* AuthErrorCode.OPERATION_NOT_ALLOWED */,
@@ -5702,6 +5704,9 @@ var MultiFactorInfoImpl = /** @class */ (function () {
5702
5704
  if ('phoneInfo' in enrollment) {
5703
5705
  return PhoneMultiFactorInfoImpl._fromServerResponse(auth, enrollment);
5704
5706
  }
5707
+ else if ('totpInfo' in enrollment) {
5708
+ return TotpMultiFactorInfoImpl._fromServerResponse(auth, enrollment);
5709
+ }
5705
5710
  return _fail(auth, "internal-error" /* AuthErrorCode.INTERNAL_ERROR */);
5706
5711
  };
5707
5712
  return MultiFactorInfoImpl;
@@ -5717,6 +5722,16 @@ var PhoneMultiFactorInfoImpl = /** @class */ (function (_super) {
5717
5722
  return new PhoneMultiFactorInfoImpl(enrollment);
5718
5723
  };
5719
5724
  return PhoneMultiFactorInfoImpl;
5725
+ }(MultiFactorInfoImpl));
5726
+ var TotpMultiFactorInfoImpl = /** @class */ (function (_super) {
5727
+ tslib.__extends(TotpMultiFactorInfoImpl, _super);
5728
+ function TotpMultiFactorInfoImpl(response) {
5729
+ return _super.call(this, "totp" /* FactorId.TOTP */, response) || this;
5730
+ }
5731
+ TotpMultiFactorInfoImpl._fromServerResponse = function (_auth, enrollment) {
5732
+ return new TotpMultiFactorInfoImpl(enrollment);
5733
+ };
5734
+ return TotpMultiFactorInfoImpl;
5720
5735
  }(MultiFactorInfoImpl));
5721
5736
 
5722
5737
  /**
@@ -6683,6 +6698,7 @@ function setPersistence(auth, persistence) {
6683
6698
  *
6684
6699
  * @remarks
6685
6700
  * This includes sign-in, sign-out, and token refresh events.
6701
+ * This will not be triggered automatically upon ID token expiration. Use {@link User.getIdToken} to refresh the ID token.
6686
6702
  *
6687
6703
  * @param auth - The {@link Auth} instance.
6688
6704
  * @param nextOrObserver - callback triggered on change.
@@ -6939,6 +6955,12 @@ function getMultiFactorResolver(auth, error) {
6939
6955
  * See the License for the specific language governing permissions and
6940
6956
  * limitations under the License.
6941
6957
  */
6958
+ function startEnrollTotpMfa(auth, request) {
6959
+ return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaEnrollment:start" /* Endpoint.START_MFA_ENROLLMENT */, _addTidIfNecessary(auth, request));
6960
+ }
6961
+ function finalizeEnrollTotpMfa(auth, request) {
6962
+ return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaEnrollment:finalize" /* Endpoint.FINALIZE_MFA_ENROLLMENT */, _addTidIfNecessary(auth, request));
6963
+ }
6942
6964
  function withdrawMfa(auth, request) {
6943
6965
  return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaEnrollment:withdraw" /* Endpoint.WITHDRAW_MFA */, _addTidIfNecessary(auth, request));
6944
6966
  }
@@ -7069,7 +7091,7 @@ function multiFactor(user) {
7069
7091
  }
7070
7092
 
7071
7093
  var name = "@firebase/auth";
7072
- var version = "0.21.5-canary.ce79f7fe2";
7094
+ var version = "0.21.5-canary.f8a2c5865";
7073
7095
 
7074
7096
  /**
7075
7097
  * @license
@@ -7324,6 +7346,216 @@ AuthImpl.prototype.setPersistence = function () { return tslib.__awaiter(void 0,
7324
7346
  return [2 /*return*/];
7325
7347
  }); }); };
7326
7348
 
7349
+ /**
7350
+ * @license
7351
+ * Copyright 2020 Google LLC
7352
+ *
7353
+ * Licensed under the Apache License, Version 2.0 (the "License");
7354
+ * you may not use this file except in compliance with the License.
7355
+ * You may obtain a copy of the License at
7356
+ *
7357
+ * http://www.apache.org/licenses/LICENSE-2.0
7358
+ *
7359
+ * Unless required by applicable law or agreed to in writing, software
7360
+ * distributed under the License is distributed on an "AS IS" BASIS,
7361
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
7362
+ * See the License for the specific language governing permissions and
7363
+ * limitations under the License.
7364
+ */
7365
+ function finalizeSignInTotpMfa(auth, request) {
7366
+ return _performApiRequest(auth, "POST" /* HttpMethod.POST */, "/v2/accounts/mfaSignIn:finalize" /* Endpoint.FINALIZE_MFA_SIGN_IN */, _addTidIfNecessary(auth, request));
7367
+ }
7368
+
7369
+ var MultiFactorAssertionImpl = /** @class */ (function () {
7370
+ function MultiFactorAssertionImpl(factorId) {
7371
+ this.factorId = factorId;
7372
+ }
7373
+ MultiFactorAssertionImpl.prototype._process = function (auth, session, displayName) {
7374
+ switch (session.type) {
7375
+ case "enroll" /* MultiFactorSessionType.ENROLL */:
7376
+ return this._finalizeEnroll(auth, session.credential, displayName);
7377
+ case "signin" /* MultiFactorSessionType.SIGN_IN */:
7378
+ return this._finalizeSignIn(auth, session.credential);
7379
+ default:
7380
+ return debugFail('unexpected MultiFactorSessionType');
7381
+ }
7382
+ };
7383
+ return MultiFactorAssertionImpl;
7384
+ }());
7385
+
7386
+ /**
7387
+ * Provider for generating a {@link TotpMultiFactorAssertion}.
7388
+ *
7389
+ * @public
7390
+ */
7391
+ var TotpMultiFactorGenerator = /** @class */ (function () {
7392
+ function TotpMultiFactorGenerator() {
7393
+ }
7394
+ /**
7395
+ * Provides a {@link TotpMultiFactorAssertion} to confirm ownership of
7396
+ * the TOTP (time-based one-time password) second factor.
7397
+ * This assertion is used to complete enrollment in TOTP second factor.
7398
+ *
7399
+ * @param secret A {@link TotpSecret} containing the shared secret key and other TOTP parameters.
7400
+ * @param oneTimePassword One-time password from TOTP App.
7401
+ * @returns A {@link TotpMultiFactorAssertion} which can be used with
7402
+ * {@link MultiFactorUser.enroll}.
7403
+ */
7404
+ TotpMultiFactorGenerator.assertionForEnrollment = function (secret, oneTimePassword) {
7405
+ return TotpMultiFactorAssertionImpl._fromSecret(secret, oneTimePassword);
7406
+ };
7407
+ /**
7408
+ * Provides a {@link TotpMultiFactorAssertion} to confirm ownership of the TOTP second factor.
7409
+ * This assertion is used to complete signIn with TOTP as the second factor.
7410
+ *
7411
+ * @param enrollmentId identifies the enrolled TOTP second factor.
7412
+ * @param oneTimePassword One-time password from TOTP App.
7413
+ * @returns A {@link TotpMultiFactorAssertion} which can be used with
7414
+ * {@link MultiFactorResolver.resolveSignIn}.
7415
+ */
7416
+ TotpMultiFactorGenerator.assertionForSignIn = function (enrollmentId, oneTimePassword) {
7417
+ return TotpMultiFactorAssertionImpl._fromEnrollmentId(enrollmentId, oneTimePassword);
7418
+ };
7419
+ /**
7420
+ * Returns a promise to {@link TotpSecret} which contains the TOTP shared secret key and other parameters.
7421
+ * Creates a TOTP secret as part of enrolling a TOTP second factor.
7422
+ * Used for generating a QR code URL or inputting into a TOTP app.
7423
+ * This method uses the auth instance corresponding to the user in the multiFactorSession.
7424
+ *
7425
+ * @param session The {@link MultiFactorSession} that the user is part of.
7426
+ * @returns A promise to {@link TotpSecret}.
7427
+ */
7428
+ TotpMultiFactorGenerator.generateSecret = function (session) {
7429
+ return tslib.__awaiter(this, void 0, void 0, function () {
7430
+ var mfaSession, response;
7431
+ return tslib.__generator(this, function (_a) {
7432
+ switch (_a.label) {
7433
+ case 0:
7434
+ mfaSession = session;
7435
+ _assert(typeof mfaSession.auth !== 'undefined', "internal-error" /* AuthErrorCode.INTERNAL_ERROR */);
7436
+ return [4 /*yield*/, startEnrollTotpMfa(mfaSession.auth, {
7437
+ idToken: mfaSession.credential,
7438
+ totpEnrollmentInfo: {}
7439
+ })];
7440
+ case 1:
7441
+ response = _a.sent();
7442
+ return [2 /*return*/, TotpSecret._fromStartTotpMfaEnrollmentResponse(response, mfaSession.auth)];
7443
+ }
7444
+ });
7445
+ });
7446
+ };
7447
+ /**
7448
+ * The identifier of the TOTP second factor: `totp`.
7449
+ */
7450
+ TotpMultiFactorGenerator.FACTOR_ID = "totp" /* FactorId.TOTP */;
7451
+ return TotpMultiFactorGenerator;
7452
+ }());
7453
+ var TotpMultiFactorAssertionImpl = /** @class */ (function (_super) {
7454
+ tslib.__extends(TotpMultiFactorAssertionImpl, _super);
7455
+ function TotpMultiFactorAssertionImpl(otp, enrollmentId, secret) {
7456
+ var _this = _super.call(this, "totp" /* FactorId.TOTP */) || this;
7457
+ _this.otp = otp;
7458
+ _this.enrollmentId = enrollmentId;
7459
+ _this.secret = secret;
7460
+ return _this;
7461
+ }
7462
+ /** @internal */
7463
+ TotpMultiFactorAssertionImpl._fromSecret = function (secret, otp) {
7464
+ return new TotpMultiFactorAssertionImpl(otp, undefined, secret);
7465
+ };
7466
+ /** @internal */
7467
+ TotpMultiFactorAssertionImpl._fromEnrollmentId = function (enrollmentId, otp) {
7468
+ return new TotpMultiFactorAssertionImpl(otp, enrollmentId);
7469
+ };
7470
+ /** @internal */
7471
+ TotpMultiFactorAssertionImpl.prototype._finalizeEnroll = function (auth, idToken, displayName) {
7472
+ return tslib.__awaiter(this, void 0, void 0, function () {
7473
+ return tslib.__generator(this, function (_a) {
7474
+ _assert(typeof this.secret !== 'undefined', auth, "argument-error" /* AuthErrorCode.ARGUMENT_ERROR */);
7475
+ return [2 /*return*/, finalizeEnrollTotpMfa(auth, {
7476
+ idToken: idToken,
7477
+ displayName: displayName,
7478
+ totpVerificationInfo: this.secret._makeTotpVerificationInfo(this.otp)
7479
+ })];
7480
+ });
7481
+ });
7482
+ };
7483
+ /** @internal */
7484
+ TotpMultiFactorAssertionImpl.prototype._finalizeSignIn = function (auth, mfaPendingCredential) {
7485
+ return tslib.__awaiter(this, void 0, void 0, function () {
7486
+ var totpVerificationInfo;
7487
+ return tslib.__generator(this, function (_a) {
7488
+ _assert(this.enrollmentId !== undefined && this.otp !== undefined, auth, "argument-error" /* AuthErrorCode.ARGUMENT_ERROR */);
7489
+ totpVerificationInfo = { verificationCode: this.otp };
7490
+ return [2 /*return*/, finalizeSignInTotpMfa(auth, {
7491
+ mfaPendingCredential: mfaPendingCredential,
7492
+ mfaEnrollmentId: this.enrollmentId,
7493
+ totpVerificationInfo: totpVerificationInfo
7494
+ })];
7495
+ });
7496
+ });
7497
+ };
7498
+ return TotpMultiFactorAssertionImpl;
7499
+ }(MultiFactorAssertionImpl));
7500
+ /**
7501
+ * Provider for generating a {@link TotpMultiFactorAssertion}.
7502
+ *
7503
+ * Stores the shared secret key and other parameters to generate time-based OTPs.
7504
+ * Implements methods to retrieve the shared secret key and generate a QR code URL.
7505
+ * @public
7506
+ */
7507
+ var TotpSecret = /** @class */ (function () {
7508
+ // The public members are declared outside the constructor so the docs can be generated.
7509
+ function TotpSecret(secretKey, hashingAlgorithm, codeLength, codeIntervalSeconds, enrollmentCompletionDeadline, sessionInfo, auth) {
7510
+ this.sessionInfo = sessionInfo;
7511
+ this.auth = auth;
7512
+ this.secretKey = secretKey;
7513
+ this.hashingAlgorithm = hashingAlgorithm;
7514
+ this.codeLength = codeLength;
7515
+ this.codeIntervalSeconds = codeIntervalSeconds;
7516
+ this.enrollmentCompletionDeadline = enrollmentCompletionDeadline;
7517
+ }
7518
+ /** @internal */
7519
+ TotpSecret._fromStartTotpMfaEnrollmentResponse = function (response, auth) {
7520
+ 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);
7521
+ };
7522
+ /** @internal */
7523
+ TotpSecret.prototype._makeTotpVerificationInfo = function (otp) {
7524
+ return { sessionInfo: this.sessionInfo, verificationCode: otp };
7525
+ };
7526
+ /**
7527
+ * Returns a QR code URL as described in
7528
+ * https://github.com/google/google-authenticator/wiki/Key-Uri-Format
7529
+ * This can be displayed to the user as a QR code to be scanned into a TOTP app like Google Authenticator.
7530
+ * If the optional parameters are unspecified, an accountName of <userEmail> and issuer of <firebaseAppName> are used.
7531
+ *
7532
+ * @param accountName the name of the account/app along with a user identifier.
7533
+ * @param issuer issuer of the TOTP (likely the app name).
7534
+ * @returns A QR code URL string.
7535
+ */
7536
+ TotpSecret.prototype.generateQrCodeUrl = function (accountName, issuer) {
7537
+ var _a;
7538
+ var useDefaults = false;
7539
+ if (_isEmptyString(accountName) || _isEmptyString(issuer)) {
7540
+ useDefaults = true;
7541
+ }
7542
+ if (useDefaults) {
7543
+ if (_isEmptyString(accountName)) {
7544
+ accountName = ((_a = this.auth.currentUser) === null || _a === void 0 ? void 0 : _a.email) || 'unknownuser';
7545
+ }
7546
+ if (_isEmptyString(issuer)) {
7547
+ issuer = this.auth.name;
7548
+ }
7549
+ }
7550
+ return "otpauth://totp/".concat(issuer, ":").concat(accountName, "?secret=").concat(this.secretKey, "&issuer=").concat(issuer, "&algorithm=").concat(this.hashingAlgorithm, "&digits=").concat(this.codeLength);
7551
+ };
7552
+ return TotpSecret;
7553
+ }());
7554
+ /** @internal */
7555
+ function _isEmptyString(input) {
7556
+ return typeof input === 'undefined' || (input === null || input === void 0 ? void 0 : input.length) === 0;
7557
+ }
7558
+
7327
7559
  exports.AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY = AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY;
7328
7560
  exports.ActionCodeOperation = ActionCodeOperation;
7329
7561
  exports.ActionCodeURL = ActionCodeURL;
@@ -7349,6 +7581,8 @@ exports.RecaptchaVerifier = RecaptchaVerifier;
7349
7581
  exports.SAMLAuthCredential = SAMLAuthCredential;
7350
7582
  exports.SAMLAuthProvider = SAMLAuthProvider;
7351
7583
  exports.SignInMethod = SignInMethod;
7584
+ exports.TotpMultiFactorGenerator = TotpMultiFactorGenerator;
7585
+ exports.TotpSecret = TotpSecret;
7352
7586
  exports.TwitterAuthProvider = TwitterAuthProvider;
7353
7587
  exports.UserImpl = UserImpl;
7354
7588
  exports._assert = _assert;
@@ -7430,4 +7664,4 @@ exports.updateProfile = updateProfile;
7430
7664
  exports.useDeviceLanguage = useDeviceLanguage;
7431
7665
  exports.verifyBeforeUpdateEmail = verifyBeforeUpdateEmail;
7432
7666
  exports.verifyPasswordResetCode = verifyPasswordResetCode;
7433
- //# sourceMappingURL=index-37042dd3.js.map
7667
+ //# sourceMappingURL=totp-bee43d8c.js.map