Skip to content

Commit

Permalink
Version 3.9.5
Browse files Browse the repository at this point in the history
  • Loading branch information
@adferrand
adferrand committed Apr 18, 2022
1 parent dec5ea5 commit 4f67d56
Show file tree
Hide file tree
Showing 6 changed files with 111 additions and 83 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Changelog

## master - CURRENT

## 3.9.5 - 18/04/2022
### Added
* Add `misaka` provider (#1205 #556)

Expand Down
4 changes: 3 additions & 1 deletion lexicon/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ def __init__(
domain_extractor = tldextract.TLDExtract(
cache_file=_get_tldextract_cache_path(), include_psl_private_domains=True # type: ignore
)
domain_parts = domain_extractor(cast(str, self.config.resolve("lexicon:domain")))
domain_parts = domain_extractor(
cast(str, self.config.resolve("lexicon:domain"))
)
runtime_config["domain"] = f"{domain_parts.domain}.{domain_parts.suffix}"

delegated = self.config.resolve("lexicon:delegated")
Expand Down
161 changes: 88 additions & 73 deletions lexicon/providers/misaka.py
View file
Original file line number Diff line number Diff line change
@@ -1,57 +1,65 @@
"""Module provider for Misaka.IO"""
from __future__ import absolute_import

import base64
import json
import logging
from typing import Tuple

import requests
from lexicon.providers.base import Provider as BaseProvider

from lexicon.providers.base import Provider as BaseProvider

LOGGER = logging.getLogger(__name__)

NAMESERVER_DOMAINS = [
# gTLDs
'm1ns.com', 'm1ns.net', 'm1ns.org',
"m1ns.com",
"m1ns.net",
"m1ns.org",
# new gTLDs
'm1ns.one', 'm1ns.moe', 'm1ns.xyz',
'm1ns.fyi', 'm1ns.app',
"m1ns.one",
"m1ns.moe",
"m1ns.xyz",
"m1ns.fyi",
"m1ns.app",
# ccTLDs
'm1ns.be', 'm1ns.io', 'm1ns.uk',
'm1ns.us', 'm1ns.im',

"m1ns.be",
"m1ns.io",
"m1ns.uk",
"m1ns.us",
"m1ns.im",
# for PTR zones only
'reversedns.org',
"reversedns.org",
# legacy domains
'ns53.net',
"ns53.net",
]


def _recordset_has_record(record_set, value):
for record in record_set['records']:
if record['value'] == value:
for record in record_set["records"]:
if record["value"] == value:
return True
return False


def provider_parser(subparser):
"""Configure provider parser for Misaka.IO"""
subparser.add_argument(
"--auth-token", help="specify token for authentication")
subparser.add_argument("--auth-token", help="specify token for authentication")


class Provider(BaseProvider):
"""Provider class for Misaka.IO"""

def __init__(self, config):
super(Provider, self).__init__(config)
self.domain_id = None
self.api_endpoint = 'https://api.misaka.io/dns'
self.api_endpoint = "https://api.misaka.io/dns"

def _authenticate(self):
payload = self._get(f'/zones/{self.domain}/settings')
if not payload['id']:
raise Exception('No domain found')
payload = self._get(f"/zones/{self.domain}/settings")
if not payload["id"]:
raise Exception("No domain found")

self.domain_id = self.domain

Expand All @@ -60,65 +68,65 @@ def _create_record(self, rtype, name, content):
name = self._relative_name(name)

identifier = self._identifier_encode(rtype, name)
endpoint = f'/zones/{self.domain_id}/recordsets/{name}/{rtype}'
ttl = self._get_lexicon_option('ttl')
record = {'value': content}
endpoint = f"/zones/{self.domain_id}/recordsets/{name}/{rtype}"
ttl = self._get_lexicon_option("ttl")
record = {"value": content}

existing_recordset = self._get_recordset(name, rtype)
if existing_recordset:
# append if returned recordsets doesn't include the record
if not _recordset_has_record(existing_recordset, content):
existing_recordset['records'].append(record)
existing_recordset['ttl'] = ttl
existing_recordset["records"].append(record)
existing_recordset["ttl"] = ttl
self._put(endpoint, existing_recordset)
LOGGER.debug('recordset exists, appending: %s', identifier)
LOGGER.debug("recordset exists, appending: %s", identifier)
# update ttl if returned ttl doesn't match
elif existing_recordset['ttl'] != ttl:
existing_recordset['ttl'] = ttl
elif existing_recordset["ttl"] != ttl:
existing_recordset["ttl"] = ttl
self._put(endpoint, existing_recordset)
LOGGER.debug('recordset exists, updating ttl: %s', identifier)
LOGGER.debug("recordset exists, updating ttl: %s", identifier)
else:
recordset = {
'ttl': ttl,
'filters': [],
'records': [record],
"ttl": ttl,
"filters": [],
"records": [record],
}
self._post(endpoint, recordset)
LOGGER.debug('create_record: %s', identifier)
LOGGER.debug("create_record: %s", identifier)

return True

def _list_records(self, rtype=None, name=None, content=None):
params = {}
if name:
name = self._relative_name(name)
params['name'] = name
params["name"] = name

payload = self._get(f'/zones/{self.domain_id}/recordsets', query_params=params)
payload = self._get(f"/zones/{self.domain_id}/recordsets", query_params=params)
records = []
for recordset in payload['results']:
if not recordset['records']:
for recordset in payload["results"]:
if not recordset["records"]:
continue

if name and recordset['name'] != name:
if name and recordset["name"] != name:
continue

if rtype and recordset['type'] != rtype:
if rtype and recordset["type"] != rtype:
continue

processed_recordset = {
'name': self._full_name(recordset['name']),
'type': recordset['type'],
'ttl': recordset['ttl'],
'id': self._identifier_encode(recordset["type"], recordset["name"]),
"name": self._full_name(recordset["name"]),
"type": recordset["type"],
"ttl": recordset["ttl"],
"id": self._identifier_encode(recordset["type"], recordset["name"]),
}

for record in recordset['records']:
processed_record = {'content': record['value']}
for record in recordset["records"]:
processed_record = {"content": record["value"]}
processed_record.update(processed_recordset)
records.append(processed_record)

LOGGER.debug('list_records: %s', records)
LOGGER.debug("list_records: %s", records)
return records

# Create or update a record.
Expand All @@ -129,28 +137,31 @@ def _update_record(self, identifier, rtype=None, name=None, content=None):

new_identifier = self._identifier_encode(rtype, name)

if (new_identifier == identifier or (rtype is None and name is None)):
if new_identifier == identifier or (rtype is None and name is None):
# the identifier hasn't changed, or type and name are both unspecified,
# only update the content.
data = {
'records': {"value": content}
}
data = {"records": {"value": content}}
target_rtype, target_name = self._identifier_decode(identifier)
self._put(f'/zones/{self.domain_id}/recordsets/{target_name}/{target_rtype}', data)
self._put(
f"/zones/{self.domain_id}/recordsets/{target_name}/{target_rtype}", data
)
else:
if not identifier:
identifier = new_identifier
# identifiers are different
# get the old record, create a new one with updated data, delete the old record.
target_rtype, target_name = self._identifier_decode(identifier)
old_record = self._get(f'/zones/{self.domain_id}/recordsets/{target_name}/{target_rtype}')
old_record = self._get(
f"/zones/{self.domain_id}/recordsets/{target_name}/{target_rtype}"
)
self.create_record(
rtype or old_record['type'],
name or old_record['domain'],
content or old_record['records'][0]['value'])
rtype or old_record["type"],
name or old_record["domain"],
content or old_record["records"][0]["value"],
)
self.delete_record(identifier)

LOGGER.debug('update_record: %s', True)
LOGGER.debug("update_record: %s", True)
return True

# Delete an existing record.
Expand All @@ -160,13 +171,15 @@ def _delete_record(self, identifier=None, rtype=None, name=None, content=None):
if name:
name = self._relative_name(name)
identifier = self._identifier_encode(rtype, name)
should_call_delete_api = not self._delete_record_with_identifier(identifier, rtype, name, content)
should_call_delete_api = not self._delete_record_with_identifier(
identifier, rtype, name, content
)

if should_call_delete_api:
rtype, name = self._identifier_decode(identifier)
self._delete(f'/zones/{self.domain_id}/recordsets/{name}/{rtype}')
self._delete(f"/zones/{self.domain_id}/recordsets/{name}/{rtype}")

LOGGER.debug('delete_record: %s', True)
LOGGER.debug("delete_record: %s", True)
return True

# Delete an existing record if identifier isn't None.
Expand All @@ -179,56 +192,56 @@ def _delete_record_with_identifier(self, identifier, rtype, name, content):
# remove corresponding record only if content isn't None
if not content:
return False
recordset['records'] = [
record for record in recordset['records']
if record['value'] != content
recordset["records"] = [
record for record in recordset["records"] if record["value"] != content
]

if not recordset['records']:
if not recordset["records"]:
return False

rtype, name = self._identifier_decode(identifier)
self._put(f'/zones/{self.domain_id}/recordsets/{name}/{rtype}', recordset)
self._put(f"/zones/{self.domain_id}/recordsets/{name}/{rtype}", recordset)
return True

# Helpers
def _request(self, action='GET', url='/', data=None, query_params=None):
def _request(self, action="GET", url="/", data=None, query_params=None):
# set defaults
data = {} if data is None else data
query_params = {} if query_params is None else query_params

token = self._get_provider_option('auth_token')
token = self._get_provider_option("auth_token")

default_headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': f'Token {token}'
"Accept": "application/json",
"Content-Type": "application/json",
"Authorization": f"Token {token}",
}
default_auth = None

response = requests.request(
action, self.api_endpoint + url,
action,
self.api_endpoint + url,
params=query_params,
data=json.dumps(data),
headers=default_headers,
auth=default_auth
auth=default_auth,
)
# if the request fails for any reason, throw an error.
response.raise_for_status()
return response.json()

def _get_recordset(self, name, rtype):
try:
payload = self._get(f'/zones/{self.domain_id}/recordsets/{name}/{rtype}')
payload = self._get(f"/zones/{self.domain_id}/recordsets/{name}/{rtype}")
except requests.exceptions.HTTPError as error:
if error.response.status_code == 404:
return None
raise

return {
'ttl': payload['ttl'],
'records': payload['records'],
'filters': payload['filters'],
"ttl": payload["ttl"],
"records": payload["records"],
"filters": payload["filters"],
}

def _identifier_decode(self, identifier: str) -> Tuple[str, str]:
Expand All @@ -243,5 +256,7 @@ def _identifier_decode(self, identifier: str) -> Tuple[str, str]:
return extracted[0], extracted[1]

def _identifier_encode(self, rtype: str, name: str) -> str:
encoded = base64.urlsafe_b64encode(f"{rtype}/{self._relative_name(name)}".encode("utf-8"))
encoded = base64.urlsafe_b64encode(
f"{rtype}/{self._relative_name(name)}".encode("utf-8")
)
return encoded.decode("utf-8").rstrip("=")
16 changes: 10 additions & 6 deletions lexicon/providers/yandex.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,17 +72,21 @@ def _list_records(self, rtype=None, name=None, content=None):
next_url = None

for record in payload["records"]:
if record["type"] == 'MX':
if record["type"] == "MX":
assembled_content = f"{record['priority']} {record['content']}"
if record["type"] == 'SRV':
if 'target' in record:
srv_target = record['target']
if record["type"] == "SRV":
if "target" in record:
srv_target = record["target"]
else:
srv_target = record['content']
srv_target = record["content"]
assembled_content = f"{record['priority']} {record['weight']} {record['port']} {srv_target}"
else:
assembled_content = record.get("content")
record_name = f"{record['subdomain']}.{self.domain_id}" if record['subdomain'] != '@' else self.domain_id
record_name = (
f"{record['subdomain']}.{self.domain_id}"
if record["subdomain"] != "@"
else self.domain_id
)
processed_record = {
"type": record["type"],
"name": record_name,
Expand Down
9 changes: 7 additions & 2 deletions lexicon/tests/providers/test_misaka.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ class MisakaProviderTests(TestCase, IntegrationTestsV2):

def _filter_headers(self):
return [
"Authorization", "Set-Cookie",
"X-Misaka-Debug", "X-Request-Id", "X-Served-By", "CF-RAY", "cf-request-id",
"Authorization",
"Set-Cookie",
"X-Misaka-Debug",
"X-Request-Id",
"X-Served-By",
"CF-RAY",
"cf-request-id",
]
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "dns-lexicon"
version = "3.9.4"
version = "3.9.5"
description = "Manipulate DNS records on various DNS providers in a standardized/agnostic way"
license = "MIT"
keywords = [
Expand Down

0 comments on commit 4f67d56

Please sign in to comment.