Skip to content

Latest commit

 

History

History
111 lines (67 loc) · 4.25 KB

README.md

File metadata and controls

111 lines (67 loc) · 4.25 KB
Raw

Public Zone Database

build status godoc

The Public Zone Database (zonedb) is a free, open-source database containing a list and associated metadata of public DNS zones (domain name extensions). It attempts to be exhaustive, including current, retired, and withdrawn top-level domains and subdomains.

The intended use case is programs that interface with the public domain name system, including registry and registrar services. The data overlaps with and shares test cases with the Public Suffix List maintained by the Mozilla Foundation. The source data was originally derived from the internal zone database in use at Domainr.

Structure

The database consists of a list of zones (zones.txt) and associated metadata in JSON format.

zones.txt

The zones.txt file is a UTF-8 encoded text file containing a list of IDN & lower-case domain names, one per line, followed by a newline (\n) character. The domain names in zones.txt are sorted according to the following rules:

  1. Number of labels (top-level domains, followed by second- and third-level domains)
  2. Parent domain (e.g. uk)
  3. Subdomain (e.g. co.uk)

Metadata

Each domain with associated metadata will have a JSON file in the metadata directory.

Updates

A CircleCI workflow updates ZoneDB each night.

zones.txt

If a new SLD or third-level domain needs to be added to zones.txt, follow these steps locally:

  1. add the new zone to the bottom of the zones.txt file
  2. run make normalize to normalize the data
  3. run make update to run ZoneDB's update process
  4. create a pull request for the changes, and confirm the tests are passing

json files

If an update to one of the {zone}.json files is needed, do this locally:

  1. make normalize # tidies the json files, and runs go generate
  2. commit the changes

Implementations

Go

go get github.com/zonedb/zonedb

This repository contains a reference implementation of the database written in Go. Unlike the source data, which is in Unicode, the Go implementation represents domain names in ASCII IDNA form for interop with existing libraries.

Contributing

Fork this repository, make changes, and send a pull request. Before submitting a PR, run make normalize to normalize any changes. The data is structured to minimize diff size.

zonedb build tool

This database is generated and validated using the zonedb tool in this directory. To install, make sure you have a working Go installation (1.4+) and run this command:

go get -u github.com/zonedb/zonedb/cmd/zonedb

You can also run the zonedb tool directly: go run cmd/zonedb/main.go

Example commands

List all zones that have wildcarded DNS:

$ go run cmd/zonedb/main.go -list-wildcards

List all zones tagged geo:

$ go run cmd/zonedb/main.go -tags geo

List a given zone's tags:

$ go run cmd/zonedb/main.go -zones capetown -list-tags

Add a tag to multiple zones (and write the output):

$ go run cmd/zonedb/main.go -zones capetown,durban,joburg -add-tags city -w
$ make normalize

Remove a tag from a zone (and write the output):

$ go run cmd/zonedb/main.go -zones la -remove-tags generic -w

Add a location to a zone (and write the output):

$ go run cmd/zonedb/main.go -zones alsace -add-locations fr-a -w

License

This database is licensed under the Open Database License (ODBl) version 1.0. See LICENSE.md for more information.

Copyright © 2008–2019 the Public Zone Database authors.