Procurando a documentação anterior?Acesse v1.docs.pluggy.ai
PluggyDocs

Visão geral de segurança

As práticas de segurança que toda integração Pluggy deve seguir: onde suas credenciais estão, o que o front end pode conter, como confiar em um webhook, quem na sua equipe pode mudar o que e como lidar com os dados dos seus usuários.

Ver como Markdown

Suas credenciais Pluggy acessam os dados financeiros de seus usuários. A Pluggy executa as conexões com as instituições, mantém as credenciais e dados de cada Item e entrega seus webhooks, assinados uma vez que você ativa a assinatura. Seu lado da integração é sua responsabilidade de proteger: suas credenciais, os tokens que você entrega ao front end, seu endpoint de webhook, sua equipe e os dados que você copia para seus próprios sistemas.

Cada seção abaixo é um resumo com um link para a página que contém os detalhes. A lista de verificação no final resume tudo.

As credenciais ficam no seu servidor#

O segredo do cliente da sua aplicação e as chaves da API que seu servidor cria com ele têm acesso total à Referência da API da Pluggy. Mantenha-os em um gerenciador de segredos ou em uma variável de ambiente do servidor, reutilize cada chave da API até que expire e use aplicações separadas para desenvolvimento e produção. Gerar um novo segredo de cliente interrompe imediatamente o antigo, mas não revoga as chaves da API criadas antes disso.

Detalhes: Credenciais e chaves da API. Receita: Gire seu segredo de cliente.

O front end recebe um Connect Token, nunca uma chave da API#

Seu backend cria um Connect Token para um usuário autenticado, e o front end abre o Pluggy Connect com ele. Ele dura 30 minutos, alcança apenas os Itens criados com ele e não pode ler dados do produto. Defina clientUserId como um identificador opaco e deixe includeSandbox desativado em produção.

Detalhes: Connect Tokens. Receita: Emita Connect Tokens do seu backend.

Verifique cada notificação de webhook#

Seu endpoint de webhook é público, então trate cada solicitação como não confiável até que passe por suas verificações. Combine as camadas: um endpoint HTTPS, um segredo nos headers do webhook e a assinatura HMAC X-Pluggy-Signature, que prova que a Pluggy enviou a notificação e que seu corpo não foi alterado. Em seguida, verifique clientId e leia o estado atual com sua chave da API em vez de confiar na carga útil. O filtro de IP de origem é uma camada extra, nunca a única.

Detalhes: Segurança do webhook. Receita: Autentique notificações de webhook com um segredo no cabeçalho.

Apenas as pessoas certas gerenciam suas aplicações#

Uma equipe tem três papéis. Proprietários e Administradores geram segredos de cliente e gerenciam webhooks; apenas Proprietários desativam ou excluem aplicações e gerenciam o segredo de assinatura do webhook. Mantenha OWNER e ADMIN para as pessoas que precisam deles e gire os segredos quando alguém que poderia vê-los sair.

Detalhes: Acesso da equipe.

Os dados e o consentimento dos seus usuários#

Deixe o Pluggy Connect coletar credenciais bancárias, para que nunca passem pelos seus servidores. Deixe os usuários desconectarem e exclua o Item quando o fizerem: isso apaga suas credenciais, revoga o consentimento e exclui seus dados. Remova sua própria cópia em item/deleted e armazene apenas o que seu produto usa.

Detalhes: Proteção de dados.

Relatar uma vulnerabilidade#

Se você encontrar uma vulnerabilidade de segurança na Pluggy, escreva para security@pluggy.ai. O mesmo contato está publicado em nosso security.txt.

Lista de verificação#

ÁreaVerificação
CredenciaisO segredo do cliente vive apenas em um gerenciador de segredos ou variável de ambiente do servidor.
CredenciaisNenhum segredo de cliente ou chave da API está no código do front end, aplicativos móveis, repositórios ou logs.
CredenciaisSeu servidor reutiliza cada chave da API até que expire.
CredenciaisDesenvolvimento e produção usam aplicações separadas.
CredenciaisVocê sabe como gerar um novo segredo de cliente, onde implantá-lo e como desativar a aplicação se uma chave da API vazar.
Front endO front end recebe apenas Connect Tokens, criados pelo seu backend para um usuário autenticado.
Front endclientUserId é um identificador opaco, não dados pessoais.
Front endincludeSandbox está desativado em produção.
WebhooksSeu endpoint verifica X-Pluggy-Signature sobre o corpo bruto, com uma tolerância de 5 minutos.
WebhooksWebhooks criados com POST /webhooks carregam um cabeçalho secreto que seu endpoint requer.
WebhooksSeu endpoint ignora notificações para outros clientIds, responde 2xx rapidamente e lê os dados com sua chave da API.
AcessoApenas as pessoas que precisam são OWNER ou ADMIN da sua equipe.
AcessoMembros que saem são removidos, e os segredos que poderiam ver são girados.
DadosUsuários podem desconectar, e desconectar exclui o Item.
DadosVocê remove sua cópia dos dados em item/deleted.
Esta página foi útil?