Tunnel

O Tunnel é responsável por estabelecer uma conexão segura entre servidores locais (on-premises) e a plataforma APIPASS. Ele atua como um canal criptografado que garante comunicação confiável e protegida contra acessos não autorizados.

As Rotas (Routes) são responsáveis por definir quais recursos internos estarão acessíveis através do Tunnel. Elas funcionam como regras de encaminhamento, permitindo granularidade no controle de tráfego e garantindo que apenas os serviços desejados sejam expostos.

Conceitos:

Tunnel

  • Canal seguro entre a infraestrutura local e a APIPASS.

  • Cada Tunnel pode ser configurado de forma independente.

  • Suporte a múltiplos ambientes e servidores.

  • Associado a um token fixo de integração que pode ser atualizado sempre que necessário.

Rotas

  • Definem o tráfego que será direcionado através de um Tunnel.

  • Permitem expor apenas determinados recursos internos.

  • Configuradas por parâmetros como nome, protocolo, URL e caminho.

Acessar e configurar Tunnel:

Para acessar a área de gerenciamento de Tunnel e Rotas:

  1. Clique no menu do usuário, no canto superior direito da tela.

  2. Selecione Gerenciamento de Conta.

  3. No menu lateral esquerdo, acesse a seção Tunnel.

Na aba lateral a esquerda será apresentado o menu Tunnel, onde é possível gerenciar o recurso.

Criar um Tunnel:

  1. Clique no botão Criar Tunnel.

  2. Informe um nome para o Tunnel.

  3. O novo Tunnel será exibido na listagem com as seguintes informações:

    • Nome do Tunnel

    • Identificador

    • Status de conexão

    • Quantidade de Rotas vinculadas.

    • Ações disponíveis: Configuração, Edição e Exclusão.

  4. O status do Tunnel será definido após instalação do Tunnel no servidor e controlado pela Infra APIPASS. INATIVO - Não houve instalação ou ocorreu uma queda de conexão (Servidor desligado por exemplo) ATIVO - Tunnel operando normalmente. INSTÁVEL - Alguma tipo de instabilidade ocorrendo (Resposta lenta ou instabilidade dos serviços)

O botão de configuração do Tunnel é a segunda etapa de instalação da integração, será aberto assim que o Tunnel for criado ou poderá ser acessado pelo botão de engrenagem. No menu será apresentado algumas formas de realizar a instalação do Tunnel no servidor que será integrado à APIPASS.

A modal de configuração contém os recursos de escolha de ambiente onde deve ser selecionado o Sistema Operacional do servidor que será instalado. Com base no Sistema Operacional selecionado será apresentado abaixo um passo a passo de instalação do recurso.

Ao final da linha temos um recurso de atualização de token, cada Tunnel possui um token para integração fixo e caso necessário o usuário pode atualiza-lo quando necessário. Esta ação invalidará o token anterior. Observe que isso impedirá novas conexões feitas com o token antigo, mas não encerrará as conexões existentes.

Deletar um Tunnel:

  1. Ao deletar um Tunnel será aberta uma modal com instruções de exclusão do serviço no servidor.

Obs: Caso o comando sudo não esteja disponível no SO, executar o comando sem o prefix sudo.

Editar Tunnel:

Ao clicar no botão de editar do Tunnel, será aberta uma modal de alteração de nome, isso não irá impactar a instalação do Tunnel caso o mesmo já esteja em execução, será apenas para fins de identificação.

Acessar e configurar Rotas:

Ao clicar no Tunnel na listagem, será aberta uma sublista para configuração de Rotas para o Tunnel.

Cada Rota define qual tráfego de rede será encaminhado através de um Tunnel estabelecido. Ele funciona como uma regra de roteamento dentro da APIPASS, permitindo expor apenas determinados recursos ou segmentos da rede interna.

Cada Rota é configurado com:

  • Protocolo: Protocolo de comunicação da rede.

  • Nome: Identificador da Rota.

  • IP ou Domínio: Define o endereço de comunicação da rota com a infra.

  • Porta: Define a porta de conexão com o IP/Domínio informado.

Edição e Exclusão de Rotas:

Cada Rota vem acompanhada de dois botões de ação, editar e excluir. No processo de edição é possível alterar os mesmos recursos de criação e essa operação não irá impactar na instalação do tunnel, apenas irá alterar a conexão de rota para os novos dados.

Já na exclusão a rota é removida sem necessidade de nenhum tipo de procedimento adicional, realizando esse processo o Tunnel deixar de conter a Rota removida e encerrará o DNS de conexão da mesma.

Funcionamento:

Para utilizar o Tunnel, faz se necessário inserir o Tunnel e a Rota desejada na autorização que irá estabelecer essa conexão. No exemplo abaixo uma autorização de Banco de Dados utilizando Tunnel e especificando qual a rota de conexão que foi configurada previamente para conexão com o Banco de Dados.

Obs: O Host e Porta da autorização serão controlados pela Rota e não serão apresentadas na criação da mesma.

Funcionamento:

A APIPASS recebe a configuração pela autorização no conector e passa a direcionar qualquer requisição para o Tunnel e Rota associados para execução do conector.

Essa arquitetura garante que a comunicação com a APIPASS seja segura, controlada e escalável, oferecendo flexibilidade na exposição de serviços internos com base em regras de roteamento configuráveis.

Last updated