Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmachard/python-unbound-console
python client for unbound server
https://github.com/dmachard/python-unbound-console
client console dns remote-control unbound
Last synced: 3 days ago
JSON representation
python client for unbound server
- Host: GitHub
- URL: https://github.com/dmachard/python-unbound-console
- Owner: dmachard
- License: mit
- Created: 2020-09-27T13:18:57.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-10T08:42:20.000Z (5 days ago)
- Last Synced: 2024-11-10T09:28:27.606Z (5 days ago)
- Topics: client, console, dns, remote-control, unbound
- Language: Python
- Homepage:
- Size: 148 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
  
# Python console for unbound server
## Table of contents
* [Installation](#installation)
* [Remote Control on Unbound](#remote-control-on-unbound)
* [Execute command](#execute-command)
* [Loading zone from YAML file](#loading-zone-from-yaml-file)
* [Loading zone from "LocalZone" object](#loading-zone-from-localzone-object)
* [Execute bulk command](#execute-bulk-command)
## Installation
  
This module can be installed from [pypi](https://pypi.org/project/unbound_console/) website.
This command will install the module with yaml support for loading zone data.
```python
pip install unbound_console[yaml]
```
If loading a zone using yaml is not required use the following command, zone data can instead be loaded through the `LocalZone` object:
```python
pip install unbound_console
```
## Remote Control on Unbound
   
Before to use this utility. You must activate the remote control on your unbound server.
See [config file](https://github.com/dmachard/python-unbound-console/blob/master/testsdata/unbound_tls.conf) example.
### Execute command
You can execute commands with the function `send_command`. See [nlnetlabs documentations](https://www.nlnetlabs.nl/documentation/unbound/unbound-control/) for the full list of available commands.
- Import the module in your code
```python
from unbound_console import RemoteControl
```
> An asyncio implementation is available, use `RemoteControlAsync` instead.
- Configure the remote control client with tls support. You can also provide a unix socket `unix_sock="/var/run/unbound-console.sock"`.
```python
rc = RemoteControl(host="127.0.0.1", port=8953,
server_cert = "/etc/unbound/unbound_server.pem",
client_cert= "/etc/unbound/unbound_control.pem",
client_key= "/etc/unbound/unbound_control.key")
```
- Execute a command and get output
```python
o = rc.send_command(cmd="status")
print(o)
```
### Loading zone from YAML file
YAML zone definition example:
> This requires installing unbound_console with yaml support
```
zone:
name: home.
type: static
records:
- "router.home. 86400 IN A 192.168.0.1"
- "192.168.0.1 86400 IN PTR router.test."
```
Call `load_zone` with the yaml file to load-it in your unbound server.
```python
o = rc.load_zone(zone_data='')
print(o)
```
### Loading zone from "LocalZone" object
Example loading from a `LocalZone` object:
```python
from unbound_console import LocalZone
zone = LocalZone(
name="home",
type="static",
records=[
"router.home. 86400 IN A 192.168.0.1",
"192.168.0.1 86400 IN PTR router.test.",
],
)
o = rc.load_zone(zone_data=zone)
print(o)
```
### Execute bulk command
```python
domains_bulk = []
domains_bulk.append( "www.google.com always_nxdomain")
o = rc.send_command(cmd="local_zones", data_list=domains_bulk)
print(o)
```