Manual oAuth

O que é?

O oAuth é um protocolo de autorização que permite que aplicativos ou serviços acessem recursos protegidos em nome de um usuário, sem que o usuário precise compartilhar suas credenciais (como nome de usuário e senha) diretamente com o aplicativo. Em vez disso, o usuário concede permissão ao aplicativo para acessar os recursos em seu nome, e o aplicativo recebe um token de acesso, que pode ser usado para fazer solicitações à API do serviço que hospeda esses recursos.

Esse protocolo minimiza os riscos de segurança ao garantir que as credenciais do usuário (como senhas) nunca sejam expostas diretamente à aplicação que solicita acesso. Além disso, os tokens de acesso são temporários e específicos para certos recursos e escopos, o que limita o potencial de abuso.

O OAuth suporta vários cenários de autorização, desde aplicações web até aplicativos móveis e serviços de backend. Ele é flexível o suficiente para ser implementado em uma variedade de ambientes, permitindo que os desenvolvedores ajustem os níveis de permissão de acordo com as necessidades da aplicação e do usuário.

Se quiser saber mais sobre o protocolo OAuth, acesse o link: Protocolo de autorização oAuth 2.0 .

Configuração do oAuth

A seguir, será abordado um passo a passo detalhado para configurar o protocolo OAuth em cada uma das ferramentas onde ele foi implementado. De modo geral, o processo de configuração é básico e semelhante em todas as ferramentas. No entanto, algumas delas exigem etapas adicionais específicas, que também serão abordadas. 

As ferramentas abordadas neste manual foram desenvolvidas em diferentes linguagens de programação, incluindo Java, VB6 e C#. A seguir, uma lista indicando a linguagem utilizada para cada ferramenta:

• VB6: Ecop, Conf
• Java: Esocial, Reinf
• C#: Nfe, Cte

oAuth Reinf/Esocial 

O eSocial e REINF são módulos do SPED que, juntos, unificam a comunicação de informações fiscais, previdenciárias e trabalhistas ao governo brasileiro. O eSocial centraliza dados sobre vínculos empregatícios e folha de pagamento, enquanto o REINF lida com retenções de tributos e contribuições não relacionadas à folha. Eles trabalham juntos para simplificar e integrar o cumprimento das obrigações legais das empresas.

O Reinf/Esocial possuem duas formas de evios de e-mail, sendo elas, a maneira convencional (já existente) e através do protocolo oAuth. O oAuth é especificamente usado para e-mails google, e e-mails que não sejam da google podem usar a forma convencional já conhecida. 

No método convencional, há campos essenciais que devem ser compreendidos: 

SMTP: é um protocolo de comunicação usado para enviar e-mails na Internet, transmitindo mensagens de um cliente de e-mail para um servidor e entre servidores, garantindo que o e-mail chegue ao destinatário correto.

Porta: As portas do SMTP são pontos de conexão que definem como e onde o protocolo SMTP se comunica através da rede para enviar e-mails. 

• Porta 25: Usada para comunicação padrão entre servidores de e-mail. Pode estar bloqueada por provedores para evitar spam.
• Porta 465: Usada para SMTP seguro (SMTPS) com criptografia SSL, embora não seja oficialmente registrada.
• Porta 587: Recomendado para envio de e-mails com autenticação e criptografia TLS. Ideal para clientes de e-mail.
• Porta 2525: Alternativa para SMTP autenticado, utilizada quando outras portas estão bloqueadas.

SSL (Secure Sockets Layer) e TLS (Transport Layer Security) são protocolos de segurança usados para criptografar dados transmitidos pela Internet, protegendo a comunicação contra interceptação e ataques. SSL é o protocolo antigo para criptografia de dados e o TLS é o protocolo mais recente e mais seguro que substituiu o SSL.

Após preencher todos os campos clique em "Salvar" e seus dados para o envio de e-mail estarão configurados. 

Partindo para a configuração de e-mail com o protocolo oAuth, serão abordados campos de extrema importância para o entendimento do uso correto do protocolo. 

Service Account E-mail: Conta de serviço gerada pelo console google. 

Service Account ID: ID da conta serviço, também gerado pelo console google. 

Caminho para Chave Privada(P12): O caminho da chave privada se refere ao local no sistema de arquivos onde o arquivo contendo a chave privada, como um arquivo P12, é armazenado. Esse caminho é crucial porque aplicações e serviços precisam saber onde localizar a chave privada para realizar autenticações e criptografias. Um arquivo P12 é um formato seguro para armazenar e transportar chaves privadas e certificados digitais, protegidos por senha.

Entenda como gerar conta serviço, ID do serviço e o arquivo p12, acessando:  Processo para configuração do oAuth no console google e para provedor microsoft

Conf

A seguir será mostrado o passo a passo de como configurar seu e-mail seguindo o método do protocolo oAuth na ferramenta Conf, com explicações claras e objetivas .

Para configurar o oAuth na ferramenta Conf, você primeiramente deve ir para a página de E-mail e logo após clicar no botão de configurar E-mail . 

Logo após esse processo ele abrirá a página de "Configuração do Servidor de e-mail", para configurar o oAuth, você deve selecionar o campo "Métodos seguros: oAuth/oAuth2.0" , a seguir, é pedido que seja informado qual provedor de e-mail será usado para a autenticação do e-mail (no exemplo o provedor utilizado será o Gmail), após isso é necessário apertar o botão marcado na parte inferior da imagem. 

Ao clicar no botão o navegador será aberto, e irá ser pedido o e-mail que será configurado (a página que será aberta será de acordo com o provedor selecionado anteriormente), informe seu e-mail e continue o processo.

Se o e-mail informado seja corporativo o processo continua normalmente, caso não for um e-mail corporativo ele abrirá a tela abaixo, para continuar aperte "Ocultar avanço", logo após "Acessar ERP Ti9(não seguro)".

Para prosseguir, clique em continuar. 

Continuando será exibida a seguinte imagem, ela pede que você selecione  o que o ERP Ti9 poderá acessar, os campos abaixo já são selecionados automaticamente, se selecionado clique em continuar. 

Após isso o processo de configuração do e-mail estará concluído, assim voltando para a página de "Configuração do Servidor de e-mail" , é informado que seu e-mail foi salvo e configurado com sucesso, e abaixo da tela em destaque está a conta que será responsável por mandar os e-mails. Para continuar aperte .

Para finalizar, clique em "Enviar E-Mail", será iniciado o processo de envio do e-mail. 

Processo de envio do e-mail: Instrução SQL é executada, apoś executada será mostrado o tamanho do e-mail e por fim o e-mail é enviado .

 , ,

CTe

A seguir será mostrado o passo a passo de como configurar seu e-mail seguindo o método do protocolo oAuth na ferramenta CTe, com explicações claras e objetivas . Nessa ferramenta existem três maneiras de envio de e-mail são elas o método convencional já conhecido e dois métodos utilizando o protocolo oAuth.

Para configurar seu e-mail nessa ferramenta você deve seguir os passos destacados na imagem abaixo, primeiro indo para "Confiração de E-mail" e em seguida "Parametrização". 

Seguindo os passos acima a tela de configuração será aberta no método convencional, no método convencional são citados campos já citados anteriormente no manual, como o SMTP e suas portas e o SSL, o e-mail do usuário e sua senha. Após preenchimento seu e-mail já estará configurado. 

Partindo para a configuração via protocolo oAuth, ao preencher os campos o navegador será aberto para a autentificação do e-mail, processo esse já mostrado anteriormente na ferramenta Conf, possuindo a mesma ideia mas com o provedor diferente agora.

A próxima configuração é feita pela conta de serviço gerada pelo console google, nessa página é pedido que o usuário informe seu usuário, o e-mail de sua conta serviço e o caminho para o arquivo p12. 

Para finalizar a configuração de e-mail da ferramenta CTe, temos o protocolo oAuth via provedor microsoft, é pedido o ID do aplicativo(cliente), o segredo do cliente e o ID do diretório(locatório). 

Acesse para saber mais sobre a configuração do oAuth:  Processo para configuração do oAuth no console google e para provedor microsoft.