File: AppIntegrityManager.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 326,092 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,181; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 117; sed: 19
file content (142 lines) | stat: -rw-r--r-- 4,502 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
 * Copyright (C) 2019 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.content.integrity;

import android.annotation.NonNull;
import android.annotation.SystemApi;
import android.annotation.SystemService;
import android.annotation.TestApi;
import android.content.Context;
import android.content.IntentSender;
import android.content.pm.ParceledListSlice;
import android.os.RemoteException;

import java.util.List;

/**
 * Class for pushing rules used to check the integrity of app installs.
 *
 * <p>Note: applications using methods of this class must be a system app and have their package
 * name allowlisted as an integrity rule provider. Otherwise a {@link SecurityException} will be
 * thrown.
 *
 * @hide
 */
@SystemApi
@SystemService(Context.APP_INTEGRITY_SERVICE)
public class AppIntegrityManager {

    /** The operation succeeded. */
    public static final int STATUS_SUCCESS = 0;

    /** The operation failed. */
    public static final int STATUS_FAILURE = 1;

    /**
     * Current status of an operation. Will be one of {@link #STATUS_SUCCESS}, {@link
     * #STATUS_FAILURE}.
     *
     * <p>More information about a status may be available through additional extras; see the
     * individual status documentation for details.
     *
     * @see android.content.Intent#getIntExtra(String, int)
     */
    public static final String EXTRA_STATUS = "android.content.integrity.extra.STATUS";

    IAppIntegrityManager mManager;

    /** @hide */
    public AppIntegrityManager(IAppIntegrityManager manager) {
        mManager = manager;
    }

    /**
     * Update the rules to evaluate during install time.
     *
     * @param updateRequest request containing the data of the rule set update
     * @param statusReceiver Called when the state of the session changes. Intents sent to this
     *     receiver contain {@link #EXTRA_STATUS}. Refer to the individual status codes on how to
     *     handle them.
     */
    public void updateRuleSet(
            @NonNull RuleSet updateRequest, @NonNull IntentSender statusReceiver) {
        try {
            mManager.updateRuleSet(
                    updateRequest.getVersion(),
                    new ParceledListSlice<>(updateRequest.getRules()),
                    statusReceiver);
        } catch (RemoteException e) {
            throw e.rethrowAsRuntimeException();
        }
    }

    /** Get the current version of the rule set. */
    @NonNull
    public String getCurrentRuleSetVersion() {
        try {
            return mManager.getCurrentRuleSetVersion();
        } catch (RemoteException e) {
            throw e.rethrowAsRuntimeException();
        }
    }

    /** Get the name of the package that provided the current rule set. */
    @NonNull
    public String getCurrentRuleSetProvider() {
        try {
            return mManager.getCurrentRuleSetProvider();
        } catch (RemoteException e) {
            throw e.rethrowAsRuntimeException();
        }
    }

    /**
     * Get current RuleSet on device.
     *
     * <p>Warning: this method is only used for tests.
     *
     * @hide
     */
    @TestApi
    @NonNull
    public RuleSet getCurrentRuleSet() {
        try {
            ParceledListSlice<Rule> rules = mManager.getCurrentRules();
            String version = mManager.getCurrentRuleSetVersion();
            return new RuleSet.Builder().setVersion(version).addRules(rules.getList()).build();
        } catch (RemoteException e) {
            throw e.rethrowAsRuntimeException();
        }
    }

    /**
     * Get the package names of all allowlisted rule providers.
     *
     * <p>Warning: this method is only used for tests.
     *
     * @hide
     */
    @TestApi
    @NonNull
    public List<String> getWhitelistedRuleProviders() {
        try {
            return mManager.getWhitelistedRuleProviders();
        } catch (RemoteException e) {
            throw e.rethrowAsRuntimeException();
        }
    }
}