/*
* Copyright (C) 2018 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 com.android.server.wifi;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import android.net.wifi.EAPConstants;
import android.net.wifi.WifiConfiguration;
import android.net.wifi.WifiNetworkSuggestion;
import android.net.wifi.hotspot2.PasspointConfiguration;
import android.net.wifi.hotspot2.pps.Credential;
import android.net.wifi.hotspot2.pps.HomeSp;
import android.util.Xml;
import androidx.test.filters.SmallTest;
import com.android.internal.util.FastXmlSerializer;
import com.android.server.wifi.WifiNetworkSuggestionsManager.ExtendedWifiNetworkSuggestion;
import com.android.server.wifi.WifiNetworkSuggestionsManager.PerAppInfo;
import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlSerializer;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
/**
* Unit tests for {@link com.android.server.wifi.NetworkSuggestionStoreData}.
*/
@SmallTest
public class NetworkSuggestionStoreDataTest extends WifiBaseTest {
private static final int TEST_UID_1 = 14556;
private static final int TEST_UID_2 = 14536;
private static final String TEST_PACKAGE_NAME_1 = "com.android.test.1";
private static final String TEST_PACKAGE_NAME_2 = "com.android.test.2";
private static final String TEST_FEATURE_ID = "com.android.feature.1";
private static final String TEST_FQDN = "FQDN";
private static final String TEST_FRIENDLY_NAME = "test_friendly_name";
private static final String TEST_REALM = "realm.test.com";
private static final String USER_CONNECT_CHOICE = "SomeNetworkProfileId";
private static final int TEST_RSSI = -50;
private static final int TEST_PRIORITY_GROUP =
WifiNetworkSuggestionsManager.DEFAULT_PRIORITY_GROUP;
private static final String TEST_PRE_R_STORE_FORMAT_XML_STRING =
"\n"
+ "%1$s\n"
+ "com.android.feature.1\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ ""WifiConfigurationTestSSID0""
+ "WPA_PSK\n"
+ ""WifiConfigurationTestSSID0"\n"
+ "\n"
+ ""WifiConfigurationTestUtilPsk""
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "02\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "02:00:00:00:00:00\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "%1$s\n"
+ "\n"
+ "";
private static final String TEST_POST_R_STORE_FORMAT_XML_STRING =
"\n"
+ "%1$s\n"
+ "com.android.feature.1\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ ""WifiConfigurationTestSSID0""
+ "WPA_PSK\n"
+ ""WifiConfigurationTestSSID0"\n"
+ "\n"
+ ""WifiConfigurationTestUtilPsk""
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "02\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "02:00:00:00:00:00\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "";
private static final String TEST_CORRUPT_DATA_INVALID_SSID =
"\n"
+ "com.android.test.1\n"
+ "\n"
+ "\n"
+ "\n"
+ ""WifiConfigurationTestUtilSSID7"NONE\n"
+ ""WifiConfigurationTestUtilSSID7"\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "01\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "02:00:00:00:00:00\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "\n"
+ "";
private static final String TEST_POST_R_APP_WITH_EMPTY_SUGGESTION =
"\n"
+ "%1$s\n"
+ "com.android.feature.1\n"
+ "\n"
+ "\n"
+ "\n"
+ "";
private static final String TEST_PRE_R_APP_WITH_EMPTY_SUGGESTION =
"\n"
+ "%1$s\n"
+ "com.android.feature.1\n"
+ "\n"
+ "\n"
+ "";
private @Mock NetworkSuggestionStoreData.DataSource mDataSource;
private NetworkSuggestionStoreData mNetworkSuggestionStoreData;
@Before
public void setUp() throws Exception {
MockitoAnnotations.initMocks(this);
mNetworkSuggestionStoreData = new NetworkSuggestionStoreData(mDataSource);
}
/**
* Helper function for serializing configuration data to a XML block.
*/
private byte[] serializeData() throws Exception {
final XmlSerializer out = new FastXmlSerializer();
final ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
out.setOutput(outputStream, StandardCharsets.UTF_8.name());
mNetworkSuggestionStoreData.serializeData(out, null);
out.flush();
return outputStream.toByteArray();
}
/**
* Helper function for parsing configuration data from a XML block.
*/
private void deserializeData(byte[] data) throws Exception {
final XmlPullParser in = Xml.newPullParser();
final ByteArrayInputStream inputStream = new ByteArrayInputStream(data);
in.setInput(inputStream, StandardCharsets.UTF_8.name());
mNetworkSuggestionStoreData.deserializeData(in, in.getDepth(),
WifiConfigStore.ENCRYPT_CREDENTIALS_CONFIG_STORE_DATA_VERSION, null);
}
/**
* Verify store file Id.
*/
@Test
public void verifyStoreFileId() throws Exception {
assertEquals(WifiConfigStore.STORE_FILE_USER_NETWORK_SUGGESTIONS,
mNetworkSuggestionStoreData.getStoreFileId());
}
/**
* Serialize/Deserialize a single network suggestion from a single app.
*/
@Test
public void serializeDeserializeSingleNetworkSuggestionFromSingleApp() throws Exception {
Map networkSuggestionsMap = new HashMap<>();
PerAppInfo appInfo = new PerAppInfo(TEST_UID_1, TEST_PACKAGE_NAME_1, TEST_FEATURE_ID);
WifiConfiguration configuration = WifiConfigurationTestUtil.createEapNetwork();
configuration.enterpriseConfig =
WifiConfigurationTestUtil.createPEAPWifiEnterpriseConfigWithGTCPhase2();
configuration.priority = 5;
WifiNetworkSuggestion networkSuggestion =
new WifiNetworkSuggestion(configuration, null, false, false, true, true,
TEST_PRIORITY_GROUP);
appInfo.hasUserApproved = false;
ExtendedWifiNetworkSuggestion ewns = ExtendedWifiNetworkSuggestion
.fromWns(networkSuggestion, appInfo, true);
ewns.connectChoice = USER_CONNECT_CHOICE;
ewns.connectChoiceRssi = TEST_RSSI;
appInfo.extNetworkSuggestions.put(ewns.hashCode(), ewns);
networkSuggestionsMap.put(TEST_PACKAGE_NAME_1, appInfo);
Map deserializedPerAppInfoMap =
assertSerializeDeserialize(networkSuggestionsMap);
ExtendedWifiNetworkSuggestion deserializedSuggestion =
deserializedPerAppInfoMap.get(TEST_PACKAGE_NAME_1).extNetworkSuggestions.values()
.stream()
.findAny()
.orElse(null);
WifiConfigurationTestUtil.assertConfigurationEqual(
configuration, deserializedSuggestion.wns.wifiConfiguration);
WifiConfigurationTestUtil.assertWifiEnterpriseConfigEqualForConfigStore(
configuration.enterpriseConfig,
deserializedSuggestion.wns.wifiConfiguration.enterpriseConfig);
assertEquals(USER_CONNECT_CHOICE, deserializedSuggestion.connectChoice);
assertEquals(TEST_RSSI, deserializedSuggestion.connectChoiceRssi);
}
/**
* Serialize/Deserialize a single network suggestion from multiple apps.
*/
@Test
public void serializeDeserializeSingleNetworkSuggestionFromMultipleApps() throws Exception {
Map networkSuggestionsMap = new HashMap<>();
PerAppInfo appInfo1 = new PerAppInfo(TEST_UID_1, TEST_PACKAGE_NAME_1, TEST_FEATURE_ID);
WifiNetworkSuggestion networkSuggestion1 = new WifiNetworkSuggestion(
WifiConfigurationTestUtil.createOpenNetwork(), null, false, false, true, true,
TEST_PRIORITY_GROUP);
appInfo1.hasUserApproved = false;
ExtendedWifiNetworkSuggestion ewns =
ExtendedWifiNetworkSuggestion.fromWns(networkSuggestion1, appInfo1, true);
appInfo1.extNetworkSuggestions.put(ewns.hashCode(), ewns);
networkSuggestionsMap.put(TEST_PACKAGE_NAME_1, appInfo1);
PerAppInfo appInfo2 = new PerAppInfo(TEST_UID_2, TEST_PACKAGE_NAME_2, TEST_FEATURE_ID);
WifiNetworkSuggestion networkSuggestion2 = new WifiNetworkSuggestion(
WifiConfigurationTestUtil.createOpenNetwork(), null, true, false, true, true,
TEST_PRIORITY_GROUP);
appInfo2.hasUserApproved = true;
ExtendedWifiNetworkSuggestion ewns2 =
ExtendedWifiNetworkSuggestion.fromWns(networkSuggestion2, appInfo2, true);
appInfo2.extNetworkSuggestions.put(ewns2.hashCode(), ewns2);
networkSuggestionsMap.put(TEST_PACKAGE_NAME_2, appInfo2);
assertSerializeDeserialize(networkSuggestionsMap);
}
/**
* Serialize/Deserialize multiple network suggestion from multiple apps.
*/
@Test
public void serializeDeserializeMultipleNetworkSuggestionFromMultipleApps() throws Exception {
Map networkSuggestionsMap = new HashMap<>();
PerAppInfo appInfo1 = new PerAppInfo(TEST_UID_1, TEST_PACKAGE_NAME_1, TEST_FEATURE_ID);
WifiNetworkSuggestion networkSuggestion1 = new WifiNetworkSuggestion(
WifiConfigurationTestUtil.createOpenNetwork(), null, false, true, true, true,
TEST_PRIORITY_GROUP);
WifiNetworkSuggestion networkSuggestion2 = new WifiNetworkSuggestion(
WifiConfigurationTestUtil.createOpenNetwork(), null, true, false, true, true,
TEST_PRIORITY_GROUP);
appInfo1.hasUserApproved = true;
ExtendedWifiNetworkSuggestion ewns1 =
ExtendedWifiNetworkSuggestion.fromWns(networkSuggestion1, appInfo1, true);
appInfo1.extNetworkSuggestions.put(ewns1.hashCode(), ewns1);
ExtendedWifiNetworkSuggestion ewns2 =
ExtendedWifiNetworkSuggestion.fromWns(networkSuggestion2, appInfo1, true);
appInfo1.extNetworkSuggestions.put(ewns2.hashCode(), ewns2);
networkSuggestionsMap.put(TEST_PACKAGE_NAME_1, appInfo1);
PerAppInfo appInfo2 = new PerAppInfo(TEST_UID_2, TEST_PACKAGE_NAME_2, TEST_FEATURE_ID);
WifiNetworkSuggestion networkSuggestion3 = new WifiNetworkSuggestion(
WifiConfigurationTestUtil.createOpenNetwork(), null, true, false, true, true,
TEST_PRIORITY_GROUP);
WifiNetworkSuggestion networkSuggestion4 = new WifiNetworkSuggestion(
WifiConfigurationTestUtil.createOpenNetwork(), null, false, true, true, true,
TEST_PRIORITY_GROUP);
appInfo2.hasUserApproved = true;
ExtendedWifiNetworkSuggestion ewns3 =
ExtendedWifiNetworkSuggestion.fromWns(networkSuggestion3, appInfo2, true);
appInfo2.extNetworkSuggestions.put(ewns3.hashCode(), ewns3);
ExtendedWifiNetworkSuggestion ewns4 =
ExtendedWifiNetworkSuggestion.fromWns(networkSuggestion4, appInfo2, true);
appInfo2.extNetworkSuggestions.put(ewns4.hashCode(), ewns4);
networkSuggestionsMap.put(TEST_PACKAGE_NAME_2, appInfo2);
assertSerializeDeserialize(networkSuggestionsMap);
}
/**
* Deserialize corrupt data and ensure that we gracefully handle any errors in the data.
*/
@Test
public void deserializeCorruptData() throws Exception {
deserializeData(TEST_CORRUPT_DATA_INVALID_SSID.getBytes());
}
/**
* Deserialize a single network suggestion from a single app using a predefined string
* stored in the old/new XML format.
*/
@Test
public void deserializeFromPreRAndPostRFormat() throws Exception {
ArgumentCaptor deserializedNetworkSuggestionsMap =
ArgumentCaptor.forClass(HashMap.class);
// Old format
String preRFormatXml = String.format(
TEST_PRE_R_STORE_FORMAT_XML_STRING, TEST_PACKAGE_NAME_1, TEST_UID_1);
deserializeData(preRFormatXml.getBytes());
// New format
String postRFormatXml = String.format(
TEST_POST_R_STORE_FORMAT_XML_STRING, TEST_PACKAGE_NAME_1, TEST_UID_1);
deserializeData(postRFormatXml.getBytes());
// Capture the deserialized data.
verify(mDataSource, times(2)).fromDeserialized(deserializedNetworkSuggestionsMap.capture());
Map deserializedPerAppInfoMapPreRFormat =
deserializedNetworkSuggestionsMap.getAllValues().get(0);
Map deserializedPerAppInfoMapPostRFormat =
deserializedNetworkSuggestionsMap.getAllValues().get(1);
// Ensure both formats produce the same parsed output.
assertEquals(deserializedPerAppInfoMapPreRFormat, deserializedPerAppInfoMapPostRFormat);
}
/**
* Deserialize no network suggestion from a single app using a predefined string stored in the
* old/new XML format.
*/
@Test
public void deserializeEmptySuggestion() throws Exception {
ArgumentCaptor deserializedNetworkSuggestionsMap =
ArgumentCaptor.forClass(HashMap.class);
// Old format with empty suggestion
String preRFormatXml = String.format(
TEST_PRE_R_APP_WITH_EMPTY_SUGGESTION, TEST_PACKAGE_NAME_1);
deserializeData(preRFormatXml.getBytes());
// New format with empty suggestion
String postRFormatXml = String.format(
TEST_POST_R_APP_WITH_EMPTY_SUGGESTION, TEST_PACKAGE_NAME_1, TEST_UID_1);
deserializeData(postRFormatXml.getBytes());
// Capture the deserialized data.
verify(mDataSource, times(2)).fromDeserialized(deserializedNetworkSuggestionsMap.capture());
Map deserializedPerAppInfoMapPreRFormat =
deserializedNetworkSuggestionsMap.getAllValues().get(0);
Map deserializedPerAppInfoMapPostRFormat =
deserializedNetworkSuggestionsMap.getAllValues().get(1);
// Verify PerAppInfo is no
assertNotNull(deserializedPerAppInfoMapPreRFormat.get(TEST_PACKAGE_NAME_1));
assertNotNull(deserializedPerAppInfoMapPostRFormat.get(TEST_PACKAGE_NAME_1));
}
/**
* Serialize/Deserialize a single Passpoint network suggestion from a single app.
*/
@Test
public void serializeDeserializeSinglePasspointSuggestionFromSingleApp() throws Exception {
Map networkSuggestionsMap = new HashMap<>();
PerAppInfo appInfo = new PerAppInfo(TEST_UID_1, TEST_PACKAGE_NAME_1, TEST_FEATURE_ID);
WifiNetworkSuggestion.Builder builder = new WifiNetworkSuggestion.Builder();
builder.setPasspointConfig(
createTestConfigWithUserCredential(TEST_FQDN, TEST_FRIENDLY_NAME));
WifiNetworkSuggestion networkSuggestion = builder.build();
appInfo.hasUserApproved = false;
ExtendedWifiNetworkSuggestion ewns =
ExtendedWifiNetworkSuggestion.fromWns(networkSuggestion, appInfo, true);
appInfo.extNetworkSuggestions.put(ewns.hashCode(), ewns);
networkSuggestionsMap.put(TEST_PACKAGE_NAME_1, appInfo);
Map deserializedPerAppInfoMap =
assertSerializeDeserialize(networkSuggestionsMap);
ExtendedWifiNetworkSuggestion deserializedSuggestion =
deserializedPerAppInfoMap.get(TEST_PACKAGE_NAME_1).extNetworkSuggestions.values()
.stream()
.findAny()
.orElse(null);
assertEquals(networkSuggestion, deserializedSuggestion.wns);
}
@Test
public void testDeserializeNullData() throws Exception {
mNetworkSuggestionStoreData.deserializeData(null, 0,
WifiConfigStore.ENCRYPT_CREDENTIALS_CONFIG_STORE_DATA_VERSION, null);
verify(mDataSource).fromDeserialized(any());
}
private Map assertSerializeDeserialize(
Map networkSuggestionsMap) throws Exception {
// Setup the data to serialize.
when(mDataSource.toSerialize()).thenReturn(networkSuggestionsMap);
// Serialize/deserialize data.
deserializeData(serializeData());
// Verify the deserialized data.
ArgumentCaptor deserializedNetworkSuggestionsMap =
ArgumentCaptor.forClass(HashMap.class);
verify(mDataSource).fromDeserialized(deserializedNetworkSuggestionsMap.capture());
assertEquals(networkSuggestionsMap, deserializedNetworkSuggestionsMap.getValue());
return deserializedNetworkSuggestionsMap.getValue();
}
private PasspointConfiguration createTestConfigWithUserCredential(String fqdn,
String friendlyName) {
PasspointConfiguration config = new PasspointConfiguration();
HomeSp homeSp = new HomeSp();
homeSp.setFqdn(fqdn);
homeSp.setFriendlyName(friendlyName);
config.setHomeSp(homeSp);
Credential credential = new Credential();
credential.setRealm(TEST_REALM);
credential.setCaCertificate(FakeKeys.CA_CERT0);
Credential.UserCredential userCredential = new Credential.UserCredential();
userCredential.setUsername("username");
userCredential.setPassword("password");
userCredential.setEapType(EAPConstants.EAP_TTLS);
userCredential.setNonEapInnerMethod(Credential.UserCredential.AUTH_METHOD_MSCHAP);
credential.setUserCredential(userCredential);
config.setCredential(credential);
return config;
}
}