Firebase Phone Number Verification kullanmaya başlayın sayfasında, kullanıcı rızası almaktan Firebase PNV arka ucuna gerekli ağ çağrılarını yapmaya kadar tüm Firebase PNV akışını yöneten getVerifiedPhoneNumber() yöntemini kullanarak Firebase PNV ile nasıl entegrasyon yapılacağı ayrıntılı olarak açıklanmaktadır.
Tek yöntemli API (getVerifiedPhoneNumber()) çoğu geliştirici için önerilir. Ancak Android Kimlik Bilgisi Yöneticisi ile etkileşim üzerinde daha ayrıntılı kontrole ihtiyacınız varsa (örneğin, telefon numarasıyla birlikte diğer kimlik bilgilerini istemek için) Firebase PNV kitaplığı, her biri Firebase PNV arka ucuyla farklı bir etkileşimi işleyen aşağıdaki iki yöntemi de sağlar:
getDigitalCredentialPayload(), Kimlik Bilgisi Yöneticisi'ni çağırmak için kullanacağınız sunucu tarafından imzalanmış bir istek alır.exchangeCredentialResponseForPhoneNumber(), Kimlik Bilgisi Yöneticisi'nden gelen yanıtı, doğrulanmış telefon numarasını içeren imzalı bir jetonla değiştirir. Faturalandırma bu adımda gerçekleşir.
Bu yöntemlerin her birini çağırma arasında, Android'in Credential Manager API'leriyle etkileşimi yönetmek sizin sorumluluğunuzdadır. Bu sayfada, üç bölümden oluşan bu akışı nasıl uygulayacağınıza dair genel bir bakış sunulmaktadır.
Başlamadan önce
Firebase projenizi oluşturun ve Başlangıç sayfasında açıklandığı şekilde Firebase PNV bağımlılıklarını içe aktarın.
1. Dijital kimlik bilgisi isteği yükünü alma
Cihazın telefon numarası için istek oluşturmak üzere getDigitalCredentialPayload() yöntemini çağırın. Bir sonraki adımda bu istek, Credential Manager API ile etkileşiminizin yükü olacaktır.
Kotlin
// This instance does not require an Activity context.
val fpnv = FirebasePhoneNumberVerification.getInstance()
// Your request should include a nonce, which will propagate through the flow
// and be present in the final response from FPNV. See the section "Verifying
// the Firebase PNV token" for details on generating and verifying this.
val nonce = fetchNonceFromYourServer()
fpnv.getDigitalCredentialPayload(nonce, "https://example.com/privacy-policy")
.addOnSuccessListener { fpnvDigitalCredentialPayload ->
// Use the payload in the next step.
// ...
}
.addOnFailureListener { e -> /* Handle payload fetch failure */ }
2. Kimlik Bilgisi Yöneticisi'ni kullanarak dijital kimlik bilgisi isteği gönderme
Ardından isteği Kimlik Bilgisi Yöneticisi'ne iletin.
Bunun için istek yükünü bir DigitalCredential API isteğine sarmalamanız gerekir. Bu istek, getDigitalCredentialPayload() yöntemine ilettiğiniz tek seferlik rastgele sayıyı içermelidir.
Kotlin
// This example uses string interpolation for clarity, but you should use some kind of type-safe
// serialization method.
fun buildDigitalCredentialRequestJson(nonce: String, fpnvDigitalCredentialPayload: String) = """
{
"requests": [
{
"protocol": "openid4vp-v1-unsigned",
"data": {
"response_type": "vp_token",
"response_mode": "dc_api",
"nonce": "$nonce",
"dcql_query": { "credentials": [$fpnvDigitalCredentialPayload] }
}
}
]
}
""".trimIndent()
Bunu yaptıktan sonra Credential Manager API'yi kullanarak istekte bulunabilirsiniz:
Kotlin
suspend fun makeFpnvRequest(
context: Activity, nonce: String, fpnvDigitalCredentialPayload: String): GetCredentialResponse {
// Helper function to build the digital credential request (defined above).
// Pass the same nonce you passed to getDigitalCredentialPayload().
val digitalCredentialRequestJson =
buildDigitalCredentialRequestJson(nonce, fpnvDigitalCredentialPayload)
// CredentialManager requires an Activity context.
val credentialManager = CredentialManager.create(context)
// Build a Credential Manager request that includes the Firebase PNV option. Note that
// you can't combine the digital credential option with other options.
val request = GetCredentialRequest.Builder()
.addCredentialOption(GetDigitalCredentialOption(digitalCredentialRequestJson))
.build()
// getCredential is a suspend function, so it must run in a coroutine scope,
val cmResponse: GetCredentialResponse = try {
credentialManager.getCredential(context, request)
} catch (e: GetCredentialException) {
// If the user cancels the operation, the feature isn't available, or the
// SIM doesn't support the feature, a GetCredentialCancellationException
// will be returned. Otherwise, a GetCredentialUnsupportedException will
// be returned with details in the exception message.
throw e
}
return cmResponse
}
Kimlik Bilgisi Yöneticisi çağrısı başarılı olursa yanıtında dijital kimlik bilgisi bulunur. Bu kimlik bilgisini aşağıdaki örnekte gösterilen kodu kullanarak ayıklayabilirsiniz:
Kotlin
val dcApiResponse = extractApiResponse(cmResponse)
fun extractApiResponse(response: GetCredentialResponse): String {
val credential = response.credential
when (credential) {
is DigitalCredential -> {
val json = JSONObject(credential.credentialJson)
val firebaseJwtArray =
json.getJSONObject("data").getJSONObject("vp_token").getJSONArray("firebase")
return firebaseJwtArray.getString(0)
}
else -> {
// Handle any unrecognized credential type here.
Log.e(TAG, "Unexpected type of credential ${credential.type}")
}
}
}
3. Dijital kimlik bilgisi yanıtını Firebase PNV jetonuyla değiştirme
Son olarak, dijital kimlik bilgisi yanıtını doğrulanmış telefon numarası ve Firebase PNV jetonuyla değiştirmek için exchangeCredentialResponseForPhoneNumber() yöntemini çağırın:
Kotlin
fpnv.exchangeCredentialResponseForPhoneNumber(dcApiResponse)
.addOnSuccessListener { result ->
val phoneNumber = result.getPhoneNumber()
// Verification successful
}
.addOnFailureListener { e -> /* Handle exchange failure */ }
Bu adım başarıyla tamamlandığında ve doğrulanmış telefon numarası uygulamanıza döndürüldüğünde faturalandırma tetiklenir.
4. Firebase PNV jetonu doğrulanıyor
Akış başarılı olursa getVerifiedPhoneNumber() yöntemi, doğrulanmış telefon numarasını ve bu numarayı içeren imzalı bir jetonu döndürür. Bu verileri, gizlilik politikanızda
belirtildiği şekilde uygulamanızda kullanabilirsiniz.
Doğrulanmış telefon numarasını uygulama istemcisinin dışında kullanıyorsanız telefon numarasının kendisi yerine jetonu iletmeniz gerekir. Böylece, kullandığınızda bütünlüğünü doğrulayabilirsiniz. Jetonları doğrulamak için iki uç nokta uygulamanız gerekir:
- Tek seferlik rastgele sayı oluşturma uç noktası
- Jeton doğrulama uç noktası
Bu uç noktaların uygulanması size bağlıdır. Aşağıdaki örneklerde, Node.js ve Express kullanarak bunları nasıl uygulayabileceğiniz gösterilmektedir.
Tek seferlik rastgele sayılar oluşturma
Bu uç nokta, uç noktalarınıza yönelik tekrar saldırılarını önlemek için kullanılan ve tek seferlik rastgele sayı olarak adlandırılan tek kullanımlık değerleri oluşturup geçici olarak depolamaktan sorumludur. Örneğin, aşağıdaki gibi tanımlanmış bir Express rotanız olabilir:
Node.js
app.get('/fpnvNonce', async (req, res) => {
const nonce = crypto.randomUUID();
// TODO: Save the nonce to a database, key store, etc.
// You should also assign the nonce an expiration time and periodically
// clear expired nonces from your database.
await persistNonce({
nonce,
expiresAt: Date.now() + 180000, // Give it a short duration.
});
// Return the nonce to the caller.
res.send({ nonce });
});
Bu, 1. adımdaki yer tutucu işlevin (fetchNonceFromYourServer()) çağıracağı uç noktadır. Tek seferlik rastgele sayı, istemcinin gerçekleştirdiği çeşitli ağ çağrıları üzerinden yayılır ve sonunda Firebase PNV jetonunda sunucunuza geri döner. Sonraki adımda, jetonun oluşturduğunuz tek seferlik rastgele sayıyı içerdiğini doğrularsınız.
Jetonları doğrulama
Bu uç nokta, istemcinizden Firebase PNV jetonları alır ve bunların gerçekliğini doğrular. Bir jetonu doğrulamak için şunları kontrol etmeniz gerekir:
typüstbilgisiJWTolarak ayarlanmış.Jeton, Firebase PNV algoritmasıyla
ES256JWKS uç noktasında yayınlanan anahtarlardan biri kullanılarak imzalanır:https://fpnv.googleapis.com/v1beta/jwksVeren hak talepleri, Firebase proje numaranızı içerir ve aşağıdaki biçimdedir:
https://fpnv.googleapis.com/projects/FIREBASE_PROJECT_NUMBERFirebase proje numaranızı Firebase konsolunun
Ayarlar > Genel sekmesinde bulabilirsiniz.Kitle talebi, Firebase proje numaranızı ve proje kimliğinizi içeren bir listedir ve şu biçimdedir:
[ https://fpnv.googleapis.com/projects/FIREBASE_PROJECT_NUMBER, https://fpnv.googleapis.com/projects/FIREBASE_PROJECT_ID, ]Jetonun süresi dolmamış olmalıdır.
Jeton, geçerli bir tek seferlik rastgele sayı içerir. Tek seferlik rastgele sayı aşağıdaki durumlarda geçerlidir:
- Siz oluşturduysanız (yani kullandığınız kalıcılık mekanizmasında bulunabiliyorsa)
- Daha önce kullanılmamış olmalıdır.
- Süresi dolmamış olmalıdır.
Örneğin, Express uygulaması aşağıdaki gibi görünebilir:
Node.js
import { JwtVerifier } from "aws-jwt-verify";
// Find your Firebase project number in the Firebase console.
const FIREBASE_PROJECT_NUMBER = "123456789";
// The issuer and audience claims of the FPNV token are specific to your
// project.
const issuer = `https://fpnv.googleapis.com/projects/${FIREBASE_PROJECT_NUMBER}`;
const audience = `https://fpnv.googleapis.com/projects/${FIREBASE_PROJECT_NUMBER}`;
// The JWKS URL contains the current public signing keys for FPNV tokens.
const jwksUri = "https://fpnv.googleapis.com/v1beta/jwks";
// Configure a JWT verifier to check the following:
// - The token is signed by Google
// - The issuer and audience claims match your project
// - The token has not yet expired (default begavior)
const fpnvVerifier = JwtVerifier.create({ issuer, audience, jwksUri });
app.post('/verifiedPhoneNumber', async (req, res) => {
if (!req.body) return res.sendStatus(400);
// Get the token from the body of the request.
const fpnvToken = req.body;
try {
// Attempt to verify the token using the verifier configured above.
const verifiedPayload = await fpnvVerifier.verify(fpnvToken);
// Now that you've verified the signature and claims, verify the nonce.
// TODO: Try to look up the nonce in your database and remove it if it's
// found; if it's not found or it's expired, throw an error.
await testAndRemoveNonce(verifiedPayload.nonce);
// Only after verifying the JWT signature, claims, and nonce, get the
// verified phone number from the subject claim.
// You can use this value however it's needed by your app.
const verifiedPhoneNumber = verifiedPayload.sub;
// (Do something with it...)
return res.sendStatus(200);
} catch {
// If verification fails, reject the token.
return res.sendStatus(400);
}
});