পরিচয়পত্র স্থানান্তর

ক্রেডেনশিয়াল ম্যানেজারের ক্রেডেনশিয়াল ট্রান্সফার এপিআইগুলো ক্রেডেনশিয়াল প্রোভাইডারদের মধ্যে একই ডিভাইসে ব্যবহারকারীর ক্রেডেনশিয়ালের নিরাপদ স্থানান্তর সক্ষম করে। এই নির্দেশিকাটিতে বিস্তারিতভাবে বর্ণনা করা হয়েছে যে, অ্যান্ড্রয়েডের ক্রেডেনশিয়াল প্রোভাইডাররা কীভাবে androidx.credentials:providerevents লাইব্রেরি দ্বারা প্রদত্ত এপিআইগুলোর সাথে ইন্টিগ্রেট করতে পারে। এই ফিচারটি প্রমিত FIDO ক্রেডেনশিয়াল এক্সচেঞ্জ ফরম্যাট (CXF) ব্যবহার করে পাসওয়ার্ড, পাসকি, ঠিকানার তথ্য এবং কাস্টম ফিল্ড সমর্থন করে।

মূল ধারণা

ক্রেডেনশিয়াল ট্রান্সফার ফ্রেমওয়ার্কটি অ্যান্ড্রয়েড ওএস বা প্রমাণীকরণবিহীন অ্যাপের কাছে সরাসরি ক্রেডেনশিয়াল প্রকাশ না করেই একই ডিভাইসে পিয়ার-টু-পিয়ার ক্রেডেনশিয়াল স্থানান্তর সহজ করে।

এই কাঠামোটি দুটি প্রধান ভূমিকা নির্ধারণ করে:

  • এক্সপোর্টার (সোর্স প্রোভাইডার): একজন ক্রেডেনশিয়াল প্রোভাইডার যিনি বর্তমানে ব্যবহারকারীর ক্রেডেনশিয়াল ধারণ করেন। এটি সিস্টেমে উপলব্ধ রপ্তানিযোগ্য অ্যাকাউন্ট ( ExportEntry ) সম্পর্কিত মেটাডেটা পূর্ব-নিবন্ধন করে এবং ব্যবহারকারী কর্তৃক নির্বাচিত হলে স্থানান্তর অনুরোধে সাড়া দেয়।
  • ইমপোর্টার (ক্লায়েন্ট প্রোভাইডার বা সেটআপ উইজার্ড): একটি ক্রেডেনশিয়াল প্রোভাইডার বা সেটআপ উইজার্ড যা কোন ধরনের ক্রেডেনশিয়াল এবং এক্সটেনশন গ্রহণ করতে পারবে তা নির্দিষ্ট করে একটি ইমপোর্ট অনুরোধ ( ImportCredentialsRequest ) শুরু করে।

অ্যান্ড্রয়েড সংস্করণ সামঞ্জস্যতা

ক্রেডেনশিয়াল ট্রান্সফার এপিআইটি অ্যান্ড্রয়েড ৮ (এপিআই লেভেল ২৬) এবং এর পরবর্তী সংস্করণের ডিভাইসগুলোতে কাজ করে।

নির্ভরতা যোগ করুন

আপনার মডিউলের build.gradle অথবা build.gradle.kts ফাইলে androidx.credentials:providerevents ডিপেন্ডেন্সিটি যোগ করুন:

dependencies {
    implementation("androidx.credentials:providerevents:1.0.0-alpha06")
}

প্রয়োজনীয় ক্লাসটি ইনস্ট্যানশিয়েট করুন

প্রয়োজনীয় ProviderEventsManager এর একটি ইনস্ট্যান্স তৈরি করুন।

val providerEventsManager = ProviderEventsManager.create(context)

রপ্তানিকারক বাস্তবায়ন করুন

ব্যবহারকারীদের আপনার অ্যাপ থেকে ডিভাইসের অন্যান্য ক্রেডেনশিয়াল প্রোভাইডারদের কাছে ক্রেডেনশিয়াল এক্সপোর্ট করার অনুমতি দিতে, এক্সপোর্টার রোলটি ইমপ্লিমেন্ট করুন।

রপ্তানি এন্ট্রি নিবন্ধন করুন

যখন আপনার ক্রেডেনশিয়াল প্রোভাইডার পরিবর্তিত হয় (উদাহরণস্বরূপ, কোনো ব্যবহারকারী সাইন ইন করলে, ক্রেডেনশিয়াল যোগ করলে, বা অ্যাকাউন্ট পরিবর্তন করলে), তখন ProviderEventsManager.registerExport() ব্যবহার করে আপনার ExportEntry আইটেমগুলো রেজিস্টার বা আপডেট করুন।

প্রতিটি ExportEntry জন্য প্রয়োজন:

  • id : একটি গোপন, দৈবচয়নে তৈরি স্ট্রিং শনাক্তকারী যা এই রপ্তানি এন্ট্রিটিকে অনন্যভাবে উপস্থাপন করে। আপনাকে অবশ্যই এই আইডিটি নিরাপদে সংরক্ষণ করতে হবে ; পরবর্তীতে আগত স্থানান্তর অনুরোধ যাচাই করার জন্য আপনার এটি প্রয়োজন হবে।
  • accountDisplayName : ঐচ্ছিক অ্যাকাউন্ট লেবেল (উদাহরণস্বরূপ, "Personal Account" )।
  • userDisplayName : ব্যবহারকারীর প্রাথমিক শনাক্তকারী (উদাহরণস্বরূপ, "alice@example.com" )।
  • icon : প্রদানকারী বা অ্যাকাউন্টের প্রতিনিধিত্বকারী একটি Bitmap আইকন (লাইব্রেরি দ্বারা স্বয়ংক্রিয়ভাবে ৩২x৩২ পিএনজি আকারে স্কেল করা)।
  • supportedCredentialTypes : CredentialTypes থেকে নেওয়া স্ট্রিং কনস্ট্যান্টের একটি সেট, যা এই এন্ট্রিতে কোন কোন ধরনের ডেটা টাইপ রয়েছে তা নির্দেশ করে।

suspend fun registerMyProviderForExport(
    providerEventsManager: ProviderEventsManager,
    providerIcon: Bitmap,
    // Randomly generated and stored in encrypted storage
    secretEntryId: String
) {
    val entry = ExportEntry(
        id = secretEntryId,
        accountDisplayName = "MyProvider Personal",
        userDisplayName = "alice@example.com",
        icon = providerIcon,
        supportedCredentialTypes = setOf(
            CredentialTypes.CREDENTIAL_TYPE_BASIC_AUTH, // Passwords
            CredentialTypes.CREDENTIAL_TYPE_PUBLIC_KEY, // Passkeys
            CredentialTypes.CREDENTIAL_TYPE_ADDRESS,
            CredentialTypes.CREDENTIAL_TYPE_CREDIT_CARD
        )
    )

    // RegisterExportRequest.create() attaches the default WASM matcher from assets
    val request = RegisterExportRequest.create(context, listOf(entry))

    try {
        val response = providerEventsManager.registerExport(request)
        // Registration successful
    } catch (e: Exception) {
        // Handle registration exceptions (e.g., RegisterExportProviderConfigurationException)
    }
}

ম্যানিফেস্ট ফাইলে এক্সপোর্টার অ্যাক্টিভিটি ঘোষণা করুন

যখন ব্যবহারকারী সিস্টেম সিলেক্টর UI-তে আপনার ExportEntry নির্বাচন করেন, তখন সিস্টেম আপনার নির্ধারিত হ্যান্ডলিং Activity চালু করে। এই অ্যাক্টিভিটিটি বাধ্যতামূলক ইন্টেন্ট অ্যাকশন এবং কন্টেন্ট URI স্কিম সহ ঘোষণা করুন:

<activity
    android:name="com.example.CredentialExportActivity"
    android:exported="true"
    android:label="@string/export_activity_label">
    <intent-filter>
        // This intent action is required for Credential Manager to invoke this activity
        <action android:name="androidx.identitycredentials.action.IMPORT_CREDENTIALS" />
        <category android:name="android.intent.category.DEFAULT" />
        <data android:scheme="content" />
    </intent-filter>
</activity>

আপনার অ্যাক্টিভিটিতে ট্রান্সফার ইনটেন্টটি পরিচালনা করুন।

আপনার CredentialExportActivity তে, অনুরোধটি পার্স করতে, কলিং অ্যাপ এবং credId যাচাই করতে, প্রয়োজনীয় বায়োমেট্রিক প্রমাণীকরণ সম্পন্ন করতে, এবং FIDO CXF পেলোডটি প্রদত্ত কন্টেন্ট URI-তে ফেরত লিখতে IntentHandler.retrieveProviderImportCredentialsRequest(intent) ব্যবহার করুন।

class CredentialExportActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // 1. Extract the transfer request from the incoming Intent
        val request: ProviderImportCredentialsRequest? =
            IntentHandler.retrieveProviderImportCredentialsRequest(intent)

        if (request == null) {
            finishWithError()
            return
        }

        // 2. Validate CallingAppInfo and secret `credId`
        val callingAppPackage = request.callingAppInfo.packageName
        val receivedCredId = request.credId
        if (!verifySecretEntryId(receivedCredId) || !isTrustedImporter(callingAppPackage)) {
            // Secret ID mismatch or untrusted caller -> abort
            sendExceptionAndFinish(ImportCredentialsNoExportOptionException("Unauthorized request"))
            return
        }

        // 3. Optional: Prompt user for Biometric / PIN authentication before exporting
        authenticateUserThenExport(request)
    }

    private fun authenticateUserThenExport(request: ProviderImportCredentialsRequest) {
        // ... Biometric prompt logic ...
        // Once authenticated, generate the FIDO CXF JSON string matching the requested types
        val cxfJsonPayload = buildFidoCxfJsonPayload(
            requestedTypes = request.request.credentialTypes,
            requestedExtensions = request.request.knownExtensions
        )

        val response = ImportCredentialsResponse(cxfJsonPayload)

        // 4. Write the JSON payload to the Content URI and set Activity result
        IntentHandler.setImportCredentialsResponse(
            context = this,
            uri = request.uri,
            intent = intent,
            response = response
        )
        setResult(Activity.RESULT_OK, intent)
        finish()
    }

    private fun sendExceptionAndFinish(exception: androidx.credentials.providerevents.exception.ImportCredentialsException) {
        IntentHandler.setImportCredentialsException(intent, exception)
        setResult(Activity.RESULT_OK, intent)
        finish()
    }

    private fun verifySecretEntryId(credentialId: String): Boolean {
        // Check if credentialId matches what you stored when calling RegisterExportRequest
        return credentialId == getStoredSecretEntryId()
    }

    private fun isTrustedImporter(packageName: String): Boolean {
        // Implement any specific allowlisting / caller checks if required
        return true
    }

    private fun finishWithError() {
        setResult(Activity.RESULT_CANCELED)
        finish()
    }
}

রপ্তানি নিবন্ধন এবং ক্লিয়ারিং ব্যতিক্রম

এই মডিউলের সমস্ত এক্সেপশন হলো ImportCredentialsException , RegisterExportException বা ClearExportException এর সাবক্লাস।

  • RegisterExportProviderConfigurationException বা ClearExportProviderConfigurationException : প্রোভাইডার সেটআপ সংক্রান্ত সমস্যার কারণে রেজিস্ট্রেশন বা ক্লিয়ারিং ব্যর্থ হলে এই ব্যতিক্রমটি থ্রো করা হয় (উদাহরণস্বরূপ, ExportEntry তে supportedCredentialTypes খালি থাকা, অথবা কোনো অসমর্থিত OS টিয়ারে কল করা)।
  • RegisterExportUnknownErrorException বা ClearExportUnknownErrorException : এক্সপোর্ট রেজিস্ট্রি আপডেট করার সময় একটি অশ্রেণীবদ্ধ সিস্টেম বা স্টোরেজ ত্রুটি ঘটেছে।

ইম্পোর্টারটি বাস্তবায়ন করুন

আপনার অ্যাপে ক্রেডেনশিয়াল ইম্পোর্ট করতে (উদাহরণস্বরূপ, অনবোর্ডিং বা প্রোভাইডার ইম্পোর্টের সময়), ইম্পোর্টার রোলটি ইমপ্লিমেন্ট করুন এবং ProviderEventsManager .importCredentials() কল করে ফ্লোটি শুরু করুন।

আমদানি অনুরোধ তৈরি করুন এবং প্রবাহ চালু করুন

আপনার ইম্পোর্টার কোন কোন CredentialTypes এবং KnownExtensions সমর্থন করে তা নির্দিষ্ট করুন:

suspend fun startCredentialImport(
    activityContext: Context,
    providerEventsManager: ProviderEventsManager
) {
    val importRequest = ImportCredentialsRequest(
        credentialTypes = setOf(
            CredentialTypes.CREDENTIAL_TYPE_BASIC_AUTH,
            CredentialTypes.CREDENTIAL_TYPE_PUBLIC_KEY,
            CredentialTypes.CREDENTIAL_TYPE_ADDRESS,
            CredentialTypes.CREDENTIAL_TYPE_NOTE
        ),
        knownExtensions = setOf(
            KnownExtensions.KNOWN_EXTENSION_SHARED
        )
    )

    try {
        // Launches the system Selector UI; suspends until user selects a provider and completes transfer
        val response = providerEventsManager.importCredentials(activityContext, importRequest)

        // 1. Inspect the source exporter's package info
        val exporterPackageName = response.callingAppInfo.packageName

        // 2. Parse the FIDO CXF JSON string
        val cxfJsonString = response.response.responseJson
        parseAndSaveImportedCredentials(cxfJsonString)
    } catch (e: ImportCredentialsException) {
        // Handle specific import exceptions (e.g., ImportCredentialsCancellationException)
        handleImportFailure(e)
    }
}

private fun parseAndSaveImportedCredentials(cxfJsonString: String) {
    val rootJson = JSONObject(cxfJsonString)
    // Parse according to FIDO Credential Exchange Format (CXF v1.0) specification:
    // https://fidoalliance.org/specs/cx/cxf-v1.0-ps-20250814.html
}

// Helper function to make it compile
private fun handleImportFailure(e: ImportCredentialsException) {}

আমদানি প্রবাহের ব্যতিক্রম

এই মডিউলের সমস্ত এক্সেপশন হলো ImportCredentialsException , RegisterExportException বা ClearExportException এর সাবক্লাস।

  • ImportCredentialsCancellationException : ব্যবহারকারী সিলেক্টর UI খারিজ করেছেন অথবা এক্সপোর্ট অ্যাক্টিভিটি বাতিল করেছেন ( Activity.RESULT_CANCELED )।
  • ImportCredentialsNoExportOptionException : অনুরোধকৃত ক্রেডেনশিয়াল প্রকারের সাথে কোনো নিবন্ধিত রপ্তানি এন্ট্রি মেলেনি, অথবা নির্বাচিত রপ্তানিকারক একটি প্রত্যাখ্যান ব্যতিক্রম দেখিয়েছে।
  • ImportCredentialsProviderConfigurationException : কনফিগারেশন ত্রুটি (উদাহরণস্বরূপ, ImportCredentialsRequest এ খালি credentialTypes সেট করা অথবা অনুমতির অভাব)।
  • ImportCredentialsInvalidJsonException : রপ্তানিকারক একটি ত্রুটিপূর্ণ বা খালি JSON পেলোড ফেরত দিয়েছে যা অনুরোধ যাচাইকরণে ব্যর্থ হয়েছে।
  • ImportCredentialsSystemErrorException : ইম্পোর্ট করার সময় অভ্যন্তরীণ অ্যান্ড্রয়েড সিস্টেম বা বাইন্ডার স্থানান্তরে ত্রুটি ঘটেছে।
  • ImportCredentialsUnknownCallerException : ফ্রেমওয়ার্ক কর্তৃক কলিং অ্যাপটি যাচাই করা সম্ভব হয়নি।
  • ImportCredentialsUnknownErrorException : ইম্পোর্ট প্রক্রিয়া চলাকালীন অশ্রেণীবদ্ধ বা অপ্রত্যাশিত ত্রুটি।

সমর্থিত শংসাপত্রের প্রকার এবং এক্সটেনশন

androidx.credentials.providerevents.transfer.CredentialTypes অবজেক্টটি FIDO CXF আইটেম টাইপগুলোর সাথে সঙ্গতিপূর্ণ প্রমিত স্ট্রিং কনস্ট্যান্টগুলো সংজ্ঞায়িত করে:

ধ্রুবক মান ( cxf টাইপ) বর্ণনা
CREDENTIAL_TYPE_BASIC_AUTH "basic-auth" ব্যবহারকারীর নাম এবং পাসওয়ার্ড দিয়ে লগইন করার তথ্য।
CREDENTIAL_TYPE_PUBLIC_KEY "passkey" FIDO2 বা WebAuthn পাসকি পাবলিক কী ক্রেডেনশিয়াল।
CREDENTIAL_TYPE_ADDRESS "address" ফর্ম স্বয়ংক্রিয়ভাবে পূরণের জন্য ডাক বা শিপিং ঠিকানার তথ্য।
CREDENTIAL_TYPE_API_KEY "api-key" এপিআই অ্যাক্সেস কী এবং টোকেন।
CREDENTIAL_TYPE_CREDIT_CARD "credit-card" ক্রেডিট ও ডেবিট কার্ডে অর্থপ্রদানের তথ্য।
CREDENTIAL_TYPE_CUSTOM_FIELDS "custom-fields" কাস্টম গ্রুপিং বা ব্যবহারকারী-সংজ্ঞায়িত ফিল্ড।
CREDENTIAL_TYPE_DRIVERS_LICENSE "drivers-license" ড্রাইভিং লাইসেন্সের বিবরণ।
CREDENTIAL_TYPE_FILE "file" বাইনারি ফাইলের জন্য মেটাডেটা এবং প্লেসহোল্ডার রেফারেন্স।
CREDENTIAL_TYPE_GENERATED_PASSWORD "generated-password" মেশিন দ্বারা তৈরি সুরক্ষিত পাসওয়ার্ড।
CREDENTIAL_TYPE_IDENTITY_DOCUMENT "identity-document" জাতীয় পরিচয়পত্র, এসএসএন, টিআইএন, বা পাসপোর্ট রেফারেন্স।
CREDENTIAL_TYPE_ITEM_REFERENCE "item-reference" পেলোডের অন্য কোনো আইটেমের দিকে নির্দেশকারী যৌক্তিক লিঙ্ক।
CREDENTIAL_TYPE_NOTE "note" ব্যবহারকারী-সংজ্ঞায়িত সুরক্ষিত নোট (UTF-8 স্ট্রিং)।
CREDENTIAL_TYPE_PASSPORT "passport" পাসপোর্ট ভ্রমণ নথির বিবরণ।
CREDENTIAL_TYPE_PERSON_NAME "person-name" ব্যক্তির পরিচয় ও নামকরণের বিবরণ।
CREDENTIAL_TYPE_SSH_KEY "ssh-key" SSH পাবলিক ও প্রাইভেট কী জোড়া।
CREDENTIAL_TYPE_TOTP "totp" সময়-ভিত্তিক এককালীন পাসওয়ার্ড (2FA) গোপনীয়তা।
CREDENTIAL_TYPE_WIFI "wifi" ওয়াই-ফাই নেটওয়ার্কের এসএসআইডি এবং পাসফ্রেজ।

কাস্টম WASM (ওয়েবঅ্যাসেম্বলি) ম্যাচিং (উন্নত)

ডিফল্টরূপে, RegisterExportRequest.create(context, entries) কল করলে লাইব্রেরি অ্যাসেটস থেকে সিস্টেম-ডিফল্ট credential_transfer_matcher.wasm বান্ডল করা হয়, যা শুধুমাত্র supportedCredentialTypes এর ইন্টারসেকশনের উপর ভিত্তি করে এন্ট্রিগুলো ফিল্টার করে।

যদি আপনার ক্রেডেনশিয়াল প্রোভাইডারের জটিল ম্যাচিং লজিকের প্রয়োজন হয় (উদাহরণস্বরূপ, ডায়নামিক ক্যাপাবিলিটি চেক বা কাস্টম ফিল্ডের উপর ভিত্তি করে শর্তসাপেক্ষ ফিল্টারিং), তাহলে আপনি WASM ক্রেডেনশিয়াল ট্রান্সফার API-এর সাথে মিলিয়ে আপনার নিজস্ব WebAssembly মডিউল কম্পাইল করতে পারেন এবং সরাসরি র বাইট অ্যারেটি পাস করতে পারেন:

// Loading a custom WASM matcher
val customMatcherBytes = context.assets.open("my_custom_matcher.wasm").use { it.readBytes() }
val customRequest = RegisterExportRequest(
    entries = myEntries,
    exportMatcher = customMatcherBytes
)
providerEventsManager.registerExport(customRequest)