Requisitos de configuración y sugerencias para la solución de problemas para Xamarin Android con MSAL.NET

Artículo
07/16/2024

Hay varios cambios de configuración que es necesario realizar en el código al usar Xamarin Android con la biblioteca de autenticación de Microsoft para .NET (MSAL.NET). En las secciones siguientes se describen las modificaciones necesarias, seguidas de una sección Solución de problemas para ayudarle a evitar algunos de los problemas más comunes.

Nota:

Ni la versión 4.61.0 de MSAL.NET ni las posteriores proporcionan compatibilidad con la Plataforma universal de Windows (UWP), Xamarin Android y Xamarin iOS. Se recomienda migrar las aplicaciones de Xamarin a marcos modernos, como MAUI. Obtenga más información sobre el desuso en el Anuncio del próximo desuso de MSAL.NET para Xamarin y UWP.

Definición de la actividad primaria

En Xamarin Android, establezca la actividad primaria para que el token se devuelva después de la interacción:

var authResult = AcquireTokenInteractive(scopes)
 .WithParentActivityOrWindow(parentActivity)
 .ExecuteAsync();

En MSAL.NET 4.2 y versiones posteriores, también puede establecer esta funcionalidad en el nivel de [PublicClientApplication][PublicClientApplication]. Para ello, use una devolución de llamada:

// Requires MSAL.NET 4.2 or later
var pca = PublicClientApplicationBuilder
  .Create("<your-client-id-here>")
  .WithParentActivityOrWindow(() => parentActivity)
  .Build();

Si usa CurrentActivityPlugin, el código del generador [PublicClientApplication][PublicClientApplication] debe ser similar a este fragmento de código:

// Requires MSAL.NET 4.2 or later
var pca = PublicClientApplicationBuilder
  .Create("<your-client-id-here>")
  .WithParentActivityOrWindow(() => CrossCurrentActivity.Current)
  .Build();

Asegurarse de que el control vuelve a MSAL

Cuando la parte interactiva del flujo de autenticación termine, devuelva el control a MSAL invalidando el método [Activity][Activity].[OnActivityResult()][OnActivityResult].

En la invalidación, llame al método AuthenticationContinuationHelper.Método SetAuthenticationContinuationEventArgs() para devolver el control a MSAL al final de la parte interactiva del flujo de autenticación.

protected override void OnActivityResult(int requestCode,
                                         Result resultCode,
                                         Intent data)
{
    base.OnActivityResult(requestCode, resultCode, data);

    // Return control to MSAL
    AuthenticationContinuationHelper.SetAuthenticationContinuationEventArgs(requestCode,
                                                                            resultCode,
                                                                            data);
}

Actualización del manifiesto de Android para la compatibilidad con System WebView

Para admitir System WebView , el archivo AndroidManifest.xml debe contener los siguientes valores:

<activity android:name="microsoft.identity.client.BrowserTabActivity" android:configChanges="orientation|screenSize" android:exported="true">
  <intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="msal{Client Id}" android:host="auth" />
  </intent-filter>
</activity>

El valor android:scheme se crea a partir del URI de redireccionamiento que se configura en el portal de la aplicación. Por ejemplo, si el URI de redireccionamiento es msal00001111-aaaa-2222-bbbb-3333cccc4444://auth , la entrada android:scheme del manifiesto tendría un aspecto similar al de este ejemplo:

<data android:scheme="msal00001111-aaaa-2222-bbbb-3333cccc4444" android:host="auth" />

Como alternativa, cree la actividad en el código en lugar de editar manualmente el archivo AndroidManifest.xml. Para crear la actividad en el código, cree primero una clase que incluya los atributos Activity y IntentFilter.

A continuación se muestra un ejemplo de una clase que representa los valores del archivo XML:

  [Activity(Exported = true)]
  [IntentFilter(new[] { Intent.ActionView },
        Categories = new[] { Intent.CategoryBrowsable, Intent.CategoryDefault },
        DataHost = "auth",
        DataScheme = "msal{client_id}")]
  public class MsalActivity : BrowserTabActivity
  {
  }

Uso de System WebView en la autenticación asíncrona

Para usar System WebView como reserva para la autenticación interactiva cuando ha configurado la aplicación para usar la autenticación asíncrona y el dispositivo no tiene ningún agente instalado, habilite MSAL para capturar la respuesta de autenticación mediante el URI de redireccionamiento del agente. MSAL intentará realizar la autenticación mediante la instancia de System WebView predeterminada en el dispositivo cuando detecte que el agente no está disponible. Con este valor predeterminado, se producirá un error porque el URI de redireccionamiento está configurado para usar un agente, y System WebView no sabe cómo usarlo para volver a MSAL. Para resolverlo, cree un filtro de intención mediante el URI de redireccionamiento del agente que configuró anteriormente. Agregue el filtro de intención modificando el manifiesto de la aplicación como en este ejemplo:

<!--Intent filter to capture System WebView or Authenticator calling back to our app after sign-in-->
<activity
      android:name="microsoft.identity.client.BrowserTabActivity">
    <intent-filter>
          <action android:name="android.intent.action.VIEW" />
          <category android:name="android.intent.category.DEFAULT" />
          <category android:name="android.intent.category.BROWSABLE" />
          <data android:scheme="msauth"
              android:host="Enter_the_Package_Name"
              android:path="/Enter_the_Signature_Hash" />
    </intent-filter>
</activity>

Sustituya el nombre del paquete que registró en Azure Portal por el valor android:host=. Sustituya el hash de clave que registró en Azure Portal por el valor android:path=. El hash de firma no debe estar codificado como dirección URL. Asegúrese de que aparece un carácter de barra inclinada (/) inicial al principio del hash de firma.

Manifiesto Xamarin.Forms 4.3.x

Xamarin.Forms 4.3.x genera código que establece el atributo package en com.companyname.{appName} en el archivo AndroidManifest.xml. Si usa DataScheme como msal{client_id}, es posible que desee cambiar el valor para que coincida con el del espacio de nombres MainActivity.cs.

Compatibilidad con Android 11

Para usar el explorador del sistema y la autenticación asíncrona en Android 11, primero debe declarar estos paquetes para que sean visibles para la aplicación. Las aplicaciones que tienen como destino Android 10 (API 29) y las versiones anteriores pueden consultar el sistema operativo para obtener una lista de los paquetes que están disponibles en el dispositivo en un momento dado. Para admitir la privacidad y la seguridad, Android 11 reduce la visibilidad del paquete a una lista predeterminada de paquetes de sistema operativo y los paquetes que se especifican en el archivo de AndroidManifest.xml de la aplicación.

Para permitir que la aplicación se autentique mediante el explorador del sistema y el agente, agregue la siguiente sección a AndroidManifest.xml:

<!-- Required for API Level 30 to make sure the app can detect browsers and other apps where communication is needed.-->
<!--https://developer.android.com/training/basics/intents/package-visibility-use-cases-->
<queries>
  <package android:name="com.azure.authenticator" />
  <package android:name="{Package Name}" />
  <package android:name="com.microsoft.windowsintune.companyportal" />
  <!-- Required for API Level 30 to make sure the app detect browsers
      (that don't support custom tabs) -->
  <intent>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="https" />
  </intent>
  <!-- Required for API Level 30 to make sure the app can detect browsers that support custom tabs -->
  <!-- https://developers.google.com/web/updates/2020/07/custom-tabs-android-11#detecting_browsers_that_support_custom_tabs -->
  <intent>
    <action android:name="android.support.customtabs.action.CustomTabsService" />
  </intent>
</queries>

Reemplace {Package Name} por el nombre del paquete de la aplicación.

El manifiesto actualizado, que ahora incluye compatibilidad con el explorador del sistema y la autenticación asíncrona, debe tener un aspecto similar a este ejemplo:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0" package="com.companyname.XamarinDev">
    <uses-sdk android:minSdkVersion="21" android:targetSdkVersion="30" />
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <application android:theme="@android:style/Theme.NoTitleBar">
        <activity android:name="microsoft.identity.client.BrowserTabActivity" android:configChanges="orientation|screenSize">
            <intent-filter>
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
                <data android:scheme="msal00001111-aaaa-2222-bbbb-3333cccc4444" android:host="auth" />
            </intent-filter>
            <intent-filter>
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
                <data android:scheme="msauth" android:host="com.companyname.XamarinDev" android:path="/Fc4l/5I4mMvLnF+l+XopDuQ2gEM=" />
            </intent-filter>
        </activity>
    </application>
    <!-- Required for API Level 30 to make sure we can detect browsers and other apps we want to
     be able to talk to.-->
    <!--https://developer.android.com/training/basics/intents/package-visibility-use-cases-->
    <queries>
        <package android:name="com.azure.authenticator" />
        <package android:name="com.companyname.xamarindev" />
        <package android:name="com.microsoft.windowsintune.companyportal" />
        <!-- Required for API Level 30 to make sure we can detect browsers
        (that don't support custom tabs) -->
        <intent>
            <action android:name="android.intent.action.VIEW" />
            <category android:name="android.intent.category.BROWSABLE" />
            <data android:scheme="https" />
        </intent>
        <!-- Required for API Level 30 to make sure we can detect browsers that support custom tabs -->
        <!-- https://developers.google.com/web/updates/2020/07/custom-tabs-android-11#detecting_browsers_that_support_custom_tabs -->
        <intent>
            <action android:name="android.support.customtabs.action.CustomTabsService" />
        </intent>
    </queries>
</manifest>

Uso de la vista web incrustada (opcional)

De forma predeterminada, MSAL.NET usa el explorador web del sistema. Este explorador permite obtener el inicio de sesión único (SSO) mediante aplicaciones web y otras aplicaciones. En casos excepcionales, es posible que desee que el sistema use una vista web insertada.

En este ejemplo de código se muestra cómo configurar una vista web insertada:

bool useEmbeddedWebView = !app.IsSystemWebViewAvailable;

var authResult = AcquireTokenInteractive(scopes)
 .WithParentActivityOrWindow(parentActivity)
 .WithEmbeddedWebView(useEmbeddedWebView)
 .ExecuteAsync();

Para obtener más información, consulte Uso de exploradores web (MSAL.NET) y Consideraciones del explorador del sistema de Xamarin Android.

Solución de problemas

Sugerencias generales

Actualice el paquete NuGet de MSAL.NET existente a la versión más reciente de MSAL.NET.
Verifique que Xamarin.Forms se encuentra en la versión más reciente.
Verifique que Xamarin.Android.Support.v4 se encuentra en la versión más reciente.
Asegúrese de que todos los paquetes de Xamarin.Android.Support tienen como destino la versión más reciente.
Limpie o vuelva a compilar la aplicación.
En Visual Studio, pruebe a establecer el número máximo de compilaciones de proyecto paralelas en 1. Para ello, seleccione Opciones>Proyectos y soluciones>Compilar y ejecutar>Número máximo de compilaciones de proyecto paralelas.
Si realiza la compilación desde la línea de comandos y el comando usa /m, intente quitar este elemento del comando.

Error: El nombre AuthenticationContinuationHelper no existe en el contexto actual.

Si un error indica que AuthenticationContinuationHelper no existe en el contexto actual, es posible que Visual Studio haya actualizado incorrectamente el archivo Android.csproj*. A veces, la ruta de acceso del archivo en el elemento <HintPath> contiene incorrectamente netstandard13 en lugar de monoandroid90.

Este ejemplo contiene una ruta de archivo correcta:

<Reference Include="Microsoft.Identity.Client, Version=3.0.4.0, Culture=neutral, PublicKeyToken=0a613f4dd989e8ae,
           processorArchitecture=MSIL">
  <HintPath>..\..\packages\Microsoft.Identity.Client.3.0.4-preview\lib\monoandroid90\Microsoft.Identity.Client.dll</HintPath>
</Reference>

Pasos siguientes

Para probar ejemplos adicionales, vea Aplicaciones cliente móviles públicas.

Compartir a través de