Mark networks with captive portal status
The goal of this is to eventually enable enhanced randomization by
default on saved open netoworks that do not depend on captive portal.
For new networks, isCaptivePortalNeverDetected should be true until a
captive portal shows up.
For networks that already exist at the upgrade,
isCaptivePortalNeverDetected should be false because there might be a
captive portal that showed up before the upgrade is made.
Bug: 162801581
Test: atest com.android.server.wifi
Test: manual verification of logs.
Change-Id: I3c874078d15228d19d1e611c2aa0409f5d571461
diff --git a/service/java/com/android/server/wifi/ClientModeImpl.java b/service/java/com/android/server/wifi/ClientModeImpl.java
index 8732477..32a7082 100644
--- a/service/java/com/android/server/wifi/ClientModeImpl.java
+++ b/service/java/com/android/server/wifi/ClientModeImpl.java
@@ -3761,6 +3761,11 @@
mWifiMetrics.logStaEvent(mInterfaceName, StaEvent.TYPE_NETWORK_AGENT_VALID_NETWORK);
doNetworkStatus(status);
}
+ if (redirectUri != null && redirectUri.toString() != null
+ && redirectUri.toString().length() > 0) {
+ mWifiThreadRunner.post(() ->
+ mWifiConfigManager.noteCaptivePortalDetected(mWifiInfo.getNetworkId()));
+ }
}
@Override
diff --git a/service/java/com/android/server/wifi/WifiConfigManager.java b/service/java/com/android/server/wifi/WifiConfigManager.java
index a6bba9a..68e9240 100644
--- a/service/java/com/android/server/wifi/WifiConfigManager.java
+++ b/service/java/com/android/server/wifi/WifiConfigManager.java
@@ -2059,6 +2059,17 @@
}
/**
+ * Set captive portal to be detected for this network.
+ * @param networkId
+ */
+ public void noteCaptivePortalDetected(int networkId) {
+ WifiConfiguration config = getInternalConfiguredNetwork(networkId);
+ if (config != null) {
+ config.getNetworkSelectionStatus().setHasNeverDetectedCaptivePortal(false);
+ }
+ }
+
+ /**
* Updates a network configuration after disconnection from it.
*
* This method updates the following WifiConfiguration elements:
diff --git a/service/java/com/android/server/wifi/util/XmlUtil.java b/service/java/com/android/server/wifi/util/XmlUtil.java
index aca7b7d..091a141 100644
--- a/service/java/com/android/server/wifi/util/XmlUtil.java
+++ b/service/java/com/android/server/wifi/util/XmlUtil.java
@@ -1021,6 +1021,8 @@
public static final String XML_TAG_DISABLE_REASON = "DisableReason";
public static final String XML_TAG_CONNECT_CHOICE = "ConnectChoice";
public static final String XML_TAG_HAS_EVER_CONNECTED = "HasEverConnected";
+ public static final String XML_TAG_IS_CAPTIVE_PORTAL_NEVER_DETECTED =
+ "CaptivePortalNeverDetected";
/**
* Write the NetworkSelectionStatus data elements from the provided status to the XML
@@ -1039,6 +1041,8 @@
XmlUtil.writeNextValue(out, XML_TAG_CONNECT_CHOICE, selectionStatus.getConnectChoice());
XmlUtil.writeNextValue(
out, XML_TAG_HAS_EVER_CONNECTED, selectionStatus.hasEverConnected());
+ XmlUtil.writeNextValue(out, XML_TAG_IS_CAPTIVE_PORTAL_NEVER_DETECTED,
+ selectionStatus.hasNeverDetectedCaptivePortal());
}
/**
@@ -1054,6 +1058,9 @@
NetworkSelectionStatus selectionStatus = new NetworkSelectionStatus();
String statusString = "";
String disableReasonString = "";
+ // Initialize hasNeverDetectedCaptivePortal to "false" for upgrading legacy configs
+ // which do not have the XML_TAG_IS_CAPTIVE_PORTAL_NEVER_DETECTED tag.
+ selectionStatus.setHasNeverDetectedCaptivePortal(false);
// Loop through and parse out all the elements from the stream within this section.
while (!XmlUtil.isNextSectionEnd(in, outerTagDepth)) {
@@ -1075,6 +1082,8 @@
case XML_TAG_HAS_EVER_CONNECTED:
selectionStatus.setHasEverConnected((boolean) value);
break;
+ case XML_TAG_IS_CAPTIVE_PORTAL_NEVER_DETECTED:
+ selectionStatus.setHasNeverDetectedCaptivePortal((boolean) value);
default:
Log.w(TAG, "Ignoring unknown value name found: " + valueName[0]);
break;
diff --git a/service/tests/wifitests/src/com/android/server/wifi/NetworkListStoreDataTest.java b/service/tests/wifitests/src/com/android/server/wifi/NetworkListStoreDataTest.java
index 31bd8d4..f3585be 100644
--- a/service/tests/wifitests/src/com/android/server/wifi/NetworkListStoreDataTest.java
+++ b/service/tests/wifitests/src/com/android/server/wifi/NetworkListStoreDataTest.java
@@ -113,6 +113,7 @@
+ "<string name=\"DisableReason\">NETWORK_SELECTION_ENABLE</string>\n"
+ "<null name=\"ConnectChoice\" />\n"
+ "<boolean name=\"HasEverConnected\" value=\"false\" />\n"
+ + "<boolean name=\"CaptivePortalNeverDetected\" value=\"true\" />\n"
+ "</NetworkStatus>\n"
+ "<IpConfiguration>\n"
+ "<string name=\"IpAssignment\">DHCP</string>\n"
@@ -170,6 +171,7 @@
+ "<string name=\"DisableReason\">NETWORK_SELECTION_ENABLE</string>\n"
+ "<null name=\"ConnectChoice\" />\n"
+ "<boolean name=\"HasEverConnected\" value=\"false\" />\n"
+ + "<boolean name=\"CaptivePortalNeverDetected\" value=\"true\" />\n"
+ "</NetworkStatus>\n"
+ "<IpConfiguration>\n"
+ "<string name=\"IpAssignment\">DHCP</string>\n"
@@ -248,6 +250,7 @@
+ "<string name=\"DisableReason\">NETWORK_SELECTION_ENABLE</string>\n"
+ "<null name=\"ConnectChoice\" />\n"
+ "<boolean name=\"HasEverConnected\" value=\"false\" />\n"
+ + "<boolean name=\"CaptivePortalNeverDetected\" value=\"true\" />\n"
+ "</NetworkStatus>\n"
+ "<IpConfiguration>\n"
+ "<string name=\"IpAssignment\">DHCP</string>\n"
@@ -310,6 +313,7 @@
+ "<string name=\"DisableReason\">NETWORK_SELECTION_ENABLE</string>\n"
+ "<null name=\"ConnectChoice\" />\n"
+ "<boolean name=\"HasEverConnected\" value=\"false\" />\n"
+ + "<boolean name=\"CaptivePortalNeverDetected\" value=\"true\" />\n"
+ "</NetworkStatus>\n"
+ "<IpConfiguration>\n"
+ "<string name=\"IpAssignment\">UNASSIGNED</string>\n"
@@ -544,6 +548,7 @@
+ "<string name=\"DisableReason\">NETWORK_SELECTION_ENABLE</string>\n"
+ "<null name=\"ConnectChoice\" />\n"
+ "<boolean name=\"HasEverConnected\" value=\"false\" />\n"
+ + "<boolean name=\"CaptivePortalNeverDetected\" value=\"true\" />\n"
+ "</NetworkStatus>\n"
+ "<IpConfiguration>\n"
+ "<string name=\"IpAssignment\">DHCP</string>\n"
diff --git a/service/tests/wifitests/src/com/android/server/wifi/WifiConfigManagerTest.java b/service/tests/wifitests/src/com/android/server/wifi/WifiConfigManagerTest.java
index 59f7dde..86e0273 100644
--- a/service/tests/wifitests/src/com/android/server/wifi/WifiConfigManagerTest.java
+++ b/service/tests/wifitests/src/com/android/server/wifi/WifiConfigManagerTest.java
@@ -3420,6 +3420,23 @@
}
/**
+ * Verify that hasNeverDetectedCaptivePortal is set to false after noteCaptivePortalDetected
+ * gets called.
+ */
+ @Test
+ public void testNoteCaptivePortalDetected() {
+ WifiConfiguration openNetwork = WifiConfigurationTestUtil.createOpenNetwork();
+ NetworkUpdateResult result = verifyAddNetworkToWifiConfigManager(openNetwork);
+
+ assertTrue(mWifiConfigManager.getConfiguredNetworks().get(0).getNetworkSelectionStatus()
+ .hasNeverDetectedCaptivePortal());
+
+ mWifiConfigManager.noteCaptivePortalDetected(openNetwork.networkId);
+ assertFalse(mWifiConfigManager.getConfiguredNetworks().get(0).getNetworkSelectionStatus()
+ .hasNeverDetectedCaptivePortal());
+ }
+
+ /**
* Verifies the foreground user unlock via {@link WifiConfigManager#handleUserUnlock(int)}
* results in a store read after bootup.
*/
diff --git a/service/tests/wifitests/src/com/android/server/wifi/WifiConfigStoreTest.java b/service/tests/wifitests/src/com/android/server/wifi/WifiConfigStoreTest.java
index 6e8e5c5..8da03a6 100644
--- a/service/tests/wifitests/src/com/android/server/wifi/WifiConfigStoreTest.java
+++ b/service/tests/wifitests/src/com/android/server/wifi/WifiConfigStoreTest.java
@@ -127,6 +127,7 @@
+ "<string name=\"DisableReason\">NETWORK_SELECTION_ENABLE</string>\n"
+ "<null name=\"ConnectChoice\" />\n"
+ "<boolean name=\"HasEverConnected\" value=\"false\" />\n"
+ + "<boolean name=\"CaptivePortalNeverDetected\" value=\"true\" />\n"
+ "</NetworkStatus>\n"
+ "<IpConfiguration>\n"
+ "<string name=\"IpAssignment\">DHCP</string>\n"
diff --git a/service/tests/wifitests/src/com/android/server/wifi/util/XmlUtilTest.java b/service/tests/wifitests/src/com/android/server/wifi/util/XmlUtilTest.java
index aabb5f8..d3ca051 100644
--- a/service/tests/wifitests/src/com/android/server/wifi/util/XmlUtilTest.java
+++ b/service/tests/wifitests/src/com/android/server/wifi/util/XmlUtilTest.java
@@ -502,6 +502,30 @@
}
/**
+ * Verify that when XML_TAG_IS_CAPTIVE_PORTAL_NEVER_DETECTED is not found in the XML file, the
+ * corresponding field defaults to false.
+ * @throws IOException
+ * @throws XmlPullParserException
+ */
+ @Test
+ public void testCaptivePortalNeverDetected_DefaultToFalse()
+ throws IOException, XmlPullParserException {
+ // First generate XML data that only has the header filled in
+ final XmlSerializer out = new FastXmlSerializer();
+ final ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+ out.setOutput(outputStream, StandardCharsets.UTF_8.name());
+ XmlUtil.writeDocumentStart(out, mXmlDocHeader);
+ XmlUtil.writeDocumentEnd(out, mXmlDocHeader);
+
+ // Deserialize the data
+ NetworkSelectionStatus retrieved =
+ deserializeNetworkSelectionStatus(outputStream.toByteArray());
+
+ // Verify that hasNeverDetectedCaptivePortal returns false.
+ assertFalse(retrieved.hasNeverDetectedCaptivePortal());
+ }
+
+ /**
* Verify that when the macRandomizationSetting field is not found in the XML file,
* macRandomizationSetting is defaulted to RANDOMIZATION_NONE.
* @throws IOException
