Credential Manager - Verifier API

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

डिजिटल क्रेडेंशियल, W3C का सार्वजनिक स्टैंडर्ड है. इसमें बताया गया है कि डिजिटल वॉलेट से, उपयोगकर्ता के पुष्टि किए जा सकने वाले डिजिटल क्रेडेंशियल को कैसे ऐक्सेस किया जा सकता है. इसे W3C Credential Management API के साथ, वेब इस्तेमाल के मामलों के लिए लागू किया जाता है. Android पर, डिजिटल क्रेडेंशियल की पुष्टि करने के लिए, Credential Manager के DigitalCredential API का इस्तेमाल किया जाता है.

Android के वर्शन के साथ काम करने की सुविधा

Verifier API, Android 6 (एपीआई लेवल 23) और इसके बाद के वर्शन पर काम करता है.

लागू करना

अपने Android प्रोजेक्ट में डिजिटल क्रेडेंशियल की पुष्टि करने के लिए, यह तरीका अपनाएं:

  1. अपने ऐप्लिकेशन के बिल्ड स्क्रिप्ट में डिपेंडेंसी जोड़ें और CredentialManager क्लास को शुरू करें.
  2. डिजिटल क्रेडेंशियल का अनुरोध बनाएं और इसका इस्तेमाल करके, DigitalCredentialOption को शुरू करें. इसके बाद, GetCredentialRequest बनाएं.
  3. बनाए गए अनुरोध के साथ, getCredential फ़्लो लॉन्च करें, ताकि आपको GetCredentialResponse मिल सके. इसके अलावा, होने वाली किसी भी गड़बड़ी को ठीक करें. सफलतापूर्वक वापस पाने के बाद, जवाब की पुष्टि करें.

डिपेंडेंसी जोड़ना और शुरू करना

अपने Gradle बिल्ड स्क्रिप्ट में, ये डिपेंडेंसी जोड़ें:

dependencies {
    implementation("androidx.credentials:credentials:1.6.0-beta01")
    implementation("androidx.credentials:credentials-play-services-auth:1.6.0-beta01")
}

इसके बाद, CredentialManager क्लास का इंस्टेंस शुरू करें.

val credentialManager = CredentialManager.create(context)

डिजिटल क्रेडेंशियल का अनुरोध बनाना

डिजिटल क्रेडेंशियल का अनुरोध बनाएं और इसका इस्तेमाल करके, DigitalCredentialOption को शुरू करें.

// The request in the JSON format to conform with
// the JSON-ified Credential Manager - Verifier API request definition.
val requestJson = generateRequestFromServer()
val digitalCredentialOption =
    GetDigitalCredentialOption(requestJson = requestJson)

// Use the option from the previous step to build the `GetCredentialRequest`.
val getCredRequest = GetCredentialRequest(
    listOf(digitalCredentialOption)
)

यहां OpenId4Vp के अनुरोध का एक उदाहरण दिया गया है. पूरी जानकारी इस वेबसाइट पर देखी जा सकती है.

{
  "requests": [
    {
      "protocol": "openid4vp-v1-unsigned",
      "data": {
        "response_type": "vp_token",
        "response_mode": "dc_api",
        "nonce": "OD8eP8BYfr0zyhgq4QCVEGN3m7C1Ht_No9H5fG5KJFk",
        "dcql_query": {
          "credentials": [
            {
              "id": "cred1",
              "format": "mso_mdoc",
              "meta": {
                "doctype_value": "org.iso.18013.5.1.mDL"
              },
              "claims": [
                {
                  "path": [
                    "org.iso.18013.5.1",
                    "family_name"
                  ]
                },
                {
                  "path": [
                    "org.iso.18013.5.1",
                    "given_name"
                  ]
                },
                {
                  "path": [
                    "org.iso.18013.5.1",
                    "age_over_21"
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

क्रेडेंशियल पाना

बनाए गए अनुरोध के साथ, getCredential फ़्लो लॉन्च करें. अगर अनुरोध पूरा हो जाता है, तो आपको GetCredentialResponse मिलेगा. वहीं, अगर अनुरोध पूरा नहीं होता है, तो आपको GetCredentialException मिलेगा.

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

coroutineScope.launch {
    try {
        val result = credentialManager.getCredential(
            context = activityContext,
            request = getCredRequest
        )
        verifyResult(result)
    } catch (e : GetCredentialException) {
        handleFailure(e)
    }
}

// Handle the successfully returned credential.
fun verifyResult(result: GetCredentialResponse) {
    val credential = result.credential
    when (credential) {
        is DigitalCredential -> {
            val responseJson = credential.credentialJson
            validateResponseOnServer(responseJson)
        }
        else -> {
            // Catch any unrecognized credential type here.
            Log.e(TAG, "Unexpected type of credential ${credential.type}")
        }
    }
}

// Handle failure.
fun handleFailure(e: GetCredentialException) {
  when (e) {
        is GetCredentialCancellationException -> {
            // The user intentionally canceled the operation and chose not
            // to share the credential.
        }
        is GetCredentialInterruptedException -> {
            // Retry-able error. Consider retrying the call.
        }
        is NoCredentialException -> {
            // No credential was available.
        }
        is CreateCredentialUnknownException -> {
            // An unknown, usually unexpected, error has occurred. Check the
            // message error for any additional debugging information.
        }
        is CreateCredentialCustomException -> {
            // You have encountered a custom error thrown by the wallet.
            // If you made the API call with a request object that's a
            // subclass of CreateCustomCredentialRequest using a 3rd-party SDK,
            // then you should check for any custom exception type constants
            // within that SDK to match with e.type. Otherwise, drop or log the
            // exception.
        }
        else -> Log.w(TAG, "Unexpected exception type ${e::class.java}")
    }
}