Skip to content

About

RDAP Client For PHP (Formerly Whois via http protocol)

Topics

Resources

Stars

4 stars

Watchers

1 watching

Forks

Latest commit

 

History

40 Commits

Folders and files

Repository files navigation

RDAP CLIENT

RDAP Client For PHP (Formerly Whois via http protocol)

Requirements

  • php 8.1 or later
  • ext-json
  • ext-intl

IETF RDAP Reference

  • Registration Data Access Protocol (RDAP) Object Tagging #RFC8521
  • Security Services for the Registration Data Access Protocol (RDAP) #RFC7481
  • Registration Data Access Protocol (RDAP) Query Format #RFC9082
  • JSON Responses for the Registration Data Access Protocol (RDAP) #RFC9083
  • Finding the Authoritative Registration Data (RDAP) Service #RFC9224

Schema Inventory & Analysis of WHOIS object

  • Inventory and Analysis of WHOIS Registration Objects #RFC7485

IANA RDAP Data

Iana provide data about rdap

For list of predefined recovered IPv4 addresses: RecoveredIPv4.php

Example Usage

See Client.php for more methods

use ArrayAccess\RdapClient\Client;
use ArrayAccess\RdapClient\Interfaces\RdapRequestInterface;
use ArrayAccess\RdapClient\Protocols\AsnProtocol;
use ArrayAccess\RdapClient\Protocols\DomainProtocol;
use ArrayAccess\RdapClient\Protocols\IPv4Protocol;
use ArrayAccess\RdapClient\Protocols\IPv6Protocol;
use ArrayAccess\RdapClient\Protocols\NsProtocol;

$client = new Client();
/**
 * @var RdapRequestInterface<string, DomainProtocol> $request
 */
$domainName = 'example.com';
$request = $client->request($domainName);

/**
 * @var RdapRequestInterface<string, IPv4Protocol> $request
 */
$ipv4 = '192.0.47.59'; // iana.org ipv4
$request = $client->request($ipv4);

/**
 * @var RdapRequestInterface<string, IPv6Protocol> $request
 */
$ipv6 = '2404:6800:4003:c01::66'; // google.com
$request = $client->request($ipv6);

/**
 * @var RdapRequestInterface<string, NsProtocol> $request
 * Name server guessing by prefix (ns[0-9]*).domain-name.ext or [^\.]+.(ns[0-9]*.[^\.]+\.)(?:.+).domain-name.ext
 */
$nameserver = 'ns1.google.com'; // google name server
$request = $client->request($nameserver);

/**
 * @var RdapRequestInterface<string, AsnProtocol> $request
 * Autonomous System Number parsed by "^(?ASN?)?(?<as_number>[0-9]+)$"
 */
$asNumber = 'AS15169'; // Google LLC ASN
// or just put the numeric string / integer
$request = $client->request($asNumber);
// getting object response
$response = $request->getResponse();
// getting json data
$jsonResponse = $response->getResponseJson();
// getting definition object
$definition = $response->getDefinition();
// if domain > getting related / another whois server request if possible
$alternateRequest = $definition->getRelatedRequest();
// json serialize
$fallbackToJson = json_encode($definition, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES);
// direct call with custom request target
// makes sure the type of RDAP uri target is equal '/domain/GOOGLE.com' as domain-protocol
$newRequest = $request->withRdapSearchURL('https://rdap.markmonitor.com/rdap/domain/GOOGLE.COM');
$response = $newRequest->getResponse();

See Response/Definitions for more details about code

Using your own HTTP client and cache

By default, requests are made with file_get_contents() and the IANA bootstrap files are cached in the system temporary directory.

The client optionally accepts a PSR-18 HTTP client, a PSR-17 request factory and a PSR-16 cache. The HTTP client is used for both the bootstrap files and the RDAP queries, so timeouts, proxies, retries and logging follow your application's configuration. The cache stores the bootstrap files for AbstractRdapService::cacheExpirations() seconds.

use ArrayAccess\RdapClient\Client;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;
use Symfony\Component\Cache\Psr16Cache;
use Symfony\Component\HttpClient\HttpClient;
use Symfony\Component\HttpClient\Psr18Client;

// Psr18Client is also a request factory, so the second argument can be omitted
$httpClient = new Psr18Client(HttpClient::create(['timeout' => 5]));
$cache = new Psr16Cache(new FilesystemAdapter());
$client = new Client($httpClient, null, $cache);

// any PSR-18 client works, e.g. Guzzle with a PSR-17 factory
$client = new Client(new \GuzzleHttp\Client(['timeout' => 5]), new \GuzzleHttp\Psr7\HttpFactory());

Note

The code of data definition contains strict types. Some of the invalid data will throw an error.

WHOIS Data Collection

Refer to: (gist) WHOIS List to get the list of whois servers / ip range / sTLD etc.

Caution! the gist contains huge data.

LICENSE

GPL-3.0-or-later

About

RDAP Client For PHP (Formerly Whois via http protocol)

Topics

Resources

Stars

4 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages