Запрос цифровых удостоверений в WebView

В этом руководстве рассказывается, как запрашивать цифровые удостоверения с помощью Менеджера учетных данных в приложении Android, использующем WebView. Используйте JavaScript Bridge, чтобы упростить обмен данными между веб-страницей и приложением.

Обзор

Ниже описан жизненный цикл запроса цифрового удостоверения из WebView.

  1. Создание запроса. Веб-страница в WebView отправляет запрос на сервер приложения, который создает JSON-запрос OpenID4VP и отправляет его обратно.
  2. Инициация запроса. Веб-страница использует navigator.credentials.get({ digital: ... }), чтобы запросить цифровые удостоверения с помощью JSON-запроса.
  3. Перехват. Внедренный код bridge.js перехватывает этот вызов, извлекает определенный JSON-запрос OpenID4VP и передает его в приложение Android.
  4. Обработка в Android. Приложение Android получает сообщение и вызывает API CredentialManager.getCredential.
  5. Выбор пользователя. Менеджер учетных данных показывает пользователю интерфейс, в котором предлагает поделиться учетными данными. Учетные данные возвращаются в приложение Android.
  6. Ответ моста. Приложение Android отправляет ответ обратно на веб-страницу с помощью моста.
  7. Завершение. Веб-страница получает и обрабатывает ответ.

Требования

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

  • Совместимость с версиями Android. Приложение должно быть предназначено для Android 6.0 (уровень API 23) или более поздней версии.
  • Управление основным приложением. Вы должны управлять приложением Android, в котором размещен WebView, чтобы вы могли прикрепить WebMessageListener перед загрузкой веб-страницы.
  • HTTPS и фрейм верхнего уровня. Веб-страница, запрашивающая учетные данные, должна передаваться по протоколу https:// и выполняться в основном фрейме (isMainFrame должно быть равно true). Дочерние фреймы и встроенные элементы <iframe> не поддерживаются.
  • Согласие на использование экспериментального API. Поскольку Digital Credentials API является экспериментальным, вам необходимо аннотировать классы или методы, использующие GetDigitalCredentialOption, с помощью @OptIn(ExperimentalDigitalCredentialApi::class).

Добавьте зависимости

Добавьте зависимости Менеджера учетных данных и AndroidX WebKit в файл build.gradle.kts модуля приложения:

dependencies {
    // Credential Manager dependencies
    implementation("androidx.credentials:credentials:1.7.0-alpha03")
    implementation("androidx.credentials:credentials-play-services-auth:1.7.0-alpha03")

    // AndroidX WebKit (required for WebMessageListener bridge)
    implementation("androidx.webkit:webkit:1.14.0")
}

Как реализовать цифровые удостоверения в WebView

Вам нужно будет добавить JavaScript в WebView, чтобы сделать запрос учетных данных и перехватить его с помощью bridge.js.

Как создать запрос JavaScript

Чтобы обеспечить обмен данными между кодом JavaScript, работающим в WebView, и кодом Android, внедрите код JavaScript в WebView:

// Example digital credential request to request verified email
const request = {
  "providers": [
      {
        "protocol": "openid4vp",
        "request": JSON.stringify({
          "requests": [
            {
              "protocol": "openid4vp-v1-unsigned",
              "data": {
                "response_type": "vp_token",
                "response_mode": "dc_api",
                "nonce": "n-0S6_W_2F", // Generate dynamically
                "dcql_query": {
                  "credentials": [
                    {
                      "id": "user_info_query",
                      "format": "dc+sd-jwt",
                      "meta": {
                        "vct_values": ["UserInfoCredential"]
                      },
                      "claims": [
                        {"path": ["email"]},
                        {"path": ["email_verified"]},
                        {"path": ["name"]}
                      ]
                    }
                  ]
                }
              }
            }
          ]
      })
    }
  ]
};

try {
  const credential = await navigator.credentials.get({
    digital: request
  });

  // Process response
} catch (err) {
  // Handle error
}

Создайте мост JavaScript

Создайте файл с названием bridge.js или вставьте этот код с помощью evaluateJavascript. Этот скрипт переопределяет navigator.credentials.get, чтобы перехватить запрос и отправить внутреннюю строку JSON OpenID4VP в приложение Android.

(function() {
  if (!navigator.credentials) {
    navigator.credentials = {};
  }

  const originalGet = navigator.credentials.get;

  // Overrides navigator.credentials.get() to intercept W3C Digital Credential requests.
  navigator.credentials.get = async function(options) {

    if (options && options.digital) {
      if (window.DigitalCredentialBridge) {
        return new Promise((resolve, reject) => {
          const digital = options.digital;

          if (digital.providers && digital.providers.length > 0) {
            const provider = digital.providers[0];

            if (provider.protocol === "openid4vp") {
              const requestJson = provider.request;

              const message = {
                type: "get",
                request: requestJson
              };

              console.log("Sending message to native bridge:", JSON.stringify(message));
              // Send the request string to native Android code
              window.DigitalCredentialBridge.postMessage(JSON.stringify(message));

              // Receive the response sent from native code using replyProxy.postMessage()
              window.DigitalCredentialBridge.onmessage = function(event) {
                console.log("Received response from native bridge:", event.data);
                try {
                  const response = JSON.parse(event.data);
                  if (response.error) {
                    reject(new Error(response.error));
                  } else {
                    resolve(response);
                  }
                } catch (e) {
                  // If it's not JSON, just resolve with the raw data
                  resolve(event.data);
                }
              };
            } else {
              reject(new Error("Unsupported protocol: " + provider.protocol));
            }
          } else {
            reject(new Error("No providers specified in digital credential request"));
          }
        });
      } else {
        console.warn("DigitalCredentialBridge not found, falling back to original");
      }
    }

    if (originalGet) {
      return originalGet.call(navigator.credentials, options);
    } else {
      throw new Error("navigator.credentials.get is not supported and no bridge available");
    }
  };
})();

Как реализовать цифровые удостоверения в Android

Настройте приложение Android так, чтобы оно обрабатывало запросы учетных данных, отправленные из bridge.js.

Создание прослушивателя Android

Настройте класс DigitalCredentialWebListener, который реализует WebViewCompat.WebMessageListener. Этот класс обрабатывает двунаправленные сообщения между JavaScript и нативным кодом Android, выполняя проверки безопасности для isMainFrame и sourceOrigin и предотвращая перекрывающиеся запросы.

Реализуйте обработчик Менеджера учетных данных

Вызовите метод getCredential, чтобы запросить цифровые удостоверения с устройства.

@OptIn(ExperimentalDigitalCredentialApi::class)
class CredentialManagerHandler(private val context: Context) {
  private val credentialManager = CredentialManager.create(context)

  suspend fun getDigitalCredential(requestJson: String): String {
    val digitalCredentialOption = GetDigitalCredentialOption(requestJson)
    val getCredRequest = GetCredentialRequest(listOf(digitalCredentialOption))

    return try {
      val result = credentialManager.getCredential(context, getCredRequest)
      val credential = result.credential
      if (credential is DigitalCredential) {
        credential.credentialJson
      } else {
        "{\"error\": \"Unexpected credential type\"}"
      }
    } catch (e: GetCredentialException) {
      "{\"error\": \"${e.message}\"}"
    } catch (e: Exception) {
      "{\"error\": \"Unknown exception\"}"
    }
  }

  companion object {
    private const val TAG = "CredManHandler"
  }
}

Примените фреймворк к своему заданию

Зарегистрируйте WebMessageListener и связанные функции в Activity или View.

// Inside your Activity or View setup
AndroidView(
  factory = { context ->
    val handler = CredentialManagerHandler(context)
    WebView(context).apply {
      settings.javaScriptEnabled = true

      // Register the bridge before loading URL
      if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER)) {
                val listener = DigitalCredentialWebListener(coroutineScope, credentialManagerHandler)
                WebViewCompat.addWebMessageListener(
                    webView,
                    INTERFACE_NAME,
                    setOf("*"),
                    listener
                )


      loadUrl("https://your-secure-domain.com/login")
    }
  },
)

Тестирую переходы

Протестируйте процесс, чтобы убедиться, что компонент WebView и приложение Android обмениваются данными. Во время тестирования в WebView появится окно выбора учетных данных, а по завершении выбранные учетные данные будут возвращены в WebView.