Skip to content
master
Switch branches/tags
Go to file
Code

README.md

Zonemaster

Introduction

Zonemaster is a software package that validates the quality of a DNS delegation. The ambition of the Zonemaster project is to develop and maintain an open source DNS validation tool, offering improved performance over existing tools and providing extensive documentation which could be re-used by similar projects in the future.

Zonemaster consists of several modules or components. The components will help different types of users to check domain servers for configuration errors and generate a report that will assist in fixing the errors.

Background

DNSCheck from IIS and Zonecheck from AFNIC are two old software packages that validate the quality of a DNS delegation. AFNIC and IIS came together to develop a new DNS validation tool from scratch under the name Zonemaster. Zonemaster intends to be a major rewrite of Zonecheck and DNSCheck, and aims to implement the best parts of both.

Purpose

The components developed as part of the Zonemaster project will help different types of users to check domain servers for configuration errors and generate a report that will assist in fixing the errors.

The ambition of the Zonemaster project is to develop and maintain an open source DNS validation tool, offering improved performance over existing tools and providing extensive documentation which could be re-used by similar projects in the future.

Documentation

This is the main project repository. In this repository, documentation regarding the design, requirements and specifications for the Zonemaster implementation are available. We also have a brief user guide.

Prerequisites

Zonemaster comes with documentation for and has been tested on the operating systems and processor architecture listed below.

Supported processor architectures

  • x86_64 / amd64

Supported operating system versions

  • CentOS 7
  • CentOS 8
  • Debian 10
  • FreeBSD 11.4
  • FreeBSD 12.2
  • Ubuntu 18.04
  • Ubuntu 20.04

Supported database engine versions

Operating System MariaDB PostgreSQL SQLite
CentOS 7 5.5 9.3 3.7.17
CentOS 8 10.3 10.14 3.26.0
Debian 10 10.3 11.7 3.27.2
FreeBSD 11.4 5.7 12.4 3.32.3
FreeBSD 12.2 5.7 12.4 3.32.3
Ubuntu 18.04 10.1 10.14 3.22.0
Ubuntu 20.04 10.3 12.4 3.31.1
  • FreeBSD uses MySQL, not MariaDB.
  • FreeBSD bundles SQLite in Perl DBD::SQLite.

Zonemaster Backend has been tested with the combination of OS and database engine version listed in the table above. Zonemaster uses functionality introduced in PostgreSQL version 9.3, and earlier versions are as such not supported.

Supported Perl versions

Operating System Perl
CentOS 7 5.16
CentOS 8 5.26
Debian 10 5.28
FreeBSD 11.4 5.32
FreeBSD 12.2 5.32
Ubuntu 18.04 5.26
Ubuntu 20.04 5.30

Zonemaster requieres Perl version 5.14.2 or higher. Zonemaster has been tested with the default version of Perl in the OSs as listed in the table above.

Supported Client Browser versions

Zonemaster GUI is tested against the browsers, their versions and listed OS as indicated bellow and should work perfectly with similar configurations.

Operating System Browser Version
Ubuntu 18.04 Firefox 85
Ubuntu 18.04 Chrome 88
Windows 10 Firefox 85
Windows 10 Chrome 88
MacOs Firefox 85
MacOs Chrome 88

Zonemaster GUI was tested manually or with testing tools. See the Zonemaster-gui repository for more details.

Support of DNSSEC algorithms 15 and 16

To be able to support and process algorithms 15 (Ed25519) and 16 (Ed448) for DNSSEC the underlying OS must have a recent version of OpenSSL installed, and LDNS being linked against that OpenSSL (see Zonemaster-LDNS-README for more details). These conditions are not met in all supported OSs. The following table lists the expected support for algorithms 15 and 16 in the supported OSs, given that the installation instructions given for Zonemaster have been followed. A test of the domains ed25519.nl and superdns.nl will reveal if the Zonemaster installation has the support or not for algorithms 15 and 16, respectively.

All supported OSs, except CentOS 7, support algorithms 15 and 16.

Translation

Zonemaster comes with translation to the following languages. Translation is available as methods in Zonemaster::Engine, zonemaster-cli (i.e. the Zonemaster-CLI interface to Zonemaster::Engine), Zonemaster-Backend RPCAPI interface to Zonemaster::Engine) and the Zonemaster-GUI interface to RPCAPI.

  • Danish (da, da_DK.UTF-8)
  • English (en, en_US.UTF-8)
  • French (fr, fr_FR.UTF-8)
  • Norwegian (nb, nb_NO.UTF-8)
  • Swedish (sv, sv_SE.UTF-8)

Norwegian is not yet available in Zonemaster-GUI.

Zonemaster and its components

The Zonemaster product consists of the main part and five components. The main part consists of specifications and documentation for the Zonemaster product, and is stored in main Zonemaster Github repository (Zonemaster).

All the software for the Zonemaster project belong to the five components, each component being stored in its own Github repository (listed below).

The software has not yet been packaged for any operating systems, and you have to install most of it from the source code. The recommended method is to install from CPAN (except for Zonemaster-GUI), but it is possible to install directly from clones of the Github repositories. Zonemaster-GUI has no Perl code, and is installed directly from its repository at Github.

The Zonemaster Product includes the following components:

Installation

To install Zonemaster, start with installation of Zonemaster-Engine (which will draw in Zonemaster-LDNS) and then continue with the other parts. You will find installation instructions from the links above.

Versions

Go to the release list of this repository to find the latest version of Zonemaster and the versions of the specific components. Be sure to read the release note of each component before installing or upgrading.

Participation

You can submit code by forking this repository and creating pull requests. When you create a pull request, please select the "develop" branch in the relevant Zonemaster repository.

See our contact and mailing lists page for information on mailing lists.

Bug reporting

For bug reporting go to the relevant Zonemaster repository and create a GitHub issue there. Before creating the issue, please search for the problem in the issue tracker in the relevant repository. If you find an open issue covering your issue, please add a comment with any additional information.

If you cannot determine which repository to create the issue in, please select the main Zonemaster repository (i.e. general issues in Zonemaster).

Notable bugs and issues

DNSSEC algorithms 15 and 16

Limitations in the support of DNSSEC algorithm 15 is described above.

Contact and mailing lists

See our contact and mailing lists page for contact information and information on mailing lists.