वेबव्यू से उपयोगकर्ताओं की पुष्टि करें

इस दस्तावेज़ में, क्रेडेंशियल मैनेजर एपीआई को वेबव्यू का इस्तेमाल करने वाले Android ऐप्लिकेशन के साथ इंटिग्रेट करने का तरीका बताया गया है.

खास जानकारी

इंटिग्रेशन की प्रोसेस शुरू करने से पहले, नेटिव Android कोड, वेबव्यू में रेंडर किए गए वेब कॉम्पोनेंट, और बैकएंड के बीच कम्यूनिकेशन के फ़्लो को समझना ज़रूरी है. वेब कॉम्पोनेंट, आपके ऐप्लिकेशन की पुष्टि करता है. इस फ़्लो में, रजिस्ट्रेशन (क्रेडेंशियल बनाना) और पुष्टि करना (मौजूदा क्रेडेंशियल के साथ) शामिल हैं.

रजिस्टर करना (पासकी बनाना)

  1. बैकएंड, शुरुआती रजिस्ट्रेशन JSON जनरेट करता है और उसे वेबव्यू में रेंडर किए गए वेब पेज पर भेजता है.
  2. वेब पेज, नए क्रेडेंशियल रजिस्टर करने के लिए navigator.credentials.create() का इस्तेमाल करता है. Android ऐप्लिकेशन को अनुरोध भेजने के लिए, बाद के चरण में इस तरीके को बदलने के लिए, इंजेक्ट किए गए JavaScript का इस्तेमाल किया जाएगा.
  3. Android ऐप्लिकेशन, क्रेडेंशियल का अनुरोध बनाने के लिए Credential Manager API का इस्तेमाल करता है. साथ ही, createCredential के लिए इसका इस्तेमाल करता है.
  4. Credential Manager API, ऐप्लिकेशन के साथ सार्वजनिक पासकोड क्रेडेंशियल शेयर करता है.
  5. ऐप्लिकेशन, सार्वजनिक कुंजी का क्रेडेंशियल वापस वेब पेज पर भेजता है, ताकि इंजेक्ट किए गए JavaScript जवाबों को पार्स कर सकें.
  6. वेब पेज, सार्वजनिक पासकोड को बैकएंड पर भेजता है. बैकएंड, सार्वजनिक पासकोड की पुष्टि करता है और उसे सेव करता है.
पासकी रजिस्ट्रेशन फ़्लो दिखाने वाला चार्ट
पहली इमेज. पासकी रजिस्ट्रेशन फ़्लो.

पुष्टि करना (पासकी पाना)

  1. क्रेडेंशियल पाने के लिए, बैकएंड पुष्टि करने वाला JSON जनरेट करता है और इसे वेब पेज पर भेजता है. यह वेब पेज, वेबव्यू क्लाइंट में रेंडर होता है.
  2. वेब पेज पर navigator.credentials.get का इस्तेमाल किया गया है. इंजेक्ट किए गए JavaScript का इस्तेमाल करके इस तरीके को बदलें, ताकि अनुरोध को Android ऐप्लिकेशन पर रीडायरेक्ट किया जा सके.
  3. ऐप्लिकेशन, getCredential को कॉल करके, क्रेडेंशियल मैनेजर एपीआई का इस्तेमाल करके क्रेडेंशियल हासिल करता है.
  4. क्रेडेंशियल मैनेजर एपीआई, ऐप्लिकेशन को क्रेडेंशियल दिखाता है.
  5. ऐप्लिकेशन को निजी पासकोड का डिजिटल हस्ताक्षर मिलता है और वह इसे वेब पेज पर भेजता है, ताकि इंजेक्ट किए गए JavaScript, जवाबों को पार्स कर सकें.
  6. इसके बाद, वेब पेज इसे सर्वर पर भेजता है. सर्वर, सार्वजनिक पासकोड की मदद से डिजिटल हस्ताक्षर की पुष्टि करता है.
पासकी की पुष्टि करने का फ़्लो दिखाने वाला चार्ट
दूसरी इमेज. पासकी की मदद से पुष्टि करने की प्रोसेस.

पासवर्ड या फ़ेडरेटेड आइडेंटिटी सिस्टम के लिए, उसी फ़्लो का इस्तेमाल किया जा सकता है.

ज़रूरी शर्तें

Credential Manager API का इस्तेमाल करने के लिए, Credential Manager की गाइड के ज़रूरी शर्तें सेक्शन में दिया गया तरीका अपनाएं. साथ ही, पक्का करें कि आपने ये काम किए हों:

JavaScript कम्यूनिकेशन

वेबव्यू और नेटिव Android कोड में मौजूद JavaScript को एक-दूसरे से बातचीत करने की अनुमति देने के लिए, आपको दोनों एनवायरमेंट के बीच मैसेज भेजने और अनुरोधों को मैनेज करने की ज़रूरत होगी. ऐसा करने के लिए, किसी वेबव्यू में कस्टम JavaScript कोड इंजेक्ट करें. इससे, वेब कॉन्टेंट के व्यवहार में बदलाव किया जा सकता है और नेटिव Android कोड के साथ इंटरैक्ट किया जा सकता है.

JavaScript इंजेक्शन

यहां दिया गया JavaScript कोड, वेबव्यू और Android ऐप्लिकेशन के बीच कम्यूनिकेशन की सुविधा देता है. यह navigator.credentials.create() और navigator.credentials.get() तरीकों को बदल देता है. इन तरीकों का इस्तेमाल, रजिस्टर करने और पुष्टि करने के लिए, पहले बताए गए WebAuthn API करता है.

अपने ऐप्लिकेशन में इस JavaScript कोड के छोटे किए गए वर्शन का इस्तेमाल करें.

पासकी के लिए एक लिसनर बनाना

ऐसी PasskeyWebListener क्लास सेट अप करें जो JavaScript के साथ कम्यूनिकेशन मैनेज करती हो. इस क्लास को WebViewCompat.WebMessageListener से इनहेरिट करना चाहिए. इस क्लास को JavaScript से मैसेज मिलते हैं और यह Android ऐप्लिकेशन में ज़रूरी कार्रवाइयां करती है.

Kotlin

// The class talking to Javascript should inherit:
class PasskeyWebListener(
    private val activity: Activity,
    private val coroutineScope: CoroutineScope,
    private val credentialManagerHandler: CredentialManagerHandler
) : WebViewCompat.WebMessageListener

// ... Implementation details

Java

// The class talking to Javascript should inherit:
class PasskeyWebListener implements WebViewCompat.WebMessageListener {

  // Implementation details
  private Activity activity;

  // Handles get/create methods meant for Java:
  private CredentialManagerHandler credentialManagerHandler;

  public PasskeyWebListener(
    Activity activity,
    CredentialManagerHandler credentialManagerHandler
    ) {
    this.activity = activity;
    this.credentialManagerHandler = credentialManagerHandler;
  }

// ... Implementation details
}

PasskeyWebListener में, अनुरोधों और जवाबों के लिए लॉजिक लागू करें, जैसा कि यहां दिए गए सेक्शन में बताया गया है.

पुष्टि करने के अनुरोध को मैनेज करना

WebAuthn navigator.credentials.create() या navigator.credentials.get() ऑपरेशन के अनुरोधों को मैनेज करने के लिए, PasskeyWebListener क्लास के onPostMessage तरीके को तब कॉल किया जाता है, जब JavaScript कोड, Android ऐप्लिकेशन को मैसेज भेजता है:

Kotlin

class PasskeyWebListener(...)... {
// ...

  /** havePendingRequest is true if there is an outstanding WebAuthn request.
      There is only ever one request outstanding at a time. */
  private var havePendingRequest = false

  /** pendingRequestIsDoomed is true if the WebView has navigated since
      starting a request. The FIDO module cannot be canceled, but the response
      will never be delivered in this case. */
  private var pendingRequestIsDoomed = false

  /** replyChannel is the port that the page is listening for a response on.
      It is valid if havePendingRequest is true. */
  private var replyChannel: ReplyChannel? = null

  /**
  * Called by the page during a WebAuthn request.
  *
  * @param view Creates the WebView.
  * @param message The message sent from the client using injected JavaScript.
  * @param sourceOrigin The origin of the HTTPS request. Should not be null.
  * @param isMainFrame Should be set to true. Embedded frames are not
    supported.
  * @param replyProxy Passed in by JavaScript. Allows replying when wrapped in
    the Channel.
  * @return The message response.
  */
  @UiThread
  override fun onPostMessage(
    view: WebView,
    message: WebMessageCompat,
    sourceOrigin: Uri,
    isMainFrame: Boolean,
    replyProxy: JavaScriptReplyProxy,
  ) {
    val messageData = message.data ?: return
    onRequest(
      messageData,
      sourceOrigin,
      isMainFrame,
      JavaScriptReplyChannel(replyProxy)
    )
  }

  private fun onRequest(
    msg: String,
    sourceOrigin: Uri,
    isMainFrame: Boolean,
    reply: ReplyChannel,
  ) {
    msg?.let {
      val jsonObj = JSONObject(msg);
      val type = jsonObj.getString(TYPE_KEY)
      val message = jsonObj.getString(REQUEST_KEY)

      if (havePendingRequest) {
        postErrorMessage(reply, "The request already in progress", type)
        return
      }

      replyChannel = reply
      if (!isMainFrame) {
        reportFailure("Requests from subframes are not supported", type)
        return
      }
      val originScheme = sourceOrigin.scheme
      if (originScheme == null || originScheme.lowercase() != "https") {
        reportFailure("WebAuthn not permitted for current URL", type)
        return
      }

      // Verify that origin belongs to your website,
      // it's because the unknown origin may gain credential info.
      if (isUnknownOrigin(originScheme)) {
        return
      }

      havePendingRequest = true
      pendingRequestIsDoomed = false

      // Use a temporary "replyCurrent" variable to send the data back, while
      // resetting the main "replyChannel" variable to null so it’s ready for
      // the next request.
      val replyCurrent = replyChannel
      if (replyCurrent == null) {
        Log.i(TAG, "The reply channel was null, cannot continue")
        return;
      }

      when (type) {
        CREATE_UNIQUE_KEY ->
          this.coroutineScope.launch {
            handleCreateFlow(credentialManagerHandler, message, replyCurrent)
          }

        GET_UNIQUE_KEY -> this.coroutineScope.launch {
          handleGetFlow(credentialManagerHandler, message, replyCurrent)
        }

        else -> Log.i(TAG, "Incorrect request json")
      }
    }
  }

  private suspend fun handleCreateFlow(
    credentialManagerHandler: CredentialManagerHandler,
    message: String,
    reply: ReplyChannel,
  ) {
    try {
      havePendingRequest = false
      pendingRequestIsDoomed = false
      val response = credentialManagerHandler.createPasskey(message)
      val successArray = ArrayList<Any>();
      successArray.add("success");
      successArray.add(JSONObject(response.registrationResponseJson));
      successArray.add(CREATE_UNIQUE_KEY);
      reply.send(JSONArray(successArray).toString())
      replyChannel = null // setting initial replyChannel for the next request
    } catch (e: CreateCredentialException) {
      reportFailure(
        "Error: ${e.errorMessage} w type: ${e.type} w obj: $e",
        CREATE_UNIQUE_KEY
      )
    } catch (t: Throwable) {
      reportFailure("Error: ${t.message}", CREATE_UNIQUE_KEY)
    }
  }

  companion object {
    const val TYPE_KEY = "type"
    const val REQUEST_KEY = "request"
    const val CREATE_UNIQUE_KEY = "create"
    const val GET_UNIQUE_KEY = "get"
  }
}

Java

class PasskeyWebListener implements ... {
// ...

  /**
  * Called by the page during a WebAuthn request.
  *
  * @param view Creates the WebView.
  * @param message The message sent from the client using injected JavaScript.
  * @param sourceOrigin The origin of the HTTPS request. Should not be null.
  * @param isMainFrame Should be set to true. Embedded frames are not
    supported.
  * @param replyProxy Passed in by JavaScript. Allows replying when wrapped in
    the Channel.
  * @return The message response.
  */
  @UiThread
  public void onPostMessage(
    @NonNull WebView view,
    @NonNull WebMessageCompat message,
    @NonNull Uri sourceOrigin,
    Boolean isMainFrame,
    @NonNull JavaScriptReplyProxy replyProxy,
  ) {
      if (messageData == null) {
        return;
    }
    onRequest(
      messageData,
      sourceOrigin,
      isMainFrame,
      JavaScriptReplyChannel(replyProxy)
    )
  }

  private void onRequest(
    String msg,
    Uri sourceOrigin,
    boolean isMainFrame,
    ReplyChannel reply
  ) {
      if (msg != null) {
        try {
          JSONObject jsonObj = new JSONObject(msg);
          String type = jsonObj.getString(TYPE_KEY);
          String message = jsonObj.getString(REQUEST_KEY);

          boolean isCreate = type.equals(CREATE_UNIQUE_KEY);
          boolean isGet = type.equals(GET_UNIQUE_KEY);

          if (havePendingRequest) {
              postErrorMessage(reply, "The request already in progress", type);
              return;
          }
          replyChannel = reply;
          if (!isMainFrame) {
              reportFailure("Requests from subframes are not supported", type);
              return;
          }
          String originScheme = sourceOrigin.getScheme();
          if (originScheme == null || !originScheme.toLowerCase().equals("https")) {
              reportFailure("WebAuthn not permitted for current URL", type);
              return;
          }

          // Verify that origin belongs to your website,
          // Requests of unknown origin may gain access to credential info.
          if (isUnknownOrigin(originScheme)) {
            return;
          }

          havePendingRequest = true;
          pendingRequestIsDoomed = false;

          // Use a temporary "replyCurrent" variable to send the data back,
          // while resetting the main "replyChannel" variable to null so it’s
          // ready for the next request.

          ReplyChannel replyCurrent = replyChannel;
          if (replyCurrent == null) {
              Log.i(TAG, "The reply channel was null, cannot continue");
              return;
          }

          if (isCreate) {
              handleCreateFlow(credentialManagerHandler, message, replyCurrent));
          } else if (isGet) {
              handleGetFlow(credentialManagerHandler, message, replyCurrent));
          } else {
              Log.i(TAG, "Incorrect request json");
          }
        } catch (JSONException e) {
        e.printStackTrace();
      }
    }
  }
}

handleCreateFlow और handleGetFlow के लिए, GitHub पर दिया गया उदाहरण देखें.

जवाब मैनेज करना

खास ऐप्लिकेशन से वेब पेज पर भेजे जाने वाले जवाबों को मैनेज करने के लिए, JavaScriptReplyChannel में JavaScriptReplyProxy जोड़ें.

Kotlin

class PasskeyWebListener(...)... {
// ...
  // The setup for the reply channel allows communication with JavaScript.
  private class JavaScriptReplyChannel(private val reply: JavaScriptReplyProxy) :
    ReplyChannel {
    override fun send(message: String?) {
      try {
        reply.postMessage(message!!)
      } catch (t: Throwable) {
        Log.i(TAG, "Reply failure due to: " + t.message);
      }
    }
  }

  // ReplyChannel is the interface where replies to the embedded site are
  // sent. This allows for testing since AndroidX bans mocking its objects.
  interface ReplyChannel {
    fun send(message: String?)
  }
}

Java

class PasskeyWebListener implements ... {
// ...

  // The setup for the reply channel allows communication with JavaScript.
  private static class JavaScriptReplyChannel implements ReplyChannel {
    private final JavaScriptReplyProxy reply;

    JavaScriptReplyChannel(JavaScriptReplyProxy reply) {
      this.reply = reply;
    }

    @Override
    public void send(String message) {
      reply.postMessage(message);
    }
  }

  // ReplyChannel is the interface where replies to the embedded site are
  // sent. This allows for testing since AndroidX bans mocking its objects.
  interface ReplyChannel {
    void send(String message);
  }
}

स्थानीय ऐप्लिकेशन से सभी गड़बड़ियों को देखना न भूलें और उन्हें JavaScript साइड पर वापस भेजें.

वेबव्यू के साथ इंटिग्रेट करना

इस सेक्शन में, वेबव्यू इंटिग्रेशन सेट अप करने का तरीका बताया गया है.

वेबव्यू को शुरू करना

अपने Android ऐप्लिकेशन की गतिविधि में, WebView को शुरू करें और उससे जुड़ा WebViewClient सेट अप करें. WebViewClient, WebView में इंजेक्ट किए गए JavaScript कोड के साथ कम्यूनिकेशन मैनेज करता है.

वेबव्यू सेट अप करें और क्रेडेंशियल मैनेजर को कॉल करें:

Kotlin

val credentialManagerHandler = CredentialManagerHandler(this)
// ...

AndroidView(factory = {
  WebView(it).apply {
    settings.javaScriptEnabled = true

    // Test URL:
    val url = "https://credman-web-test.glitch.me/"
    val listenerSupported = WebViewFeature.isFeatureSupported(
      WebViewFeature.WEB_MESSAGE_LISTENER
    )
    if (listenerSupported) {
      // Inject local JavaScript that calls Credential Manager.
      hookWebAuthnWithListener(this, this@MainActivity,
      coroutineScope, credentialManagerHandler)
      } else {
        // Fallback routine for unsupported API levels.
      }
      loadUrl(url)
    }
  }
)

Java

// Example shown in the onCreate method of an Activity

@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  setContentView(R.layout.activity_main);

  WebView webView = findViewById(R.id.web_view);
  // Test URL:
  String url = "https://credman-web-test.glitch.me/";
  Boolean listenerSupported = WebViewFeature.isFeatureSupported(
    WebViewFeature.WEB_MESSAGE_LISTENER
  );
  if (listenerSupported) {
    // Inject local JavaScript that calls Credential Manager.
    hookWebAuthnWithListener(webView, this,
      coroutineScope, credentialManagerHandler)
  } else {
    // Fallback routine for unsupported API levels.
  }
  webView.loadUrl(url);
}

नया वेबव्यू क्लाइंट ऑब्जेक्ट बनाएं और वेब पेज में JavaScript इंजेक्ट करें:

Kotlin

// This is an example call into hookWebAuthnWithListener
val passkeyWebListener = PasskeyWebListener(
  activity, coroutineScope, credentialManagerHandler
)

val webViewClient = object : WebViewClient() {
  override fun onPageStarted(view: WebView?, url: String?, favicon: Bitmap?) {
    super.onPageStarted(view, url, favicon)
    // Handle page load events
    passkeyWebListener.onPageStarted();
    webView.evaluateJavascript(PasskeyWebListener.INJECTED_VAL, null)
  }
}

webView.webViewClient = webViewClient

Java

// This is an example call into hookWebAuthnWithListener
PasskeyWebListener passkeyWebListener = new PasskeyWebListener(
  activity, credentialManagerHandler
)

WebViewClient webiewClient = new WebViewClient() {
  @Override
  public void onPageStarted(WebView view, String url, Bitmap favicon) {
    super.onPageStarted(view, url, favicon);
    // Handle page load events
    passkeyWebListener.onPageStarted();
    webView.evaulateJavascript(PasskeyWebListener.INJECTED_VAL, null);
  }
};

webView.setWebViewClient(webViewClient);

वेब मैसेज लिसनर सेट अप करना

JavaScript और Android ऐप्लिकेशन के बीच मैसेज पोस्ट करने की अनुमति देने के लिए, WebViewCompat.addWebMessageListener तरीके की मदद से वेब मैसेज सुनने वाला सेट अप करें.

Kotlin

val rules = setOf("*")
if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER)) {
  WebViewCompat.addWebMessageListener(
    webView, PasskeyWebListener.INTERFACE_NAME, rules, passkeyWebListener
  )
}

Java

Set<String> rules = new HashSet<>(Arrays.asList("*"));

if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER)) {
  WebViewCompat.addWebMessageListener(
    webView, PasskeyWebListener.INTERFACE_NAME, rules, passkeyWebListener
  )
}

वेब इंटिग्रेशन

वेब इंटिग्रेशन चेकआउट बनाने का तरीका जानने के लिए, बिना पासवर्ड के लॉगिन करने के लिए पासकी बनाएं और फ़ॉर्म में जानकारी अपने-आप भरने की सुविधा की मदद से पासकी से साइन इन करें.

जांच करना और डिप्लॉय करना

Android ऐप्लिकेशन, वेब पेज, और बैकएंड के बीच सही कम्यूनिकेशन पक्का करने के लिए, पूरे फ़्लो की जांच कंट्रोल किए गए माहौल में अच्छी तरह से करें.

इंटिग्रेट किए गए समाधान को प्रोडक्शन में डिप्लॉय करें. साथ ही, यह पक्का करें कि बैकएंड, आने वाले रजिस्ट्रेशन और पुष्टि के अनुरोधों को मैनेज कर सके. बैकएंड कोड को, रजिस्ट्रेशन (बनाने) और पुष्टि करने (पाने) की प्रोसेस के लिए, शुरुआती JSON जनरेट करना चाहिए. यह वेब पेज से मिले जवाबों की पुष्टि भी करनी चाहिए.

पुष्टि करें कि लागू करने का तरीका, यूज़र एक्सपीरियंस के सुझावों के मुताबिक हो.

ज़रूरी जानकारी

  • navigator.credentials.create() और navigator.credentials.get() से जुड़ी कार्रवाइयों को मैनेज करने के लिए, दिए गए JavaScript कोड का इस्तेमाल करें.
  • PasskeyWebListener क्लास, वेबव्यू में मौजूद Android ऐप्लिकेशन और JavaScript कोड के बीच ब्रिज की तरह काम करती है. यह मैसेज भेजने, सूचना देने, और ज़रूरी कार्रवाइयों को लागू करने की सुविधा देता है.
  • दिए गए कोड स्निपेट को अपने प्रोजेक्ट के स्ट्रक्चर, नाम रखने के तरीकों, और अपनी ज़रूरतों के हिसाब से बदलें.
  • नेटिव ऐप्लिकेशन की ओर से होने वाली गड़बड़ियों को पकड़ें और उन्हें JavaScript की ओर वापस भेजें.

इस गाइड का पालन करके और वेबव्यू का इस्तेमाल करने वाले अपने Android ऐप्लिकेशन में क्रेडेंशियल मैनेजर एपीआई को इंटिग्रेट करके, अपने उपयोगकर्ताओं को पासकी की मदद से सुरक्षित और आसान लॉगिन अनुभव दिया जा सकता है. साथ ही, उनके क्रेडेंशियल को असरदार तरीके से मैनेज किया जा सकता है.