Comment construire une connexion SAML avec .NET Core (Blazor Server)

Pour nos nouveaux amis:

Logto est une alternative à Auth0 conçue pour les applications modernes et les produits SaaS. Il offre des services 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 passer en revue les étapes pour construire rapidement l'expérience de connexion SAML (authentification utilisateur) avec .NET Core (Blazor Server) et Logto.

Prérequis

Une instance Logto en cours d'exécution. Consultez la page d'introduction pour commencer.
Connaissances de base de .NET Core (Blazor Server).
Un compte SAML utilisable.

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 Application web traditionnelle, suivez simplement ces étapes :

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".
Dans la fenêtre modale qui s'ouvre, cliquez sur la section "Application web traditionnelle" ou filtrez tous les frameworks "Application web traditionnelle" disponibles en utilisant les cases à cocher de filtre rapide à gauche. Cliquez sur la carte du framework ".Net Core (Blazor Server)" pour commencer à créer votre application.
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 .Net Core (Blazor Server)

astuce:

La démonstration suivante est construite sur .NET Core 8.0. Le SDK est compatible avec .NET 6.0 ou supérieur.
Les projets d'exemple .NET Core sont disponibles dans le répertoire GitHub.

Installation

Ajoutez le package NuGet à votre projet :

dotnet add package Logto.AspNetCore.Authentication

Ajouter l'authentification Logto

Ouvrez Startup.cs (ou Program.cs) et ajoutez le code suivant pour enregistrer les services d'authentification Logto :

Program.cs
using Logto.AspNetCore.Authentication;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddLogtoAuthentication(options =>
{
  options.Endpoint = builder.Configuration["Logto:Endpoint"]!;
  options.AppId = builder.Configuration["Logto:AppId"]!;
  options.AppSecret = builder.Configuration["Logto:AppSecret"];
});

La méthode AddLogtoAuthentication effectuera les actions suivantes :

Définir le schéma d'Authentification (Authentication) par défaut sur LogtoDefaults.CookieScheme.
Définir le schéma de défi par défaut sur LogtoDefaults.AuthenticationScheme.
Définir le schéma de déconnexion par défaut sur LogtoDefaults.AuthenticationScheme.
Ajouter des gestionnaires d'authentification par cookie et OpenID Connect au schéma d'authentification.

Avant de continuer, il y a deux termes confus dans le middleware d'authentification .NET Core que nous devons clarifier :

CallbackPath : L'URI vers laquelle Logto redirigera l'utilisateur après que l'utilisateur se soit connecté (l'"URI de redirection" dans Logto)
RedirectUri : L'URI vers laquelle sera redirigé après que les actions nécessaires ont été prises dans le middleware d'Authentification (Authentication) Logto.

Le processus de connexion peut être illustré comme suit :

De même, .NET Core a également SignedOutCallbackPath et RedirectUri pour le flux de déconnexion.

Pour plus de clarté, nous les appellerons comme suit :

Terme que nous utilisons	Terme .NET Core
URI de redirection Logto	CallbackPath
URI de redirection post-déconnexion Logto	SignedOutCallbackPath
URI de redirection de l'application	RedirectUri

Ce processus d'authentification (Authentication) suit le protocole OpenID Connect (OIDC), et Logto applique des mesures de sécurité strictes pour protéger la connexion utilisateur.
Si vous avez plusieurs applications, vous pouvez utiliser le même fournisseur d’identité (Logto). Une fois que l'utilisateur se connecte à une application, Logto complétera automatiquement le processus de connexion lorsque l'utilisateur accède à une autre application.

Pour en savoir plus sur la logique et les avantages de la connexion basée sur la redirection, consultez Expérience de connexion Logto expliquée.

Configurer les URIs de redirection

remarque:

Dans les extraits de code suivants, nous supposons que votre application fonctionne sur http://localhost:3000/.

Tout d'abord, configurons l' URI de redirection Logto. Ajoutez l'URI suivante à la liste des "URIs de redirection" sur la page des détails de l'application Logto :

http://localhost:3000/Callback

Pour configurer l' URI de redirection après déconnexion Logto, ajoutez l'URI suivante à la liste des "URIs de redirection après déconnexion" sur la page des détails de l'application Logto :

http://localhost:3000/SignedOutCallback

Modifier les chemins par défaut

L' URI de redirection Logto a un chemin par défaut de /Callback, et l' URI de redirection après déconnexion Logto a un chemin par défaut de /SignedOutCallback.

Vous pouvez les laisser tels quels s'il n'y a pas de besoin particulier. Si vous souhaitez les modifier, vous pouvez définir la propriété CallbackPath et SignedOutCallbackPath pour LogtoOptions :

Program.cs
builder.Services.AddLogtoAuthentication(options =>
{
  // Autres configurations...
  options.CallbackPath = "/Foo";
  options.SignedOutCallbackPath = "/Bar";
});

N'oubliez pas de mettre à jour la valeur sur la page des détails de l'application Logto en conséquence.

Ajouter des routes

Étant donné que Blazor Server utilise SignalR pour communiquer entre le serveur et le client, cela signifie que les méthodes qui manipulent directement le contexte HTTP (comme l'émission de défis ou de redirections) ne fonctionnent pas comme prévu lorsqu'elles sont appelées depuis un composant Blazor.

Pour corriger cela, nous devons explicitement ajouter deux points de terminaison pour les redirections de connexion et de déconnexion :

Program.cs
app.MapGet("/SignIn", async context =>
{
    if (!(context.User?.Identity?.IsAuthenticated ?? false))
    {
        await context.ChallengeAsync(new AuthenticationProperties { RedirectUri = "/" });
    } else {
        context.Response.Redirect("/");
    }
});

app.MapGet("/SignOut", async context =>
{
    if (context.User?.Identity?.IsAuthenticated ?? false)
    {
        await context.SignOutAsync(new AuthenticationProperties { RedirectUri = "/" });
    } else {
        context.Response.Redirect("/");
    }
});

Nous pouvons maintenant rediriger vers ces points de terminaison pour déclencher la connexion et la déconnexion.

Implémenter les boutons de connexion / déconnexion

Dans le composant Razor, ajoutez le code suivant :

Components/Pages/Index.razor
@using Microsoft.AspNetCore.Components.Authorization
@using System.Security.Claims
@inject AuthenticationStateProvider AuthenticationStateProvider
@inject NavigationManager NavigationManager

@* ... *@

<p>Est authentifié : @User.Identity?.IsAuthenticated</p>
@if (User.Identity?.IsAuthenticated == true)
{
    <button @onclick="SignOut">Se déconnecter</button>
}
else
{
    <button @onclick="SignIn">Se connecter</button>
}

@* ... *@

@code {
    private ClaimsPrincipal? User { get; set; }

    protected override async Task OnInitializedAsync()
    {
        var authState = await AuthenticationStateProvider.GetAuthenticationStateAsync();
        User = authState.User;
    }

    private void SignIn()
    {
        NavigationManager.NavigateTo("/SignIn", forceLoad: true);
    }

    private void SignOut()
    {
        NavigationManager.NavigateTo("/SignOut", forceLoad: true);
    }
}

Explication :

Le AuthenticationStateProvider injecté est utilisé pour obtenir l'état d'authentification de l'utilisateur actuel et remplir la propriété User.
Les méthodes SignIn et SignOut sont utilisées pour rediriger l'utilisateur vers les points de terminaison de connexion et de déconnexion respectivement. En raison de la nature de Blazor Server, nous devons utiliser NavigationManager avec un chargement forcé pour déclencher la redirection.

La page affichera le bouton "Se connecter" si l'utilisateur n'est pas authentifié, et affichera le bouton "Se déconnecter" si l'utilisateur est authentifié.

Le composant `<AuthorizeView />`

Alternativement, vous pouvez utiliser le composant AuthorizeView pour rendre conditionnellement du contenu en fonction de l'état d'authentification de l'utilisateur. Ce composant est utile lorsque vous souhaitez afficher un contenu différent pour les utilisateurs authentifiés et non authentifiés.

Dans votre composant Razor, ajoutez le code suivant :

Components/Pages/Index.razor
@using Microsoft.AspNetCore.Components.Authorization

@* ... *@

<AuthorizeView>
    <Authorized>
        <p>Nom : @User?.Identity?.Name</p>
        @* Contenu pour les utilisateurs authentifiés *@
    </Authorized>
    <NotAuthorized>
        @* Contenu pour les utilisateurs non authentifiés *@
    </NotAuthorized>
</AuthorizeView>

@* ... *@

Le composant AuthorizeView nécessite un paramètre en cascade de type Task<AuthenticationState>. Un moyen direct d'obtenir ce paramètre est d'ajouter le composant <CascadingAuthenticationState>. Cependant, en raison de la nature de Blazor Server, nous ne pouvons pas simplement ajouter le composant à la mise en page ou au composant racine (cela peut ne pas fonctionner comme prévu). Au lieu de cela, nous pouvons ajouter le code suivant au builder (Program.cs ou Startup.cs) pour fournir le paramètre en cascade :

Program.cs
builder.Services.AddCascadingAuthenticationState();

Ensuite, vous pouvez utiliser le composant AuthorizeView dans chaque composant qui en a besoin.

Point de contrôle : Testez votre application

Maintenant, vous pouvez tester votre application :

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

Ajouter le connecteur SAML

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

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

Accédez à Console > Connectors > Social Connectors.
Cliquez sur "Add social connector" et sélectionnez "SAML".
Suivez le guide README et complétez les champs requis et personnalisez les paramètres.

remarque:

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

Configurer Application SAML standard

Passons en revue les configurations du connecteur SAML.

Avant de commencer, vous pouvez vous rendre chez un fournisseur d'identité sociale qui prend en charge le protocole SAML et créer votre propre compte. Okta, OneLogin, Salesforce et certaines autres plateformes prennent en charge l'authentification basée sur le protocole SAML.

Si votre IdP exige le chiffrement de l'assertion SAML et la réception de requêtes d'authentification signées, vous devez générer votre clé privée et le certificat correspondant en utilisant l'algorithme RSA. Conservez la clé privée pour votre utilisation SP et téléchargez le certificat sur IdP.

Vous devez également configurer l'URL ACS (Assertion Consumer Service) comme ${your_logto_origin}/api/authn/saml/${connector_id} pour gérer l'assertion SAML de l'IdP. Vous pouvez trouver votre connectorId sur la page des détails du connecteur SAML dans la console d'administration de Logto.

remarque:

Selon la conception actuelle de Logto, nous ne prenons en charge que la liaison par redirection pour l'envoi de requêtes d'authentification et la liaison par POST pour la réception d'assertions SAML. Bien que cela ne semble pas très cool, nous pensons que la conception actuelle peut gérer la plupart de vos cas d'utilisation. Si vous avez des problèmes, n'hésitez pas à nous contacter !

Configurer le connecteur SAML (SP)

Dans cette section, nous allons présenter chaque attribut en détail.

entityID `Requis`

entityID (c'est-à-dire issuer) est l'identifiant de l'entité. Il est utilisé pour identifier votre entité (entité SP SAML) et correspondre à l'équivalence dans chaque requête/réponse SAML.

signInEndpoint `Requis`

Le point de terminaison de l'IdP auquel vous envoyez les requêtes d'authentification SAML. Habituellement, vous pouvez trouver cette valeur sur la page des détails de l'IdP (c'est-à-dire l'URL SSO ou l'URL de connexion de l'IdP).

x509Certificate `Requis`

Le certificat x509 généré à partir de la clé privée de l'IdP, l'IdP est censé avoir cette valeur disponible.

Le contenu du certificat est accompagné de l'en-tête -----BEGIN CERTIFICATE----- et de la fin -----END CERTIFICATE-----.

idpMetadataXml `Requis`

Le champ est utilisé pour placer le contenu de votre fichier XML de métadonnées IdP.

remarque:

Le parseur XML que nous utilisons ne prend pas en charge les espaces de noms personnalisés. Si les métadonnées de l'IdP comportent un espace de noms, vous devez les supprimer manuellement. Pour l'espace de noms du fichier XML, voir référence.

assertionConsumerServiceUrl `Requis`

L'URL du service consommateur d'assertions (ACS) est le point de terminaison du SP pour recevoir les requêtes POST d'assertion SAML de l'IdP. Comme nous l'avons mentionné dans la partie précédente, elle est généralement configurée dans les paramètres de l'IdP, mais certains IdP obtiennent cette valeur à partir des requêtes d'authentification SAML, nous ajoutons donc également cette valeur en tant que champ REQUIS. Sa valeur devrait ressembler à ${your_logto_origin}/api/authn/saml/${connector_id}.

signAuthnRequest

La valeur booléenne qui contrôle si la requête d'authentification SAML doit être signée, dont la valeur par défaut est false.

encryptAssertion

encryptAssertion est une valeur booléenne qui indique si l'IdP chiffrera l'assertion SAML, avec une valeur par défaut false.

remarque:

Les attributs signAuthnRequest et encryptAssertion doivent être alignés avec les paramètres correspondants de l'IdP, sinon une erreur sera générée pour indiquer que la configuration ne correspond pas. Toutes les réponses SAML doivent être signées.

requestSignatureAlgorithm

Cela doit être aligné avec les algorithmes de signature de l'IdP afin que Logto puisse vérifier la signature de l'assertion SAML. Sa valeur doit être soit http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 ou http://www.w3.org/2001/04/xmldsig-more#rsa-sha512 et la valeur par défaut est http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

messageSigningOrder

messageSigningOrder indique l'ordre de signature et de chiffrement de l'IdP, sa valeur doit être soit sign-then-encrypt soit encrypt-then-sign et la valeur par défaut est sign-then-encrypt.

privateKey et privateKeyPass

privateKey est une valeur OPTIONNELLE et est requise lorsque signAuthnRequest est true.

privateKeyPass est le mot de passe que vous avez défini lors de la création de privateKey, requis si nécessaire.

Si signAuthnRequest est true, le certificat correspondant généré à partir de privateKey est requis par l'IdP pour vérifier la signature.

encPrivateKey et encPrivateKeyPass

encPrivateKey est une valeur OPTIONNELLE et est requise lorsque encryptAssertion est true.

encPrivateKeyPass est le mot de passe que vous avez défini lors de la création de encPrivateKey, requis si nécessaire.

Si encryptAssertion est true, le certificat correspondant généré à partir de encPrivateKey est requis par l'IdP pour chiffrer l'assertion SAML.

remarque:

Pour la génération de clés et de certificats, openssl est un outil formidable. Voici une ligne de commande d'exemple qui pourrait être utile :

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

Les fichiers privateKey et encPrivateKey doivent être encodés dans le schéma pkcs1 en tant que chaîne pem, ce qui signifie que les fichiers de clé privée doivent commencer par -----BEGIN RSA PRIVATE KEY----- et se terminer par -----END RSA PRIVATE KEY-----.

nameIDFormat

nameIDFormat est un attribut OPTIONNEL qui déclare le format d'identifiant de nom qui répondrait. La valeur peut être parmi 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 et urn:oasis:names:tc:SAML:2.0:nameid-format:transient, et la valeur par défaut est urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified.

timeout

timeout est la tolérance de temps pour la validation temporelle, car le temps entre votre entité SP et l'entité IdP pourrait être différent et la connexion réseau peut également apporter un certain retard. L'unité est en millisecondes, et la valeur par défaut est 5000 (c'est-à-dire 5s).

profileMap

Logto fournit également un champ profileMap que les utilisateurs peuvent personnaliser pour mapper les profils des fournisseurs sociaux qui ne sont généralement pas standard. Chaque clé profileMap est le nom du champ de profil utilisateur standard de Logto et la valeur correspondante doit être le nom du champ de profil social. À l'heure actuelle, Logto ne concerne que 'id', 'name', 'avatar', 'email' et 'phone' du profil social, seul 'id' est REQUIS et les autres sont des champs optionnels.

Types de configuration

Nom	Type	Requis	Valeur par défaut
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

Champs ProfileMap	Type	Requis	Valeur par défaut
id	string	false	id
name	string	false	name
avatar	string	false	avatar
email	string	false	email
phone	string	false	phone

Référence

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 SAML devrait être disponible maintenant.

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

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

Onglet Expérience de connexion

Tests et validation

Retournez à votre application .NET Core (Blazor Server). Vous devriez maintenant pouvoir vous connecter avec SAML. 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à.

Créer une application dans Logto​

Intégrer le SDK .Net Core (Blazor Server)​

Installation​

Ajouter l'authentification Logto​

Flux de connexion et de déconnexion​

Concernant la connexion basée sur la redirection​

Configurer les URIs de redirection​

Modifier les chemins par défaut​

Ajouter des routes​

Implémenter les boutons de connexion / déconnexion​

Le composant <AuthorizeView />​

Point de contrôle : Testez votre application​

Ajouter le connecteur SAML​

Configurer Application SAML standard​

Créer un compte IdP social et enregistrer l'application SAML (IdP)​

Configurer le connecteur SAML (SP)​

entityID Requis​

signInEndpoint Requis​

x509Certificate Requis​

idpMetadataXml Requis​

assertionConsumerServiceUrl Requis​

signAuthnRequest​

encryptAssertion​

requestSignatureAlgorithm​

messageSigningOrder​

privateKey et privateKeyPass​

encPrivateKey et encPrivateKeyPass​

nameIDFormat​

timeout​

profileMap​

Types de configuration​

Référence​

Enregistrer votre configuration​

Activer le connecteur SAML dans l'Expérience de connexion​

Tests et validation​

Lectures complémentaires​

Créer une application dans Logto

Intégrer le SDK .Net Core (Blazor Server)

Installation

Ajouter l'authentification Logto

Flux de connexion et de déconnexion

Concernant la connexion basée sur la redirection

Configurer les URIs de redirection

Modifier les chemins par défaut

Ajouter des routes

Implémenter les boutons de connexion / déconnexion

Le composant `<AuthorizeView />`

Point de contrôle : Testez votre application

Ajouter le connecteur SAML

Configurer Application SAML standard

Créer un compte IdP social et enregistrer l'application SAML (IdP)

Configurer le connecteur SAML (SP)

entityID `Requis`

signInEndpoint `Requis`

x509Certificate `Requis`

idpMetadataXml `Requis`

assertionConsumerServiceUrl `Requis`

signAuthnRequest

encryptAssertion

requestSignatureAlgorithm

messageSigningOrder

privateKey et privateKeyPass

encPrivateKey et encPrivateKeyPass

nameIDFormat

timeout

profileMap

Types de configuration

Référence

Enregistrer votre configuration

Activer le connecteur SAML dans l'Expérience de connexion

Tests et validation

Lectures complémentaires