Android Framework 添加新的 系统服务

基于 上一篇 对 AMS 的类图结构的学习，
AMS 类图结构
想自己 添加 一个新的 系统服务，看看是否能实现，加深理解及学以致用。于是有了下文。
开发环境：

• Android SDK 31 (Android12 平台)
• Android Studio version 2020.3.1
• Gradle 依赖 6.8.3

一、总体涉及修改的文件：

1. 新增 的 服务

(1) 服务AIDL文件，定义服务的接口：
frameworks/base/core/java/android/app/IDemoManager.aidl
(2) 服务管理类，提供给客户端调用，以访问 服务端的接口 (即持有 服务端 的引用， Binder 引用)
frameworks/base/core/java/android/app/DemoManager.java
(3) 服务实现类， 实现AIDL 文件
frameworks/base/services/core/java/com/android/server/DemoManagerService.java

2. 创建 及 启动服务 涉及的修改

(1) 定义服务的标识
frameworks/base/core/java/android/content/Context.java
(2) 创建 及 启动 服务
frameworks/base/services/java/com/android/server/SystemServer.java
(3)创建服务管理类(可同时获取服务端的代理对象，由服务管理对象持有)
frameworks/base/core/java/android/app/SystemServiceRegistry.java

3. SELinux sepolicy 的权限 修改

device/qcom/sepolicy/.../service.te
device/qcom/sepolicy/.../service_contexts
*备注： 其中路径中的 ... 表示可能不同厂商的实际路径不一致， 参考项目的目录配置

4. 其它平台限制的修改

根据 异常log分析，添加对应 修改 即可， 例如 ServiceManager.addService可能还有其它限制，如白名单service等

二、具体过程

1. 新增 服务

1.1 服务AIDL文件：IDemoManager.aidl ， 定义接口
方便起见，我们是添加在 android.app 包中 （平台可能会限制我们添加到自定义的目录）
这里仅 声明了 一个 plus 函数，实现对两个 int 值的加法， 并返回 int 值的结果， 相当简单

// IDemoManager.aidl
package android.app;

// Declare any non-default types here with import statements

interface IDemoManager {
    int plus(int a, int b);
}

1.2 服务管理类： DemoManager.java
这里是参考 ActivityManager 源码的实现， 获取 服务的 代理对象(Binder引用) 时，使用了 单例模式；
Context.DEMO_SERVICE 是新增服务的 标识， 见下面的 Context.java 的修改；
提供两个方法， 静态方法 plus 和 非静态方法 plusA, 最终调用的都是 服务端的 plus 方法；

package android.app;

import android.annotation.SystemService;

import android.content.Context;
import android.compat.annotation.UnsupportedAppUsage;
import android.os.IBinder;
import android.os.RemoteException;
import android.os.ServiceManager;
import android.util.Log;
import android.util.Singleton;

@SystemService(Context.DEMO_SERVICE)
public class DemoManager {
    private static String TAG = "DemoManager";

    /**
     * @hide
     */
    @UnsupportedAppUsage
    public static IDemoManager getService() {
        return IDemoManagerSingleton.get();
    }

    @UnsupportedAppUsage
    private static final Singleton IDemoManagerSingleton =
            new Singleton() {
                @Override
                protected IDemoManager create() {
                    final IBinder b = ServiceManager.getService(Context.DEMO_SERVICE);
                    final IDemoManager am = IDemoManager.Stub.asInterface(b);
                    return am;
                }
            };

    public static int plus(int a, int b) throws RemoteException {
        Log.d(TAG, "plus");
        return getService().plus(a, b);
    }

    public int plusA(int a, int b) throws RemoteException {
        Log.d(TAG, "plusA");
        return getService().plus(a, b);
    }


    /**
     * @hide
     */
    public DemoManager() {
    }
}

1.3 服务实现类： DemoManagerService.java
继承IDemoManager.Stub，实现接口；
内部静态类 Lifecycle 继承了 SystemService, 则可由 系统 管理它的生命周期 (启动、添加到SericeManager等); (不熟悉的可以看 SystemServie 的源码)
Context.DEMO_SERVICE 是新增服务的 标识， 见下面的 Context.java 的修改

package com.android.server;

import android.app.IDemoManager;
import android.content.Context;
import android.os.RemoteException;
import android.util.Log;

import com.android.server.SystemService;

import androidx.annotation.NonNull;

public class DemoManagerService extends IDemoManager.Stub{
    private static String TAG = "DemoManagerService";

    @Override
    public int plus(int a, int b) throws RemoteException {
        Log.d(TAG, "plus - a=" + a + ", b=" + b);
        return a + b;
    }

    public static final class Lifecycle extends SystemService {
        private final DemoManagerService mService;

        public Lifecycle(Context context) {
            super(context);
            mService = new DemoManagerService();
            Log.d(TAG, "Lifecycle create");
        }

        @Override
        public void onStart() {
            Log.d(TAG, "Lifecycle onStart start");
            publishBinderService(Context.DEMO_SERVICE, mService);
            Log.d(TAG, "Lifecycle onStart continue");
            mService.start();
            Log.d(TAG, "Lifecycle onStart end");
        }

        @Override
        public void onBootPhase(int phase) {

        }

//        @Override
//        public void onUserStopped(@NonNull TargetUser user) {
//        }

        public DemoManagerService getService() {
            return mService;
        }
    }

    private void start() {
        //todo
    }
}

2. 创建 及 启动 服务

2.1 Context.java
定义 服务的 唯一标识

public static final String DEMO_SERVICE = "demo";

2.2 SystemServer.java
在startOtherServices() 方法中， 启动服务
务必加上 try-catch, 否则，一旦发生异常， 例如SEPolicy限制添加 该 service而抛出 SecurityException, 则会导致 system_server进程挂掉，设备无法开机!!!

private void startOtherServices(@NonNull TimingsTraceAndSlog t) {
        // 省略一万行
        t.traceBegin("StartDemoManagerService");
        try {
            mSystemServiceManager.startService(DemoManagerService.Lifecycle.class);
        } catch (Throwable e) {
            reportWtf("starting DemoManagerService", e);
        }
        t.traceEnd();

2.3 SystemServiceRegistry.java
在静态代码块中，新增代码 注册 服务管理 类 对象

@SystemApi
public final class SystemServiceRegistry {
    // 省略一万行
    static {
       // 省略一万行
       registerService(Context.DEMO_SERVICE, DemoManager.class,
                new CachedServiceFetcher() {
            @Override
            public DemoManager createService(ContextImpl ctx) {
                return new DemoManager();
            }});

3.SEPolicy 权限修改

SEPolicy 简单可以理解为 Linux 为了 控制 系统服务 的访问权限，
ServiceManager 仅能访问特定类型的服务， 因此 新增的 服务必须声明为 对应的类型!!!
例如在上面修改的基础上，运行不起效，日志提示以下错误信息：

audit:                      avc:  denied  { add } for pid=1222 uid=1000 name=demo scontext=u:r:system_server:s0 tcontext=u:object_r:default_android_service:s0 tclass=service_manager permissive=0
即不允许 在 system_server 中， 通过 service_manager 获取到 服务demo(它的类型为: u:object_r:default_android_service:s0) 

则，需要进行以下的修改
3.1 service.te 新增服务 类型
在该文件后面新增：

type demo_service,         system_api_service, system_server_service, service_manager_type;

这里定义服务类型， 服务名最好对应 新增服务 的标识(Context.java ---> DEMO_SERVICE = "demo")，
因此这里我们定义了：
服务名：demo_service
类型：system_api_service, system_server_service, service_manager_type
3.2 service_contexts 设置服务上下文 类型
在该文件后面新增：

demo                  u:object_r:demo_service:s0

这里为 新增的服务demo 设置类型为： u:object_r:demo_service:s0，
需要特别注意的是， demo 是对应Context.java 新增的：

public static final String DEMO_SERVICE = "demo";

demo_service 为在 service.te 定义的类型， 必须一一对应，否则无效!!!!
则可以得出结论： ServiceManager 访问的类型，必须是 在 service.te 里定义的 类型

4.其它修改

一般是与平台限制有关，
如ServiceManager addService 时提示 仅允许 白名单的service, 按提示 加入 白名单即可

又例如在 DemoManager 获取 service (即使用ServiceManager getService)时报错：

15:41:46.698  4689   4689   DemoManager:             plusA
15:41:46.705  696    795    audit:                   avc:  denied  { find } for pid=4689 uid=10320 name=demo scontext=u:r:untrusted_app:s0:c64,c257,c512,c768 tcontext=u:object_r:demo_service:s0 tclass=service_manager permissive=0
15:41:46.705  696    795    servicemanager:          demo : getService has failed, permission denied.

此时可尝试在 untrusted_app.te 中添加：

allow untrusted_app demo_service:service_manager find;

大概意识是， 允许untrusted_app 通过 service_manager 获取到我们新增的服务 demo_service
( demo_service是我们在service.te 新增的服务类型)

5. 客户端使用

只需根据 Context.getSystemService 获取到 DemoManager，然后调用对应plusA 方法即可

import android.app.DemoManager;

.....
    private DemoManager mDemoManager;
     
    mDemoManager = (DemoManager) mContext.getSystemService(Context.DEMO_SERVICE);
    Log.d(TAG, " mDemoManager="+mDemoManager);
    if (mDemoManager != null ) {
        try {
            int result = mDemoManager.plusA(2,3);
            Log.d(TAG, "result="+result);
        } catch(Exception e) {
            e.printStackTrace();
        }
    }

服务创建、启动 即 使用 日志打印：

03-31 06:11:43.985  1243  1243 I SystemServerTiming: StartDemoManagerService
03-31 06:11:43.985  1243  1243 I SystemServiceManager: Starting com.android.server.DemoManagerService$Lifecycle
03-31 06:11:43.987  1243  1243 D DemoManagerService: Lifecycle create
03-31 06:11:43.987  1243  1243 D DemoManagerService: Lifecycle onStart start

03-31 06:11:43.988   696   795 I servicemanager: Adding 'u:r:system_server:s0' service (demo:1243)

03-31 06:11:43.988  1243  1243 D DemoManagerService: Lifecycle onStart continue
03-31 06:11:43.988  1243  1243 D DemoManagerService: Lifecycle onStart end
03-31 06:11:43.988  1243  1243 D SystemServerTiming: StartDemoManagerService took to complete: 3ms

14:15:08.034  10415  10415  SampleApp mDemoManager=android.app.DemoManager@e8bd8a2
14:15:08.038  10415  10415  SampleApp  result=5

三、遇到的问题

1. SEPolicy 权限问题详细log：

16:37:47.140  1222   1222   SystemServerTiming:         StartDemoManagerService
16:37:47.140  1222   1222   SystemServiceManager:       Starting com.android.server.DemoManagerService$Lifecycle
16:37:47.142  1222   1222   DemoManagerService:         Lifecycle create
16:37:47.142  1222   1222   DemoManagerService:         Lifecycle onStart start
16:37:47.143  695    706    audit:                      avc:  denied  { add } for pid=1222 uid=1000 name=demo scontext=u:r:system_server:s0 tcontext=u:object_r:default_android_service:s0 tclass=service_manager permissive=0
16:37:47.144  1222   1222   SystemServer:               ***********************************************
16:37:47.146  1222   1222   SystemServer:               BOOT FAILURE starting DemoManagerService
16:37:47.146  1222   1222   SystemServer:               java.lang.RuntimeException: Failed to start service com.android.server.DemoManagerService$Lifecycle: onStart threw an exception
16:37:47.146  1222   1222   SystemServer:               at com.android.server.SystemServiceManager.startService(SystemServiceManager.java:244)
16:37:47.146  1222   1222   SystemServer:               at com.android.server.SystemServiceManager.startService(SystemServiceManager.java:225)
16:37:47.146  1222   1222   SystemServer:               at com.android.server.SystemServer.startOtherServices(SystemServer.java:2928)
16:37:47.146  1222   1222   SystemServer:               at com.android.server.SystemServer.run(SystemServer.java:1225)
16:37:47.146  1222   1222   SystemServer:               at com.android.server.SystemServer.main(SystemServer.java:946)
16:37:47.146  1222   1222   SystemServer:               at java.lang.reflect.Method.invoke(Native Method)
16:37:47.146  1222   1222   SystemServer:               at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:567)
16:37:47.146  1222   1222   SystemServer:               at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1113)
16:37:47.146  1222   1222   SystemServer:               Caused by: java.lang.SecurityException:
16:37:47.146  1222   1222   SystemServer:               at android.os.Parcel.createExceptionOrNull(Parcel.java:2437)
16:37:47.146  1222   1222   SystemServer:               at android.os.Parcel.createException(Parcel.java:2421)
16:37:47.146  1222   1222   SystemServer:               at android.os.Parcel.readException(Parcel.java:2404)
16:37:47.146  1222   1222   SystemServer:               at android.os.Parcel.readException(Parcel.java:2346)
16:37:47.146  1222   1222   SystemServer:               at android.os.IServiceManager$Stub$Proxy.addService(IServiceManager.java:452)
16:37:47.146  1222   1222   SystemServer:               at android.os.ServiceManagerProxy.addService(ServiceManagerNative.java:72)
16:37:47.146  1222   1222   SystemServer:               at android.os.ServiceManager.addService(ServiceManager.java:249)
16:37:47.146  1222   1222   SystemServer:               at com.android.server.SystemService.publishBinderService(SystemService.java:442)
16:37:47.146  1222   1222   SystemServer:               at com.android.server.SystemService.publishBinderService(SystemService.java:426)
16:37:47.146  1222   1222   SystemServer:               at com.android.server.SystemService.publishBinderService(SystemService.java:413)
16:37:47.146  1222   1222   SystemServer:               at com.android.server.DemoManagerService$Lifecycle.onStart(DemoManagerService.java:33)
16:37:47.146  1222   1222   SystemServer:               at com.android.server.SystemServiceManager.startService(SystemServiceManager.java:238)
16:37:47.146  1222   1222   SystemServer:               ... 7 more
16:37:47.143  0      0      [0:                         Binder:695_2:  706]  avc: denied  { add } for pid=1222 uid=1000 name=demo scontext=u:r:system_server:s0 tcontext=u:object_r:default_android_service:s0 tclass=service_manager permissive=0
16:37:47.143  0      0      :                           [0:   Binder:695_2:  706]
16:37:47.146  1222   1222   SystemServerTiming:         StartDemoManagerService took to complete: 7ms

四、参考文章

Android Framework添加系统服务
https://www.cnblogs.com/rossoneri/p/9651782.html

Android源码添加自定义系统服务
https://www.cnblogs.com/liam999/p/5933827.html

一文彻底明白linux中的selinux到底是什么
https://blog.csdn.net/yanjun821126/article/details/80828908