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
|
/*
* Copyright (C) 2022 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 com.android.adservices.service.common;
import android.adservices.common.AdServicesPermissions;
import android.annotation.NonNull;
import android.content.Context;
import android.content.pm.PackageManager;
/**
* AdServicesApi permission helper. This class provides helper methods to check for permissions that
* need to be declared by callers of the APIs provided by AdServicesApi.
*
* @hide
*/
public final class PermissionHelper {
private PermissionHelper() {}
private static boolean checkSdkPermission(
@NonNull Context context, @NonNull String sdkName, @NonNull String perm) {
return context.getPackageManager().checkPermission(perm, sdkName)
== PackageManager.PERMISSION_GRANTED;
}
/** @return {@code true} if the caller has the permission to invoke Topics APIs. */
public static boolean hasTopicsPermission(
@NonNull Context context, boolean useSandboxCheck, @NonNull String sdkName) {
boolean callerPerm =
context.checkCallingOrSelfPermission(AdServicesPermissions.ACCESS_ADSERVICES_TOPICS)
== PackageManager.PERMISSION_GRANTED;
// Note: Checking permission declared by Sdk running in Sandbox is only for accounting
// purposes and should not be used as a security measure.
if (useSandboxCheck) {
return callerPerm
&& checkSdkPermission(
context, sdkName, AdServicesPermissions.ACCESS_ADSERVICES_TOPICS);
}
return callerPerm;
}
/** @return {@code true} if the caller has the permission to invoke AdID APIs. */
public static boolean hasAdIdPermission(
@NonNull Context context, boolean useSandboxCheck, @NonNull String sdkName) {
boolean callerPerm =
context.checkCallingOrSelfPermission(AdServicesPermissions.ACCESS_ADSERVICES_AD_ID)
== PackageManager.PERMISSION_GRANTED;
// Note: Checking permission declared by Sdk running in Sandbox is only for accounting
// purposes and should not be used as a security measure.
if (useSandboxCheck) {
return callerPerm
&& checkSdkPermission(
context, sdkName, AdServicesPermissions.ACCESS_ADSERVICES_AD_ID);
}
return callerPerm;
}
/** @return {@code true} if the caller has the permission to invoke Attribution APIs. */
public static boolean hasAttributionPermission(@NonNull Context context) {
// TODO(b/236267953): Add check for SDK permission.
int status =
context.checkCallingOrSelfPermission(
AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION);
return status == PackageManager.PERMISSION_GRANTED;
}
/** @return {@code true} if the caller has the permission to invoke Custom Audiences APIs. */
public static boolean hasCustomAudiencesPermission(@NonNull Context context) {
// TODO(b/236268316): Add check for SDK permission.
int status =
context.checkCallingOrSelfPermission(
AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE);
return status == PackageManager.PERMISSION_GRANTED;
}
/**
* @return {@code true} if the caller has the permission to invoke AdService's state
* modification API.
*/
public static boolean hasModifyAdServicesStatePermission(@NonNull Context context) {
int status =
context.checkCallingOrSelfPermission(AdServicesPermissions.MODIFY_ADSERVICES_STATE);
return status == PackageManager.PERMISSION_GRANTED;
}
/**
* @return {@code true} if the caller has the permission to invoke AdService's state access API.
*/
public static boolean hasAccessAdServicesStatePermission(@NonNull Context context) {
int status =
context.checkCallingOrSelfPermission(AdServicesPermissions.ACCESS_ADSERVICES_STATE);
return status == PackageManager.PERMISSION_GRANTED;
}
}
|