Asynchronous DNS client and server
Project description
async_dns
Features
- Built with
asyncio
in pure Python, no third party dependency is required - Support DNS over UDP / TCP
- Support DNS over HTTPS
- Support DNS over TLS
Prerequisite
- Python >=3.6
Installation
$ pip3 install async_dns
# or
$ pip3 install git+https://github.com/gera2ld/async_dns.git
CLI
Resolver
usage: python3 -m async_dns.resolver [-h] [-n NAMESERVERS [NAMESERVERS ...]] [-t TYPES [TYPES ...]]
hostnames [hostnames ...]
Async DNS resolver
positional arguments:
hostnames the hostnames to query
optional arguments:
-h, --help show this help message and exit
-n NAMESERVERS [NAMESERVERS ...], --nameservers NAMESERVERS [NAMESERVERS ...]
name servers
-t TYPES [TYPES ...], --types TYPES [TYPES ...]
query types, default as `any`
Examples:
# Resolve an IP
$ python3 -m async_dns.resolver www.google.com
$ python3 -m async_dns.resolver -t mx -- gmail.com
# Query via TCP
$ python3 -m async_dns.resolver -n tcp://127.0.0.1 -- www.google.com
# Query via TLS
$ python3 -m async_dns.resolver -n tcps://dns.alidns.com -- www.google.com
# Query from non-standard ports
$ python3 -m async_dns.resolver -n udp://127.0.0.1:1053 -- www.google.com
# Query from HTTPS
$ python3 -m async_dns.resolver -n https://dns.alidns.com/dns-query -- www.google.com
Note: --
is required before hostname
s if the previous option can have multiple arguments.
Server
usage: python3 -m async_dns.server [-h] [-b BIND] [--hosts HOSTS] [-x [PROXY [PROXY ...]]]
DNS server by Gerald.
optional arguments:
-h, --help show this help message and exit
-b BIND, --bind BIND the address for the server to bind
--hosts HOSTS the path of a hosts file, `none` to disable hosts, `local` to read from
local hosts file
-x [PROXY [PROXY ...]], --proxy [PROXY [PROXY ...]]
the proxy DNS servers, `none` to serve as a recursive server, `default` to
proxy to default nameservers
Note: TLS and HTTPS are not supported in async_dns
server. Consider async-doh for DoH server support.
Examples:
# Start a DNS proxy server on :53
$ python3 -m async_dns.server -b :53 --hosts /etc/hosts
# Start a DNS server over TCP proxy
$ python3 -m async_dns.server -x tcp://114.114.114.114
# Start a DNS recursive server
$ python3 -m async_dns.server -x none
API
import asyncio
from async_dns import types
from async_dns.resolver import ProxyResolver
resolver = ProxyResolver()
res = asyncio.run(resolver.query('www.baidu.com', types.A))
print(res)
Routing
ProxyResolver supports routing based on domains:
resolver = ProxyResolver(proxies=[
('*.lan', ['192.168.1.1']), # query 'udp://192.168.1.1:53' for '*.lan' domains
(lambda d: d.endswith('.local'), ['tcp://127.0.0.1']), # query tcp://127.0.0.1:53 for domains ending with '.local'
'8.8.8.8', # equivalent to (None, ['8.8.8.8']), matches all others
])
Queries
Both resolver.query(fqdn, qtype=ANY, timeout=3.0, tick=5)
and resolver.query_safe(fqdn, qtype=ANY, timeout=3.0, tick=5)
do queries for domain names. The only difference is that query_safe
returns None
if there is an exception, while query
always raises the exception.
DoH support
This library contains a simple implementation of DoH (aka DNS over HTTPS) client with partial HTTP protocol implemented.
If you need a more powerful DoH client based on aiohttp, or a DoH server, consider async-doh.
Test
$ python3 -m unittest
References
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for async_dns-1.1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f80c043c4400e6f019e3d18ab63fd3444ad919c48388623f7371fae8680a8c5 |
|
MD5 | 25f5df5b5b43892a425a704294d77ac6 |
|
BLAKE2b-256 | 65627ab83c9c10d370e56b4ecdbbfcd0b0aa4f242fb59a5c16640a3a06287112 |