struzik-vladislav/epp-client

PHP library for communicating with EPP(Extensible Provisioning Protocol) servers

v2.6.1 2025-03-04 20:25 UTC

Requires

• php: ^7.4|^8.0
• ext-dom: *
• ext-mbstring: *
• ext-simplexml: *
• psr/log: ~1.0 | ~2.0 | ~3.0
• struzik-vladislav/xpath-extended: ~1.0

Requires (Dev)

• phpunit/phpunit: >=9.6

Suggests

• struzik-vladislav/epp-ext-hostmasterua-balance: Balance extension provided by Hostmaster (https://hostmaster.ua/)
• struzik-vladislav/epp-ext-hostmasterua-uaepp: UAEPP extension provided by Hostmaster (https://hostmaster.ua/)
• struzik-vladislav/epp-ext-iddigital-charge: Charge extension provided by Identity Digital (https://www.identity.digital/)
• struzik-vladislav/epp-ext-iddigital-kv: Key-Value extension provided by Identity Digital (https://www.identity.digital/)
• struzik-vladislav/epp-ext-rgp: Domain Registry Grace Period (RGP) extension for the EPP Client
• struzik-vladislav/epp-ext-secdns: DNS Security Extension for the EPP Client
• struzik-vladislav/epp-monolog-formatter: A EPP requests/responses formatter for Monolog
• struzik-vladislav/epp-rabbitmq-connection: Connection to the EPP servers via RabbitMQ
• struzik-vladislav/epp-socket-connection: Socket connection to the EPP servers

MIT

• Vladislav Struzik

• registry
• registrar
• domains
• epp

README

PHP library for communicating with EPP (Extensible Provisioning Protocol) servers.

Documentation

Go to web documentation.

Library implemented according to next RFCs:

• RFC 5730 - Extensible Provisioning Protocol (EPP)
• RFC 3731 - Extensible Provisioning Protocol (EPP) Domain Name Mapping
• RFC 5732 - Extensible Provisioning Protocol (EPP) Host Mapping
• RFC 5733 - Extensible Provisioning Protocol (EPP) Contact Mapping
• RFC 5734 - Extensible Provisioning Protocol (EPP) Transport over TCP
• RFC 3735 - Guidelines for Extending the Extensible Provisioning Protocol (EPP)

Connections

• struzik-vladislav/epp-socket-connection - Socket connection to the EPP servers
• struzik-vladislav/epp-rabbitmq-connection - Connection to the EPP servers via RabbitMQ (EPP RabbitMQ Daemon is coming soon)

Extensions

• struzik-vladislav/epp-ext-rgp - Domain Registry Grace Period (RGP) extension for the EPP Client
• struzik-vladislav/epp-ext-secdns - DNS Security Extension for the EPP Client
• struzik-vladislav/epp-ext-hostmasterua-uaepp - UAEPP extension provided by HostmasterUA
• struzik-vladislav/epp-ext-hostmasterua-balance - Balance extension provided by HostmasterUA
• struzik-vladislav/epp-ext-iddigital-charge - Charge extension provided by Identity Digital

Tools

• struzik-vladislav/epp-monolog-formatter - Requests/Responses monolog/monolog formatter for hiding sensitive data

Basic usage

composer.json

{
  "require": {
    "struzik-vladislav/epp-client": "^2.0",
    "struzik-vladislav/epp-socket-connection": "^2.0",
    "monolog/monolog": "*"
  }
}

example.php

<?php

use Monolog\Handler\StreamHandler;
use Monolog\Logger;
use Struzik\EPPClient\EPPClient;
use Struzik\EPPClient\NamespaceCollection;
use Struzik\EPPClient\Request\Session\LoginRequest;
use Struzik\EPPClient\Request\Session\LogoutRequest;
use Struzik\EPPClient\SocketConnection\StreamSocketConfig;
use Struzik\EPPClient\SocketConnection\StreamSocketConnection;

require_once __DIR__.'/vendor/autoload.php';

$logger = new Logger('EPP Client');
$logger->pushHandler(new StreamHandler('php://output', Logger::DEBUG));

$connectionConfig = new StreamSocketConfig();
$connectionConfig->uri = 'tls://epp.example.com:700';
$connectionConfig->timeout = 10;
$connectionConfig->context = [
    'ssl' => [
        'local_cert' => __DIR__.'/certificate.pem',
    ]
];
$connection = new StreamSocketConnection($connectionConfig, $logger);

$client = new EPPClient($connection, $logger);
$client->getNamespaceCollection()->offsetSet(NamespaceCollection::NS_NAME_ROOT, 'urn:ietf:params:xml:ns:epp-1.0');
$client->getNamespaceCollection()->offsetSet(NamespaceCollection::NS_NAME_CONTACT, 'urn:ietf:params:xml:ns:contact-1.0');
$client->getNamespaceCollection()->offsetSet(NamespaceCollection::NS_NAME_HOST, 'urn:ietf:params:xml:ns:host-1.0');
$client->getNamespaceCollection()->offsetSet(NamespaceCollection::NS_NAME_DOMAIN, 'urn:ietf:params:xml:ns:domain-1.0');;

$client->connect();

$request = new LoginRequest($client);
$request->setLogin('login')
    ->setPassword('password')
    ->setLanguage('en')
    ->setProtocolVersion('1.0');
$response = $client->send($request);

$request = new LogoutRequest($client);
$response = $client->send($request);

$client->disconnect();