Cómo construir el inicio de sesión de Alipay (Native) con Flutter

Para nuestros nuevos amigos:

Logto es una alternativa a Auth0 diseñada para aplicaciones modernas y productos SaaS. Ofrece servicios tanto de Cloud como de código abierto para ayudarte a lanzar rápidamente tu sistema de gestión e identidad (IAM). Disfruta de autenticación, autorización y gestión multi-tenant todo en uno.

Recomendamos comenzar con un tenant de desarrollo gratuito en Logto Cloud. Esto te permite explorar todas las características fácilmente.

En este artículo, repasaremos los pasos para construir rápidamente la experiencia de inicio de sesión de Alipay (Native) (autenticación de usuario) con Flutter y Logto.

Requisitos previos

Una instancia de Logto en funcionamiento. Consulta la página de introducción para comenzar.
Conocimientos básicos de Flutter.
Una cuenta de Alipay (Native) utilizable.

Crear una aplicación en Logto

Logto se basa en la autenticación OpenID Connect (OIDC) y la autorización OAuth 2.0. Admite la gestión de identidad federada a través de múltiples aplicaciones, comúnmente llamada inicio de sesión único (SSO).

Para crear tu aplicación Native app, simplemente sigue estos pasos:

Abre la Consola de Logto. En la sección "Comenzar", haz clic en el enlace "Ver todo" para abrir la lista de marcos de aplicaciones. Alternativamente, puedes navegar a Consola de Logto > Aplicaciones, y hacer clic en el botón "Crear aplicación".
En el modal que se abre, haz clic en la sección "Native app" o filtra todos los marcos "Native app" disponibles usando las casillas de filtro rápido a la izquierda. Haz clic en la tarjeta del marco "Flutter" para comenzar a crear tu aplicación.
Ingresa el nombre de la aplicación, por ejemplo, "Librería", y haz clic en "Crear aplicación".

🎉 ¡Ta-da! Acabas de crear tu primera aplicación en Logto. Verás una página de felicitaciones que incluye una guía de integración detallada. Sigue la guía para ver cómo será la experiencia en tu aplicación.

Integrar el SDK de Flutter

tip:

El paquete SDK está disponible en pub.dev y en el repositorio de GitHub de Logto.
El proyecto de ejemplo está construido usando Flutter material. Puedes encontrarlo en pub.dev.
Este SDK es compatible con aplicaciones Flutter en las plataformas iOS, Android y Web. La compatibilidad con otras plataformas no ha sido probada.

Instalación

pub.dev
GitHub

Puedes instalar el logto_dart_sdk package directamente usando el gestor de paquetes pub. Ejecuta el siguiente comando en la raíz de tu proyecto:

flutter pub add logto_dart_sdk

O añade lo siguiente a tu archivo pubspec.yaml:

dependencies:
  logto_dart_sdk: ^3.0.0

Luego ejecuta:

flutter pub get

Si prefieres bifurcar tu propia versión del SDK, puedes clonar el repositorio directamente desde GitHub.

git clone https://github.com/logto-io/dart

Dependencia y configuraciones

Compatibilidad de versiones de SDK

Versión de Logto SDK	Versión de Dart SDK	Compatible con Dart 3.0
< 2.0.0	>= 2.17.6 < 3.0.0	false
>= 2.0.0 < 3.0.0	>= 3.0.0	true
>= 3.0.0	>= 3.6.0	true

Configuración de flutter_secure_storage

En su funcionamiento interno, este SDK utiliza flutter_secure_storage para implementar el almacenamiento seguro persistente de tokens multiplataforma.

Se utiliza Keychain para iOS
Se utiliza cifrado AES para Android.

Configurar versión de Android

Establece el android:minSdkVersion a >= 18 en el archivo android/app/build.gradle de tu proyecto.

build.gradle
  android {
      ...

      defaultConfig {
          ...
          minSdkVersion 18
          ...
      }
  }

Desactivar la copia de seguridad automática en Android

Por defecto, Android realiza copias de seguridad de los datos en Google Drive. Esto puede causar la excepción java.security.InvalidKeyException:Failed al desencriptar la clave. Para evitar esto,

Para desactivar la copia de seguridad automática, ve a tu archivo de manifiesto de la aplicación y establece los atributos android:allowBackup y android:fullBackupContent en false.

AndroidManifest.xml
<manifest ... >
    ...
    <application
      android:allowBackup="false"
      android:fullBackupContent="false"
      ...
    >
        ...
    </application>
</manifest>

Excluye sharedprefs de FlutterSecureStorage.

Si necesitas mantener el android:fullBackupContent para tu aplicación en lugar de desactivarlo, puedes excluir el directorio sharedprefs de la copia de seguridad. Consulta más detalles en la documentación de Android.

En tu archivo AndroidManifest.xml, añade el atributo android:fullBackupContent al elemento <application>, como se muestra en el siguiente ejemplo. Este atributo apunta a un archivo XML que contiene reglas de copia de seguridad.
AndroidManifest.xml
```
<application ...
  android:fullBackupContent="@xml/backup_rules">
</application>
```
Crea un archivo XML llamado @xml/backup_rules en el directorio res/xml/. En este archivo, añade reglas con los elementos <include> y <exclude>. El siguiente ejemplo realiza una copia de seguridad de todas las preferencias compartidas excepto device.xml:
@xml/backup_rules
```
<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
  <exclude domain="sharedpref" path="FlutterSecureStorage"/>
</full-backup-content>
```

Por favor, consulta flutter_secure_storage para más detalles.

Configuración de flutter_web_auth_2

Detrás de escena, este SDK utiliza flutter_web_auth_2 para autenticar a los usuarios con Logto. Este paquete proporciona una forma sencilla de autenticar a los usuarios con Logto utilizando el webview del sistema o el navegador.

Este complemento utiliza ASWebAuthenticationSession en iOS 12+ y macOS 10.15+, SFAuthenticationSession en iOS 11, Chrome Custom Tabs en Android y abre una nueva ventana en la Web.

iOS: No se requiere configuración adicional

Android: Registra la URL de callback en Android

Para capturar la URL de callback desde la página de inicio de sesión de Logto, necesitarás registrar tu redirectUri de inicio de sesión en tu archivo AndroidManifest.xml.

AndroidManifest.xml
  <manifest>
    <application>
        <activity
          android:name="com.linusu.flutter_web_auth_2.CallbackActivity"
          android:exported="true">
          <intent-filter android:label="flutter_web_auth_2">
          <action android:name="android.intent.action.VIEW" />
          <category android:name="android.intent.category.DEFAULT" />
          <category android:name="android.intent.category.BROWSABLE" />
          <data android:scheme="YOUR_CALLBACK_URL_SCHEME_HERE" />
          </intent-filter>
        </activity>
    </application>
  </manifest>

Navegador web: Crea un endpoint para manejar la URL de callback

Si estás utilizando la plataforma web, necesitas crear un endpoint para manejar la URL de callback y enviarla de vuelta a la aplicación utilizando la API postMessage.

callback.html
<!doctype html>
<title>Autenticación completa</title>
<p>
  La autenticación está completa. Si esto no ocurre automáticamente, por favor cierra la ventana.
</p>
<script>
  function postAuthenticationMessage() {
    const message = {
      'flutter-web-auth-2': window.location.href,
    };

    if (window.opener) {
      window.opener.postMessage(message, window.location.origin);
      window.close();
    } else if (window.parent && window.parent !== window) {
      window.parent.postMessage(message, window.location.origin);
    } else {
      localStorage.setItem('flutter-web-auth-2', window.location.href);
      window.close();
    }
  }

  postAuthenticationMessage();
</script>

Por favor, consulta la guía de configuración en el paquete flutter_web_auth_2 para más detalles.

Integración

Inicializar LogtoClient

Importa el paquete logto_dart_sdk e inicializa la instancia de LogtoClient en la raíz de tu aplicación.

lib/main.dart
import 'package:logto_dart_sdk/logto_dart_sdk.dart';
import 'package:http/http.dart' as http;

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Flutter Demo',
      home: MyHomePage(title: 'Logto Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late LogtoClient logtoClient;

  void render() {
    // cambio de estado
  }

  // LogtoConfig
  final logtoConfig = const LogtoConfig(
    endpoint: "<your-logto-endpoint>",
    appId: "<your-app-id>"
  );

  void _init() {
    logtoClient = LogtoClient(
      config: logtoConfig,
      httpClient: http.Client(), // Cliente http opcional
    );
    render();
  }

  @override
  void initState() {
    super.initState();
    _init();
  }

  // ...
}

Antes de profundizar en los detalles, aquí tienes una visión general rápida de la experiencia del usuario final. El proceso de inicio de sesión se puede simplificar de la siguiente manera:

Tu aplicación invoca el método de inicio de sesión.
El usuario es redirigido a la página de inicio de sesión de Logto. Para aplicaciones nativas, se abre el navegador del sistema.
El usuario inicia sesión y es redirigido de vuelta a tu aplicación (configurada como el URI de redirección).

Este proceso de autenticación sigue el protocolo OpenID Connect (OIDC), y Logto aplica medidas de seguridad estrictas para proteger el inicio de sesión del usuario.
Si tienes múltiples aplicaciones, puedes usar el mismo proveedor de identidad (Logto). Una vez que el usuario inicia sesión en una aplicación, Logto completará automáticamente el proceso de inicio de sesión cuando el usuario acceda a otra aplicación.

Para aprender más sobre la lógica y los beneficios del inicio de sesión basado en redirección, consulta Experiencia de inicio de sesión de Logto explicada.

Antes de comenzar, necesitas agregar un URI de redirección en la Consola de Administración para tu aplicación.

Vamos a cambiar a la página de detalles de la aplicación en Logto Console. Añade un URI de redirección io.logto://callback y haz clic en "Guardar cambios".

Para iOS, el esquema del URI de redirección no importa realmente ya que la clase ASWebAuthenticationSession escuchará el URI de redirección independientemente de si está registrado.
Para Android, el esquema del URI de redirección debe estar registrado en el archivo AndroidManifest.xml.

Después de configurar el URI de redirección, agregamos un botón de inicio de sesión a tu página, que llamará a la API logtoClient.signIn para invocar el flujo de inicio de sesión de Logto:

lib/main.dart
class _MyHomePageState extends State<MyHomePage> {
  // ...
  final redirectUri = 'io.logto://callback';

  @override
  Widget build(BuildContext context) {
    // ...

    Widget signInButton = TextButton(
      onPressed: () async {
        await logtoClient.signIn(redirectUri);
        render();
      },
      child: const Text('Sign In'),
    );

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            signInButton,
          ],
        ),
      ),
    );
  }
}

Implementar cierre de sesión

Cambiemos a la página de detalles de la aplicación en Logto Console. Añade un URI de redirección posterior al cierre de sesión io.logto://callback y haz clic en "Guardar cambios".

URI de redirección posterior al cierre de sesión en Logto Console

URI de redirección posterior al cierre de sesión es un concepto de OAuth 2.0 que implica la ubicación a la que se debe redirigir después de cerrar sesión.

Ahora vamos a agregar un botón de cierre de sesión en la página principal para que los usuarios puedan cerrar sesión en tu aplicación.

lib/main.dart
class _MyHomePageState extends State<MyHomePage> {
  // ...

  final postSignOutRedirectUri = 'io.logto//home';

  @override
  Widget build(BuildContext context) {
    // ...

    Widget signOutButton = TextButton(
      onPressed: () async {
        await logtoClient.signOut(postSignOutRedirectUri);
        render();
      },
      child: const Text('Sign Out'),
    );

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            signInButton,
            signOutButton,
          ],
        ),
      ),
    );
  }
}

Manejar el estado de autenticación

Logto SDK proporciona un método asincrónico para verificar el estado de autenticación. El método es logtoClient.isAuthenticated. El método devuelve un valor booleano, true si el usuario está autenticado, de lo contrario false.

En el ejemplo, renderizamos condicionalmente los botones de inicio y cierre de sesión según el estado de autenticación. Ahora actualicemos el método render en nuestro Widget para manejar el cambio de estado:

lib/main.dart
class _MyHomePageState extends State<MyHomePage> {
  // ...
  bool? isAuthenticated = false;

  void render() {
    setState(() async {
      isAuthenticated = await logtoClient.isAuthenticated;
    });
  }

  @override
  Widget build(BuildContext context) {
    // ...

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            isAuthenticated == true ? signOutButton : signInButton,
          ],
        ),
      ),
    );
  }
}

Punto de control: Prueba tu aplicación

Ahora, puedes probar tu aplicación:

Ejecuta tu aplicación, verás el botón de inicio de sesión.
Haz clic en el botón de inicio de sesión, el SDK iniciará el proceso de inicio de sesión y te redirigirá a la página de inicio de sesión de Logto.
Después de iniciar sesión, serás redirigido de vuelta a tu aplicación y verás el botón de cierre de sesión.
Haz clic en el botón de cierre de sesión para limpiar el almacenamiento de tokens y cerrar sesión.

Añadir el conector Alipay (Native)

Para habilitar un inicio de sesión rápido y mejorar la conversión de usuarios, conéctate con Flutter como un proveedor de identidad (IdP). El conector social de Logto te ayuda a establecer esta conexión en minutos permitiendo la entrada de varios parámetros.

Para añadir un conector social, simplemente sigue estos pasos:

Navega a Console > Connectors > Social Connectors.
Haz clic en "Add social connector" y selecciona "Alipay (Native)".
Sigue la guía README y completa los campos requeridos y personaliza la configuración.

nota:

Si estás siguiendo la guía del Conector en el lugar, puedes omitir la siguiente sección.

Configura Alipay mobile app

Registra una cuenta de desarrollador de Alipay

Registra una cuenta de desarrollador de Alipay si aún no tienes una.

Crea y configura una aplicación de Alipay

Inicia sesión en la consola de Alipay con la cuenta que acabas de registrar.
Ve a la pestaña "Web & Mobile Apps" (网页&移动应用) en el panel "My Application" (我的应用).
Haz clic en el botón "Create an App" (立即创建) para comenzar a configurar tu aplicación.
Nombra tu aplicación en "Application Name" (应用名称) siguiendo las convenciones de nombres y sube tu "Application Icon" (应用图标), asegúrate de elegir "mobile application" (移动应用) como "App type" (应用类型). Para construir una App iOS, se requiere un "Bundle ID" único. Además, se requieren la "application signature" (应用签名) y el "application package name" (应用包名) para aplicaciones Android.
Después de terminar de crear la aplicación, llegamos a la página de Resumen, donde debemos hacer clic en "add ability" (添加能力) para agregar "Third-party application authorization" (第三方应用授权), "Get member information" (获取会员信息) y "App Alipay login" (App 支付宝登录) antes de habilitar el inicio de sesión con Alipay.
Ve al Centro de Atención al Cliente de Alipay, e inicia sesión con la cuenta de desarrollador de Alipay. Haz clic en "Account Center" (账号中心) en la barra superior y ve a "APPID binding" (APPID 绑定), cuya entrada se encuentra en la parte inferior de la barra lateral. "Add binding" (添加绑定) escribiendo el APPID de la aplicación móvil que acabas de crear en el paso 4.
Haz clic en el botón "Sign" de "App Alipay login", y completa el proceso de firma siguiendo la guía. Después de terminar este paso, deberías ver que las capacidades que agregaste en el paso 5 ya están activas.
Regresa a la página de la consola de la plataforma abierta de Alipay, y podrás encontrar "Interface signing method" (接口加签方式（密钥/证书）) en la sección "development information" (开发信息). Haz clic en el botón "set up" (设置), y te encontrarás en una página para configurar el método de firma. "Public Key" (公钥) es el modo de firma preferido, y debes rellenar el contenido del archivo de clave pública que has generado en el cuadro de texto.
Configura la "Authorization Redirect URI" (授权回调地址) haciendo clic en el botón "set up" (设置) en la parte inferior de la página de la consola de Alipay. ${your_logto_origin}/callback/${connector_id} es la URI de redirección predeterminada utilizada en Logto core. El connector_id se puede encontrar en la barra superior de la página de detalles del conector en Logto Admin Console.
Después de completar todos estos pasos, vuelve a la esquina superior derecha de la página de la consola de Alipay y haz clic en "Submit for review" (提交审核). Una vez que la revisión sea aprobada, ya puedes disfrutar de un flujo de inicio de sesión con Alipay sin problemas.

nota:

Puedes usar openssl para generar pares de claves en tu máquina local ejecutando el siguiente fragmento de código en la terminal.

openssl genrsa -out private.pem 2048
openssl rsa -in private.pem -outform PEM -pubout -out public.pem

Al rellenar la clave pública en el sitio web de configuración de la app de Alipay, necesitas eliminar el encabezado y pie de página de public.pem, borrar todos los saltos de línea y pegar el resto del contenido en el cuadro de texto para "public key".

Configura los ajustes del conector Logto Alipay Native

En el espacio de trabajo de la consola de Alipay ve al panel "My application" (我的应用) y haz clic en la pestaña "Web & Mobile Apps" (网页&移动应用), allí puedes encontrar el APPID de todas las aplicaciones.
En el paso 7 de la parte anterior, ya has generado un par de claves que incluye una clave privada y una clave pública.
Completa los ajustes del conector de Logto:
- Rellena el campo appId con el APPID que obtuviste en el paso 1.
- Rellena el campo privateKey con el contenido del archivo de clave privada mencionado en el paso 2. ASEGÚRATE de usar '\n' para reemplazar todos los saltos de línea. No necesitas eliminar el encabezado y pie de página en el archivo de clave privada.
- Rellena el campo signType con 'RSA2' debido al modo de firma Public key que elegimos en el paso 7 de "Crear y configurar aplicaciones de Alipay".

Tipos de configuración

Nombre	Tipo	Valores enum
appId	string	N/A
privateKey	string	N/A
signType	enum string	'RSA' / 'RSA2'

iOS

Suponemos que ya has integrado el Logto iOS SDK en tu app. En este caso, las cosas son bastante simples, y ni siquiera necesitas leer la documentación del SDK de Alipay:

1. Añade LogtoSocialPluginAlipay a tu proyecto Xcode

Agrega el framework:

nota:

El plugin incluye el "minimalist SDK" (极简版 SDK) de Alipay. Puedes usar directamente import AFServiceSDK una vez importado el plugin.

2. Añade el plugin a las opciones de inicialización de tu LogtoClient

let logtoClient = LogtoClient(
  useConfig: config,
  socialPlugins: [LogtoSocialPluginAlipay(callbackScheme: "your-scheme")]
)

Donde callbackScheme es uno de los custom URL Schemes que puede redirigir a tu app.

Android

Suponemos que ya has integrado el Logto Android SDK en tu app. En este caso, las cosas son bastante simples, y ni siquiera necesitas leer la documentación del SDK de Alipay:

1. Descarga el "minimalist SDK" de Alipay y agrégalo a tu proyecto

Descarga el "minimalist SDK" (极简版 SDK) de Alipay desde Logto 3rd-party Social SDKs a la carpeta app/libs de tu proyecto:

project-path/app/libs/alipaySdk-15.7.9-20200727142846.aar

2. Añade el "minimalist SDK" de Alipay como dependencia

Abre tu archivo build.gradle:

project-path/app/build.gradle

Agrega la dependencia:

dependencies {
  // ...
  implementation(files("./libs/alipaySdk-15.7.9-20200727142846.aar"))  // kotlin-script
  // o
  implementation files('./libs/alipaySdk-15.7.9-20200727142846.aar')  // groovy-script
}

Guarda tu configuración

Verifica que hayas completado los valores necesarios en el área de configuración del conector Logto. Haz clic en "Guardar y listo" (o "Guardar cambios") y el conector Alipay (Native) debería estar disponible ahora.

Una vez que crees un conector social con éxito, puedes habilitarlo como un botón "Continuar con Alipay (Native)" en la Experiencia de inicio de sesión.

Navega a Consola > Experiencia de inicio de sesión > Registro e inicio de sesión.
(Opcional) Elige "No aplicable" para el identificador de registro si solo necesitas inicio de sesión social.
Añade el conector Alipay (Native) configurado a la sección "Inicio de sesión social".

Pestaña de Experiencia de inicio de sesión

Pruebas y Validación

Regresa a tu aplicación Flutter. Ahora deberías poder iniciar sesión con Alipay (Native). ¡Disfruta!

Lecturas adicionales

Flujos de usuario final: Logto proporciona flujos de autenticación listos para usar, incluyendo MFA y SSO empresarial, junto con potentes APIs para la implementación flexible de configuraciones de cuenta, verificación de seguridad y experiencia multi-tenant.

Autorización (Authorization): La autorización define las acciones que un usuario puede realizar o los recursos a los que puede acceder después de ser autenticado. Explora cómo proteger tu API para aplicaciones nativas y de una sola página e implementar el Control de Acceso Basado en Roles (RBAC).

Organizaciones (Organizations): Particularmente efectivo en aplicaciones SaaS multi-tenant y B2B, la función de organización permite la creación de inquilinos, gestión de miembros, RBAC a nivel de organización y aprovisionamiento justo a tiempo.

Serie IAM del cliente: Nuestros artículos de blog en serie sobre la Gestión de Identidad y Acceso del Cliente (o Consumidor), desde los conceptos básicos hasta temas avanzados y más allá.

Crear una aplicación en Logto​

Integrar el SDK de Flutter​

Instalación​

Dependencia y configuraciones​

Compatibilidad de versiones de SDK​

Configuración de flutter_secure_storage​

Configurar versión de Android​

Desactivar la copia de seguridad automática en Android​

Configuración de flutter_web_auth_2​

Integración​

Inicializar LogtoClient​

Implementar inicio de sesión​

Sobre el inicio de sesión basado en redirección​

Implementar cierre de sesión​

Manejar el estado de autenticación​

Punto de control: Prueba tu aplicación​

Añadir el conector Alipay (Native)​

Configura Alipay mobile app​

Registra una cuenta de desarrollador de Alipay​

Crea y configura una aplicación de Alipay​

Configura los ajustes del conector Logto Alipay Native​

Tipos de configuración​

Habilita el inicio de sesión nativo de Alipay en tu app​

iOS​

Android​

Guarda tu configuración​

Habilitar el conector Alipay (Native) en la Experiencia de inicio de sesión​

Pruebas y Validación​

Lecturas adicionales​

Crear una aplicación en Logto

Integrar el SDK de Flutter

Instalación

Dependencia y configuraciones

Compatibilidad de versiones de SDK

Configuración de flutter_secure_storage

Configurar versión de Android

Desactivar la copia de seguridad automática en Android

Configuración de flutter_web_auth_2

Integración

Inicializar LogtoClient

Implementar inicio de sesión

Sobre el inicio de sesión basado en redirección

Implementar cierre de sesión

Manejar el estado de autenticación

Punto de control: Prueba tu aplicación

Añadir el conector Alipay (Native)

Configura Alipay mobile app

Registra una cuenta de desarrollador de Alipay

Crea y configura una aplicación de Alipay

Configura los ajustes del conector Logto Alipay Native

Tipos de configuración

Habilita el inicio de sesión nativo de Alipay en tu app

iOS

Android

Guarda tu configuración

Habilitar el conector Alipay (Native) en la Experiencia de inicio de sesión

Pruebas y Validación

Lecturas adicionales