wifi: Use overlay to control reset SAP configration during restoring

The AOSP setting(UI) doesn't support several SAP configration.
ex: Channel selection, hidden network option, autoShutDown timer
selection etc...

Once those UI depends features config are restored from cloud.
It will causes User use wrong config and it can't modify anymore.

Bug: 159572880
Bug: 159325231
Test: atest FrameworksWifiTests
Change-Id: I7a6bf855fbb08a4808af5f166e5354f4bf67e4cd

4 files changed, 157 insertions, 33 deletions

diff --git a/service/java/com/android/server/wifi/WifiApConfigStore.java b/service/java/com/android/server/wifi/WifiApConfigStore.java
index 961cbbd3b..eb2b11245 100644
--- a/service/java/com/android/server/wifi/WifiApConfigStore.java
+++ b/service/java/com/android/server/wifi/WifiApConfigStore.java
@@ -153,10 +153,13 @@ public class WifiApConfigStore {
 
     /**
      * Returns SoftApConfiguration in which some parameters might be reset to supported default
-     * config.
+     * config since it depends on UI or HW.
      *
-     * MaxNumberOfClients and setClientControlByUserEnabled will need HAL support client force
-     * disconnect. Reset to default when device doesn't support it.
+     * MaxNumberOfClients and isClientControlByUserEnabled will need HAL support client force
+     * disconnect, and Band setting (5g/6g) need HW support.
+     *
+     * HiddenSsid, Channel, ShutdownTimeoutMillis and AutoShutdownEnabled are features
+     * which need UI(Setting) support.
      *
      * SAE/SAE-Transition need hardware support, reset to secured WPA2 security type when device
      * doesn't support it.
@@ -164,15 +167,20 @@ public class WifiApConfigStore {
     public SoftApConfiguration resetToDefaultForUnsupportedConfig(
             @NonNull SoftApConfiguration config) {
         SoftApConfiguration.Builder configBuilder = new SoftApConfiguration.Builder(config);
-        if (!ApConfigUtil.isClientForceDisconnectSupported(mContext)) {
-            configBuilder.setMaxNumberOfClients(0);
+        if ((!ApConfigUtil.isClientForceDisconnectSupported(mContext)
+                || mContext.getResources().getBoolean(
+                R.bool.config_wifiSoftapResetUserControlConfig))
+                && config.isClientControlByUserEnabled()) {
             configBuilder.setClientControlByUserEnabled(false);
-            if (config.getMaxNumberOfClients() != 0) {
-                Log.e(TAG, "Reset MaxNumberOfClients to 0 due to device doesn't support");
-            }
-            if (config.isClientControlByUserEnabled()) {
-                Log.e(TAG, "Reset ClientControlByUser to false due to device doesn't support");
-            }
+            Log.i(TAG, "Reset ClientControlByUser to false due to device doesn't support");
+        }
+
+        if ((!ApConfigUtil.isClientForceDisconnectSupported(mContext)
+                || mContext.getResources().getBoolean(
+                R.bool.config_wifiSoftapResetMaxClientSettingConfig))
+                && config.getMaxNumberOfClients() != 0) {
+            configBuilder.setMaxNumberOfClients(0);
+            Log.i(TAG, "Reset MaxNumberOfClients to 0 due to device doesn't support");
         }
 
         if (!ApConfigUtil.isWpa3SaeSupported(mContext) && (config.getSecurityType()
@@ -181,18 +189,51 @@ public class WifiApConfigStore {
                 == SoftApConfiguration.SECURITY_TYPE_WPA3_SAE_TRANSITION)) {
             configBuilder.setPassphrase(generatePassword(),
                     SoftApConfiguration.SECURITY_TYPE_WPA2_PSK);
-            Log.e(TAG, "Device doesn't support WPA3-SAE, reset config to WPA2");
+            Log.i(TAG, "Device doesn't support WPA3-SAE, reset config to WPA2");
         }
 
-        if (mContext.getResources().getBoolean(R.bool.config_wifiSoftapResetChannelConfig)) {
+        if (mContext.getResources().getBoolean(R.bool.config_wifiSoftapResetChannelConfig)
+                && config.getChannel() != 0) {
             // The device might not support customize channel or forced channel might not
             // work in some countries. Need to reset it.
-            if (config.getChannel() != 0) {
-                // Add 2.4G by default
-                configBuilder.setBand(SoftApConfiguration.BAND_2GHZ | config.getBand());
-                Log.i(TAG, "Reset SAP channel configuration");
-            }
+            // Add 2.4G by default
+            configBuilder.setBand(config.getBand() | SoftApConfiguration.BAND_2GHZ);
+            Log.i(TAG, "Reset SAP channel configuration");
+        }
+
+        int newBand = config.getBand();
+        if (!mContext.getResources().getBoolean(R.bool.config_wifi6ghzSupport)
+                && (newBand & SoftApConfiguration.BAND_6GHZ) != 0) {
+            newBand &= ~SoftApConfiguration.BAND_6GHZ;
+            Log.i(TAG, "Device doesn't support 6g, remove 6G band from band setting");
         }
+
+        if (!mContext.getResources().getBoolean(R.bool.config_wifi5ghzSupport)
+                && (newBand & SoftApConfiguration.BAND_5GHZ) != 0) {
+            newBand &= ~SoftApConfiguration.BAND_5GHZ;
+            Log.i(TAG, "Device doesn't support 5g, remove 5G band from band setting");
+        }
+
+        if (newBand != config.getBand()) {
+            // Always added 2.4G by default when reset the band.
+            Log.i(TAG, "Reset band from " + config.getBand() + " to "
+                    + (newBand | SoftApConfiguration.BAND_2GHZ));
+            configBuilder.setBand(newBand | SoftApConfiguration.BAND_2GHZ);
+        }
+
+        if (mContext.getResources().getBoolean(R.bool.config_wifiSoftapResetHiddenConfig)
+                && config.isHiddenSsid()) {
+            configBuilder.setHiddenSsid(false);
+            Log.i(TAG, "Reset SAP Hidden Network configuration");
+        }
+
+        if (mContext.getResources().getBoolean(
+                R.bool.config_wifiSoftapResetAutoShutdownTimerConfig)
+                && config.getShutdownTimeoutMillis() != 0) {
+            configBuilder.setShutdownTimeoutMillis(0);
+            Log.i(TAG, "Reset SAP auto shutdown configuration");
+        }
+
         mWifiMetrics.noteSoftApConfigReset(config, configBuilder.build());
         return configBuilder.build();
     }
diff --git a/service/res/values/config.xml b/service/res/values/config.xml
index 7e35eed19..4ea23adc0 100644
--- a/service/res/values/config.xml
+++ b/service/res/values/config.xml
@@ -133,13 +133,24 @@
          are no connected devices. -->
     <integer translatable="false" name="config_wifiFrameworkSoftApShutDownTimeoutMilliseconds">600000</integer>
 
-
     <!-- Integer indicating maximum hardware supported client number of soft ap -->
     <integer translatable="false" name="config_wifiHardwareSoftapMaxClientCount">16</integer>
 
-    <!-- boolean indicating whether reset channel configuration or not during cloud configuration restore -->
+    <!-- boolean indicating whether or not to reset channel configuration during cloud configuration restore -->
     <bool translatable="false" name ="config_wifiSoftapResetChannelConfig">true</bool>
 
+    <!-- boolean indicating whether or not to reset hiddenSsid configuration during cloud configuration restore -->
+    <bool translatable="false" name ="config_wifiSoftapResetHiddenConfig">true</bool>
+
+    <!-- boolean indicating whether or not to reset user control configuration during cloud configuration restore -->
+    <bool translatable="false" name ="config_wifiSoftapResetUserControlConfig">true</bool>
+
+    <!-- boolean indicating whether or not to reset auto shotdown configuration during cloud configuration restore -->
+    <bool translatable="false" name ="config_wifiSoftapResetAutoShutdownTimerConfig">true</bool>
+
+    <!-- boolean indicating whether or not to reset max client setting configuration during cloud configuration restore -->
+    <bool translatable="false" name ="config_wifiSoftapResetMaxClientSettingConfig">true</bool>
+
     <!-- List of allowed channels in 2GHz band for softap. If the device doesn't want to restrict
          channels this should be empty. Values is a comma separated channel string and/or channel
          range string like '1-6,11'. -->
diff --git a/service/res/values/overlayable.xml b/service/res/values/overlayable.xml
index bf96fde62..b02eb9e77 100644
--- a/service/res/values/overlayable.xml
+++ b/service/res/values/overlayable.xml
@@ -58,6 +58,10 @@
           <item type="integer" name="config_wifiFrameworkScoreGoodRssiThreshold6ghz" />
           <item type="integer" name="config_wifiFrameworkSoftApShutDownTimeoutMilliseconds" />
           <item type="bool" name="config_wifiSoftapResetChannelConfig" />
+          <item type="bool" name="config_wifiSoftapResetHiddenConfig" />
+          <item type="bool" name="config_wifiSoftapResetUserControlConfig" />
+          <item type="bool" name="config_wifiSoftapResetAutoShutdownTimerConfig" />
+          <item type="bool" name="config_wifiSoftapResetMaxClientSettingConfig" />
           <item type="string"  name="config_wifiSoftap2gChannelList" />
           <item type="string"  name="config_wifiSoftap5gChannelList" />
           <item type="string"  name="config_wifiSoftap6gChannelList" />
diff --git a/tests/wifitests/src/com/android/server/wifi/WifiApConfigStoreTest.java b/tests/wifitests/src/com/android/server/wifi/WifiApConfigStoreTest.java
index bc646c1eb..d19a4f002 100644
--- a/tests/wifitests/src/com/android/server/wifi/WifiApConfigStoreTest.java
+++ b/tests/wifitests/src/com/android/server/wifi/WifiApConfigStoreTest.java
@@ -659,24 +659,92 @@ public class WifiApConfigStoreTest extends WifiBaseTest {
 
     @Test
     public void testResetToDefaultForUnsupportedConfig() throws Exception {
-        mResources.setBoolean(R.bool.config_wifiSofapClientForceDisconnectSupported, false);
-        mResources.setBoolean(R.bool.config_wifi_softap_sae_supported, false);
-        mResources.setBoolean(R.bool.config_wifiSoftapResetChannelConfig, true);
-        SoftApConfiguration sae_config = new SoftApConfiguration.Builder()
-                .setPassphrase("secretsecret", SoftApConfiguration.SECURITY_TYPE_WPA3_SAE)
-                .setMaxNumberOfClients(10)
-                .setClientControlByUserEnabled(true)
-                .setChannel(149, SoftApConfiguration.BAND_5GHZ)
-                .build();
+        mResources.setBoolean(R.bool.config_wifiSofapClientForceDisconnectSupported, true);
+        mResources.setBoolean(R.bool.config_wifi_softap_sae_supported, true);
+        mResources.setBoolean(R.bool.config_wifi6ghzSupport, true);
+        mResources.setBoolean(R.bool.config_wifi5ghzSupport, true);
+
+        // Test all of the features support and all of the reset config are false.
+        String testPassphrase = "secretsecret";
+        SoftApConfiguration.Builder configBuilder = new SoftApConfiguration.Builder();
+        configBuilder.setPassphrase(testPassphrase, SoftApConfiguration.SECURITY_TYPE_WPA3_SAE);
         WifiApConfigStore store = createWifiApConfigStore();
+        SoftApConfiguration resetedConfig = store.resetToDefaultForUnsupportedConfig(
+                configBuilder.build());
+        assertEquals(resetedConfig, configBuilder.build());
 
-        SoftApConfiguration resetedConfig = store.resetToDefaultForUnsupportedConfig(sae_config);
-        assertEquals(resetedConfig.getMaxNumberOfClients(), 0);
-        assertFalse(resetedConfig.isClientControlByUserEnabled());
+        verify(mWifiMetrics).noteSoftApConfigReset(configBuilder.build(), resetedConfig);
+
+        // Test SAE not support case.
+        mResources.setBoolean(R.bool.config_wifi_softap_sae_supported, false);
+        resetedConfig = store.resetToDefaultForUnsupportedConfig(configBuilder.build());
+        assertEquals(resetedConfig.getSecurityType(), SoftApConfiguration.SECURITY_TYPE_WPA2_PSK);
+        // Test force channel
+        configBuilder.setChannel(149, SoftApConfiguration.BAND_5GHZ);
+        mResources.setBoolean(
+                R.bool.config_wifiSoftapResetChannelConfig, true);
+        resetedConfig = store.resetToDefaultForUnsupportedConfig(configBuilder.build());
         assertEquals(resetedConfig.getChannel(), 0);
         assertEquals(resetedConfig.getBand(),
                 SoftApConfiguration.BAND_2GHZ | SoftApConfiguration.BAND_5GHZ);
-        verify(mWifiMetrics).noteSoftApConfigReset(sae_config, resetedConfig);
+
+        // Test forced channel band doesn't support.
+        mResources.setBoolean(R.bool.config_wifi5ghzSupport, false);
+        resetedConfig = store.resetToDefaultForUnsupportedConfig(configBuilder.build());
+        assertEquals(resetedConfig.getChannel(), 0);
+        assertEquals(resetedConfig.getBand(),
+                SoftApConfiguration.BAND_2GHZ);
+
+        // Test band not support with auto channel
+        configBuilder.setBand(SoftApConfiguration.BAND_5GHZ);
+        resetedConfig = store.resetToDefaultForUnsupportedConfig(configBuilder.build());
+        assertEquals(resetedConfig.getBand(), SoftApConfiguration.BAND_2GHZ);
+
+        // Test reset hidden network
+        mResources.setBoolean(
+                R.bool.config_wifiSoftapResetHiddenConfig, true);
+        configBuilder.setHiddenSsid(true);
+        resetedConfig = store.resetToDefaultForUnsupportedConfig(configBuilder.build());
+        assertFalse(resetedConfig.isHiddenSsid());
+
+        // Test auto shutdown timer
+        mResources.setBoolean(
+                R.bool.config_wifiSoftapResetAutoShutdownTimerConfig, true);
+        configBuilder.setShutdownTimeoutMillis(8888);
+        resetedConfig = store.resetToDefaultForUnsupportedConfig(configBuilder.build());
+        assertEquals(resetedConfig.getShutdownTimeoutMillis(), 0);
+
+        // Test max client setting when force client disconnect doesn't support
+        mResources.setBoolean(R.bool.config_wifiSofapClientForceDisconnectSupported, false);
+        configBuilder.setMaxNumberOfClients(10);
+        resetedConfig = store.resetToDefaultForUnsupportedConfig(configBuilder.build());
+        assertEquals(resetedConfig.getMaxNumberOfClients(), 0);
+
+        // Test client control setting when force client disconnect doesn't support
+        mResources.setBoolean(R.bool.config_wifiSofapClientForceDisconnectSupported, false);
+        ArrayList<MacAddress> blockedClientList = new ArrayList<>();
+        blockedClientList.add(MacAddress.fromString("11:22:33:44:55:66"));
+        configBuilder.setBlockedClientList(blockedClientList);
+
+        configBuilder.setClientControlByUserEnabled(true);
+        resetedConfig = store.resetToDefaultForUnsupportedConfig(configBuilder.build());
+        assertFalse(resetedConfig.isClientControlByUserEnabled());
+        // The blocked list still keep
+        assertEquals(resetedConfig.getBlockedClientList(), blockedClientList);
+
+        // Test max client setting when reset enabled but force client disconnect supported
+        mResources.setBoolean(R.bool.config_wifiSofapClientForceDisconnectSupported, true);
+        mResources.setBoolean(
+                R.bool.config_wifiSoftapResetMaxClientSettingConfig, true);
+        assertEquals(resetedConfig.getMaxNumberOfClients(), 0);
+
+        // Test client control setting when reset enabled but force client disconnect supported
+        mResources.setBoolean(R.bool.config_wifiSofapClientForceDisconnectSupported, true);
+        mResources.setBoolean(
+                R.bool.config_wifiSoftapResetUserControlConfig, true);
+        resetedConfig = store.resetToDefaultForUnsupportedConfig(configBuilder.build());
+        assertFalse(resetedConfig.isClientControlByUserEnabled());
+        assertEquals(resetedConfig.getBlockedClientList(), blockedClientList);
     }
 
     /**