feat: es10x mss as preference (#213)

Reviewed-on: https://gitea.angry.im/PeterCxy/OpenEUICC/pulls/213
Co-authored-by: septs <github@septs.pw>
Co-committed-by: septs <github@septs.pw>

app-common/src/main/java/im/angry/openeuicc/core/DefaultEuiccChannelFactory.kt

@@ -21,7 +21,7 @@ open class DefaultEuiccChannelFactory(protected val context: Context) : EuiccCha
     override suspend fun tryOpenEuiccChannel(
         port: UiccPortInfoCompat,
         isdrAid: ByteArray
-    ): EuiccChannel? {
+    ): EuiccChannel? = try {
         if (port.portIndex != 0) {
             Log.w(
                 DefaultEuiccChannelManager.TAG,
@@ -35,58 +35,52 @@ open class DefaultEuiccChannelFactory(protected val context: Context) : EuiccCha
             DefaultEuiccChannelManager.TAG,
             "Trying OMAPI for physical slot ${port.card.physicalSlotIndex}"
         )
-        try {
-            return EuiccChannelImpl(
-                context.getString(R.string.channel_type_omapi),
+        EuiccChannelImpl(
+            context.getString(R.string.channel_type_omapi),
+            port,
+            intrinsicChannelName = null,
+            OmapiApduInterface(
+                seService!!,
                 port,
-                intrinsicChannelName = null,
-                OmapiApduInterface(
-                    seService!!,
-                    port,
-                    context.preferenceRepository.verboseLoggingFlow
-                ),
-                isdrAid,
-                context.preferenceRepository.verboseLoggingFlow,
-                context.preferenceRepository.ignoreTLSCertificateFlow,
-            ).also {
-                Log.i(DefaultEuiccChannelManager.TAG, "Is OMAPI channel, setting MSS to 60")
-                it.lpa.setEs10xMss(60)
-            }
-        } catch (_: IllegalArgumentException) {
-            // Failed
-            Log.w(
-                DefaultEuiccChannelManager.TAG,
-                "OMAPI APDU interface unavailable for physical slot ${port.card.physicalSlotIndex} with ISD-R AID: ${isdrAid.encodeHex()}."
-            )
-        }
-
-        return null
+                context.preferenceRepository.verboseLoggingFlow
+            ),
+            isdrAid,
+            context.preferenceRepository.verboseLoggingFlow,
+            context.preferenceRepository.ignoreTLSCertificateFlow,
+            context.preferenceRepository.es10xMssFlow,
+        )
+    } catch (_: IllegalArgumentException) {
+        // Failed
+        Log.w(
+            DefaultEuiccChannelManager.TAG,
+            "OMAPI APDU interface unavailable for physical slot ${port.card.physicalSlotIndex} with ISD-R AID: ${isdrAid.encodeHex()}."
+        )
+        null
     }
 
     override fun tryOpenUsbEuiccChannel(
         ccidCtx: UsbCcidContext,
         isdrAid: ByteArray
-    ): EuiccChannel? {
-        try {
-            return EuiccChannelImpl(
-                context.getString(R.string.channel_type_usb),
-                FakeUiccPortInfoCompat(FakeUiccCardInfoCompat(EuiccChannelManager.USB_CHANNEL_ID)),
-                intrinsicChannelName = ccidCtx.productName,
-                UsbApduInterface(
-                    ccidCtx
-                ),
-                isdrAid,
-                context.preferenceRepository.verboseLoggingFlow,
-                context.preferenceRepository.ignoreTLSCertificateFlow,
-            )
-        } catch (_: IllegalArgumentException) {
-            // Failed
-            Log.w(
-                DefaultEuiccChannelManager.TAG,
-                "USB APDU interface unavailable for ISD-R AID: ${isdrAid.encodeHex()}."
-            )
-        }
-        return null
+    ): EuiccChannel? = try {
+        EuiccChannelImpl(
+            context.getString(R.string.channel_type_usb),
+            FakeUiccPortInfoCompat(FakeUiccCardInfoCompat(EuiccChannelManager.USB_CHANNEL_ID)),
+            intrinsicChannelName = ccidCtx.productName,
+            UsbApduInterface(
+                ccidCtx
+            ),
+            isdrAid,
+            context.preferenceRepository.verboseLoggingFlow,
+            context.preferenceRepository.ignoreTLSCertificateFlow,
+            context.preferenceRepository.es10xMssFlow,
+        )
+    } catch (_: IllegalArgumentException) {
+        // Failed
+        Log.w(
+            DefaultEuiccChannelManager.TAG,
+            "USB APDU interface unavailable for ISD-R AID: ${isdrAid.encodeHex()}."
+        )
+        null
     }
 
     override fun cleanup() {

app-common/src/main/java/im/angry/openeuicc/core/EuiccChannelImpl.kt

@@ -1,8 +1,9 @@
 package im.angry.openeuicc.core
 
 import im.angry.openeuicc.util.UiccPortInfoCompat
-import im.angry.openeuicc.util.decodeHex
 import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.runBlocking
 import net.typeblog.lpac_jni.ApduInterface
 import net.typeblog.lpac_jni.LocalProfileAssistant
 import net.typeblog.lpac_jni.impl.HttpInterfaceImpl
@@ -15,7 +16,8 @@ class EuiccChannelImpl(
     override val apduInterface: ApduInterface,
     override val isdrAid: ByteArray,
     verboseLoggingFlow: Flow<Boolean>,
-    ignoreTLSCertificateFlow: Flow<Boolean>
+    ignoreTLSCertificateFlow: Flow<Boolean>,
+    es10xMssFlow: Flow<Int>,
 ) : EuiccChannel {
     override val slotId = port.card.physicalSlotIndex
     override val logicalSlotId = port.logicalSlotIndex
@@ -25,8 +27,10 @@ class EuiccChannelImpl(
         LocalProfileAssistantImpl(
             isdrAid,
             apduInterface,
-            HttpInterfaceImpl(verboseLoggingFlow, ignoreTLSCertificateFlow)
-        )
+            HttpInterfaceImpl(verboseLoggingFlow, ignoreTLSCertificateFlow),
+        ).also {
+            it.setEs10xMss(runBlocking { es10xMssFlow.first().toByte() })
+        }
 
     override val atr: ByteArray?
         get() = (apduInterface as? ApduInterfaceAtrProvider)?.atr

app-common/src/main/java/im/angry/openeuicc/ui/SettingsFragment.kt

@@ -8,6 +8,7 @@ import android.provider.Settings
 import android.widget.Toast
 import androidx.lifecycle.lifecycleScope
 import androidx.preference.CheckBoxPreference
+import androidx.preference.ListPreference
 import androidx.preference.Preference
 import androidx.preference.PreferenceCategory
 import androidx.preference.PreferenceFragmentCompat
@@ -16,7 +17,6 @@ import im.angry.openeuicc.util.*
 import kotlinx.coroutines.flow.collect
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.launch
-import kotlinx.coroutines.runBlocking
 
 open class SettingsFragment: PreferenceFragmentCompat() {
     private lateinit var developerPref: PreferenceCategory
@@ -84,6 +84,9 @@ open class SettingsFragment: PreferenceFragmentCompat() {
         requirePreference<CheckBoxPreference>("pref_developer_euicc_memory_reset")
             .bindBooleanFlow(preferenceRepository.euiccMemoryResetFlow)
 
+        requirePreference<ListPreference>("pref_developer_es10x_mss")
+            .bindIntFlow(preferenceRepository.es10xMssFlow, 63)
+
         requirePreference<Preference>("pref_developer_isdr_aid_list").apply {
             intent = Intent(requireContext(), IsdrAidListActivity::class.java)
         }
@@ -127,13 +130,26 @@ open class SettingsFragment: PreferenceFragmentCompat() {
         }
 
         setOnPreferenceChangeListener { _, newValue ->
-            runBlocking {
+            lifecycleScope.launch {
                 flow.updatePreference(newValue as Boolean)
             }
             true
         }
     }
 
+    private fun ListPreference.bindIntFlow(flow: PreferenceFlowWrapper<Int>, defaultValue: Int) {
+        lifecycleScope.launch {
+            flow.collect { value = it.toString() }
+        }
+
+        setOnPreferenceChangeListener { _, newValue ->
+            lifecycleScope.launch {
+                flow.updatePreference((newValue as String).toIntOrNull() ?: defaultValue)
+            }
+            true
+        }
+    }
+
     protected fun mergePreferenceOverlay(overlayKey: String, targetKey: String) {
         val overlayCat = requirePreference<PreferenceCategory>(overlayKey)
         val targetCat = requirePreference<PreferenceCategory>(targetKey)

app-common/src/main/java/im/angry/openeuicc/util/PreferenceUtils.kt

@@ -5,6 +5,7 @@ import androidx.datastore.core.DataStore
 import androidx.datastore.preferences.core.Preferences
 import androidx.datastore.preferences.core.booleanPreferencesKey
 import androidx.datastore.preferences.core.edit
+import androidx.datastore.preferences.core.intPreferencesKey
 import androidx.datastore.preferences.core.stringPreferencesKey
 import androidx.datastore.preferences.preferencesDataStore
 import androidx.fragment.app.Fragment
@@ -38,6 +39,7 @@ internal object PreferenceKeys {
     val IGNORE_TLS_CERTIFICATE = booleanPreferencesKey("ignore_tls_certificate")
     val EUICC_MEMORY_RESET = booleanPreferencesKey("euicc_memory_reset")
     val ISDR_AID_LIST = stringPreferencesKey("isdr_aid_list")
+    val ES10X_MSS = intPreferencesKey("es10x_mss")
 }
 
 const val EUICC_DEFAULT_ISDR_AID = "A0000005591010FFFFFFFF8900000100"
@@ -89,6 +91,7 @@ open class PreferenceRepository(private val context: Context) {
         PreferenceConstants.DEFAULT_AID_LIST,
         { Base64.getEncoder().encodeToString(it.encodeToByteArray()) },
         { Base64.getDecoder().decode(it).decodeToString() })
+    val es10xMssFlow = bindFlow(PreferenceKeys.ES10X_MSS, 63)
 
     protected fun <T> bindFlow(
         key: Preferences.Key<T>,

app-common/src/main/res/values/strings.xml

@@ -200,6 +200,16 @@
     <string name="pref_developer_ignore_tls_certificate_desc">Accept any TLS certificate used by the RSP server</string>
     <string name="pref_developer_euicc_memory_reset">Allow erasing eUICC</string>
     <string name="pref_developer_euicc_memory_reset_desc">This is a dangerous operation and hidden by default. As an alternative, you can delete all profiles manually.</string>
+    <string name="pref_developer_es10x_mss">ES10x MSS</string>
+    <string name="pref_developer_es10x_mss_desc">Global ES10x MSS</string>
+    <string-array name="pref_developer_es10x_entry_keys">
+        <item>High Speed</item>
+        <item>Compatibility Mode</item>
+    </string-array>
+    <string-array name="pref_developer_es10x_entry_values" translatable="false">
+        <item>255</item>
+        <item>63</item>
+    </string-array>
     <string name="pref_developer_isdr_aid_list">Customize ISD-R AID list</string>
     <string name="pref_developer_isdr_aid_list_desc">Some brands of removable eUICCs may use their own non-standard ISD-R AID, rendering them inaccessible to third-party apps. We can attempt to use non-standard AIDs added in this list, but there is no guarantee that they will work.</string>
     <string name="pref_info">Info</string>

app-common/src/main/res/xml/pref_settings.xml

@@ -81,6 +81,14 @@
             app:summary="@string/pref_developer_euicc_memory_reset_desc"
             app:title="@string/pref_developer_euicc_memory_reset" />
 
+        <ListPreference
+            app:iconSpaceReserved="false"
+            app:key="pref_developer_es10x_mss"
+            app:summary="@string/pref_developer_es10x_mss_desc"
+            app:title="@string/pref_developer_es10x_mss"
+            app:entries="@array/pref_developer_es10x_entry_keys"
+            app:entryValues="@array/pref_developer_es10x_entry_values" />
+
         <Preference
             app:iconSpaceReserved="false"
             app:key="pref_developer_isdr_aid_list"

app/src/main/java/im/angry/openeuicc/core/PrivilegedEuiccChannelFactory.kt

@@ -42,6 +42,7 @@ class PrivilegedEuiccChannelFactory(context: Context) : DefaultEuiccChannelFacto
                     isdrAid,
                     context.preferenceRepository.verboseLoggingFlow,
                     context.preferenceRepository.ignoreTLSCertificateFlow,
+                    context.preferenceRepository.es10xMssFlow,
                 )
             } catch (_: IllegalArgumentException) {
                 // Failed