Firebase Phone Number Verification is in private preview. If you're a developer interested in trying out this product during the preview phase, fill out this interest form to join the waitlist.

Эта страница переведена с помощью Cloud Translation API.

Настройте процесс проверки номера телефона Firebase на Android

На странице «Начало работы с Firebase Phone Number Verification подробно описано, как интегрировать Firebase PNV с помощью метода getVerifiedPhoneNumber() , который обрабатывает весь процесс Firebase PNV , от получения согласия пользователя до выполнения необходимых сетевых запросов к бэкэнду Firebase PNV .

Для большинства разработчиков рекомендуется использовать API с одним методом ( getVerifiedPhoneNumber() ). Однако, если вам нужен более точный контроль над взаимодействием с Android Credential Manager — например, для запроса других учетных данных вместе с номером телефона — библиотека Firebase PNV также предоставляет следующие два метода, каждый из которых обрабатывает различное взаимодействие с бэкэндом Firebase PNV :

getDigitalCredentialPayload() получает подписанный сервером запрос, который вы будете использовать для вызова диспетчера учетных данных.
exchangeCredentialResponseForPhoneNumber() обменивает ответ от диспетчера учетных данных на подписанный токен, содержащий подтвержденный номер телефона. На этом этапе будет произведена оплата.

Между вызовами каждого из этих методов вы отвечаете за обработку взаимодействия с API диспетчера учетных данных Android. На этой странице представлен обзор того, как реализовать этот трехэтапный процесс.

Прежде чем начать

Настройте свой проект Firebase и импортируйте зависимости Firebase PNV , как описано на странице «Начало работы» .

1. Получите полезную нагрузку запроса цифровых учетных данных.

Вызовите метод getDigitalCredentialPayload() , чтобы сгенерировать запрос на получение номера телефона устройства. На следующем шаге этот запрос станет полезной нагрузкой вашего взаимодействия с API Credential Manager.

// 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. Отправьте запрос на получение цифровых учетных данных с помощью Менеджера учетных данных.

Далее передайте запрос менеджеру учетных данных.

Для этого необходимо обернуть полезную нагрузку запроса в запрос к API DigitalCredential. Этот запрос должен содержать тот же nonce, который вы передали в getDigitalCredentialPayload() .

// 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()

После этого вы можете отправить запрос, используя API диспетчера учетных данных:

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
}

Если вызов диспетчера учетных данных будет успешным, в ответе будут содержаться цифровые учетные данные, которые можно извлечь с помощью кода, подобного приведенному ниже примеру:

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. Обменяйте полученный цифровой ответ с учетными данными на токен Firebase PNV .

Наконец, вызовите метод exchangeCredentialResponseForPhoneNumber() , чтобы обменять цифровой ответ с учетными данными на подтвержденный номер телефона и токен Firebase PNV :

fpnv.exchangeCredentialResponseForPhoneNumber(dcApiResponse)
  .addOnSuccessListener { result ->
    val phoneNumber = result.getPhoneNumber()
    // Verification successful
  }
  .addOnFailureListener { e -> /* Handle exchange failure */ }

После успешного завершения этого шага и получения в приложение подтвержденного номера телефона будет произведена оплата.

4. Проверка токена Firebase PNV

Если процесс завершится успешно, метод getVerifiedPhoneNumber() вернет подтвержденный номер телефона и подписанный токен, содержащий его. Вы можете использовать эти данные в своем приложении в соответствии с вашей политикой конфиденциальности.

Если вы используете проверенный номер телефона вне клиентского приложения, следует передавать токен, а не сам номер телефона, чтобы можно было проверить его целостность при использовании. Для проверки токенов необходимо реализовать две конечные точки:

Конечная точка генерации одноразового числа
Конечная точка проверки токена

Реализация этих конечных точек зависит от вас; следующие примеры показывают, как вы можете реализовать их с помощью Node.js и Express.

Генерация одноразовых кодов (nonce)

Эта конечная точка отвечает за генерацию и временное хранение одноразовых значений, называемых nonce, которые используются для предотвращения атак повторного воспроизведения против ваших конечных точек. Например, у вас может быть определен маршрут Express следующим образом:

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 });
});

Это конечная точка, которую вызовет функция-заполнитель fetchNonceFromYourServer() на шаге 1. Nonce будет передаваться через различные сетевые запросы, выполняемые клиентом, и в конечном итоге вернется на ваш сервер в токене Firebase PNV . На следующем шаге вы проверяете, содержит ли токен сгенерированный вами nonce.

Проверка токенов

Этот конечный пункт получает токены Firebase PNV от вашего клиента и проверяет их подлинность. Для проверки токена необходимо выполнить следующую проверку:

В заголовке typ установлен формат JWT .
Токен подписывается с использованием одного из ключей, опубликованных в конечной точке Firebase PNV JWKS, с применением алгоритма ES256 :
```
https://fpnv.googleapis.com/v1beta/jwks
```
В заявлении эмитента содержится номер вашего проекта Firebase, и оно имеет следующий формат:
```
https://fpnv.googleapis.com/projects/FIREBASE_PROJECT_NUMBER
```
Номер вашего проекта Firebase можно найти на странице настроек проекта в консоли Firebase.
Утверждение аудитории представляет собой список, содержащий номер вашего проекта Firebase и идентификатор проекта, и имеет следующий формат:
```
[
  https://fpnv.googleapis.com/projects/FIREBASE_PROJECT_NUMBER,
  https://fpnv.googleapis.com/projects/FIREBASE_PROJECT_ID,
]
```
Срок действия токена не истёк.
Токен содержит действительный одноразовый код (nonce). Одноразовый код считается действительным, если:
- Вы его сгенерировали (то есть, его можно найти в любом используемом вами механизме сохранения данных).
- Оно ещё не использовалось
- Срок действия не истёк.

Например, реализация Express может выглядеть примерно так:

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);
    }
});

Настройте процесс проверки номера телефона Firebase на Android Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.