From 2dbf394181f4e5f907f1d1aaf48369cd3249c49f Mon Sep 17 00:00:00 2001 From: Jack Yu Date: Fri, 6 Sep 2019 20:43:54 +0800 Subject: [PATCH] Provide APIs to get preferred payment service information Provide APIs to get current preferred payment service information: 1. AID list 2. RouteDestination 3. Description APIs would be guarded by a new permission. Bug:139790381 Test: Build pass Change-Id: I1a4fff5fee58f6e5d6727319cff9ad90e55fc767 --- api/current.txt | 9 ++ core/java/android/nfc/INfcCardEmulation.aidl | 1 + core/java/android/nfc/NfcAdapter.java | 27 ++++- .../nfc/cardemulation/CardEmulation.java | 104 ++++++++++++++++++ core/res/AndroidManifest.xml | 9 ++ core/res/res/values/strings.xml | 6 + 6 files changed, 154 insertions(+), 2 deletions(-) diff --git a/api/current.txt b/api/current.txt index 23b5bc6224f1f..3eff7fb3e94fc 100644 --- a/api/current.txt +++ b/api/current.txt @@ -99,6 +99,7 @@ package android { field public static final String MOUNT_FORMAT_FILESYSTEMS = "android.permission.MOUNT_FORMAT_FILESYSTEMS"; field public static final String MOUNT_UNMOUNT_FILESYSTEMS = "android.permission.MOUNT_UNMOUNT_FILESYSTEMS"; field public static final String NFC = "android.permission.NFC"; + field public static final String NFC_PREFERRED_PAYMENT_INFO = "android.permission.NFC_PREFERRED_PAYMENT_INFO"; field public static final String NFC_TRANSACTION_EVENT = "android.permission.NFC_TRANSACTION_EVENT"; field public static final String PACKAGE_USAGE_STATS = "android.permission.PACKAGE_USAGE_STATS"; field @Deprecated public static final String PERSISTENT_ACTIVITY = "android.permission.PERSISTENT_ACTIVITY"; @@ -30707,6 +30708,7 @@ package android.nfc { method @Deprecated public void setOnNdefPushCompleteCallback(android.nfc.NfcAdapter.OnNdefPushCompleteCallback, android.app.Activity, android.app.Activity...); field public static final String ACTION_ADAPTER_STATE_CHANGED = "android.nfc.action.ADAPTER_STATE_CHANGED"; field public static final String ACTION_NDEF_DISCOVERED = "android.nfc.action.NDEF_DISCOVERED"; + field @RequiresPermission(android.Manifest.permission.NFC_PREFERRED_PAYMENT_INFO) public static final String ACTION_PREFERRED_PAYMENT_CHANGED = "android.nfc.action.PREFERRED_PAYMENT_CHANGED"; field public static final String ACTION_TAG_DISCOVERED = "android.nfc.action.TAG_DISCOVERED"; field public static final String ACTION_TECH_DISCOVERED = "android.nfc.action.TECH_DISCOVERED"; field @RequiresPermission(android.Manifest.permission.NFC_TRANSACTION_EVENT) public static final String ACTION_TRANSACTION_DETECTED = "android.nfc.action.TRANSACTION_DETECTED"; @@ -30715,6 +30717,7 @@ package android.nfc { field public static final String EXTRA_DATA = "android.nfc.extra.DATA"; field public static final String EXTRA_ID = "android.nfc.extra.ID"; field public static final String EXTRA_NDEF_MESSAGES = "android.nfc.extra.NDEF_MESSAGES"; + field public static final String EXTRA_PREFERRED_PAYMENT_CHANGED_REASON = "android.nfc.extra.PREFERRED_PAYMENT_CHANGED_REASON"; field public static final String EXTRA_READER_PRESENCE_CHECK_DELAY = "presence"; field public static final String EXTRA_SECURE_ELEMENT_NAME = "android.nfc.extra.SECURE_ELEMENT_NAME"; field public static final String EXTRA_TAG = "android.nfc.extra.TAG"; @@ -30725,6 +30728,9 @@ package android.nfc { field public static final int FLAG_READER_NFC_V = 8; // 0x8 field public static final int FLAG_READER_NO_PLATFORM_SOUNDS = 256; // 0x100 field public static final int FLAG_READER_SKIP_NDEF_CHECK = 128; // 0x80 + field public static final int PREFERRED_PAYMENT_CHANGED = 2; // 0x2 + field public static final int PREFERRED_PAYMENT_LOADED = 1; // 0x1 + field public static final int PREFERRED_PAYMENT_UPDATED = 3; // 0x3 field public static final int STATE_OFF = 1; // 0x1 field public static final int STATE_ON = 3; // 0x3 field public static final int STATE_TURNING_OFF = 4; // 0x4 @@ -30780,8 +30786,11 @@ package android.nfc.cardemulation { public final class CardEmulation { method public boolean categoryAllowsForegroundPreference(String); + method @Nullable @RequiresPermission(android.Manifest.permission.NFC_PREFERRED_PAYMENT_INFO) public java.util.List getAidsForPreferredPaymentService(); method public java.util.List getAidsForService(android.content.ComponentName, String); + method @Nullable @RequiresPermission(android.Manifest.permission.NFC_PREFERRED_PAYMENT_INFO) public String getDescriptionForPreferredPaymentService(); method public static android.nfc.cardemulation.CardEmulation getInstance(android.nfc.NfcAdapter); + method @Nullable @RequiresPermission(android.Manifest.permission.NFC_PREFERRED_PAYMENT_INFO) public String getRouteDestinationForPreferredPaymentService(); method public int getSelectionModeForCategory(String); method public boolean isDefaultServiceForAid(android.content.ComponentName, String); method public boolean isDefaultServiceForCategory(android.content.ComponentName, String); diff --git a/core/java/android/nfc/INfcCardEmulation.aidl b/core/java/android/nfc/INfcCardEmulation.aidl index dd2c0d4f9ee52..848b6d52c47f9 100644 --- a/core/java/android/nfc/INfcCardEmulation.aidl +++ b/core/java/android/nfc/INfcCardEmulation.aidl @@ -39,4 +39,5 @@ interface INfcCardEmulation boolean setPreferredService(in ComponentName service); boolean unsetPreferredService(); boolean supportsAidPrefixRegistration(); + ApduServiceInfo getPreferredPaymentService(int userHandle); } diff --git a/core/java/android/nfc/NfcAdapter.java b/core/java/android/nfc/NfcAdapter.java index bc698f97738a8..7ab984fc9275c 100644 --- a/core/java/android/nfc/NfcAdapter.java +++ b/core/java/android/nfc/NfcAdapter.java @@ -151,7 +151,7 @@ public final class NfcAdapter { public static final String ACTION_TAG_DISCOVERED = "android.nfc.action.TAG_DISCOVERED"; /** - * Broadcast Action: Intent to notify an application that an transaction event has occurred + * Broadcast Action: Intent to notify an application that a transaction event has occurred * on the Secure Element. * *

This intent will only be sent if the application has requested permission for @@ -163,6 +163,18 @@ public final class NfcAdapter { public static final String ACTION_TRANSACTION_DETECTED = "android.nfc.action.TRANSACTION_DETECTED"; + /** + * Broadcast Action: Intent to notify if the preferred payment service changed. + * + *

This intent will only be sent to the application has requested permission for + * {@link android.Manifest.permission#NFC_PREFERRED_PAYMENT_INFO} and if the application + * has the necessary access to Secure Element which witnessed the particular event. + */ + @RequiresPermission(android.Manifest.permission.NFC_PREFERRED_PAYMENT_INFO) + @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) + public static final String ACTION_PREFERRED_PAYMENT_CHANGED = + "android.nfc.action.PREFERRED_PAYMENT_CHANGED"; + /** * Broadcast to only the activity that handles ACTION_TAG_DISCOVERED * @hide @@ -231,6 +243,17 @@ public final class NfcAdapter { */ public static final String EXTRA_SECURE_ELEMENT_NAME = "android.nfc.extra.SECURE_ELEMENT_NAME"; + /** + * Mandatory String extra field in {@link #ACTION_PREFERRED_PAYMENT_CHANGED} + * Indicates the condition when trigger this event. + */ + public static final String EXTRA_PREFERRED_PAYMENT_CHANGED_REASON = + "android.nfc.extra.PREFERRED_PAYMENT_CHANGED_REASON"; + + public static final int PREFERRED_PAYMENT_LOADED = 1; + public static final int PREFERRED_PAYMENT_CHANGED = 2; + public static final int PREFERRED_PAYMENT_UPDATED = 3; + public static final int STATE_OFF = 1; public static final int STATE_TURNING_ON = 2; public static final int STATE_ON = 3; @@ -1410,7 +1433,7 @@ public final class NfcAdapter { /** * Enable foreground dispatch to the given Activity. * - *

This will give give priority to the foreground activity when + *

This will give priority to the foreground activity when * dispatching a discovered {@link Tag} to an application. * *

If any IntentFilters are provided to this method they are used to match dispatch Intents diff --git a/core/java/android/nfc/cardemulation/CardEmulation.java b/core/java/android/nfc/cardemulation/CardEmulation.java index aa93611062f5a..f1c74a6331c4b 100644 --- a/core/java/android/nfc/cardemulation/CardEmulation.java +++ b/core/java/android/nfc/cardemulation/CardEmulation.java @@ -17,6 +17,7 @@ package android.nfc.cardemulation; import android.annotation.NonNull; +import android.annotation.Nullable; import android.annotation.RequiresPermission; import android.annotation.SdkConstant; import android.annotation.SdkConstant.SdkConstantType; @@ -656,6 +657,109 @@ public final class CardEmulation { } } + /** + * Retrieves the registered AIDs for the preferred payment service. + * + * @return The list of AIDs registered for this category, or null if it couldn't be found. + */ + @RequiresPermission(android.Manifest.permission.NFC_PREFERRED_PAYMENT_INFO) + @Nullable + public List getAidsForPreferredPaymentService() { + try { + ApduServiceInfo serviceInfo = sService.getPreferredPaymentService(mContext.getUserId()); + return (serviceInfo != null ? serviceInfo.getAids() : null); + } catch (RemoteException e) { + recoverService(); + if (sService == null) { + Log.e(TAG, "Failed to recover CardEmulationService."); + return null; + } + try { + ApduServiceInfo serviceInfo = + sService.getPreferredPaymentService(mContext.getUserId()); + return (serviceInfo != null ? serviceInfo.getAids() : null); + } catch (RemoteException ee) { + Log.e(TAG, "Failed to recover CardEmulationService."); + return null; + } + } + } + + /** + * Retrieves the route destination for the preferred payment service. + * + * @return The route destination secure element name of the preferred payment service. + * HCE payment: "Host" + * OffHost payment: prefix SIM or prefix eSE string. + * "OffHost" if the payment service does not specify secure element + * name. + */ + @RequiresPermission(android.Manifest.permission.NFC_PREFERRED_PAYMENT_INFO) + @Nullable + public String getRouteDestinationForPreferredPaymentService() { + try { + ApduServiceInfo serviceInfo = sService.getPreferredPaymentService(mContext.getUserId()); + if (serviceInfo != null) { + if (!serviceInfo.isOnHost()) { + return serviceInfo.getOffHostSecureElement() == null ? + "OffHost" : serviceInfo.getOffHostSecureElement(); + } + return "Host"; + } + return null; + } catch (RemoteException e) { + recoverService(); + if (sService == null) { + Log.e(TAG, "Failed to recover CardEmulationService."); + return null; + } + try { + ApduServiceInfo serviceInfo = + sService.getPreferredPaymentService(mContext.getUserId()); + if (serviceInfo != null) { + if (!serviceInfo.isOnHost()) { + return serviceInfo.getOffHostSecureElement() == null ? + "Offhost" : serviceInfo.getOffHostSecureElement(); + } + return "Host"; + } + return null; + + } catch (RemoteException ee) { + Log.e(TAG, "Failed to recover CardEmulationService."); + return null; + } + } + } + + /** + * Returns a user-visible description of the preferred payment service. + * + * @return the preferred payment service description + */ + @RequiresPermission(android.Manifest.permission.NFC_PREFERRED_PAYMENT_INFO) + @Nullable + public String getDescriptionForPreferredPaymentService() { + try { + ApduServiceInfo serviceInfo = sService.getPreferredPaymentService(mContext.getUserId()); + return (serviceInfo != null ? serviceInfo.getDescription() : null); + } catch (RemoteException e) { + recoverService(); + if (sService == null) { + Log.e(TAG, "Failed to recover CardEmulationService."); + return null; + } + try { + ApduServiceInfo serviceInfo = + sService.getPreferredPaymentService(mContext.getUserId()); + return (serviceInfo != null ? serviceInfo.getDescription() : null); + } catch (RemoteException ee) { + Log.e(TAG, "Failed to recover CardEmulationService."); + return null; + } + } + } + /** * @hide */ diff --git a/core/res/AndroidManifest.xml b/core/res/AndroidManifest.xml index a35c4dbdf383f..c99289a26b0a7 100644 --- a/core/res/AndroidManifest.xml +++ b/core/res/AndroidManifest.xml @@ -306,6 +306,7 @@ + @@ -1767,6 +1768,14 @@

Protection level: normal --> + + + + Preferred NFC Payment Service Information + + Allows the app to get preferred nfc payment service information like + registered aids and route destination. + control Near Field Communication