Aller au contenu principal
Pour nos nouveaux amis:

Logto est une alternative à Auth0 conçue pour les applications modernes et les produits SaaS. Il offre des services à la fois Cloud et Open-source pour vous aider à lancer rapidement votre système de gestion des identités et des accès (IAM). Profitez de l'authentification, de l'autorisation et de la gestion multi-locataires tout-en-un.

Nous recommandons de commencer avec un locataire de développement gratuit sur Logto Cloud. Cela vous permet d'explorer facilement toutes les fonctionnalités.

Dans cet article, nous allons parcourir les étapes pour construire rapidement l'expérience de connexion GitHub (GitHub App) (authentification utilisateur) avec Android (Kotlin / Java) et Logto.

Prérequis

Créer une application dans Logto​

Logto est basé sur l'authentification OpenID Connect (OIDC) et l'autorisation OAuth 2.0. Il prend en charge la gestion des identités fédérées à travers plusieurs applications, communément appelée authentification unique (SSO).

Pour créer votre application Native app, suivez simplement ces étapes :

  1. Ouvrez la Logto Console. Dans la section "Get started", cliquez sur le lien "View all" pour ouvrir la liste des frameworks d'application. Alternativement, vous pouvez naviguer vers Logto Console > Applications, et cliquer sur le bouton "Create application". Get started
  2. Dans la fenêtre modale qui s'ouvre, cliquez sur la section "Native app" ou filtrez tous les frameworks "Native app" disponibles en utilisant les cases à cocher de filtre rapide à gauche. Cliquez sur la carte du framework "Android" pour commencer à créer votre application. Frameworks
  3. Entrez le nom de l'application, par exemple, "Bookstore", et cliquez sur "Create application".

🎉 Ta-da ! Vous venez de créer votre première application dans Logto. Vous verrez une page de félicitations qui inclut un guide d'intégration détaillé. Suivez le guide pour voir quelle sera l'expérience dans votre application.

Intégrer le SDK Android​

astuce:

Installation​

remarque:

Le niveau API Android minimal pris en charge par Logto Android SDK est le niveau 24.

Avant d'installer Logto Android SDK, assurez-vous que mavenCentral() est ajouté à votre configuration de dépôt dans le fichier de construction du projet Gradle :

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

Ajoutez Logto Android SDK à vos dépendances :

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

Étant donné que le SDK nécessite un accès à Internet, vous devez ajouter la permission suivante à votre fichier 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">

  <!-- ajouter la permission internet -->
  <uses-permission android:name="android.permission.INTERNET" />

  <!-- autres configurations... -->
</manifest>

Init LogtoClient​

Créez un LogtoViewModel.kt et initialisez LogtoClient dans ce modèle de vue :

LogtoViewModel.kt
//...avec d'autres imports
import io.logto.sdk.android.LogtoClient
import io.logto.sdk.android.type.LogtoConfig

class LogtoViewModel(application: Application) : AndroidViewModel(application) {
    private val logtoConfig = LogtoConfig(
          endpoint = "<votre-point-de-terminaison-logto>",
          appId = "<votre-id-app>",
          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 {
                // Obtenez l'objet Application à partir des extras
                val application = checkNotNull(extras[APPLICATION_KEY])
                return LogtoViewModel(application) as T
            }
        }
    }
}

ensuite, créez un LogtoViewModel pour votre MainActivity.kt :

MainActivity.kt
//...avec d'autres imports
class MainActivity : AppCompatActivity() {
    private val logtoViewModel: LogtoViewModel by viewModels { LogtoViewModel.Factory }
    //...autres codes
}

Configurer l'URI de redirection​

Passons à la page des détails de l'application de Logto Console. Ajoutez une URI de redirection io.logto.android://io.logto.sample/callback et cliquez sur "Enregistrer les modifications".

URI de redirection dans Logto Console

Implémenter la connexion et la déconnexion​

remarque:

Avant d'appeler logtoClient.signIn, assurez-vous d'avoir correctement configuré l'URI de redirection dans la console d'administration.

Vous pouvez utiliser logtoClient.signIn pour connecter l'utilisateur et logtoClient.signOut pour déconnecter l'utilisateur.

Par exemple, dans une application Android :

LogtoModelView.kt
//...avec d'autres imports
class LogtoViewModel(application: Application) : AndroidViewModel(application) {
    // ...autres codes

    // Ajouter une donnée en direct pour observer le statut d'authentification
    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) }
            // Mettre à jour la donnée en direct
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }

    fun signOut() {
        logtoClient.signOut { logtoException ->
            logtoException?.let { println(it) }
            // Mettre à jour la donnée en direct
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }
}

Ensuite, appelez les méthodes signIn et signOut dans votre activité :

MainActivity.kt
class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        //...autres codes

        // Supposons que vous ayez un bouton avec l'identifiant "sign_in_button" dans votre mise en page
        val signInButton = findViewById<Button>(R.id.sign_in_button)
        signInButton.setOnClickListener {
            logtoViewModel.signIn(this)
        }

        // Supposons que vous ayez un bouton avec l'identifiant "sign_out_button" dans votre mise en page
        val signOutButton = findViewById<Button>(R.id.sign_out_button)
        signOutButton.setOnClickListener {
            if (logtoViewModel.authenticated) { // Vérifiez si l'utilisateur est authentifié
                logtoViewModel.signOut()
            }
        }

        // Observez le statut d'authentification pour mettre à jour l'interface utilisateur
        logtoViewModel.authenticated.observe(this) { authenticated ->
            if (authenticated) {
                // L'utilisateur est authentifié
                signInButton.visibility = View.GONE
                signOutButton.visibility = View.VISIBLE
            } else {
                // L'utilisateur n'est pas authentifié
                signInButton.visibility = View.VISIBLE
                signOutButton.visibility = View.GONE
            }
        }

    }
}

Point de contrôle : Testez votre application​

Maintenant, vous pouvez tester votre application :

  1. Exécutez votre application, vous verrez le bouton de connexion.
  2. Cliquez sur le bouton de connexion, le SDK initiera le processus de connexion et vous redirigera vers la page de connexion Logto.
  3. Après vous être connecté, vous serez redirigé vers votre application et verrez le bouton de déconnexion.
  4. Cliquez sur le bouton de déconnexion pour effacer le stockage des jetons et vous déconnecter.

Ajouter le connecteur GitHub (GitHub App)​

Pour activer une connexion rapide et améliorer la conversion des utilisateurs, connectez-vous avec Android en tant que fournisseur d’identité (IdP). Le connecteur social Logto vous aide à établir cette connexion en quelques minutes en permettant plusieurs entrées de paramètres.

Pour ajouter un connecteur social, suivez simplement ces étapes :

  1. Accédez à Console > Connectors > Social Connectors.
  2. Cliquez sur "Add social connector" et sélectionnez "GitHub (GitHub App)".
  3. Suivez le guide README et complétez les champs requis et personnalisez les paramètres.
Onglet Connecteur
remarque:

Si vous suivez le guide du connecteur sur place, vous pouvez passer à la section suivante.

Configurer GitHub (GitHub App)​

Étape 1 : Créer une application GitHub​

Avant de pouvoir utiliser GitHub comme fournisseur d'authentification, vous devez créer une application GitHub sur GitHub afin d'obtenir des identifiants OAuth 2.0.

  1. Rendez-vous sur GitHub et connectez-vous avec votre compte, ou créez un nouveau compte si nécessaire.
  2. Accédez à Paramètres > Paramètres développeur > Applications GitHub.
  3. Cliquez sur Nouvelle application GitHub pour enregistrer une nouvelle application :
    • Nom de l'application GitHub : Saisissez un nom unique pour votre application. Le nom ne peut pas dépasser 34 caractères et doit être unique sur GitHub.
    • URL de la page d'accueil : Saisissez l'URL de la page d'accueil de votre application.
    • URL de rappel : Copiez l'URI de rappel depuis votre connecteur GitHub Logto et collez-le ici. Vous pouvez ajouter plusieurs URL de rappel si nécessaire. Après la connexion des utilisateurs avec GitHub, ils seront redirigés ici avec un code d'autorisation que Logto utilise pour finaliser l'authentification.
    • Expirer les jetons d’autorisation utilisateur : Laissez cette option cochée (recommandé). Cela active l'expiration des jetons et les jetons de rafraîchissement pour une sécurité renforcée.
    • Demander l’autorisation utilisateur (OAuth) lors de l’installation : Cochez cette option si vous souhaitez inviter les utilisateurs à autoriser votre application lors de l'installation.
    • Webhook : Décochez Actif si vous n'avez pas besoin d'événements webhook. Pour les cas d'utilisation d'authentification uniquement, les webhooks ne sont généralement pas nécessaires.
  4. Sous Permissions, configurez les permissions dont votre application a besoin (voir l'étape 2 ci-dessous pour plus de détails).
  5. Sous Où cette application GitHub peut-elle être installée ?, sélectionnez N'importe quel compte si vous souhaitez que les utilisateurs de n'importe quel compte GitHub puissent utiliser votre application pour l'authentification.
  6. Cliquez sur Créer une application GitHub pour créer l'application GitHub.
remarque:

Contrairement aux applications OAuth, les applications GitHub utilisent des permissions fines au lieu de portées larges. Vous configurez les permissions dans le tableau de bord GitHub lors de la création de l'application, et les utilisateurs accordent l'accès à des dépôts spécifiques lors de l'autorisation.

Pour plus de détails sur la configuration des applications GitHub, consultez Enregistrer une application GitHub.

Étape 2 : Configurer les permissions dans GitHub​

Les applications GitHub utilisent des permissions fines au lieu de portées OAuth. Vous devez configurer les permissions dans le tableau de bord GitHub lors de la création ou de la modification de votre application GitHub. Ces permissions déterminent à quelles données votre application peut accéder.

Comprendre les permissions des applications GitHub​

Les permissions sont classées en trois types :

  • Permissions de dépôt : Accès aux ressources au niveau du dépôt (code, tickets, pull requests, etc.)
  • Permissions d'organisation : Accès aux ressources au niveau de l'organisation (membres, équipes, projets, etc.)
  • Permissions de compte : Accès aux données du compte utilisateur (e-mail, profil, abonnés, etc.)

Pour chaque permission, vous pouvez sélectionner :

  • Aucun accès : L'application ne peut pas accéder à cette ressource
  • Lecture seule : L'application peut lire mais pas modifier cette ressource
  • Lecture & écriture : L'application peut lire et modifier cette ressource

Pour la fonctionnalité de base "Se connecter avec GitHub", configurez au minimum ces permissions de compte :

PermissionNiveau d'accèsObjectif
Adresses e-mailLecture seuleObtenir l'adresse e-mail de l'utilisateur pour la création de compte
astuce:

Les applications GitHub ont un accès implicite à la lecture des informations de profil public lorsqu'elles agissent au nom d'un utilisateur. Vous n'avez pas besoin de demander explicitement la permission pour les données de profil de base telles que le nom d'utilisateur, l'avatar et l'URL du profil public.

Permissions supplémentaires pour l'accès à l'API​

Si votre application doit accéder aux API GitHub au-delà de l'authentification, ajoutez les permissions correspondantes dans le tableau de bord GitHub. Voici quelques exemples courants :

Type de permissionPermissionNiveau d'accèsCas d'utilisation
DépôtContenusLecture seule / Lecture & écritureAccéder aux fichiers et au code du dépôt
DépôtTicketsLecture & écritureCréer et gérer des tickets
DépôtPull requestsLecture & écritureCréer et gérer des pull requests
DépôtMétadonnéesLecture seuleAccéder aux métadonnées du dépôt (requis pour de nombreuses opérations)
OrganisationMembresLecture seuleLister les membres de l'organisation
CompteAbonnésLecture seuleAccéder aux abonnés et abonnements de l'utilisateur

Ceci n'est pas une liste exhaustive — les applications GitHub prennent en charge de nombreuses autres permissions fines. Consultez Permissions requises pour les applications GitHub pour la liste complète.

Différence clé avec les applications OAuth:

Contrairement aux applications OAuth où vous configurez les portées dans le connecteur Logto, les permissions des applications GitHub sont entièrement gérées dans le tableau de bord GitHub. Vous pouvez laisser le champ Scope vide dans votre connecteur GitHub Logto — ce n'est pas nécessaire car les applications GitHub n'utilisent pas les portées OAuth traditionnelles.

Il suffit de configurer les permissions dont vous avez besoin dans GitHub, et les utilisateurs seront invités à accorder l'accès lors de l'autorisation.

Étape 3 : Configurer votre connecteur Logto​

Après avoir créé l'application GitHub, vous serez redirigé vers sa page de paramètres où vous pourrez obtenir les identifiants.

  1. Sur la page des paramètres de votre application GitHub, copiez l'ID client et collez-le dans le champ clientId dans Logto.
  2. Sous Secrets client, cliquez sur Générer un nouveau secret client. Copiez le secret généré et collez-le dans le champ clientSecret dans Logto.
  3. Cliquez sur Enregistrer et terminer dans Logto pour connecter votre système d'identité à GitHub.
attention:

Gardez votre secret client en sécurité et ne l'exposez jamais dans du code côté client. Les secrets client GitHub ne peuvent pas être récupérés en cas de perte — vous devrez en générer un nouveau.

remarque:

L'ID client d'une application GitHub est différent de l'ID de l'application. Assurez-vous d'utiliser l'ID client (affiché comme "Client ID" sur la page des paramètres), et non l'ID de l'application.

Étape 4 : Paramètres généraux​

Voici quelques paramètres généraux qui ne bloqueront pas la connexion à GitHub mais peuvent affecter l'expérience d'authentification de l'utilisateur final.

Synchroniser les informations de profil​

Dans le connecteur GitHub, vous pouvez configurer la façon dont les informations de profil sont synchronisées depuis les informations utilisateur GitHub vers le profil utilisateur Logto, y compris name, avatar et email. Choisissez parmi les options suivantes :

  • Synchroniser uniquement lors de l'inscription : Les informations de profil sont récupérées une seule fois lors de la première connexion de l'utilisateur.
  • Toujours synchroniser lors de la connexion : Les informations de profil sont mises à jour à chaque connexion de l'utilisateur.

Stocker les jetons pour accéder aux API GitHub (Optionnel)​

Si vous souhaitez accéder aux API GitHub et effectuer des actions avec l'autorisation de l'utilisateur (que ce soit via la connexion sociale ou la liaison de compte), activez le stockage des jetons dans Logto :

  1. Configurez les permissions requises dans les paramètres de votre application GitHub (Étape 2).
  2. Activez Stocker les jetons pour un accès API persistant dans le connecteur GitHub Logto. Logto stockera en toute sécurité à la fois le jeton d’accès et le jeton de rafraîchissement dans le Secret Vault.
remarque:

Comme les applications GitHub émettent toujours des jetons de rafraîchissement, Logto stocke automatiquement les deux jetons. Le jeton d’accès expire après 8 heures, mais Logto peut utiliser le jeton de rafraîchissement pour obtenir de nouveaux jetons d’accès, garantissant un accès API ininterrompu jusqu'à 6 mois.

Étape 5 : Tester votre intégration (Optionnel)​

Avant de passer en production, testez l'intégration de votre application GitHub :

  1. Utilisez le connecteur dans un tenant de développement Logto.
  2. Vérifiez que les utilisateurs peuvent se connecter avec GitHub.
  3. Vérifiez que les utilisateurs sont invités à accorder les bonnes permissions lors de l'autorisation.
  4. Si vous avez activé le stockage des jetons, vérifiez que les jetons d’accès (et les jetons de rafraîchissement) sont correctement stockés.
  5. Testez les appels API en utilisant les jetons stockés pour vous assurer que les permissions fonctionnent comme prévu.

Les applications GitHub fonctionnent immédiatement avec n'importe quel compte utilisateur GitHub — il n'est pas nécessaire d'avoir des utilisateurs de test ou une approbation d'application comme sur d'autres plateformes. Cependant, si votre application est installée sur une organisation, les propriétaires de l'organisation devront peut-être approuver l'installation.

Enregistrer votre configuration​

Vérifiez que vous avez rempli les valeurs nécessaires dans la zone de configuration du connecteur Logto. Cliquez sur "Enregistrer et terminer" (ou "Enregistrer les modifications") et le connecteur GitHub (GitHub App) devrait être disponible maintenant.

Activer le connecteur GitHub (GitHub App) dans l'Expérience de connexion​

Une fois que vous avez créé un connecteur social avec succès, vous pouvez l'activer en tant que bouton "Continuer avec GitHub (GitHub App)" dans l'Expérience de connexion.

  1. Accédez à Console > Expérience de connexion > Inscription et connexion.
  2. (Facultatif) Choisissez "Non applicable" pour l'identifiant d'inscription si vous avez besoin uniquement de la connexion sociale.
  3. Ajoutez le connecteur GitHub (GitHub App) configuré à la section "Connexion sociale".
Onglet Expérience de connexion

Tests et validation​

Retournez à votre application Android (Kotlin / Java). Vous devriez maintenant pouvoir vous connecter avec GitHub (GitHub App). Profitez-en !

Lectures complémentaires​

Flux des utilisateurs finaux : Logto fournit des flux d'authentification prêts à l'emploi, y compris l'authentification multi-facteurs (MFA) et le SSO d’entreprise, ainsi que des API puissantes pour une mise en œuvre flexible des paramètres de compte, de la vérification de sécurité et de l'expérience multi-locataire.

Autorisation : L'autorisation définit les actions qu'un utilisateur peut effectuer ou les ressources auxquelles il peut accéder après avoir été authentifié. Découvrez comment protéger votre API pour les applications natives et monopages et mettre en œuvre le contrôle d’accès basé sur les rôles (RBAC).

Organisations : Particulièrement efficace dans les applications SaaS multi-locataires et B2B, la fonctionnalité d'organisation permet la création de locataires, la gestion des membres, le RBAC au niveau de l'organisation et l'approvisionnement juste-à-temps.

Série IAM client : Nos articles de blog en série sur la gestion des identités et des accès des clients (ou consommateurs), des sujets de base aux sujets avancés et au-delà.