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 Google Workspace enterprise SSO (autenticação de usuário) com PHP 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 PHP.
• Uma conta Google Workspace 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:

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 "Laravel" 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.

Integrate Laravel SDK

Este guia mostrará como integrar o Logto em seu aplicativo web PHP.

dica:

• O exemplo usa Laravel, mas os conceitos são os mesmos para outros frameworks.

Instalação

composer require logto/sdk

Inicializar LogtoClient

Primeiro, crie uma configuração Logto:

index.php

use Logto\Sdk\LogtoClient;
use Logto\Sdk\LogtoConfig;

$client = new LogtoClient(
  new LogtoConfig(
    endpoint: "https://you-logto-endpoint.app",
    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:

Por padrão, o SDK usa a sessão PHP embutida para armazenar os dados do Logto. Se você quiser usar outro armazenamento, pode passar um objeto de armazenamento personalizado como segundo parâmetro:

index.php

$client = new LogtoClient(
  new LogtoConfig(
    // ...
  ),
  new YourCustomStorage(),
);

Veja Storage para mais detalhes.

Configurar URIs de redirecionamento

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.

---

nota:

Nos trechos de código a seguir, assumimos que seu aplicativo está sendo executado em http://localhost:3000/.

Configurar URIs de redirecionamento

Vá para a página de detalhes do aplicativo no Logto Console. Adicione um URI de redirecionamento http://localhost:3000/callback.

Assim como no login, os usuários devem ser redirecionados para o Logto para sair da sessão compartilhada. Uma vez concluído, seria ótimo redirecionar o usuário de volta para o seu site. Por exemplo, adicione http://localhost:3000/ como a seção de URI de redirecionamento pós logout.

Em seguida, clique em "Salvar" para salvar as alterações.

Manipular callback

Após o usuário fazer login, o Logto redirecionará o usuário para a URL de callback que você definiu no Logto Console. Neste exemplo, usamos /callback como a URL de callback:

Route::get('/callback', function () {
  try {
    $client->handleSignInCallback(); // Lida com várias coisas
  } catch (\Throwable $exception) {
    return $exception; // Altere isso para a sua lógica de tratamento de erros
  }
  return redirect('/'); // Redireciona o usuário para a página inicial após um login bem-sucedido
});

Implementar rota de login

No seu aplicativo web, adicione uma rota para lidar adequadamente com a solicitação de login dos usuários. Por exemplo:

Route::get('/sign-in', function () {
return redirect($client->signIn('http://localhost:3000/callback'));
});

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

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

Route::get('/sign-in', function () {
return redirect($client->signIn('http://localhost:3000/callback', InteractionMode::signUp));
});

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.

Implementar rota de logout

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 PHP e a sessão Logto, uma rota de logout pode ser implementada da seguinte forma:

Route::get('/sign-out', function () {
return redirect(
  // Redireciona o usuário para a página inicial após um logout bem-sucedido
  $client->signOut('http://localhost:3000/')
);
});

postLogoutRedirectUri é opcional, e se não for fornecido, o usuário será redirecionado para uma página padrão do Logto após um sign-out bem-sucedido (sem redirecionar de volta para o seu aplicativo).

Nota O nome postLogoutRedirectUri é da especificação OpenID Connect RP-Initiated Logout. Embora o Logto use "sign-out" em vez de "logout", o conceito é o mesmo.

Manipular 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.

Também precisamos implementar uma página inicial 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.

Route::get('/', function () {
  if ($client->isAuthenticated() === false) {
    return "Não autenticado <a href='/sign-in'>Entrar</a>";
  }

  return "<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.

Add Google Workspace enterprise SSO connector

To simplify access management and gain enterprise-level safeguards for your big clients, connect with Laravel 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:

1. Navigate to Logto console > Enterprise SSO.

2. 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.
3. Provide a unique name (e.g., SSO sign-in for Acme Company).

4. Configure the connection with your IdP in the "Connection" tab. Check the guides above for each connector types.

5. 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.

6. Save changes.

Set up Google Cloud Platform

Etapa 1: Criar um novo projeto no Google Cloud Platform

Antes de poder usar o Google Workspace como um provedor de autenticação, você deve configurar um projeto no Google API Console para obter credenciais OAuth 2.0. Se você já tiver um projeto, pode pular esta etapa. Caso contrário, crie um novo projeto sob sua organização do Google.

Etapa 2: Configurar a tela de consentimento para seu aplicativo

Para criar uma nova credencial OIDC, você precisa configurar a tela de consentimento para o seu aplicativo.

1. Navegue até a página Tela de consentimento OAuth e selecione o tipo de usuário Interno. Isso tornará o aplicativo OAuth disponível apenas para usuários dentro da sua organização.

2. Preencha as configurações da Tela de Consentimento (Consent Screen) seguindo as instruções na página. Você precisa fornecer as seguintes informações mínimas:

• Nome do aplicativo: O nome do seu aplicativo. Ele será exibido na tela de consentimento.
• Email de suporte: O email de suporte do seu aplicativo. Ele será exibido na tela de consentimento.

3. Defina os Escopos (Scopes) para o seu aplicativo. Para recuperar adequadamente as informações de identidade e endereço de email do usuário do IdP, os conectores SSO do Logto precisam conceder os seguintes escopos do IdP:

• openid: Este escopo é necessário para a autenticação OIDC. Ele é usado para recuperar o Token de ID e obter acesso ao endpoint userInfo do IdP.
• profile: Este escopo é necessário para acessar as informações básicas do perfil do usuário.
• email: Este escopo é necessário para acessar o endereço de email do usuário.

Clique no botão Salvar para salvar as configurações da tela de consentimento.

Etapa 3: Criar uma nova credencial OAuth

Navegue até a página de Credenciais e clique no botão Create Credentials. Selecione a opção OAuth client ID no menu suspenso para criar uma nova credencial OAuth para seu aplicativo.

Continue configurando a credencial OAuth preenchendo as seguintes informações:

1. Selecione Web application como o tipo de aplicativo.
2. Preencha o Name do seu aplicativo cliente, Logto SSO Connector, por exemplo. Isso ajudará você a identificar as credenciais no futuro.
3. Preencha os Authorized redirect URIs com o URI de callback do Logto. Este é o URI para o qual o Google redirecionará o navegador do usuário após a autenticação bem-sucedida. Após um usuário autenticar-se com sucesso com o 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.
4. Preencha os Authorized JavaScript origins com a origem do URI de callback do Logto. Isso garante que apenas seu aplicativo Logto possa enviar solicitações para o servidor OAuth do Google.
5. Clique no botão Create para criar a credencial OAuth.

Etapa 4: Configurar o conector Logto com as credenciais do cliente

Após criar com sucesso a credencial OAuth, você receberá um modal de prompt com o client ID e o client secret.

Copie o Client ID e o Client secret e preencha os campos correspondentes na aba Connection do conector SSO do Logto.

Agora você configurou com sucesso um conector SSO do Google Workspace no Logto.

Etapa 5: Escopos adicionais (Opcional)

Use o campo Scope para adicionar escopos adicionais à sua solicitação OAuth. Isso permitirá que você solicite mais informações do servidor OAuth do Google. Consulte a documentação Google OAuth Scopes para mais informações.

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 e o endereço de email do usuário.

Etapa 6: 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.

Para mais informações sobre o conector SSO do Google Workspace, por favor, consulte Google OpenID Connector.

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 Google Workspace enterprise SSO deve estar disponível agora.

Enable Google Workspace enterprise SSO connector in Sign-in Experience

You don’t need to configure enterprise connectors individually, Logto simplifies SSO integration into your applications with just one click.

1. Navigate to: Console > Sign-in experience > Sign-up and sign-in.
2. Enable the "Enterprise SSO" toggle.
3. 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).

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 PHP. Agora você deve conseguir fazer login com Google Workspace enterprise SSO. Aproveite!

Further readings

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.