Implementa una eSIM

La tecnología de la tarjeta SIM integrada (eSIM o eUICC) permite a los usuarios de dispositivos móviles descargar el perfil de un operador y activar el servicio de un operador sin tener una tarjeta SIM física. Es una especificación global impulsada por la GSMA que habilita el aprovisionamiento remoto de SIM (RSP) de cualquier dispositivo móvil. A partir de Android 9, el framework de Android ofrece APIs estándar para acceder a la eSIM y administrar los perfiles de suscripción. Estas APIs de eUICC permiten a terceros desarrollar sus propias apps del operador y asistentes de perfiles locales (LPA) en dispositivos Android compatibles con eSIM.

El LPA es una app del sistema independiente que se debe incluir en la imagen de compilación de Android. La administración de los perfiles en la eSIM suele realizarse mediante el LPA, ya que funciona como un puente entre SM-DP+ (servicio remoto que prepara, almacena y entrega paquetes de perfiles a los dispositivos) y el chip eUICC. De manera opcional, el APK de LPA puede incluir un componente de IU, llamado IU o LUI de LPA, para proporcionar un lugar central en el que el usuario final pueda administrar todos los perfiles de suscripción incorporados. El framework de Android descubre y se conecta automáticamente al mejor LPA disponible, y enruta todas las operaciones de eUICC a través de una instancia de LPA.

Arquitectura del aprovisionamiento remoto de SIM (RSP) simplificado

Figura 1: Arquitectura simplificada de RSP

Los operadores de redes móviles interesados en crear una app de operador deben consultar las APIs de EuiccManager, que proporciona operaciones de administración de perfiles de alto nivel, como downloadSubscription(), switchToSubscription() y deleteSubscription().

Si eres un OEM de dispositivos interesado en crear tu propia app de sistema LPA, debes extender EuiccService para que el framework de Android se conecte a tus servicios de LPA. Además, debes usar las APIs de EuiccCardManager, que proporcionan funciones ES10x basadas en GSMA RSP v2.0. Estas funciones se usan para enviar comandos al chip eUICC, como prepareDownload(), loadBoundProfilePackage(), retrieveNotificationList() y resetMemory().

Las APIs de EuiccManager requieren una app de LPA implementada correctamente para funcionar, y el llamador de las APIs de EuiccCardManager debe ser una LPA. El framework de Android aplica esto.

Los dispositivos que ejecutan Android 10 o versiones posteriores pueden admitir dispositivos con varias eSIM. Para obtener más información, consulta Compatibilidad con varias eSIM.

Crea una app de operador

Las APIs de eUICC en Android 9 permiten que los operadores de redes móviles creen apps de la marca del operador para administrar sus perfiles directamente. Esto incluye descargar y borrar perfiles de suscripción que pertenecen al operador, así como cambiar a un perfil que pertenece a un operador.

EuiccManager

EuiccManager es el punto de entrada principal para que las apps interactúen con el LPA. Esto incluye las apps del operador que descargan, borran y cambian a suscripciones que son propiedad del operador. Esto también incluye la app del sistema de la LUI, que proporciona una ubicación o IU central para administrar todas las suscripciones incorporadas y puede ser una app independiente de la que proporciona el EuiccService.

Para usar las APIs públicas, una app del operador primero debe obtener la instancia de EuiccManager a través de Context#getSystemService:

EuiccManager mgr = (EuiccManager) context.getSystemService(Context.EUICC_SERVICE);

Debes comprobar si el dispositivo admite la eSIM antes de realizar cualquier operación de eSIM. Por lo general, EuiccManager#isEnabled() muestra true si la función android.hardware.telephony.euicc está definida y hay un paquete de LPA presente.

if (mgr == null || !mgr.isEnabled()) {
    return;
}

Para obtener información sobre el hardware de la eUICC y la versión del SO de la eSIM, haz lo siguiente:

EuiccInfo info = mgr.getEuiccInfo();
String osVer = info.getOsVersion();

Muchas APIs, como downloadSubscription() y switchToSubscription(), usan callbacks de PendingIntent, ya que pueden tardar segundos o incluso minutos en completarse. PendingIntent se envía con un código de resultado en el espacio EuiccManager#EMBEDDED_SUBSCRIPTION_RESULT_, que proporciona códigos de error definidos por el framework, así como un código de resultado detallado arbitrario propagado desde la LPA como EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE, lo que permite que la app del operador realice un seguimiento con fines de registro o depuración. La devolución de llamada PendingIntent debe ser BroadcastReceiver.

Para descargar una suscripción descargable determinada (creada a partir de un código de activación o un código QR), haz lo siguiente:

// Register receiver.
static final String ACTION_DOWNLOAD_SUBSCRIPTION = "download_subscription";
static final String LPA_DECLARED_PERMISSION
    = "com.your.company.lpa.permission.BROADCAST";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE,
                    0 /* defaultValue*/);

                // If the result code is a resolvable error, call startResolutionActivity
                if (resultCode == EuiccManager.EMBEDDED_SUBSCRIPTION_RESULT_RESOLVABLE_ERROR) {
                    PendingIntent callbackIntent = PendingIntent.getBroadcast(
                        getContext(), 0 /* requestCode */, intent,
                        PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_MUTABLE);
                    mgr.startResolutionActivity(
                        activity,
                        0 /* requestCode */,
                        intent,
                        callbackIntent);
                }

                resultIntent = intent;
            }
        };
context.registerReceiver(receiver,
        new IntentFilter(ACTION_DOWNLOAD_SUBSCRIPTION),
        LPA_DECLARED_PERMISSION /* broadcastPermission*/,
        null /* handler */);

// Download subscription asynchronously.
DownloadableSubscription sub = DownloadableSubscription
        .forActivationCode(code /* encodedActivationCode*/);
Intent intent = new Intent(action).setPackage(context.getPackageName());
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent,
        PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_MUTABLE);
mgr.downloadSubscription(sub, true /* switchAfterDownload */,
        callbackIntent);

Define y usa el permiso en AndroidManifest.xml:

    <permission android:protectionLevel="signature" android:name="com.your.company.lpa.permission.BROADCAST" />
    <uses-permission android:name="com.your.company.lpa.permission.BROADCAST"/>

Para cambiar a una suscripción con el ID de suscripción, sigue estos pasos:

// Register receiver.
static final String ACTION_SWITCH_TO_SUBSCRIPTION = "switch_to_subscription";
static final String LPA_DECLARED_PERMISSION
    = "com.your.company.lpa.permission.BROADCAST";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE,
                    0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(receiver,
        new IntentFilter(ACTION_SWITCH_TO_SUBSCRIPTION),
        LPA_DECLARED_PERMISSION /* broadcastPermission*/,
        null /* handler */);

// Switch to a subscription asynchronously.
Intent intent = new Intent(action).setPackage(context.getPackageName());
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent,
        PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_MUTABLE);
mgr.switchToSubscription(1 /* subscriptionId */, callbackIntent);

Para obtener una lista completa de las APIs de EuiccManager y ejemplos de código, consulta APIs de eUICC.

Errores que se pueden resolver

En algunos casos, el sistema no puede completar la operación de la eSIM, pero el usuario puede resolver el error. Por ejemplo, downloadSubscription puede fallar si los metadatos del perfil indican que se requiere un código de confirmación del operador. O bien, switchToSubscription puede fallar si la app del operador tiene privilegios del operador sobre el perfil de destino (es decir, el operador es propietario del perfil), pero no tiene privilegios del operador sobre el perfil habilitado actualmente, por lo que se requiere el consentimiento del usuario.

En estos casos, se llama a la devolución de llamada del emisor con EuiccManager#EMBEDDED_SUBSCRIPTION_RESULT_RESOLVABLE_ERROR. La devolución de llamada Intent contiene elementos adicionales internos para que, cuando el emisor la pase a EuiccManager#startResolutionActivity, se pueda solicitar la resolución a través de la LUI. Por ejemplo, si vuelves a usar el código de confirmación, EuiccManager#startResolutionActivity activa una pantalla de la LUI que le permite al usuario ingresar un código de confirmación. Después de ingresar el código, se reanuda la operación de descarga. Este enfoque le proporciona a la app del operador un control total sobre cuándo se muestra la IU, pero le brinda a la LPA/LUI un método extensible para agregar un nuevo control de los problemas recuperables por el usuario en el futuro sin necesidad de que las apps cliente cambien.

Android 9 define estos errores solucionables en EuiccService, que la LUI debe controlar:

/**
 * Alert the user that this action will result in an active SIM being
 * deactivated. To implement the LUI triggered by the system, you need to define
 * this in AndroidManifest.xml.
 */
public static final String ACTION_RESOLVE_DEACTIVATE_SIM =
        "android.service.euicc.action.RESOLVE_DEACTIVATE_SIM";
/**
 * Alert the user about a download/switch being done for an app that doesn't
 * currently have carrier privileges.
 */
public static final String ACTION_RESOLVE_NO_PRIVILEGES =
        "android.service.euicc.action.RESOLVE_NO_PRIVILEGES";

/** Ask the user to resolve all the resolvable errors. */
public static final String ACTION_RESOLVE_RESOLVABLE_ERRORS =
        "android.service.euicc.action.RESOLVE_RESOLVABLE_ERRORS";

Privilegios del operador

Si representas a un operador que desarrolla tu propia app de operador que llama a EuiccManager para descargar perfiles en un dispositivo, tu perfil debe incluir las reglas de privilegios de operador correspondientes a tu app de operador en los metadatos. Esto se debe a que los perfiles de suscripción que pertenecen a diferentes operadores pueden coexistir en el eUICC de un dispositivo, y cada app del operador solo debe poder acceder a los perfiles que le pertenecen. Por ejemplo, el operador A no debería poder descargar, habilitar ni inhabilitar un perfil que sea propiedad del operador B.

Para garantizar que solo el propietario de un perfil pueda acceder a él, Android usa un mecanismo para otorgar privilegios especiales a la app del propietario del perfil (es decir, la app del operador). La plataforma de Android carga los certificados almacenados en el archivo de reglas de acceso (ARF) del perfil y otorga permiso a las apps firmadas por estos certificados para realizar llamadas a las APIs de EuiccManager. A continuación, se describe el proceso de alto nivel:

  1. El operador firma el APK de la app del operador. La herramienta apksigner adjunta el certificado de clave pública al APK.
  2. El operador/SM-DP+ prepara un perfil y sus metadatos, que incluyen un ARF que contiene lo siguiente:

    1. Firma (SHA-1 o SHA-256) del certificado de clave pública de la app del operador (obligatorio)
    2. Nombre del paquete de la app del operador (muy recomendado)
  3. La app del operador intenta realizar una operación eUICC con la API de EuiccManager.

  4. La plataforma de Android verifica que el hash SHA-1 o SHA-256 del certificado de la app que llama coincida con la firma del certificado obtenido del ARF del perfil de destino. Si el nombre del paquete de la app del operador se incluye en el ARF, también debe coincidir con el nombre del paquete de la app que realiza la llamada.

  5. Una vez que se verifican la firma y el nombre del paquete (si se incluye), se otorga el privilegio de proveedor a la app que realiza la llamada en el perfil de destino.

Debido a que los metadatos del perfil pueden estar disponibles fuera del perfil en sí (para que la LPA pueda recuperar los metadatos del perfil desde SM-DP+ antes de que se descargue el perfil o desde ISD-R cuando el perfil esté inhabilitado), debe contener las mismas reglas de privilegios del operador que en el perfil.

El SO eUICC y SM-DP+ deben admitir una etiqueta propietaria BF76 en los metadatos del perfil. El contenido de la etiqueta debe ser el mismo que las reglas de privilegios del operador que muestra la applet de reglas de acceso (ARA) definida en Privilegios de operador de UICC:

RefArDo ::= [PRIVATE 2] SEQUENCE {  -- Tag E2
    refDo [PRIVATE 1] SEQUENCE {  -- Tag E1
        deviceAppIdRefDo [PRIVATE 1] OCTET STRING (SIZE(20|32)),  -- Tag C1
        pkgRefDo [PRIVATE 10] OCTET STRING (SIZE(0..127)) OPTIONAL  -- Tag CA
    },
    arDo [PRIVATE 3] SEQUENCE {  -- Tag E3
        permArDo [PRIVATE 27] OCTET STRING (SIZE(8))  -- Tag DB
    }
}

Para obtener más detalles sobre la firma de apps, consulta Cómo firmar tu app. Para obtener más detalles sobre los privilegios del operador, consulta Privilegios de operador de UICC.

Crea una app de asistente de perfil local

Los fabricantes de dispositivos pueden implementar su propio asistente de perfil local (LPA), que debe estar conectado con las APIs de Android Euicc. En las siguientes secciones, se proporciona una breve descripción general para crear una app de LPA y, luego, integrarla en el sistema Android.

Requisitos de hardware o módem

El LPA y el SO de la eSIM en el chip eUICC deben admitir, como mínimo, el aprovisionamiento de SIM remoto (RSP) de GSMA v2.0 o v2.2. También debes planificar el uso de servidores SM-DP+ y SM-DS que tengan una versión de RSP coincidente. Para obtener información detallada sobre la arquitectura de RSP, consulta la Especificación de arquitectura de RSP de GSMA SGP.21.

Además, para integrar las APIs de eUICC en Android 9, el módem del dispositivo debe enviar capacidades de terminal con compatibilidad para capacidades de eUICC codificadas (administración de perfiles locales y descarga de perfiles). También debe implementar los siguientes métodos:

  • HAL de IRadio versión 1.1: setSimPower
  • IRadio HAL v1.2: getIccCardStatus

  • IRadioConfig HAL v1.0: getSimSlotsStatus

  • AIDL de IRadioConfig v1.0: getAllowedCarriers

    La LPA de Google debe conocer el estado de bloqueo del operador para poder permitir la descarga o transferencia de eSIM solo para el operador permitido. De lo contrario, los usuarios podrían terminar descargando y transfiriendo una SIM y, luego, darse cuenta de que el dispositivo está bloqueado por un operador diferente.

    • Los proveedores o los OEM deben implementar la API de IRadioSim.getAllowedCarriers()HAL.

    • El RIL o módem del proveedor debe propagar el estado de bloqueo y el carrierId del operador al que está bloqueado el dispositivo como parte de la API de HAL IRadioSimResponse.getAllowedCarriersResponse().

El módem debe reconocer la eSIM con el perfil de inicio predeterminado habilitado como una SIM válida y mantener la SIM encendida.

En el caso de los dispositivos que ejecutan Android 10, debe definirse un array de IDs de ranura eUICC no extraíble. Por ejemplo, consulta arrays.xml.

<resources>
   <!-- Device-specific array of SIM slot indexes which are are embedded eUICCs.
        e.g. If a device has two physical slots with indexes 0, 1, and slot 1 is an
        eUICC, then the value of this array should be:
            <integer-array name="non_removable_euicc_slots">
                <item>1</item>
            </integer-array>
        If a device has three physical slots and slot 1 and 2 are eUICCs, then the value of
        this array should be:
            <integer-array name="non_removable_euicc_slots">
               <item>1</item>
               <item>2</item>
            </integer-array>
        This is used to differentiate between removable eUICCs and built in eUICCs, and should
        be set by OEMs for devices which use eUICCs. -->

   <integer-array name="non_removable_euicc_slots">
       <item>1</item>
   </integer-array>
</resources>

Para obtener una lista completa de los requisitos del módem, consulta Requisitos del módem para la compatibilidad con eSIM.

EuiccService

Un LPA consta de dos componentes independientes (ambos pueden implementarse en el mismo APK): el backend de LPA y la IU de LPA o LUI.

Para implementar el backend de LPA, debes extender EuiccService y declarar este servicio en tu archivo de manifiesto. El servicio debe requerir el permiso del sistema android.permission.BIND_EUICC_SERVICE para garantizar que solo el sistema pueda vincularse a él. El servicio también debe incluir un filtro de intents con la acción android.service.euicc.EuiccService. La prioridad del filtro de intents debe establecerse en un valor distinto de cero en caso de que haya varias implementaciones en el dispositivo. Por ejemplo:

<service
    android:name=".EuiccServiceImpl"
    android:permission="android.permission.BIND_EUICC_SERVICE">
    <intent-filter android:priority="100">
        <action android:name="android.service.euicc.EuiccService" />
    </intent-filter>
</service>

De forma interna, el framework de Android determina la LPA activa y, luego, interactúa con ella según sea necesario para admitir las APIs de eUICC de Android. Se consulta PackageManager para todas las apps con el permiso android.permission.WRITE_EMBEDDED_SUBSCRIPTIONS, que especifica un servicio para la acción android.service.euicc.EuiccService. Se selecciona el servicio con la prioridad más alta. Si no se encuentra ningún servicio, se inhabilita la compatibilidad con LPA.

Para implementar la LUI, debes proporcionar una actividad para las siguientes acciones:

  • android.service.euicc.action.MANAGE_EMBEDDED_SUBSCRIPTIONS
  • android.service.euicc.action.PROVISION_EMBEDDED_SUBSCRIPTION

Al igual que con el servicio, cada actividad debe requerir el permiso del sistema android.permission.BIND_EUICC_SERVICE. Cada uno debe tener un filtro de intents con la acción adecuada, la categoría android.service.euicc.category.EUICC_UI y una prioridad distinta de cero. Se usa una lógica similar para elegir las implementaciones de estas actividades, al igual que para elegir la implementación de EuiccService. Por ejemplo:

<activity android:name=".MyLuiActivity"
          android:exported="true"
          android:permission="android.permission.BIND_EUICC_SERVICE">
    <intent-filter android:priority="100">
        <action android:name="android.service.euicc.action.MANAGE_EMBEDDED_SUBSCRIPTIONS" />
        <action android:name="android.service.euicc.action.PROVISION_EMBEDDED_SUBSCRIPTION" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.service.euicc.category.EUICC_UI" />
    </intent-filter>
</activity>

Esto implica que la IU que implementa estas pantallas puede provenir de un APK diferente al que implementa EuiccService. Tener un solo APK o varios (por ejemplo, uno que implemente EuiccService y uno que proporcione actividades de la LUI) es una decisión de diseño.

EuiccCardManager

EuiccCardManager es la interfaz para comunicarse con el chip de eSIM. Proporciona funciones ES10 (como se describe en la especificación de RSP de GSMA) y controla los comandos de solicitud/respuesta de APDU de bajo nivel, así como el análisis de ASN.1. EuiccCardManager es una API del sistema y solo las apps con privilegios del sistema pueden llamarla.

APIs de apps del operador, LPA y Euicc

Figura 2: Tanto la app del operador como la LPA usan APIs de Euicc.

Las APIs de operación de perfil a través de EuiccCardManager requieren que el llamador sea un LPA. El framework de Android aplica esto. Esto significa que el llamador debe extender EuiccService y declararse en tu archivo de manifiesto, como se describe en las secciones anteriores.

Al igual que con EuiccManager, para usar las APIs de EuiccCardManager, tu LPA primero debe obtener la instancia de EuiccCardManager a través de Context#getSystemService:

EuiccCardManager cardMgr = (EuiccCardManager) context.getSystemService(Context.EUICC_CARD_SERVICE);

Luego, para obtener todos los perfiles de la eUICC, haz lo siguiente:

ResultCallback<EuiccProfileInfo[]> callback =
       new ResultCallback<EuiccProfileInfo[]>() {
           @Override
           public void onComplete(int resultCode,
                   EuiccProfileInfo[] result) {
               if (resultCode == EuiccCardManagerReflector.RESULT_OK) {
                   // handle result
               } else {
                   // handle error
               }
           }
       };

cardMgr.requestAllProfiles(eid, AsyncTask.THREAD_POOL_EXECUTOR, callback);

De forma interna, EuiccCardManager se vincula a EuiccCardController (que se ejecuta en el proceso telefónico) a través de una interfaz de AIDL, y cada método EuiccCardManager recibe su devolución de llamada del proceso telefónico a través de una interfaz de AIDL dedicada y diferente. Cuando se usan las APIs de EuiccCardManager, el emisor (LPA) debe proporcionar un objeto Executor a través del cual se invoca la devolución de llamada. Este objeto Executor puede ejecutarse en un solo subproceso o en un grupo de subprocesos que elijas.

La mayoría de las APIs de EuiccCardManager tienen el mismo patrón de uso. Por ejemplo, para cargar un paquete de perfil vinculado en la eUICC, haz lo siguiente:

...
cardMgr.loadBoundProfilePackage(eid, boundProfilePackage,
        AsyncTask.THREAD_POOL_EXECUTOR, callback);

Para cambiar a otro perfil con un ICCID determinado, sigue estos pasos:

...
cardMgr.switchToProfile(eid, iccid, true /* refresh */,
        AsyncTask.THREAD_POOL_EXECUTOR, callback);

Para obtener la dirección SM-DP+ predeterminada del chip eUICC, haz lo siguiente:

...
cardMgr.requestDefaultSmdpAddress(eid, AsyncTask.THREAD_POOL_EXECUTOR,
        callback);

Para recuperar una lista de notificaciones de los eventos de notificación determinados, haz lo siguiente:

...
cardMgr.listNotifications(eid,
        EuiccNotification.Event.INSTALL
              | EuiccNotification.Event.DELETE /* events */,
        AsyncTask.THREAD_POOL_EXECUTOR, callback);

Cómo activar un perfil de eSIM a través de una app del operador

En los dispositivos que ejecutan Android 9 o versiones posteriores, puedes usar una app del operador para activar la eSIM y descargar perfiles. Para descargar perfiles, la app del operador puede llamar directamente a downloadSubscription o proporcionar un código de activación al LPA.

Cuando una app del operador descarga un perfil llamando a downloadSubscription, la llamada aplica la restricción de que la app pueda administrar el perfil a través de una etiqueta de metadatos BF76 que codifica las reglas de privilegios del operador para el perfil. Si un perfil no tiene una etiqueta BF76 o si su etiqueta BF76 no coincide con la firma de la app del operador que realiza la llamada, se rechaza la descarga.

En la siguiente sección, se describe cómo activar una eSIM a través de una app de operador con un código de activación.

Activa la eSIM con un código de activación

Cuando se usa un código de activación para activar un perfil de eSIM, la LPA recupera un código de activación de la app del operador y descarga el perfil. El LPA puede iniciar este flujo y controlar todo el flujo de la IU, lo que significa que no se muestra la IU de la app del operador. Con este enfoque, se omite la verificación de etiquetas BF76, y los operadores de red no necesitan implementar todo el flujo de la IU de activación de eSIM, lo que incluye la descarga de un perfil de eSIM y el manejo de errores.

Define el servicio de aprovisionamiento de eUICC del proveedor

La LPA y la app del operador se comunican a través de dos interfaces AIDL: ICarrierEuiccProvisioningService y IGetActivationCodeCallback. La app del operador debe implementar una interfaz ICarrierEuiccProvisioningService y exponerla en su declaración de manifiesto. El LPA debe vincularse a ICarrierEuiccProvisioningService e implementar IGetActivationCodeCallback. Para obtener más información sobre cómo implementar y exponer una interfaz de AIDL, consulta Cómo definir una interfaz de AIDL.

Para definir las interfaces del AIDL, crea los siguientes archivos del AIDL para las apps de LPA y de operador.

  • ICarrierEuiccProvisioningService.aidl

    package android.service.euicc;
    
    import android.service.euicc.IGetActivationCodeCallback;
    
    oneway interface ICarrierEuiccProvisioningService {
        // The method to get the activation code from the carrier app. The caller needs to pass in
        // the implementation of IGetActivationCodeCallback as the parameter.
        void getActivationCode(in IGetActivationCodeCallback callback);
    
        // The method to get the activation code from the carrier app. The caller needs to pass in
        // the activation code string as the first parameter and the implementation of
        // IGetActivationCodeCallback as the second parameter. This method provides the carrier
        // app the device EID which allows a carrier to pre-bind a profile to the device's EID before
        // the download process begins.
        void getActivationCodeForEid(in String eid, in IGetActivationCodeCallback callback);
    }
    
    
  • IGetActivationCodeCallback.aidl

    package android.service.euicc;
    
    oneway interface IGetActivationCodeCallback {
        // The call back method needs to be called when the carrier app gets the activation
        // code successfully. The caller needs to pass in the activation code string as the
        // parameter.
        void onSuccess(String activationCode);
    
        // The call back method needs to be called when the carrier app failed to get the
        // activation code.
        void onFailure();
    }
    

Ejemplo de implementación de LPA

Para vincularse a la implementación de ICarrierEuiccProvisioningService de la app del operador, la LPA debe copiar ICarrierEuiccProvisioningService.aidl y IGetActivationCodeCallback.aidl en tu proyecto y, luego, implementar ServiceConnection.

@Override
public void onServiceConnected(ComponentName componentName, IBinder iBinder) {
    mCarrierProvisioningService = ICarrierEuiccProvisioningService.Stub.asInterface(iBinder);
}

Después de vincularse a la implementación de ICarrierEuiccProvisioningService de la app del operador, la LPA llama a getActivationCode o getActivationCodeForEid para obtener el código de activación de la app del operador pasando la implementación de la clase de stub IGetActivationCodeCallback.

La diferencia entre getActivationCode y getActivationCodeForEid es que getActivationCodeForEid permite que un operador vincule previamente un perfil al EID del dispositivo antes de que comience el proceso de descarga.

void getActivationCodeFromCarrierApp() {
    IGetActivationCodeCallback.Stub callback =
            new IGetActivationCodeCallback.Stub() {
                @Override
                public void onSuccess(String activationCode) throws RemoteException {
                    // Handle the case LPA success to get activation code from a carrier app.
                }

                @Override
                public void onFailure() throws RemoteException {
                    // Handle the case LPA failed to get activation code from a carrier app.
                }
            };
    
    try {
        mCarrierProvisioningService.getActivationCode(callback);
    } catch (RemoteException e) {
        // Handle Remote Exception
    }
}

Ejemplo de implementación para una app del operador

Para que la LPA se vincule a la app del operador, esta debe copiar ICarrierEuiccProvisioningService.aidl y IGetActivationCodeCallback.aidl en tu proyecto y declarar el servicio ICarrierEuiccProvisioningService en el archivo AndroidManifest.xml. El servicio debe requerir el permiso del sistema android.permission.WRITE_EMBEDDED_SUBSCRIPTIONS para garantizar que solo la LPA, una app con privilegios del sistema, pueda vincularse a él. El servicio también debe incluir un filtro de intents con la acción android.service.euicc.action.BIND_CARRIER_PROVISIONING_SERVICE.

  • AndroidManifest.xml

    <application>
      ...
      <service
          android:name=".CarrierEuiccProvisioningService"
          android:exported="true"
          android:permission="android.permission.WRITE_EMBEDDED_SUBSCRIPTIONS">
        <intent-filter>
          <action android:name="android.service.euicc.action.BIND_CARRIER_PROVISIONING_SERVICE"/>
        </intent-filter>
      </service>
      ...
    </application>
    

Para implementar el servicio de la app de proveedor del AIDL, crea un servicio, extiende la clase Stub e implementa los métodos getActivationCode y getActivationCodeForEid. Luego, el LPA puede llamar a cualquiera de los métodos para recuperar el código de activación del perfil. La app del operador debe responder llamando a IGetActivationCodeCallback#onSuccess con el código de activación si se recuperó correctamente del servidor del operador. Si no funciona, la app del operador debería responder con IGetActivationCodeCallback#onFailure.

  • CarrierEuiccProvisioningService.java

    import android.service.euicc.ICarrierEuiccProvisioningService;
    import android.service.euicc.ICarrierEuiccProvisioningService.Stub;
    import android.service.euicc.IGetActivationCodeCallback;
    
    public class CarrierEuiccProvisioningService extends Service {
        private final ICarrierEuiccProvisioningService.Stub binder =
            new Stub() {
              @Override
              public void getActivationCode(IGetActivationCodeCallback callback) throws RemoteException {
                String activationCode = // do whatever work necessary to get an activation code (HTTP requests to carrier server, fetch from storage, etc.)
                callback.onSuccess(activationCode);
              }
    
              @Override
              public void getActivationCodeForEid(String eid, IGetActivationCodeCallback callback) throws RemoteException {
                String activationCode = // do whatever work necessary (HTTP requests, fetch from storage, etc.)
                callback.onSuccess(activationCode);
              }
          }
    }
    

Cómo iniciar la IU de una app de operador en el flujo de activación de LPA

En dispositivos con Android 11 y versiones posteriores, el LPA puede iniciar la IU de una app de operador. Esto es útil porque una app de operador podría requerir información adicional del usuario antes de proporcionar un código de activación al LPA. Por ejemplo, es posible que los operadores exijan a los usuarios que accedan para activar sus números de teléfono o realizar otros servicios de portabilidad.

Este es el proceso para iniciar la IU de una app de operador en el LPA:

  1. La LPA inicia el flujo de activación de la app del operador enviando el intent android.service.euicc.action.START_CARRIER_ACTIVATION al paquete de la app del operador que contiene la acción. (El receptor de la app del operador debe protegerse en la declaración del manifiesto con android:permission="android.permission.WRITE_EMBEDDED_SUBSCRIPTIONS" para evitar recibir intents de apps que no sean de LPA).

    String packageName = // The carrier app's package name
    
    Intent carrierAppIntent =
        new Intent(android.service.euicc.action.START_CARRIER_ACTIVATION)
            .setPackage(packageName);
    
    ResolveInfo activity =
        context.getPackageManager().resolveActivity(carrierAppIntent, 0);
    
    carrierAppIntent
        .setClassName(activity.activityInfo.packageName, activity.activityInfo.name);
    
    startActivityForResult(carrierAppIntent, requestCode);
    
  2. La app del operador realiza su trabajo con su propia IU. Por ejemplo, acceder al usuario o enviar solicitudes HTTP al backend del operador.

  3. La app del operador responde a la LPA llamando a setResult(int, Intent) y finish().

    1. Si la app del operador responde con RESULT_OK, la LPA continúa el flujo de activación. Si la app del operador determina que el usuario debe escanear un código QR en lugar de permitir que la LPA vincule el servicio de la app del operador, la app del operador responde a la LPA con setResult(int, Intent) con RESULT_OK y una instancia de Intent que contiene el android.telephony.euicc.extra.USE_QR_SCANNER booleano adicional establecido en true. Luego, el LPA verifica el elemento adicional y, en lugar de vincular la implementación de ICarrierEuiccProvisioningService de la app del operador, inicia el escáner de códigos QR.
    2. Si la app del operador falla o responde con RESULT_CANCELED (este es el código de respuesta predeterminado), la LPA cancela el flujo de activación de la eSIM.
    3. Si la app del operador responde con algo distinto de RESULT_OK o RESULT_CANCELED, el LPA lo trata como un error.

    Por motivos de seguridad, la LPA no debe aceptar directamente un código de activación proporcionado en el intent de resultado para garantizar que los llamadores que no sean de la LPA no puedan obtener un código de activación de la app del operador.

Cómo iniciar el flujo de activación de LPA en una app de operador

A partir de Android 11, las apps de operadores pueden usar las APIs de eUICC para iniciar una LUI para la activación de eSIM. Este método muestra la IU del flujo de activación de eSIM de la LPA para activar el perfil de eSIM. Luego, el LPA envía una transmisión cuando finaliza la activación del perfil de la eSIM.

  1. La LPA debe declarar una actividad que incluya un filtro de intents con la acción android.service.euicc.action.START_EUICC_ACTIVATION. La prioridad del filtro de intents debe establecerse en un valor distinto de cero en caso de que haya varias implementaciones en el dispositivo. Por ejemplo:

    <application>
      ...
    <activity
        android:name=".CarrierAppInitActivity"
        android:exported="true">
    
        <intent-filter android:priority="100">
            <action android:name="android.service.euicc.action.START_EUICC_ACTIVATION" />
        </intent-filter>
    </activity>
      ...
    </application>
    
  2. La app del operador realiza su trabajo con su propia IU. Por ejemplo, acceder al usuario o enviar solicitudes HTTP al backend del operador.

  3. En este punto, la app del operador debe estar lista para proporcionar un código de activación a través de su implementación de ICarrierEuiccProvisioningService. La app del operador inicia la LPA llamando a startActivityForResult(Intent, int) con la acción android.telephony.euicc.action.START_EUICC_ACTIVATION. El LPA también verifica el android.telephony.euicc.extra.USE_QR_SCANNER adicional booleano. Si el valor es true, la LPA inicia el escáner de códigos QR para permitir que el usuario escanee el código QR del perfil.

  4. En el lado de la LPA, esta se vincula a la implementación de ICarrierEuiccProvisioningService de la app del operador para recuperar el código de activación y descargar el perfil correspondiente. El LPA muestra todos los elementos necesarios de la IU durante la descarga, como una pantalla de carga.

  5. Cuando se completa el flujo de activación de LPA, esta responde a la app del operador con un código de resultado, que la app del operador controla en onActivityResult(int, int, Intent).

    1. Si el LPA logra descargar el nuevo perfil de eSIM, responde con RESULT_OK.
    2. Si el usuario cancela la activación del perfil de eSIM en la LPA, esta responde con RESULT_CANCELED.
    3. Si la LPA responde con algo que no sea RESULT_OK o RESULT_CANCELED, la app del operador lo trata como un error.

    Por motivos de seguridad, la LPA no acepta un código de activación directamente en el intent proporcionado para garantizar que los llamadores que no sean de la LPA no puedan obtener el código de activación de la app del operador.

Compatibilidad con varias eSIM

En el caso de los dispositivos que ejecutan Android 10 o versiones posteriores, la clase EuiccManager admite dispositivos con varias eSIM. Los dispositivos con una sola eSIM que se actualizan a Android 10 no requieren ninguna modificación en la implementación de LPA, ya que la plataforma asocia automáticamente la instancia de EuiccManager con la eUICC predeterminada. La eUICC predeterminada la determina la plataforma para dispositivos con la versión 1.2 o posterior de la HAL de radio y la LPA para dispositivos con versiones de la HAL de radio anteriores a la 1.2.

Requisitos

Para admitir varias eSIM, el dispositivo debe tener más de un eUICC, que puede ser un eUICC integrado o una ranura SIM física en la que se puedan insertar eUICC extraíbles.

Se requiere la versión 1.2 o posterior de HAL de radio para admitir varias eSIM. Se recomiendan la versión 1.4 de la HAL de Radio y la versión 1.2 de la HAL de RadioConfig.

Implementación

Para admitir varias eSIM (incluidas las eUICC extraíbles o las SIM programables), la LPA debe implementar EuiccService, que recibe el ID de zócalo correspondiente al ID de tarjeta que proporciona el llamador.

El recurso non_removable_euicc_slots especificado en arrays.xml es un array de números enteros que representan los IDs de ranura de los eUICC integrados de un dispositivo. Debes especificar este recurso para permitir que la plataforma determine si un eUICC insertado es extraíble o no.

App del operador para dispositivos con varias eSIM

Cuando crees una app de operador para un dispositivo con varias eSIM, usa el método createForCardId en EuiccManager para crear un objeto EuiccManager que esté fijado a un ID de tarjeta determinado. El ID de la tarjeta es un número entero que identifica de manera única un UICC o un eUICC en el dispositivo.

Para obtener el ID de la tarjeta de la eUICC predeterminada del dispositivo, usa el método getCardIdForDefaultEuicc en TelephonyManager. Este método muestra UNSUPPORTED_CARD_ID si la versión de HAL de radio es inferior a 1.2 y muestra UNINITIALIZED_CARD_ID si el dispositivo no leyó la eUICC.

También puedes obtener IDs de tarjeta de getUiccCardsInfo y getUiccSlotsInfo (API del sistema) en TelephonyManager, y de getCardId en SubscriptionInfo.

Cuando se crea una instancia de un objeto EuiccManager con un ID de tarjeta específico, todas las operaciones se dirigen a la eUICC con ese ID de tarjeta. Si no se puede acceder a la eUICC (por ejemplo, cuando se apaga o se quita), EuiccManager ya no funciona.

Puedes usar las siguientes muestras de código para crear una app de operador.

Ejemplo 1: Obtén una suscripción activa y crea una instancia de EuiccManager

// Get the active subscription and instantiate an EuiccManager for the eUICC which holds
// that subscription
SubscriptionManager subMan = (SubscriptionManager)
        mContext.getSystemService(Context.TELEPHONY_SUBSCRIPTION_SERVICE);
int cardId = subMan.getActiveSubscriptionInfo().getCardId();
EuiccManager euiccMan = (EuiccManager) mContext.getSystemService(Context.EUICC_SERVICE)
            .createForCardId(cardId);

Ejemplo 2: Itera a través de las UICC y crea una instancia de EuiccManager para una eUICC extraíble

// On a device with a built-in eUICC and a removable eUICC, iterate through the UICC cards
// to instantiate an EuiccManager associated with a removable eUICC
TelephonyManager telMan = (TelephonyManager)
        mContext.getSystemService(Context.TELEPHONY_SERVICE);
List<UiccCardInfo> infos = telMan.getUiccCardsInfo();
int removableCardId = -1; // valid cardIds are 0 or greater
for (UiccCardInfo info : infos) {
    if (info.isRemovable()) {
        removableCardId = info.getCardId();
        break;
    }
}
if (removableCardId != -1) {
    EuiccManager euiccMan = (EuiccManager) mContext.getSystemService(Context.EUICC_SERVICE)
            .createForCardId(removableCardId);
}

Validación

AOSP no incluye una implementación de LPA, y no se espera que tengas una LPA disponible en todas las compilaciones de Android (no todos los teléfonos admiten eSIM). Por este motivo, no hay casos de prueba de CTS de extremo a extremo. Sin embargo, los casos de prueba básicos están disponibles en AOSP para garantizar que las APIs de eUICC expuestas sean válidas en las compilaciones de Android.

Debes asegurarte de que las compilaciones pasen los siguientes casos de prueba de CTS (para las APIs públicas): /platform/cts/tests/tests/telephony/current/src/android/telephony/euicc/cts.

Los operadores que implementan una app de operador deben realizar sus ciclos normales de control de calidad interno para garantizar que todas las funciones implementadas funcionen según lo esperado. Como mínimo, la app del operador debe poder mostrar una lista de todos los perfiles de suscripción que pertenecen al mismo operador, descargar e instalar un perfil, activar un servicio en el perfil, cambiar entre perfiles y borrar perfiles.

Si creas tu propia LPA, debes realizar pruebas mucho más estrictas. Debes trabajar con tu proveedor de módem, el proveedor del chip eUICC o el proveedor del SO de eSIM, los proveedores de SM-DP+ y los operadores para resolver problemas y garantizar la interoperabilidad de tu LPA dentro de la arquitectura de RSP. Una buena cantidad de pruebas manuales es inevitable. Para obtener la mejor cobertura de pruebas, debes seguir el plan de pruebas de RSP del SGP.23 de la GSMA.