Apply Android CC to your service with CCPlugin

What is CCPlugIn?

CCPlugIn allows developers to run their Java services in a Realm environment on Android. It bridges the Normal World and the Realm World, enabling secure and isolated execution of custom services.

Prerequisites

Please follow this Android CC Environment Setup to set up the environment for using Host Android as a VM host and running KVM-based virtual machines.

How to apply CCPlugIn into your repository

@GenerateCCService on your AIDL interface

To run an AIDL interface inside a Realm via CCPlugIn, you must annotate the AIDL interface with:

@GenerateCCService(FQCN="...")

FQCN is the fully-qualified class name of the Realm-side service implementation that CCPlugIn should launch and bind to this interface.

Example:

// This FQCN string should be matched with your own service's FQCN.
@GenerateCCService(FQCN="com.example.realm.MyCcService")
interface IExampleInterface
{
    void doSomething();
    int addInt(int a, int b);
    int getRandomNumber();
    void getRandomNumberFromCallback(IResponse response);
    ...
}

Copy ccplugin_template into your repository

cd <AOSP ROOT>/external/CCPlugIn
./copy_ccplugin_template.sh <TARGET REPO ROOT>
cd <TARGET REPO ROOT>
cat ccplugin_template/append_to_your_android_bp.txt >> <TARGET ANDROID.BP PATH>/Android.bp

After that, you need to fill in the blanks in your Android.bp file. Here’s an example

// The main service file of your app which runs in the Realm world. It should be a java file.
filegroup {
    name: "my_app_service_for_realm",
    srcs: [""], // NOTE: Please fill in this part
}

/*
 * The actual implementation of this interface runs on "my_app_service_for_realm" in the Realm world.
 * The CCProxyService uses this interface to relays requests from the Normal World to the Realm world.
 */
filegroup {
    name: "my_app_aidl_for_realm",
    srcs: [""], // NOTE: Please fill in this part
}

Please define your own app name and replace “my_app” to it in both your Android.bp and ccplugin_template/Android.bp.

android_app {
    name: "my_app", // NOTE: Please define your own app name here
    srcs: [
        ":generate_cc_service",
    ],
    ...
}

Refer to these sample apps to learn how to apply CCPlugIn to your service:

• odcc-example-aosp
• odcc-tf-lite-bert-qa

Building

UNBUNDLED_BUILD_SDKS_FROM_SOURCE=true TARGET_BUILD_APPS=<YOUR ANDROID_APP NAME> m apps_only dist

Installing

You can install the app like this:

adb install -t out/dist/<YOUR ANDROID_APP NAME>.apk