Cómo construir el inicio de sesión de SAML con Android (Kotlin / Java)

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 SAML (autenticación de usuario) con Android (Kotlin / Java) y Logto.

Requisitos previos

Una instancia de Logto en funcionamiento. Consulta la página de introducción para comenzar.
Conocimientos básicos de Android (Kotlin / Java).
Una cuenta de SAML 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 Aplicación nativa, 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 "Aplicación nativa" o filtra todos los marcos "Aplicación nativa" disponibles usando las casillas de filtro rápido a la izquierda. Haz clic en la tarjeta del marco "Android" 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 Android

tip:

El ejemplo se basa en View system y View Model, pero los conceptos son los mismos al usar Jetpack Compose.
El ejemplo está escrito en Kotlin, pero los conceptos son los mismos para Java.
Los proyectos de ejemplo tanto en Kotlin como en Java están disponibles en nuestro repositorio SDK.
El video tutorial está disponible en nuestro canal de YouTube.

Instalación

nota:

El nivel mínimo de API de Android compatible con Logto Android SDK es el nivel 24.

Antes de instalar Logto Android SDK, asegúrate de que mavenCentral() esté agregado a la configuración de tu repositorio en el archivo de construcción del proyecto Gradle:

settings.gradle.kts
dependencyResolutionManagement {
  repositories {
    mavenCentral()
  }
}

Añade Logto Android SDK a tus dependencias:

Kotlin
Groovy

build.gradle.kts
dependencies {
  implementation("io.logto.sdk:android:1.1.3")
}

build.gradle
dependencies {
  implementation 'io.logto.sdk:android:1.1.3'
}

Dado que el SDK necesita acceso a internet, debes añadir el siguiente permiso a tu archivo AndroidManifest.xml:

AndroidManifest.xml
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:tools="http://schemas.android.com/tools">

  <!-- añadir permiso de internet -->
  <uses-permission android:name="android.permission.INTERNET" />

  <!-- otras configuraciones... -->
</manifest>

Inicializar LogtoClient

Crea un LogtoViewModel.kt e inicializa LogtoClient en este modelo de vista:

LogtoViewModel.kt
//...con otras importaciones
import io.logto.sdk.android.LogtoClient
import io.logto.sdk.android.type.LogtoConfig

class LogtoViewModel(application: Application) : AndroidViewModel(application) {
    private val logtoConfig = LogtoConfig(
          endpoint = "<your-logto-endpoint>",
          appId = "<your-app-id>",
          scopes = null,
          resources = null,
          usingPersistStorage = true,
    )

    private val logtoClient = LogtoClient(logtoConfig, application)

    companion object {
        val Factory: ViewModelProvider.Factory = object : ViewModelProvider.Factory {
            @Suppress("UNCHECKED_CAST")
            override fun <T : ViewModel> create(
                modelClass: Class<T>,
                extras: CreationExtras
            ): T {
                // Obtén el objeto Application de extras
                val application = checkNotNull(extras[APPLICATION_KEY])
                return LogtoViewModel(application) as T
            }
        }
    }
}

luego, crea un LogtoViewModel para tu MainActivity.kt:

MainActivity.kt
//...con otras importaciones
class MainActivity : AppCompatActivity() {
    private val logtoViewModel: LogtoViewModel by viewModels { LogtoViewModel.Factory }
    //...otros códigos
}

Configurar URI de redirecció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.android://io.logto.sample/callback y haz clic en "Guardar cambios".

nota:

Antes de llamar a logtoClient.signIn, asegúrate de haber configurado correctamente el URI de redirección en la Consola de Administración.

Puedes usar logtoClient.signIn para iniciar sesión del usuario y logtoClient.signOut para cerrar sesión del usuario.

Por ejemplo, en una aplicación Android:

LogtoModelView.kt
//...con otras importaciones
class LogtoViewModel(application: Application) : AndroidViewModel(application) {
    // ...otros códigos

    // Añadir un live data para observar el estado de autenticación
    private val _authenticated = MutableLiveData(logtoClient.isAuthenticated)
    val authenticated: LiveData<Boolean>
        get() = _authenticated

    fun signIn(context: Activity) {
        logtoClient.signIn(context, "io.logto.android://io.logto.sample/callback") { logtoException ->
            logtoException?.let { println(it) }
            // Actualizar el live data
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }

    fun signOut() {
        logtoClient.signOut { logtoException ->
            logtoException?.let { println(it) }
            // Actualizar el live data
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }
}

Luego llama a los métodos signIn y signOut en tu actividad:

MainActivity.kt
class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        //...otros códigos

        // Supón que tienes un botón con id "sign_in_button" en tu diseño
        val signInButton = findViewById<Button>(R.id.sign_in_button)
        signInButton.setOnClickListener {
            logtoViewModel.signIn(this)
        }

        // Supón que tienes un botón con id "sign_out_button" en tu diseño
        val signOutButton = findViewById<Button>(R.id.sign_out_button)
        signOutButton.setOnClickListener {
            if (logtoViewModel.authenticated) { // Verifica si el usuario está autenticado
                logtoViewModel.signOut()
            }
        }

        // Observa el estado de autenticación para actualizar la interfaz de usuario
        logtoViewModel.authenticated.observe(this) { authenticated ->
            if (authenticated) {
                // El usuario está autenticado
                signInButton.visibility = View.GONE
                signOutButton.visibility = View.VISIBLE
            } else {
                // El usuario no está autenticado
                signInButton.visibility = View.VISIBLE
                signOutButton.visibility = View.GONE
            }
        }

    }
}

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 SAML

Para habilitar un inicio de sesión rápido y mejorar la conversión de usuarios, conéctate con Android 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 "SAML".
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 Aplicación SAML estándar

Vamos a revisar las configuraciones del conector SAML.

Antes de comenzar, puedes ir a un proveedor de identidad social que soporte el protocolo SAML y crear tu propia cuenta. Okta, OneLogin, Salesforce y algunas otras plataformas soportan autenticación basada en el protocolo SAML.

Si tu IdP requiere el cifrado de la aserción SAML y la recepción de solicitudes de autenticación firmadas, debes generar tu clave privada y el certificado correspondiente usando el algoritmo RSA. Guarda la clave privada para el uso de tu SP y sube el certificado al IdP.

También necesitas configurar la URL de ACS (Assertion Consumer Service) como ${your_logto_origin}/api/authn/saml/${connector_id} para manejar la aserción SAML del IdP. Puedes encontrar tu connectorId en la página de detalles del conector SAML en la Consola de Administración de Logto.

nota:

Según el diseño actual de Logto, solo soportamos Redirect-binding para enviar solicitudes de autenticación y POST-binding para recibir aserciones SAML. Aunque esto no suena muy bien, creemos que el diseño actual puede manejar la mayoría de tus casos de uso. Si tienes algún problema, ¡no dudes en contactarnos!

Configurar el conector SAML (SP)

En esta sección, presentaremos cada atributo en detalle.

entityID `Requerido`

entityID (es decir, issuer) es el identificador de la entidad. Se utiliza para identificar tu entidad (entidad SAML SP) y hacer coincidir la equivalencia en cada solicitud/respuesta SAML.

signInEndpoint `Requerido`

El endpoint del IdP al que envías solicitudes de autenticación SAML. Por lo general, puedes encontrar este valor en la página de detalles del IdP (es decir, SSO URL o Login URL del IdP).

x509Certificate `Requerido`

El certificado x509 generado a partir de la clave privada del IdP, se espera que el IdP tenga este valor disponible.

El contenido del certificado viene con el encabezado -----BEGIN CERTIFICATE----- y el final -----END CERTIFICATE-----.

idpMetadataXml `Requerido`

El campo se utiliza para colocar contenidos de tu archivo XML de metadatos del IdP.

nota:

El analizador XML que estamos usando no soporta espacios de nombres personalizados. Si los metadatos del IdP vienen con espacio de nombres, debes eliminarlos manualmente. Para el espacio de nombres del archivo XML, consulta referencia.

assertionConsumerServiceUrl `Requerido`

La URL del servicio consumidor de aserciones (ACS) es el endpoint del SP para recibir solicitudes POST de aserciones SAML del IdP. Como mencionamos en la parte anterior, generalmente se configura en la configuración del IdP, pero algunos IdP obtienen este valor de las solicitudes de autenticación SAML, por lo que también agregamos este valor como un campo REQUERIDO. Su valor debería verse como ${your_logto_origin}/api/authn/saml/${connector_id}.

signAuthnRequest

El valor booleano que controla si la solicitud de autenticación SAML debe estar firmada, cuyo valor predeterminado es false.

encryptAssertion

encryptAssertion es un valor booleano que indica si el IdP cifrará la aserción SAML, con un valor predeterminado de false.

nota:

Los atributos signAuthnRequest y encryptAssertion deben alinearse con los parámetros correspondientes de la configuración del IdP, de lo contrario se lanzará un error para mostrar que la configuración no coincide. Todas las respuestas SAML deben estar firmadas.

requestSignatureAlgorithm

Esto debe alinearse con los algoritmos de firma del IdP para que Logto pueda verificar la firma de la aserción SAML. Su valor debe ser http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 o http://www.w3.org/2001/04/xmldsig-more#rsa-sha512 y el valor predeterminado es http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

messageSigningOrder

messageSigningOrder indica el orden de firma y cifrado del IdP, su valor debe ser sign-then-encrypt o encrypt-then-sign y el valor predeterminado es sign-then-encrypt.

privateKey y privateKeyPass

privateKey es un valor OPCIONAL y es requerido cuando signAuthnRequest es true.

privateKeyPass es la contraseña que has establecido al crear privateKey, requerida cuando sea necesario.

Si signAuthnRequest es true, el certificado correspondiente generado a partir de privateKey es requerido por el IdP para verificar la firma.

encPrivateKey y encPrivateKeyPass

encPrivateKey es un valor OPCIONAL y es requerido cuando encryptAssertion es true.

encPrivateKeyPass es la contraseña que has establecido al crear encPrivateKey, requerida cuando sea necesario.

Si encryptAssertion es true, el certificado correspondiente generado a partir de encPrivateKey es requerido por el IdP para cifrar la aserción SAML.

nota:

Para la generación de claves y certificados, openssl es una herramienta maravillosa. Aquí hay una línea de comando de ejemplo que podría ser útil:

openssl genrsa -passout pass:${privateKeyPassword} -out ${encryptPrivateKeyFilename}.pem 4096
openssl req -new -x509 -key ${encryptPrivateKeyFilename}.pem -out ${encryptionCertificateFilename}.cer -days 3650

Los archivos privateKey y encPrivateKey deben estar codificados en el esquema pkcs1 como cadena pem, lo que significa que los archivos de clave privada deben comenzar con -----BEGIN RSA PRIVATE KEY----- y terminar con -----END RSA PRIVATE KEY-----.

nameIDFormat

nameIDFormat es un atributo OPCIONAL que declara el formato de identificación de nombre que respondería. El valor puede ser urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified, urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent y urn:oasis:names:tc:SAML:2.0:nameid-format:transient, y el valor predeterminado es urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified.

timeout

timeout es la tolerancia de tiempo para la validación de tiempo, ya que el tiempo entre tu entidad SP y la entidad IdP podría ser diferente y la conexión de red también puede traer algún retraso. La unidad es en milisegundos, y el valor predeterminado es 5000 (es decir, 5s).

profileMap

Logto también proporciona un campo profileMap que los usuarios pueden personalizar el mapeo desde los perfiles de los proveedores sociales que generalmente no son estándar. Cada clave de profileMap es el nombre del campo de perfil de usuario estándar de Logto y el valor correspondiente debe ser el nombre del campo de perfil social. En la etapa actual, Logto solo se preocupa por 'id', 'name', 'avatar', 'email' y 'phone' del perfil social, solo 'id' es REQUERIDO y los demás son campos opcionales.

Tipos de configuración

Nombre	Tipo	Requerido	Valor predeterminado
signInEndpoint	string	true
x509certificate	string	true
idpMetadataXml	string	true
entityID	string	true
assertionConsumerServiceUrl	string	true
messageSigningOrder	`encrypt-then-sign` \| `sign-then-encrypt`	false	`sign-then-encrypt`
requestSignatureAlgorithm	`http://www.w3.org/2000/09/xmldsig#rsa-sha1` \| `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` \| `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512`	false	`http://www.w3.org/2001/04/xmldsig-more#rsa-sha256`
signAuthnRequest	boolean	false	false
encryptAssertion	boolean	false	false
privateKey	string	false
privateKeyPass	string	false
nameIDFormat	`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified` \| `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` \| `urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName` \| `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` \| `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`	false	`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`
timeout	number	false	5000
profileMap	ProfileMap	false

Campos de ProfileMap	Tipo	Requerido	Valor predeterminado
id	string	false	id
name	string	false	name
avatar	string	false	avatar
email	string	false	email
phone	string	false	phone

Referencia

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 SAML debería estar disponible ahora.

Una vez que crees un conector social con éxito, puedes habilitarlo como un botón "Continuar con SAML" 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 SAML 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 Android (Kotlin / Java). Ahora deberías poder iniciar sesión con SAML. ¡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 Android​

Instalación​

Inicializar LogtoClient​

Configurar URI de redirección​

Implementar inicio y cierre de sesión​

Punto de control: Prueba tu aplicación​

Añadir el conector SAML​

Configura Aplicación SAML estándar​

Crear cuenta de IdP social y registrar aplicación SAML (IdP)​

Configurar el conector SAML (SP)​

entityID Requerido​

signInEndpoint Requerido​

x509Certificate Requerido​

idpMetadataXml Requerido​

assertionConsumerServiceUrl Requerido​

signAuthnRequest​

encryptAssertion​

requestSignatureAlgorithm​

messageSigningOrder​

privateKey y privateKeyPass​

encPrivateKey y encPrivateKeyPass​

nameIDFormat​

timeout​

profileMap​

Tipos de configuración​

Referencia​

Guarda tu configuración​

Habilitar el conector SAML en la Experiencia de inicio de sesión​

Pruebas y Validación​

Lecturas adicionales​

Crear una aplicación en Logto

Integrar el SDK de Android

Instalación

Inicializar LogtoClient

Configurar URI de redirección

Implementar inicio y cierre de sesión

Punto de control: Prueba tu aplicación

Añadir el conector SAML

Configura Aplicación SAML estándar

Crear cuenta de IdP social y registrar aplicación SAML (IdP)

Configurar el conector SAML (SP)

entityID `Requerido`

signInEndpoint `Requerido`

x509Certificate `Requerido`

idpMetadataXml `Requerido`

assertionConsumerServiceUrl `Requerido`

signAuthnRequest

encryptAssertion

requestSignatureAlgorithm

messageSigningOrder

privateKey y privateKeyPass

encPrivateKey y encPrivateKeyPass

nameIDFormat

timeout

profileMap

Tipos de configuración

Referencia

Guarda tu configuración

Habilitar el conector SAML en la Experiencia de inicio de sesión

Pruebas y Validación

Lecturas adicionales