How to build SAML enterprise SSO with .NET Core (Blazor Server)

Para nossos novos amigos:

Logto é uma alternativa ao Auth0 projetada para aplicativos modernos e produtos SaaS. Ele oferece serviços tanto Cloud quanto Open-source para ajudá-lo a lançar rapidamente seu sistema de identidade e gerenciamento (IAM). Desfrute de autenticação, autorização e gerenciamento multi-inquilino tudo em um.

Recomendamos começar com um tenant de desenvolvimento gratuito no Logto Cloud. Isso permite que você explore todos os recursos facilmente.

Neste artigo, vamos percorrer os passos para construir rapidamente a experiência de login SAML enterprise SSO (autenticação de usuário) com .NET Core (Blazor Server) e Logto.

Pré-requisitos

Uma instância Logto em execução. Confira a página de introdução para começar.
Conhecimento básico de .NET Core (Blazor Server).
Uma conta SAML enterprise SSO utilizável.

Create an application in Logto

Logto é baseado na autenticação OpenID Connect (OIDC) e na autorização OAuth 2.0. Ele suporta o gerenciamento de identidade federada em vários aplicativos, comumente chamado de Autenticação Única (SSO).

Para criar seu aplicativo Aplicativo web tradicional, basta seguir estas etapas:

Abra o Logto Console. Na seção "Get started", clique no link "View all" para abrir a lista de frameworks de aplicativos. Alternativamente, você pode navegar para Logto Console > Applications e clicar no botão "Create application".
No modal que se abre, clique na seção "Aplicativo web tradicional" ou filtre todos os frameworks "Aplicativo web tradicional" disponíveis usando as caixas de seleção de filtro rápido à esquerda. Clique no cartão do framework ".Net Core (Blazor Server)" para começar a criar seu aplicativo.
Insira o nome do aplicativo, por exemplo, "Bookstore", e clique em "Create application".

🎉 Ta-da! Você acabou de criar seu primeiro aplicativo no Logto. Você verá uma página de parabéns que inclui um guia de integração detalhado. Siga o guia para ver como será a experiência em seu aplicativo.

Integrate .Net Core (Blazor Server) SDK

dica:

A demonstração a seguir é construída no .NET Core 8.0. O SDK é compatível com .NET 6.0 ou superior.
Os projetos de exemplo do .NET Core estão disponíveis no repositório GitHub.

Instalação

Adicione o pacote NuGet ao seu projeto:

dotnet add package Logto.AspNetCore.Authentication

Adicionar autenticação Logto

Abra Startup.cs (ou Program.cs) e adicione o seguinte código para registrar os serviços de autenticação do 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"];
});

O método AddLogtoAuthentication fará as seguintes coisas:

Definir o esquema de autenticação padrão para LogtoDefaults.CookieScheme.
Definir o esquema de desafio padrão para LogtoDefaults.AuthenticationScheme.
Definir o esquema de logout padrão para LogtoDefaults.AuthenticationScheme.
Adicionar manipuladores de autenticação de cookie e OpenID Connect ao esquema de autenticação.

Antes de prosseguirmos, há dois termos confusos no middleware de autenticação do .NET Core que precisamos esclarecer:

CallbackPath: O URI para o qual o Logto redirecionará o usuário após o usuário ter feito login (o "URI de redirecionamento" no Logto)
RedirectUri: O URI para o qual será redirecionado após as ações necessárias terem sido realizadas no middleware de autenticação do Logto.

O processo de login pode ser ilustrado da seguinte forma:

Da mesma forma, o .NET Core também possui SignedOutCallbackPath e RedirectUri para o fluxo de logout.

Para maior clareza, nos referiremos a eles da seguinte forma:

Termo que usamos	Termo do .NET Core
URI de redirecionamento do Logto	CallbackPath
URI de redirecionamento pós-logout do Logto	SignedOutCallbackPath
URI de redirecionamento do aplicativo	RedirectUri

Este processo de autenticação segue o protocolo OpenID Connect (OIDC), e o Logto aplica medidas de segurança rigorosas para proteger o login do usuário.
Se você tiver vários aplicativos, pode usar o mesmo provedor de identidade (Logto). Uma vez que o usuário faz login em um aplicativo, o Logto completará automaticamente o processo de login quando o usuário acessar outro aplicativo.

Para saber mais sobre a lógica e os benefícios do login baseado em redirecionamento, veja Experiência de login do Logto explicada.

Configurar URIs de redirecionamento

nota:

Nos trechos de código a seguir, assumimos que seu aplicativo está sendo executado em http://localhost:3000/.

Primeiro, vamos configurar o URI de redirecionamento do Logto. Adicione o seguinte URI à lista de "Redirect URIs" na página de detalhes do aplicativo Logto:

http://localhost:3000/Callback

Para configurar o URI de redirecionamento pós logout do Logto, adicione o seguinte URI à lista de "Post sign-out redirect URIs" na página de detalhes do aplicativo Logto:

http://localhost:3000/SignedOutCallback

Alterar os caminhos padrão

O URI de redirecionamento do Logto tem um caminho padrão de /Callback, e o URI de redirecionamento pós logout do Logto tem um caminho padrão de /SignedOutCallback.

Você pode deixá-los como estão se não houver nenhum requisito especial. Se você quiser alterá-los, pode definir a propriedade CallbackPath e SignedOutCallbackPath para LogtoOptions:

Program.cs
builder.Services.AddLogtoAuthentication(options =>
{
  // Outras configurações...
  options.CallbackPath = "/Foo";
  options.SignedOutCallbackPath = "/Bar";
});

Lembre-se de atualizar o valor na página de detalhes do aplicativo Logto de acordo.

Adicionar rotas

Como o Blazor Server usa SignalR para se comunicar entre o servidor e o cliente, isso significa que métodos que manipulam diretamente o contexto HTTP (como emitir desafios ou redirecionamentos) não funcionam como esperado quando chamados de um componente Blazor.

Para corrigir isso, precisamos adicionar explicitamente dois endpoints para redirecionamentos de login e logout:

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("/");
    }
});

Agora podemos redirecionar para esses endpoints para acionar login e logout.

Implementar botões de login / logout

No componente Razor, adicione o seguinte código:

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

@* ... *@

<p>Está autenticado: @User.Identity?.IsAuthenticated</p>
@if (User.Identity?.IsAuthenticated == true)
{
    <button @onclick="SignOut">Sair</button>
}
else
{
    <button @onclick="SignIn">Entrar</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);
    }
}

Explicação:

O AuthenticationStateProvider injetado é usado para obter o estado de autenticação do usuário atual e preencher a propriedade User.
Os métodos SignIn e SignOut são usados para redirecionar o usuário para os endpoints de login e logout, respectivamente. Devido à natureza do Blazor Server, precisamos usar o NavigationManager com carregamento forçado para acionar o redirecionamento.

A página mostrará o botão "Entrar" se o usuário não estiver autenticado e mostrará o botão "Sair" se o usuário estiver autenticado.

O componente `<AuthorizeView />`

Alternativamente, você pode usar o componente AuthorizeView para renderizar condicionalmente o conteúdo com base no estado de autenticação do usuário. Este componente é útil quando você deseja mostrar conteúdo diferente para usuários autenticados e não autenticados.

No seu componente Razor, adicione o seguinte código:

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

@* ... *@

<AuthorizeView>
    <Authorized>
        <p>Nome: @User?.Identity?.Name</p>
        @* Conteúdo para usuários autenticados *@
    </Authorized>
    <NotAuthorized>
        @* Conteúdo para usuários não autenticados *@
    </NotAuthorized>
</AuthorizeView>

@* ... *@

O componente AuthorizeView requer um parâmetro em cascata do tipo Task<AuthenticationState>. Uma maneira direta de obter este parâmetro é adicionar o componente <CascadingAuthenticationState>. No entanto, devido à natureza do Blazor Server, não podemos simplesmente adicionar o componente ao layout ou ao componente raiz (pode não funcionar como esperado). Em vez disso, podemos adicionar o seguinte código ao builder (Program.cs ou Startup.cs) para fornecer o parâmetro em cascata:

Program.cs
builder.Services.AddCascadingAuthenticationState();

Então, você pode usar o componente AuthorizeView em todos os componentes que precisarem dele.

Ponto de verificação: Teste seu aplicativo

Agora, você pode testar seu aplicativo:

Execute seu aplicativo, você verá o botão de login.
Clique no botão de login, o SDK iniciará o processo de login e redirecionará você para a página de login do Logto.
Após fazer login, você será redirecionado de volta para seu aplicativo e verá o botão de logout.
Clique no botão de logout para limpar o armazenamento de tokens e sair.

Add SAML enterprise SSO connector

To simplify access management and gain enterprise-level safeguards for your big clients, connect with .Net Core (Blazor Server) as a federated identity provider. The Logto enterprise SSO connector helps you establish this connection in minutes by allowing several parameter inputs.

To add an enterprise SSO connector, simply follow these steps:

Navigate to Logto console > Enterprise SSO.

SSO page

Click "Add enterprise connector" button and choose your SSO provider type. Choose from prebuilt connectors for Microsoft Entra ID (Azure AD), Google Workspace, and Okta, or create a custom SSO connection using the standard OpenID Connect (OIDC) or SAML protocol.
Provide a unique name (e.g., SSO sign-in for Acme Company).

Select your SSO provider

Configure the connection with your IdP in the "Connection" tab. Check the guides above for each connector types.

SSO connection

Customize the SSO experience and enterprise’s email domain in the "Experience" tab. Users sign in with the SSO-enabled email domain will be redirected to SSO authentication.

SSO experience

Save changes.

Set up SAML SSO application on your IdP

Passo 1: Criar um aplicativo SAML SSO no seu IdP {#step-1-create-a-saml-sso-application-on-your-idp}

Inicie a integração SAML SSO criando um aplicativo no lado do IdP. Obtenha as seguintes configurações do Logto, representando seu Provedor de Serviço (SP):

Público (Audience) URI (SP Entity ID): Representa um identificador globalmente único para o seu serviço Logto, funcionando como o EntityId para SP durante solicitações de autenticação ao IdP. Este identificador é fundamental para a troca segura de afirmações SAML e outros dados relacionados à autenticação entre o IdP e o Logto.
URL ACS: A URL do Serviço de Consumidor de Afirmação (ACS) é o local onde a afirmação SAML é enviada com uma solicitação POST. Esta URL é usada pelo IdP para enviar a afirmação SAML para o Logto. Atua como uma URL de retorno onde o Logto espera receber e consumir a resposta SAML contendo as informações de identidade do usuário.

Preencha as configurações de Público (Audience) URI e URL ACS em seu aplicativo SAML do IdP e continue a recuperar as seguintes configurações do seu IdP.

Passo 2: Configurar SAML SSO no Logto

Para fazer a integração SAML SSO funcionar, você precisará fornecer os metadados do IdP ao Logto. Os metadados do IdP são um documento XML que contém todas as informações necessárias para que o Logto estabeleça a confiança com o IdP.

Navegue até a aba Connection. O Logto oferece três maneiras diferentes de configurar os metadados do IdP:

URL de Metadados: Forneça a URL do documento XML de metadados do IdP. O Logto buscará os metadados da URL e configurará a integração SAML SSO automaticamente.
Carregar Metadados: Carregue o documento XML de metadados do IdP. O Logto analisará o documento XML e configurará a integração SAML SSO automaticamente.
Configuração Manual: Configure manualmente os metadados do IdP.

ID da entidade IdP: O ID da Entidade do IdP.
URL de autenticação única: A URL do Serviço de Autenticação Única do IdP.
Certificado de assinatura: O certificado x509 é usado para verificar a assinatura da resposta SAML do IdP.

Com qualquer uma das configurações acima, o Logto analisará os metadados do IdP e configurará a integração SAML SSO de acordo.

Passo 3: Configurar mapeamento de atributos de usuário

Os atributos do usuário retornados do IdP podem variar dependendo da configuração do IdP. O Logto oferece uma maneira flexível de mapear os atributos do usuário retornados do IdP para os atributos do usuário no Logto. Você pode configurar o mapeamento de atributos do usuário na aba de experiência de integração SAML SSO.

id: O identificador único do usuário. O Logto lerá a reivindicação nameId da resposta SAML como o id de identidade SSO do usuário.
email: O endereço de email do usuário.
name: O nome do usuário.

Passo 4: Definir domínios de email e habilitar o conector SSO

Forneça os domínios de email da sua organização na aba SSO experience do conector do Logto. Isso habilitará o conector SSO como um método de autenticação para esses usuários.

Usuários com endereços de email nos domínios especificados serão redirecionados para usar o conector SAML SSO como seu único método de autenticação.

Save your configuration

Verifique se você preencheu os valores necessários na área de configuração do conector Logto. Clique em "Salvar e Concluído" (ou "Salvar alterações") e o conector SAML enterprise SSO deve estar disponível agora.

You don’t need to configure enterprise connectors individually, Logto simplifies SSO integration into your applications with just one click.

Navigate to: Console > Sign-in experience > Sign-up and sign-in.
Enable the "Enterprise SSO" toggle.
Save changes.

Once enabled, a "Single Sign-On" button will appear on your sign-in page. Enterprise users with SSO-enabled email domains can access your services using their enterprise identity providers (IdPs).

Auto detect SSO sign-in via email domain

To learn more about the SSO user experience, including SP-initiated SSO and IdP-initiated SSO, refer to User flows: Enterprise SSO.

Testing and Validation

Retorne ao seu aplicativo .NET Core (Blazor Server). Agora você deve conseguir fazer login com SAML enterprise SSO. Aproveite!

Create an application in Logto​

Integrate .Net Core (Blazor Server) SDK​

Instalação​

Adicionar autenticação Logto​

Fluxos de login e logout​

Sobre o login baseado em redirecionamento​

Configurar URIs de redirecionamento​

Alterar os caminhos padrão​

Adicionar rotas​

Implementar botões de login / logout​

O componente <AuthorizeView />​

Ponto de verificação: Teste seu aplicativo​

Add SAML enterprise SSO connector​

Set up SAML SSO application on your IdP​

Passo 2: Configurar SAML SSO no Logto​

Passo 3: Configurar mapeamento de atributos de usuário​

Passo 4: Definir domínios de email e habilitar o conector SSO​

Save your configuration​

Enable SAML enterprise SSO connector in Sign-in Experience​

Testing and Validation​

Further readings​