# -*- coding: utf-8 -*-
#
# Copyright 2004-2022 Univention GmbH
#
# https://www.univention.de/
#
# All rights reserved.
#
# The source code of this program is made available
# under the terms of the GNU Affero General Public License version 3
# (GNU AGPL V3) as published by the Free Software Foundation.
#
# Binary versions of this program provided by Univention to you as
# well as other copyrighted, protected or trademarked materials like
# Logos, graphics, fonts, specific documentations and configurations,
# cryptographic keys etc. are subject to a license agreement between
# you and Univention and not subject to the GNU AGPL V3.
#
# In the case you use this program under the terms of the GNU AGPL V3,
# the program is provided in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public
# License with the Debian GNU/Linux or Univention distribution in file
# /usr/share/common-licenses/AGPL-3; if not, see
# <https://www.gnu.org/licenses/>.
"""
|UDM| module for |DNS| forward zones
"""
import ipaddress
from univention.admin.layout import Tab, Group
from univention.admin import configRegistry
import univention.admin.filter
import univention.admin.handlers
import univention.admin.localization
from univention.admin.handlers.dns import ARPA_IP4, ARPA_IP6, escapeSOAemail, unescapeSOAemail, stripDot
translation = univention.admin.localization.translation('univention.admin.handlers.dns')
_ = translation.translate
module = 'dns/forward_zone'
operations = ['add', 'edit', 'remove', 'search']
columns = ['nameserver', 'a', 'mx', 'txt']
childs = True
childmodules = ['dns/alias', 'dns/host_record', 'dns/srv_record', 'dns/txt_record', 'dns/ns_record']
short_description = _('DNS: Forward lookup zone')
object_name = _('Forward lookup zone')
object_name_plural = _('Forward lookup zones')
long_description = _('Map names to IP addresses (and other data).')
options = {
'default': univention.admin.option(
short_description=short_description,
default=True,
objectClasses=['top', 'dNSZone'],
),
}
property_descriptions = {
'zone': univention.admin.property(
short_description=_('Zone name'),
long_description=_('The name of the domain.'),
syntax=univention.admin.syntax.dnsName,
include_in_default_search=True,
required=True,
may_change=False,
identifies=True
),
'zonettl': univention.admin.property(
short_description=_('Zone time to live'),
long_description=_('The time this entry may be cached.'),
syntax=univention.admin.syntax.UNIX_TimeInterval,
required=True,
default=(('3', 'hours'), []),
dontsearch=True,
),
'contact': univention.admin.property(
short_description=_('Contact person'),
long_description=_('The email address of the person responsible for this zone.'),
syntax=univention.admin.syntax.emailAddress,
required=True,
default=('root@%s' % configRegistry.get('domainname'), []),
),
'serial': univention.admin.property(
short_description=_('Serial number'),
long_description=_('The sequence number for this zone. Updates automatically.'),
syntax=univention.admin.syntax.integer,
required=True,
default=('1', [])
),
'refresh': univention.admin.property(
short_description=_('Refresh interval'),
long_description=_('The time interval secondary DNS servers use to check the zone for updates.'),
syntax=univention.admin.syntax.UNIX_TimeInterval,
required=True,
default=(('8', 'hours'), [])
),
'retry': univention.admin.property(
short_description=_('Retry interval'),
long_description=_('The time interval secondary DNS servers use to retry failed refresh updates.'),
syntax=univention.admin.syntax.UNIX_TimeInterval,
required=True,
default=(('2', 'hours'), [])
),
'expire': univention.admin.property(
short_description=_('Expiry interval'),
long_description=_('The time interval after which secondary DNS servers will expire failed zones.'),
syntax=univention.admin.syntax.UNIX_TimeInterval,
required=True,
default=(('7', 'days'), [])
),
'ttl': univention.admin.property(
short_description=_('Negative time to live'),
long_description=_('The time interval "not found" answers are cached.'),
syntax=univention.admin.syntax.UNIX_TimeInterval,
required=True,
default=(('3', 'hours'), [])
),
'nameserver': univention.admin.property(
short_description=_('Name server'),
long_description=_('The FQDNs of the servers serving this zone.'),
syntax=univention.admin.syntax.dnsHostname,
multivalue=True,
required=True,
),
'mx': univention.admin.property(
short_description=_('Mail exchanger host'),
long_description=_('The FQDNs of the hosts responsible for receiving mail for this DNS name.'),
syntax=univention.admin.syntax.dnsMX,
multivalue=True,
),
'txt': univention.admin.property(
short_description=_('Text Record'),
long_description=_('One or more arbitrary text strings.'),
syntax=univention.admin.syntax.string,
multivalue=True,
),
'a': univention.admin.property(
short_description=_('IP addresses'),
long_description=_('One or more IP addresses, to which the name is resolved to.'),
syntax=univention.admin.syntax.ipAddress,
multivalue=True,
),
}
layout = [
Tab(_('General'), _('Basic settings'), layout=[
Group(_('General forward lookup zone settings'), layout=[
'zone',
'nameserver',
'zonettl'
]),
]),
Tab(_('Start of authority'), _('Primary name server information'), layout=[
Group(_('Start of authority'), layout=[
'contact',
'serial',
['refresh', 'retry'],
['expire', 'ttl']
]),
]),
Tab(_('IP addresses'), _('IP addresses of the zone'), layout=[
Group(_('IP addresses of the zone'), layout=[
'a'
]),
]),
Tab(_('MX records'), _('Mail exchanger records'), layout=[
Group(_('MX records'), layout=[
'mx'
]),
]),
Tab(_('TXT records'), _('Text records'), layout=[
Group(_('TXT records'), layout=[
'txt'
]),
]),
]
[docs]def mapMX(old, encoding=()):
return [u' '.join(entry).encode(*encoding) for entry in old]
[docs]def unmapMX(old, encoding=()):
return [entry.decode(*encoding).split(u' ', 1) for entry in old]
mapping = univention.admin.mapping.mapping()
mapping.register('zone', 'zoneName', stripDot, univention.admin.mapping.ListToString, encoding='ASCII')
mapping.register('nameserver', 'nSRecord', encoding='ASCII')
mapping.register('zonettl', 'dNSTTL', univention.admin.mapping.mapUNIX_TimeInterval, univention.admin.mapping.unmapUNIX_TimeInterval)
mapping.register('mx', 'mXRecord', mapMX, unmapMX, encoding='ASCII')
mapping.register('txt', 'tXTRecord', encoding='ASCII')
[docs]class object(univention.admin.handlers.simpleLdap):
module = module
def __init__(self, co, lo, position, dn='', superordinate=None, attributes=[]):
univention.admin.handlers.simpleLdap.__init__(self, co, lo, position, dn, superordinate, attributes=attributes)
if not self.dn and not self.position:
raise univention.admin.uexceptions.insufficientInformation(_('Neither DN nor position given.'))
def _post_unmap(self, info, values):
info = super(object, self)._post_unmap(info, values)
info['a'] = []
if 'aRecord' in values:
info['a'].extend([x.decode('ASCII') for x in values['aRecord']])
if 'aAAARecord' in values:
info['a'].extend([ipaddress.IPv6Address(x.decode('ASCII')).exploded for x in values['aAAARecord']])
return info
[docs] def open(self):
univention.admin.handlers.simpleLdap.open(self)
soa = self.oldattr.get('sOARecord', [b''])[0].split(b' ')
if len(soa) > 6:
self['contact'] = unescapeSOAemail(soa[1].decode('ASCII'))
self['serial'] = soa[2].decode('ASCII')
self['refresh'] = univention.admin.mapping.unmapUNIX_TimeInterval(soa[3])
self['retry'] = univention.admin.mapping.unmapUNIX_TimeInterval(soa[4])
self['expire'] = univention.admin.mapping.unmapUNIX_TimeInterval(soa[5])
self['ttl'] = univention.admin.mapping.unmapUNIX_TimeInterval(soa[6])
self.save()
def _ldap_addlist(self):
return super(object, self)._ldap_addlist() + [
('relativeDomainName', [b'@'])
]
def _ldap_modlist(self):
ml = univention.admin.handlers.simpleLdap._ldap_modlist(self)
if self.hasChanged(['nameserver', 'contact', 'serial', 'refresh', 'retry', 'expire', 'ttl']):
if self['contact'] and not self['contact'].endswith('.'):
self['contact'] += '.'
for i in range(0, len(self['nameserver'])):
if len(self['nameserver'][i]) > 0 \
and ':' not in self['nameserver'][i] \
and '.' in self['nameserver'][i] \
and not self['nameserver'][i].endswith('.'):
self['nameserver'][i] += '.'
refresh = univention.admin.mapping.mapUNIX_TimeInterval(self['refresh'])
retry = univention.admin.mapping.mapUNIX_TimeInterval(self['retry'])
expire = univention.admin.mapping.mapUNIX_TimeInterval(self['expire'])
ttl = univention.admin.mapping.mapUNIX_TimeInterval(self['ttl'])
soa = b'%s %s %s %s %s %s %s' % (self['nameserver'][0].encode('ASCII'), escapeSOAemail(self['contact']).encode('ASCII'), self['serial'].encode('ASCII'), refresh, retry, expire, ttl)
ml.append(('sOARecord', self.oldattr.get('sOARecord', []), [soa]))
oldAddresses = self.oldinfo.get('a')
newAddresses = self.info.get('a')
oldARecord = []
newARecord = []
oldAaaaRecord = []
newAaaaRecord = []
if oldAddresses != newAddresses:
if oldAddresses:
for address in oldAddresses:
if ':' in address: # IPv6
oldAaaaRecord.append(address.encode('ASCII'))
else:
oldARecord.append(address.encode('ASCII'))
if newAddresses:
for address in newAddresses:
if ':' in address: # IPv6
newAaaaRecord.append(ipaddress.IPv6Address(u'%s' % (address,)).exploded.encode('ASCII'))
else:
newARecord.append(address.encode('ASCII'))
ml.append(('aRecord', oldARecord, newARecord, ))
ml.append(('aAAARecord', oldAaaaRecord, newAaaaRecord, ))
return ml
def _ldap_pre_modify(self):
super(object, self)._ldap_pre_modify()
# update SOA record
if not self.hasChanged('serial'):
self['serial'] = str(int(self['serial']) + 1)
[docs] @classmethod
def unmapped_lookup_filter(cls):
return univention.admin.filter.conjunction('&', [
univention.admin.filter.expression('objectClass', 'dNSZone'),
univention.admin.filter.expression('relativeDomainName', '@'),
univention.admin.filter.conjunction('!', [univention.admin.filter.expression('zoneName', '*%s' % ARPA_IP4, escape=False)]),
univention.admin.filter.conjunction('!', [univention.admin.filter.expression('zoneName', '*%s' % ARPA_IP6, escape=False)]),
])
lookup = object.lookup
lookup_filter = object.lookup_filter
[docs]def identify(dn, attr, canonical=False):
return b'dNSZone' in attr.get('objectClass', []) and [b'@'] == attr.get('relativeDomainName', []) and not attr['zoneName'][0].decode('ASCII').endswith(ARPA_IP4) and not attr['zoneName'][0].decode('ASCII').endswith(ARPA_IP6)
