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

Commit f275443c authored by Jeff Sharkey's avatar Jeff Sharkey
Browse files

Update Bluetooth API annotations. 

Recent work has introduced a new "Nearby devices" runtime permission
which protects all existing Bluetooth APIs; we've done this by
defining a <split-permission> to convert the old BLUETOOTH and
BLUETOOTH_ADMIN permissions into one of three new permissions:

* BLUETOOTH_ADVERTISE: Required to be able to advertise to nearby
                       Bluetooth devices.
* BLUETOOTH_CONNECT:   Allows applications to connect to paired
                       bluetooth devices.
* BLUETOOTH_SCAN:      Required to be able to discover and pair
                       nearby Bluetooth devices.

At its core, this change begins updating the Bluetooth APIs to have
correct @RequiresPermission indicating which permission is actually
enforced internally.  To ensure alignment across Binder, the newly
added "RequiresPermissionChecker" Error Prone checker was used to
discover any inconsistencies, ensuring correctness from server-side
enforcement up through to the public APIs.

In addition, since developers will continue building apps for both
modern and legacy platforms, this change introduces new auto-doc
annotations which will emit helpful consistent documentation
describing the behavior of older devices that are still using the
old permission model.

Bug: 183626724
Test: ./build/soong/soong_ui.bash --make-mode Bluetooth RUN_ERROR_PRONE=true
Change-Id: I16880d3f8edee8123cb512a9d8898ceccbe576f3
parent 1d20cc1a

system/binder/android/bluetooth/IBluetooth.aidl

+70 −1
Original line number Diff line number Diff line
@@ -39,79 +39,131 @@ import android.os.ResultReceiver; 
interface IBluetooth

{

    int getState();



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean enable(boolean quietMode);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean disable();



    @UnsupportedAppUsage

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(allOf={android.Manifest.permission.BLUETOOTH_CONNECT,android.Manifest.permission.LOCAL_MAC_ADDRESS})")

    String getAddress();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    ParcelUuid[] getUuids();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean setName(in String name);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    String getName();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    BluetoothClass getBluetoothClass();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setBluetoothClass(in BluetoothClass bluetoothClass);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getIoCapability();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setIoCapability(int capability);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getLeIoCapability();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setLeIoCapability(int capability);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_SCAN)")

    int getScanMode();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_SCAN)")

    boolean setScanMode(int mode, int duration);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_SCAN)")

    int getDiscoverableTimeout();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_SCAN)")

    boolean setDiscoverableTimeout(int timeout);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_SCAN)")

    boolean startDiscovery(in AttributionSource attributionSource);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_SCAN)")

    boolean cancelDiscovery();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_SCAN)")

    boolean isDiscovering();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    long getDiscoveryEndMillis();



    int getAdapterConnectionState();

    int getProfileConnectionState(int profile);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    BluetoothDevice[] getBondedDevices();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean createBond(in BluetoothDevice device, in int transport, in OobData p192Data,

    in OobData p256Data, String packageName);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean cancelBondProcess(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean removeBond(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getBondState(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean isBondingInitiatedLocally(in BluetoothDevice device);

    long getSupportedProfiles();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getConnectionState(in BluetoothDevice device);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    String getRemoteName(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getRemoteType(in BluetoothDevice device);

    @UnsupportedAppUsage

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    String getRemoteAlias(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean setRemoteAlias(in BluetoothDevice device, in String name, in String callingPackage);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getRemoteClass(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    ParcelUuid[] getRemoteUuids(in BluetoothDevice device);

    @UnsupportedAppUsage

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean fetchRemoteUuids(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean sdpSearch(in BluetoothDevice device, in ParcelUuid uuid);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getBatteryLevel(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getMaxConnectedAudioDevices();



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean setPin(in BluetoothDevice device, boolean accept, int len, in byte[] pinCode);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean setPasskey(in BluetoothDevice device, boolean accept, int len, in byte[]

    passkey);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setPairingConfirmation(in BluetoothDevice device, boolean accept);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getPhonebookAccessPermission(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setSilenceMode(in BluetoothDevice device, boolean silence);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean getSilenceMode(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setPhonebookAccessPermission(in BluetoothDevice device, int value);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getMessageAccessPermission(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setMessageAccessPermission(in BluetoothDevice device, int value);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getSimAccessPermission(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setSimAccessPermission(in BluetoothDevice device, int value);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    void registerCallback(in IBluetoothCallback callback);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    void unregisterCallback(in IBluetoothCallback callback);



    // For Socket

    IBluetoothSocketManager getSocketManager();



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean factoryReset();



    boolean isMultiAdvertisementSupported();
@@ -123,15 +175,20 @@ interface IBluetooth 
    boolean isLeExtendedAdvertisingSupported();

    boolean isLePeriodicAdvertisingSupported();

    int getLeMaximumAdvertisingDataLength();



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    BluetoothActivityEnergyInfo reportActivityInfo();



    // For Metadata

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean registerMetadataListener(in IBluetoothMetadataListener listener, in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean unregisterMetadataListener(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setMetadata(in BluetoothDevice device, in int key, in byte[] value);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    byte[] getMetadata(in BluetoothDevice device, in int key);





    /**

     * Requests the controller activity info asynchronously.

     * The implementor is expected to reply with the
@@ -139,21 +196,33 @@ interface IBluetooth 
     * key {@link android.os.BatteryStats#RESULT_RECEIVER_CONTROLLER_KEY}.

     * The result code is ignored.

     */

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    oneway void requestActivityInfo(in ResultReceiver result);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    void onLeServiceUp();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    void onBrEdrDown();



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(allOf={android.Manifest.permission.BLUETOOTH_CONNECT,android.Manifest.permission.BLUETOOTH_PRIVILEGED,android.Manifest.permission.MODIFY_PHONE_STATE})")

    boolean connectAllEnabledProfiles(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(allOf={android.Manifest.permission.BLUETOOTH_CONNECT,android.Manifest.permission.BLUETOOTH_PRIVILEGED})")

    boolean disconnectAllEnabledProfiles(in BluetoothDevice device);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(allOf={android.Manifest.permission.BLUETOOTH_CONNECT,android.Manifest.permission.BLUETOOTH_PRIVILEGED,android.Manifest.permission.MODIFY_PHONE_STATE})")

    boolean setActiveDevice(in BluetoothDevice device, in int profiles);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    List<BluetoothDevice> getMostRecentlyConnectedDevices();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(allOf={android.Manifest.permission.BLUETOOTH_CONNECT,android.Manifest.permission.BLUETOOTH_PRIVILEGED,android.Manifest.permission.MODIFY_PHONE_STATE})")

    boolean removeActiveDevice(in int profiles);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean registerBluetoothConnectionCallback(in IBluetoothConnectionCallback callback);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean unregisterBluetoothConnectionCallback(in IBluetoothConnectionCallback callback);



    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean canBondWithoutDialog(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    void generateLocalOobData(in int transport, IBluetoothOobDataCallback callback);

}

system/binder/android/bluetooth/IBluetoothA2dp.aidl

+22 −0
Original line number Diff line number Diff line
@@ -29,32 +29,54 @@ import android.bluetooth.BufferConstraints; 
interface IBluetoothA2dp {

    // Public API

    @UnsupportedAppUsage

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean connect(in BluetoothDevice device);

    @UnsupportedAppUsage

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean disconnect(in BluetoothDevice device);

    @UnsupportedAppUsage

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    List<BluetoothDevice> getConnectedDevices();

    @UnsupportedAppUsage

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    List<BluetoothDevice> getDevicesMatchingConnectionStates(in int[] states);

    @UnsupportedAppUsage

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getConnectionState(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean setActiveDevice(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    BluetoothDevice getActiveDevice();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(allOf={android.Manifest.permission.BLUETOOTH_CONNECT,android.Manifest.permission.BLUETOOTH_PRIVILEGED})")

    boolean setConnectionPolicy(in BluetoothDevice device, int connectionPolicy);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    int getConnectionPolicy(in BluetoothDevice device);

    boolean isAvrcpAbsoluteVolumeSupported();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    oneway void setAvrcpAbsoluteVolume(int volume);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean isA2dpPlaying(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    BluetoothCodecStatus getCodecStatus(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    oneway void setCodecConfigPreference(in BluetoothDevice device,

                in BluetoothCodecConfig codecConfig);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    oneway void enableOptionalCodecs(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    oneway void disableOptionalCodecs(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int supportsOptionalCodecs(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getOptionalCodecsEnabled(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    oneway void setOptionalCodecsEnabled(in BluetoothDevice device, int value);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    int getDynamicBufferSupport();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    BufferConstraints getBufferConstraints();

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean setBufferLengthMillis(int codec, int size);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    int getPriority(in BluetoothDevice device);

}

system/binder/android/bluetooth/IBluetoothA2dpSink.aidl

+5 −0
Original line number Diff line number Diff line
@@ -25,13 +25,18 @@ import android.bluetooth.BluetoothDevice; 
 * @hide

 */

interface IBluetoothA2dpSink {

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean connect(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    boolean disconnect(in BluetoothDevice device);

    List<BluetoothDevice> getConnectedDevices();

    List<BluetoothDevice> getDevicesMatchingConnectionStates(in int[] states);

    int getConnectionState(in BluetoothDevice device);

    BluetoothAudioConfig getAudioConfig(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(allOf={android.Manifest.permission.BLUETOOTH_CONNECT,android.Manifest.permission.BLUETOOTH_PRIVILEGED})")

    boolean setConnectionPolicy(in BluetoothDevice device, int connectionPolicy);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    int getConnectionPolicy(in BluetoothDevice device);

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)")

    boolean isA2dpPlaying(in BluetoothDevice device);

}

system/binder/android/bluetooth/IBluetoothAvrcpTarget.aidl

+1 −0
Original line number Diff line number Diff line
@@ -25,5 +25,6 @@ interface IBluetoothAvrcpTarget { 
    /**

     * @hide

     */

    @JavaPassthrough(annotation="@android.annotation.RequiresPermission(android.Manifest.permission.BLUETOOTH_CONNECT)")

    void sendVolumeChanged(in int volume);

}

system/binder/android/bluetooth/IBluetoothGatt.aidl

+55 −0

File changed.

Preview size limit exceeded, changes collapsed.