আপনার শংসাপত্র প্রদানকারী সমাধানের সাথে ক্রেডেনশিয়াল ম্যানেজারকে একীভূত করুন

ক্রেডেনশিয়াল ম্যানেজার বলতে অ্যান্ড্রয়েড ১৪-তে চালু করা API-এর একটি সেট বোঝায় যা ব্যবহারকারীর নাম-পাসওয়ার্ড, পাসকি এবং ফেডারেটেড সাইন-ইন সমাধান (যেমন গুগলের সাথে সাইন-ইন) এর মতো একাধিক সাইন-ইন পদ্ধতি সমর্থন করে। যখন ক্রেডেনশিয়াল ম্যানেজার API চালু করা হয়, তখন অ্যান্ড্রয়েড সিস্টেম ডিভাইসে ইনস্টল করা সমস্ত ক্রেডেনশিয়াল প্রদানকারীর কাছ থেকে ক্রেডেনশিয়াল একত্রিত করে। এই ডকুমেন্টটি API-এর সেট বর্ণনা করে যা এই ক্রেডেনশিয়াল প্রদানকারীদের জন্য ইন্টিগ্রেশন এন্ডপয়েন্ট প্রদান করে।

সেটআপ

আপনার শংসাপত্র প্রদানকারীতে কার্যকারিতা বাস্তবায়নের আগে, নিম্নলিখিত বিভাগগুলিতে দেখানো সেটআপ পদক্ষেপগুলি সম্পূর্ণ করুন।

নির্ভরতা ঘোষণা করুন

ক্রেডেনশিয়াল ম্যানেজার লাইব্রেরির সর্বশেষ সংস্করণ ব্যবহার করতে, আপনার অ্যাপ মডিউলের বিল্ড স্ক্রিপ্টে নিম্নলিখিত নির্ভরতাগুলি যোগ করুন:

dependencies {
    implementation("androidx.credentials:credentials:1.6.0-beta03")
}

dependencies {
    implementation "androidx.credentials:credentials:1.6.0-beta03"
}

ম্যানিফেস্ট ফাইলে পরিষেবা উপাদান ঘোষণা করুন

আপনার অ্যাপের ম্যানিফেস্ট ফাইল AndroidManifest.xml এ, androidx.credentials লাইব্রেরি থেকে CredentialProviderService ক্লাস প্রসারিত করে এমন একটি পরিষেবা ক্লাসের জন্য একটি <service> ঘোষণা অন্তর্ভুক্ত করুন, যেমনটি নিম্নলিখিত উদাহরণে দেখানো হয়েছে।

<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>

পূর্ববর্তী উদাহরণে দেখানো অনুমতি এবং ইন্টেন্ট ফিল্টারটি ক্রেডেনশিয়াল ম্যানেজার ফ্লোকে প্রত্যাশা অনুযায়ী কাজ করার জন্য অবিচ্ছেদ্য। অনুমতিটি প্রয়োজন যাতে শুধুমাত্র অ্যান্ড্রয়েড সিস্টেম এই পরিষেবার সাথে সংযুক্ত হতে পারে। ক্রেডেনশিয়াল ম্যানেজার দ্বারা ব্যবহারের জন্য ক্রেডেনশিয়াল সরবরাহকারী হিসাবে এই পরিষেবাটি আবিষ্কারের জন্য ইন্টেন্ট ফিল্টারটি ব্যবহার করা হয়।

সমর্থিত শংসাপত্রের প্রকারগুলি ঘোষণা করুন

আপনার 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>

পূর্ববর্তী API স্তরগুলিতে, শংসাপত্র সরবরাহকারীরা পাসওয়ার্ড এবং অন্যান্য ডেটার জন্য অটোফিলের মতো API-এর সাথে একীভূত হয়। এই সরবরাহকারীরা বিদ্যমান শংসাপত্রের ধরণগুলি সংরক্ষণ করতে একই অভ্যন্তরীণ অবকাঠামো ব্যবহার করতে পারে, একই সাথে পাসকি সহ অন্যান্যগুলিকে সমর্থন করার জন্য এটি প্রসারিত করতে পারে।

সরবরাহকারীর মিথস্ক্রিয়ার জন্য দ্বি-পর্যায়ের পদ্ধতি

ক্রেডেনশিয়াল ম্যানেজার দুটি পর্যায়ে ক্রেডেনশিয়াল প্রদানকারীদের সাথে যোগাযোগ করে:

1. প্রথম ধাপ হল begin/query ধাপ যেখানে সিস্টেমটি ক্রেডেনশিয়াল প্রোভাইডার পরিষেবার সাথে আবদ্ধ হয় এবং onBeginGetCredentialRequest() , onBeginCreateCredentialRequest() , অথবা onClearCredentialStateRequest() পদ্ধতিগুলিকে Begin… অনুরোধের মাধ্যমে ব্যবহার করে। প্রোভাইডারদের এই অনুরোধগুলি প্রক্রিয়া করতে হবে এবং Begin… প্রতিক্রিয়া দিয়ে প্রতিক্রিয়া জানাতে হবে, অ্যাকাউন্ট নির্বাচকের উপর দেখানো ভিজ্যুয়াল বিকল্পগুলি উপস্থাপন করে এমন এন্ট্রিগুলি দিয়ে সেগুলিকে পূর্ণ করতে হবে। প্রতিটি এন্ট্রিতে একটি PendingIntent সেট থাকতে হবে।
2. ব্যবহারকারী একবার একটি এন্ট্রি নির্বাচন করলে, নির্বাচন পর্ব শুরু হয় এবং এন্ট্রির সাথে যুক্ত PendingIntent বন্ধ হয়ে যায়, যা সংশ্লিষ্ট প্রদানকারীর কার্যকলাপকে সামনে আনে। ব্যবহারকারীর এই কার্যকলাপটির সাথে ইন্টারঅ্যাক্ট করা শেষ হয়ে গেলে, ক্রেডেনশিয়াল প্রদানকারীকে কার্যকলাপটি শেষ করার আগে ফলাফলের প্রতিক্রিয়া সেট করতে হবে। এই প্রতিক্রিয়াটি ক্লায়েন্ট অ্যাপে পাঠানো হয় যা ক্রেডেনশিয়াল ম্যানেজারকে আহ্বান করেছিল।

পাসকি তৈরির কাজ পরিচালনা করুন

পাসকি তৈরির জন্য কোয়েরিগুলি পরিচালনা করুন

যখন কোন ক্লায়েন্ট অ্যাপ একটি পাসকি তৈরি করতে এবং এটি একটি ক্রেডেনশিয়াল প্রোভাইডারের সাথে সংরক্ষণ করতে চায়, তখন তারা createCredential API কল করে। আপনার ক্রেডেনশিয়াল প্রোভাইডার পরিষেবাতে এই অনুরোধটি পরিচালনা করতে যাতে পাসকিটি আসলে আপনার স্টোরেজে সংরক্ষণ করা হয়, নিম্নলিখিত বিভাগগুলিতে দেখানো পদক্ষেপগুলি সম্পূর্ণ করুন।

1. আপনার পরিষেবাতে CredentialProviderService থেকে বর্ধিত onBeginCreateCredentialRequest() পদ্ধতিটি ওভাররাইড করুন।
2. একটি সংশ্লিষ্ট BeginCreateCredentialResponse তৈরি করে এবং কলব্যাকের মাধ্যমে এটি পাস করে BeginCreateCredentialRequest পরিচালনা করুন।
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 ফ্ল্যাগ দিয়ে তৈরি করতে হবে যাতে সিস্টেমটি চূড়ান্ত অনুরোধটি intent extra-তে যুক্ত করতে পারে।
• আপনার PendingIntent অবশ্যই PendingIntent.FLAG_ONE_SHOT ফ্ল্যাগ দিয়ে তৈরি করা উচিত নয় কারণ ব্যবহারকারী একটি এন্ট্রি নির্বাচন করতে পারেন, ফিরে গিয়ে এটি পুনরায় নির্বাচন করতে পারেন যার ফলে PendingIntent দুবার চালু হতে পারে।
• আপনার PendingIntent অবশ্যই একটি অনন্য অনুরোধ কোড দিয়ে তৈরি করতে হবে যাতে প্রতিটি এন্ট্রির নিজস্ব সংশ্লিষ্ট PendingIntent থাকতে পারে।

পাসকি তৈরির অনুরোধের জন্য এন্ট্রি নির্বাচন পরিচালনা করুন

1. যখন ব্যবহারকারী পূর্বে পপুলেট করা CreateEntry নির্বাচন করে, তখন সংশ্লিষ্ট PendingIntent চালু করা হয় এবং সংশ্লিষ্ট প্রদানকারীর Activity তৈরি করা হয়।
2. আপনার Activity-এর onCreate পদ্ধতিটি চালু করার পরে, সংশ্লিষ্ট ইন্টেন্টটি অ্যাক্সেস করুন এবং ProviderCreateCredentialRequest পেতে PendingIntentHander ক্লাসে এটি পাস করুন।
3. অনুরোধ থেকে requestJson , callingAppInfo এবং clientDataHash বের করুন।
4. ইনটেন্ট এক্সট্রা থেকে লোকাল accountId বের করুন। এটি একটি নমুনা অ্যাপ-নির্দিষ্ট বাস্তবায়ন এবং এটির প্রয়োজন নেই। এই অ্যাকাউন্ট আইডিটি এই নির্দিষ্ট অ্যাকাউন্ট আইডির বিপরীতে এই শংসাপত্র সংরক্ষণ করতে ব্যবহার করা যেতে পারে।
5. requestJson যাচাই করুন। নিচের উদাহরণে PublicKeyCredentialCreationOptions এর মতো স্থানীয় ডেটা ক্লাস ব্যবহার করা হয়েছে যাতে WebAuthn স্পেসিফিকেশন অনুসারে JSON ইনপুটকে একটি স্ট্রাকচার্ড ক্লাসে রূপান্তর করা যায়। একটি ক্রেডেনশিয়াল প্রোভাইডার হিসেবে, আপনি এটিকে আপনার নিজস্ব পার্সার দিয়ে প্রতিস্থাপন করতে পারেন।
6. কলটি যদি কোনও নেটিভ অ্যান্ড্রয়েড অ্যাপ থেকে আসে তাহলে কলিং অ্যাপের অ্যাসেট-লিঙ্কটি পরীক্ষা করে দেখুন।
7. একটি প্রমাণীকরণ প্রম্পট দেখান। নীচের উদাহরণটি Android বায়োমেট্রিক API ব্যবহার করে।
8. প্রমাণীকরণ সফল হলে, একটি credentialId এবং একটি কী জোড়া তৈরি করুন।
9. আপনার স্থানীয় ডাটাবেসে callingAppInfo.packageName ফাইলের বিপরীতে প্রাইভেট কী সংরক্ষণ করুন।
10. একটি ওয়েব প্রমাণীকরণ API JSON প্রতিক্রিয়া তৈরি করুন যাতে পাবলিক কী এবং credentialId থাকে। নীচের উদাহরণে AuthenticatorAttestationResponse এবং FidoPublicKeyCredential মতো স্থানীয় ইউটিলিটি ক্লাস ব্যবহার করা হয়েছে যা পূর্বে উল্লিখিত স্পেকের উপর ভিত্তি করে একটি JSON তৈরি করতে সহায়তা করে। একজন ক্রেডেনশিয়াল প্রদানকারী হিসাবে, আপনি এই ক্লাসগুলিকে আপনার নিজস্ব বিল্ডার দিয়ে প্রতিস্থাপন করতে পারেন।
11. উপরে তৈরি করা JSON দিয়ে একটি CreatePublicKeyCredentialResponse তৈরি করুন।
12. PendingIntentHander.setCreateCredentialResponse() মাধ্যমে একটি Intent এ CreatePublicKeyCredentialResponse অতিরিক্ত হিসেবে সেট করুন এবং Activity-এর ফলাফলের সাথে সেই ইন্টেন্টটি সেট করুন।
13. কার্যকলাপটি শেষ করুন।

নিচের কোড উদাহরণটি এই ধাপগুলি ব্যাখ্যা করে। onCreate() চালু করার পরে এই কোডটি আপনার Activity ক্লাসে পরিচালনা করতে হবে।

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 সংশ্লিষ্ট Activityটি কার্যকর করে এবং সামনে আনে। onCreate এ পাস করা সংশ্লিষ্ট ইন্টেন্টটি অ্যাক্সেস করুন এবং ProviderCreateCredentialRequest পদ্ধতিটি পেতে PendingIntentHander ক্লাসে এটি পাস করুন।

নিচের উদাহরণটি এই প্রক্রিয়াটি কীভাবে বাস্তবায়ন করতে হয় তা ব্যাখ্যা করে। এই কোডটি আপনার Activity এর 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 ইনস্ট্যান্স প্রস্তুত করে।
• অ্যান্ড্রয়েড ফ্রেমওয়ার্ক এই পরিষেবাগুলির সাথে আবদ্ধ হয়ে সমস্ত প্রযোজ্য শংসাপত্র প্রদানকারীর কাছে এই অনুরোধটি প্রচার করে।
• এরপর প্রোভাইডার সার্ভিস একটি 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 ব্যবহার করে সেগুলি সেট আপ করুন। পাসকিগুলির জন্য, আপনি intente-তে 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. সংশ্লিষ্ট Activity-এর 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. ব্যবহারকারীকে যাচাই করার জন্য, একটি বায়োমেট্রিক প্রম্পট (অথবা অন্য কোনও দাবি পদ্ধতি) দেখান। নীচের কোড স্নিপেটটি অ্যান্ড্রয়েড বায়োমেট্রিক API ব্যবহার করে।

7. প্রমাণীকরণ সফল হয়ে গেলে, W3 Web Authentication Assertion spec এর উপর ভিত্তি করে একটি 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 এ সেট করা ইন্টেন্ট অ্যাকশনের সাথে সম্পর্কিত Activity চালু করা হয়। ক্রেডেনশিয়াল প্রদানকারীরা তখন ক্রেডেনশিয়ালগুলি আনলক করার জন্য একটি বায়োমেট্রিক প্রমাণীকরণ প্রবাহ বা অনুরূপ প্রক্রিয়া তৈরি করতে পারে। সফল হলে, ক্রেডেনশিয়াল প্রদানকারীকে একটি BeginGetCredentialResponse তৈরি করতে হবে, যা উপরে বর্ণিত ব্যবহারকারীর সাইন-ইন হ্যান্ডলিং-এর অনুরূপ , কারণ ক্রেডেনশিয়ালগুলি এখন আনলক করা হয়েছে। প্রস্তুতকৃত ইন্টেন্ট ফলাফল হিসাবে সেট করার আগে এবং কার্যকলাপটি সম্পন্ন হওয়ার আগে এই প্রতিক্রিয়াটি PendingIntentHandler.setBeginGetCredentialResponse() পদ্ধতির মাধ্যমে সেট করতে হবে।

শংসাপত্রের অনুরোধগুলি সাফ করুন

একটি ক্লায়েন্ট অ্যাপ অনুরোধ করতে পারে যে শংসাপত্র নির্বাচনের জন্য রক্ষণাবেক্ষণ করা যেকোনো অবস্থা অবশ্যই সাফ করতে হবে, যেমন একটি শংসাপত্র প্রদানকারী পূর্বে নির্বাচিত শংসাপত্রটি মনে রাখতে পারে এবং শুধুমাত্র পরের বার এটি ফেরত দিতে পারে। একটি ক্লায়েন্ট অ্যাপ এই API কে কল করে এবং আশা করে যে স্টিকি নির্বাচনটি সাফ হয়ে যাবে। আপনার শংসাপত্র প্রদানকারী পরিষেবা 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 ইন্টেন্ট আপনার ব্যবহারকারীকে পছন্দের প্রদানকারী নির্বাচন স্ক্রিনে পুনঃনির্দেশিত করে। এই স্ক্রিনে নির্বাচিত প্রদানকারী পছন্দের শংসাপত্র এবং অটোফিল প্রদানকারী হয়ে ওঠে।

বিশেষাধিকারপ্রাপ্ত অ্যাপগুলির একটি অনুমোদিত তালিকা পান

ওয়েব ব্রাউজারের মতো সুবিধাপ্রাপ্ত অ্যাপগুলি ক্রেডেনশিয়াল ম্যানেজার GetCredentialRequest() এবং CreatePublicKeyCredentialRequest() পদ্ধতিতে origin প্যারামিটার সেট করে অন্যান্য নির্ভরশীল পক্ষের পক্ষে ক্রেডেনশিয়াল ম্যানেজার কল করে। এই অনুরোধগুলি প্রক্রিয়া করার জন্য, ক্রেডেনশিয়াল প্রদানকারী getOrigin() API ব্যবহার করে origin পুনরুদ্ধার করে।

origin পুনরুদ্ধার করার জন্য, credential provider অ্যাপটিকে androidx.credentials.provider.CallingAppInfo's getOrigin() API তে বিশেষ সুবিধাপ্রাপ্ত এবং বিশ্বস্ত কলকারীদের একটি তালিকা পাঠাতে হবে। এই allowlist অবশ্যই একটি বৈধ JSON অবজেক্ট হতে হবে। signingInfo থেকে প্রাপ্ত packageName এবং সার্টিফিকেট ফিঙ্গারপ্রিন্ট getOrigin() API তে পাস করা privilegedAllowlist এ পাওয়া কোনও অ্যাপের সাথে মিলে গেলে origin ফেরত দেওয়া হবে। origin মান পাওয়ার পরে, provider অ্যাপটিকে এটিকে একটি বিশেষ সুবিধাপ্রাপ্ত কল হিসাবে বিবেচনা করা উচিত এবং কলিং অ্যাপের স্বাক্ষর ব্যবহার করে origin গণনা করার পরিবর্তে AuthenticatorResponse এর ক্লায়েন্ট ডেটাতে এই origin সেট করা উচিত।

যদি আপনি কোনও origin পুনরুদ্ধার করেন, তাহলে স্বাক্ষর অনুরোধের সময় clientDataJSON একত্রিত এবং হ্যাশ করার পরিবর্তে CreatePublicKeyCredentialRequest() বা GetPublicKeyCredentialOption() এ সরাসরি প্রদত্ত clientDataHash ব্যবহার করুন। JSON পার্সিং সমস্যা এড়াতে, প্রত্যয়ন এবং দাবির প্রতিক্রিয়ায় clientDataJSON এর জন্য একটি স্থানধারক মান সেট করুন। Google পাসওয়ার্ড ম্যানেজার getOrigin() এ কল করার জন্য একটি উন্মুক্তভাবে উপলব্ধ allowlist ব্যবহার করে। একটি শংসাপত্র প্রদানকারী হিসাবে, আপনি এই তালিকাটি ব্যবহার করতে পারেন অথবা API দ্বারা বর্ণিত JSON ফর্ম্যাটে আপনার নিজস্ব প্রদান করতে পারেন। কোন তালিকাটি ব্যবহার করা হবে তা নির্বাচন করা প্রদানকারীর উপর নির্ভর করে। তৃতীয় পক্ষের শংসাপত্র প্রদানকারীদের সাথে বিশেষাধিকারপ্রাপ্ত অ্যাক্সেস পেতে, তৃতীয় পক্ষের দ্বারা প্রদত্ত ডকুমেন্টেশনটি পড়ুন।

ডিভাইসে প্রোভাইডার চালু করুন

ব্যবহারকারীদের ডিভাইস সেটিংস > পাসওয়ার্ড এবং অ্যাকাউন্ট > আপনার প্রদানকারী > সক্ষম বা অক্ষম এর মাধ্যমে প্রদানকারী সক্ষম করতে হবে।

fun createSettingsPendingIntent(): PendingIntent