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 SendGrid (autenticação de usuário) com Flutter 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 Flutter.
• Uma conta SendGrid 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 Native app, 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 "Native app" ou filtre todos os frameworks "Native app" disponíveis usando as caixas de seleção de filtro rápido à esquerda. Clique no cartão do framework "Flutter" 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 Logto SDK

dica:

• O pacote SDK está disponível no pub.dev e no repositório do Logto no GitHub.
• O projeto de exemplo é construído usando Flutter material. Você pode encontrá-lo no pub.dev.
• Este SDK é compatível com aplicativos Flutter nas plataformas iOS, Android e Web. A compatibilidade com outras plataformas não foi testada.

Instalação

pub.dev

Você pode instalar o logto_dart_sdk package diretamente usando o gerenciador de pacotes pub. Execute o seguinte comando no diretório raiz do seu projeto:

flutter pub add logto_dart_sdk

Ou adicione o seguinte ao seu arquivo pubspec.yaml:

dependencies:
  logto_dart_sdk: ^3.0.0

Em seguida, execute:

flutter pub get

GitHub

Se você preferir criar sua própria versão do SDK, pode clonar o repositório diretamente do GitHub.

git clone https://github.com/logto-io/dart

Dependência e configurações

Compatibilidade de versão do SDK

Versão do Logto SDK	Versão do Dart SDK	Compatível com Dart 3.0
< 2.0.0	>= 2.17.6 < 3.0.0	false
>= 2.0.0 < 3.0.0	>= 3.0.0	true
>= 3.0.0	>= 3.6.0	true

Configuração do flutter_secure_storage

Nos bastidores, este SDK usa flutter_secure_storage para implementar o armazenamento seguro de tokens persistentes em várias plataformas.

• Keychain é usado para iOS
• Criptografia AES é usada para Android.

Configurar versão do Android

Defina o android:minSdkVersion para >= 18 no arquivo android/app/build.gradle do seu projeto.

build.gradle

  android {
      ...

      defaultConfig {
          ...
          minSdkVersion 18
          ...
      }
  }

Desativar backup automático no Android

Por padrão, o Android faz backup de dados no Google Drive. Isso pode causar a exceção java.security.InvalidKeyException:Failed ao desembrulhar a chave. Para evitar isso,

1. Para desativar o backup automático, vá para o arquivo de manifesto do seu aplicativo e defina os atributos android:allowBackup e android:fullBackupContent como false.

   AndroidManifest.xml

   <manifest ... >
       ...
       <application
         android:allowBackup="false"
         android:fullBackupContent="false"
         ...
       >
           ...
       </application>
   </manifest>
   

2. Exclua sharedprefs do FlutterSecureStorage.

   Se você precisar manter o android:fullBackupContent para seu aplicativo em vez de desativá-lo, pode excluir o diretório sharedprefs do backup. Veja mais detalhes na documentação do Android.

   No seu arquivo AndroidManifest.xml, adicione o atributo android:fullBackupContent ao elemento <application>, conforme mostrado no exemplo a seguir. Este atributo aponta para um arquivo XML que contém regras de backup.

   AndroidManifest.xml

   <application ...
     android:fullBackupContent="@xml/backup_rules">
   </application>

   Crie um arquivo XML chamado @xml/backup_rules no diretório res/xml/. Neste arquivo, adicione regras com os elementos <include> e <exclude>. O exemplo a seguir faz backup de todas as preferências compartilhadas, exceto device.xml:

   @xml/backup_rules

   <?xml version="1.0" encoding="utf-8"?>
   <full-backup-content>
     <exclude domain="sharedpref" path="FlutterSecureStorage"/>
   </full-backup-content>

Por favor, verifique flutter_secure_storage para mais detalhes.

Configuração do flutter_web_auth_2

Nos bastidores, este SDK usa flutter_web_auth_2 para autenticar usuários com Logto. Este pacote fornece uma maneira simples de autenticar usuários com Logto usando o webview do sistema ou navegador.

Este plugin usa ASWebAuthenticationSession no iOS 12+ e macOS 10.15+, SFAuthenticationSession no iOS 11, Chrome Custom Tabs no Android e abre uma nova janela na Web.

• iOS: Nenhuma configuração adicional necessária

• Android: Registre a URL de callback no Android

  Para capturar a URL de callback da página de login do Logto, você precisará registrar seu redirectUri de login no arquivo AndroidManifest.xml.

  AndroidManifest.xml

    <manifest>
      <application>
          <activity
            android:name="com.linusu.flutter_web_auth_2.CallbackActivity"
            android:exported="true">
            <intent-filter android:label="flutter_web_auth_2">
            <action android:name="android.intent.action.VIEW" />
            <category android:name="android.intent.category.DEFAULT" />
            <category android:name="android.intent.category.BROWSABLE" />
            <data android:scheme="YOUR_CALLBACK_URL_SCHEME_HERE" />
            </intent-filter>
          </activity>
      </application>
    </manifest>

• Navegador Web: Crie um endpoint para lidar com a URL de callback

  Se você estiver usando a plataforma web, precisará criar um endpoint para lidar com a URL de callback e enviá-la de volta para o aplicativo usando a API postMessage.

  callback.html

  <!doctype html>
  <title>Autenticação completa</title>
  <p>
    A autenticação está completa. Se isso não acontecer automaticamente, por favor, feche a janela.
  </p>
  <script>
    function postAuthenticationMessage() {
      const message = {
        'flutter-web-auth-2': window.location.href,
      };
  
      if (window.opener) {
        window.opener.postMessage(message, window.location.origin);
        window.close();
      } else if (window.parent && window.parent !== window) {
        window.parent.postMessage(message, window.location.origin);
      } else {
        localStorage.setItem('flutter-web-auth-2', window.location.href);
        window.close();
      }
    }
  
    postAuthenticationMessage();
  </script>

Por favor, verifique o guia de configuração no pacote flutter_web_auth_2 para mais detalhes.

Integração

Inicializar LogtoClient

Importe o pacote logto_dart_sdk e inicialize a instância LogtoClient na raiz do seu aplicativo.

lib/main.dart

import 'package:logto_dart_sdk/logto_dart_sdk.dart';
import 'package:http/http.dart' as http;

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Flutter Demo',
      home: MyHomePage(title: 'Logto Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late LogtoClient logtoClient;

  void render() {
    // mudança de estado
  }

  // LogtoConfig
  final logtoConfig = const LogtoConfig(
    endpoint: "<your-logto-endpoint>",
    appId: "<your-app-id>"
  );

  void _init() {
    logtoClient = LogtoClient(
      config: logtoConfig,
      httpClient: http.Client(), // Cliente HTTP opcional
    );
    render();
  }

  @override
  void initState() {
    super.initState();
    _init();
  }

  // ...
}

Implementar login

Antes de mergulharmos nos detalhes, aqui está uma visão geral rápida da experiência do usuário final. O processo de login pode ser simplificado da seguinte forma:

1. Seu aplicativo invoca o método de login.
2. O usuário é redirecionado para a página de login do Logto. Para aplicativos nativos, o navegador do sistema é aberto.
3. O usuário faz login e é redirecionado de volta para o seu aplicativo (configurado como o URI de redirecionamento).

Sobre o login baseado em redirecionamento

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

---

Antes de começar, você precisa adicionar um URI de redirecionamento no Admin Console para o seu aplicativo.

Vamos mudar para a página de detalhes do Aplicativo no Logto Console. Adicione um URI de redirecionamento io.logto://callback e clique em "Salvar alterações".

• Para iOS, o esquema de URI de redirecionamento não importa realmente, pois a classe ASWebAuthenticationSession ouvirá o URI de redirecionamento independentemente de estar registrado.
• Para Android, o esquema de URI de redirecionamento deve ser registrado no arquivo AndroidManifest.xml.

Após configurar o URI de redirecionamento, adicionamos um botão de login à sua página, que chamará a API logtoClient.signIn para invocar o fluxo de login do Logto:

lib/main.dart

class _MyHomePageState extends State<MyHomePage> {
  // ...
  final redirectUri = 'io.logto://callback';

  @override
  Widget build(BuildContext context) {
    // ...

    Widget signInButton = TextButton(
      onPressed: () async {
        await logtoClient.signIn(redirectUri);
        render();
      },
      child: const Text('Sign In'),
    );

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            signInButton,
          ],
        ),
      ),
    );
  }
}

Implementar logout

Vamos mudar para a página de detalhes do Aplicativo no Logto Console. Adicione um URI de Redirecionamento Pós-Logout io.logto://callback e clique em "Salvar alterações".

URI de Redirecionamento Pós-Logout é um conceito do OAuth 2.0 que implica o local para onde deve redirecionar após o logout.

Agora vamos adicionar um botão de logout na página principal para que os usuários possam sair do seu aplicativo.

lib/main.dart

class _MyHomePageState extends State<MyHomePage> {
  // ...

  final postSignOutRedirectUri = 'io.logto//home';

  @override
  Widget build(BuildContext context) {
    // ...

    Widget signOutButton = TextButton(
      onPressed: () async {
        await logtoClient.signOut(postSignOutRedirectUri);
        render();
      },
      child: const Text('Sign Out'),
    );

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            signInButton,
            signOutButton,
          ],
        ),
      ),
    );
  }
}

Lidar com o status de autenticação

O Logto SDK fornece um método assíncrono para verificar o status de autenticação. O método é logtoClient.isAuthenticated. O método retorna um valor booleano, true se o usuário estiver autenticado, caso contrário, false.

No exemplo, renderizamos condicionalmente os botões de login e logout com base no status de autenticação. Agora vamos atualizar o método render em nosso Widget para lidar com a mudança de estado:

lib/main.dart

class _MyHomePageState extends State<MyHomePage> {
  // ...
  bool? isAuthenticated = false;

  void render() {
    setState(() async {
      isAuthenticated = await logtoClient.isAuthenticated;
    });
  }

  @override
  Widget build(BuildContext context) {
    // ...

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            isAuthenticated == true ? signOutButton : signInButton,
          ],
        ),
      ),
    );
  }
}

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 SendGrid

O conector Email é um método usado para enviar senhas de uso único (OTPs) para autenticação. Ele permite a verificação de Endereço de email para suportar autenticação sem senha, incluindo registro baseado em Email, login, autenticação de dois fatores (2FA) e recuperação de conta. Você pode facilmente conectar SendGrid como seu provedor Email. Com o conector Email do Logto, você pode configurá-lo em apenas alguns minutos.

Para adicionar um conector Email, basta seguir estas etapas:

1. Navegue até Console > Connector > Email and SMS connectors.
2. Para adicionar um novo conector Email, clique no botão "Set up" e selecione "SendGrid".
3. Revise a documentação README para o provedor selecionado.
4. Complete os campos de configuração na seção "Parameter Configuration".
5. Personalize o modelo Email usando o editor JSON.
6. Teste sua configuração enviando um código de verificação para seu Endereço de email.

nota:

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

Configurar Conector de email SendGrid

Registrar conta SendGrid

Crie uma nova conta no site da SendGrid. Você pode pular esta etapa se já tiver uma conta.

Verificar remetentes

Vá para a página do console SendGrid e faça login com sua conta SendGrid.

Os remetentes indicam os endereços de onde nosso email de código de verificação será enviado. Para enviar emails via servidor de email SendGrid, você precisa verificar pelo menos um remetente.

A partir da página do console SendGrid, vá para "Settings" -> "Sender Authentication" na barra lateral.

A autenticação de domínio é recomendada, mas não obrigatória. Você pode clicar em "Get started" no cartão "Authenticate Your Domain" e seguir o guia que se segue para vincular e verificar um remetente no SendGrid.

Ao clicar no botão "Verify a Single Sender" no painel, você estará focando em um formulário que requer algumas informações críticas para criar um remetente. Siga o guia, preencha todos esses campos e clique no botão "Create".

Após o remetente único ser criado, um email com um link de verificação deve ser enviado para o endereço de email do seu remetente. Vá para sua caixa de entrada, encontre o email de verificação e termine de verificar o remetente único clicando no link fornecido no email. Agora você pode enviar emails via conector SendGrid usando o remetente que acabou de verificar.

Criar chaves de API

Vamos começar a partir da página do console SendGrid, vá para "Settings" -> "API Keys" na barra lateral.

Clique em "Create API Key" no canto superior direito da página de API Keys. Digite o nome da chave de API e personalize "API Key Permission" conforme seu caso de uso. Um Full Access global ou Restricted Access com acesso total ao Mail Send é necessário antes de enviar emails com esta chave de API.

A chave de API é apresentada a você na tela assim que você termina o processo de Create API Key. Você deve salvar esta chave de API em algum lugar seguro, pois esta é a única chance de vê-la.

Configurar seu conector

Preencha o campo apiKey com a chave de API criada na seção "Criar chaves de API".

Preencha os campos fromEmail e fromName com o From Address e o Nickname dos remetentes. Você pode encontrar os detalhes do remetente na página "Sender Management". fromName é OPCIONAL, então você pode pular o preenchimento.

Você pode adicionar vários modelos de conector de email SendGrid para diferentes casos. Aqui está um exemplo de adição de um único modelo:

• Preencha o campo subject, que funciona como o título dos emails.
• Preencha o campo content com conteúdos de string arbitrários. Não se esqueça de deixar o espaço reservado {{code}} para o código de verificação aleatório.
• Preencha o campo usageType com Register, SignIn, ForgotPassword, Generic para diferentes casos de uso.
• Preencha o campo type com text/plain ou text/html para diferentes tipos de conteúdo.

Para habilitar fluxos completos de usuário, são necessários modelos com usageType Register, SignIn, ForgotPassword e Generic.

Aqui está um exemplo de JSON de modelo de conector SendGrid.

[
  {
    "subject": "<register-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (register template)>",
    "usageType": "Register",
    "type": "text/plain",
  },
  {
    "subject": "<sign-in-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (sign-in template)>",
    "usageType": "SignIn",
    "type": "text/plain",
  },
  {
    "subject": "<forgot-password-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (forgot-password template)>",
    "usageType": "ForgotPassword",
    "type": "text/plain",
  },
  {
    "subject": "<generic-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (generic template)>",
    "usageType": "Generic",
    "type": "text/plain",
  },
]

Testar conector de email SendGrid

Você pode digitar um endereço de email e clicar em "Send" para ver se as configurações funcionam antes de "Save and Done".

É isso. Não se esqueça de Habilitar conector na experiência de login

Tipos de configuração

Nome	Tipo
apiKey	string
fromEmail	string
fromName	string (OPCIONAL)
templates	Template[]

Propriedades do Template	Tipo	Valores do Enum
subject	string	N/A
content	string	N/A
usageType	enum string	'Register' | 'SignIn' | 'ForgotPassword' | 'Generic'
type	enum string	'text/plain' | 'text/html'

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

Ativar conector SendGrid na Experiência de Login

Depois de criar um conector com sucesso, você pode habilitar o login e registro sem senha baseado em número de telefone.

1. Navegue para Console > Experiência de login > Inscrição e login.
2. Configure os métodos de inscrição (Opcional):
   1. Selecione "Endereço de email" ou "Email ou número de telefone" como o identificador de inscrição.
   2. "Verificar na inscrição" é forçado a ser habilitado. Você também pode habilitar "Criar uma senha" no registro.
3. Configure os métodos de login:
   1. Selecione Endereço de email como um dos identificadores de login. Você pode fornecer vários identificadores disponíveis (email, número de telefone e nome de usuário).
   2. Selecione "Código de verificação" e / ou "Senha" como o fator de autenticação.
4. Clique em "Salvar alterações" e teste na "Pré-visualização ao vivo".

Além do registro e login via OTPs , você também pode habilitar a recuperação de senha e verificação de segurança baseada em , bem como vincular Endereço de email ao perfil. Veja Fluxos de usuário final para mais detalhes.

Teste e Validação

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