Merge "Add data size check on legacy advertising" into main (8f23095e) · Commits · e / os / android_packages_modules_Bluetooth

framework/tests/bumble/src/android/bluetooth/LeLegacyAdvertisingTest.java

0 → 100644

+173 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2024 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.bluetooth;

		import static com.google.common.truth.Truth.assertThat;

		import android.bluetooth.le.AdvertiseData;
		import android.bluetooth.le.AdvertisingSet;
		import android.bluetooth.le.AdvertisingSetCallback;
		import android.bluetooth.le.AdvertisingSetParameters;
		import android.bluetooth.le.BluetoothLeAdvertiser;
		import android.os.ParcelUuid;
		import android.platform.test.annotations.RequiresFlagsEnabled;
		import android.platform.test.flag.junit.CheckFlagsRule;
		import android.platform.test.flag.junit.DeviceFlagsValueProvider;

		import androidx.test.ext.junit.runners.AndroidJUnit4;

		import com.android.bluetooth.flags.Flags;
		import com.android.compatibility.common.util.AdoptShellPermissionsRule;

		import org.junit.Rule;
		import org.junit.Test;
		import org.junit.runner.RunWith;

		import java.util.UUID;
		import java.util.concurrent.CompletableFuture;
		import java.util.concurrent.TimeUnit;

		@RunWith(AndroidJUnit4.class)
		public class LeLegacyAdvertisingTest {
		private static final int TIMEOUT_MS = 1_000;

		@Rule public final AdoptShellPermissionsRule mPermissionRule = new AdoptShellPermissionsRule();

		@Rule
		public final CheckFlagsRule mCheckFlagsRule = DeviceFlagsValueProvider.createCheckFlagsRule();

		@RequiresFlagsEnabled(Flags.FLAG_BLE_CHECK_DATA_LENGTH_ON_LEGACY_ADVERTISING)
		@Test
		public void setAdvertisingDataOver31Bytes() throws Exception {
		final BluetoothLeAdvertiser advertiser =
		BluetoothAdapter.getDefaultAdapter().getBluetoothLeAdvertiser();

		// Set legacy scan mode
		AdvertisingSetParameters params =
		new AdvertisingSetParameters.Builder()
		.setLegacyMode(true)
		.setScannable(true)
		.setInterval(AdvertisingSetParameters.INTERVAL_HIGH)
		.setTxPowerLevel(AdvertisingSetParameters.TX_POWER_MEDIUM)
		.build();

		AdvertiseData advertiseData =
		new AdvertiseData.Builder()
		.addServiceUuid(new ParcelUuid(UUID.randomUUID()))
		.build();

		final CompletableFuture<Integer> future = new CompletableFuture<>();

		AdvertisingSetCallback callback =
		new AdvertisingSetCallback() {
		@Override
		public void onAdvertisingSetStarted(
		AdvertisingSet advertisingSet, int txPower, int status) {
		// Should be greater than 31
		int advertisingDataLengthWhichExceedsLimit = 50;
		advertisingSet.setAdvertisingData(
		createAdvertiseData(advertisingDataLengthWhichExceedsLimit));
		}

		@Override
		public void onAdvertisingDataSet(AdvertisingSet advertisingSet, int status) {
		future.complete(status);
		}
		};

		try {
		advertiser.startAdvertisingSet(params, advertiseData, null, null, null, callback);
		future.completeOnTimeout(null, TIMEOUT_MS, TimeUnit.MILLISECONDS).join();

		Integer setAdvertingDataResult = future.get();
		assertThat(setAdvertingDataResult).isNotNull();
		assertThat(setAdvertingDataResult)
		.isEqualTo(AdvertisingSetCallback.ADVERTISE_FAILED_DATA_TOO_LARGE);
		} finally {
		advertiser.stopAdvertisingSet(callback);
		}
		}

		@RequiresFlagsEnabled(Flags.FLAG_BLE_CHECK_DATA_LENGTH_ON_LEGACY_ADVERTISING)
		@Test
		public void setScanResponseDataOver31Bytes() throws Exception {
		final BluetoothLeAdvertiser advertiser =
		BluetoothAdapter.getDefaultAdapter().getBluetoothLeAdvertiser();

		// Set legacy scan mode
		AdvertisingSetParameters params =
		new AdvertisingSetParameters.Builder()
		.setLegacyMode(true)
		.setScannable(true)
		.setInterval(AdvertisingSetParameters.INTERVAL_HIGH)
		.setTxPowerLevel(AdvertisingSetParameters.TX_POWER_MEDIUM)
		.build();

		AdvertiseData advertiseData =
		new AdvertiseData.Builder()
		.addServiceUuid(new ParcelUuid(UUID.randomUUID()))
		.build();

		final CompletableFuture<Integer> future = new CompletableFuture<>();

		AdvertisingSetCallback callback =
		new AdvertisingSetCallback() {
		@Override
		public void onAdvertisingSetStarted(
		AdvertisingSet advertisingSet, int txPower, int status) {
		// Should be greater than 31
		int scanResponseDataLengthWhichExceedsLimit = 50;
		advertisingSet.setScanResponseData(
		createAdvertiseData(scanResponseDataLengthWhichExceedsLimit));
		}

		@Override
		public void onScanResponseDataSet(AdvertisingSet advertisingSet, int status) {
		future.complete(status);
		}
		};

		try {
		advertiser.startAdvertisingSet(params, advertiseData, null, null, null, callback);
		future.completeOnTimeout(null, TIMEOUT_MS, TimeUnit.MILLISECONDS).join();

		Integer setScanResponseResult = future.get();
		assertThat(setScanResponseResult).isNotNull();
		assertThat(setScanResponseResult)
		.isEqualTo(AdvertisingSetCallback.ADVERTISE_FAILED_DATA_TOO_LARGE);
		} finally {
		advertiser.stopAdvertisingSet(callback);
		}
		}

		private AdvertiseData createAdvertiseData(int length) {
		if (length <= 4) {
		return null;
		}

		// Create an arbitrary manufacturer specific data
		int manufacturerId = BluetoothAssignedNumbers.GOOGLE;
		byte[] manufacturerSpecificData = new byte[length - 4];
		for (int i = 0; i < manufacturerSpecificData.length; i++) {
		manufacturerSpecificData[i] = (byte) i;
		}

		return new AdvertiseData.Builder()
		.addManufacturerData(manufacturerId, manufacturerSpecificData)
		.build();
		}
		}

system/gd/hci/le_advertising_manager.cc

+9 −4

Original line number	Diff line number	Diff line
		@@ -79,6 +79,7 @@ struct Advertiser {
		uint16_t duration;
		uint8_t max_extended_advertising_events;
		bool started = false;
		bool is_legacy = false;
		bool connectable = false;
		bool discoverable = false;
		bool directed = false;
		@@ -793,6 +794,7 @@ struct LeAdvertisingManager::impl : public bluetooth::hci::LeAddressManagerCallb

		void set_parameters(AdvertiserId advertiser_id, AdvertisingConfig config) {
		config.tx_power = get_tx_power_after_calibration(static_cast<int8_t>(config.tx_power));
		advertising_sets_[advertiser_id].is_legacy = config.legacy_pdus;
		advertising_sets_[advertiser_id].connectable = config.connectable;
		advertising_sets_[advertiser_id].discoverable = config.discoverable;
		advertising_sets_[advertiser_id].tx_power = config.tx_power;
		@@ -1067,10 +1069,13 @@ struct LeAdvertisingManager::impl : public bluetooth::hci::LeAddressManagerCallb
		data_len += data[i].size();
		}

		if (data_len > le_maximum_advertising_data_length_) {
		log::warn(
		"advertising data len exceeds le_maximum_advertising_data_length_ {}",
		le_maximum_advertising_data_length_);
		int maxDataLength = (IS_FLAG_ENABLED(ble_check_data_length_on_legacy_advertising) &&
		advertising_sets_[advertiser_id].is_legacy)
		? kLeMaximumLegacyAdvertisingDataLength
		: le_maximum_advertising_data_length_;

		if (data_len > maxDataLength) {
		log::warn("advertising data len {} exceeds maxDataLength {}", data_len, maxDataLength);
		if (advertising_callbacks_ != nullptr) {
		if (set_scan_rsp) {
		advertising_callbacks_->OnScanResponseDataSet(

system/gd/hci/le_advertising_manager.h

+1 −0

Original line number	Diff line number	Diff line
		@@ -106,6 +106,7 @@ class LeAdvertisingManager : public bluetooth::Module {
		static constexpr AdvertiserId kInvalidId = 0xFF;
		static constexpr uint8_t kInvalidHandle = 0xFF;
		static constexpr uint8_t kAdvertisingSetIdMask = 0x0F;
		static constexpr uint16_t kLeMaximumLegacyAdvertisingDataLength = 31;
		static constexpr uint16_t kLeMaximumFragmentLength = 251;
		static constexpr uint16_t kLeMaximumPeriodicDataFragmentLength = 252;
		static constexpr uint16_t kLeMaximumGapDataLength = 255;