Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6eed56dd authored by Jeff Sharkey's avatar Jeff Sharkey
Browse files

More Bluetooth API annotation updates. 

This change adds a "BluetoothPermissionChecker" that ensures that
all Bluetooth permission annotations are consistent.  In addition, it
verifies that all Bluetooth public APIs have been audited to be
permission protected where relevant.

We've currently standardized on saying that APIs that return device
or Bluetooth state information (without sharing details about any
particular remote Bluetooth device) do not need to be permission
protected.

This change is only annotations and has no behavior changes.

Bug: 183626724
Test: ./build/soong/soong_ui.bash --make-mode Bluetooth RUN_ERROR_PRONE=true
Change-Id: Ie80b15b058359bf1e9a6ee881b89cb3e5b584ca1
parent 938e329b

Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -408,6 +408,7 @@ filegroup { 
        "core/java/android/annotation/MainThread.java",

        "core/java/android/annotation/NonNull.java",

        "core/java/android/annotation/Nullable.java",

        "core/java/android/annotation/RequiresNoPermission.java",

        "core/java/android/annotation/RequiresPermission.java",

        "core/java/android/annotation/SdkConstant.java",

        "core/java/android/annotation/StringDef.java",

core/java/Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -70,6 +70,7 @@ filegroup { 
        "android/annotation/Nullable.java",

        "android/annotation/PluralsRes.java",

        "android/annotation/RawRes.java",

        "android/annotation/RequiresNoPermission.java",

        "android/annotation/RequiresPermission.java",

        "android/annotation/SdkConstant.java",

        "android/annotation/Size.java",

core/java/android/annotation/RequiresNoPermission.java

0 → 100644
+36 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2021 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.annotation;



import static java.lang.annotation.ElementType.ANNOTATION_TYPE;

import static java.lang.annotation.ElementType.CONSTRUCTOR;

import static java.lang.annotation.ElementType.FIELD;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.PARAMETER;

import static java.lang.annotation.RetentionPolicy.CLASS;



import java.lang.annotation.Retention;

import java.lang.annotation.Target;



/**

 * Denotes that the annotated element requires no permissions.

 *

 * @hide

 */

@Retention(CLASS)

@Target({ANNOTATION_TYPE,METHOD,CONSTRUCTOR,FIELD,PARAMETER})

public @interface RequiresNoPermission {

}

core/java/android/bluetooth/BluetoothA2dp.java

+6 −0
Original line number Diff line number Diff line
@@ -20,8 +20,10 @@ import android.Manifest; 
import android.annotation.IntDef;

import android.annotation.NonNull;

import android.annotation.Nullable;

import android.annotation.RequiresNoPermission;

import android.annotation.RequiresPermission;

import android.annotation.SdkConstant;

import android.annotation.SuppressLint;

import android.annotation.SdkConstant.SdkConstantType;

import android.bluetooth.annotations.RequiresBluetoothConnectPermission;

import android.bluetooth.annotations.RequiresLegacyBluetoothAdminPermission;
@@ -512,6 +514,7 @@ public final class BluetoothA2dp implements BluetoothProfile { 
     * @return true if priority is set, false on error

     * @hide

     */

    @RequiresBluetoothConnectPermission

    @RequiresPermission(allOf = {

            android.Manifest.permission.BLUETOOTH_CONNECT,

            android.Manifest.permission.BLUETOOTH_PRIVILEGED,
@@ -534,6 +537,7 @@ public final class BluetoothA2dp implements BluetoothProfile { 
     * @hide

     */

    @SystemApi

    @RequiresBluetoothConnectPermission

    @RequiresPermission(allOf = {

            android.Manifest.permission.BLUETOOTH_CONNECT,

            android.Manifest.permission.BLUETOOTH_PRIVILEGED,
@@ -624,6 +628,7 @@ public final class BluetoothA2dp implements BluetoothProfile { 
     * @return true if device supports absolute volume

     * @hide

     */

    @RequiresNoPermission

    public boolean isAvrcpAbsoluteVolumeSupported() {

        if (DBG) Log.d(TAG, "isAvrcpAbsoluteVolumeSupported");

        try {
@@ -690,6 +695,7 @@ public final class BluetoothA2dp implements BluetoothProfile { 
     *

     * @hide

     */

    @RequiresBluetoothConnectPermission

    @RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)

    public boolean shouldSendVolumeKeys(BluetoothDevice device) {

        if (isEnabled() && isValidDevice(device)) {

core/java/android/bluetooth/BluetoothA2dpSink.java

+2 −0
Original line number Diff line number Diff line
@@ -282,6 +282,7 @@ public final class BluetoothA2dpSink implements BluetoothProfile { 
     * @return true if priority is set, false on error

     * @hide

     */

    @RequiresBluetoothConnectPermission

    @RequiresPermission(allOf = {

            android.Manifest.permission.BLUETOOTH_CONNECT,

            android.Manifest.permission.BLUETOOTH_PRIVILEGED,
@@ -304,6 +305,7 @@ public final class BluetoothA2dpSink implements BluetoothProfile { 
     * @hide

     */

    @SystemApi

    @RequiresBluetoothConnectPermission

    @RequiresPermission(allOf = {

            android.Manifest.permission.BLUETOOTH_CONNECT,

            android.Manifest.permission.BLUETOOTH_PRIVILEGED