Prośba o cyfrowe dokumenty tożsamości w komponencie WebView

Z tego przewodnika dowiesz się, jak prosić o cyfrowe dane uwierzytelniające za pomocą Credential Managera w aplikacji na Androida, która korzysta z komponentu WebView. Użyj mostu JavaScript, aby ułatwić komunikację między stroną internetową a aplikacją.

Przegląd

Poniżej opisujemy cykl życia żądania cyfrowego dokumentu tożsamości z WebView:

  1. Generowanie żądania: strona internetowa w komponencie WebView wysyła żądanie do serwera aplikacji, który generuje żądanie OpenID4VP w formacie JSON i odsyła je z powrotem.
  2. Inicjowanie żądania: strona internetowa używa navigator.credentials.get({ digital: ... }) do żądania cyfrowych danych uwierzytelniających za pomocą żądania JSON.
  3. Przechwytywanie: wstrzyknięty skrypt bridge.js przechwytuje to wywołanie, wyodrębnia konkretny obiekt JSON żądania OpenID4VP i przekazuje go do aplikacji na Androida.
  4. Obsługa na Androidzie: aplikacja na Androida otrzymuje wiadomość i wywołuje interfejs API CredentialManager.getCredential.
  5. Wybór użytkownika: Credential Manager wyświetla interfejs, który prosi użytkownika o udostępnienie danych logowania. Dane logowania zostaną zwrócone do aplikacji na Androida.
  6. Odpowiedź mostu: aplikacja na Androida wysyła odpowiedź z powrotem na stronę internetową za pomocą mostu.
  7. Zakończenie: strona internetowa otrzymuje i obsługuje odpowiedź.

Wymagania wstępne

Zanim zaimplementujesz most JavaScript dla cyfrowych dokumentów tożsamości w WebView, upewnij się, że Twój projekt spełnia te wymagania:

  • Zgodność z wersją Androida: aplikacja musi być kierowana na Androida 6.0 (poziom interfejsu API 23) lub nowszego.
  • Kontrola nad aplikacją hosta: musisz kontrolować aplikację na Androida hostującą WebView, aby móc dołączyć WebMessageListener przed wczytaniem strony internetowej.
  • HTTPS i ramka najwyższego poziomu: strona internetowa żądająca danych logowania musi być wyświetlana przez https:// i uruchamiana w ramce głównej (isMainFrame musi być true). Podramki i umieszczone elementy <iframe> nie są obsługiwane.
  • Akceptacja eksperymentalnego interfejsu API: interfejs Digital Credentials API jest eksperymentalny, dlatego musisz dodać adnotację do klas lub metod, które używają GetDigitalCredentialOption, za pomocą @OptIn(ExperimentalDigitalCredentialApi::class).

Dodawanie zależności

Dodaj zależności Credential Manager i AndroidX WebKit do pliku build.gradle.kts modułu aplikacji:

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

Wdrażanie cyfrowych dokumentów tożsamości w komponencie WebView

Aby wysłać żądanie danych logowania i przechwycić je za pomocą bridge.js, musisz dodać JavaScript do komponentu WebView.

Tworzenie żądania JavaScript

Aby umożliwić komunikację między kodem JavaScript działającym w komponencie WebView a kodem Androida, wstrzyknij kod JavaScript do komponentu 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
}

Tworzenie mostu JavaScript

Utwórz plik o nazwie bridge.js lub wstrzyknij ten kod za pomocą evaluateJavascript. Ten skrypt zastępuje navigator.credentials.get, aby przechwycić żądanie i wysłać wewnętrzny ciąg znaków JSON OpenID4VP do aplikacji na Androida.

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

Wdrażanie cyfrowych dokumentów tożsamości na Androidzie

Skonfiguruj aplikację na Androida, aby obsługiwała żądania danych logowania wysyłane z usługi bridge.js.

Tworzenie detektora na Androidzie

Skonfiguruj klasę DigitalCredentialWebListener, która implementuje interfejs WebViewCompat.WebMessageListener. Ta klasa obsługuje wiadomości dwukierunkowe między kodem JavaScript a natywnym kodem Androida, wymuszając kontrole bezpieczeństwa w przypadku isMainFrame i sourceOrigin oraz zapobiegając nakładaniu się żądań.

Implementowanie modułu obsługi Credential Manager

Wywołaj getCredential, aby poprosić o cyfrowe dane uwierzytelniające z urządzenia.

@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"
  }
}

Zastosuj platformę do aktywności

W pliku Activity lub View zarejestruj WebMessageListener i powiązane funkcje.

// 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")
    }
  },
)

Testuję działanie

Przetestuj proces, aby potwierdzić komunikację między komponentem WebView a aplikacją na Androida. Podczas tego procesu w komponencie WebView pojawi się selektor danych logowania, a po zakończeniu wybrane dane logowania zostaną zwrócone do komponentu WebView.