Como habilitar TSL/SSL no AppServer REST do Protheus®
- Sara Beatriz Nascimento das Neves
- há 7 horas
- 4 min de leitura
Ao integrar aplicações com o Protheus® por meio de APIs REST, é fundamental garantir que toda a comunicação ocorra de forma segura. Uma das principais formas de proteger essas informações é utilizando HTTPS, que criptografa os dados trafegados entre o cliente e o servidor.
No Aprovador, é necessário que seja realizada a autenticação dos usuários com o Protheus. Como o processo de autenticação envolve o envio das credenciais e a obtenção de um token de acesso, recomendamos fortemente que o AppServer responsável pelos serviços REST esteja configurado com SSL/TLS.
Além de aumentar a segurança da comunicação, essa configuração está alinhada com as boas práticas recomendadas pela própria TOTVS® para ambientes que disponibilizam serviços Web e APIs REST.
Objetivo
Neste post será demonstrado como configurar um certificado TSL/SSL no AppServer REST do Protheus®, permitindo que os serviços sejam acessados por meio de HTTPS e garantindo uma comunicação criptografada entre cliente e servidor.
O que é SSL/TLS?
SSL (Secure Sockets Layer) e seu sucessor, TLS (Transport Layer Security), são protocolos responsáveis por proteger a comunicação entre aplicações através de criptografia.
Na prática, ao habilitar HTTPS em seu AppServer, você garante:
Criptografia dos dados transmitidos;
Proteção das credenciais dos usuários;
Maior segurança na comunicação entre aplicações;
Validação da identidade do servidor através de um certificado digital.
Quando essa configuração é necessária?
A utilização de TSL/SSL é altamente recomendada sempre que o AppServer REST estiver acessível pela rede, principalmente quando:
Aplicações externas realizam autenticação no Protheus;
APIs REST são consumidas por sistemas terceiros;
O ambiente está publicado para acesso externo;
Informações sensíveis trafegam pela rede.
Em nosso caso, mesmo com a comunicação ocorrendo de forma local, essa configuração é necessária para que a autenticação dos usuários ocorra através de uma conexão segura durante a obtenção do token de acesso.
Pré-requisitos
Antes de iniciar a configuração, certifique-se de possuir:
Um certificado digital válido (ou um certificado autoassinado para ambientes de testes);
A chave privada correspondente ao certificado;
Acesso ao servidor onde está instalado o AppServer REST;
Uma porta TCP disponível para publicação do serviço HTTPS;
Permissão para editar o arquivo appserver.ini;
Acesso para reiniciar o serviço do AppServer.
Importante: Em ambientes de produção, recomenda-se utilizar certificados emitidos por uma Autoridade Certificadora (CA) confiável. Certificados autoassinados são indicados apenas para ambientes internos ou de homologação.
Passo a passo
1. Obtenha o certificado digital
Antes de configurar o HTTPS no AppServer, é necessário possuir um certificado digital válido que será utilizado para estabelecer uma conexão segura entre o servidor Protheus e as aplicações que irão consumir seus serviços REST.
Esse certificado será responsável por:
Criptografar toda a comunicação utilizando SSL/TLS;
Garantir a autenticidade do servidor;
Quais tipos de certificado podem ser utilizados?
Existem três cenários comuns para utilização de certificados no Protheus.
Certificado emitido por uma Autoridade Certificadora (Recomendado)
É a opção indicada para ambientes de produção. Nesse cenário, o certificado é emitido por uma Autoridade Certificadora (CA) reconhecida.
Como esses certificados já são confiáveis para navegadores e sistemas operacionais, os clientes que acessarem sua aplicação não receb erão alertas de segurança.
Quando utilizar
Ambiente de produção;
APIs REST expostas para outras aplicações;
Integrações externas;
Sistemas acessados pela Internet.
Este é o cenário recomendado pela TOTVS® para aplicações REST publicadas em HTTPS.
Certificado autoassinado (Self-Signed)
O certificado autoassinado é criado pela própria empresa, sem o intermédio de uma Autoridade Certificadora.
Ele fornece criptografia normalmente, porém não é considerado confiável pelos navegadores e aplicações até que seja instalado manualmente como certificado confiável.
Quando utilizar
Ambiente de desenvolvimento;
Ambiente de homologação;
Testes internos;
Laboratórios.
Como não existe validação por uma autoridade certificadora, é comum que navegadores exibam mensagens informando que a conexão não é confiável.
Certificado padrão da TOTVS®
O Application Server também disponibiliza certificados próprios distribuídos juntamente com a instalação do produto.
Esses certificados foram criados para facilitar alguns cenários de comunicação segura entre componentes da plataforma TOTVS®, como SmartClient e WebAgent.
Importante: Embora esses certificados sejam úteis para alguns recursos internos da plataforma, eles não são recomendados para publicação de serviços REST em produção.
A própria TOTVS® informa que esse certificado foi criado para comunicação segura da porta multiprotocolo e não deve ser utilizado para APIs REST expostas externamente. Para esses casos, recomenda-se utilizar um certificado emitido por uma Autoridade Certificadora confiável.
2. Copie os arquivos do certificado para o servidor
Copie e cole os arquivos do certificado na pasta do Appserver.
Por exemplo:
Dependendo da Autoridade Certificadora utilizada, o certificado poderá ser disponibilizado em formatos como .crt, .cer, .pem ou .pfx. O AppServer utiliza o certificado e sua respectiva chave privada, portanto pode ser necessário converter o arquivo recebido para o formato esperado pela configuração.
3. Edite o arquivo appserver.ini
Localize a seção [Drivers] e habilite a porta multiprotocolo segura.
Depois, na seção de configuração SSL [SSLConfigure], adicione o certificado e sua chave.
Por fim, na seção HTTPREST, adicione as configurações referentes ao REST.
Por exemplo:
Dessa forma, tanto o REST quanto o WEBAPP estarão protegidos.
4. Reinicie o AppServer
Após salvar o arquivo, reinicie o serviço para que as alterações sejam aplicadas.
5. Valide o acesso via HTTPS
Acesse a URL do serviço utilizando HTTPS e confirme que o certificado foi carregado corretamente.
Exemplo:
Como verificar se o TSL/SSL está funcionando?
Alguns indicativos de que a configuração foi realizada corretamente:
O navegador apresenta o cadeado de conexão segura;
A URL utiliza HTTPS;
Não são exibidos erros relacionados ao certificado;
As chamadas REST passam a responder através de conexão criptografada.
Ao clicar sobre o certificado, é possível visualizar suas informações:
A configuração de TSL/SSL no AppServer REST é uma etapa importante para aumentar a segurança do ambiente Protheus® e proteger a comunicação entre aplicações.
Além de atender às boas práticas de segurança, essa configuração reduz a exposição de credenciais durante a autenticação dos usuários e garante que as integrações utilizem um canal criptografado para troca de informações.
Sempre que possível, utilize certificados emitidos por uma Autoridade Certificadora reconhecida e mantenha-os dentro do período de validade, evitando interrupções nas integrações.
Referências:
Comentários