EPP
1. Introdução
O protocolo EPP é um padrão do IETF que permite que provedores de serviço executem operações de provisionamento em objetos de um repositório central. Sua principal aplicação é a automatização do registro e manutenção de domínios.
A implementação EPP do .br está disponível desde julho/2006 para provedores de serviços que administram grandes conjuntos de domínios.
O acesso ao serviço EPP do .br é permitido apenas aos provedores aprovados num processo de homologação técnica. Este processo é composto de uma sequência de comandos minimamente suficiente para cobrir as principais operações do protocolo EPP
Veja abaixo os passos necessários para utilizar o serviço EPP do .br:
- 1.1 Definição da forma de integração dos sistemas do provedor com o serviço EPP do .br
Além da biblioteca cliente libepp-nicbr, desenvolvida pelo Registro.br em C++, outras implementações do protocolo EPP podem ser utilizadas.
Como EPP é um protocolo padrão, com interface XML sobre transporte TCP com TLS, qualquer linguagem capaz de gerar e processar XML sobre TLS pode ser utilizada para integração dos sistemas do provedor com o Registro.br, bastando que a implementação cliente siga as recomendações listadas na seção Referências EPP.
Durante o desenvolvimento da integração dos sistemas, é importante observar com cuidado as Políticas e restrições ao serviço EPP do .br para o correto funcionamento do sistema.
- 1.2 Acesso ao ambiente de homologação e testes
Uma vez definida a forma de integração com os sistemas do Registro.br, é necessário solicitar o cadastro do provedor no ambiente de homologação e testes.
Esta solicitação deve ser feita com o envio do Formulário de Homologação preenchido para epp-suporte@registro.br. Observe que o item 2 do formulário deve ser preenchido com um código de usuário cadastrado no próprio ambiente de homologação. Seu usuário no site em produção do Registro.br não pode ser utilizado no ambiente de testes.
Os dados de acesso ao serviço EPP serão enviados por e-mail assim que o cadastro do provedor for concretizado.
- 1.3 Aprovação no procedimento de homologação
Uma vez apto a interoperar com o Registro.br via EPP, o provedor deve demonstrar sua total compreensão do protocolo e do sistema de registro de domínios brasileiro. Para tal é necessário executar com perfeição o Procedimento de Homologação de Provedores de Serviços EPP no Registro.br.
Este procedimento deve ser realizado no intervalo máximo de 1 hora. Ao terminar, o provedor deve enviar um e-mail para epp-suporte@registro.br informando o endereço IP utilizado na conexão, o nome do provedor e os horários de início e fim do procedimento. O Registro.br responderá em aproximadamente 48 horas.
- 1.4 Assinatura de contrato
Após confirmada a homologação, o provedor deverá enviar o Formulário do Contrato preenchido para epp@registro.br, para que possamos elaborar o contrato
A minuta do contrato bem como instruções para encaminhamento do processo serão enviados por e-mail para providências do provedor.
- 1.5 Depósito inicial
Após a confirmação da efetivação do contrato, o Registro.br entrará em contato por e-mail para solicitar que seja feito o depósito inicial. Este depósito deve ser realizado seguindo o Procedimento de Crédito para Provedores de Serviços EPP. O valor será automaticamente convertido em créditos para utilização no registro e manutenção de domínios.
Uma vez efetivado o crédito inicial o provedor receberá, enfim, uma conta EPP no sistema de produção do Registro.br.
- 1.6 Solicitação do certificado SSL
O acesso ao servidor EPP de produção exige o uso de um certificado SSL de uso exclusivo do provedor, o qual é emitido pelo NIC.br somente após o cadastro da conta EPP no sistema. Para obter este certificado, siga as instruções descritas em Solicitando um certificado SSL.
2. Informações Operacionais
- 2.1 Procedimento de crédito para o serviço EPP
Créditos EPP devem ser feitos através de DOC, TED ou depósito na conta corrente do NIC.br
Dados da conta bancária
Banco Santander: 033
Agencia: 105
C/C: 1303201-4 (DOC)
C/C: 13003201-4 (depósito)
Titular: NIC.br
Chave Pix: epp@registro.br
CNPJ 05.506.560/0001-36Após efetuado o crédito, é preciso enviar o comprovante através de uma das seguintes opções:
- Em formato eletrônico por email para epp@registro.br.
- Por FAX para (11) 55093501. Após o envio do comprovante por fax, é necessário confirmar o recebimento do mesmo pelo telefone (11) 5509-3500.
Juntamente com o comprovante, informe o Provedor de Serviços e nome e telefone para contato.
IMPORTANTE: Créditos efetuados serão efetivados no Registro.br, após a confirmação bancária.
- 2.2 Valor do registro e manutenção de domínios
Os valores das operações "create" e "renew" no protocolo EPP são ambas de R$ 36,00 por ano. É possível informar períodos de 1 a 10 anos de registro ou renovação.
Domínios NOM.BR podem ser registrados ou renovados por períodos entre 3 e 10 anos. O período mínimo de 3 anos para este DPN tem custo de R$ 36,00. Para cada ano adicional, serão cobrados R$ 12,00.
- 2.3 Solicitando um certificado TLS
A conexão ao servidor EPP de produção exige o uso de um certificado TLS de uso exclusivo do provedor, o qual é emitido pelo NIC.br aos provedores que possuem conta EPP ativa no sistema. O certificado emitido é de um AC privada do NIC.br que não tem aceitação por browsers ou outros programas e dispositivos, e serve apenas para o ambiente EPP do .br.
Para que possamos emitir o certificado TLS é necessário que o provedor nos envie um CSR (Certificate Signing Request), que é um arquivo contendo informações sobre o provedor que serão incluídas no certificado gerado pelo NIC.br, tais como:
- Common Name: Para fins do serviço EPP do .br, deve ser utilizado o número atribuído ao provedor, quando de seu cadastro;
- Organization: Razão social do provedor;
- Organizational Unit: Departamento do provedor responsável pelo serviço EPP;
- City: Cidade onde o provedor está localizado;
- State: Estado onde o provedor está localizado;
- Country: Código ISO de 2 letras do país do provedor;
- Public Key: Chave pública a ser incluída no certificado.
O CSR gerado pelo provedor EPP deve estar no formato PEM e codificado em Base-64. O arquivo CSR neste formato pode ser aberto num editor de texto comum e tem conteúdo parecido com o apresentado abaixo:
-----BEGIN CERTIFICATE REQUEST----- MIICzDCCAbQCAQAwgYYxCzAJBgNVBAYTAkVOMQ0wCwYDVQQIDARub25lMQ0wCwYD VQQHDARub25lMRIwEAYDVQQKDAlXaWtpcGVkaWExDTALBgNVBAsMBG5vbmUxGDAW BgNVBAMMDyoud2lraXBlZGlhLm9yZzEcMBoGCSqGSIb3DQEJARYNbm9uZUBub25l LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMP/U8RlcCD6E8AL PT8LLUR9ygyygPCaSmIEC8zXGJung3ykElXFRz/Jc/bu0hxCxi2YDz5IjxBBOpB/ kieG83HsSmZZtR+drZIQ6vOsr/ucvpnB9z4XzKuabNGZ5ZiTSQ9L7Mx8FzvUTq5y /ArIuM+FBeuno/IV8zvwAe/VRa8i0QjFXT9vBBp35aeatdnJ2ds50yKCsHHcjvtr 9/8zPVqqmhl2XFS3Qdqlsprzbgksom67OobJGjaV+fNHNQ0o/rzP//Pl3i7vvaEG 7Ff8tQhEwR9nJUR1T6Z7ln7S6cOr23YozgWVkEJ/dSr6LAopb+cZ88FzW5NszU6i 57HhA7ECAwEAAaAAMA0GCSqGSIb3DQEBBAUAA4IBAQBn8OCVOIx+n0AS6WbEmYDR SspR9xOCoOwYfamB+2Bpmt82R01zJ/kaqzUtZUjaGvQvAaz5lUwoMdaO0X7I5Xfl sllMFDaYoGD4Rru4s8gz2qG/QHWA8uPXzJVAj6X0olbIdLTEqTKsnBj4Zr1AJCNy /YcG4ouLJr140o26MhwBpoCRpPjAgdYMH60BYfnc4/DILxMVqR9xqK1s98d6Ob/+ 3wHFK+S7BRWrJQXcM8veAexXuk9lHQ+FgGfD0eSYGz0kyP26Qa2pLTwumjt+nBPl rfJxaLHwTQ/1988G0H35ED0f9Md5fzoKi5evU1wG5WRxdEUPyt3QUXxdQ69i0C+7 -----END CERTIFICATE REQUEST-----
A criação do CSR tem como pré-requisito a criação de uma chave privada. Sugerimos a utilização de chaves RSA de ao menos 2048 bits. Supondo o uso do software OpenSSL, a geração da chave privada pode ser feita com o seguinte comando:
openssl genrsa -aes256 -out meuprovedor.key 2048
Com a chave privada gerada, a criação do CSR pode ser feita com o comando a seguir:
openssl req -new -key meuprovedor.key -out meuprovedor.csr
O arquivo contendo o CSR deve ser enviado por e-mail para epp@registro.br. O NIC.br fará as verificações necessárias no CSR recebido e, estando tudo em ordem, emitirá o novo certificado TLS para o provedor EPP.
IMPORTANTE: O certificado TLS gerado será enviado somente para o e-mail do contato administrativo do provedor.
Assim que receber o arquivo com o novo certificado, certifique-se de substituí-lo em seus sistemas.
Sistemas que utilizam a biblioteca libepp-nicbr esperam os dados do certificado e respectiva chave privada num único arquivo no formato PEM. O comando abaixo pode ser utilizado para gerá-lo:
cat meuprovedor.crt meuprovedor.key > meuprovedor.pem
Caso seu sistema utilize certificados no formato PKCS#12, a conversão pode ser feita da seguinte forma:
openssl pkcs12 -export -in meuprovedor.crt -inkey meuprovedor.key -out meuprovedor.p12
3. Informações técnicas
- 3.1 Ambiente de homologação e testes
O sistema para testes da interface EPP do registro.br está publicamente disponível desde o dia 22/05/2006 no servidor beta.registro.br.
Para obter uma conta no sistema de testes é preciso:
- Cadastrar um ID em beta.registro.br
- Enviar o formulário preenchido por email para epp-suporte@registro.br. As instruções encontram-se no próprio formulário.
As zonas disponíveis para o teste são COM.BR, ORG.BR, EDU.BR, NOM.BR e ENG.BR. Domínios registrados no servidor de testes serão publicados no servidor DNS em beta.registro.br.
Os seguintes serviços estarão disponíveis:
http/s - Interface WEB epp - Servidor EPP TLS/700 whois - Servidor whois TCP/43 ex.: whois -h beta.registro.br eppserv.com.br isavail - Serviço de disponibilidade de domínios UDP/43 ex.: avail_client.py -s beta.registro.br eppserv.com.br dns - Servidor DNS com dnssec ex.: dig @beta.registro.br eppserv.com.br ns [+dnssec]
Suporte EPP poderá ser obtido pelo email epp-suporte@registro.br ou pela lista de discussão.
- 3.2 Referências EPP
Abaixo, listamos os documentos que definem o protocolo EPP, bem como as extensões criadas pelo Registro.br. Os documentos identificados com * são aqueles necessários para o correto funcionamento de um cliente do serviço EPP do .br:
- RFC 3735: Guidelines for Extending the Extensible Provisioning Protocol
- RFC 5730*: Extensible Provisioning Protocol (EPP)
- RFC 5731*: EPP Domain Name Mapping
- RFC 5732: EPP Host Mapping
- RFC 5733*: EPP Contact Mapping
- RFC 5734*: EPP Transport over TCP
- RFC 5910*: Domain Name System (DNS) Security Extensions Mapping for EPP
- draft-neves-epp-brorg-06.txt*: BR Organization Mapping for EPP
- draft-neves-epp-brdomain-05.txt*: BR Domain Mapping for EPP
- draft-neves-epp-ipnetwork-02.txt: IP Network Mapping for EPP
- draft-neves-epp-asn-02.txt: Autonomous System Number Mapping for EPP
4. Biblioteca libepp-nicbr
Esta é a biblioteca C++ LIBEPP-NICBR que implementa parcialmente o Extensible Provisioning Protocol (EPP), conforme descrito nos RFC5735, RFC5730 a RFC5734 e RFC5910.
O mapeamento de domínio - RFC5731 - foi implementado com hosts sendo atributos do objeto Domínio.
Para adequar o protocolo ao modelo do .BR, foram feitas extensões aos mapeamentos de domínio e contato (draft-neves-epp-brdomain e draft-neves-epp-brorg), suportadas desde a versão 0.2. A documentação destas extensões está disponível em Referências EPP.
Embora a maior parte do desenvolvimento tenha sido feito em FreeBSD, não tivemos problemas compilando-a e executando os testes em Linux (testado em versões recentes de Ubuntu).
- 4.1 Downloads
1-10 de 29
Data Versão Descrição Download 21-Set-2023 libepp-nicbr 1.19 Suporte a OpenSSL 3.0.x Baixar 23-Ago-2021 libepp-nicbr 1.18 Suporte às novas políticas de trocas de contato do Registro.br Baixar 07-Dez-2020 libepp-nicbr 1.17 Extensão para integração com LACNIC, C++17 e novos certificados. Baixar 12-Fev-2020 libepp-nicbr 1.16 Suporte a OpenSSL 1.1.1 e correções de memory leaks. Baixar 28-Jan-2015 libepp-nicbr 1.15 Suporte a TLSv1.1 e TLSv1.2 e novos certificados. Baixar 10-Dez-2014 libepp-nicbr 1.14 Novos comandos e extensões referentes a gTLDs e integrações com o LACNIC. Baixar 15-Mai-2013 libepp-nicbr 1.13 Correções e melhorias no transporte de dados e na conversão dos XMLs. Baixar 06-Set-2012 libepp-nicbr 1.12 Correções no sistema de compilação e novos certificados de teste. Baixar 15-Ago-2011 libepp-nicbr 1.11 Novos campos e comandos, assim como suporte a DNSSEC nos comandos de gerenciamento de IPs. Baixar 22-Jul-2010 libepp-nicbr 1.10 Pequenas correções (host status/Xerces-C 2) Baixar 1-10 de 29
- 4.2 Suporte, comentários, críticas e sugestões
Entre em contato via epp-suporte@registro.br ou acesse a Lista de discussão.