Device Trust from Android Enterprise - इंटिग्रेशन गाइड

डिवाइस के भरोसेमंद होने के सिग्नल पाने के लिए, AMAPI SDK का इस्तेमाल करने के बारे में जानने के लिए, यह दस्तावेज़ आपकी मुख्य गाइड होना चाहिए.

AMAPI SDK की मदद से, आपका ऐप्लिकेशन (जिसे हम कभी-कभी "साथ में काम करने वाला" ऐप्लिकेशन भी कहते हैं) ADP (Android Device Policy) ऐप्लिकेशन से डिवाइस के भरोसेमंद होने के सिग्नल ऐक्सेस कर सकता है. इसके बाद, आपका ऐप्लिकेशन इन सिग्नल का इस्तेमाल करके, डिवाइस के भरोसेमंद होने की स्थिति का पता लगा सकता है. साथ ही, चुने गए कारोबार के लॉजिक को लागू कर सकता है.

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

  • डिवाइस के भरोसेमंद होने से जुड़े सिग्नल का ऐक्सेस सीमित है, ताकि कोई व्यक्ति बिना अनुमति के इनका इस्तेमाल न कर पाए. आवेदन करने के तरीके के बारे में जानने के लिए, डिवाइस के भरोसेमंद होने के सिग्नल ऐक्सेस करने की सुविधा पेज पर जाएं.
  • Android Enterprise का सुझाव है कि आप अपने क्लाइंट ऐप्लिकेशन में, Play Integrity API के सुइट को इंटिग्रेट करें. साथ ही, डिवाइस के भरोसेमंद होने के सिग्नल को पढ़ने और उन पर भरोसा करने से पहले, नतीजे देखें. जिन डिवाइसों पर Play Integrity API की जांच पूरी नहीं होती उन पर भरोसा नहीं किया जाना चाहिए. साथ ही, भरोसेमंद होने की स्थिति तय करने के लिए इस्तेमाल किए गए डिवाइस से मिले किसी भी सिग्नल पर भरोसा नहीं किया जाना चाहिए. ज़्यादा जानकारी के लिए, Play Integrity API के दस्तावेज़ देखें.

अपने ऐप्लिकेशन में AMAPI SDK टूल को इंटिग्रेट करना

डिवाइस के भरोसेमंद होने के सिग्नल ऐक्सेस करने के लिए, आपके ऐप्लिकेशन को AMAPI SDK के साथ इंटिग्रेट करना होगा. इस लाइब्रेरी और इसे अपने ऐप्लिकेशन में जोड़ने के तरीके के बारे में ज़्यादा जानकारी, AMAPI SDK टूल को इंटिग्रेट करने से जुड़ी गाइड में देखी जा सकती है.

ज़रूरी अनुमतियां जोड़ना

Android Enterprise API से डिवाइस ट्रस्ट के तौर पर मिले कुछ सिग्नल के लिए, यह ज़रूरी है कि ऐप्लिकेशन उसी अनुमति का एलान करे जिसकी ज़रूरत इस जानकारी को ऐक्सेस करने के लिए होती है. खास तौर पर:

सिग्नल ज़रूरी अनुमति
नेटवर्क की स्थिति ACCESS_NETWORK_STATE
स्क्रीन लॉक की जटिलता REQUEST_PASSWORD_COMPLEXITY

अगर ये अनुमतियां ऐप्लिकेशन के AndroidManifest.xml में शामिल नहीं हैं, तो Android Enterprise API से मिलने वाला डिवाइस ट्रस्ट, संबंधित सिग्नल के मेटाडेटा में PERMISSION_ISSUE दिखाएगा:

internalDeviceSettings=DeviceSettings{
  screenLockComplexity=COMPLEXITY_UNSPECIFIED,
  internalScreenLockComplexityMetadata=Metadata{
    dataIssues=[
      DataIssue{
        issueType=PERMISSION_ISSUE,
        issueLevel=WARNING,
        issueDetails=IssueDetailsCase{none}
      }
    ]
  },

ज़्यादा जानकारी के लिए, डिवाइस पर भरोसा करने से जुड़े उपलब्ध सिग्नल की सूची देखें.

डिवाइस के भरोसेमंद होने के सिग्नल ऐक्सेस करने का तरीका

डिवाइस के भरोसेमंद होने के सिग्नल ऐक्सेस करने वाले ऐप्लिकेशन को यह पुष्टि करनी होगी कि क्लाइंट एनवायरमेंट अप-टू-डेट है. अगर ज़रूरी हो, तो उसे अपडेट करना होगा.

डिवाइस ट्रस्ट सिग्नल ऐक्सेस करने का तरीका:

डिवाइस के भरोसेमंद होने के सिग्नल ऐक्सेस करने का तरीका

क्लाइंट एनवायरमेंट की पुष्टि करना

कोड के इस उदाहरण में, ADP ऐप्लिकेशन की मौजूदा स्थिति को पढ़ने के लिए getEnvironment का इस्तेमाल करने का तरीका दिखाया गया है. इसके बाद, आपका ऐप्लिकेशन deviceClient बना सकता है, ताकि डिवाइस के भरोसेमंद होने के सिग्नल को ऐक्सेस किया जा सके. हालांकि, ऐसा तब ही किया जा सकता है, जब एनवायरमेंट तैयार हो और अप-टू-डेट हो. इसके बारे में जानने के लिए, डिवाइस के भरोसेमंद होने के सिग्नल ऐक्सेस करना लेख पढ़ें.

Kotlin

import com.google.android.managementapi.common.model.Role
import com.google.android.managementapi.device.DeviceClient
import com.google.android.managementapi.device.DeviceClientFactory
import com.google.android.managementapi.device.model.GetDeviceRequest
import com.google.android.managementapi.environment.EnvironmentClient
import com.google.android.managementapi.environment.EnvironmentClientFactory
import com.google.android.managementapi.environment.model.Environment.AndroidDevicePolicyEnvironment.State.INSTALLED
import com.google.android.managementapi.environment.model.Environment.AndroidDevicePolicyEnvironment.State.NOT_INSTALLED
import com.google.android.managementapi.environment.model.Environment.AndroidDevicePolicyEnvironment.State.READY
import com.google.android.managementapi.environment.model.Environment.AndroidDevicePolicyEnvironment.Version.UP_TO_DATE
import com.google.android.managementapi.environment.model.GetEnvironmentRequest
import com.google.android.managementapi.environment.model.PrepareEnvironmentRequest

try {
    val context = applicationContext

    val roles = listOf(Role.builder().setRoleType(Role.RoleType.IDENTITY_PROVIDER).build())
    val request = GetEnvironmentRequest.builder().setRoles(roles).build()
    val environmentClient = EnvironmentClientFactory.create(context)
    val environmentResponse = environmentClient.getEnvironment(request)

    if (environmentResponse.hasAndroidDevicePolicyEnvironment()) {
        val adpEnvironment = environmentResponse.androidDevicePolicyEnvironment

        if (adpEnvironment.state == READY && adpEnvironment.version == UP_TO_DATE) {
            // AMAPI Environment State OK, Version OK.  Requesting Device signals..
            checkDevice(deviceClient = DeviceClientFactory.create(context))
        } else if (adpEnvironment.state == INSTALLED) {
            // prepareEnvironment should be called, calling
            // prepareEnvironment won't show the UI
            prepareEnvironment(context, environmentClient)
        } else if (adpEnvironment.state == NOT_INSTALLED) {
            // prepareEnvironment should be called, calling
            // prepareEnvironment will show the UI
            prepareEnvironment(context, environmentClient)
        }
    }
} catch (e: Exception) {
    Log.e(TAG, "Exception", e)
}

Java

import static com.google.android.managementapi.environment.model.Environment.AndroidDevicePolicyEnvironment.State.INSTALLED;
import static com.google.android.managementapi.environment.model.Environment.AndroidDevicePolicyEnvironment.State.NOT_INSTALLED;
import static com.google.android.managementapi.environment.model.Environment.AndroidDevicePolicyEnvironment.State.READY;
import static com.google.android.managementapi.environment.model.Environment.AndroidDevicePolicyEnvironment.Version.UP_TO_DATE;

import com.google.android.managementapi.common.model.Role;
import com.google.android.managementapi.device.DeviceClient;
import com.google.android.managementapi.device.DeviceClientFactory;
import com.google.android.managementapi.device.model.Device;
import com.google.android.managementapi.device.model.GetDeviceRequest;
import com.google.android.managementapi.environment.EnvironmentClient;
import com.google.android.managementapi.environment.EnvironmentClientFactory;
import com.google.android.managementapi.environment.model.Environment;
import com.google.android.managementapi.environment.model.Environment.AndroidDevicePolicyEnvironment;
import com.google.android.managementapi.environment.model.GetEnvironmentRequest;
import com.google.android.managementapi.environment.model.PrepareEnvironmentRequest;
import com.google.android.managementapi.environment.model.PrepareEnvironmentResponse;

try {
    Context context = getApplicationContext();

    ImmutableList roles = new ImmutableList.Builder()
            .add(Role.builder()
                    .setRoleType(Role.RoleType.IDENTITY_PROVIDER)
                    .build())
            .build();

    EnvironmentClient environmentClient = EnvironmentClientFactory.create(context);
    GetEnvironmentRequest request = GetEnvironmentRequest.builder()
            .setRoles(roles)
            .build();

    ListenableFuture getEnvironmentFuture = environmentClient.getEnvironmentAsync(request);
    Futures.addCallback(getEnvironmentFuture, new FutureCallback<>() {
        @Override
        public void onSuccess(Environment environment) {
            AndroidDevicePolicyEnvironment adpEnvironment = environment.getAndroidDevicePolicyEnvironment();

            AndroidDevicePolicyEnvironment.State state = adpEnvironment.getState();
            AndroidDevicePolicyEnvironment.Version version = adpEnvironment.getVersion();
            if (state == READY && version == UP_TO_DATE) {
                // AMAPI Environment State OK, Version OK.  Requesting Device signals..
                DeviceClient deviceClient = DeviceClientFactory.create(context);
                checkDevice(deviceClient);
            } else if (state == INSTALLED) {
                // prepareEnvironment should be called, calling
                // prepareEnvironment won't show the UI
                prepareEnvironment(context, environmentClient);
            } else if (state == NOT_INSTALLED) {
                // prepareEnvironment should be called, calling
                // prepareEnvironment will show the UI
                prepareEnvironment(context, environmentClient);
            }
        }

        @Override
        public void onFailure(Throwable t) {
            Log.d(TAG, t.toString());
        }
    }, MoreExecutors.directExecutor());
} catch (Exception e) {
    Log.d(TAG, e.toString());
}

अगर ADP ऐप्लिकेशन इंस्टॉल है, लेकिन अपडेट नहीं है, तो आपके ऐप्लिकेशन को prepareEnvironment को कॉल करना चाहिए, ताकि उपयोगकर्ता के इंटरैक्शन के बिना ADP ऐप्लिकेशन को अपडेट किया जा सके.

अगर ADP ऐप्लिकेशन इंस्टॉल नहीं है, तो आपका ऐप्लिकेशन prepareEnvironment कॉल कर सकता है, ताकि उपयोगकर्ता को ADP ऐप्लिकेशन इंस्टॉल करने के लिए कहा जा सके. क्लाइंट एनवायरमेंट तैयार करना लेख पढ़ें.

क्लाइंट एनवायरमेंट तैयार करना

  • अगर ADP ऐप्लिकेशन पहले से इंस्टॉल है, तो एपीआई इसे बिना किसी उपयोगकर्ता के हस्तक्षेप के अपडेट कर देगा.

  • अगर ADP ऐप्लिकेशन इंस्टॉल नहीं है, तो एपीआई उपयोगकर्ता को ADP ऐप्लिकेशन इंस्टॉल करने के लिए कहेगा.

Android Device Policy ऐप्लिकेशन इंस्टॉल करें

उपयोगकर्ता के चुने गए विकल्प को मॉनिटर करने के लिए, कॉलबैक रजिस्टर किया जा सकता है. ज़्यादा जानकारी के लिए, ADP ऐप्लिकेशन इंस्टॉल करने के दौरान उपयोगकर्ता के इंटरैक्शन को ट्रैक करना लेख पढ़ें.

हमारा सुझाव है कि prepareEnvironment कॉल, फ़ोरग्राउंड प्रोसेस से किया जाए. साथ ही, इसे ऑनबोर्डिंग के UX फ़्लो के दौरान किया जाए, ताकि उपयोगकर्ता को Android Device Policy इंस्टॉल करें मोडल डायलॉग से हैरानी न हो. अगर फ़ोरग्राउंड प्रोसेस से कॉल करना मुमकिन नहीं है, तो बैकग्राउंड से कॉल करने की अनुमति है. ऐसा इसलिए, क्योंकि यह एक वेब फ़्लो है और Android कॉम्पोनेंट में कोई यूज़र इंटरफ़ेस (यूआई) नहीं है. हालांकि, इसके लिए यह ज़रूरी है कि ऐसा ऑनबोर्डिंग यूज़र एक्सपीरियंस (यूएक्स) फ़्लो के दौरान हो.

एनवायरमेंट को सही तरीके से सेट अप करने के बाद, डिवाइस के भरोसेमंद होने से जुड़े सिग्नल ऐक्सेस किए जा सकते हैं. डिवाइस ट्रस्ट सिग्नल ऐक्सेस करना लेख पढ़ें.

Kotlin

try {
    val myNotificationReceiverService = ComponentName(
        context, MyNotificationReceiverService::class.java
    )

    val roles = listOf(Role.builder().setRoleType(Role.RoleType.IDENTITY_PROVIDER).build())
    val request = PrepareEnvironmentRequest.builder().setRoles(roles).build()

    val response =
        environmentClient.prepareEnvironment(request, myNotificationReceiverService)

    val environment = response.environment
    val adpEnvironment = environment.androidDevicePolicyEnvironment

    val state = adpEnvironment.state
    val version = adpEnvironment.version
    if (state == READY && version == UP_TO_DATE) {
        // Environment is prepared, access device posture signals using
        // DeviceClient.
        checkDevice(deviceClient = DeviceClientFactory.create(context))
    } else {
        // The prepareEnvironment call failed to prepare
        Log.w(
            TAG, "AMAPI environment was not ready: " + state + " - " + version
        )
    }

} catch (e: java.lang.Exception) {
    Log.d(TAG, e.toString())
}

Java

try {
    ComponentName myNotificationReceiverService = new ComponentName(
            context,
            MyNotificationReceiverService.class
    );

    ImmutableList roles = new ImmutableList.Builder()
            .add(Role.builder()
                    .setRoleType(Role.RoleType.IDENTITY_PROVIDER)
                    .build())
            .build();


    PrepareEnvironmentRequest request = PrepareEnvironmentRequest.builder()
            .setRoles(roles)
            .build();

    ListenableFuture environmentFuture =
            environmentClient.prepareEnvironmentAsync(
                    request,
                    myNotificationReceiverService
            );

    Futures.addCallback(environmentFuture, new FutureCallback<>() {
        @Override
        public void onSuccess(PrepareEnvironmentResponse response) {
            Environment environment = response.getEnvironment();
            AndroidDevicePolicyEnvironment adpEnvironment = environment.getAndroidDevicePolicyEnvironment();

            AndroidDevicePolicyEnvironment.State state = adpEnvironment.getState();
            AndroidDevicePolicyEnvironment.Version version = adpEnvironment.getVersion();
            if (state == READY && version == UP_TO_DATE) {
                // AMAPI Environment State OK, Version OK.  Requesting Device signals..
                DeviceClient deviceClient = DeviceClientFactory.create(context);
                checkDevice(deviceClient);
            } else {
                // The prepareEnvironment call failed to prepare
                Log.w(
                        TAG, "AMAPI environment was not ready: "
                        + adpEnvironment.getState() + " - " + adpEnvironment.getVersion()
                );
            }
        }

        @Override
        public void onFailure(@NonNull Throwable t) {
            // Handle the error
            Log.d(TAG, "AMAPI response did not contain an ADP environment");
        }
    }, MoreExecutors.directExecutor());
} catch (Exception e) {
    Log.d(TAG, e.toString());
}

डिवाइस ट्रस्ट सिग्नल ऐक्सेस करना

आपको जिस डिवाइस के भरोसेमंद होने के सिग्नल चाहिए उन्हें ऐक्सेस करने के लिए, पिछले चरण में दिखाए गए deviceClient इंस्टेंस का इस्तेमाल करके, Device ऑब्जेक्ट का अनुरोध किया जा सकता है.

Kotlin

try {
    kotlin.runCatching {
        deviceClient.getDeviceAwait(GetDeviceRequest.getDefaultInstance())
    }.onFailure { t ->
        Log.d(TAG, t.toString())
    }.onSuccess { device ->
        // Access device posture signals available in device
        val deviceString = device.toString()
        Log.d(TAG, deviceString)
    }
} catch (e: java.lang.Exception) {
    Log.d(TAG, e.toString())
}

Java

try {
    ListenableFuture deviceFuture =
            deviceClient.getDevice(GetDeviceRequest.getDefaultInstance());

    Futures.addCallback(deviceFuture, new FutureCallback() {
        @Override
        public void onSuccess(Device device) {
            // Access device posture signals available in device
            String deviceString = device.toString();
            Log.d(TAG, deviceString);
        }

        @Override
        public void onFailure(Throwable t) {
            Log.d(TAG, Log.d(TAG, t.toString());
        }
    }, MoreExecutors.directExecutor());
} catch (Exception e) {
    Log.d(TAG, e.toString());
}

ADP ऐप्लिकेशन इंस्टॉल करने के दौरान उपयोगकर्ता के इंटरैक्शन को ट्रैक करना

अगर डिवाइस को prepareEnvironment के दौरान ADP ऐप्लिकेशन इंस्टॉल करना है, तो आपका ऐप्लिकेशन उपयोगकर्ता के इंटरैक्शन को ट्रैक कर सकता है. इसके लिए, NotificationReceiverService लागू करें, ताकि getPrepareEnvironmentListener को खारिज करने वाली सूचनाएं मिल सकें:

Kotlin

import android.util.Log
import com.google.android.managementapi.environment.EnvironmentListener
import com.google.android.managementapi.environment.model.EnvironmentEvent.EventCase.Kind.ANDROID_DEVICE_POLICY_INSTALL_CONSENT_ACCEPTED
import com.google.android.managementapi.environment.model.EnvironmentEvent
import com.google.android.managementapi.notification.NotificationReceiverService

class MyNotificationReceiverService : NotificationReceiverService() {
    override fun getPrepareEnvironmentListener(): EnvironmentListener {
        return MyEnvironmentListener()
    }
}

class MyEnvironmentListener : EnvironmentListener {
    override fun onEnvironmentEvent(
        event: EnvironmentEvent
    ) {
        if (event.event.kind == ANDROID_DEVICE_POLICY_INSTALL_CONSENT_ACCEPTED) {
            Log.d(TAG, "User provided install consent")
        } else {
            Log.d(TAG, "User rejected install consent")
        }
    }

    companion object {
        private val TAG: String = MyEnvironmentListener::class.java.simpleName
    }
}

Java

import static com.google.android.managementapi.environment.model.EnvironmentEvent.EventCase.Kind.ANDROID_DEVICE_POLICY_INSTALL_CONSENT_ACCEPTED;

import android.util.Log;
import androidx.annotation.NonNull;
import com.google.android.managementapi.environment.EnvironmentListener;
import com.google.android.managementapi.environment.model.EnvironmentEvent;
import com.google.android.managementapi.notification.NotificationReceiverService;

class MyNotificationReceiverService extends NotificationReceiverService {
    @NonNull
    @Override
    protected EnvironmentListener getPrepareEnvironmentListener() {
        return new MyEnvironmentListener();
    }
}
class MyEnvironmentListener implements EnvironmentListener {
    final private String TAG = MyEnvironmentListener.class.getSimpleName();

    @Override
    public void onEnvironmentEvent(EnvironmentEvent event) {
        if (event.getEvent().getKind() == ANDROID_DEVICE_POLICY_INSTALL_CONSENT_ACCEPTED)
        {
            Log.d(TAG, "User provided install consent");
        } else {
            Log.d(TAG, "User rejected install consent");
        }
    }
}

ज्ञात समस्याएं

फ़िलहाल, कोई समस्या नहीं है.