Python bindings for libknot
Project description
Libknot API in Python
A Python interface for managing the Knot DNS daemon.
Table of contents
Introduction
If the shared libknot.so library isn't available in the library search path, it's
necessary to load the library first, e.g.:
import libknot
libknot.Knot("/usr/lib/libknot.so")
Control module
Using this module it's possible to create scripts for efficient tasks that
would require complex shell scripts with multiple calls of knotc. For
communication with the daemon it uses the same mechanism as the knotc utility,
i.e. communication via a Unix socket.
The module API is stored in libknot.control.
Control usage
The module usage consists of several steps:
- Initialization and connection to the daemon control socket.
- One or more control operations. An operation is called by sending a command with optional data to the daemon. The operation result has to be received afterwards.
- Closing the connection and deinitialization.
Control examples
import json
import libknot.control
# Initialization
ctl = libknot.control.KnotCtl()
ctl.connect("/var/run/knot/knot.sock")
ctl.set_timeout(60)
try:
# Operation without parameters
ctl.send_block(cmd="conf-begin")
resp = ctl.receive_block()
# Operation with parameters
ctl.send_block(cmd="conf-set", section="zone", item="domain", data="test")
resp = ctl.receive_block()
ctl.send_block(cmd="conf-commit")
resp = ctl.receive_block()
# Operation with a result displayed in JSON format
ctl.send_block(cmd="conf-read", section="zone", item="domain")
resp = ctl.receive_block()
print(json.dumps(resp, indent=4))
except libknot.control.KnotCtlError as exc:
# Print libknot error
print(exc)
finally:
# Deinitialization
ctl.send(libknot.control.KnotCtlType.END)
ctl.close()
# List configured zones (including catalog member ones)
ctl.send_block(cmd="conf-list", filters="z")
resp = ctl.receive_block()
for zone in resp['zone']:
print(zone)
# Print expirations as unixtime for all secondary zones
ctl.send_block(cmd="zone-status", filters="u")
resp = ctl.receive_block()
for zone in resp:
if resp[zone]["role"] == "master":
continue
expiration = resp[zone]["expiration"]
if expiration == "-":
print("Zone %s not loaded" % zone)
else:
print("Zone %s expires at %s" % (zone, resp[zone]["expiration"]))
Probe module
Using this module it's possible to receive traffic data from a running daemon with active probe module.
The module API is stored in libknot.probe.
Probe usage
The module usage consists of several steps:
- Initialization of one or more probe channels
- Periodical receiving of data units from the channels and data processing
Probe examples
import libknot.probe
# Initialization of the first probe channel stored in `/run/knot`
probe = libknot.probe.KnotProbe("/run/knot", 1)
# Array for storing up to 8 data units
data = libknot.probe.KnotProbeDataArray(8)
while (True):
# Receiving data units with timeout of 1000 ms
if probe.consume(data, 1000) > 0:
# Printing received data units in the default format
for item in data:
print(item)
Dname module
This module provides a few dname-related operations.
The module API is stored in libknot.dname.
Dname usage
The dname object is initialized from a string with textual dname. Then the dname can be reformatted to wire format or back to textual format.
Dname examples
import libknot.dname
dname1 = libknot.dname.KnotDname("knot-dns.cz")
print("%s: wire: %s size: %u" % (dname1.str(), dname1.wire(), dname1.size()))
dname2 = libknot.dname.KnotDname("e\\120ample.c\om.")
print("%s: wire: %s size: %u" % (dname2.str(), dname2.wire(), dname2.size()))
dname3 = libknot.dname.KnotDname(dname_wire=b'\x02cz\x00')
print("%s: wire: %s size: %u" % (dname3.str(), dname3.wire(), dname3.size()))
knot-dns.cz.: wire: b'\x08knot-dns\x02cz\x00' size: 13
example.com.: wire: b'\x07example\x03com\x00' size: 13
cz.: wire: b'\x02cz\x00' size: 4
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
File details
Details for the file libknot-3.4.2.tar.gz.
File metadata
- Download URL: libknot-3.4.2.tar.gz
- Upload date:
- Size: 11.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a727605137421ec6b625ef307e24ef2b45a65d47b3e4963518d3cb340cd1c2d7 |
|
| MD5 | 9c1e60ac3545671d544024e01f6f0836 |
|
| BLAKE2b-256 | 5f57166490d769503e07cfe5829596c39bed0a2cc4f8cc5d5f4243cd697f56de |
