Skip to content

Commit

Permalink
docs(security): add docs about ip whitelist and user mfa
Browse files Browse the repository at this point in the history
  • Loading branch information
noghartt committed Feb 1, 2024
1 parent 671d98d commit 0253071
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apis/__assets__/api-detail-route.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions docs/apis/api-security-ip-whitelist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Adicionando filtro de IP à sua API
tags:
- api
- security
---

Como forma de garantir uma melhor segurança no uso da sua API, você pode adicionar uma lista de permissões de IP à sua API.
Assim, apenas os IPs que estão na lista de permissões poderão acessar sua API.

Vamos ver como você pode adicionar uma lista de permissões de IP à sua API.

## Adicionando uma lista de permissões de IP à sua API

Primeiramente, como um requisito, você precisa ter uma API criada.
Se você ainda não criou uma API, pode seguir os passos no guia [Criando uma API](./api-getting-started.md).

Após criar a API, você pode acessar os detalhes dela clicando no nome da API na [lista de APIs](https://app.openpix.com.br/home/applications/tab/list).

![Detalhe da API](./__assets__/api-detail-route.png)

Nos detalhes da API, você pode clicar na seção de "IPs permitidos" para adicionar um novo IP.

Após clicar no modal, irá aparecer um campo onde poderá inserir o IP que deseja adicionar à lista de permissões.

![Detalhe da API mostrando o modal de adição de IPs](./__assets__/api-detail-allowed-ip-modal.png)

Após a adição, será necessário efetuar a confirmação utilizando um código multi-fator,
é o meio de assegurar que somente você poderá adicionar IPs à lista de permissões.

Após a confirmação, o IP será adicionado à lista de permissões e poderá acessar a API.

Lembrando que, caso não tenha adicionado nenhum IP a lista de permissões, a API poderá estar
sendo utilizada por quaisquer IPs.

## Como posso pegar o IP da minha máquina?

Existe algumas ferramentas que facilitam a obtenção do IP da sua máquina, como por exemplo:

- [Meu IP](https://meuip.com/).
- [ifconfig.me](https://ifconfig.me/)

Com essas ferramentas, é possível saber qual IP você deve inserir na lista de permissões da sua API.
57 changes: 57 additions & 0 deletions docs/security/security-user-mfa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Adicionando autenticação multi-fator via App à sua conta
tags:
- security
- user
---

A autenticação multi-fator (MFA) é uma camada adicional de segurança que requer
mais de uma forma de autenticação para verificar a identidade do usuário. Isso pode ser
feito através de um aplicativo de autenticação, como o Google Authenticator, Microsoft Authenticator,
Authy, entre outros.

## Ativando a autenticação multi-fator

Para ativar a autenticação multi-fator, siga os passos abaixo:

1. Acesse a [página de configurações](https://app.openpix.com.br/home/me/account/edit) da sua conta.
2. Na seção "Informação da Plataforma", clique em "Autenticação multifator"
3. Clique no botão "Ativar autenticação de dois fatores"
4. Escaneie o QR Code com o aplicativo de autenticação, caso não conseguir, você pode inserir o código manualmente.
5. Após escanear o QR Code, insira o código gerado pelo aplicativo de autenticação no campo abaixo de "Digite o código de verificação".
6. Clique no botão "Salvar"
7. Você configurou a autenticação multi-fator com sucesso!

Com isso, todas as ações que exigem uma autenticação na sua conta, alteração de senha,
saques, pagamentos externos, entre outros, irão exigir a autenticação multi-fator para serem realizadas.

## Trocando o dispositivo de autenticação multi-fator

Caso você tenha trocado de dispositivo ou perdido o acesso ao aplicativo de autenticação,
você deverá entrar em contato com o nosso time de suporte que irá realizar todo o processo
para auxiliar na troca do dispositivo.

## Desativando a autenticação multi-fator

Caso você queira desativar a autenticação multi-fator, siga os passos abaixo:

1. Acesse a [página de configurações](https://app.openpix.com.br/home/me/account/edit) da sua conta.
2. Na seção "Informação da Plataforma", clique em "Autenticação multifator"
3. Clique no botão "Desativar"
4. Você precisará confirmar a desativação da autenticação multi-fator inserindo o código gerado pelo aplicativo de autenticação no campo abaixo de "Digite o código de verificação".
5. Após confirmar, a autenticação multi-fator será desativada com sucesso.

Lembre-se que a autenticação multi-fator é uma camada adicional de segurança para a sua conta,
desativá-la pode deixar a sua conta mais vulnerável a ataques. Caso você tenha desativado a
autenticação multi-fator, recomendamos que você ative novamente o mais rápido possível.

## Como selecionar o método de autenticação preferido?

Caso você tenha mais de um método de autenticação configurado, você pode selecionar o método
preferido para autenticação multi-fator. Para isso, siga os passos abaixo:

1. Acesse a [página de configurações](https://app.openpix.com.br/home/me/account/edit) da sua conta.
2. Na seção "Informação da Plataforma", clique em "Método de autenticação multi-fator preferido"
3. Selecione o método de autenticação que você deseja utilizar como preferido.
4. Clique no botão "Salvar"
5. Você configurou o método de autenticação multi-fator preferido com sucesso!

0 comments on commit 0253071

Please sign in to comment.