fixed author and formatting
This commit is contained in:
Matthias Bilger
@@ -20,7 +20,7 @@ class Authenticator(dns_common.DNSAuthenticator):
|
||||
This Authenticator uses the ISPConfig Remote REST API to fulfill a dns-01 challenge.
|
||||
"""
|
||||
|
||||
description = ('Obtain certificates using a DNS TXT record (if you are using ISPConfig for DNS).')
|
||||
description = "Obtain certificates using a DNS TXT record (if you are using ISPConfig for DNS)."
|
||||
ttl = 60
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
@@ -29,32 +29,44 @@ class Authenticator(dns_common.DNSAuthenticator):
|
||||
|
||||
@classmethod
|
||||
def add_parser_arguments(cls, add): # pylint: disable=arguments-differ
|
||||
super(Authenticator, cls).add_parser_arguments(add, default_propagation_seconds=120)
|
||||
add('credentials', help='ISPConfig credentials INI file.')
|
||||
super(Authenticator, cls).add_parser_arguments(
|
||||
add, default_propagation_seconds=120
|
||||
)
|
||||
add("credentials", help="ISPConfig credentials INI file.")
|
||||
|
||||
def more_info(self): # pylint: disable=missing-docstring,no-self-use
|
||||
return 'This plugin configures a DNS TXT record to respond to a dns-01 challenge using ' + \
|
||||
'the ISPConfig Remote REST API.'
|
||||
def more_info(self): # pylint: disable=missing-docstring,no-self-use
|
||||
return (
|
||||
"This plugin configures a DNS TXT record to respond to a dns-01 challenge using "
|
||||
+ "the ISPConfig Remote REST API."
|
||||
)
|
||||
|
||||
def _setup_credentials(self):
|
||||
self.credentials = self._configure_credentials(
|
||||
'credentials',
|
||||
'ISPConfig credentials INI file',
|
||||
"credentials",
|
||||
"ISPConfig credentials INI file",
|
||||
{
|
||||
'endpoint': 'URL of the ISPConfig Remote API.',
|
||||
'username': 'Username for ISPConfig Remote API.',
|
||||
'password': 'Password for ISPConfig Remote API.'
|
||||
}
|
||||
"endpoint": "URL of the ISPConfig Remote API.",
|
||||
"username": "Username for ISPConfig Remote API.",
|
||||
"password": "Password for ISPConfig Remote API.",
|
||||
},
|
||||
)
|
||||
|
||||
def _perform(self, domain, validation_name, validation):
|
||||
self._get_ispconfig_client().add_txt_record(domain, validation_name, validation, self.ttl)
|
||||
self._get_ispconfig_client().add_txt_record(
|
||||
domain, validation_name, validation, self.ttl
|
||||
)
|
||||
|
||||
def _cleanup(self, domain, validation_name, validation):
|
||||
self._get_ispconfig_client().del_txt_record(domain, validation_name, validation, self.ttl)
|
||||
self._get_ispconfig_client().del_txt_record(
|
||||
domain, validation_name, validation, self.ttl
|
||||
)
|
||||
|
||||
def _get_ispconfig_client(self):
|
||||
return _ISPConfigClient(self.credentials.conf('endpoint'), self.credentials.conf('username'), self.credentials.conf('password'))
|
||||
return _ISPConfigClient(
|
||||
self.credentials.conf("endpoint"),
|
||||
self.credentials.conf("username"),
|
||||
self.credentials.conf("password"),
|
||||
)
|
||||
|
||||
|
||||
class _ISPConfigClient(object):
|
||||
@@ -63,7 +75,7 @@ class _ISPConfigClient(object):
|
||||
"""
|
||||
|
||||
def __init__(self, endpoint, username, password):
|
||||
logger.debug('creating ispconfigclient')
|
||||
logger.debug("creating ispconfigclient")
|
||||
self.endpoint = endpoint
|
||||
self.username = username
|
||||
self.password = password
|
||||
@@ -73,39 +85,42 @@ class _ISPConfigClient(object):
|
||||
def _login(self):
|
||||
if self.session_id is not None:
|
||||
return
|
||||
logger.debug('logging in')
|
||||
logindata = {'username': self.username, 'password':self.password}
|
||||
self.session_id = self._api_request('login', logindata)
|
||||
logger.debug('session id is %s', self.session_id)
|
||||
logger.debug("logging in")
|
||||
logindata = {"username": self.username, "password": self.password}
|
||||
self.session_id = self._api_request("login", logindata)
|
||||
logger.debug("session id is %s", self.session_id)
|
||||
|
||||
def _api_request(self, action, data):
|
||||
if self.session_id is not None:
|
||||
data['session_id'] = self.session_id
|
||||
data["session_id"] = self.session_id
|
||||
url = self._get_url(action)
|
||||
resp = self.session.get(
|
||||
url,
|
||||
json=data
|
||||
)
|
||||
logger.debug('API REquest to URL: %s', url)
|
||||
resp = self.session.get(url, json=data)
|
||||
logger.debug("API REquest to URL: %s", url)
|
||||
if resp.status_code != 200:
|
||||
raise errors.PluginError('HTTP Error during login {0}'.format(resp.status_code))
|
||||
raise errors.PluginError(
|
||||
"HTTP Error during login {0}".format(resp.status_code)
|
||||
)
|
||||
try:
|
||||
result = resp.json()
|
||||
except:
|
||||
raise errors.PluginError('API response with non JSON: {0}'.format(resp.text))
|
||||
if (result['code'] == 'ok'):
|
||||
return result['response']
|
||||
elif (result['code'] == 'remote_fault'):
|
||||
raise errors.PluginError('API response with an error: {0}'.format(result['message']))
|
||||
raise errors.PluginError(
|
||||
"API response with non JSON: {0}".format(resp.text)
|
||||
)
|
||||
if result["code"] == "ok":
|
||||
return result["response"]
|
||||
elif result["code"] == "remote_fault":
|
||||
raise errors.PluginError(
|
||||
"API response with an error: {0}".format(result["message"])
|
||||
)
|
||||
else:
|
||||
raise errors.PluginError('API response unknown {0}'.format(resp.text))
|
||||
raise errors.PluginError("API response unknown {0}".format(resp.text))
|
||||
|
||||
def _get_url(self, action):
|
||||
return '{0}?{1}'.format(self.endpoint, action)
|
||||
return "{0}?{1}".format(self.endpoint, action)
|
||||
|
||||
def _get_server_id(self, zone_id):
|
||||
zone = self._api_request('dns_zone_get', {'primary_id': zone_id})
|
||||
return zone['server_id']
|
||||
zone = self._api_request("dns_zone_get", {"primary_id": zone_id})
|
||||
return zone["server_id"]
|
||||
|
||||
def add_txt_record(self, domain, record_name, record_content, record_ttl):
|
||||
"""
|
||||
@@ -121,20 +136,24 @@ class _ISPConfigClient(object):
|
||||
zone_id, zone_name = self._find_managed_zone_id(domain)
|
||||
if zone_id is None:
|
||||
raise errors.PluginError("Domain not known")
|
||||
logger.debug('domain found: %s with id: %s', zone_name, zone_id)
|
||||
logger.debug("domain found: %s with id: %s", zone_name, zone_id)
|
||||
o_record_name = record_name
|
||||
record_name = record_name.replace(zone_name, '')[:-1]
|
||||
logger.debug('using record_name: %s from original: %s', record_name, o_record_name)
|
||||
record_name = record_name.replace(zone_name, "")[:-1]
|
||||
logger.debug(
|
||||
"using record_name: %s from original: %s", record_name, o_record_name
|
||||
)
|
||||
record = self.get_existing_txt(zone_id, record_name, record_content)
|
||||
if record is not None:
|
||||
if record['data'] == record_content:
|
||||
logger.info('already there, id {0}'.format(record['id']))
|
||||
if record["data"] == record_content:
|
||||
logger.info("already there, id {0}".format(record["id"]))
|
||||
return
|
||||
else:
|
||||
logger.info('update {0}'.format(record['id']))
|
||||
self._update_txt_record(zone_id, record['id'], record_name, record_content, record_ttl)
|
||||
logger.info("update {0}".format(record["id"]))
|
||||
self._update_txt_record(
|
||||
zone_id, record["id"], record_name, record_content, record_ttl
|
||||
)
|
||||
else:
|
||||
logger.info('insert new txt record')
|
||||
logger.info("insert new txt record")
|
||||
self._insert_txt_record(zone_id, record_name, record_content, record_ttl)
|
||||
|
||||
def del_txt_record(self, domain, record_name, record_content, record_ttl):
|
||||
@@ -151,49 +170,53 @@ class _ISPConfigClient(object):
|
||||
zone_id, zone_name = self._find_managed_zone_id(domain)
|
||||
if zone_id is None:
|
||||
raise errors.PluginError("Domain not known")
|
||||
logger.debug('domain found: %s with id: %s', zone_name, zone_id)
|
||||
logger.debug("domain found: %s with id: %s", zone_name, zone_id)
|
||||
o_record_name = record_name
|
||||
record_name = record_name.replace(zone_name, '')[:-1]
|
||||
logger.debug('using record_name: %s from original: %s', record_name, o_record_name)
|
||||
record_name = record_name.replace(zone_name, "")[:-1]
|
||||
logger.debug(
|
||||
"using record_name: %s from original: %s", record_name, o_record_name
|
||||
)
|
||||
record = self.get_existing_txt(zone_id, record_name, record_content)
|
||||
if record is not None:
|
||||
if record['data'] == record_content:
|
||||
logger.debug('delete TXT record: %s', record['id'])
|
||||
self._delete_txt_record(record['id'])
|
||||
if record["data"] == record_content:
|
||||
logger.debug("delete TXT record: %s", record["id"])
|
||||
self._delete_txt_record(record["id"])
|
||||
|
||||
def _prepare_rr_data(self, zone_id, record_name, record_content, record_ttl):
|
||||
server_id = self._get_server_id(zone_id)
|
||||
data = {
|
||||
'client_id': None,
|
||||
'rr_type': 'TXT',
|
||||
'params':{
|
||||
'server_id': server_id,
|
||||
'name': record_name,
|
||||
'active': 'Y',
|
||||
'type': 'TXT',
|
||||
'data': record_content,
|
||||
'zone': zone_id,
|
||||
'ttl': record_ttl,
|
||||
'update_serial':False,
|
||||
"client_id": None,
|
||||
"rr_type": "TXT",
|
||||
"params": {
|
||||
"server_id": server_id,
|
||||
"name": record_name,
|
||||
"active": "Y",
|
||||
"type": "TXT",
|
||||
"data": record_content,
|
||||
"zone": zone_id,
|
||||
"ttl": record_ttl,
|
||||
"update_serial": False,
|
||||
},
|
||||
}
|
||||
return data
|
||||
|
||||
def _insert_txt_record(self, zone_id, record_name, record_content, record_ttl):
|
||||
data = self._prepare_rr_data(zone_id, record_name, record_content, record_ttl)
|
||||
logger.debug('insert with data: %s', data)
|
||||
result = self._api_request('dns_txt_add', data)
|
||||
logger.debug("insert with data: %s", data)
|
||||
result = self._api_request("dns_txt_add", data)
|
||||
|
||||
def _update_txt_record(self, zone_id, primary_id, record_name, record_content, record_ttl):
|
||||
def _update_txt_record(
|
||||
self, zone_id, primary_id, record_name, record_content, record_ttl
|
||||
):
|
||||
data = self._prepare_rr_data(zone_id, record_name, record_content, record_ttl)
|
||||
data['primary_id'] = primary_id
|
||||
logger.debug('update with data: %s', data)
|
||||
result = self._api_request('dns_txt_update', data)
|
||||
data["primary_id"] = primary_id
|
||||
logger.debug("update with data: %s", data)
|
||||
result = self._api_request("dns_txt_update", data)
|
||||
|
||||
def _delete_txt_record(self, primary_id):
|
||||
data = { 'primary_id': primary_id }
|
||||
logger.debug('delete with data: %s', data)
|
||||
result = self._api_request('dns_txt_delete', data)
|
||||
data = {"primary_id": primary_id}
|
||||
logger.debug("delete with data: %s", data)
|
||||
result = self._api_request("dns_txt_delete", data)
|
||||
|
||||
def _find_managed_zone_id(self, domain):
|
||||
"""
|
||||
@@ -208,10 +231,10 @@ class _ISPConfigClient(object):
|
||||
zone_dns_name_guesses = dns_common.base_domain_name_guesses(domain)
|
||||
|
||||
for zone_name in zone_dns_name_guesses:
|
||||
#get the zone id
|
||||
# get the zone id
|
||||
try:
|
||||
logger.debug('looking for zone: %s', zone_name)
|
||||
zone_id = self._api_request('dns_zone_get_id', {'origin': zone_name})
|
||||
logger.debug("looking for zone: %s", zone_name)
|
||||
zone_id = self._api_request("dns_zone_get_id", {"origin": zone_name})
|
||||
return zone_id, zone_name
|
||||
except errors.PluginError as e:
|
||||
pass
|
||||
@@ -232,9 +255,13 @@ class _ISPConfigClient(object):
|
||||
|
||||
"""
|
||||
self._login()
|
||||
read_zone_data = {'zone_id': zone_id}
|
||||
zone_data = self._api_request('dns_rr_get_all_by_zone', read_zone_data)
|
||||
read_zone_data = {"zone_id": zone_id}
|
||||
zone_data = self._api_request("dns_rr_get_all_by_zone", read_zone_data)
|
||||
for entry in zone_data:
|
||||
if entry['name'] == record_name and entry['type'] == 'TXT' and entry['data'] == record_content:
|
||||
if (
|
||||
entry["name"] == record_name
|
||||
and entry["type"] == "TXT"
|
||||
and entry["data"] == record_content
|
||||
):
|
||||
return entry
|
||||
return None
|
||||
|
||||
Reference in New Issue
Block a user