Como construir um servidor Symfony API seguro usando Auth0

Neste tutorial, aprenderemos como construir e proteger um servidor Symfony API simples usando Auth0. Você também dará um passo adiante para proteger alguns dos endpoints. Você usará Auth0 para lidar com autenticação e autorização. O código-fonte completo para este tutorial pode ser encontrado aqui no GitHub .

Pré-requisitos

Para acompanhar este tutorial, você deve ter conhecimento razoável de Programação Orientada a Objetos em PHP e conhecimento básico de construção de aplicações com Symfony. Você também precisará do seguinte:

• Composer instalado globalmente em seu computador para gerenciar dependências
• Symfony CLI instalado em seu computador. Siga as instruções aqui para configurá-lo para o seu sistema operacional.
• Uma conta Auth0. Você pode se inscrever para uma conta Auth0 gratuita aqui .
• Angular CLI instalado globalmente em seu computador. Observe que você não precisa ser proficiente em criar aplicativos com Angular. Só é necessário aqui testar a API que iremos construir.

O que você vai construir

Você construirá um servidor Symfony API simples com três endpoints diferentes. Cada endpoint retornará diferentes tipos de mensagens, dependendo do acesso que o usuário possui.

Terminal público

• GET /api/messages/public

Este endpoint deve ser exposto a qualquer pessoa não autorizada. Espera-se retornar a seguinte mensagem:

{
  "message": "The API doesn't require an access token to share this message."
}

Endpoint protegido

• GET /api/messages/protected

Este endpoint será protegido contra acesso não autorizado. Somente usuários autorizados com um token de acesso válido em seu cabeçalho de solicitação HTTP poderão ver a seguinte mensagem:

{
  "message": "The API successfully validated your access token."
}

Endpoint do administrador

• GET /api/messages/admin

Semelhante ao endpoint protegido, isso requer que o token de acesso contenha uma read:admin-messagespermissão para acessar os dados do administrador. Isso geralmente é chamado de controle de acesso baseado em função (RBAC) .

Começando

Aqui você começará a construir a API do Symfony configurando e instalando um novo aplicativo Symfony e suas dependências necessárias.

Estruturando o aplicativo Symfony

Para começar, abra seu terminal, navegue até o diretório de desenvolvimento de sua preferência e execute o seguinte comando para criar um novo projeto usando o Composer :

composer create-project symfony/website-skeleton api-symfony-server

Depois que o processo de instalação estiver concluído, mude para o novo diretório que você acabou de criar:

cd api-symfony-server

```bash
cp .env .env.local

Este arquivo é ignorado pelo Git, pois corresponde a um padrão existente .gitignore(que o Symfony gerou). Um dos benefícios desse arquivo é que ele ajuda a armazenar suas credenciais fora do código para mantê-las seguras.

Em seguida, atualize o DATABASE_URLparâmetro .env.localpara que o aplicativo use um banco de dados SQLite em vez do padrão PostgreSQL. Para fazer isso, comente a DATABASE_URLentrada existente e remova o comentário da opção SQLite para que corresponda ao exemplo abaixo.

DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"

NOTA: O banco de dados será criado no diretório var no diretório raiz do projeto e será nomeado data.db.

Executando o aplicativo

Certifique-se de estar no diretório principal do projeto e usando a CLI do Symfony , inicie o aplicativo com o seguinte comando:

symfony serve

Navegue até http://localhost:8000 para visualizar a página inicial padrão do novo aplicativo Symfony:

Construindo a API

Nesta seção, vamos nos concentrar na criação de controladores que manipularão a lógica de cada terminal mencionado anteriormente. Começaremos com o ponto de extremidade público e prosseguiremos gradualmente para lidar com outros pontos de extremidade.

Pare a execução do aplicativo usando CTRL + Ce, em seguida, pressioneEnter

Crie controladores e configure cada endpoint

Comece emitindo o seguinte comando do terminal dentro do diretório raiz do seu projeto para criar um controlador:

php bin/console make:controller APIController

Você verá a seguinte saída:

 created: src/Controller/APIController.php
 created: templates/api/index.html.twig

  Success!

 Next: Open your new controller class and add some pages!

Localize o controlador recém-criado src/Controller/APIController.phpe atualize seu conteúdo com o seguinte:

// src/Controller/APIController.php
<?php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

/**
 * @Route("/api/messages")
 */
class APIController extends AbstractController
{
    /**
     * @Route("/public", name="public")
     */
    public function publicAction()
    : JsonResponse
    {
        return $this->json(["message" => "The API doesn't require an access token to share this message."], Response::HTTP_OK);
    }

    /**
     * @Route("/protected", name="protected")
     */
    public function protectedAction()
    : JsonResponse
    {
        return $this->json(["message" => "The API successfully validated your access token."], Response::HTTP_OK);
    }

    /**
     * @Route("/admin", name="admin")
     */
    public function adminAction(): JsonResponse
    {
        return $this->json(["message" => "The API successfully recognized you as an admin."], Response::HTTP_OK);
    }
}

Do trecho acima, este controlador contém três métodos diferentes:

• publicAction()
• protectedAction()
• adminAction()

Cada um é projetado para manipular /public, /protectede /adminterminais e retorna as mensagens apropriadas, respectivamente.

De volta ao terminal, inicie o aplicativo novamente symfony servee abra uma ferramenta de teste de API, como o Postman , para testar cada endpoint.

Comece com o terminal público. Crie uma nova solicitação GET para este endpoint http://localhost:8000/api/messages/public . Você receberá a mensagem The API doesn't require an access token to share this message, conforme imagem abaixo:

Em seguida, experimente o endpoint protegido em http://localhost:8000/api/messages/protected .

E, finalmente, o terminal admin em [ http://localhost:8000/api/messages/admin ] ( http://localhost:8000/api/messages/admin ) fornecerá a mensagem The API successfully recognized you as an admin.:

No momento, todos os endpoints criados podem ser acessados ​​por qualquer pessoa. Claro, não é isso que queremos. Você precisa garantir que os terminais /protectede /adminsejam expostos apenas a usuários autorizados. Você iniciará a configuração na próxima seção.

Se ainda não o fez, certifique-se de criar uma conta Auth0 gratuita agora .

Protegendo endpoints protegidos e administrativos

Você usará Auth0 para proteger os endpoints (protegidos e admin). Para fazer isso, você precisará voltar ao seu painel Auth0 e configurar uma API.

Para começar, navegue até a seção API do seu painel de gerenciamento Auth0 clicando em "Aplicativos"> "APIs". Se você já criou APIs antes, isso mostrará a lista de todas as APIs da sua conta, mas para este tutorial, vá em frente e clique no botão "CRIAR API" e configure uma nova.

Forneça um nome amigável, como Symfony API Serverpara a API, e defina seu identificador como https://localhost:8000. Você é livre para usar qualquer nome e identificador, mas se quiser seguir este tutorial exatamente, você deve manter os valores acima. Deixe o algoritmo de assinatura como RS256e clique no botão "Criar" para prosseguir. Você precisará dos valores daqui mais adiante no tutorial.

Instalar dependências e configurar autenticação

Para proteger os endpoints GET /api/messages/protectede GET /api/messages/adminvocê usará o pacote de autenticação JWT para Symfony chamado auth0/jwt-auth-bundle .

Interrompa a execução do aplicativo usando CTRL + Ce execute o seguinte comando para instalar o pacote usando o composer:

composer require auth0/jwt-auth-bundle:"~4.0"

Depois de instalar o pacote em seu projeto, você deve encontrar um novo arquivo localizado em config/packages/jwt_auth.yaml. Caso contrário, crie o arquivo e cole o seguinte conteúdo nele:

jwt_auth:
  domain: "%env(AUTH0_DOMAIN)%"
  client_id: "%env(AUTH0_CLIENT_ID)%"
  audience: "%env(AUTH0_AUDIENCE)%"

Anteriormente, quando você criava uma API, Auth0 também criava automaticamente um aplicativo de teste para sua API. Este será o aplicativo Auth0 que manterá seus usuários. Você pode encontrá-lo clicando em Applications> Applicationse, em seguida, selecionando o aplicativo de teste na lista que corresponde ao que você nomeou sua API. Se você nomeou da mesma forma que neste tutorial, será "Symfony API Server (Test Application)". Você também pode selecionar e usar quaisquer outros aplicativos para sua conta. Mas para este tutorial, clique no aplicativo de teste e você verá uma página conforme mostrado aqui:

Abra .env.localo arquivo e atualize os valores das variáveis ​​de ambiente abaixo:

CLIENT_ORIGIN_URL=http://localhost:4040
AUTH0_AUDIENCE=http://localhost:8000
AUTH0_DOMAIN=YOUR_AUTH0_DOMAIN
AUTH0_CLIENT_ID=YOUR_AUTH0_ID
AUTH0_CLIENT_SECRET=YOUR_AUTH0_CLIENT_SECRET

Certifique-se de substituir YOUR_AUTH0_DOMAIN, YOUR_AUTH0_CLIENT_IDe YOUR_AUTH0_CLIENT_SECRETos espaços reservados pelos valores apropriados obtidos em seu painel Auth0.

Configurando usuário e provedor de usuário

Lidar com autenticação e autorização requer que Auth0 esteja ciente do usuário autenticado no momento. Este é o trabalho de um provedor de usuário no Symfony, pois ajuda a recarregar um usuário da sessão e carregar o usuário para outros recursos específicos, como usar nome de usuário ou e-mail para autenticação.

Se os usuários de nossa API estiverem armazenados no banco de dados, pode não ser necessário criar um provedor de usuário personalizado, mas aqui carregaremos os usuários de um local personalizado (Auth0), daí a necessidade de criar um.

Para começar, navegue até a srcpasta e crie uma nova pasta chamada Securitye dentro da pasta recém-criada, crie outra e chame-a de User. Em seguida, crie a classe de usuário dentro da Userpasta e nomeie-a como WebServiceUser.php. Abra o arquivo recém-criado e cole o seguinte código nele:

<?php

namespace App\Security\User;

use Symfony\Component\Security\Core\User\EquatableInterface;
use Symfony\Component\Security\Core\User\UserInterface;

class WebServiceUser implements
    UserInterface, EquatableInterface {

    private $roles;
    private $jwt;

    public function __construct($jwt, $roles) {

        $this->roles = $roles;
        $this->jwt = $jwt;
    }

    /**
     * @inheritDoc
     */
    public function getRoles()
    : array {

        return $this->roles;
    }

    /**
     * @inheritDoc
     */
    public function getPassword()
    : ?string {

        return null;
    }

    /**
     * @inheritDoc
     */
    public function getSalt()
    : ?string {

        return null;
    }

    public function isEqualTo(UserInterface $user)
    : bool {

        if (!$user instanceof WebServiceUser) {
            return false;
        }

        return $this->getUsername() === $user->getUsername();
    }

    /**
     * @inheritDoc
     */
    public function getUsername() {

        return $this->jwt["email"] ?? $this->jwt["sub"];
    }

    /**
     * @inheritDoc
     */
    public function eraseCredentials() {
    }

    public function getUserIdentifier() {
        return $this->jwt["email"] ?? $this->jwt["sub"];
    }
}

Aqui, a WebServiceUserclasse implementa duas interfaces diferentes:

• UserInterface — representa a interface que todas as classes User devem implementar
• EquatableInterface — usado para testar se dois objetos são iguais no contexto de segurança e reautenticação

Em seguida, crie um arquivo na Userpasta e nomeie-o WebServiceAnonymousUser.php. Isso retornará o usuário anônimo. Use o seguinte conteúdo para isso:

<?php

namespace App\Security\User;

class WebServiceAnonymousUser extends WebServiceUser {

    public function __construct() {

        parent::__construct(null, ['IS_AUTHENTICATED_ANONYMOUSLY']);
    }

    public function getUsername() {

        return null;
    }
}

Para finalizar, crie outro arquivo dentro da Userpasta e nomeie-o como WebServiceUserProvider.php. Quando terminar, cole o seguinte código nele:

<?php

namespace App\Security\User;

use Auth0\JWTAuthBundle\Security\Core\JWTUserProviderInterface;
use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Polyfill\Intl\Icu\Exception\NotImplementedException;


class WebServiceUserProvider implements JWTUserProviderInterface {

    public function loadUserByJWT($jwt)
    : WebServiceUser {
        $data = ['sub' => $jwt->sub];
        $roles = [];
        $roles[] = 'ROLE_OAUTH_AUTHENTICATED';

        return new WebServiceUser($data, $roles);
    }

    public function getAnonymousUser()
    : WebServiceAnonymousUser {

        return new WebServiceAnonymousUser();
    }

    public function loadUserByUsername($username) {

        throw new NotImplementedException('method not implemented');
    }

    public function refreshUser(UserInterface $user) {

        if (!$user instanceof WebServiceUser) {
            throw new UnsupportedUserException(
                sprintf('Instances of "%s" are not supported.', get_class($user))
            );
        }

        return $this->loadUserByUsername($user->getUsername());
    }

    public function supportsClass($class)
    : bool {

        return $class === 'App\Security\User\WebServiceUser';
    }

    public function loadUserByIdentifier(string $identifier)
    {
        throw new NotImplementedException('method not implemented');
    }
}

Essa classe implementa o JWTUserProviderInterfacedo pacote Auth0 instalado anteriormente, que especifica os métodos importantes que a WebServiceUserProviderclasse deve implementar. Esses métodos são:

• loadUserByJWT: recebe o token de acesso JWT decodificado e retorna um User.
• getAnonymousUser: retorna um usuário anônimo que representa um não autenticado (geralmente representado pelo papel IS_AUTHENTICATED_ANONYMOUSLY)

Criando um autenticador de guarda

Em seguida, precisamos criar um autenticador de guarda no Symfony. Para fazer isso, crie um novo arquivo dentro da src/Security/Userpasta e nomeie-o como GuardAuthenticator.php. Abra o novo arquivo e use o seguinte conteúdo para ele:

<?php


namespace App\Security\User;


use Auth0\JWTAuthBundle\Security\Guard\JwtGuardAuthenticator;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Exception\AuthenticationException;

class GuardAuthenticator extends JwtGuardAuthenticator
{
    public function start(Request $request, AuthenticationException $authException = null)
    {
        $responseBody = [
            'message' => 'No authorization token was found',
        ];

        return new JsonResponse($responseBody, JsonResponse::HTTP_UNAUTHORIZED);
    }
}

Isso GuardAuthenticatorestende a JwtGuardAuthenticatorclasse do jwtpacote e verifica se um token de acesso está presente em um cabeçalho de solicitação HTTP. Caso contrário, ele retorna uma mensagem apropriada.

Configurar o provedor de segurança

Antes de configurar o provedor de segurança, crie um serviço para WebServiceUserProvider. Os serviços são uma ótima maneira de tornar seus aplicativos mais fáceis de manter e adaptar a novos requisitos. Você pode criar um adicionando este código ao final do config/services.yamlarquivo:

parameters:

services:
    ...
    # 👇  new code starts here
    web_service_user_provider:
        class: App\Security\User\WebServiceUserProvider
        arguments: ["@jwt_auth.auth0_service"]

Por fim, modifique o security.yamlarquivo localizado no config/packages/security.yamlarquivo para que contenha o seguinte:

• o web_service_user_providerserviço
• A área segura que você deseja autenticar usando um token de acesso
• A access_controlseção com as funções necessárias para cada rota Você pode substituí-la completamente pelo seguinte:

security:
  enable_authenticator_manager: true

  # https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
  providers:
    #        users_in_memory: { memory: null }
    web_service_user_provider:
      id: App\Security\User\WebServiceUserProvider
  firewalls:
    dev:
      pattern: ^/(_(profiler|wdt)|css|images|js)/
      security: false
    secured_area:
      pattern: ^/api
      stateless: true
      guard:
        authenticators:
          id: App\Security\User\GuardAuthenticator
      provider: web_service_user_provider
  # Easy way to control access for large sections of your site
  # Note: Only the *first* access control that matches will be used
  access_control:
    - { path: ^/api/messages/public, roles: PUBLIC_ACCESS }
    - { path: ^/api/messages/protected, roles: ROLE_OAUTH_AUTHENTICATED }
    - { path: ^/api/messages/admin, roles: ROLE_OAUTH_AUTHENTICATED }

Agora, você pode testar isso novamente com o Postman acessando a rota protegida. Inicie o aplicativo executando symfony servee acesse http://localhost:8000/api/messages/protected. Você receberá uma mensagem indicando que "Nenhum token de autorização foi encontrado" conforme mostrado abaixo:

Isso ocorre porque você precisa de um token de acesso para recuperar com êxito o conteúdo do /protectedendpoint.

Obtenha um token e autorize o aplicativo de teste

Gerar um token de acesso dinamicamente exigirá que seu aplicativo cliente seja autorizado pelo Auth0, mas como prova de conceito, por enquanto, você obterá e usará um token de teste para sua API no Auth0 Dashboard. Para fazer isso, navegue até a seção API em seu Auth0 Dashboard e clique na API que você criou anteriormente. Em seguida, clique na Testguia e role para baixo para copiar o access_tokenmostrado sob o subtítulo Resposta .

Abra o Postman novamente e selecione Bearer Tokenna guia Autorização e cole o Token de acesso:

Agora você pode experimentar o api/messages/protectedendpoint protegido e receberá a mensagem The API successfully validated your access token., conforme mostrado abaixo:

Implementando o controle de acesso baseado em função para a API

Conforme mencionado anteriormente, o GET /api/messages/adminendpoint requer que o token de acesso contenha uma read:admin-messagespermissão para acessar os dados administrativos. Isso geralmente é chamado de controle de acesso baseado em função (RBAC) , em que as permissões devem ser atribuídas aos usuários com base em sua função dentro de uma organização.

Nesta seção, para implementar e configurar esse controle de acesso, você fará o seguinte:

• Ative as configurações de RBAC (controle de acesso baseado em função) no seu painel Auth0
• Crie uma adminfunção dentro do Painel
• Crie permissão específica. read:admin-messagespara ser mais preciso.
• Adicione a permissão recém-criada à adminfunção.
• Atribua a nova função a um usuário específico

Ativar configurações de RBAC

Para que o controle de acesso baseado em função (RBAC) funcione corretamente, você deve ativá-lo para sua API usando o Dashboard ou a API de gerenciamento .

Navegue até o painel Auth0 e clique em APIs, selecione a API criada anteriormente Symfony API Servere role para baixo até a seção Configurações do RBAC :

Ative o RBAC alternando os dois botões aqui: "Ativar RBAC" e "Adicionar permissões no token de acesso". Isso aplicará políticas de autorização de controle de acesso baseadas em função para qualquer endpoint de sua escolha e garantirá que a permissionsdeclaração seja adicionada ao token de acesso. Clique no botão Salvar para atualizar as alterações.

Criar uma função de administrador

Você pode criar funções usando o Dashboard do Auth0 ou a API de gerenciamento. As funções podem ser usadas com o conjunto de recursos API Authorization Core .

Vá para o seguinte:

• Painel
• Clique em Gerenciamento de usuários na barra de menu lateral
• Clique em funções
• Em seguida, clique no botão Criar função

Dê um nome à função, como "Admin" e adicione uma descrição, como "Ler todas as mensagens do administrador":

Criar permissões

Volte para a Symfony API Serverpágina no menu API no painel e clique na guia "Permissões" na mesma página para definir a permissão e seu escopo.

Em "Permissão (Escopo), cole read:admin-messages. Em "Descrição", coloque "Ler mensagens do administrador". Certifique-se de clicar em "Adicionar" para salvar a permissão.

Adicionar permissões às funções

Agora que você criou a Adminfunção e sua permissão correspondente, a próxima coisa a fazer é adicionar a permissão à função recém-criada.

Volte para a página "Funções" em "Gerenciamento de usuários"> "Funções".

Clique na função Admin que você criou anteriormente e, em seguida, clique na guia Permissões. Agora clique no botão Adicionar permissões . Você verá uma página como esta:

Selecione a API na lista; no nosso caso seria Symfony API Server. Marque a caixa ao lado read:admin-messagespara indicar a permissão para a função Admin. Por fim, clique em Adicionar permissões para salvar as alterações.

Atribuir funções aos usuários

Há duas maneiras de atribuir uma função a um usuário. Você pode escolher um usuário na lista Usuários e, em seguida, atribuir uma função ou pode ir para a página Detalhes do usuário (perfil do usuário) de um usuário individual e escolher uma função a ser atribuída na guia Funções . Você ficará com a lista de usuários neste tutorial.

Fazer isso:

1. Vá para Painel > Gerenciamento de usuários > Usuários .
2. Clique em " ... " ao lado do usuário que deseja modificar e selecione Atribuir funções .
3. Escolha a(s) função(ões) que deseja atribuir e clique em Atribuir

Atualizando provedor de usuário de serviço da Web

Neste ponto, uma vez que um usuário é autenticado por meio da API, o access tokenque será retornado conterá uma read:admin-messagespermissão ou não. Para verificar essa permissão antes de permitir que o usuário acesse os dados do administrador, você atualizará o src/Security/User/WebServiceUserProvider.phparquivo conforme mostrado abaixo:

...
class WebServiceUserProvider implements JWTUserProviderInterface {

    public function loadUserByJWT($jwt)
    : WebServiceUser {
        $data = ['sub' => $jwt->sub];
        $roles = [];
        $roles[] = in_array('read:admin-messages', $jwt->permissions) ? 'ROLE_ADMIN' : 'ROLE_OAUTH_AUTHENTICATED';

        return new WebServiceUser($data, $roles);
    }
    ...
}

Aqui, você verificou se o read:admin-messagesestá presente na matriz de permissões ou não. Se presente, uma função de a ROLE_ADMINserá atribuída ao usuário autenticado. Caso contrário, uma função de ROLE_OAUTH_AUTHENTICATEDseria atribuída.

Além disso, abra config/packages/security.yamle atualize seu conteúdo conforme mostrado aqui:

security:
  enable_authenticator_manager: true

  # https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
  providers:
    #        users_in_memory: { memory: null }
    web_service_user_provider:
      id: App\Security\User\WebServiceUserProvider
  firewalls:
    dev:
      pattern: ^/(_(profiler|wdt)|css|images|js)/
      security: false
    secured_area:
      pattern: ^/api
      stateless: true
      guard:
        authenticators:
          id: App\Security\User\GuardAuthenticator
      provider: web_service_user_provider
  role_hierarchy:
    ROLE_ADMIN: [ROLE_OAUTH_AUTHENTICATED, ROLE_ALLOWED_TO_SWITCH]
  # Easy way to control access for large sections of your site
  # Note: Only the *first* access control that matches will be used
  access_control:
    - { path: ^/api/messages/public, roles: PUBLIC_ACCESS }
    - { path: ^/api/messages/protected, roles: ROLE_OAUTH_AUTHENTICATED }
    - { path: ^/api/messages/admin, roles: ROLE_ADMIN }

No snippet acima, você atualizou a função do api/messages/adminendpoint.

Criando um assinante de evento

Assim que um usuário não autorizado tentar acessar qualquer um dos /api/messages/adminendpoints sem a devida permissão, uma exceção será lançada, indicando que tal acesso é proibido.

Nesta seção, você criará um assinante de evento que ouvirá o evento proibido e retornará uma mensagem apropriada. Para fazer isso, crie uma pasta nomeada EventSubscriberdentro do srcdiretório e, em seguida, crie um novo arquivo nomeado ExceptionSubscriber.phpdentro dela. Abra o arquivo recém-criado e use o seguinte conteúdo para ele:

<?php

namespace App\EventSubscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;

class ExceptionSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents()
    {
        return [
            KernelEvents::EXCEPTION => ['onKernelException']
        ];
    }

    public function onKernelException(ExceptionEvent $event)
    {
        $exception = $event->getThrowable();
        if ($exception instanceof AccessDeniedHttpException) {
            $event->setResponse(new JsonResponse([
                'message' => "Insufficient scopes.",
            ], Response::HTTP_UNAUTHORIZED));
            $event->stopPropagation();
        }
        return $exception;
    }
}

Com todas as alterações necessárias feitas, execute o servidor API emitindo o seguinte comando:

symfony serve

Testando o endpoint de administrador

Conforme mencionado, ao contrário de outros endpoints criados até agora, o GET /api/messages/adminendpoint requer que o token de acesso contenha a read:admin-messagespermissão. Como é um pouco difícil e desaconselhável manipular o token de acesso do aplicativo Machine-to-Machine no Auth0 Dashboard, faremos uma abordagem diferente e usaremos um aplicativo cliente para simular e testar a interação cliente-servidor.

Esta é a melhor forma, por enquanto, de garantir que tenhamos uma interface para os usuários:

• Entrar e Sair
• Recuperar informações do perfil do usuário
• Proteger rotas de aplicativos
• Faça chamadas seguras para uma API

Observação: sinta-se à vontade para usar seu aplicativo cliente, se houver, para esse processo.

Para usar um aplicativo cliente pré-criado, emita o seguinte comando do terminal para clonar o aplicativo do GitHub:

git clone https://github.com/auth0-sample-gallery/spa_angular_typescript_hello-world.git hello-world-demo

Isso irá clonar o aplicativo de demonstração em uma nova pasta nomeada hello-world-demoem seu diretório de desenvolvimento.

Antes de instalar as dependências do projeto, certifique-se de ter o Angular CLI instalado. Você pode verificar emitindo este comando no terminal do seu sistema.

ng --version

A saída será os detalhes da versão atual do Angular CLI que você instalou em seu sistema. Se não estiver instalado, siga as instruções aqui para configurar o Angular CLI globalmente .

Vá para a pasta do novo projeto e emita o seguinte comando para instalar as dependências necessárias:

// Change directory
cd hello-world-demo

// Install dependencies
npm install

O projeto inicial usa uma folha de estilo personalizada para estilizar e fazer o layout do aplicativo, para que você não precise fazer nenhuma alteração.

Conecte o aplicativo cliente ao Auth0

Em seguida, você precisa conectar este aplicativo ao Auth0. De volta ao painel do Auth0, clique em "Aplicativos" > "Aplicativos" > "Criar aplicativo".

Dê a ele um nome como "Angular Symfony App" e selecione "Single Page Web Applications" para o nome do aplicativo. Por fim, clique em "Criar".

O aplicativo de demonstração Angular redirecionará os usuários para a página Auth0 Login sempre que uma solicitação de autenticação for feita. Auth0 redirecionará de volta com as credenciais necessárias.

Para que esse redirecionamento ocorra com segurança, você deve especificar a URL para a qual Auth0 pode redirecionar depois de validar as credenciais de um usuário. De volta ao painel Auth0 , selecione o aplicativo criado para sua API, clique na guia Configurações dessa página e role para baixo para localizar os seguintes campos:

• URLs de retorno de chamada permitidos
• Origens Web permitidas
• URLs de logout permitidos

Use http://localhost:4040como o valor para cada um dos campos porque o aplicativo Cliente estará acessível nesse URL durante o desenvolvimento. Clique em Salvar alterações para prosseguir.

Com as URLs especificadas corretamente, conecte o aplicativo cliente com Auth0 criando um novo arquivo nomeado env.jsonno diretório raiz do aplicativo cliente e preenchendo-o conforme mostrado aqui:

{
  "domain": "YOUR_AUTH0_DOMAIN",
  "clientId": "YOUR_AUTH0_CLIENT_ID",
  "audience": "http://localhost:8000",
  "apiServerUrl": "http://localhost:8000"
}

Certifique-se de preencher "Domínio" e "ID do cliente" com seus valores da página Aplicativo no painel Auth0 . Agora, vá em frente e execute o aplicativo usando o seguinte comando:

ng serve

Navegue até http://localhost:4040 para acessar o aplicativo.

Habilite a comunicação entre o aplicativo cliente e o Symfony API Server

Por padrão, os navegadores possuem medidas de segurança que desabilitam a interação e o compartilhamento de recursos entre aplicativos de domínios diferentes, a menos que seja explicitamente permitido por algum dos aplicativos. Isso significa que o envio de solicitações HTTP do aplicativo cliente para a API do Symfony será desabilitado no momento. Para habilitar a comunicação entre os dois aplicativos, você precisará habilitar CORS (Cross-Origin Resource Sharing) .

Para habilitar a API do Symfony, você precisará usar o Nelmo Bundle . Execute o seguinte comando para instalá-lo:

composer require nelmio/cors-bundle

Após a conclusão do processo de instalação, um arquivo de configuração padrão nomeado nelmio_cors.yamlserá gerado na config/packagespasta conforme mostrado aqui:

nelmio_cors:
  defaults:
    origin_regex: true
    allow_origin: ["%env(CORS_ALLOW_ORIGIN)%"]
    allow_methods: ["GET", "OPTIONS", "POST", "PUT", "PATCH", "DELETE"]
    allow_headers: ["Content-Type", "Authorization"]
    expose_headers: ["Link"]
    max_age: 3600
  paths:
    "^/": null

A configuração padrão especificada aqui seria suficiente, pois declarava todos os verbos HTTP apropriados. Em seguida, navegue até o .env.localarquivo e atualize seu conteúdo conforme mostrado abaixo:

####> nelmio/cors-bundle ###
CORS_ALLOW_ORIGIN='^https?://(localhost|127\.0\.0\.1)(:[0-9]+)?$'
####< nelmio/cors-bundle ###

Aqui, especificamos que a URL localhost deve ser permitida.

Finalmente, inicie o servidor Symfony com:

    symfony serve

No aplicativo cliente , clique no botão API externa e forneça suas credenciais.

Certifique-se de fazer login com os detalhes do usuário com a função Admin conforme especificado no painel Auth0.

Você também pode verificar os outros endpoints clicando no botão PÚBLICO para api/messages/publicendpoint ou no botão PROTECTED para api/messages/protectedendpoints conforme mostrado, respectivamente, abaixo:

Conclusão

Conforme mostrado aqui neste tutorial, você aprendeu como construir facilmente um servidor Symfony API com um endpoint que pode ser acessado por qualquer pessoa na internet sem autenticação e outros endpoints que requerem autorização e função apropriadas.

Você criou esses endpoints sucessivamente começando com o endpoint público e indo além para criar dois endpoints protegidos, ou seja, private e admin. Para definir e configurar completamente a autenticação e autorização para os endpoints protegidos, você aproveitou a API do Auth0 para garantir que apenas solicitações HTTP que contenham o token de acesso válido em seu cabeçalho de autorização possam recuperar dados.

Espero que você tenha achado este tutorial útil. O código-fonte completo para o servidor de API construído neste post pode ser encontrado aqui no GitHub .

Fonte do artigo original em:   https://auth0.com

#symfony 

What is GEEK

Buddha Community

Top 10 API Security Threats Every API Team Should Know

As more and more data is exposed via APIs either as API-first companies or for the explosion of single page apps/JAMStack, API security can no longer be an afterthought. The hard part about APIs is that it provides direct access to large amounts of data while bypassing browser precautions. Instead of worrying about SQL injection and XSS issues, you should be concerned about the bad actor who was able to paginate through all your customer records and their data.

Typical prevention mechanisms like Captchas and browser fingerprinting won’t work since APIs by design need to handle a very large number of API accesses even by a single customer. So where do you start? The first thing is to put yourself in the shoes of a hacker and then instrument your APIs to detect and block common attacks along with unknown unknowns for zero-day exploits. Some of these are on the OWASP Security API list, but not all.

Insecure pagination and resource limits

Most APIs provide access to resources that are lists of entities such as /users or /widgets. A client such as a browser would typically filter and paginate through this list to limit the number items returned to a client like so:

First Call: GET /items?skip=0&take=10 
Second Call: GET /items?skip=10&take=10

However, if that entity has any PII or other information, then a hacker could scrape that endpoint to get a dump of all entities in your database. This could be most dangerous if those entities accidently exposed PII or other sensitive information, but could also be dangerous in providing competitors or others with adoption and usage stats for your business or provide scammers with a way to get large email lists. See how Venmo data was scraped

A naive protection mechanism would be to check the take count and throw an error if greater than 100 or 1000. The problem with this is two-fold:

1. For data APIs, legitimate customers may need to fetch and sync a large number of records such as via cron jobs. Artificially small pagination limits can force your API to be very chatty decreasing overall throughput. Max limits are to ensure memory and scalability requirements are met (and prevent certain DDoS attacks), not to guarantee security.
2. This offers zero protection to a hacker that writes a simple script that sleeps a random delay between repeated accesses.

skip = 0
while True:    response = requests.post('https://api.acmeinc.com/widgets?take=10&skip=' + skip),                      headers={'Authorization': 'Bearer' + ' ' + sys.argv[1]})    print("Fetched 10 items")    sleep(randint(100,1000))    skip += 10

How to secure against pagination attacks

To secure against pagination attacks, you should track how many items of a single resource are accessed within a certain time period for each user or API key rather than just at the request level. By tracking API resource access at the user level, you can block a user or API key once they hit a threshold such as “touched 1,000,000 items in a one hour period”. This is dependent on your API use case and can even be dependent on their subscription with you. Like a Captcha, this can slow down the speed that a hacker can exploit your API, like a Captcha if they have to create a new user account manually to create a new API key.

Insecure API key generation

Most APIs are protected by some sort of API key or JWT (JSON Web Token). This provides a natural way to track and protect your API as API security tools can detect abnormal API behavior and block access to an API key automatically. However, hackers will want to outsmart these mechanisms by generating and using a large pool of API keys from a large number of users just like a web hacker would use a large pool of IP addresses to circumvent DDoS protection.

How to secure against API key pools

The easiest way to secure against these types of attacks is by requiring a human to sign up for your service and generate API keys. Bot traffic can be prevented with things like Captcha and 2-Factor Authentication. Unless there is a legitimate business case, new users who sign up for your service should not have the ability to generate API keys programmatically. Instead, only trusted customers should have the ability to generate API keys programmatically. Go one step further and ensure any anomaly detection for abnormal behavior is done at the user and account level, not just for each API key.

Accidental key exposure

APIs are used in a way that increases the probability credentials are leaked:

1. APIs are expected to be accessed over indefinite time periods, which increases the probability that a hacker obtains a valid API key that’s not expired. You save that API key in a server environment variable and forget about it. This is a drastic contrast to a user logging into an interactive website where the session expires after a short duration.
2. The consumer of an API has direct access to the credentials such as when debugging via Postman or CURL. It only takes a single developer to accidently copy/pastes the CURL command containing the API key into a public forum like in GitHub Issues or Stack Overflow.
3. API keys are usually bearer tokens without requiring any other identifying information. APIs cannot leverage things like one-time use tokens or 2-factor authentication.

If a key is exposed due to user error, one may think you as the API provider has any blame. However, security is all about reducing surface area and risk. Treat your customer data as if it’s your own and help them by adding guards that prevent accidental key exposure.

How to prevent accidental key exposure

The easiest way to prevent key exposure is by leveraging two tokens rather than one. A refresh token is stored as an environment variable and can only be used to generate short lived access tokens. Unlike the refresh token, these short lived tokens can access the resources, but are time limited such as in hours or days.

The customer will store the refresh token with other API keys. Then your SDK will generate access tokens on SDK init or when the last access token expires. If a CURL command gets pasted into a GitHub issue, then a hacker would need to use it within hours reducing the attack vector (unless it was the actual refresh token which is low probability)

Exposure to DDoS attacks

APIs open up entirely new business models where customers can access your API platform programmatically. However, this can make DDoS protection tricky. Most DDoS protection is designed to absorb and reject a large number of requests from bad actors during DDoS attacks but still need to let the good ones through. This requires fingerprinting the HTTP requests to check against what looks like bot traffic. This is much harder for API products as all traffic looks like bot traffic and is not coming from a browser where things like cookies are present.

Stopping DDoS attacks

The magical part about APIs is almost every access requires an API Key. If a request doesn’t have an API key, you can automatically reject it which is lightweight on your servers (Ensure authentication is short circuited very early before later middleware like request JSON parsing). So then how do you handle authenticated requests? The easiest is to leverage rate limit counters for each API key such as to handle X requests per minute and reject those above the threshold with a 429 HTTP response. There are a variety of algorithms to do this such as leaky bucket and fixed window counters.

Incorrect server security

APIs are no different than web servers when it comes to good server hygiene. Data can be leaked due to misconfigured SSL certificate or allowing non-HTTPS traffic. For modern applications, there is very little reason to accept non-HTTPS requests, but a customer could mistakenly issue a non HTTP request from their application or CURL exposing the API key. APIs do not have the protection of a browser so things like HSTS or redirect to HTTPS offer no protection.

How to ensure proper SSL

Test your SSL implementation over at Qualys SSL Test or similar tool. You should also block all non-HTTP requests which can be done within your load balancer. You should also remove any HTTP headers scrub any error messages that leak implementation details. If your API is used only by your own apps or can only be accessed server-side, then review Authoritative guide to Cross-Origin Resource Sharing for REST APIs

Incorrect caching headers

APIs provide access to dynamic data that’s scoped to each API key. Any caching implementation should have the ability to scope to an API key to prevent cross-pollution. Even if you don’t cache anything in your infrastructure, you could expose your customers to security holes. If a customer with a proxy server was using multiple API keys such as one for development and one for production, then they could see cross-pollinated data.

#api management #api security #api best practices #api providers #security analytics #api management policies #api access tokens #api access #api security risks #api access keys

Public ASX100 APIs: The Essential List

We’ve conducted some initial research into the public APIs of the ASX100 because we regularly have conversations about what others are doing with their APIs and what best practices look like. Being able to point to good local examples and explain what is happening in Australia is a key part of this conversation.

Method

The method used for this initial research was to obtain a list of the ASX100 (as of 18 September 2020). Then work through each company looking at the following:

1. Whether the company had a public API: this was found by googling “[company name] API” and “[company name] API developer” and “[company name] developer portal”. Sometimes the company’s website was navigated or searched.
2. Some data points about the API were noted, such as the URL of the portal/documentation and the method they used to publish the API (portal, documentation, web page).
3. Observations were recorded that piqued the interest of the researchers (you will find these below).
4. Other notes were made to support future research.
5. You will find a summary of the data in the infographic below.

Data

With regards to how the APIs are shared:

• Documentation is where just the Swagger/OpenAPI docs are hosted somewhere. e.g. https://api.linkgroup.com/member/docs/index
• Portal is where an interactive portal has been developed. e.g. https://dev.telstra.com/
• The web page is where the company has a single page that isn’t interactive explaining their Public APIs. e.g. https://www.bendigoadelaide.com.au/banking-products-api.asp

#api #api-development #api-analytics #apis #api-integration #api-testing #api-security #api-gateway

An API-First Approach For Designing Restful APIs | Hacker Noon

I’ve been working with Restful APIs for some time now and one thing that I love to do is to talk about APIs.

So, today I will show you how to build an API using the API-First approach and Design First with OpenAPI Specification.

First thing first, if you don’t know what’s an API-First approach means, it would be nice you stop reading this and check the blog post that I wrote to the Farfetchs blog where I explain everything that you need to know to start an API using API-First.

Preparing the ground

Before you get your hands dirty, let’s prepare the ground and understand the use case that will be developed.

Tools

If you desire to reproduce the examples that will be shown here, you will need some of those items below.

• NodeJS
• OpenAPI Specification
• Text Editor (I’ll use VSCode)
• Command Line

Use Case

To keep easy to understand, let’s use the Todo List App, it is a very common concept beyond the software development community.

#api #rest-api #openai #api-first-development #api-design #apis #restful-apis #restful-api

What Are Good Traits That Make Great API Product Managers

As more companies realize the benefits of an API-first mindset and treating their APIs as products, there is a growing need for good API product management practices to make a company’s API strategy a reality. However, API product management is a relatively new field with little established knowledge on what is API product management and what a PM should be doing to ensure their API platform is successful.

Many of the current practices of API product management have carried over from other products and platforms like web and mobile, but API products have their own unique set of challenges due to the way they are marketed and used by customers. While it would be rare for a consumer mobile app to have detailed developer docs and a developer relations team, you’ll find these items common among API product-focused companies. A second unique challenge is that APIs are very developer-centric and many times API PMs are engineers themselves. Yet, this can cause an API or developer program to lose empathy for what their customers actually want if good processes are not in place. Just because you’re an engineer, don’t assume your customers will want the same features and use cases that you want.

This guide lays out what is API product management and some of the things you should be doing to be a good product manager.

#api #analytics #apis #product management #api best practices #api platform #api adoption #product managers #api product #api metrics

54% of Developers Cite Lack of Documentation as the Top Obstacle to Consuming APIs

Recently, I worked with my team at Postman to field the 2020 State of the API survey and report. We’re insanely grateful to the folks who participated—more than 13,500 developers and other professionals took the survey, helping make this the largest and most comprehensive survey in the industry. (Seriously folks, thank you!) Curious what we learned? Here are a few insights in areas that you might find interesting:

API Reliability

Whether internal, external, or partner, APIs are perceived as reliable—more than half of respondents stated that APIs do not break, stop working, or materially change specification often enough to matter. Respondents choosing the “not often enough to matter” option here came in at 55.8% for internal APIs, 60.4% for external APIs, and 61.2% for partner APIs.

Obstacles to Producing APIs

When asked about the biggest obstacles to producing APIs, lack of time is by far the leading obstacle, with 52.3% of respondents listing it. Lack of knowledge (36.4%) and people (35.1%) were the next highest.

#api #rest-api #apis #api-first-development #api-report #api-documentation #api-reliability #hackernoon-top-story