docs: update README.md

This commit is contained in:
Maël Gangloff 2024-07-19 01:17:33 +02:00
parent 59a74f050d
commit 3b63320cb6
No known key found for this signature in database
GPG Key ID: 11FDC81C24A7F629
4 changed files with 26 additions and 2 deletions

View File

@ -1,5 +1,5 @@
cff-version: 1.2.0
title: DOmain Watchdog
title: Domain Watchdog
message: >-
If you use this software, please cite it using the
metadata from this file.

View File

@ -13,7 +13,7 @@ Although the RDAP and WHOIS protocols allow you to obtain precise information ab
perform a reverse search to discover a list of domain names associated with an entity. Additionally, accessing a
detailed history of events (ownership changes, renewals, etc.) is not feasible with these protocols.
## General Description of Operation
## How it works?
The latest version of the WHOIS protocol was standardized in 2004 by RFC 3912.[^1] This protocol allows anyone to
retrieve key information concerning a domain name, an IP address, or an entity registered with a registry.

View File

@ -5,6 +5,11 @@ namespace App\MessageHandler;
use App\Message\UpdateRdapServers;
use App\Service\RDAPService;
use Symfony\Component\Messenger\Attribute\AsMessageHandler;
use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
#[AsMessageHandler]
final readonly class UpdateRdapServersHandler
@ -15,6 +20,13 @@ final readonly class UpdateRdapServersHandler
}
/**
* @throws TransportExceptionInterface
* @throws ServerExceptionInterface
* @throws RedirectionExceptionInterface
* @throws DecodingExceptionInterface
* @throws ClientExceptionInterface
*/
public function __invoke(UpdateRdapServers $message): void
{
$this->RDAPService->updateRDAPServers();

View File

@ -24,6 +24,11 @@ use App\Repository\RdapServerRepository;
use DateTimeImmutable;
use Doctrine\ORM\EntityManagerInterface;
use Exception;
use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Throwable;
@ -229,6 +234,13 @@ readonly class RDAPService
return $entity;
}
/**
* @throws TransportExceptionInterface
* @throws ServerExceptionInterface
* @throws RedirectionExceptionInterface
* @throws DecodingExceptionInterface
* @throws ClientExceptionInterface
*/
public function updateRDAPServers(): void
{
$dnsRoot = $this->client->request(