Guia para configurar o SSO SAML do ASP.NET Core usando o Shibboleth como IdP

Pré-requisitos: Download e instalação

• Versão .NET 5 e superior
• Versão .NET Core 2.1 e .NET Core 3.1
• Framework .NET

• Entre para http://portal.miniorange.com/ e navegue para o Downloads guia. A partir daí, localize o plugin que você comprou e clique em Baixe Plugin Para baixar o arquivo zip do plugin.

• Extraia o arquivo zip baixado em seu computador e coloque o pacote NuGet (arquivo .nupkg) em uma pasta como "C:\miniOrangePackages".
• Execute o seguinte comando no terminal do Visual Studio para adicioná-lo como uma fonte de pacote:

dotnet nuget add source C:\miniOrangePackages--name miniOrangePackage


• Abra seu projeto no terminal:

cd C:\Path\To\YourProject


• Instale o pacote em seu projeto usando o comando abaixo:

dotnet add package miniOrange.SAML.SSO --source miniOrangePackage


OR

• Após colocar o pacote NuGet (arquivo .nupkg) em uma pasta local, em vez de usar o terminal, você também pode instalá-lo usando o Visual Studio seguindo os passos abaixo:
• Abra seu aplicativo .NET no Visual Studio e clique em Ferramentas na barra de navegação superior e navegue até Gerenciador de Pacotes NuGet → Gerenciar Pacotes NuGet para a Solução.

• Uma nova janela será aberta; clique em ícone de engrenagem Ao lado do menu suspenso Origem do pacote.

• Uma janela pop-up será aberta; selecione Fontes de Pacotes No painel de navegação à esquerda, clique no sinal de mais (+). (+) ícone, insira um nome Para a origem do pacote, forneça o caminho da pasta onde você colocou o pacote NuGet. fonte campo e clique em Atualizar e, finalmente, clique em OK Para salvar as alterações, conforme mostrado na imagem.

• Após fechar a janela pop-up, selecione a fonte do pacote recém-adicionada na lista. Fonte do pacote suspenso.

• Agora, clique no botão Explorar guia, pesquise por miniOrange.SAML.SSOSelecione o pacote nos resultados e clique em Instalar.

• Observação: Para integrar o middleware miniOrange ASP.NET SAML SSO em seu aplicativo, você precisará adicionar os namespaces, serviços e middleware abaixo em seu projeto. Abaixo está um exemplo de implementação para referência.
  Inclua apenas a seção destacada abaixo no Programa.cs arquivo de seu aplicativo.

  using miniOrange.saml;
  using System.Reflection
  var builder=WebApplication.CreateBuilder(args);

  // Add services to the container.
  builder.Services.AddRazorPages();
  builder.Services.AddminiOrangeServices(Assembly.GetExecutingAssembly());

  var app = builder.Build();
        if(!app.Environment.IsDevelopment())
  {
    app.UseExceptionHandler("/Error");
    app.UseHsts();
  }

  app.UseHttpsRedirection();
  app.UseRouting();
  app.UseAuthorization();
  app.MapRazorPages();

  app.UseCookiePolicy();
  app.UseAuthentication();

  #if NET9_0_OR_GREATER
  app.MapStaticAssets();
  #else
  app.UseStaticFiles();
  #endif

  app.UseminiOrangeSAMLSSOMiddleware();
  app.Run();


• Entre para http://portal.miniorange.com/ e navegue para o Downloads guia. A partir daí, localize o plugin que você comprou e clique em Baixe Plugin Para baixar o arquivo zip do plugin.

• Extraia o arquivo zip baixado em seu computador e coloque o pacote NuGet (arquivo .nupkg) em uma pasta como "C:\miniOrangePackages".
• Execute o seguinte comando no terminal do Visual Studio para adicioná-lo como uma fonte de pacote:

dotnet nuget add source C:\miniOrangePackages--name miniOrangePackage


• Abra seu projeto no terminal:

cd C:\Path\To\YourProject


• Instale o pacote em seu projeto usando o comando abaixo:

dotnet add package miniOrange.SAML.SSO --source miniOrangePackage


OR

• Após colocar o pacote NuGet (arquivo .nupkg) em uma pasta local, em vez de usar o terminal, você também pode instalá-lo usando o Visual Studio seguindo os passos abaixo:
• Abra seu aplicativo .NET no Visual Studio e clique em Ferramentas na barra de navegação superior e navegue até Gerenciador de Pacotes NuGet → Gerenciar Pacotes NuGet para a Solução.

• Uma nova janela será aberta; clique em ícone de engrenagem Ao lado do menu suspenso Origem do pacote.

• Uma janela pop-up será aberta; selecione Fontes de Pacotes No painel de navegação à esquerda, clique no sinal de mais (+). (+) ícone, insira um nome Para a origem do pacote, forneça o caminho da pasta onde você colocou o pacote NuGet. fonte campo e clique em Atualizar e, finalmente, clique em OK Para salvar as alterações, conforme mostrado na imagem.

• Após fechar a janela pop-up, selecione a fonte do pacote recém-adicionada na lista. Fonte do pacote suspenso.

• Agora, clique no botão Explorar guia, pesquise por miniOrange.SAML.SSOSelecione o pacote nos resultados e clique em Instalar.

• Observação: Para integrar o middleware miniOrange ASP.NET SAML SSO em seu aplicativo, você precisará adicionar os namespaces, serviços e middleware abaixo em seu projeto. Abaixo está um exemplo de implementação para referência.
  Inclua apenas a seção destacada abaixo no Programa.cs arquivo de seu aplicativo.

  using miniOrange.saml;
  using System.Reflection;

  public class Startup
  {

    public Startup(IConfiguration configuration)
    {
      Configuration = configuration;
    }
    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
      services.AddRazorPages();
      services.AddminiOrangeServices(Assembly.GetExecutingAssembly());
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
      if (env.IsDevelopment())
      {
        app.UseDeveloperExceptionPage();
      }
      else
      {
        app.UseExceptionHandler("/Error");
        // The default HSTS value is 30 days. You may want to change this for production scenarios, see         https://aka.ms/aspnetcore-hsts.
        app.UseHsts();
      }

      app.UseHttpsRedirection();

      app.UseCookiePolicy();
      app.UseAuthentication();

      #if NET9_0_OR_GREATER
      app.MapStaticAssets();
      #else
      app.UseStaticFiles();
      #endif

      app.UseminiOrangeSAMLSSOMiddleware();

      app.UseRouting();
      app.UseAuthorization();
      app.UseEndpoints(endpoints =>
      {
        endpoints.MapRazorPages();
      });
    }
  }


• Após a integração, abra seu navegador e navegue até o painel do conector com o URL abaixo:
  

• Se a página de login aparecer, significa que você adicionou com sucesso o middleware miniOrange SAML SSO à sua aplicação.

• Faça login com sua conta miniOrange licenciada para configurar o middleware.
• Após o login, o Configuração da Conta O painel de controle será aberto. Insira a chave de licença para ativar o plugin, que você receberá após fazer login. portal.miniorange.com e navegando para Gerenciar licença → Chaves de licença.

• Em seguida, marque a caixa. "Li as duas condições acima e desejo ativar o plugin.", e clique no botão Ativar licença botão.

A] Usando URL de metadados SAML ou arquivo de metadados

• De acordo com o relatório Menu de configurações do plugin, olhe para Configurações do provedor de serviços. Abaixo, você pode encontrar o URL dos metadados, bem como a opção para baixar os metadados SAML.

• Copie o URL dos metadados ou baixe o arquivo de metadados para configurá-lo no seu provedor de identidade.

• Você pode consultar a captura de tela abaixo:

B] Carregando metadados manualmente

• De Configurações do provedor de serviços Na seção, você pode copiar manualmente os metadados do provedor de serviços, como por exemplo ID da entidade SP, URL do ACS, URL de logout únicoE compartilhe-o com seu provedor de identidade para configuração.
• Você também pode baixar o Certificado SP clicando em Baixar Certificado SP e forneça-o ao seu provedor de identidade, se necessário.
• Sob o Certificado de criptografia Na seção correspondente, selecione o tipo de certificado apropriado de acordo com sua necessidade.
• Após concluir as etapas acima, clique em Economize para aplicar a configuração.

• Você pode consultar a captura de tela abaixo:

• Em conf/idp.properties, descomente e defina 'idp.encryption.optional' como true.
  por exemplo, idp.encryption.optional = true

• In conf/metadata-providers.xml, configure o Provedor de Serviços assim

• In conf/saml-nameid.propriedades, descomente e defina o padrão NomeID as Email como isso.

• In conf/saml-nameid-xml, procure por shibboleth.SAML2NameIDGenerators. Descomente o bean shibboleth.SAML2AttributeSourcedGenerator e comente todos os outros beans de referência.

• Certifique-se de ter definido AttributeDefinition em conf/attribute-resolver.xml.

• Certifique-se de ter AttributeFilterPolicy definido em conf/attribute-filter.xml.

• Reinicie o servidor Shibboleth.
• Você precisa configurar esses endpoints no middleware SAML do ASP.NET.

• Você configurou com sucesso o Shibboleth como SAML IdP (Provedor de Identidade) para obter login SSO do Shibboleth no seu aplicativo ASP.NET.

• Clique no Adicionar novo IDP botão para configurar um novo Provedor de Identidade.

• Sob o Configurações de Plugin guia, selecione shibboleth como seu provedor de identidade da lista exibida.

Há duas maneiras detalhadas abaixo com as quais você pode configurar os metadados do seu Provedor de Identidade SAML no middleware.

A] Carregar metadados usando o botão Carregar metadados do IDP:

• Se o seu provedor de identidade tiver fornecido a URL de metadados ou o arquivo de metadados (somente formato .xml), você poderá simplesmente configurar os metadados do provedor de identidade no middleware usando o Carregar metadados do IDP opção.

• Copie o URL dos metadados ou baixe o arquivo de metadados para configurá-lo no seu provedor de identidade.

• Você pode consultar a captura de tela abaixo:

• Você pode escolher qualquer uma das opções de acordo com o formato de metadados disponível.

B] Configure os metadados do provedor de identidade manualmente:

• Depois de configurar seu Provedor de Identidade, ele irá fornecer a você ID da entidade IDP, URL de logon único do IDP e Certificado SAML X509 campos respectivamente.

• Clique Economize para salvar seus dados de IDP.

• Após carregar os detalhes dos metadados, navegue até Configurações do Provedor de Identidade seção. Passe o mouse sobre o Selecionar ações menu suspenso e clique em Configuração de Teste.

• A captura de tela abaixo mostra um resultado de teste bem-sucedido. Clique em clique aqui para concluir as etapas restantes de integração do SSO.

• Se você estiver enfrentando algum erro no middleware, clique em guia de solução de problemas botão.

• Para solucionar o erro, siga os passos abaixo:
• Na aba Solução de Problemas, ative a opção para receber os registros do plugin e reproduzir o problema.
• Faça o download do arquivo de registro clicando em Baixar arquivo de registro botão para ver o que deu errado.

• Você pode compartilhar o arquivo de log conosco em aspnetsupport@xecurify.com e nossa equipe entrará em contato com você para resolver seu problema.

• Após testar a configuração, mapeie os atributos do seu aplicativo com os atributos do Provedor de Identidade (IdP).

• No menu à esquerda do miniOrange ASP.NET SAML SSO Middleware, clique em Mapeamento de atributos/funções aba conforme mostrado na imagem.
• Mapeie o necessário Atributos do IdP (tais como Nome de usuário, E-mail, Nome e Sobrenome) recebidos na resposta SAML em seus respectivos campos.

• ObservaçãoTodos os atributos mapeados serão armazenados na sessão para que você possa acessá-los em sua aplicação.
• Depois que os atributos forem mapeados, clique em Salvar mapeamento de atributos para aplicar alterações.

Mapeamento de atributos personalizados

• Se você quiser passar atributos adicionais do seu IdP, insira o Nome do Atributo e o Valor do Atributo correspondente em Mapeamento de atributos personalizados.
• De Valor do atributo (Reivindicação) No menu suspenso, selecione uma das declarações recebidas nos resultados da Configuração de Teste. Por exemplo: NameID.
• Essas declarações correspondem aos atributos enviados pelo seu Provedor de Identidade (IdP).

• Essas declarações correspondem aos atributos enviados pelo seu Provedor de Identidade (IdP).

• De acordo com o relatório Nome do Atributo No campo, insira o nome do atributo conforme você deseja que ele apareça ou seja usado em sua aplicação .NET.
• Você pode adicionar vários mapeamentos se seu aplicativo exigir vários atributos, clicando em + botão.
• Após definir todos os mapeamentos necessários, clique em Salvar mapeamento de atributos para armazenar a configuração.

• O plugin agora traduzirá as declarações SSO recebidas do seu Provedor de Identidade (IdP) para os nomes de atributos personalizados definidos aqui.

Mapeamento de Funções

• De acordo com o relatório Mapeamento de Funções seção, insira o Nome do Atributo do Grupo exatamente como configurado em seu provedor de identidade para obter as informações do grupo de usuários.
• Introduzir o Nome do papel recebido do Provedor de Identidade e mapeá-lo para o apropriado. Valor da função No campo Valor da função, insira as funções definidas em sua aplicação .NET.
• Por exemplo: mapeie o grupo IdP Group1 ou Group10 recebido no atributo UserGroups para a função correspondente configurada em seu aplicativo .NET.
• Após adicionar os mapeamentos necessários, clique em Salvar mapeamento de funções Para salvar a configuração com sucesso.

Restrição de domínio

• Essa funcionalidade pode ser usada para restringir o acesso do usuário ao site com base no domínio do atributo "Email" mapeado.
• De acordo com o relatório Atributo de e-mail No campo, insira o nome do atributo que contém o endereço de e-mail do usuário, conforme recebido do seu Provedor de Identidade (IdP).

• De acordo com o relatório Nome de domínio No campo, insira o(s) domínio(s) que deseja permitir ou restringir, separados por vírgulas caso esteja adicionando vários domínios.
• permitir que o Alternar restrição Com base na sua necessidade de configurar o acesso por meio de listas negras ou brancas.
• Após concluir a configuração, clique em Salvar domínios Para salvar as configurações com sucesso.

• Esses passos permitem que você recupere as informações do usuário SSO em seu aplicativo na forma de declarações de usuário.
• Basta copiar e colar o trecho de código onde você quiser acessar os atributos do usuário.

• Você também pode copiar o código de integração abaixo:

• Passe o mouse sobre Selecionar ações e clique em Copiar link SSO.

• Use o seguinte URL como um link no aplicativo de onde você deseja executar o SSO:

• Por exemplo, você pode usá-lo como:

• Use a seguinte URL como um link para seu aplicativo de onde você deseja executar o SLO:

• Por exemplo, você pode usá-lo como:

Configurações avançadas

Se você deseja aplicar as Configurações Avançadas, navegue até... Configurações avançadas aba.

Redirecionamento automático para o IdP

• permitir que o Redirecionamento automático para o IdP Ativar botão para redirecionar automaticamente os usuários para o provedor de identidade configurado durante o login.
• Selecione o IdP para o qual deseja redirecionar os usuários a partir do URL específico em IDP padrão suspenso.
• Escolha o Tipo de redirecionamento as Restrito or Público com base em sua exigência.
• Caso necessário, insira os URLs que devem ser excluídos do redirecionamento no campo "Excluir URLs", separados por vírgulas.
• Clique em Economize para armazenar a configuração com sucesso.

Desativar o painel de administração

• permitir que o Desativar o painel de administração Desative a opção para ocultar o painel de administração do miniOrange e clique em Salvar para aplicar as alterações.

Informações do certificado

• Acesse a seção Informações do Certificado e selecione o Tipo de Certificado desejado (Certificado de assinatura ou certificado de criptografia).
• Clique em Regenerar certificado Se você deseja gerar um novo certificado.

• Em seguida, clique em Solicitar novo certificado para aplicar o certificado atualizado.

Carregar certificado personalizado

• Navegue até a Carregar certificado personalizado seção e selecione o Tipo de Certificado necessário (Certificado de assinatura ou certificado de criptografia).
• Clique em Escolher Ficheiro para fazer o upload do Chave pública (.crt) e Chave privada (.pfx) arquivos e insira o Senha da chave privada no campo fornecido.
• Após fornecer os detalhes necessários, clique em Economize Para carregar e aplicar o certificado personalizado com sucesso.