- Introduction
- Background
- Purpose
- Documentation
- Prerequisites
- Support of DNSKEY algorithms 15 and 16
- Translation
- Zonemaster and its components
- Installation
- Versions
- Participation
- Bug reporting
- Notable bugs and issues
- Contact and mailing lists
- License
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.
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.
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.
This is the main project repository. In this repository, most documentation of Zonemaster is found.
In the public documentation you will find e.g. specifications of all Test Cases for the Zonemaster implementation, as well as installation instructions and user guides for each Zonemaster component.
In the internal tree you can find documentation regarding the design and requirements of the Zonemaster implementation.
The public documentation can be built using
mdbook and the following commands:
cd docs/public
mdbook build
open book/index.html
See Prerequisites document.
To be able to support and process DNSKEY 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). Then
information below on support of the algorithms assumes 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 support algorithms 15 and 16 out of the box.
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)
- Finnish (fi, fi_FI.UTF-8)
- French (fr, fr_FR.UTF-8)
- Norwegian (nb, nb_NO.UTF-8)
- Spanish (es, es_ES.UTF-8)
- Swedish (sv, sv_SE.UTF-8)
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 the main Zonemaster Github repository.
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:
- Zonemaster-LDNS - LDNS with a Perl frontend used by Zonemaster-Engine.
- Zonemaster-Engine - The Zonemaster test library.
- Zonemaster-CLI - A Command Line Interface (CLI) to the test library (Zonemaster-Engine).
- Zonemaster-Backend - A JSON/RPC interface with database to the test library (Zonemaster-Engine).
- Zonemaster-GUI - A web user interface to the test library via Zonemaster-Backend.
Zonemaster itself can be installed manually. It can also be run using Docker. For detailed instructions on both options, see the Installation document.
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.
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.
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.
- Issues in Zonemaster::LDNS
- Issues in Zonemaster::Engine
- Issues in Zonemaster::CLI
- Issues in Zonemaster::Backend
- Issues in Zonemaster::GUI
If you cannot determine which repository to create the issue in, please select the main Zonemaster repository (i.e. general issues in Zonemaster).
None.
See our contact and mailing lists page for contact information and information on mailing lists.
This is free software under a 2-clause BSD license. The full text of the license can be found in the LICENSE file included in this respository.