Como construir login SAML com .NET Core (MVC)

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 (autenticação de usuário) com .NET Core (MVC) 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 (MVC).
Uma conta SAML utilizável.

Criar um aplicativo no 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 (MVC)" 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.

Integrar .NET Core (MVC) 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.

Implementar botões de login / logout

Primeiro, adicione métodos de ações ao seu Controller, por exemplo:

Controllers/HomeController.cs
public class HomeController : Controller
{
  public IActionResult SignIn()
  {
    // Isso redirecionará o usuário para a página de login do Logto.
    return Challenge(new AuthenticationProperties { RedirectUri = "/" });
  }

  // Use a palavra-chave `new` para evitar conflito com o método `ControllerBase.SignOut`
  new public IActionResult SignOut()
  {
    // Isso limpará o cookie de autenticação e redirecionará o usuário para a página de logout do Logto
    // para limpar a sessão do Logto também.
    return SignOut(new AuthenticationProperties { RedirectUri = "/" });
  }
}

Em seguida, adicione os links à sua View:

Views/Home/Index.cshtml
<p>Está autenticado: @User.Identity?.IsAuthenticated</p>
@if (User.Identity?.IsAuthenticated == true) {
  <a asp-controller="Home" asp-action="SignOut">Sair</a>
} else {
  <a asp-controller="Home" asp-action="SignIn">Entrar</a>
}

Ele mostrará o link "Entrar" se o usuário não estiver autenticado e mostrará o link "Sair" se o usuário estiver autenticado.

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.

Adicionar conector SAML

Para habilitar um login rápido e melhorar a conversão de usuários, conecte-se com .NET Core (MVC) como um provedor de identidade (IdP). O conector social do Logto ajuda você a estabelecer essa conexão em minutos, permitindo a entrada de vários parâmetros.

Para adicionar um conector social, basta seguir estas etapas:

Navegue até Console > Connectors > Social Connectors.
Clique em "Add social connector" e selecione "SAML".
Siga o guia README e complete os campos obrigatórios e personalize as configurações.

nota:

Se você estiver seguindo o guia do Conector no local, pode pular a próxima seção.

Configurar Aplicativo SAML padrão

Vamos passar pelas configurações do conector SAML.

Antes de começarmos, você pode ir a um provedor de identidade social que suporte o protocolo SAML e criar sua própria conta. Okta, OneLogin, Salesforce e algumas outras plataformas suportam autenticação baseada no protocolo SAML.

Se o seu IdP exigir a criptografia da asserção SAML e o recebimento de solicitações de autenticação assinadas, você deve gerar sua chave privada e o certificado correspondente usando o algoritmo RSA. Mantenha a chave privada para uso do seu SP e carregue o certificado no IdP.

Você também precisa configurar a URL do ACS (Assertion Consumer Service) como ${your_logto_origin}/api/authn/saml/${connector_id} para lidar com a asserção SAML do IdP. Você pode encontrar seu connectorId na página de detalhes do conector SAML no Console de Administração do Logto.

nota:

De acordo com o design atual do Logto, só suportamos Redirect-binding para enviar solicitações de autenticação e POST-binding para receber asserções SAML. Embora isso possa não parecer legal, acreditamos que o design atual pode lidar com a maioria dos seus casos de uso. Se você tiver algum problema, sinta-se à vontade para entrar em contato!

Configurar conector SAML (SP)

Nesta seção, vamos apresentar cada atributo em detalhe.

entityID `Obrigatório`

entityID (ou seja, issuer) é o identificador da Entidade. Ele é usado para identificar sua entidade (entidade SP SAML) e corresponder à equivalência em cada solicitação/resposta SAML.

signInEndpoint `Obrigatório`

O endpoint do IdP para o qual você envia solicitações de autenticação SAML. Normalmente, você pode encontrar esse valor na página de detalhes do IdP (ou seja, SSO URL ou Login URL do IdP).

x509Certificate `Obrigatório`

O certificado x509 gerado a partir da chave privada do IdP, espera-se que o IdP tenha esse valor disponível.

O conteúdo do certificado vem com o cabeçalho -----BEGIN CERTIFICATE----- e o final -----END CERTIFICATE-----.

idpMetadataXml `Obrigatório`

O campo é usado para colocar conteúdos do arquivo XML de metadados do seu IdP.

nota:

O analisador XML que estamos usando não suporta namespace personalizado. Se os metadados do IdP vierem com namespace, você deve removê-los manualmente. Para namespace de arquivo XML, veja referência.

assertionConsumerServiceUrl `Obrigatório`

A URL do serviço consumidor de asserção (ACS) é o endpoint do SP para receber solicitações POST de asserção SAML do IdP. Como mencionamos na parte anterior, geralmente é configurado nas configurações do IdP, mas alguns IdPs obtêm esse valor das solicitações de autenticação SAML, por isso também adicionamos esse valor como um campo OBRIGATÓRIO. Seu valor deve ser semelhante a ${your_logto_origin}/api/authn/saml/${connector_id}.

signAuthnRequest

O valor booleano que controla se a solicitação de autenticação SAML deve ser assinada, cujo valor padrão é false.

encryptAssertion

encryptAssertion é um valor booleano que indica se o IdP irá criptografar a asserção SAML, com valor padrão false.

nota:

Os atributos signAuthnRequest e encryptAssertion devem estar alinhados com os parâmetros correspondentes da configuração do IdP, caso contrário, um erro será lançado para mostrar que a configuração não corresponde. Todas as respostas SAML precisam ser assinadas.

requestSignatureAlgorithm

Isso deve estar alinhado com os algoritmos de assinatura do IdP para que o Logto possa verificar a assinatura da asserção SAML. Seu valor deve ser 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 e o valor padrão é http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

messageSigningOrder

messageSigningOrder indica a ordem de assinatura e criptografia do IdP, seu valor deve ser sign-then-encrypt ou encrypt-then-sign e o valor padrão é sign-then-encrypt.

privateKey e privateKeyPass

privateKey é um valor OPCIONAL e é necessário quando signAuthnRequest é true.

privateKeyPass é a senha que você definiu ao criar privateKey, necessária quando necessário.

Se signAuthnRequest for true, o certificado correspondente gerado a partir de privateKey é necessário pelo IdP para verificar a assinatura.

encPrivateKey e encPrivateKeyPass

encPrivateKey é um valor OPCIONAL e é necessário quando encryptAssertion é true.

encPrivateKeyPass é a senha que você definiu ao criar encPrivateKey, necessária quando necessário.

Se encryptAssertion for true, o certificado correspondente gerado a partir de encPrivateKey é necessário pelo IdP para criptografar a asserção SAML.

nota:

Para geração de chaves e certificados, openssl é uma ferramenta maravilhosa. Aqui está uma linha de comando de exemplo que pode ser útil:

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

Os arquivos privateKey e encPrivateKey são obrigados a serem codificados no esquema pkcs1 como string pem, o que significa que os arquivos de chave privada devem começar com -----BEGIN RSA PRIVATE KEY----- e terminar com -----END RSA PRIVATE KEY-----.

nameIDFormat

nameIDFormat é um atributo OPCIONAL que declara o formato do nome id que responderia. O valor pode estar entre 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 e urn:oasis:names:tc:SAML:2.0:nameid-format:transient, e o valor padrão é urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified.

timeout

timeout é a tolerância de tempo para validação de tempo, já que o tempo entre sua entidade SP e a entidade IdP pode ser diferente e a conexão de rede também pode trazer algum atraso. A unidade é em milissegundos, e o valor padrão é 5000 (ou seja, 5s).

profileMap

Logto também fornece um campo profileMap que os usuários podem personalizar o mapeamento dos perfis dos fornecedores sociais, que geralmente não são padrão. Cada chave profileMap é o nome do campo de perfil de usuário padrão do Logto e o valor correspondente deve ser o nome do campo de perfil social. No estágio atual, o Logto só se preocupa com 'id', 'name', 'avatar', 'email' e 'phone' do perfil social, apenas 'id' é OBRIGATÓRIO e os outros são campos opcionais.

Tipos de configuração

Nome	Tipo	Obrigatório	Valor Padrão
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 do ProfileMap	Tipo	Obrigatório	Valor Padrão
id	string	false	id
name	string	false	name
avatar	string	false	avatar
email	string	false	email
phone	string	false	phone

Referência

Salvar sua configuração

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 deve estar disponível agora.

Depois de criar um conector social com sucesso, você pode habilitá-lo como um botão "Continuar com SAML" na Experiência de Login.

Navegue até Console > Experiência de login > Inscrição e login.
(Opcional) Escolha "Não aplicável" para o identificador de inscrição se você precisar apenas de login social.
Adicione o conector SAML configurado à seção "Login social".

Aba Experiência de Login

Teste e Validação

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

Leituras adicionais

Fluxos de usuário final: Logto fornece fluxos de autenticação prontos para uso, incluindo MFA e SSO corporativo, juntamente com APIs poderosas para implementação flexível de configurações de conta, verificação de segurança e experiência multi-inquilino.

Autorização (Authorization): A autorização define as ações que um usuário pode realizar ou os recursos que ele pode acessar após ser autenticado. Explore como proteger sua API para aplicativos nativos e de página única e implementar Controle de Acesso Baseado em Papel (RBAC).

Organizações (Organizations): Particularmente eficaz em aplicativos SaaS multi-inquilino e B2B, o recurso de organização permite a criação de inquilinos, gerenciamento de membros, RBAC em nível de organização e provisionamento just-in-time.

Série IAM do cliente: Nossos posts em série sobre Gerenciamento de Identidade e Acesso do Cliente (ou Consumidor), do básico ao avançado e além.

Criar um aplicativo no Logto​

Integrar .NET Core (MVC) 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​

Implementar botões de login / logout​

Ponto de verificação: Teste seu aplicativo​

Adicionar conector SAML​

Configurar Aplicativo SAML padrão​

Criar conta de IdP social e registrar aplicativo SAML (IdP)​

Configurar conector SAML (SP)​

entityID Obrigatório​

signInEndpoint Obrigatório​

x509Certificate Obrigatório​

idpMetadataXml Obrigatório​

assertionConsumerServiceUrl Obrigatório​

signAuthnRequest​

encryptAssertion​

requestSignatureAlgorithm​

messageSigningOrder​

privateKey e privateKeyPass​

encPrivateKey e encPrivateKeyPass​

nameIDFormat​

timeout​

profileMap​

Tipos de configuração​

Referência​

Salvar sua configuração​

Ativar conector SAML na Experiência de Login​

Teste e Validação​

Leituras adicionais​

Criar um aplicativo no Logto

Integrar .NET Core (MVC) 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

Implementar botões de login / logout

Ponto de verificação: Teste seu aplicativo

Adicionar conector SAML

Configurar Aplicativo SAML padrão

Criar conta de IdP social e registrar aplicativo SAML (IdP)

Configurar conector SAML (SP)

entityID `Obrigatório`

signInEndpoint `Obrigatório`

x509Certificate `Obrigatório`

idpMetadataXml `Obrigatório`

assertionConsumerServiceUrl `Obrigatório`

signAuthnRequest

encryptAssertion

requestSignatureAlgorithm

messageSigningOrder

privateKey e privateKeyPass

encPrivateKey e encPrivateKeyPass

nameIDFormat

timeout

profileMap

Tipos de configuração

Referência

Salvar sua configuração

Ativar conector SAML na Experiência de Login

Teste e Validação

Leituras adicionais