Skip to main content

DNS Name Server Framework

Project description

NServer: a high-level Python DNS Name Server Framework.

PyPi Python Versions License

NServer is a Python (3.6+) framework for building customised DNS name servers with a focuses on ease of use over completeness. It implements high level APIs for interacting with DNS queries whilst making very few assumptions about how responses are generated.

It is not intended to act like traditional DNS servers such as BIND or CoreDNS and should not be considered a general DNS resolver.

NServer has been built upon dnslib however uses high level abstractions that does not give access to the full DNS specification. If this is your desired behaviour I suggest using dnslib and its server API.

NServer has been inspired by easy to use high level frameworks such as Flask or Requests.

NServer is currently Alpha software and does not have complete documentation, testing, or implementation of certain features. Specific APIs may change in the future, but NServer uses semantic versioning so you can have more stable interfaces using version specifiers (e.g. nserver>=0.0.1,<1.0).

Installation

Install via pip

pip3 install nserver

Quick Start

from nserver import NameServer, Response, A, NS, TXT

ns = NameServer("example")

# Responses can have answers records, additional records and authority records.
@ns.rule("example.com", ["NS"])
def my_name_servers(query):
    response = Response()
    for i in range(4):
        my_ns = "ns{}.example.com".format(i + 1)
        response.answers.append(NS(query.name, my_ns))
        response.additional.append(A(my_ns, "1.1.1.1"))
    return response


# Rules can use wildcards for both single-segment (*) or many-segment (**)
# wildcards will not match mising segments (equivilent to regex `+`)
# You can also construct simple responses by return records directly.


@ns.rule("**.example.com", ["A"])
def wildcard_example(query):
    """All example.com subdomains are at 1.2.3.4."""
    return A(query.name, "1.2.3.4")


# Rules are processed in the order they are registered so if a query matches
# this rule, it will not reach the `australian_catchall` below.
# Wildcards can appear in names, but the above segment limits apply.


@ns.rule("www.*.com.au", ["A"])
def all_australian_www(query):
    return A(query.name, "5.6.7.8")


# Wildcard domains also allow special substitutions.
# base_name will provide the domain less any subdomains.


@ns.rule("hello.{base_domain}", ["TXT"])
def say_hello(query):
    if query.name.endswith(".com.au"):
        return TXT(query.name, "G'day mate")
    return TXT(query.name, "Hello friend")


# Rules can apply to multiple query types.


@ns.rule("**.com.au", ["A", "AAAA", "ANY"])
def australian_catchall(query):
    return Response()  # Empty response, avoids default NXDOMAIN


# Anything that does not match will return NXDOMAIN

if __name__ == "__main__":
    ns.settings.SERVER_PORT = 9001  # It's over 9000!
    ns.run()

Once running, interact using dig:

dig -p 9001 @localhost NS example.com

dig -p 9001 @localhost A foo.example.com
dig -p 9001 @localhost A foo.bar.example.com

dig -p 9001 @localhost A www.foo.com.au
dig -p 9001 @localhost A www.bar.com.au

dig -p 9001 @localhost TXT hello.foo.com
dig -p 9001 @localhost TXT hello.foo.com.au

dig -p 9001 @localhost A foo.com.au
dig -p 9001 @localhost AAAA foo.com.au
dig -p 9001 @localhost ANY foo.com.au

Bugs, Feature Requests etc

TLDR: Please submit an issue on github.

In the case of bug reports, please help me help you by following best practices 1 2.

In the case of feature requests, please provide background to the problem you are trying to solve so to help find a solution that makes the most sense for the library as well as your usecase. Before making a feature request consider looking at my (roughly written) design notes.

Development

The only development dependency is bash and docker. All actions are run within docker for ease of use. See ./dev.sh help for commands. Typical commands are format, lint, test, repl, build.

I am still working through open source licencing and contributing, so not taking PRs at this point in time. Instead raise and issue and I'll try get to it as soon a feasible.

Licence

This project is licenced under the MIT Licence - see LICENCE.

This project may include other open source licenced software - see NOTICE.

Authors

A project by Nicholas Hairs - www.nicholashairs.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for nserver, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size nserver-0.0.3-py3-none-any.whl (14.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size nserver-0.0.3.tar.gz (17.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page