From 5bf4e1ec4f878e64427ebdcddbd1b00a87ddd7c3 Mon Sep 17 00:00:00 2001
From: Ruchi Kandoi <kandoiruchi@google.com>
Date: Thu, 17 Jan 2019 15:31:02 -0800
Subject: [PATCH] Add Secure NFC functionality

Secure NFC will permit NFC acitvity only when screen
is unlocked.

Bug: 117253725
Test: Manual; Toggle switch; check if HCE works with screen off
Change-Id: I9977d85065fc7ebca3ed4991ffa52fef0590cf90
---
 res/values/strings.xml                        |  7 +-
 res/xml/connected_devices_advanced.xml        |  8 ++
 .../settings/nfc/AndroidBeamEnabler.java      |  2 +-
 .../settings/nfc/SecureNfcEnabler.java        | 60 +++++++++++
 .../nfc/SecureNfcPreferenceController.java    | 99 +++++++++++++++++++
 ...dConnectedDeviceDashboardFragmentTest.java | 14 ++-
 6 files changed, 187 insertions(+), 3 deletions(-)
 create mode 100644 src/com/android/settings/nfc/SecureNfcEnabler.java
 create mode 100644 src/com/android/settings/nfc/SecureNfcPreferenceController.java

diff --git a/res/values/strings.xml b/res/values/strings.xml
index f77c10d577c..9576c1482b7 100644
--- a/res/values/strings.xml
+++ b/res/values/strings.xml
@@ -1859,6 +1859,11 @@
     <!-- Dialog content for NFC disclaimer: telling user NFC can exchange data when device is nearby other devices (for example: payment terminals, badge reader etc). [CHAR_LIMIT=NONE]-->
     <string name="nfc_disclaimer_content">NFC exchanges data between this device and other nearby devices or targets, such as payment terminals, access readers, and interactive ads or tags.</string>
 
+    <!-- Used in the settings screen to secure NFC [CHAR LIMIT=NONE] -->
+    <string name="nfc_secure_settings_title">Secure NFC</string>
+    <!-- Description of Secure NFC in the 1st level settings screen. [CHAR LIMIT=NONE] -->
+    <string name="nfc_secure_toggle_summary" product="default">Allow NFC Payment and Transit use only when screen is unlocked</string>
+
     <!-- Used to enter the Android Beam sharing preferences screen. This phrase is a trademark. [CHAR LIMIT=32] -->
     <string name="android_beam_settings_title">Android Beam</string>
     <!-- Used to describe the on state of the Android Beam feature [CHAR LIMIT=NONE] -->
@@ -1866,7 +1871,7 @@
     <!-- Used to describe the off state of the Android Beam feature [CHAR LIMIT=NONE] -->
     <string name="android_beam_off_summary">Off</string>
     <!-- Used to describe the enabled state of the Android Beam feature when NFC, which it relies on, is turned off [CHAR LIMIT=NONE] -->
-    <string name="android_beam_disabled_summary">Unavailable because NFC is turned off</string>
+    <string name="nfc_disabled_summary">Unavailable because NFC is turned off</string>
     <!-- Used in the Android Beam sharing preferences screen. This phrase is a trademark. [CHAR LIMIT=32] -->
     <string name="android_beam_label">Android Beam</string>
     <!-- Explanation of the Android Beam feature in the Android Beam settings panel. The use of "beam" here is as a verb and not considered trademarked. [CHAR LIMIT=NONE] -->
diff --git a/res/xml/connected_devices_advanced.xml b/res/xml/connected_devices_advanced.xml
index b5d2a999e4b..2ceceb384f0 100644
--- a/res/xml/connected_devices_advanced.xml
+++ b/res/xml/connected_devices_advanced.xml
@@ -44,6 +44,14 @@
         android:icon="@drawable/ic_android"
         android:order="-6"/>
 
+    <SwitchPreference
+        android:key="nfc_secure_settings"
+        android:title="@string/nfc_secure_settings_title"
+        settings:controller="com.android.settings.nfc.SecureNfcPreferenceController"
+        android:icon="@drawable/ic_nfc"
+        android:summary="@string/nfc_secure_toggle_summary"
+        android:order="-7"/>
+
     <com.android.settingslib.RestrictedPreference
         android:key="connected_device_printing"
         android:title="@string/print_settings"
diff --git a/src/com/android/settings/nfc/AndroidBeamEnabler.java b/src/com/android/settings/nfc/AndroidBeamEnabler.java
index 4dda2fd42b1..31ef7028eeb 100644
--- a/src/com/android/settings/nfc/AndroidBeamEnabler.java
+++ b/src/com/android/settings/nfc/AndroidBeamEnabler.java
@@ -53,7 +53,7 @@ public class AndroidBeamEnabler extends BaseNfcEnabler {
         switch (newState) {
             case NfcAdapter.STATE_OFF:
                 mPreference.setEnabled(false);
-                mPreference.setSummary(R.string.android_beam_disabled_summary);
+                mPreference.setSummary(R.string.nfc_disabled_summary);
                 break;
             case NfcAdapter.STATE_ON:
                 if (mBeamDisallowedBySystem) {
diff --git a/src/com/android/settings/nfc/SecureNfcEnabler.java b/src/com/android/settings/nfc/SecureNfcEnabler.java
new file mode 100644
index 00000000000..065dc8b6a23
--- /dev/null
+++ b/src/com/android/settings/nfc/SecureNfcEnabler.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2019 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.settings.nfc;
+
+import android.content.Context;
+import android.nfc.NfcAdapter;
+import android.provider.Settings;
+
+import androidx.annotation.VisibleForTesting;
+import androidx.preference.SwitchPreference;
+
+import com.android.settings.R;
+
+/**
+ * SecureNfcEnabler is a helper to manage the Secure Nfc on/off checkbox preference
+ * It turns on/off Secure NFC and ensures the summary of the preference reflects
+ * the current state.
+ */
+public class SecureNfcEnabler extends BaseNfcEnabler {
+    private final SwitchPreference mPreference;
+
+    public SecureNfcEnabler(Context context, SwitchPreference preference) {
+        super(context);
+        mPreference = preference;
+    }
+
+    @Override
+    protected void handleNfcStateChanged(int newState) {
+        switch (newState) {
+            case NfcAdapter.STATE_OFF:
+                mPreference.setSummary(R.string.nfc_disabled_summary);
+                mPreference.setEnabled(false);
+                break;
+            case NfcAdapter.STATE_ON:
+                mPreference.setChecked(mPreference.isEnabled());
+                mPreference.setEnabled(true);
+                break;
+            case NfcAdapter.STATE_TURNING_ON:
+                mPreference.setEnabled(false);
+                break;
+            case NfcAdapter.STATE_TURNING_OFF:
+                mPreference.setEnabled(false);
+                break;
+        }
+    }
+}
diff --git a/src/com/android/settings/nfc/SecureNfcPreferenceController.java b/src/com/android/settings/nfc/SecureNfcPreferenceController.java
new file mode 100644
index 00000000000..2c236723d77
--- /dev/null
+++ b/src/com/android/settings/nfc/SecureNfcPreferenceController.java
@@ -0,0 +1,99 @@
+/*
+ * Copyright (C) 2019 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.settings.nfc;
+
+import android.content.Context;
+import android.nfc.NfcAdapter;
+import android.os.SystemProperties;
+
+import androidx.preference.PreferenceScreen;
+import androidx.preference.SwitchPreference;
+
+import com.android.settings.core.TogglePreferenceController;
+import com.android.settingslib.core.lifecycle.LifecycleObserver;
+import com.android.settingslib.core.lifecycle.events.OnPause;
+import com.android.settingslib.core.lifecycle.events.OnResume;
+
+public class SecureNfcPreferenceController extends TogglePreferenceController
+        implements LifecycleObserver, OnResume, OnPause {
+
+    public static final String KEY_TOGGLE_NFC = "nfc_secure_setting";
+    private final NfcAdapter mNfcAdapter;
+    private SecureNfcEnabler mSecureNfcEnabler;
+
+    public SecureNfcPreferenceController(Context context, String key) {
+        super(context, key);
+        mNfcAdapter = NfcAdapter.getDefaultAdapter(context);
+    }
+
+    @Override
+    public void displayPreference(PreferenceScreen screen) {
+        super.displayPreference(screen);
+        if (!isAvailable()) {
+            mSecureNfcEnabler = null;
+            return;
+        }
+
+        final SwitchPreference switchPreference =
+                (SwitchPreference) screen.findPreference(getPreferenceKey());
+
+        mSecureNfcEnabler = new SecureNfcEnabler(mContext, switchPreference);
+    }
+
+    @Override
+    public boolean isChecked() {
+        return mNfcAdapter.isNfcSecureEnabled();
+    }
+
+    @Override
+    public boolean setChecked(boolean isChecked) {
+        return mNfcAdapter.setNfcSecure(isChecked);
+    }
+
+    @Override
+    @AvailabilityStatus
+    public int getAvailabilityStatus() {
+        if (mNfcAdapter == null) {
+            return UNSUPPORTED_ON_DEVICE;
+        }
+        return mNfcAdapter.deviceSupportsNfcSecure() ? AVAILABLE
+            : UNSUPPORTED_ON_DEVICE;
+    }
+
+    @Override
+    public boolean hasAsyncUpdate() {
+        return true;
+    }
+
+    @Override
+    public boolean isSliceable() {
+        return true;
+    }
+
+    @Override
+    public void onResume() {
+        if (mSecureNfcEnabler != null) {
+            mSecureNfcEnabler.resume();
+        }
+    }
+
+    @Override
+    public void onPause() {
+        if (mSecureNfcEnabler != null) {
+            mSecureNfcEnabler.pause();
+        }
+    }
+}
diff --git a/tests/robotests/src/com/android/settings/connecteddevice/AdvancedConnectedDeviceDashboardFragmentTest.java b/tests/robotests/src/com/android/settings/connecteddevice/AdvancedConnectedDeviceDashboardFragmentTest.java
index 658a952012d..2a8aa8ecdaf 100644
--- a/tests/robotests/src/com/android/settings/connecteddevice/AdvancedConnectedDeviceDashboardFragmentTest.java
+++ b/tests/robotests/src/com/android/settings/connecteddevice/AdvancedConnectedDeviceDashboardFragmentTest.java
@@ -16,7 +16,11 @@
 package com.android.settings.connecteddevice;
 
 import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.when;
 
+import android.content.Context;
+import android.nfc.NfcAdapter;
 import android.provider.SearchIndexableResource;
 
 import com.android.settings.testutils.shadow.ShadowConnectivityManager;
@@ -26,6 +30,7 @@ import com.android.settingslib.drawer.CategoryKey;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
 import org.robolectric.RobolectricTestRunner;
 import org.robolectric.RuntimeEnvironment;
@@ -40,6 +45,9 @@ public class AdvancedConnectedDeviceDashboardFragmentTest {
 
     private AdvancedConnectedDeviceDashboardFragment mFragment;
 
+    @Mock
+    private NfcAdapter mNfcAdapter;
+
     @Before
     public void setUp() {
         MockitoAnnotations.initMocks(this);
@@ -69,9 +77,13 @@ public class AdvancedConnectedDeviceDashboardFragmentTest {
 
     @Test
     public void testSearchIndexProvider_correctNonIndexables() {
+        Context context = spy(RuntimeEnvironment.application);
+        when(context.getApplicationContext()).thenReturn(context);
+        when(NfcAdapter.getDefaultAdapter(context)).thenReturn(mNfcAdapter);
+        when(mNfcAdapter.deviceSupportsNfcSecure()).thenReturn(true);
         final List<String> niks =
                 AdvancedConnectedDeviceDashboardFragment.SEARCH_INDEX_DATA_PROVIDER
-                        .getNonIndexableKeys(RuntimeEnvironment.application);
+                        .getNonIndexableKeys(context);
 
         assertThat(niks).contains(AdvancedConnectedDeviceDashboardFragment.KEY_BLUETOOTH);
     }