בקשת פרטי כניסה דיגיטליים ב-WebView

במדריך הזה מוסבר איך לבקש פרטי כניסה דיגיטליים באמצעות Credential Manager באפליקציה ל-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. בחירת המשתמש: Credential Manager מציג ממשק משתמש שמבקש מהמשתמש לשתף את פרטי הכניסה שלו. פרטי הכניסה מוחזרים לאפליקציה ל-Android.
  6. תגובת הגשר: אפליקציית Android שולחת את התגובה בחזרה לדף האינטרנט באמצעות הגשר.
  7. השלמה: דף האינטרנט מקבל את התגובה ומטפל בה.

דרישות מוקדמות

לפני שמטמיעים את גשר ה-JavaScript לאישורים דיגיטליים ב-WebView, חשוב לוודא שהפרויקט עומד בדרישות הבאות:

  • תאימות לגרסת Android: האפליקציה צריכה לטרגט ל-Android בגרסה 6.0 (רמת API‏ 23) ומעלה.
  • שליטה באפליקציה המארחת: אתם צריכים לשלוט באפליקציית Android שמארחת את WebView כדי שתוכלו לצרף WebMessageListener לפני טעינת דף האינטרנט.
  • ‫HTTPS ומסגרת ברמה העליונה: דף האינטרנט שמבקש את פרטי הכניסה צריך להיות מוצג דרך https:// ולפעול במסגרת הראשית (isMainFrame צריך להיות true). אין תמיכה במסגרות משנה וברכיבי <iframe> מוטמעים.
  • הבעת הסכמה ל-API ניסיוני: Digital Credentials API הוא ניסיוני, לכן צריך להוסיף הערות ל-classes או ל-methods שמשתמשים ב-GetDigitalCredentialOption באמצעות @OptIn(ExperimentalDigitalCredentialApi::class).

הוספת יחסי תלות

מוסיפים את יחסי התלות של Credential Manager ו-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 ומונעת בקשות חופפות.

הטמעת ה-Handler של Credential Manager

קוראים ל-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"
  }
}

החלת המסגרת על ה-Activity שלכם

ב-Activity או ב-View, רושמים את WebMessageListener והפונקציות שמשויכות אליו.

// 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 בסיום.