APPプライバシー許可を効果的に制御するためのソリューション

前書き

外部ストレージの読み取りと書き込み、連絡先の読み取り、テキストメッセージの送信などのプライバシー許可のために、Androidは6.0システムで動的認証の実行を開始しました。しかし、私の国では、認証ボックスをユーザーに表示するだけでは不十分です。工業情報化部は、11月19日初めに、8種類の侵害レビューに対して、次の8種類に明確に対応する特別な修正アプリを発行しました。問題の：

1.個人情報を非公開で収集する;
2。範囲を超えて個人情報を収集する;
3。サードパーティユーザーと個人情報を共有する;
4。ユーザーにターゲットプッシュ機能の使用を強制する;
5。使用を許可しない;
6。頻繁にアクセス権の申請;
。パーミッションのための7過度の要求、
ユーザーアカウントのログアウト8.セットアップの障壁。

残念ながら、オンライン新聞は批判に気づきました。プライバシー権限は当社のAPPの古いバージョンで確認されましたが、プライバシードキュメントでは効果的に説明されていませんでした。通知を受け取った後、チームはすぐに権限をスキャンし、APPがAndroidManifestで3つのプライバシー権限を確認したことを発見しましたが、実際のプロセスではそれらを使用しませんでした（いくつかは多くの間違いを犯しました）。多くのチームが私たちと同じ問題に直面していると思います。複数チームの開発では、権限を導入するための効果的な監視メカニズムはありません。同様の問題が再発しないようにするために、この記事では、シンプルで効果的なコードコンパイルレイヤーインターセプトスキームを紹介します。

スキームの原理について説明する前に、検出スキームは、APP AndroidManifest.xmlファイルで検証されたユーザー関連のプライバシー権限をスキャンし、次にプライバシードキュメントと実際の使用シナリオを比較して判断することであると想定します。検出スキームに直面して、私たちは解決策を提供します：

processApplicationManifestタスクがコンパイルフェーズで実行された後、マージされたマニフェストログファイルをスキャンします。新しいアクセス許可が使用されると、問題が解決されるまでパッケージ化エラーがスローされます。

ソースコードの簡単な読み物

Android GradleプラグインがAPPをコンパイルすると、build / outputs / logsディレクトリに[manifest-merger-$ {variantname} -report.txt]という名前のテキストファイルが生成されます。
例としてAGP3.5.0ソースコードを取り上げ、ProcessApplicationManifestタスクがマージされたマニフェストログファイルを生成する方法を分析するだけです。

package com.android.build.gradle.tasks;

/** A task that processes the manifest */
@CacheableTask
public abstract class ProcessApplicationManifest extends ManifestProcessorTask {
    @Override
    @Internal
    protected boolean getIncremental() {
        return true;
    }

    @Override
    protected void doFullTaskAction() throws IOException {
        ... ...
                    MergingReport mergingReport =
                    ManifestHelperKt.mergeManifestsForApplication(
                            getMainManifest(),
                            getManifestOverlays(),
                            computeFullProviderList(compatibleScreenManifestForSplit),
                            navigationXmls,
                            getFeatureName(),
                            moduleMetadata == null
                                    ? getPackageOverride()
                                    : moduleMetadata.getApplicationId(),
                            moduleMetadata == null
                                    ? apkData.getVersionCode()
                                    : Integer.parseInt(moduleMetadata.getVersionCode()),
                            moduleMetadata == null
                                    ? apkData.getVersionName()
                                    : moduleMetadata.getVersionName(),
                            getMinSdkVersion(),
                            getTargetSdkVersion(),
                            getMaxSdkVersion(),
                            manifestOutputFile.getAbsolutePath(),
                            // no aapt friendly merged manifest file necessary for applications.
                            null /* aaptFriendlyManifestOutputFile */,
                            metadataFeatureManifestOutputFile.getAbsolutePath(),
                            bundleManifestOutputFile.getAbsolutePath(),
                            instantAppManifestOutputFile != null
                                    ? instantAppManifestOutputFile.getAbsolutePath()
                                    : null,
                            ManifestMerger2.MergeType.APPLICATION,
                            variantConfiguration.getManifestPlaceholders(),
                            getOptionalFeatures(),
                            getReportFile(),   
                            LoggerWrapper.getLogger(ProcessApplicationManifest.class));
        ... ...
    }

    public static class CreationAction
            extends AnnotationProcessingTaskCreationAction<ProcessApplicationManifest> {

        private File reportFile;

        @Override
        public void preConfigure(@NonNull String taskName) {
            super.preConfigure(taskName);
            
            //这里就【manifest-merger-${variantname}-report.txt】文件
            reportFile =
                    FileUtils.join(
                            variantScope.getGlobalScope().getOutputsDir(),
                            "logs",
                            "manifest-merger-"
                                    + variantScope.getVariantConfiguration().getBaseName()
                                    + "-report.txt");
        }
     }   
}

コードを通じて、ProcessApplicationManifestがManifestHelperKt.mergeManifestsForApplicationメソッドに渡されてすべてのマニフェストがマージされ、ログが[manifest-merger-$ {variantname} -report.txt]ファイルに保存されていることがわかります。

package com.android.build.gradle.internal.tasks.manifest

/** Invoke the Manifest Merger version 2.  */
fun mergeManifestsForApplication(
    mainManifest: File,
    manifestOverlays: List<File>,
    dependencies: List<ManifestProvider>,
    navigationFiles: List<File>,
    featureName: String?,
    packageOverride: String?,
    versionCode: Int,
    versionName: String?,
    minSdkVersion: String?,
    targetSdkVersion: String?,
    maxSdkVersion: Int?,
    outManifestLocation: String,
    outAaptSafeManifestLocation: String?,
    outMetadataFeatureManifestLocation: String?,
    outBundleManifestLocation: String?,
    outInstantAppManifestLocation: String?,
    mergeType: ManifestMerger2.MergeType,
    placeHolders: Map<String, Any>,
    optionalFeatures: Collection<ManifestMerger2.Invoker.Feature>,
    reportFile: File?,
    logger: ILogger
): MergingReport {

    try {

        //ManifestMerger2是 manifest-merger库提供的辅助类
        val manifestMergerInvoker = ManifestMerger2.newMerger(mainManifest, logger, mergeType)
            .setPlaceHolderValues(placeHolders)
            .addFlavorAndBuildTypeManifests(*manifestOverlays.toTypedArray())
            .addManifestProviders(dependencies)
            .addNavigationFiles(navigationFiles)
            .withFeatures(*optionalFeatures.toTypedArray())
            .setMergeReportFile(reportFile)
            .setFeatureName(featureName)

        if (mergeType == ManifestMerger2.MergeType.APPLICATION) {
            manifestMergerInvoker.withFeatures(ManifestMerger2.Invoker.Feature.REMOVE_TOOLS_DECLARATIONS)
        }


        if (outAaptSafeManifestLocation != null) {
            manifestMergerInvoker.withFeatures(ManifestMerger2.Invoker.Feature.MAKE_AAPT_SAFE)
        }

        setInjectableValues(
            manifestMergerInvoker,
            packageOverride, versionCode, versionName,
            minSdkVersion, targetSdkVersion, maxSdkVersion
        )
        
        //关注这里的调用
        val mergingReport = manifestMergerInvoker.merge()
        //省略其他对merge结果处理代码
        ... ...
        return mergingReport
    } catch (e: ManifestMerger2.MergeFailureException) {
        // TODO: unacceptable.
        throw RuntimeException(e)
    }
}
接着看manifestMergerInvoker.merge()的实现

package com.android.manifmerger;

/**
 * merges android manifest files, idempotent.
 */
@Immutable
public class ManifestMerger2 {
    public static class Invoker<T extends Invoker<T>>{

        @NonNull
        public MergingReport merge() throws MergeFailureException {

            // provide some free placeholders values.
            ImmutableMap<ManifestSystemProperty, Object> systemProperties = mSystemProperties.build();
            ... ...
            FileStreamProvider fileStreamProvider = mFileStreamProvider != null
                    ? mFileStreamProvider : new FileStreamProvider();
            ManifestMerger2 manifestMerger =
                    new ManifestMerger2(
                            mLogger,
                            mMainManifestFile,
                            mLibraryFilesBuilder.build(),
                            mFlavorsAndBuildTypeFiles.build(),
                            mFeaturesBuilder.build(),
                            mPlaceholders.build(),
                            new MapBasedKeyBasedValueResolver<ManifestSystemProperty>(
                                    systemProperties),
                            mMergeType,
                            mDocumentType,
                            Optional.fromNullable(mReportFile),
                            mFeatureName,
                            fileStreamProvider,
                            mNavigationFilesBuilder.build());
            //调用下面的 private MergingReport merge()方法               
            return manifestMerger.merge();
        }
    }


    /**
     * Perform high level ordering of files merging and delegates actual merging to
     * {@link XmlDocument#merge(XmlDocument, com.android.manifmerger.MergingReport.Builder)}
     *
     * @return the merging activity report.
     * @throws MergeFailureException if the merging cannot be completed (for instance, if xml
     * files cannot be loaded).
     */
    @NonNull
    private MergingReport merge() throws MergeFailureException {
        // initiate a new merging report
        MergingReport.Builder mergingReportBuilder = new MergingReport.Builder(mLogger);
        //一系列merge manifest规则处理
        ... ...
        MergingReport mergingReport = mergingReportBuilder.build();

        if (mReportFile.isPresent()) {
            writeReport(mergingReport);
        }
        return mergingReport;
    }

    //最终写入Log文件方法
    /**
     * Creates the merging report file.
     * @param mergingReport the merging activities report to serialize.
     */
    private void writeReport(@NonNull MergingReport mergingReport) {
        FileWriter fileWriter = null;
                ... ... 
                fileWriter = new FileWriter(mReportFile.get());
                mergingReport.getActions().log(fileWriter);
    } 
}

これまで、ログファイルがコードレベルからどのように生成されるかを見てきました。

スキームの実現

[Manifest-merger- $ {variantname} -report.txt]ファイルの一般的な内容は次のとおりです。

-- Merging decision tree log ---
manifest
ADDED from /somepath/AndroidManifest.xml:x:x-xx:xx
MERGED from [dependencies sdk] /somepath/AndroidManifest.xml:x:x-xx:xx
INJECTED from /somepath/AndroidManifest.xml:x:x-xx:xx
...
uses-permission#android.permission.INTERNET
方案代码实现很简单：

1.自定义一个Extension，列出暂禁用的权限；
2.实现相应Plugin和Task；

Extension定义可以如下所示：

host{
       //明确暂禁用的权限列表
       forbiddenPermissions = ['android.permission.GET_ACCOUNTS',
                            'android.permission.SEND_SMS',
                            'android.permission.CALL_PHONE',
                            'android.permission.BLUETOOTH',
                             ... ...] 
}
Plugin简单示例：

public  class HostPlugin implements Plugin<Project> {
    @Override
    final void apply(Project project) {
        if (!project.getPlugins().hasPlugin('com.android.application') && !project.getPlugins().hasPlugin('com.android.library')) {
            throw new GradleException('apply plugin: \'com.android.application\' or apply plugin: \'com.android.library\' is required')
        }
        HostExtension hostExtension = project.getExtensions().create('host', HostExtension.class)
        
        project.afterEvaluate {
            def variants = null;
            if (project.plugins.hasPlugin('com.android.application')) {
                variants = android.getApplicationVariants()
            } else if (project.plugins.hasPlugin('com.android.library')) {
                variants = android.getLibraryVariants()
            }
            variants?.all { BaseVariant variant ->
               MergeHostManifestTask taskConfiguration=  new MergeHostManifestTask.CreationAction()
               project.getTasks().create(taskConfiguration.getName(), taskConfiguration.getType(), taskConfiguration)
            }
        }
    }   
}
Task简单示例：

import org.gradle.util.GFileUtils
import com.android.utils.FileUtils

class MergeHostManifestTask extends DefaultTask {

    List<String> forbiddenPermissions //禁用的权限列表

    VariantScope scope

    @TaskAction
    def doFullTaskAction() {

        File logFile = FileUtils.join(
                scope.getGlobalScope().getOutputsDir(),
                "logs",
                "manifest-permissions-validate-"
                        + scope.getVariantConfiguration().getBaseName()
                        + "-report.txt")
        GFileUtils.mkdirs(logFile.getParentFile())
        GFileUtils.deleteQuietly(logFile)  

        checkHostManifest(forbiddenPermissions,logFile,scope)
        if (logFile.exists() && logFile.length() > 0) {
            throw new GradleException("Has forbidden permissions in host, please check it in file ${logFile.getAbsolutePath()}")
        }              
    }    

    /**
     * 检测host manifest 是否含有禁用权限列表
     * @param forbiddenPermissions
     * @param logFile
     * @param variantScope
     */
    public static void checkHostManifest(List<String> forbiddenPermissions, File logFile, def variantScope) {
        if (forbiddenPermissions == null || forbiddenPermissions.isEmpty()) {
            return
        }

        File reportFile =
                FileUtils.join(
                        variantScope.getGlobalScope().getOutputsDir(),
                        "logs",
                        "manifest-merger-"
                                + variantScope.getVariantConfiguration().getBaseName()
                                + "-report.txt")

        if (!reportFile.exists()) {
            return
        }

        reportFile.withReader { reader ->
            String line
            while ((line = reader.readLine()) != null) {
                forbiddenPermissions.each { p ->
                    if (line.contains("uses-permission#${p.trim()}")) {
                        logFile.append("${p.trim()}\n")
                        logFile.append(reader.readLine())
                        logFile.append("\n")
                    }
                }
            }
        }
    }

    public static class CreationAction
            extends TaskConfiguration<MergeHostManifestTask> {

        BaseVariant variant

        Project project

        public CreationAction(Project project,BaseVariant variant){
            this.project= project
            this.variant=variant
        }

        @Override
        void execute(MergeHostManifestTask task) {
            ... ...
            HostExtension hostExtension = project.getExtensions().findByType(HostExtension.class)
            task.forbiddenPermissions = hostExtension.getForbiddenPermissions()
            task.scope= variant.getMetaClass().getProperty(variant, 'variantData').getScope()
            task.dependsOn getProcessManifestTask()
        }

       private Task getProcessManifestTaskCompat() {
        try {
            //>=3.3.0
            String taskName = variant.getMetaClass().getProperty(variant, 'variantData').getScope().getTaskContainer().getProcessManifestTask().getName()
            return project.getTasks().findByName(taskName)
        } catch (Exception e) {

        }
    }
}

APPまたはその依存SDKが無効なアクセス許可を導入した場合、コンパイル例外がスローされ、生成された[manifest-permissions-validate- $ {variantname} -report.txt]ファイルの内容は次のようになります。

android.permission.SEND_SMS
ADDED from /../app/src/main/AndroidManifest.xml:9:5-67
android.permission.BLUETOOTH
ADDED from /../app/src/main/AndroidManifest.xml:11:5-68

結びの言葉

プライバシー許可のリストに関して、関連部門は完全なリストを許可しませんでした。チームは、プライバシー文書が同期されるまで、プライバシー文書に記載されていないすべての動的許可を無効な許可として使用することをお勧めします。

参照

1.Android Gradleプラグイン：https：//android.googlesource.com/platform/tools/base/+/studio-master-dev/build-system/gradle-core

この記事はオープンソースプロジェクトに含まれています：https：//github.com/Android-Alvin/Android-LearningNotesには、さまざまな方向への自己学習プログラミングルート、インタビューの質問収集/顔の経典、および一連の技術が含まれています記事など。リソースは継続的に更新されています…