How to build OIDC enterprise SSO with Python

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 OIDC enterprise SSO (autenticação de usuário) com Python 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 Python.
Uma conta OIDC 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 "Flask" 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 Flask SDK

dica:

O exemplo usa Flask, mas os conceitos são os mesmos para outros frameworks.
O projeto de exemplo em Python está disponível em nosso repositório do Python SDK.
O Logto SDK utiliza corrotinas, lembre-se de usar await ao chamar funções assíncronas.

Instalação

Execute no diretório raiz do projeto:

pip install logto # ou `poetry add logto` ou qualquer outro que você use

Inicializar LogtoClient

Primeiro, crie uma configuração Logto:

client.py
from logto import LogtoClient, LogtoConfig

client = LogtoClient(
    LogtoConfig(
        endpoint="https://you-logto-endpoint.app",  # Substitua pelo seu endpoint Logto
        appId="replace-with-your-app-id",
        appSecret="replace-with-your-app-secret",
    ),
)

dica:

Você pode encontrar e copiar o "App Secret" na página de detalhes do aplicativo no Admin Console:

Também substitua o armazenamento de memória padrão por um armazenamento persistente, por exemplo:

client.py
from logto import LogtoClient, LogtoConfig, Storage
from flask import session
from typing import Union

class SessionStorage(Storage):
    def get(self, key: str) -> Union[str, None]:
        return session.get(key, None)

    def set(self, key: str, value: Union[str, None]) -> None:
        session[key] = value

    def delete(self, key: str) -> None:
        session.pop(key, None)

client = LogtoClient(
    LogtoConfig(...),
    storage=SessionStorage(),
)

Veja Storage para mais detalhes.

No seu aplicativo web, adicione uma rota para lidar adequadamente com a solicitação de login dos usuários. Vamos usar /sign-in como exemplo:

flask.py
@app.route("/sign-in")
async def sign_in():
  # Obtenha a URL de login e redirecione o usuário para ela
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
  ))

Substitua http://localhost:3000/callback pela URL de callback que você configurou no seu Logto Console para este aplicativo.

Se você quiser mostrar a página de cadastro na primeira tela, pode definir interactionMode como signUp:

flask.py
@app.route("/sign-in")
async def sign_in():
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
      interactionMode="signUp", # Mostrar a página de cadastro na primeira tela
  ))

Agora, sempre que seus usuários visitarem http://localhost:3000/sign-in, isso iniciará uma nova tentativa de login e redirecionará o usuário para a página de login do Logto.

Nota Criar uma rota de login não é a única maneira de iniciar uma tentativa de login. Você sempre pode usar o método signIn para obter a URL de login e redirecionar o usuário para ela.

Após o usuário fazer uma solicitação de logout, o Logto limpará todas as informações de autenticação do usuário na sessão.

Para limpar a sessão do Python e a sessão do Logto, uma rota de logout pode ser implementada da seguinte forma:

flask.py
@app.route("/sign-out")
async def sign_out():
  return redirect(
      # Redirecionar o usuário para a página inicial após um logout bem-sucedido
      await client.signOut(postLogoutRedirectUri="http://localhost:3000/")
  )

Lidar com o status de autenticação

No Logto SDK, podemos usar client.isAuthenticated() para verificar o status de autenticação. Se o usuário estiver autenticado, o valor será verdadeiro; caso contrário, o valor será falso.

Aqui também implementamos uma página inicial simples para demonstração:

Se o usuário não estiver autenticado, mostrar um botão de login;
Se o usuário estiver autenticado, mostrar um botão de logout.

@app.route("/")
async def home():
    if client.isAuthenticated() is False:
        return "Não autenticado <a href='/sign-in'>Entrar</a>"
    return "Autenticado <a href='/sign-out'>Sair</a>"

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 OIDC enterprise SSO connector

To simplify access management and gain enterprise-level safeguards for your big clients, connect with Flask 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 Aplicativo OIDC no seu IdP

Etapa 1: Criar um aplicativo OIDC no seu IdP

Inicie a integração OIDC SSO criando um aplicativo no lado do IdP. Você precisará fornecer as seguintes configurações do servidor Logto.

URI de Callback: O URI de Callback do Logto, também conhecido como URI de Redirecionamento ou URL de Resposta, é um endpoint ou URL específico que o IdP usa para redirecionar o navegador do usuário após a autenticação bem-sucedida. Depois que um usuário autentica com sucesso no IdP, o IdP redireciona o navegador do usuário de volta para este URI designado junto com um código de autorização. O Logto completará o processo de autenticação com base no código de autorização recebido deste URI.

Preencha o URI de Callback do Logto no formulário de configurações do aplicativo OIDC do seu IdP e continue a criar o aplicativo. (A maioria dos IdPs OIDC oferece uma ampla gama de tipos de aplicativos para escolher. Para criar um conector SSO baseado na web no Logto, por favor, escolha o tipo Web Application.)

Etapa 2: Configurar OIDC SSO no Logto

Após criar com sucesso um aplicativo OIDC no lado do IdP, você precisará fornecer as configurações do IdP de volta para o Logto. Navegue até a aba Connection e preencha as seguintes configurações:

Client ID: Um identificador único atribuído ao seu aplicativo OIDC pelo IdP. Este identificador é usado pelo Logto para identificar e autenticar o aplicativo durante o fluxo OIDC.
Client Secret: Um segredo confidencial compartilhado entre o Logto e o IdP. Este segredo é usado para autenticar o aplicativo OIDC e proteger a comunicação entre o Logto e o IdP.
Emissor (Issuer): A URL do emissor, um identificador único para o IdP, especificando a localização onde o provedor de identidade OIDC pode ser encontrado. É uma parte crucial da configuração OIDC, pois ajuda o Logto a descobrir os endpoints necessários. Para facilitar o processo de configuração, o Logto buscará automaticamente os endpoints e configurações OIDC necessários. Isso é feito utilizando o emissor que você forneceu e fazendo uma chamada aos endpoints de descoberta OIDC do IdP. É imperativo garantir que o endpoint do emissor seja válido e configurado corretamente para permitir que o Logto recupere as informações necessárias corretamente. Após uma solicitação de busca bem-sucedida, você deverá ver as configurações do IdP analisadas na seção de emissores.
Escopo (Scope): Uma lista de strings separadas por espaços definindo as permissões ou níveis de acesso desejados solicitados pelo Logto durante o processo de autenticação OIDC. O parâmetro de escopo permite que você especifique quais informações e acessos o Logto está solicitando do IdP. O parâmetro de escopo é opcional. Independentemente das configurações de escopo personalizadas, o Logto sempre enviará os escopos openid, profile e email para o IdP. Isso é para garantir que o Logto possa recuperar corretamente as informações de identidade do usuário e o endereço de email do IdP. Você pode adicionar escopos adicionais ao parâmetro de escopo para solicitar mais informações do IdP.

Etapa 3: 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 seu conector 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 OIDC 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 Python. Agora você deve conseguir fazer login com OIDC enterprise SSO. Aproveite!

Create an application in Logto​

Integrate Flask SDK​

Instalação​

Inicializar LogtoClient​

Implementar login e logout​

Lidar com o status de autenticação​

Ponto de verificação: Teste seu aplicativo​

Add OIDC enterprise SSO connector​

Set up Aplicativo OIDC no seu IdP​

Etapa 1: Criar um aplicativo OIDC no seu IdP​

Etapa 2: Configurar OIDC SSO no Logto​

Etapa 3: Definir domínios de email e habilitar o conector SSO​

Save your configuration​

Enable OIDC enterprise SSO connector in Sign-in Experience​

Testing and Validation​

Further readings​