EuiccCard #1 (b2f5a565) · Commits · e / os / android_frameworks_opt_telephony

src/java/com/android/internal/telephony/uicc/euicc/EuiccCard.java

0 → 100644

+439 −0

Original line number	Diff line number	Diff line
		/*
		* 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.internal.telephony.uicc.euicc;

		import android.annotation.Nullable;
		import android.content.Context;
		import android.os.Handler;
		import android.service.euicc.EuiccProfileInfo;
		import android.telephony.euicc.EuiccCardManager;
		import android.telephony.euicc.EuiccNotification;
		import android.telephony.euicc.EuiccRulesAuthTable;

		import com.android.internal.telephony.CommandsInterface;
		import com.android.internal.telephony.uicc.IccCardStatus;
		import com.android.internal.telephony.uicc.IccUtils;
		import com.android.internal.telephony.uicc.UiccCard;
		import com.android.internal.telephony.uicc.asn1.InvalidAsn1DataException;
		import com.android.internal.telephony.uicc.asn1.TagNotFoundException;
		import com.android.internal.telephony.uicc.euicc.apdu.ApduSender;
		import com.android.internal.telephony.uicc.euicc.apdu.RequestBuilder;
		import com.android.internal.telephony.uicc.euicc.apdu.RequestProvider;
		import com.android.internal.telephony.uicc.euicc.async.AsyncResultCallback;
		import com.android.internal.telephony.uicc.euicc.async.AsyncResultHelper;

		/**
		* This represents an eUICC card to perform profile management operations asynchronously. This class
		* includes methods defined by different versions of GSMA Spec (SGP.22).
		*/
		public class EuiccCard extends UiccCard {
		private static final String ISD_R_AID = "A0000005591010FFFFFFFF8900000100";

		private static final EuiccSpecVersion SGP_2_0 = new EuiccSpecVersion(2, 0, 0);

		// These interfaces are used for simplifying the code by leveraging lambdas.
		private interface ApduRequestBuilder {
		void build(RequestBuilder requestBuilder)
		throws EuiccCardException, TagNotFoundException, InvalidAsn1DataException;
		}

		private interface ApduResponseHandler<T> {
		T handleResult(byte[] response)
		throws EuiccCardException, TagNotFoundException, InvalidAsn1DataException;
		}

		private final ApduSender mApduSender;
		private final Object mLock = new Object();
		private EuiccSpecVersion mSpecVersion;

		public EuiccCard(Context c, CommandsInterface ci, IccCardStatus ics, int phoneId) {
		super(c, ci, ics, phoneId);
		// TODO: Set supportExtendedApdu based on ATR.
		mApduSender = new ApduSender(ci, ISD_R_AID, false /* supportExtendedApdu */);
		}

		/**
		* Gets the GSMA RSP specification version supported by this eUICC. This may return null if the
		* version cannot be read.
		*/
		public void getSpecVersion(AsyncResultCallback<EuiccSpecVersion> callback, Handler handler) {
		if (mSpecVersion != null) {
		AsyncResultHelper.returnResult(mSpecVersion, callback, handler);
		return;
		}

		sendApdu(newRequestProvider((RequestBuilder requestBuilder) -> { /* Do nothing */ }),
		(byte[] response) -> mSpecVersion, callback, handler);
		}

		/**
		* Gets a list of user-visible profiles.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 1.1.0 [GSMA SGP.22]
		*/
		public void getAllProfiles(AsyncResultCallback<EuiccProfileInfo[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Gets a profile.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 1.1.0 [GSMA SGP.22]
		*/
		public final void getProfile(String iccid, AsyncResultCallback<EuiccProfileInfo> callback,
		Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Disables a profile of the given {@code iccid}.
		*
		* @param refresh Whether sending the REFRESH command to modem.
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 1.1.0 [GSMA SGP.22]
		*/
		public void disableProfile(String iccid, boolean refresh, AsyncResultCallback<Void> callback,
		Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Switches from the current profile to another profile. The current profile will be disabled
		* and the specified profile will be enabled.
		*
		* @param refresh Whether sending the REFRESH command to modem.
		* @param callback The callback to get the EuiccProfile enabled.
		* @param handler The handler to run the callback.
		* @since 1.1.0 [GSMA SGP.22]
		*/
		public void switchToProfile(String iccid, boolean refresh, AsyncResultCallback<Void> callback,
		Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Gets the EID of the eUICC.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 1.1.0 [GSMA SGP.22]
		*/
		public void getEid(AsyncResultCallback<String> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Sets the nickname of a profile.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 1.1.0 [GSMA SGP.22]
		*/
		public void setNickname(String iccid, String nickname, AsyncResultCallback<Void> callback,
		Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Deletes a profile from eUICC.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 1.1.0 [GSMA SGP.22]
		*/
		public void deleteProfile(String iccid, AsyncResultCallback<Void> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Resets the eUICC memory (e.g., remove all profiles).
		*
		* @param options Bits of the options of resetting which parts of the eUICC memory.
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 1.1.0 [GSMA SGP.22]
		*/
		public void resetMemory(@EuiccCardManager.ResetOption int options,
		AsyncResultCallback<Void> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Gets the default SM-DP+ address from eUICC.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void getDefaultSmdpAddress(AsyncResultCallback<String> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Gets the SM-DS address from eUICC.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void getSmdsAddress(AsyncResultCallback<String> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Sets the default SM-DP+ address of eUICC.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void setDefaultSmdpAddress(String defaultSmdpAddress, AsyncResultCallback<Void> callback,
		Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Gets Rules Authorisation Table.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void getRulesAuthTable(AsyncResultCallback<EuiccRulesAuthTable> callback,
		Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Gets the eUICC challenge for new profile downloading.
		*
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void getEuiccChallenge(AsyncResultCallback<byte[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Gets the eUICC info1 for new profile downloading.
		*
		* @param callback The callback to get the result, which represents an {@code EUICCInfo1}
		* defined in GSMA RSP v2.0+.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void getEuiccInfo1(AsyncResultCallback<byte[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Gets the eUICC info2 for new profile downloading.
		*
		* @param callback The callback to get the result, which represents an {@code EUICCInfo2}
		* defined in GSMA RSP v2.0+.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void getEuiccInfo2(AsyncResultCallback<byte[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Authenticates the SM-DP+ server by the eUICC. The parameters {@code serverSigned1}, {@code
		* serverSignature1}, {@code euiccCiPkIdToBeUsed}, and {@code serverCertificate} are the ASN.1
		* data returned by SM-DP+ server.
		*
		* @param matchingId The activation code or an empty string.
		* @param callback The callback to get the result, which represents an {@code
		* AuthenticateServerResponse} defined in GSMA RSP v2.0+.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void authenticateServer(String matchingId, byte[] serverSigned1,
		byte[] serverSignature1, byte[] euiccCiPkIdToBeUsed, byte[] serverCertificate,
		AsyncResultCallback<byte[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Prepares the profile download request sent to SM-DP+. The parameters {@code smdpSigned2},
		* {@code smdpSignature2}, and {@code smdpCertificate} are the ASN.1 data returned by SM-DP+
		* server.
		*
		* @param hashCc The hash of confirmation code. It can be null if there is no confirmation code
		* required.
		* @param callback The callback to get the result, which represents an {@code
		* PrepareDownloadResponse} defined in GSMA RSP v2.0+.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void prepareDownload(@Nullable byte[] hashCc, byte[] smdpSigned2, byte[] smdpSignature2,
		byte[] smdpCertificate, AsyncResultCallback<byte[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Loads a downloaded bound profile package onto the eUICC.
		*
		* @param boundProfilePackage The Bound Profile Package data returned by SM-DP+ server.
		* @param callback The callback to get the result, which represents an {@code
		* LoadBoundProfilePackageResponse} defined in GSMA RSP v2.0+.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void loadBoundProfilePackage(byte[] boundProfilePackage,
		AsyncResultCallback<byte[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Cancels the current profile download session.
		*
		* @param transactionId The transaction ID returned by SM-DP+ server.
		* @param callback The callback to get the result, which represents an {@code
		* CancelSessionResponse} defined in GSMA RSP v2.0+.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void cancelSession(byte[] transactionId, @EuiccCardManager.CancelReason int reason,
		AsyncResultCallback<byte[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Lists all notifications of the given {@code notificationEvents}.
		*
		* @param events Bits of the event types ({@link EuiccNotification.Event}) to list.
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void listNotifications(@EuiccNotification.Event int events,
		AsyncResultCallback<EuiccNotification[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Retrieves contents of all notification of the given {@code events}.
		*
		* @param events Bits of the event types ({@link EuiccNotification.Event}) to list.
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void retrieveNotificationList(@EuiccNotification.Event int events,
		AsyncResultCallback<EuiccNotification[]> callback, Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Retrieves the content of a notification of the given {@code seqNumber}.
		*
		* @param seqNumber The sequence number of the notification.
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void retrieveNotification(int seqNumber, AsyncResultCallback<EuiccNotification> callback,
		Handler handler) {
		// TODO: to be implemented.
		}

		/**
		* Removes a notification from eUICC.
		*
		* @param seqNumber The sequence number of the notification.
		* @param callback The callback to get the result.
		* @param handler The handler to run the callback.
		* @since 2.0.0 [GSMA SGP.22]
		*/
		public void removeNotificationFromList(int seqNumber, AsyncResultCallback<Void> callback,
		Handler handler) {
		// TODO: to be implemented.
		}

		private RequestProvider newRequestProvider(ApduRequestBuilder builder) {
		return (selectResponse, requestBuilder) -> {
		EuiccSpecVersion ver = getOrExtractSpecVersion(selectResponse);
		if (ver == null) {
		throw new EuiccCardException("Cannot get eUICC spec version.");
		}
		try {
		if (ver.compareTo(SGP_2_0) < 0) {
		throw new EuiccCardException("eUICC spec version is unsupported: " + ver);
		}
		builder.build(requestBuilder);
		} catch (InvalidAsn1DataException \| TagNotFoundException e) {
		throw new EuiccCardException("Cannot parse ASN1 to build request.", e);
		}
		};
		}

		private EuiccSpecVersion getOrExtractSpecVersion(byte[] selectResponse) {
		// Uses the cached version.
		if (mSpecVersion != null) {
		return mSpecVersion;
		}
		// Parses and caches the version.
		EuiccSpecVersion ver = EuiccSpecVersion.fromOpenChannelResponse(selectResponse);
		if (ver != null) {
		synchronized (mLock) {
		if (mSpecVersion == null) {
		mSpecVersion = ver;
		}
		}
		}
		return ver;
		}

		/**
		* A wrapper on {@link ApduSender#send(RequestProvider, AsyncResultCallback, Handler)} to
		* leverage lambda to simplify the sending APDU code.EuiccCardErrorException.
		*
		* @param requestBuilder Builds the request of APDU commands.
		* @param responseHandler Converts the APDU response from bytes to expected result.
		* @param <T> Type of the originally expected result.
		*/
		private <T> void sendApdu(RequestProvider requestBuilder,
		ApduResponseHandler<T> responseHandler, AsyncResultCallback<T> callback,
		Handler handler) {
		mApduSender.send(requestBuilder, new AsyncResultCallback<byte[]>() {
		@Override
		public void onResult(byte[] response) {
		try {
		callback.onResult(responseHandler.handleResult(response));
		} catch (EuiccCardException e) {
		callback.onException(e);
		} catch (InvalidAsn1DataException \| TagNotFoundException e) {
		callback.onException(new EuiccCardException(
		"Cannot parse response: " + IccUtils.bytesToHexString(response), e));
		}
		}

		@Override
		public void onException(Throwable e) {
		callback.onException(new EuiccCardException("Cannot send APDU.", e));
		}
		}, handler);
		}
		}

src/java/com/android/internal/telephony/uicc/euicc/EuiccCardErrorException.java

0 → 100644

+123 −0

Original line number	Diff line number	Diff line
		/*
		* 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.internal.telephony.uicc.euicc;

		import android.annotation.IntDef;
		import android.annotation.Nullable;

		import com.android.internal.telephony.uicc.asn1.Asn1Node;
		import com.android.internal.telephony.uicc.euicc.apdu.ApduSender;

		import java.lang.annotation.Retention;
		import java.lang.annotation.RetentionPolicy;

		/**
		* The exception which is thrown when an error is returned in a successfully executed APDU command
		* sent to eUICC. This exception means the response status is no-error
		* ({@link ApduSender#STATUS_NO_ERROR}), but the action is failed due to eUICC specific logic.
		*/
		public class EuiccCardErrorException extends EuiccCardException {
		/** Operations */
		@Retention(RetentionPolicy.SOURCE)
		@IntDef(prefix = "OPERATION_", value = {
		OPERATION_UNKNOWN,
		OPERATION_GET_PROFILE,
		OPERATION_PREPARE_DOWNLOAD,
		OPERATION_AUTHENTICATE_SERVER,
		OPERATION_CANCEL_SESSION,
		OPERATION_LOAD_BOUND_PROFILE_PACKAGE,
		OPERATION_LIST_NOTIFICATIONS,
		OPERATION_SET_NICKNAME,
		OPERATION_RETRIEVE_NOTIFICATION,
		OPERATION_REMOVE_NOTIFICATION_FROM_LIST,
		OPERATION_SWITCH_TO_PROFILE,
		OPERATION_DISABLE_PROFILE,
		OPERATION_DELETE_PROFILE,
		OPERATION_RESET_MEMORY,
		OPERATION_SET_DEFAULT_SMDP_ADDRESS,
		})
		public @interface OperationCode {}

		public static final int OPERATION_UNKNOWN = 0;
		public static final int OPERATION_GET_PROFILE = 1;
		public static final int OPERATION_PREPARE_DOWNLOAD = 2;
		public static final int OPERATION_AUTHENTICATE_SERVER = 3;
		public static final int OPERATION_CANCEL_SESSION = 4;
		public static final int OPERATION_LOAD_BOUND_PROFILE_PACKAGE = 5;
		public static final int OPERATION_LIST_NOTIFICATIONS = 6;
		public static final int OPERATION_SET_NICKNAME = 7;
		public static final int OPERATION_RETRIEVE_NOTIFICATION = 8;
		public static final int OPERATION_REMOVE_NOTIFICATION_FROM_LIST = 9;
		public static final int OPERATION_SWITCH_TO_PROFILE = 10;
		public static final int OPERATION_DISABLE_PROFILE = 11;
		public static final int OPERATION_DELETE_PROFILE = 12;
		public static final int OPERATION_RESET_MEMORY = 13;
		public static final int OPERATION_SET_DEFAULT_SMDP_ADDRESS = 14;

		private final @OperationCode int mOperationCode;
		private final int mErrorCode;
		private final @Nullable Asn1Node mErrorDetails;

		/**
		* Creates an exception with an error code in the response of an APDU command.
		*
		* @param errorCode The meaning of the code depends on each APDU command. It should always be
		* non-negative.
		*/
		public EuiccCardErrorException(@OperationCode int operationCode, int errorCode) {
		mOperationCode = operationCode;
		mErrorCode = errorCode;
		mErrorDetails = null;
		}

		/**
		* Creates an exception with an error code and the error details in the response of an APDU
		* command.
		*
		* @param errorCode The meaning of the code depends on each APDU command. It should always be
		* non-negative.
		* @param errorDetails The content of the details depends on each APDU command.
		*/
		public EuiccCardErrorException(@OperationCode int operationCode, int errorCode,
		@Nullable Asn1Node errorDetails) {
		mOperationCode = operationCode;
		mErrorCode = errorCode;
		mErrorDetails = errorDetails;
		}

		/** @return The error code. The meaning of the code depends on each APDU command. */
		public int getErrorCode() {
		return mErrorCode;
		}

		/** @return The operation code. */
		public int getOperationCode() {
		return mOperationCode;
		}

		/** @return The error details. The meaning of the details depends on each APDU command. */
		@Nullable
		public Asn1Node getErrorDetails() {
		return mErrorDetails;
		}

		@Override
		public String getMessage() {
		return "EuiccCardError: mOperatorCode=" + mOperationCode + ", mErrorCode=" + mErrorCode
		+ ", errorDetails=" + (mErrorDetails == null ? "null" : mErrorDetails.toHex());
		}
		}

src/java/com/android/internal/telephony/uicc/euicc/EuiccCardException.java

0 → 100644

+33 −0

Original line number	Diff line number	Diff line
		/*
		* 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.internal.telephony.uicc.euicc;

		/**
		* The base exception class of all exceptions thrown by the methods of an {@link EuiccCard}
		* instance.
		*/
		public class EuiccCardException extends Exception {
		public EuiccCardException() {}

		public EuiccCardException(String message) {
		super(message);
		}

		public EuiccCardException(String message, Throwable throwable) {
		super(message, throwable);
		}
		}

src/java/com/android/internal/telephony/uicc/euicc/EuiccSpecVersion.java

+49 −2

File changed.

Preview size limit exceeded, changes collapsed.

src/java/com/android/internal/telephony/uicc/euicc/Tags.java

0 → 100644

+108 −0

File added.

Preview size limit exceeded, changes collapsed.