Jeśli masz już Firebase Authentication with Identity Platform, możesz dodać do swojej aplikacji internetowej uwierzytelnianie wielopoziomowe z użyciem SMS-ów.
Uwierzytelnianie wielopoziomowe zwiększa bezpieczeństwo aplikacji. Osoby przeprowadzające ataki często przejmują hasła i konta społecznościowe, ale przechwycenie SMS-a jest dużo trudniejsze.
Zanim zaczniesz
Włącz co najmniej 1 dostawcę, który obsługuje uwierzytelnianie wielopoziomowe. Uwierzytelnianie wielopoziomowe jest obsługiwane przez wszystkich dostawców z wyjątkiem uwierzytelniania przez telefon, uwierzytelniania anonimowego i Apple Game Center.
Włącz regiony, w których planujesz używać uwierzytelniania przez SMS-y. Firebase stosuje zasadę blokowania regionów SMS-ów, która domyślnie pomaga tworzyć projekty w bezpieczniejszym stanie.
Upewnij się, że Twoja aplikacja weryfikuje adresy e-mail użytkowników. MFA wymaga potwierdzania adresu e-mail. Uniemożliwia to złośliwym podmiotom rejestrowanie się w usłudze za pomocą adresu e-mail, którego nie są właścicielami, a następnie blokowanie dostępu prawdziwemu właścicielowi przez dodanie drugiego składnika.
Korzystanie z środowiska wielu najemców
Jeśli włączasz uwierzytelnianie wielopoziomowe do użytku w środowisku wielu najemców, wykonaj te czynności (oprócz pozostałych instrukcji w tym dokumencie):
W konsoli Google Cloud wybierz najemcę, z którym chcesz pracować.
W kodzie ustaw pole
tenantIdw instancjiAuthna identyfikator najemcy. Przykład:Web
import { getAuth } from "firebase/auth"; const auth = getAuth(app); auth.tenantId = "myTenantId1";Web
firebase.auth().tenantId = 'myTenantId1';
Włączanie uwierzytelniania wielopoziomowego
W konsoli Firebase otwórz Zabezpieczenia > Uwierzytelnianie.
Na karcie Metoda logowania w sekcji Zaawansowane włącz Uwierzytelnianie wielopoziomowe z użyciem SMS-ów.
Wpisz też numery telefonów, za pomocą których będziesz testować aplikację. Chociaż rejestracja numerów telefonów do testów jest opcjonalna, zdecydowanie ją zalecamy, ponieważ pozwoli uniknąć ograniczeń podczas programowania.
Jeśli jeszcze tego nie zrobisz, autoryzuj domenę aplikacji:
W konsoli Firebase otwórz kartę Zabezpieczenia > Uwierzytelnianie > Ustawienia.
W sekcji Dozwolone domeny kliknij Dodaj domenę i dodaj swoją domenę.
Wybieranie wzorca rejestracji
Możesz wybrać, czy Twoja aplikacja wymaga uwierzytelniania wielopoziomowego oraz jak i kiedy rejestrować użytkowników. Oto kilka typowych wzorców:
Zarejestruj drugi składnik użytkownika w ramach rejestracji. Użyj tej metody, jeśli Twoja aplikacja wymaga uwierzytelniania wielopoziomowego dla wszystkich użytkowników.
Podczas rejestracji zaproponuj opcję rejestracji drugiego składnika, którą można pominąć. Aplikacje, które chcą zachęcać do uwierzytelniania wielopoziomowego, ale nie wymagają go, mogą preferować to podejście.
Zamiast ekranu rejestracji udostępnij możliwość dodania drugiego składnika na stronie zarządzania kontem lub profilem użytkownika. Minimalizuje to trudności podczas procesu rejestracji, a jednocześnie udostępnia uwierzytelnianie wielopoziomowe użytkownikom, którzy dbają o bezpieczeństwo.
Wymagaj dodania drugiego składnika stopniowo, gdy użytkownik chce uzyskać dostęp do funkcji o zwiększonych wymaganiach dotyczących bezpieczeństwa.
Konfigurowanie weryfikatora reCAPTCHA
Zanim zaczniesz wysyłać kody SMS, musisz skonfigurować weryfikator reCAPTCHA. Firebase używa reCAPTCHA, aby zapobiegać nadużyciom, zapewniając, że prośby o weryfikację numeru telefonu pochodzą z jednej z dozwolonych domen aplikacji.
Nie musisz ręcznie konfigurować klienta reCAPTCHA. Obiekt RecaptchaVerifier w pakiecie SDK klienta automatycznie tworzy i inicjuje wszystkie niezbędne klucze i tajne klucze klienta.
Korzystanie z niewidocznej reCAPTCHA
Obiekt RecaptchaVerifier obsługuje
niewidoczną reCAPTCHA,
która często może zweryfikować użytkownika bez konieczności podejmowania przez niego żadnych działań. Aby użyć niewidocznej reCAPTCHA, utwórz obiekt RecaptchaVerifier z parametrem size ustawionym na invisible i określ identyfikator elementu interfejsu, który rozpoczyna rejestrację wielopoziomową:
Web
import { RecaptchaVerifier, getAuth } from "firebase/auth";
const recaptchaVerifier = new RecaptchaVerifier(getAuth(), "sign-in-button", {
"size": "invisible",
"callback": function(response) {
// reCAPTCHA solved, you can proceed with
// phoneAuthProvider.verifyPhoneNumber(...).
onSolvedRecaptcha();
}
});
Web
var recaptchaVerifier = new firebase.auth.RecaptchaVerifier('sign-in-button', {
'size': 'invisible',
'callback': function(response) {
// reCAPTCHA solved, you can proceed with phoneAuthProvider.verifyPhoneNumber(...).
onSolvedRecaptcha();
}
});
Korzystanie z widżetu reCAPTCHA
Aby użyć widocznego widżetu reCAPTCHA, utwórz element HTML, który będzie zawierać widżet, a następnie utwórz obiekt RecaptchaVerifier z identyfikatorem kontenera interfejsu. Opcjonalnie możesz też ustawić wywołania zwrotne, które są wywoływane, gdy reCAPTCHA zostanie rozwiązana lub wygaśnie:
Web
import { RecaptchaVerifier, getAuth } from "firebase/auth";
const recaptchaVerifier = new RecaptchaVerifier(
getAuth(),
"recaptcha-container",
// Optional reCAPTCHA parameters.
{
"size": "normal",
"callback": function(response) {
// reCAPTCHA solved, you can proceed with
// phoneAuthProvider.verifyPhoneNumber(...).
onSolvedRecaptcha();
},
"expired-callback": function() {
// Response expired. Ask user to solve reCAPTCHA again.
// ...
}
}
);
Web
var recaptchaVerifier = new firebase.auth.RecaptchaVerifier(
'recaptcha-container',
// Optional reCAPTCHA parameters.
{
'size': 'normal',
'callback': function(response) {
// reCAPTCHA solved, you can proceed with phoneAuthProvider.verifyPhoneNumber(...).
// ...
onSolvedRecaptcha();
},
'expired-callback': function() {
// Response expired. Ask user to solve reCAPTCHA again.
// ...
}
});
Wstępne renderowanie reCAPTCHA
Opcjonalnie możesz wstępnie renderować reCAPTCHA przed rozpoczęciem rejestracji dwuskładnikowej:
Web
recaptchaVerifier.render()
.then(function (widgetId) {
window.recaptchaWidgetId = widgetId;
});
Web
recaptchaVerifier.render()
.then(function(widgetId) {
window.recaptchaWidgetId = widgetId;
});
var recaptchaResponse = grecaptcha.getResponse(window.recaptchaWidgetId);
RecaptchaVerifier abstrahuje tę logikę za pomocą metody verify, więc nie musisz bezpośrednio obsługiwać zmiennej grecaptcha.
Rejestrowanie drugiego składnika
Aby zarejestrować nowy składnik dodatkowy dla użytkownika:
Ponownie uwierzytelnij użytkownika.
Poproś użytkownika o podanie numeru telefonu.
Zainicjuj weryfikator reCAPTCHA zgodnie z opisem w poprzedniej sekcji. Jeśli instancja RecaptchaVerifier jest już skonfigurowana, pomiń ten krok:
Web
import { RecaptchaVerifier, getAuth } from "firebase/auth"; const recaptchaVerifier = new RecaptchaVerifier( getAuth(),'recaptcha-container-id', undefined);Web
var recaptchaVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container-id');Uzyskaj sesję wielopoziomową dla użytkownika:
Web
import { multiFactor } from "firebase/auth"; multiFactor(user).getSession().then(function (multiFactorSession) { // ... });Web
user.multiFactor.getSession().then(function(multiFactorSession) { // ... })Zainicjuj obiekt
PhoneInfoOptionsz numerem telefonu użytkownika i sesją wielopoziomową:Web
// Specify the phone number and pass the MFA session. const phoneInfoOptions = { phoneNumber: phoneNumber, session: multiFactorSession };Web
// Specify the phone number and pass the MFA session. var phoneInfoOptions = { phoneNumber: phoneNumber, session: multiFactorSession };Wyślij wiadomość weryfikacyjną na telefon użytkownika:
Web
import { PhoneAuthProvider } from "firebase/auth"; const phoneAuthProvider = new PhoneAuthProvider(auth); phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier) .then(function (verificationId) { // verificationId will be needed to complete enrollment. });Web
var phoneAuthProvider = new firebase.auth.PhoneAuthProvider(); // Send SMS verification code. return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier) .then(function(verificationId) { // verificationId will be needed for enrollment completion. })Chociaż nie jest to wymagane, zalecamy poinformowanie użytkowników z wyprzedzeniem, że otrzymają SMS-a i że obowiązują standardowe stawki.
Jeśli żądanie się nie powiedzie, zresetuj reCAPTCHA, a następnie powtórz poprzedni krok, aby użytkownik mógł spróbować ponownie. Pamiętaj, że
verifyPhoneNumber()automatycznie zresetuje reCAPTCHA, gdy wystąpi błąd, ponieważ tokeny reCAPTCHA są jednorazowe.Web
recaptchaVerifier.clear();Web
recaptchaVerifier.clear();Gdy SMS zostanie wysłany, poproś użytkownika o zweryfikowanie kodu:
Web
// Ask user for the verification code. Then: const cred = PhoneAuthProvider.credential(verificationId, verificationCode);Web
// Ask user for the verification code. Then: var cred = firebase.auth.PhoneAuthProvider.credential(verificationId, verificationCode);Zainicjuj obiekt
MultiFactorAssertionza pomocąPhoneAuthCredential:Web
import { PhoneMultiFactorGenerator } from "firebase/auth"; const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(cred);Web
var multiFactorAssertion = firebase.auth.PhoneMultiFactorGenerator.assertion(cred);Dokończ rejestrację. Opcjonalnie możesz określić wyświetlaną nazwę drugiego składnika. Jest to przydatne w przypadku użytkowników, którzy mają kilka drugich składników, ponieważ numer telefonu jest maskowany podczas procesu uwierzytelniania (np. +1******1234).
Web
// Complete enrollment. This will update the underlying tokens // and trigger ID token change listener. multiFactor(user).enroll(multiFactorAssertion, "My personal phone number");Web
// Complete enrollment. This will update the underlying tokens // and trigger ID token change listener. user.multiFactor.enroll(multiFactorAssertion, 'My personal phone number');
Poniższy kod przedstawia pełny przykład rejestracji drugiego składnika:
Web
import {
multiFactor, PhoneAuthProvider, PhoneMultiFactorGenerator,
RecaptchaVerifier, getAuth
} from "firebase/auth";
const recaptchaVerifier = new RecaptchaVerifier(getAuth(),
'recaptcha-container-id', undefined);
multiFactor(user).getSession()
.then(function (multiFactorSession) {
// Specify the phone number and pass the MFA session.
const phoneInfoOptions = {
phoneNumber: phoneNumber,
session: multiFactorSession
};
const phoneAuthProvider = new PhoneAuthProvider(auth);
// Send SMS verification code.
return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier);
}).then(function (verificationId) {
// Ask user for the verification code. Then:
const cred = PhoneAuthProvider.credential(verificationId, verificationCode);
const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(cred);
// Complete enrollment.
return multiFactor(user).enroll(multiFactorAssertion, mfaDisplayName);
});
Web
var recaptchaVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container-id');
user.multiFactor.getSession().then(function(multiFactorSession) {
// Specify the phone number and pass the MFA session.
var phoneInfoOptions = {
phoneNumber: phoneNumber,
session: multiFactorSession
};
var phoneAuthProvider = new firebase.auth.PhoneAuthProvider();
// Send SMS verification code.
return phoneAuthProvider.verifyPhoneNumber(
phoneInfoOptions, recaptchaVerifier);
})
.then(function(verificationId) {
// Ask user for the verification code.
var cred = firebase.auth.PhoneAuthProvider.credential(verificationId, verificationCode);
var multiFactorAssertion = firebase.auth.PhoneMultiFactorGenerator.assertion(cred);
// Complete enrollment.
return user.multiFactor.enroll(multiFactorAssertion, mfaDisplayName);
});
Gratulacje! Udało Ci się zarejestrować drugi składnik uwierzytelniania dla użytkownika.
Logowanie użytkowników za pomocą drugiego składnika
Aby zalogować użytkownika za pomocą weryfikacji dwuetapowej przez SMS-a:
Zaloguj użytkownika za pomocą pierwszego składnika, a następnie przechwyć błąd
auth/multi-factor-auth-required. Ten błąd zawiera resolver, wskazówki dotyczące zarejestrowanych drugich składników oraz sesję bazową, która potwierdza, że użytkownik został uwierzytelniony za pomocą pierwszego składnika.Jeśli na przykład pierwszym składnikiem użytkownika był adres e-mail i hasło:
Web
import { getAuth, signInWithEmailAndPassword, getMultiFactorResolver} from "firebase/auth"; const auth = getAuth(); signInWithEmailAndPassword(auth, email, password) .then(function (userCredential) { // User successfully signed in and is not enrolled with a second factor. }) .catch(function (error) { if (error.code == 'auth/multi-factor-auth-required') { // The user is a multi-factor user. Second factor challenge is required. resolver = getMultiFactorResolver(auth, error); // ... } else if (error.code == 'auth/wrong-password') { // Handle other errors such as wrong password. } });Web
firebase.auth().signInWithEmailAndPassword(email, password) .then(function(userCredential) { // User successfully signed in and is not enrolled with a second factor. }) .catch(function(error) { if (error.code == 'auth/multi-factor-auth-required') { // The user is a multi-factor user. Second factor challenge is required. resolver = error.resolver; // ... } else if (error.code == 'auth/wrong-password') { // Handle other errors such as wrong password. } ... });Jeśli pierwszym składnikiem użytkownika jest dostawca federacyjny, np. OAuth, SAML lub OIDC, przechwyć błąd po wywołaniu
signInWithPopup()lubsignInWithRedirect().Jeśli użytkownik ma zarejestrowanych kilka składników dodatkowych, zapytaj, którego z nich chce użyć:
Web
// Ask user which second factor to use. // You can get the masked phone number via resolver.hints[selectedIndex].phoneNumber // You can get the display name via resolver.hints[selectedIndex].displayName if (resolver.hints[selectedIndex].factorId === PhoneMultiFactorGenerator.FACTOR_ID) { // User selected a phone second factor. // ... } else if (resolver.hints[selectedIndex].factorId === TotpMultiFactorGenerator.FACTOR_ID) { // User selected a TOTP second factor. // ... } else { // Unsupported second factor. }Web
// Ask user which second factor to use. // You can get the masked phone number via resolver.hints[selectedIndex].phoneNumber // You can get the display name via resolver.hints[selectedIndex].displayName if (resolver.hints[selectedIndex].factorId === firebase.auth.PhoneMultiFactorGenerator.FACTOR_ID) { // User selected a phone second factor. // ... } else if (resolver.hints[selectedIndex].factorId === firebase.auth.TotpMultiFactorGenerator.FACTOR_ID) { // User selected a TOTP second factor. // ... } else { // Unsupported second factor. }Zainicjuj weryfikator reCAPTCHA zgodnie z opisem w poprzedniej sekcji. Jeśli instancja RecaptchaVerifier jest już skonfigurowana, pomiń ten krok:
Web
import { RecaptchaVerifier, getAuth } from "firebase/auth"; recaptchaVerifier = new RecaptchaVerifier(getAuth(), 'recaptcha-container-id', undefined);Web
var recaptchaVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container-id');Zainicjuj obiekt
PhoneInfoOptionsz numerem telefonu użytkownika i sesją wielopoziomową. Te wartości są zawarte w obiekcieresolverprzekazanym do błęduauth/multi-factor-auth-required:Web
const phoneInfoOptions = { multiFactorHint: resolver.hints[selectedIndex], session: resolver.session };Web
var phoneInfoOptions = { multiFactorHint: resolver.hints[selectedIndex], session: resolver.session };Wyślij wiadomość weryfikacyjną na telefon użytkownika:
Web
// Send SMS verification code. const phoneAuthProvider = new PhoneAuthProvider(auth); phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier) .then(function (verificationId) { // verificationId will be needed for sign-in completion. });Web
var phoneAuthProvider = new firebase.auth.PhoneAuthProvider(); // Send SMS verification code. return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier) .then(function(verificationId) { // verificationId will be needed for sign-in completion. })Jeśli żądanie się nie powiedzie, zresetuj reCAPTCHA, a następnie powtórz poprzedni krok, aby użytkownik mógł spróbować ponownie:
Web
recaptchaVerifier.clear();Web
recaptchaVerifier.clear();Gdy SMS zostanie wysłany, poproś użytkownika o zweryfikowanie kodu:
Web
const cred = PhoneAuthProvider.credential(verificationId, verificationCode);Web
// Ask user for the verification code. Then: var cred = firebase.auth.PhoneAuthProvider.credential(verificationId, verificationCode);Zainicjuj obiekt
MultiFactorAssertionza pomocąPhoneAuthCredential:Web
const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(cred);Web
var multiFactorAssertion = firebase.auth.PhoneMultiFactorGenerator.assertion(cred);Aby dokończyć uwierzytelnianie dodatkowe, wywołaj
resolver.resolveSignIn(). Następnie możesz uzyskać dostęp do pierwotnego wyniku logowania, który zawiera standardowe dane specyficzne dla dostawcy i dane uwierzytelniające:Web
// Complete sign-in. This will also trigger the Auth state listeners. resolver.resolveSignIn(multiFactorAssertion) .then(function (userCredential) { // userCredential will also contain the user, additionalUserInfo, optional // credential (null for email/password) associated with the first factor sign-in. // For example, if the user signed in with Google as a first factor, // userCredential.additionalUserInfo will contain data related to Google // provider that the user signed in with. // - user.credential contains the Google OAuth credential. // - user.credential.accessToken contains the Google OAuth access token. // - user.credential.idToken contains the Google OAuth ID token. });Web
// Complete sign-in. This will also trigger the Auth state listeners. resolver.resolveSignIn(multiFactorAssertion) .then(function(userCredential) { // userCredential will also contain the user, additionalUserInfo, optional // credential (null for email/password) associated with the first factor sign-in. // For example, if the user signed in with Google as a first factor, // userCredential.additionalUserInfo will contain data related to Google provider that // the user signed in with. // user.credential contains the Google OAuth credential. // user.credential.accessToken contains the Google OAuth access token. // user.credential.idToken contains the Google OAuth ID token. });
Poniższy kod przedstawia pełny przykład logowania użytkownika z uwierzytelnianiem wielopoziomowym:
Web
import {
getAuth,
getMultiFactorResolver,
PhoneAuthProvider,
PhoneMultiFactorGenerator,
RecaptchaVerifier,
signInWithEmailAndPassword
} from "firebase/auth";
const recaptchaVerifier = new RecaptchaVerifier(getAuth(),
'recaptcha-container-id', undefined);
const auth = getAuth();
signInWithEmailAndPassword(auth, email, password)
.then(function (userCredential) {
// User is not enrolled with a second factor and is successfully
// signed in.
// ...
})
.catch(function (error) {
if (error.code == 'auth/multi-factor-auth-required') {
const resolver = getMultiFactorResolver(auth, error);
// Ask user which second factor to use.
if (resolver.hints[selectedIndex].factorId ===
PhoneMultiFactorGenerator.FACTOR_ID) {
const phoneInfoOptions = {
multiFactorHint: resolver.hints[selectedIndex],
session: resolver.session
};
const phoneAuthProvider = new PhoneAuthProvider(auth);
// Send SMS verification code
return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier)
.then(function (verificationId) {
// Ask user for the SMS verification code. Then:
const cred = PhoneAuthProvider.credential(
verificationId, verificationCode);
const multiFactorAssertion =
PhoneMultiFactorGenerator.assertion(cred);
// Complete sign-in.
return resolver.resolveSignIn(multiFactorAssertion)
})
.then(function (userCredential) {
// User successfully signed in with the second factor phone number.
});
} else if (resolver.hints[selectedIndex].factorId ===
TotpMultiFactorGenerator.FACTOR_ID) {
// Handle TOTP MFA.
// ...
} else {
// Unsupported second factor.
}
} else if (error.code == 'auth/wrong-password') {
// Handle other errors such as wrong password.
}
});
Web
var resolver;
firebase.auth().signInWithEmailAndPassword(email, password)
.then(function(userCredential) {
// User is not enrolled with a second factor and is successfully signed in.
// ...
})
.catch(function(error) {
if (error.code == 'auth/multi-factor-auth-required') {
resolver = error.resolver;
// Ask user which second factor to use.
if (resolver.hints[selectedIndex].factorId ===
firebase.auth.PhoneMultiFactorGenerator.FACTOR_ID) {
var phoneInfoOptions = {
multiFactorHint: resolver.hints[selectedIndex],
session: resolver.session
};
var phoneAuthProvider = new firebase.auth.PhoneAuthProvider();
// Send SMS verification code
return phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, recaptchaVerifier)
.then(function(verificationId) {
// Ask user for the SMS verification code.
var cred = firebase.auth.PhoneAuthProvider.credential(
verificationId, verificationCode);
var multiFactorAssertion =
firebase.auth.PhoneMultiFactorGenerator.assertion(cred);
// Complete sign-in.
return resolver.resolveSignIn(multiFactorAssertion)
})
.then(function(userCredential) {
// User successfully signed in with the second factor phone number.
});
} else if (resolver.hints[selectedIndex].factorId ===
firebase.auth.TotpMultiFactorGenerator.FACTOR_ID) {
// Handle TOTP MFA.
// ...
} else {
// Unsupported second factor.
}
} else if (error.code == 'auth/wrong-password') {
// Handle other errors such as wrong password.
} ...
});
Gratulacje! Udało Ci się zalogować użytkownika za pomocą uwierzytelniania wielopoziomowego.
Co dalej?
- Zarządzaj użytkownikami z uwierzytelnianiem wielopoziomowym programowo za pomocą Admin SDK.