Como configurar o mTLS na Digibee Integration Platform

Learn how to install mTLS on your realm.

O Mutual Transport Layer Security (mTLS) é um protocolo de autenticação bilateral que verifica usuários, dispositivos e servidores dentro de uma organização, validando que ambas as partes (servidor e cliente) possuem as chaves privadas corretas. A Digibee Integration Platform permite consumir e publicar APIs com o protocolo mTLS para identificar clientes e servidores por meio de certificados TLS.

Para que a Digibee possa proceder com a instalação, é necessário registrar um certificado utilizando um Root Certificate salvo em uma conta do tipo Certificate Chain no seu realm.. Os certificados devem ser emitidos, fornecidos e gerenciados pelo cliente e devem estar disponíveis para que a comunicação com o servidor Digibee, onde o Root Certificate foi configurado, ocorra com sucesso.

Configurando o mTLS

Para configurar o mTLS na Digibee Integration Platform, siga os passos abaixo:

Nesta configuração, a cadeia completa de certificados e a chave não são necessárias. O campo de senha deve ser deixado vazio ao salvar o certificado.

1. Salve o Root Certificate no formato .pem no campo Chain. O certificado em formato .pem segue o formato abaixo:

-----BEGIN CERTIFICATE-----
MIIF4zCCA8ugAwIBAgIUI/vA3JlEcMMpXnufpuVSLhQZcwUwDQYJKoZIhvcNAQEL
BQAwgYAxCzAJBgNVBAYTAkJSMQswCQYDVQQIDAJTQzELMAkGA1UEBwwCRkwxCzA
JBgNVBAoMAkRHMQ4wDAYDVQQLDAVERy1GTDEPMA0GA1UEAwwGZGduYW1lMSkw
-----END CERTIFICATE-----

Pay attention to the environment, as there may be different certificates for test and prod. Currently, Digibee only supports one certificate per environment.

1. O nome da conta é crucial para a instalação bem-sucedida do certificado no Load Balancer dedicado ao seu realm. Ele deve seguir o formato dgb-mtls-REFERENCE_NAME. No exemplo abaixo, a conta foi nomeada como dgb-mtls-autocorp.

1. Após criar a conta do tipo Certificate Chain com o certificado salvo no formato .pem, entre em contato com a Digibee pelo chat. Você deve informar o nome da conta para que o certificado possa ser instalado no Load Balancer do seu realm.

Usando mTLS em outros pipelines

1. Ative o parâmetro mTLS enabled API no trigger do pipeline.

2. Desmarque a opção API Key no trigger ao usar o mTLS enabled API.

Endpoints

Os endpoints desempenham um papel crucial na implementação do mTLS, pois são o ponto de interação entre o cliente e o servidor onde o protocolo mTLS é configurado e aplicado.

A Digibee cria novos endpoints, diferentes dos endpoints regulares. Durante a configuração, você receberá as informações sobre os endpoints recém-criados. Os endpoints mTLS são exclusivos para acesso via internet e não são acessíveis por VPN.

Os endpoints gerados pela Plataforma sempre seguem esta estrutura:

• Ambiente de produção

https://api.godigibee.io/pipeline/{{NOME_DO_REALM}}/v1/{{NOME_DO_PIPELINE}}

• Ambiente de teste

https://test.godigibee.io/pipeline/{{NOME_DO_REALM}}/v1/{{NOME_DO_PIPELINE}}

O endpoint gerado após a instalação do mTLS seguirá o mesmo formato, mas com o número 2 adicionado à URL:

• Ambiente de produção

https://api2.godigibee.io/pipeline/{{NOME_DO_REALM}}/v1/{{NOME_DO_PIPELINE}}

• Ambiente de teste

https://test2.godigibee.io/pipeline/{{NOME_DO_REALM}}/v1/{{NOME_DO_PIPELINE}}