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 OAuth2 (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 OAuth2 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:

1. 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".
2. 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.
3. 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 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.

Implementar login e logout

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:

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

Adicionar conector OAuth2

Para habilitar um login rápido e melhorar a conversão de usuários, conecte-se com Flask 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:

1. Navegue até Console > Connectors > Social Connectors.
2. Clique em "Add social connector" e selecione "OAuth2".
3. 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 padrão OAuth 2.0

Crie seu aplicativo OAuth

Ao abrir esta página, acreditamos que você já sabe qual provedor de identidade social deseja conectar. A primeira coisa a fazer é confirmar se o provedor de identidade suporta o protocolo OAuth, que é um pré-requisito para configurar um conector válido. Em seguida, siga as instruções do provedor de identidade para registrar e criar o aplicativo relevante para autorização OAuth.

Configure seu conector

Nós SOMENTE suportamos o tipo de concessão "Authorization Code" por questões de segurança e ele se encaixa perfeitamente no cenário do Logto.

clientId e clientSecret podem ser encontrados na página de detalhes dos seus aplicativos OAuth.

clientId: O client ID é um identificador único que identifica o aplicativo cliente durante o registro com o servidor de autorização. Este ID é usado pelo servidor de autorização para verificar a identidade do aplicativo cliente e associar quaisquer tokens de acesso autorizados a esse aplicativo cliente específico.

clientSecret: O client secret é uma chave confidencial emitida para o aplicativo cliente pelo servidor de autorização durante o registro. O aplicativo cliente usa essa chave secreta para se autenticar com o servidor de autorização ao solicitar tokens de acesso. O client secret é considerado informação confidencial e deve ser mantido seguro o tempo todo.

tokenEndpointAuthMethod: O método de autenticação do endpoint de token é usado pelo aplicativo cliente para se autenticar com o servidor de autorização ao solicitar tokens de acesso. Para descobrir métodos suportados, consulte o campo token_endpoint_auth_methods_supported disponível no endpoint de descoberta OpenID Connect do provedor de serviços OAuth 2.0, ou consulte a documentação relevante fornecida pelo provedor de serviços OAuth 2.0.

clientSecretJwtSigningAlgorithm (Opcional): Somente necessário quando tokenEndpointAuthMethod é client_secret_jwt. O algoritmo de assinatura JWT do client secret é usado pelo aplicativo cliente para assinar o JWT que é enviado ao servidor de autorização durante a solicitação de token.

scope: O parâmetro de escopo é usado para especificar o conjunto de recursos e permissões que o aplicativo cliente está solicitando acesso. O parâmetro de escopo é tipicamente definido como uma lista de valores separados por espaço que representam permissões específicas. Por exemplo, um valor de escopo de "read write" pode indicar que o aplicativo cliente está solicitando acesso de leitura e escrita aos dados de um usuário.

Espera-se que você encontre authorizationEndpoint, tokenEndpoint e userInfoEndpoint na documentação do fornecedor social.

authenticationEndpoint: Este endpoint é usado para iniciar o processo de autenticação. O processo de autenticação geralmente envolve o usuário fazer login e conceder autorização para que o aplicativo cliente acesse seus recursos.

tokenEndpoint: Este endpoint é usado pelo aplicativo cliente para obter um token de acesso que pode ser usado para acessar os recursos solicitados. O aplicativo cliente geralmente envia uma solicitação ao endpoint de token com um tipo de concessão e código de autorização para receber um token de acesso.

userInfoEndpoint: Este endpoint é usado pelo aplicativo cliente para obter informações adicionais sobre o usuário, como seu nome completo, endereço de email ou foto de perfil. O endpoint de informações do usuário é tipicamente acessado após o aplicativo cliente ter obtido um token de acesso do endpoint de token.

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. As chaves são nomes de campos de perfil de usuário padrão do Logto e os valores correspondentes devem ser nomes de campos dos perfis sociais. Na fase 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.

responseType e grantType podem ser SOMENTE valores FIXOS com o tipo de concessão de código de autorização, então os tornamos opcionais e os valores padrão serão preenchidos automaticamente.

Por exemplo, você pode encontrar resposta de perfil de usuário do Google e, portanto, seu profileMap deve ser assim:

{
  "id": "sub",
  "avatar": "picture"
}

nota:

Fornecemos uma chave customConfig OPCIONAL para colocar seus parâmetros personalizados. Cada provedor de identidade social pode ter sua própria variante no protocolo padrão OAuth. Se o provedor de identidade social desejado seguir estritamente o protocolo padrão OAuth, então você não precisa se preocupar com customConfig.

Tipos de configuração

Nome	Tipo	Obrigatório
authorizationEndpoint	string	true
userInfoEndpoint	string	true
clientId	string	true
clientSecret	string	true
tokenEndpointResponseType	enum	false
responseType	string	false
grantType	string	false
tokenEndpoint	string	false
scope	string	false
customConfig	Record<string, string>	false
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

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

Ativar conector OAuth2 na Experiência de Login

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

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

Teste e Validação

Retorne ao seu aplicativo Python. Agora você deve conseguir fazer login com OAuth2. 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.