Zonemaster::Engine(3p)

NAME
Zonemaster::Engine - A tool to check the quality of a DNS zone

SYNOPSIS
    my @results = Zonemaster::Engine->test_zone('iis.se')

INTRODUCTION
This manual describes the main Zonemaster::Engine module. If what you're after is documentation on the Zonemaster test engine as a whole, see Zonemaster::Engine::Overview.

METHODS

test_zone($name)
    Runs all available tests and returns a list of Zonemaster::Engine::Logger::Entry objects.

test_module($module, $name)
    Runs all available tests for the zone with the given name in the specified module.

test_method($module, $method, @arguments)
    Run one particular test method in one particular module. The requested module must be in the list of active loaded modules (that is, not the Basic module and not a module disabled by the current policy), and the method must be listed in the metadata the module exports. If those requirements are fulfilled, the method will be called with the provided arguments.

zone($name)
    Returns a Zonemaster::Engine::Zone object for the given name.

ns($name, $address)
    Returns a Zonemaster::Engine::Nameserver object for the given name and address.

profile()
    Returns the effective profile (Zonemaster::Engine::Profile object).

logger()
    Returns the global Zonemaster::Engine::Logger object.

all_tags()
    Returns a list of all the tags that can be logged for all avilable test modules.

all_methods()
    Returns a hash, where the keys are test module names and the values are lists with the names of the test methods in that module.

recurse($name, $type, $class)
    Does a recursive lookup for the given name, type and class, and returns the resulting packet (if any). Simply calls "recurse" in Zonemaster::Engine::Recursor on a globally stored object.

can_continue()
    In case of critical condition that prevents tool to process tests, add test here and return False.

save_cache($filename)
    After running the tests, save the accumulated cache to a file with the given name.

preload_cache($filename)
    Before running the tests, load the cache with information from a file with the given name. This file must have the same format as is produced by "save_cache()".

asn_lookup($ip)
    Takes a single IP address and returns one of three things:

    •   Nothing, if the IP address is not in any AS.

    •   If called in list context, a list of AS number and a Net::IP::XS object representing the prefix it's in.

    •   If called in scalar context, only the AS number.

modules()
    Returns a list of the loaded test modules. Exactly the same as "modules" in Zonemaster::Engine::Test.

add_fake_delegation($domain, $data)
    This method adds some fake delegation information to the system. The arguments are a domain name, and a reference to a hash with delegation information. The keys in the hash must be nameserver names, and the values references to lists of IP addresses (which can be left empty) for the corresponding nameserver. If IP addresses are not provided for nameservers, the engine will perform queries to find them, except for in-bailiwick nameservers. All IP addresses found/provided are then used to initialize %Zonemaster::Engine::Recursor::fake_addresses_cache for later usage. If all servers can be associated to IP addresses, add_fake_delegation method returns 1, 'undef' otherwise.

    Example:

        Zonemaster::Engine->add_fake_delegation(
            'lysator.liu.se' => {
                'ns1.nic.fr' => [ ],
                'ns.nic.se'  => [ '212.247.7.228',  '2a00:801:f0:53::53' ],
                'i.ns.se'    => [ '194.146.106.22', '2001:67c:1010:5::53' ],
                'ns3.nic.se' => [ '212.247.8.152',  '2a00:801:f0:211::152' ]
            }
        );

    will return 1.

        Zonemaster::Engine->add_fake_delegation(
            'lysator.liu.se' => {
                'ns1.lysator.liu.se' => [ ],
                'ns.nic.se'  => [ '212.247.7.228',  '2a00:801:f0:53::53' ],
                'i.ns.se'    => [ '194.146.106.22', '2001:67c:1010:5::53' ],
                'ns3.nic.se' => [ '212.247.8.152',  '2a00:801:f0:211::152' ]
            }
        );

    will return 'undef' (missing address for ns1.lysator.liu.se).

add_fake_ds($domain, $data)
    This method adds fake DS records to the system. The arguments are a domain name, and a reference to a list of references to hashes. The hashes in turn must have the keys "keytag", "algorithm", "type" and "digest", with the values holding the corresponding data. The digest data should be a single unbroken string of hexadecimal digits.

    Example:

       Zonemaster::Engine->add_fake_ds(
          'nic.se' => [
             { keytag => 16696, algorithm => 5, type => 2, digest => '40079DDF8D09E7F10BB248A69B6630478A28EF969DDE399F95BC3B39F8CBACD7' },
             { keytag => 16696, algorithm => 5, type => 1, digest => 'EF5D421412A5EAF1230071AFFD4F585E3B2B1A60' },
          ]
       );

start_time_now()
    Set the logger's start time to the current time.

reset()
    Reset logger start time to current time, empty the list of log messages, clear nameserver object cache and recursor cache.

AUTHORS
Vincent Levigneron <vincent.levigneron at nic.fr> - Current maintainer

Calle Dybedahl <calle at init.se> - Original author

LICENSE
This is free software, licensed under:

The (three-clause) BSD License

The full text of the license can be found in the LICENSE file included with this distribution.