From b65284004f3fcf6ab49e633ed0ca58ca46433242 Mon Sep 17 00:00:00 2001 From: Jordan Liu Date: Mon, 9 Apr 2018 16:33:17 -0700 Subject: Update getIccAuthentication documentation Explain what it means if the function returns null. This is based on the spec at TS 31.102 section 7.3.1. Bug: 74392381 Test: manual Change-Id: Ic84d94589431109079a866027953ab9dbef103b8 Merged-In: Ic84d94589431109079a866027953ab9dbef103b8 --- telephony/java/android/telephony/TelephonyManager.java | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/telephony/java/android/telephony/TelephonyManager.java b/telephony/java/android/telephony/TelephonyManager.java index 375fdbbd5ec4..16599d25d437 100644 --- a/telephony/java/android/telephony/TelephonyManager.java +++ b/telephony/java/android/telephony/TelephonyManager.java @@ -5147,7 +5147,12 @@ public class TelephonyManager { * {@link #AUTHTYPE_EAP_SIM} * @param data authentication challenge data, base64 encoded. * See 3GPP TS 31.102 7.1.2 for more details. - * @return the response of authentication, or null if not available + * @return the response of authentication. This value will be null in the following cases: + * Authentication error, incorrect MAC + * Authentication error, security context not supported + * Key freshness failure + * Authentication error, no memory space available + * Authentication error, no memory space available in EFMUK */ // TODO(b/73660190): This should probably require MODIFY_PHONE_STATE, not // READ_PRIVILEGED_PHONE_STATE. It certainly shouldn't reference the permission in Javadoc since @@ -5168,7 +5173,13 @@ public class TelephonyManager { * {@link #AUTHTYPE_EAP_SIM} * @param data authentication challenge data, base64 encoded. * See 3GPP TS 31.102 7.1.2 for more details. - * @return the response of authentication, or null if not available + * @return the response of authentication. This value will be null in the following cases only + * (see 3GPP TS 31.102 7.3.1): + * Authentication error, incorrect MAC + * Authentication error, security context not supported + * Key freshness failure + * Authentication error, no memory space available + * Authentication error, no memory space available in EFMUK * @hide */ public String getIccAuthentication(int subId, int appType, int authType, String data) { -- cgit v1.2.3-59-g8ed1b