क्रेडेंशियल देने वाले अपने समाधान के साथ क्रेडेंशियल मैनेजर को इंटिग्रेट करें

Credential Manager, Android 14 में लॉन्च किए गए एपीआई का एक सेट है. इसमें साइन-इन करने के कई तरीके काम करते हैं. जैसे, उपयोगकर्ता नाम-पासवर्ड, पासकी, और फ़ेडरेटेड साइन-इन के समाधान (जैसे, Google से साइन-इन करना). Credential Manager API को कॉल करने पर, Android सिस्टम डिवाइस पर इंस्टॉल किए गए सभी क्रेडेंशियल प्रोवाइडर से क्रेडेंशियल इकट्ठा करता है. इस दस्तावेज़ में, एपीआई के उस सेट के बारे में बताया गया है जो क्रेडेंशियल की सेवा देने वाली इन कंपनियों के लिए, इंटिग्रेशन एंडपॉइंट उपलब्ध कराता है.

सेटअप

क्रेडेंशियल प्रोवाइडर में फ़ंक्शन लागू करने से पहले, यहां दिए गए सेक्शन में सेटअप करने का तरीका पूरा करें.

डिपेंडेंसी का एलान करना

Credential Manager लाइब्रेरी के नए वर्शन का इस्तेमाल करने के लिए, अपने ऐप्लिकेशन मॉड्यूल की बिल्ड स्क्रिप्ट में ये डिपेंडेंसी जोड़ें:

Kotlin

dependencies {
    implementation("androidx.credentials:credentials:1.7.0-alpha02")
}

Groovy

dependencies {
    implementation "androidx.credentials:credentials:1.7.0-alpha02"
}

मेनिफ़ेस्ट फ़ाइल में सेवा एलिमेंट की जानकारी दें

अपने ऐप्लिकेशन की मेनिफ़ेस्ट फ़ाइल AndroidManifest.xml में, ऐसी सेवा क्लास के लिए <service> एलान शामिल करें जो androidx.credentials लाइब्रेरी से CredentialProviderService क्लास को एक्सटेंड करती है. इसके बारे में यहां दिए गए उदाहरण में बताया गया है.

<service android:name=".MyCredentialProviderService"
    android:enabled="true"
    android:exported="true"
    android:label="My Credential Provider"
    android:icon="@mipmap/ic_launcher"
    android:permission="android.permission.BIND_CREDENTIAL_PROVIDER_SERVICE"
    tools:targetApi="upside_down_cake">
    <intent-filter>
        <action android:name="android.service.credentials.CredentialProviderService"/>
    </intent-filter>
    <meta-data
        android:name="android.credentials.provider"
        android:resource="@xml/provider"/>
</service>

पिछले उदाहरण में दिखाई गई अनुमति और इंटेंट फ़िल्टर, Credential Manager के फ़्लो के लिए ज़रूरी हैं, ताकि वह उम्मीद के मुताबिक काम कर सके. इस अनुमति की ज़रूरत इसलिए होती है, ताकि सिर्फ़ Android सिस्टम इस सेवा से जुड़ सके. इंटेंट फ़िल्टर का इस्तेमाल, इस सेवा को क्रेडेंशियल देने वाली सेवा के तौर पर खोजने के लिए किया जाता है. इसका इस्तेमाल, Credential Manager करता है.

इस्तेमाल किए जा सकने वाले क्रेडेंशियल टाइप की जानकारी देना

अपनी res/xml डायरेक्ट्री में, provider.xml नाम की एक नई फ़ाइल बनाएं. इस फ़ाइल में, क्रेडेंशियल के उन टाइप के बारे में बताएं जो आपकी सेवा के साथ काम करते हैं. इसके लिए, लाइब्रेरी में क्रेडेंशियल के हर टाइप के लिए तय किए गए कॉन्स्टेंट का इस्तेमाल करें. यहां दिए गए उदाहरण में, सेवा में सामान्य पासवर्ड के साथ-साथ पासकी भी काम करती हैं. इनके लिए कॉन्स्टेंट वैल्यू, TYPE_PASSWORD_CREDENTIAL और TYPE_PUBLIC_KEY_CREDENTIAL के तौर पर तय की गई हैं:

<credential-provider xmlns:android="http://schemas.android.com/apk/res/android">
    <capabilities>
        <capability name="android.credentials.TYPE_PASSWORD_CREDENTIAL" />
        <capability name="androidx.credentials.TYPE_PUBLIC_KEY_CREDENTIAL" />
    </capabilities>
</credential-provider>

पिछले एपीआई लेवल पर, क्रेडेंशियल उपलब्ध कराने वाली सेवाएं, पासवर्ड और अन्य डेटा के लिए, ऑटोमैटिक तरीके से भरने की सुविधा जैसे एपीआई के साथ इंटिग्रेट होती हैं. ये प्रोवाइडर, मौजूदा क्रेडेंशियल टाइप को सेव करने के लिए, एक ही इंटरनल इन्फ़्रास्ट्रक्चर का इस्तेमाल कर सकते हैं. साथ ही, वे इसे अन्य क्रेडेंशियल टाइप के साथ काम करने के लिए भी बढ़ा सकते हैं. इनमें पासकी भी शामिल हैं.

सेवा देने वाली कंपनी के साथ इंटरैक्शन के लिए दो चरणों वाला तरीका

Credential Manager, क्रेडेंशियल उपलब्ध कराने वाली सेवाओं के साथ दो चरणों में इंटरैक्ट करता है:

  1. पहला चरण, शुरुआत/क्वेरी का चरण होता है. इसमें सिस्टम, क्रेडेंशियल की सेवा देने वाली कंपनियों से जुड़ता है. साथ ही, Begin… अनुरोधों के साथ onBeginGetCredentialRequest(), onBeginCreateCredentialRequest() या onClearCredentialStateRequest() तरीकों को लागू करता है. सेवा देने वाली कंपनियों को इन अनुरोधों को प्रोसेस करना होगा और Begin… रिस्पॉन्स के साथ जवाब देना होगा. साथ ही, उन्हें ऐसी एंट्री भरनी होंगी जो खाता चुनने वाले टूल पर दिखाए जाने वाले विज़ुअल विकल्पों को दिखाती हों. हर एंट्री में PendingIntent सेट होना चाहिए.
  2. जब उपयोगकर्ता कोई एंट्री चुनता है, तो चुनने का चरण शुरू हो जाता है. साथ ही, एंट्री से जुड़ा PendingIntent ट्रिगर हो जाता है. इससे, सेवा देने वाली कंपनी की गतिविधि शुरू हो जाती है. जब उपयोगकर्ता इस गतिविधि को पूरा कर ले, तो क्रेडेंशियल मैनेजर को गतिविधि खत्म करने से पहले, गतिविधि के नतीजे के तौर पर जवाब सेट करना होगा. इसके बाद, यह जवाब उस क्लाइंट ऐप्लिकेशन को भेजा जाता है जिसने Credential Manager को शुरू किया था.

पासकी बनाने की प्रोसेस मैनेज करना

पासकी बनाने के लिए क्वेरी मैनेज करना

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

  1. CredentialProviderService से एक्सटेंड की गई अपनी सेवा में, onBeginCreateCredentialRequest() तरीके को बदलें.
  2. BeginCreateCredentialRequest को हैंडल करने के लिए, उससे जुड़ा BeginCreateCredentialResponse बनाएं और उसे कॉलबैक के ज़रिए पास करें.
  3. BeginCreateCredentialResponse बनाते समय, ज़रूरी CreateEntries जोड़ें. हर CreateEntry, उस खाते से जुड़ा होना चाहिए जिसमें क्रेडेंशियल सेव किया जा सकता है. साथ ही, इसमें अन्य ज़रूरी मेटाडेटा के साथ-साथ PendingIntent सेट होना चाहिए.

यहां दिए गए उदाहरण में, इन चरणों को लागू करने का तरीका बताया गया है.

override fun onBeginCreateCredentialRequest(
    request: BeginCreateCredentialRequest,
    cancellationSignal: CancellationSignal,
    callback: OutcomeReceiver<BeginCreateCredentialResponse, CreateCredentialException>,
) {
    val response: BeginCreateCredentialResponse? = processCreateCredentialRequest(request)
    if (response != null) {
        callback.onResult(response)
    } else {
        callback.onError(CreateCredentialUnknownException())
    }
}

fun processCreateCredentialRequest(request: BeginCreateCredentialRequest): BeginCreateCredentialResponse? {
    when (request) {
        is BeginCreatePublicKeyCredentialRequest -> {
            // Request is passkey type
            return handleCreatePasskeyQuery(request)
        }
    }
    // Request not supported
    return null
}

private fun handleCreatePasskeyQuery(
    request: BeginCreatePublicKeyCredentialRequest
): BeginCreateCredentialResponse {

    // Adding two create entries - one for storing credentials to the 'Personal'
    // account, and one for storing them to the 'Family' account. These
    // accounts are local to this sample app only.
    val createEntries: MutableList<CreateEntry> = mutableListOf()
    createEntries.add(
        CreateEntry(
            PERSONAL_ACCOUNT_ID,
            createNewPendingIntent(PERSONAL_ACCOUNT_ID, CREATE_PASSKEY_INTENT)
        )
    )

    createEntries.add(
        CreateEntry(
            FAMILY_ACCOUNT_ID,
            createNewPendingIntent(FAMILY_ACCOUNT_ID, CREATE_PASSKEY_INTENT)
        )
    )

    return BeginCreateCredentialResponse(createEntries)
}

private fun createNewPendingIntent(accountId: String, action: String): PendingIntent {
    val intent = Intent(action).setPackage(PACKAGE_NAME)

    // Add your local account ID as an extra to the intent, so that when
    // user selects this entry, the credential can be saved to this
    // account
    intent.putExtra(EXTRA_KEY_ACCOUNT_ID, accountId)

    return PendingIntent.getActivity(
        applicationContext, UNIQUE_REQ_CODE,
        intent,
        (
            PendingIntent.FLAG_MUTABLE
                or PendingIntent.FLAG_UPDATE_CURRENT
            )
    )
}

PendingIntent को बनाते समय इन बातों का ध्यान रखें:

  • संबंधित ऐक्टिविटी को इस तरह सेट अप किया जाना चाहिए कि ज़रूरी बायोमेट्रिक प्रॉम्प्ट, पुष्टि या विकल्प चुनने की सुविधा दिखे.
  • जब संबंधित गतिविधि को शुरू किया जाता है, तब सेवा देने वाली कंपनी को ज़रूरी डेटा की ज़रूरत होती है. इस डेटा को उस इंटेंट पर अतिरिक्त के तौर पर सेट किया जाना चाहिए जिसका इस्तेमाल आपके PendingIntent को बनाने के लिए किया जाता है. जैसे, बनाने के फ़्लो में accountId.
  • आपका PendingIntent, फ़्लैग PendingIntent.FLAG_MUTABLE के साथ बनाया जाना चाहिए, ताकि सिस्टम इंटेंट एक्स्ट्रा में आखिरी अनुरोध जोड़ सके.
  • आपके PendingIntent को PendingIntent.FLAG_ONE_SHOT फ़्लैग के साथ नहीं बनाया जाना चाहिए, क्योंकि हो सकता है कि उपयोगकर्ता कोई एंट्री चुने, वापस जाए, और उसे फिर से चुने. इससे PendingIntent दो बार ट्रिगर हो जाएगा.
  • आपके PendingIntent को एक यूनीक अनुरोध कोड के साथ बनाया जाना चाहिए, ताकि हर एंट्री का अपना PendingIntent हो सके.

पासकी बनाने के अनुरोधों के लिए, एंट्री चुनने की प्रोसेस को मैनेज करना

  1. जब उपयोगकर्ता पहले से भरी गई CreateEntry को चुनता है, तो उससे जुड़ी PendingIntent को शुरू किया जाता है. साथ ही, उससे जुड़ा प्रोवाइडर Activity बनाया जाता है.
  2. आपकी ऐक्टिविटी का onCreate तरीका शुरू होने के बाद, उससे जुड़े इंटेंट को ऐक्सेस करें और ProviderCreateCredentialRequest पाने के लिए, उसे PendingIntentHander क्लास में पास करें.
  3. अनुरोध से requestJson, callingAppInfo, और clientDataHash को एक्सट्रैक्ट करें.
  4. इंटेंट एक्स्ट्रा से स्थानीय accountId को एक्सट्रैक्ट करें. यह सैंपल के तौर पर मिले ऐप्लिकेशन के लिए, खास तौर पर लागू किया गया है और ज़रूरी नहीं है. इस खाता आईडी का इस्तेमाल, इस क्रेडेंशियल को इस खाता आईडी के लिए सेव करने के लिए किया जा सकता है.
  5. requestJson की पुष्टि करें. यहां दिए गए उदाहरण में, PublicKeyCredentialCreationOptions जैसी लोकल डेटा क्लास का इस्तेमाल किया गया है. इससे, इनपुट JSON को WebAuthn की खास जानकारी के मुताबिक स्ट्रक्चर्ड क्लास में बदला जाता है. क्रेडेंशियल की सेवा देने वाली कंपनी के तौर पर, इसे अपने पार्सर से बदला जा सकता है.
  6. अगर कॉल किसी नेटिव Android ऐप्लिकेशन से किया गया है, तो कॉलिंग ऐप्लिकेशन के लिए ऐसेट-लिंक देखें.
  7. पुष्टि करने का अनुरोध दिखाएं. यहां दिए गए उदाहरण में, Android के बायोमेट्रिक एपीआई का इस्तेमाल किया गया है.
  8. पुष्टि होने के बाद, एक credentialId और कुंजी का जोड़ा जनरेट करें.
  9. callingAppInfo.packageName के लिए, निजी पासकोड को अपने लोकल डेटाबेस में सेव करें.
  10. Web Authentication API JSON रिस्पॉन्स बनाएं. इसमें सार्वजनिक पासकोड और credentialId शामिल होना चाहिए. यहां दिए गए उदाहरण में, AuthenticatorAttestationResponse और FidoPublicKeyCredential जैसी लोकल यूटिलिटी क्लास का इस्तेमाल किया गया है. इनसे, पहले बताई गई खास जानकारी के आधार पर JSON बनाने में मदद मिलती है. क्रेडेंशियल की सेवा देने वाली कंपनी के तौर पर, इन क्लास को अपने बिल्डर से बदला जा सकता है.
  11. जनरेट किए गए JSON की मदद से, CreatePublicKeyCredentialResponse बनाएं.
  12. PendingIntentHander.setCreateCredentialResponse() का इस्तेमाल करके, CreatePublicKeyCredentialResponse को Intent पर अतिरिक्त के तौर पर सेट करें. साथ ही, उस इंटेंट को ऐक्टिविटी के नतीजे पर सेट करें.
  13. गतिविधि पूरी करें.

यहां दिए गए कोड के उदाहरण में, इन चरणों के बारे में बताया गया है. onCreate() को शुरू करने के बाद, इस कोड को आपकी ऐक्टिविटी क्लास में मैनेज करना होगा.

override fun onCreate(savedInstanceState: Bundle?, persistentState: PersistableBundle?) {
    super.onCreate(savedInstanceState, persistentState)
    // ...

    val request =
        PendingIntentHandler.retrieveProviderCreateCredentialRequest(intent)

    val accountId = intent.getStringExtra(CredentialsRepo.EXTRA_KEY_ACCOUNT_ID)
    if (request != null && request.callingRequest is CreatePublicKeyCredentialRequest) {
        val publicKeyRequest: CreatePublicKeyCredentialRequest =
            request.callingRequest as CreatePublicKeyCredentialRequest
        createPasskey(
            publicKeyRequest.requestJson,
            request.callingAppInfo,
            publicKeyRequest.clientDataHash,
            accountId
        )
    }
}

@SuppressLint("RestrictedApi")
fun createPasskey(
    requestJson: String,
    callingAppInfo: CallingAppInfo?,
    clientDataHash: ByteArray?,
    accountId: String?
) {
    val request = PublicKeyCredentialCreationOptions(requestJson)

    val biometricPrompt = BiometricPrompt(
        this,
        { }, // Pass in your own executor
        object : AuthenticationCallback() {
            override fun onAuthenticationError(errorCode: Int, errString: CharSequence) {
                super.onAuthenticationError(errorCode, errString)
                finish()
            }

            override fun onAuthenticationFailed() {
                super.onAuthenticationFailed()
                finish()
            }

            @RequiresApi(VERSION_CODES.P)
            override fun onAuthenticationSucceeded(
                result: AuthenticationResult
            ) {
                super.onAuthenticationSucceeded(result)

                // Generate a credentialId
                val credentialId = ByteArray(32)
                SecureRandom().nextBytes(credentialId)

                // Generate a credential key pair
                val spec = ECGenParameterSpec("secp256r1")
                val keyPairGen = KeyPairGenerator.getInstance("EC")
                keyPairGen.initialize(spec)
                val keyPair = keyPairGen.genKeyPair()

                // Save passkey in your database as per your own implementation

                // Create AuthenticatorAttestationResponse object to pass to
                // FidoPublicKeyCredential

                val response = AuthenticatorAttestationResponse(
                    requestOptions = request,
                    credentialId = credentialId,
                    credentialPublicKey = getPublicKeyFromKeyPair(keyPair),
                    origin = appInfoToOrigin(callingAppInfo!!),
                    up = true,
                    uv = true,
                    be = true,
                    bs = true,
                    packageName = callingAppInfo.packageName
                )

                val credential = FidoPublicKeyCredential(
                    rawId = credentialId,
                    response = response,
                    authenticatorAttachment = "", // Add your authenticator attachment
                )
                val result = Intent()

                val createPublicKeyCredResponse =
                    CreatePublicKeyCredentialResponse(credential.json())

                // Set the CreateCredentialResponse as the result of the Activity
                PendingIntentHandler.setCreateCredentialResponse(
                    result,
                    createPublicKeyCredResponse
                )
                setResult(RESULT_OK, result)
                finish()
            }
        }
    )

    val promptInfo = BiometricPrompt.PromptInfo.Builder()
        .setTitle("Use your screen lock")
        .setSubtitle("Create passkey for ${request.rp.name}")
        .setAllowedAuthenticators(
            BiometricManager.Authenticators.BIOMETRIC_STRONG
            /* or BiometricManager.Authenticators.DEVICE_CREDENTIAL */
        )
        .build()
    biometricPrompt.authenticate(promptInfo)
}

@RequiresApi(VERSION_CODES.P)
fun appInfoToOrigin(info: CallingAppInfo): String {
    val cert = info.signingInfo.apkContentsSigners[0].toByteArray()
    val md = MessageDigest.getInstance("SHA-256")
    val certHash = md.digest(cert)
    // This is the format for origin
    return "android:apk-key-hash:${b64Encode(certHash)}"
}

पासवर्ड बनाने के अनुरोधों से जुड़ी क्वेरी मैनेज करना

पासवर्ड बनाने के अनुरोधों से जुड़ी क्वेरी मैनेज करने के लिए, यह तरीका अपनाएं:

  • पिछले सेक्शन में बताए गए processCreateCredentialRequest() तरीके में, पासवर्ड के अनुरोधों को मैनेज करने के लिए, स्विच ब्लॉक में एक और केस जोड़ें.
  • BeginCreateCredentialResponse बनाते समय, ज़रूरी CreateEntries जोड़ें.
  • हर CreateEntry, उस खाते से जुड़ा होना चाहिए जिसमें क्रेडेंशियल सेव किया जा सकता है. साथ ही, उस पर अन्य मेटाडेटा के साथ-साथ PendingIntent सेट होना चाहिए.

यहां दिए गए उदाहरण में, इन चरणों को लागू करने का तरीका बताया गया है:

fun processCreateCredentialRequest(
    request: BeginCreateCredentialRequest
): BeginCreateCredentialResponse? {
    when (request) {
        is BeginCreatePublicKeyCredentialRequest -> {
            // Request is passkey type
            return handleCreatePasskeyQuery(request)
        }

        is BeginCreatePasswordCredentialRequest -> {
            // Request is password type
            return handleCreatePasswordQuery(request)
        }
    }
    return null
}

@RequiresApi(VERSION_CODES.M)
private fun handleCreatePasswordQuery(
    request: BeginCreatePasswordCredentialRequest
): BeginCreateCredentialResponse {
    val createEntries: MutableList<CreateEntry> = mutableListOf()

    // Adding two create entries - one for storing credentials to the 'Personal'
    // account, and one for storing them to the 'Family' account. These
    // accounts are local to this sample app only.
    createEntries.add(
        CreateEntry(
            PERSONAL_ACCOUNT_ID,
            createNewPendingIntent(PERSONAL_ACCOUNT_ID, CREATE_PASSWORD_INTENT)
        )
    )
    createEntries.add(
        CreateEntry(
            FAMILY_ACCOUNT_ID,
            createNewPendingIntent(FAMILY_ACCOUNT_ID, CREATE_PASSWORD_INTENT)
        )
    )

    return BeginCreateCredentialResponse(createEntries)
}

पासवर्ड बनाने के अनुरोधों के लिए, एंट्री चुनने की सुविधा को मैनेज करना

जब उपयोगकर्ता किसी पॉप्युलेट किए गए CreateEntry को चुनता है, तो उससे जुड़ा PendingIntent लागू होता है और उससे जुड़ी ऐक्टिविटी सामने आती है. onCreate में पास किए गए असोसिएटेड इंटेंट को ऐक्सेस करें और ProviderCreateCredentialRequest मेथड पाने के लिए, इसे PendingIntentHander क्लास में पास करें.

नीचे दिए गए उदाहरण में, इस प्रोसेस को लागू करने का तरीका बताया गया है. इस कोड को आपकी गतिविधि के onCreate() तरीके से मैनेज करना होगा.

val createRequest = PendingIntentHandler.retrieveProviderCreateCredentialRequest(intent)
val accountId = intent.getStringExtra(CredentialsRepo.EXTRA_KEY_ACCOUNT_ID)

if (createRequest == null) {
    return
}

val request: CreatePasswordRequest = createRequest.callingRequest as CreatePasswordRequest

// Fetch the ID and password from the request and save it in your database
mDatabase.addNewPassword(
    PasswordInfo(
        request.id,
        request.password,
        createRequest.callingAppInfo.packageName
    )
)

// Set the final response back
val result = Intent()
val response = CreatePasswordResponse()
PendingIntentHandler.setCreateCredentialResponse(result, response)
setResult(Activity.RESULT_OK, result)
finish()

उपयोगकर्ता के साइन-इन को मैनेज करना

उपयोगकर्ता के साइन-इन को इस तरीके से मैनेज किया जाता है:

  • जब कोई क्लाइंट ऐप्लिकेशन किसी उपयोगकर्ता को साइन इन कराने की कोशिश करता है, तो वह GetCredentialRequest इंस्टेंस तैयार करता है.
  • Android फ़्रेमवर्क, इस अनुरोध को क्रेडेंशियल उपलब्ध कराने वाली सभी लागू सेवाओं को भेजता है. इसके लिए, वह इन सेवाओं से जुड़ता है.
  • इसके बाद, सेवा देने वाली कंपनी को एक BeginGetCredentialRequest मिलता है. इसमें BeginGetCredentialOption की सूची होती है. हर में ऐसे पैरामीटर होते हैं जिनका इस्तेमाल करके, मिलते-जुलते क्रेडेंशियल वापस पाए जा सकते हैं.

क्रेडेंशियल उपलब्ध कराने वाली सेवा में इस अनुरोध को मैनेज करने के लिए, यह तरीका अपनाएं:

  1. अनुरोध को मैनेज करने के लिए, onBeginGetCredentialRequest() तरीके को बदलें. ध्यान दें कि अगर आपके क्रेडेंशियल लॉक हैं, तो जवाब पर तुरंत AuthenticationAction सेट किया जा सकता है और कॉलबैक को शुरू किया जा सकता है.

    private val unlockEntryTitle = "Authenticate to continue"

override fun onBeginGetCredentialRequest(
    request: BeginGetCredentialRequest,
    cancellationSignal: CancellationSignal,
    callback: OutcomeReceiver<BeginGetCredentialResponse, GetCredentialException>,
) {
    if (isAppLocked()) {
        callback.onResult(
            BeginGetCredentialResponse(
                authenticationActions = mutableListOf(
                    AuthenticationAction(
                        unlockEntryTitle, createUnlockPendingIntent()
                    )
                )
            )
        )
        return
    }
    try {
        response = processGetCredentialRequest(request)
        callback.onResult(response)
    } catch (e: GetCredentialException) {
        callback.onError(GetCredentialUnknownException())
    }
}

    अगर किसी सेवा देने वाली कंपनी को कोई credentialEntries दिखाने से पहले क्रेडेंशियल अनलॉक करने की ज़रूरत पड़ती है, तो उसे एक पेंडिंग इंटेंट सेट अप करना होगा. इससे उपयोगकर्ता को ऐप्लिकेशन के अनलॉक फ़्लो पर ले जाया जाएगा:

    private fun createUnlockPendingIntent(): PendingIntent {
    val intent = Intent(UNLOCK_INTENT).setPackage(PACKAGE_NAME)
    return PendingIntent.getActivity(
        applicationContext, UNIQUE_REQUEST_CODE, intent,
        (
            PendingIntent.FLAG_MUTABLE
                or PendingIntent.FLAG_UPDATE_CURRENT
            )
    )
}

  2. अपने लोकल डेटाबेस से क्रेडेंशियल वापस पाएं और उन्हें CredentialEntries का इस्तेमाल करके सेट अप करें, ताकि वे सिलेक्टर पर दिखें. पासकी के लिए, इंटेंट पर अतिरिक्त के तौर पर credentialId सेट किया जा सकता है. इससे यह पता चलता है कि जब उपयोगकर्ता इस एंट्री को चुनता है, तो यह किस क्रेडेंशियल से मैप होता है.

    companion object {
    // These intent actions are specified for corresponding activities
    // that are to be invoked through the PendingIntent(s)
    private const val GET_PASSKEY_INTENT_ACTION = "PACKAGE_NAME.GET_PASSKEY"
    private const val GET_PASSWORD_INTENT_ACTION = "PACKAGE_NAME.GET_PASSWORD"
}

fun processGetCredentialRequest(
    request: BeginGetCredentialRequest
): BeginGetCredentialResponse {
    val callingPackageInfo = request.callingAppInfo
    val callingPackageName = callingPackageInfo?.packageName.orEmpty()
    val credentialEntries: MutableList<CredentialEntry> = mutableListOf()

    for (option in request.beginGetCredentialOptions) {
        when (option) {
            is BeginGetPasswordOption -> {
                credentialEntries.addAll(
                    populatePasswordData(
                        callingPackageName,
                        option
                    )
                )
            }
            is BeginGetPublicKeyCredentialOption -> {
                credentialEntries.addAll(
                    populatePasskeyData(
                        callingPackageInfo,
                        option
                    )
                )
            } else -> {
                Log.i(TAG, "Request not supported")
            }
        }
    }
    return BeginGetCredentialResponse(credentialEntries)
}

  3. अपने डेटाबेस से क्रेडेंशियल के लिए क्वेरी करें. साथ ही, पासकी और पासवर्ड की एंट्री बनाएं, ताकि उन्हें भरा जा सके.

    private fun populatePasskeyData(
    callingAppInfo: CallingAppInfo?,
    option: BeginGetPublicKeyCredentialOption
): List<CredentialEntry> {
    val passkeyEntries: MutableList<CredentialEntry> = mutableListOf()
    val request = PublicKeyCredentialRequestOptions(option.requestJson)
    // Get your credentials from database where you saved during creation flow
    val creds = getCredentialsFromInternalDb(request.rpId)
    val passkeys = creds.passkeys
    for (passkey in passkeys) {
        val data = Bundle()
        data.putString("credId", passkey.credId)
        passkeyEntries.add(
            PublicKeyCredentialEntry(
                context = applicationContext,
                username = passkey.username,
                pendingIntent = createNewPendingIntent(
                    GET_PASSKEY_INTENT_ACTION,
                    data
                ),
                beginGetPublicKeyCredentialOption = option,
                displayName = passkey.displayName,
                icon = passkey.icon
            )
        )
    }
    return passkeyEntries
}

// Fetch password credentials and create password entries to populate to the user
private fun populatePasswordData(
    callingPackage: String,
    option: BeginGetPasswordOption
): List<CredentialEntry> {
    val passwordEntries: MutableList<CredentialEntry> = mutableListOf()

    // Get your password credentials from database where you saved during
    // creation flow
    val creds = getCredentialsFromInternalDb(callingPackage)
    val passwords = creds.passwords
    for (password in passwords) {
        passwordEntries.add(
            PasswordCredentialEntry(
                context = applicationContext,
                username = password.username,
                pendingIntent = createNewPendingIntent(
                    GET_PASSWORD_INTENT
                ),
                beginGetPasswordOption = option,
                displayName = password.username,
                icon = password.icon
            )
        )
    }
    return passwordEntries
}

private fun createNewPendingIntent(
    action: String,
    extra: Bundle? = null
): PendingIntent {
    val intent = Intent(action).setPackage(PACKAGE_NAME)
    if (extra != null) {
        intent.putExtra("CREDENTIAL_DATA", extra)
    }

    return PendingIntent.getActivity(
        applicationContext, UNIQUE_REQUEST_CODE, intent,
        (PendingIntent.FLAG_MUTABLE or PendingIntent.FLAG_UPDATE_CURRENT)
    )
}

  4. क्रेडेंशियल के लिए क्वेरी करने और उन्हें भरने के बाद, आपको उपयोगकर्ता के चुने गए क्रेडेंशियल के लिए, चुनने के चरण को मैनेज करना होगा. भले ही, वह पासकी हो या पासवर्ड.

पासकी के लिए उपयोगकर्ता के चुने गए विकल्प को मैनेज करना

  1. इससे जुड़ी ऐक्टिविटी के onCreate तरीके में, उससे जुड़े इंटेंट को वापस पाएं और उसे PendingIntentHandler.retrieveProviderGetCredentialRequest() को पास करें.
  2. ऊपर मिले अनुरोध से GetPublicKeyCredentialOption को निकालें. इसके बाद, इस विकल्प से requestJson और clientDataHash को निकालें.
  3. इंटेंट एक्स्ट्रा से credentialId को निकालें. इसे क्रेडेंशियल उपलब्ध कराने वाली सेवा ने तब भरा था, जब उससे जुड़ा PendingIntent सेट अप किया गया था.
  4. ऊपर ऐक्सेस किए गए अनुरोध पैरामीटर का इस्तेमाल करके, अपने लोकल डेटाबेस से पासकी निकालें.

  5. यह पुष्टि करें कि पासकी मान्य है. इसके लिए, मेटाडेटा और उपयोगकर्ता की पुष्टि करें.

    val getRequest = PendingIntentHandler.retrieveProviderGetCredentialRequest(intent)
val publicKeyRequest = getRequest?.credentialOptions?.first() as GetPublicKeyCredentialOption

val requestInfo = intent.getBundleExtra("CREDENTIAL_DATA")
val credIdEnc = requestInfo?.getString("credId").orEmpty()

// Get the saved passkey from your database based on the credential ID from the PublicKeyRequest
val passkey = mDatabase.getPasskey(credIdEnc)

// Decode the credential ID, private key and user ID
val credId = b64Decode(credIdEnc)
val privateKey = b64Decode(passkey.credPrivateKey)
val uid = b64Decode(passkey.uid)

val origin = appInfoToOrigin(getRequest.callingAppInfo)
val packageName = getRequest.callingAppInfo.packageName

validatePasskey(
    publicKeyRequest.requestJson,
    origin,
    packageName,
    uid,
    passkey.username,
    credId,
    privateKey
)

  6. उपयोगकर्ता की पुष्टि करने के लिए, बायोमेट्रिक प्रॉम्प्ट (या पुष्टि करने का कोई अन्य तरीका) दिखाएं. यहां दिए गए कोड स्निपेट में, Android Biometric API का इस्तेमाल किया गया है.

  7. पुष्टि होने के बाद, W3 वेब ऑथेंटिकेशन असर्शन स्पेक के आधार पर JSON रिस्पॉन्स बनाएं. नीचे दिए गए कोड स्निपेट में, AuthenticatorAssertionResponse जैसी हेल्पर डेटा क्लास का इस्तेमाल किया गया है. इनका इस्तेमाल, स्ट्रक्चर्ड पैरामीटर को लेने और उन्हें ज़रूरी JSON फ़ॉर्मैट में बदलने के लिए किया जाता है. जवाब में, WebAuthn क्रेडेंशियल की निजी कुंजी से किया गया डिजिटल हस्ताक्षर शामिल होता है. साइन इन करने से पहले, उपयोगकर्ता की पुष्टि करने के लिए, भरोसा करने वाली पार्टी का सर्वर इस हस्ताक्षर की पुष्टि कर सकता है.

  8. ऊपर जनरेट किए गए JSON का इस्तेमाल करके, PublicKeyCredential बनाएं और इसे फ़ाइनल GetCredentialResponse पर सेट करें. इस गतिविधि के नतीजे के तौर पर, यह आखिरी जवाब सेट करें.

यहां दिए गए उदाहरण में बताया गया है कि इन चरणों को कैसे लागू किया जा सकता है:

val request = PublicKeyCredentialRequestOptions(requestJson)
val privateKey: ECPrivateKey = convertPrivateKey(privateKeyBytes)

val biometricPrompt = BiometricPrompt(
    this,
    { }, // Pass in your own executor
    object : BiometricPrompt.AuthenticationCallback() {
        override fun onAuthenticationError(
            errorCode: Int,
            errString: CharSequence
        ) {
            super.onAuthenticationError(errorCode, errString)
            finish()
        }

        override fun onAuthenticationFailed() {
            super.onAuthenticationFailed()
            finish()
        }

        override fun onAuthenticationSucceeded(
            result: BiometricPrompt.AuthenticationResult
        ) {
            super.onAuthenticationSucceeded(result)
            val response = AuthenticatorAssertionResponse(
                requestOptions = request,
                credentialId = credId,
                origin = origin,
                up = true,
                uv = true,
                be = true,
                bs = true,
                userHandle = uid,
                packageName = packageName
            )

            val sig = Signature.getInstance("SHA256withECDSA")
            sig.initSign(privateKey)
            sig.update(response.dataToSign())
            response.signature = sig.sign()

            val credential = FidoPublicKeyCredential(
                rawId = credId,
                response = response,
                authenticatorAttachment = "", // Add your authenticator attachment
            )
            val result = Intent()
            val passkeyCredential = PublicKeyCredential(credential.json())
            PendingIntentHandler.setGetCredentialResponse(
                result, GetCredentialResponse(passkeyCredential)
            )
            setResult(RESULT_OK, result)
            finish()
        }
    }
)

val promptInfo = BiometricPrompt.PromptInfo.Builder()
    .setTitle("Use your screen lock")
    .setSubtitle("Use passkey for ${request.rpId}")
    .setAllowedAuthenticators(
        BiometricManager.Authenticators.BIOMETRIC_STRONG
        /* or BiometricManager.Authenticators.DEVICE_CREDENTIAL */
    )
    .build()
biometricPrompt.authenticate(promptInfo)

पासवर्ड से पुष्टि करने के लिए, उपयोगकर्ता के चुने गए विकल्प को मैनेज करना

  1. अपनी संबंधित गतिविधि में, onCreate में पास किए गए इंटेंट को ऐक्सेस करें और PendingIntentHandler का इस्तेमाल करके ProviderGetCredentialRequest को निकालें.

  2. इनकमिंग पैकेज के नाम के लिए पासवर्ड क्रेडेंशियल वापस पाने के अनुरोध में, GetPasswordOption का इस्तेमाल करें.

    val getRequest = PendingIntentHandler.retrieveProviderGetCredentialRequest(intent)

val passwordOption = getRequest?.credentialOptions?.first() as GetPasswordOption

val username = passwordOption.allowedUserIds.first()
// Fetch the credentials for the calling app package name
val creds = mDatabase.getCredentials(callingAppInfo.packageName)
val passwords = creds.passwords
val it = passwords.iterator()
var password = ""
while (it.hasNext()) {
    val passwordItemCurrent = it.next()
    if (passwordItemCurrent.username == username) {
        password = passwordItemCurrent.password
        break
    }
}

  3. क्रेडेंशियल वापस पाने के बाद, चुने गए पासवर्ड क्रेडेंशियल के लिए जवाब सेट करें.

    // Set the response back
val result = Intent()
val passwordCredential = PasswordCredential(username, password)
PendingIntentHandler.setGetCredentialResponse(
    result, GetCredentialResponse(passwordCredential)
)
setResult(Activity.RESULT_OK, result)
finish()

पुष्टि करने की कार्रवाई की एंट्री चुनने की प्रोसेस को मैनेज करना

जैसा कि पहले बताया गया है, क्रेडेंशियल लॉक होने पर, क्रेडेंशियल उपलब्ध कराने वाली सेवा AuthenticationAction सेट कर सकती है. अगर उपयोगकर्ता इस एंट्री को चुनता है, तो PendingIntent में सेट किए गए इंटेंट कार्रवाई से जुड़ी ऐक्टिविटी को शुरू किया जाता है. इसके बाद, क्रेडेंशियल प्रोवाइडर, क्रेडेंशियल अनलॉक करने के लिए बायोमेट्रिक ऑथेंटिकेशन फ़्लो या इससे मिलता-जुलता तरीका दिखा सकते हैं. क्रेडेंशियल अनलॉक होने के बाद, क्रेडेंशियल प्रोवाइडर को BeginGetCredentialResponse बनाना होगा. यह प्रोसेस, उपयोगकर्ता के साइन-इन को मैनेज करने के तरीके से मिलती-जुलती है, जिसके बारे में ऊपर बताया गया है. इसके बाद, इस रिस्पॉन्स को PendingIntentHandler.setBeginGetCredentialResponse() तरीके से सेट करना होगा. इसके बाद ही, तैयार किए गए इंटेंट को नतीजे के तौर पर सेट किया जा सकता है और ऐक्टिविटी को पूरा किया जा सकता है.

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

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

override fun onClearCredentialStateRequest(
    request: ProviderClearCredentialStateRequest,
    cancellationSignal: CancellationSignal,
    callback: OutcomeReceiver<Void?, ClearCredentialException>
) {
    // Delete any maintained state as appropriate.
}

उपयोगकर्ताओं को पासवर्ड, पासकी, और जानकारी अपने-आप भरने की सुविधा वाली स्क्रीन से, क्रेडेंशियल की सेवा देने वाली कंपनी की सेटिंग खोलने की अनुमति देने के लिए, क्रेडेंशियल की सेवा देने वाले ऐप्लिकेशन को res/xml/provider.xml में credential-provider settingsActivity मेनिफ़ेस्ट एट्रिब्यूट लागू करना चाहिए. इस एट्रिब्यूट की मदद से, इंटेंट का इस्तेमाल करके अपने ऐप्लिकेशन की सेटिंग स्क्रीन खोली जा सकती है. ऐसा तब होता है, जब कोई उपयोगकर्ता पासवर्ड, पासकी, और ऑटोमैटिक भरने की सुविधा की सूची में मौजूद किसी सेवा देने वाली कंपनी के नाम पर क्लिक करता है. इस एट्रिब्यूट की वैल्यू को उस गतिविधि के नाम पर सेट करें जिसे सेटिंग स्क्रीन से लॉन्च करना है.

<credential-provider
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:settingsSubtitle="Example settings provider name"
    android:settingsActivity="com.example.SettingsActivity">
    <capabilities>
        <capability name="android.credentials.TYPE_PUBLIC_KEY_CREDENTIAL" />
    </capabilities>
</credential-provider>
'बदलें' और 'खोलें' बटन के फ़ंक्शन दिखाने वाला डायग्राम
पहली इमेज: बदलें बटन पर क्लिक करने से, क्रेडेंशियल मैनेजर चुनने वाला डायलॉग बॉक्स खुलता है. इससे उपयोगकर्ता, क्रेडेंशियल मैनेजर की सेवा देने वाली अपनी पसंदीदा कंपनी को चुन सकता है. खोलें बटन, मेनिफ़ेस्ट में किए गए बदलाव में तय की गई सेटिंग गतिविधि को लॉन्च करता है. साथ ही, यह उस सेवा देने वाली कंपनी के लिए खास तौर पर सेटिंग पेज खोलता है.

सेटिंग इंटेंट

सेटिंग खोलें: android.settings.CREDENTIAL_PROVIDER इंटेंट, सेटिंग की स्क्रीन दिखाता है. यहां उपयोगकर्ता, क्रेडेंशियल देने वाली अपनी पसंदीदा और अन्य सेवाओं को चुन सकता है.

पासवर्ड, पासकी, और जानकारी अपने-आप भरने की सुविधा वाली सेटिंग स्क्रीन
दूसरी इमेज: पासवर्ड, पासकी, और जानकारी अपने-आप भरने की सुविधा की सेटिंग वाली स्क्रीन.

पसंदीदा क्रेडेंशियल सेवा: ACTION_REQUEST_SET_AUTOFILL_SERVICE इंटेंट, आपके उपयोगकर्ता को पसंदीदा सेवा देने वाली कंपनी को चुनने की स्क्रीन पर रीडायरेक्ट करता है. इस स्क्रीन पर चुनी गई सेवा, क्रेडेंशियल और ऑटोमैटिक तरीके से जानकारी भरने की सुविधा देने वाली पसंदीदा सेवा बन जाती है.

'बदलें' और 'खोलें' बटन के फ़ंक्शन दिखाने वाला डायग्राम
तीसरी इमेज: पासवर्ड, पासकी, और ऑटोमैटिक तरीके से जानकारी भरने की सुविधा के लिए सेवा देने वाली पसंदीदा कंपनी की सेटिंग स्क्रीन.

खास ऐप्लिकेशन की अनुमति वाली सूची पाना

वेब ब्राउज़र जैसे खास ऐप्लिकेशन, Credential Manager GetCredentialRequest() और CreatePublicKeyCredentialRequest() तरीकों में origin पैरामीटर सेट करके, अन्य भरोसेमंद पक्षों की ओर से Credential Manager को कॉल करते हैं. इन अनुरोधों को प्रोसेस करने के लिए, क्रेडेंशियल की सेवा देने वाली कंपनी, getOrigin() एपीआई का इस्तेमाल करके origin को वापस लाती है.

origin को वापस पाने के लिए, क्रेडेंशियल उपलब्ध कराने वाले ऐप्लिकेशन को androidx.credentials.provider.CallingAppInfo's getOrigin() एपीआई को खास और भरोसेमंद कॉलर की सूची देनी होगी. अनुमति वाली यह सूची, एक मान्य JSON ऑब्जेक्ट होनी चाहिए. origin तब दिखता है, जब packageName और signingInfo से मिले सर्टिफ़िकेट फ़िंगरप्रिंट, getOrigin() एपीआई को पास किए गए privilegedAllowlist में मौजूद ऐप्लिकेशन के फ़िंगरप्रिंट से मैच करते हैं. origin वैल्यू मिलने के बाद, सेवा देने वाले ऐप्लिकेशन को इसे एक खास कॉल मानना चाहिए. साथ ही, कॉलिंग ऐप्लिकेशन के सिग्नेचर का इस्तेमाल करके origin की गिनती करने के बजाय, AuthenticatorResponse में origin को क्लाइंट डेटा पर सेट करना चाहिए.

अगर आपको origin वापस पाना है, तो सीधे CreatePublicKeyCredentialRequest() या GetPublicKeyCredentialOption() में दिए गए clientDataHash का इस्तेमाल करें. हस्ताक्षर के अनुरोध के दौरान, clientDataJSON को असेंबल और हैश न करें. JSON पार्स करने से जुड़ी समस्याओं से बचने के लिए, अटेस्टेशन और असर्शन के जवाब में clientDataJSON के लिए प्लेसहोल्डर वैल्यू सेट करें. Google Password Manager, getOrigin() को कॉल करने के लिए, सार्वजनिक तौर पर उपलब्ध अनुमति वाली सूची का इस्तेमाल करता है. क्रेडेंशियल प्रोवाइडर के तौर पर, इस सूची का इस्तेमाल किया जा सकता है. इसके अलावा, एपीआई में बताए गए JSON फ़ॉर्मैट में अपनी सूची भी दी जा सकती है. यह सेवा देने वाली कंपनी पर निर्भर करता है कि वह किस सूची का इस्तेमाल करे. क्रेडेंशियल उपलब्ध कराने वाली तीसरे पक्ष की कंपनियों के साथ खास ऐक्सेस पाने के लिए, तीसरे पक्ष के दस्तावेज़ देखें.

किसी डिवाइस पर प्रोवाइडर चालू करना

उपयोगकर्ताओं को डिवाइस की सेटिंग > पासवर्ड और खाते > सेवा देने वाली कंपनी > चालू या बंद करें पर जाकर, सेवा देने वाली कंपनी को चालू करना होगा.

fun createSettingsPendingIntent(): PendingIntent