@firebase/auth 0.21.5 → 0.21.6-canary.45a55330e

package/dist/rn/index.d.ts

@@ -32,5 +32,6 @@ import { signInWithRedirect, linkWithRedirect, reauthenticateWithRedirect, getRe
 import { RecaptchaVerifier } from './src/platform_browser/recaptcha/recaptcha_verifier';
 import { browserPopupRedirectResolver } from './src/platform_browser/popup_redirect';
 import { PhoneMultiFactorGenerator } from './src/platform_browser/mfa/assertions/phone';
+import { TotpMultiFactorGenerator, TotpSecret } from './src/mfa/assertions/totp';
 import { getAuth } from './src/platform_browser';
-export { browserLocalPersistence, browserSessionPersistence, indexedDBLocalPersistence, PhoneAuthProvider, signInWithPhoneNumber, linkWithPhoneNumber, reauthenticateWithPhoneNumber, updatePhoneNumber, signInWithPopup, linkWithPopup, reauthenticateWithPopup, signInWithRedirect, linkWithRedirect, reauthenticateWithRedirect, getRedirectResult, RecaptchaVerifier, browserPopupRedirectResolver, PhoneMultiFactorGenerator, getAuth };
+export { browserLocalPersistence, browserSessionPersistence, indexedDBLocalPersistence, PhoneAuthProvider, signInWithPhoneNumber, linkWithPhoneNumber, reauthenticateWithPhoneNumber, updatePhoneNumber, signInWithPopup, linkWithPopup, reauthenticateWithPopup, signInWithRedirect, linkWithRedirect, reauthenticateWithRedirect, getRedirectResult, RecaptchaVerifier, browserPopupRedirectResolver, PhoneMultiFactorGenerator, TotpMultiFactorGenerator, TotpSecret, getAuth };

package/dist/rn/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var ReactNative = require('react-native');
 var app = require('@firebase/app');
-var phone = require('./phone-e7bf48a1.js');
+var phone = require('./phone-588b1f48.js');
 var tslib = require('tslib');
 require('@firebase/util');
 require('@firebase/component');

package/dist/rn/internal.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var phone = require('./phone-e7bf48a1.js');
+var phone = require('./phone-588b1f48.js');
 var tslib = require('tslib');
 var util = require('@firebase/util');
 var app = require('@firebase/app');
@@ -2885,6 +2885,179 @@ var BrowserPopupRedirectResolver = /** @class */ (function () {
  */
 var browserPopupRedirectResolver = BrowserPopupRedirectResolver;
 
+/**
+ * Provider for generating a {@link TotpMultiFactorAssertion}.
+ *
+ * @public
+ */
+var TotpMultiFactorGenerator = /** @class */ (function () {
+    function TotpMultiFactorGenerator() {
+    }
+    /**
+     * Provides a {@link TotpMultiFactorAssertion} to confirm ownership of
+     * the TOTP (time-based one-time password) second factor.
+     * This assertion is used to complete enrollment in TOTP second factor.
+     *
+     * @param secret A {@link TotpSecret} containing the shared secret key and other TOTP parameters.
+     * @param oneTimePassword One-time password from TOTP App.
+     * @returns A {@link TotpMultiFactorAssertion} which can be used with
+     * {@link MultiFactorUser.enroll}.
+     */
+    TotpMultiFactorGenerator.assertionForEnrollment = function (secret, oneTimePassword) {
+        return TotpMultiFactorAssertionImpl._fromSecret(secret, oneTimePassword);
+    };
+    /**
+     * Provides a {@link TotpMultiFactorAssertion} to confirm ownership of the TOTP second factor.
+     * This assertion is used to complete signIn with TOTP as the second factor.
+     *
+     * @param enrollmentId identifies the enrolled TOTP second factor.
+     * @param oneTimePassword One-time password from TOTP App.
+     * @returns A {@link TotpMultiFactorAssertion} which can be used with
+     * {@link MultiFactorResolver.resolveSignIn}.
+     */
+    TotpMultiFactorGenerator.assertionForSignIn = function (enrollmentId, oneTimePassword) {
+        return TotpMultiFactorAssertionImpl._fromEnrollmentId(enrollmentId, oneTimePassword);
+    };
+    /**
+     * Returns a promise to {@link TotpSecret} which contains the TOTP shared secret key and other parameters.
+     * Creates a TOTP secret as part of enrolling a TOTP second factor.
+     * Used for generating a QR code URL or inputting into a TOTP app.
+     * This method uses the auth instance corresponding to the user in the multiFactorSession.
+     *
+     * @param session The {@link MultiFactorSession} that the user is part of.
+     * @returns A promise to {@link TotpSecret}.
+     */
+    TotpMultiFactorGenerator.generateSecret = function (session) {
+        return tslib.__awaiter(this, void 0, void 0, function () {
+            var mfaSession, response;
+            return tslib.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        mfaSession = session;
+                        phone._assert(typeof mfaSession.auth !== 'undefined', "internal-error" /* AuthErrorCode.INTERNAL_ERROR */);
+                        return [4 /*yield*/, phone.startEnrollTotpMfa(mfaSession.auth, {
+                                idToken: mfaSession.credential,
+                                totpEnrollmentInfo: {}
+                            })];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, TotpSecret._fromStartTotpMfaEnrollmentResponse(response, mfaSession.auth)];
+                }
+            });
+        });
+    };
+    /**
+     * The identifier of the TOTP second factor: `totp`.
+     */
+    TotpMultiFactorGenerator.FACTOR_ID = "totp" /* FactorId.TOTP */;
+    return TotpMultiFactorGenerator;
+}());
+var TotpMultiFactorAssertionImpl = /** @class */ (function (_super) {
+    tslib.__extends(TotpMultiFactorAssertionImpl, _super);
+    function TotpMultiFactorAssertionImpl(otp, enrollmentId, secret) {
+        var _this = _super.call(this, "totp" /* FactorId.TOTP */) || this;
+        _this.otp = otp;
+        _this.enrollmentId = enrollmentId;
+        _this.secret = secret;
+        return _this;
+    }
+    /** @internal */
+    TotpMultiFactorAssertionImpl._fromSecret = function (secret, otp) {
+        return new TotpMultiFactorAssertionImpl(otp, undefined, secret);
+    };
+    /** @internal */
+    TotpMultiFactorAssertionImpl._fromEnrollmentId = function (enrollmentId, otp) {
+        return new TotpMultiFactorAssertionImpl(otp, enrollmentId);
+    };
+    /** @internal */
+    TotpMultiFactorAssertionImpl.prototype._finalizeEnroll = function (auth, idToken, displayName) {
+        return tslib.__awaiter(this, void 0, void 0, function () {
+            return tslib.__generator(this, function (_a) {
+                phone._assert(typeof this.secret !== 'undefined', auth, "argument-error" /* AuthErrorCode.ARGUMENT_ERROR */);
+                return [2 /*return*/, phone.finalizeEnrollTotpMfa(auth, {
+                        idToken: idToken,
+                        displayName: displayName,
+                        totpVerificationInfo: this.secret._makeTotpVerificationInfo(this.otp)
+                    })];
+            });
+        });
+    };
+    /** @internal */
+    TotpMultiFactorAssertionImpl.prototype._finalizeSignIn = function (auth, mfaPendingCredential) {
+        return tslib.__awaiter(this, void 0, void 0, function () {
+            var totpVerificationInfo;
+            return tslib.__generator(this, function (_a) {
+                phone._assert(this.enrollmentId !== undefined && this.otp !== undefined, auth, "argument-error" /* AuthErrorCode.ARGUMENT_ERROR */);
+                totpVerificationInfo = { verificationCode: this.otp };
+                return [2 /*return*/, phone.finalizeSignInTotpMfa(auth, {
+                        mfaPendingCredential: mfaPendingCredential,
+                        mfaEnrollmentId: this.enrollmentId,
+                        totpVerificationInfo: totpVerificationInfo
+                    })];
+            });
+        });
+    };
+    return TotpMultiFactorAssertionImpl;
+}(phone.MultiFactorAssertionImpl));
+/**
+ * Provider for generating a {@link TotpMultiFactorAssertion}.
+ *
+ * Stores the shared secret key and other parameters to generate time-based OTPs.
+ * Implements methods to retrieve the shared secret key and generate a QR code URL.
+ * @public
+ */
+var TotpSecret = /** @class */ (function () {
+    // The public members are declared outside the constructor so the docs can be generated.
+    function TotpSecret(secretKey, hashingAlgorithm, codeLength, codeIntervalSeconds, enrollmentCompletionDeadline, sessionInfo, auth) {
+        this.sessionInfo = sessionInfo;
+        this.auth = auth;
+        this.secretKey = secretKey;
+        this.hashingAlgorithm = hashingAlgorithm;
+        this.codeLength = codeLength;
+        this.codeIntervalSeconds = codeIntervalSeconds;
+        this.enrollmentCompletionDeadline = enrollmentCompletionDeadline;
+    }
+    /** @internal */
+    TotpSecret._fromStartTotpMfaEnrollmentResponse = function (response, auth) {
+        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);
+    };
+    /** @internal */
+    TotpSecret.prototype._makeTotpVerificationInfo = function (otp) {
+        return { sessionInfo: this.sessionInfo, verificationCode: otp };
+    };
+    /**
+     * Returns a QR code URL as described in
+     * https://github.com/google/google-authenticator/wiki/Key-Uri-Format
+     * This can be displayed to the user as a QR code to be scanned into a TOTP app like Google Authenticator.
+     * If the optional parameters are unspecified, an accountName of <userEmail> and issuer of <firebaseAppName> are used.
+     *
+     * @param accountName the name of the account/app along with a user identifier.
+     * @param issuer issuer of the TOTP (likely the app name).
+     * @returns A QR code URL string.
+     */
+    TotpSecret.prototype.generateQrCodeUrl = function (accountName, issuer) {
+        var _a;
+        var useDefaults = false;
+        if (_isEmptyString(accountName) || _isEmptyString(issuer)) {
+            useDefaults = true;
+        }
+        if (useDefaults) {
+            if (_isEmptyString(accountName)) {
+                accountName = ((_a = this.auth.currentUser) === null || _a === void 0 ? void 0 : _a.email) || 'unknownuser';
+            }
+            if (_isEmptyString(issuer)) {
+                issuer = this.auth.name;
+            }
+        }
+        return "otpauth://totp/".concat(issuer, ":").concat(accountName, "?secret=").concat(this.secretKey, "&issuer=").concat(issuer, "&algorithm=").concat(this.hashingAlgorithm, "&digits=").concat(this.codeLength);
+    };
+    return TotpSecret;
+}());
+/** @internal */
+function _isEmptyString(input) {
+    return typeof input === 'undefined' || (input === null || input === void 0 ? void 0 : input.length) === 0;
+}
+
 /**
  * @license
  * Copyright 2021 Google LLC
@@ -3729,6 +3902,8 @@ exports.useDeviceLanguage = phone.useDeviceLanguage;
 exports.verifyBeforeUpdateEmail = phone.verifyBeforeUpdateEmail;
 exports.verifyPasswordResetCode = phone.verifyPasswordResetCode;
 exports.AuthPopup = AuthPopup;
+exports.TotpMultiFactorGenerator = TotpMultiFactorGenerator;
+exports.TotpSecret = TotpSecret;
 exports._generateEventId = _generateEventId;
 exports._getRedirectResult = _getRedirectResult;
 exports._overrideRedirectResult = _overrideRedirectResult;