README

A DNS service for Laravel. Use the DNS over HTTPS (DoH) driver it includes or create your own custom driver.

Installation

You can install the package via composer:

composer require jinomial/laravel-dns

You can publish the config file with:

php artisan vendor:publish --provider="Jinomial\LaravelDns\DnsServiceProvider" --tag="laravel-dns-config"

This is the contents of the published config file:

return [

    /*
    |--------------------------------------------------------------------------
    | Default DNS
    |--------------------------------------------------------------------------
    |
    | This option controls the default DNS socket that is used by the DNS
    | service. Alternative DNS sockets may be setup and used as needed;
    | however, this socket will be used by default.
    |
    */

    'default' => env('DNS_SOCKET', 'doh'),

    /*
    |--------------------------------------------------------------------------
    | DNS Socket Configurations
    |--------------------------------------------------------------------------
    |
    | Here you may configure all of the DNS sockets used by your application
    | plus their respective settings. Several examples have been configured for
    | you and you are free to add your own as your application requires.
    |
    | Supported: "doh", "system",
    |
    */

    'sockets' => [
        'doh' => [
            'driver' => 'doh',
            'endpoint' => env('DOH_ENDPOINT', 'https://cloudflare-dns.com/dns-query'),
            'guzzle' => [
                'connect_timeout' => 0,
                'timeout' => 0,
                'verify' => false,
            ]
        ],
        'system' => [
            'driver' => 'system',
        ],
    ],

];

Usage

The response depends on the driver that is used.

doh driver responses

The doh driver uses Cloudflare's DNS over HTTPs with JSON for lookups.

See the response documentation for details about the response format.

$response = Dns::query('ipv6.localhost.jinomial.com', 'aaaa');
print_r($response);

// Array
// (
//     [Status] => 0
//     [TC] =>
//     [RD] => 1
//     [RA] => 1
//     [AD] =>
//     [CD] =>
//     [Question] => Array
//         (
//             [0] => Array
//                 (
//                     [name] => ipv6.localhost.jinomial.com
//                     [type] => 28
//                 )
//
//         )
//
//     [Answer] => Array
//         (
//             [0] => Array
//                 (
//                     [name] => ipv6.localhost.jinomial.com
//                     [type] => 28
//                     [TTL] => 298
//                     [data] => ::1
//                 )
//
//         )
//
// )

system driver responses

The system driver uses PHP's dns_get_record method for lookups.

See the dns_get_record documentation for details about the response format.

$response = Dns::query('ipv6.localhost.jinomial.com', 'aaaa');
print_r($response);

// Array
// (
//     [0] => Array
//         (
//             [host] => ipv6.localhost.jinomial.com
//             [class] => IN
//             [ttl] => 377
//             [type] => AAAA
//             [ipv6] => ::1
//         )
//
// )

Batch Queries

Multiple lookups can be performed at once.

$response = Dns::query([
    [
        'name' => 'ipv6.localhost.jinomial.com',
        'type' => 'AAAA',
    ],
    [
        'name' => 'ipv4.localhost.jinomial.com',
        'type' => 'A',
    ],
]);

The doh driver supports asynchronous queries.

$promises = Dns::query($queries, null, ['async' => true]);
$response = Dns::unwrap($promises);

Testing

Run all tests:

composer test

Test suites are separated into "unit" and "integration". Run each suite:

composer test-unit
composer test-integration

Tests are grouped into the following groups:

network
drivers
doh
manager
facades
commands

Run tests for groups:

composer test -- --include=manager,facades

Network tests make remote calls that can take time or fail. Exclude them:

composer test-unit -- --exclude=network

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

Jason Schmedes

License

The MIT License (MIT). Please see License File for more information.

jinomial / laravel-dns

Maintainers

Details