Browse Source

The record got field names from the DNSKEY record by accident, fix this

Basically changing from
https://www.rfc-editor.org/rfc/rfc4034.html#section-2.1 to https://www.rfc-editor.org/rfc/rfc4034.html#section-5.1

So:
flags -> key_tag
protocol -> algorithm
algorithm -> digest_type
public_key -> digest
pull/1065/head
Martin Frausing 2 years ago
parent
commit
43d380d76a
Failed to extract signature
2 changed files with 140 additions and 138 deletions
  1. +43
    -43
      octodns/record/ds.py
  2. +97
    -95
      tests/test_octodns_record_ds.py

+ 43
- 43
octodns/record/ds.py View File

@ -8,31 +8,31 @@ from .rr import RrParseError
class DsValue(EqualityTupleMixin, dict): class DsValue(EqualityTupleMixin, dict):
# https://www.rfc-editor.org/rfc/rfc4034.html#section-2.1
# https://www.rfc-editor.org/rfc/rfc4034.html#section-5.1
@classmethod @classmethod
def parse_rdata_text(cls, value): def parse_rdata_text(cls, value):
try: try:
flags, protocol, algorithm, public_key = value.split(' ')
key_tag, algorithm, digest_type, digest = value.split(' ')
except ValueError: except ValueError:
raise RrParseError() raise RrParseError()
try: try:
flags = int(flags)
key_tag = int(key_tag)
except ValueError: except ValueError:
pass pass
try: try:
protocol = int(protocol)
algorithm = int(algorithm)
except ValueError: except ValueError:
pass pass
try: try:
algorithm = int(algorithm)
digest_type = int(digest_type)
except ValueError: except ValueError:
pass pass
return { return {
'flags': flags,
'protocol': protocol,
'key_tag': key_tag,
'algorithm': algorithm, 'algorithm': algorithm,
'public_key': public_key,
'digest_type': digest_type,
'digest': digest,
} }
@classmethod @classmethod
@ -42,25 +42,25 @@ class DsValue(EqualityTupleMixin, dict):
reasons = [] reasons = []
for value in data: for value in data:
try: try:
int(value['flags'])
int(value['key_tag'])
except KeyError: except KeyError:
reasons.append('missing flags')
reasons.append('missing key_tag')
except ValueError: except ValueError:
reasons.append(f'invalid flags "{value["flags"]}"')
try:
int(value['protocol'])
except KeyError:
reasons.append('missing protocol')
except ValueError:
reasons.append(f'invalid protocol "{value["protocol"]}"')
reasons.append(f'invalid key_tag "{value["key_tag"]}"')
try: try:
int(value['algorithm']) int(value['algorithm'])
except KeyError: except KeyError:
reasons.append('missing algorithm') reasons.append('missing algorithm')
except ValueError: except ValueError:
reasons.append(f'invalid algorithm "{value["algorithm"]}"') reasons.append(f'invalid algorithm "{value["algorithm"]}"')
if 'public_key' not in value:
reasons.append('missing public_key')
try:
int(value['digest_type'])
except KeyError:
reasons.append('missing digest_type')
except ValueError:
reasons.append(f'invalid digest_type "{value["digest_type"]}"')
if 'digest' not in value:
reasons.append('missing digest')
return reasons return reasons
@classmethod @classmethod
@ -70,28 +70,20 @@ class DsValue(EqualityTupleMixin, dict):
def __init__(self, value): def __init__(self, value):
super().__init__( super().__init__(
{ {
'flags': int(value['flags']),
'protocol': int(value['protocol']),
'key_tag': int(value['key_tag']),
'algorithm': int(value['algorithm']), 'algorithm': int(value['algorithm']),
'public_key': value['public_key'],
'digest_type': int(value['digest_type']),
'digest': value['digest'],
} }
) )
@property @property
def flags(self):
return self['flags']
@flags.setter
def flags(self, value):
self['flags'] = value
@property
def protocol(self):
return self['protocol']
def key_tag(self):
return self['key_tag']
@protocol.setter
def protocol(self, value):
self['protocol'] = value
@key_tag.setter
def key_tag(self, value):
self['key_tag'] = value
@property @property
def algorithm(self): def algorithm(self):
@ -102,12 +94,20 @@ class DsValue(EqualityTupleMixin, dict):
self['algorithm'] = value self['algorithm'] = value
@property @property
def public_key(self):
return self['public_key']
def digest_type(self):
return self['digest_type']
@digest_type.setter
def digest_type(self, value):
self['digest_type'] = value
@property
def digest(self):
return self['digest']
@public_key.setter
def public_key(self, value):
self['public_key'] = value
@digest.setter
def digest(self, value):
self['digest'] = value
@property @property
def data(self): def data(self):
@ -116,15 +116,15 @@ class DsValue(EqualityTupleMixin, dict):
@property @property
def rdata_text(self): def rdata_text(self):
return ( return (
f'{self.flags} {self.protocol} {self.algorithm} {self.public_key}'
f'{self.key_tag} {self.algorithm} {self.digest_type} {self.digest}'
) )
def _equality_tuple(self): def _equality_tuple(self):
return (self.flags, self.protocol, self.algorithm, self.public_key)
return (self.key_tag, self.algorithm, self.digest_type, self.digest)
def __repr__(self): def __repr__(self):
return ( return (
f'{self.flags} {self.protocol} {self.algorithm} {self.public_key}'
f'{self.key_tag} {self.algorithm} {self.digest_type} {self.digest}'
) )


+ 97
- 95
tests/test_octodns_record_ds.py View File

@ -12,64 +12,64 @@ from octodns.zone import Zone
class TestRecordDs(TestCase): class TestRecordDs(TestCase):
def test_ds(self): def test_ds(self):
for a, b in ( for a, b in (
# diff flags
# diff key_tag
( (
{ {
'flags': 0,
'protocol': 1,
'algorithm': 2,
'public_key': 'abcdef0123456',
'key_tag': 0,
'algorithm': 1,
'digest_type': 2,
'digest': 'abcdef0123456',
}, },
{ {
'flags': 1,
'protocol': 1,
'algorithm': 2,
'public_key': 'abcdef0123456',
'key_tag': 1,
'algorithm': 1,
'digest_type': 2,
'digest': 'abcdef0123456',
}, },
), ),
# diff protocol
# diff algorithm
( (
{ {
'flags': 0,
'protocol': 1,
'algorithm': 2,
'public_key': 'abcdef0123456',
'key_tag': 0,
'algorithm': 1,
'digest_type': 2,
'digest': 'abcdef0123456',
}, },
{ {
'flags': 0,
'protocol': 2,
'key_tag': 0,
'algorithm': 2, 'algorithm': 2,
'public_key': 'abcdef0123456',
'digest_type': 2,
'digest': 'abcdef0123456',
}, },
), ),
# diff algorithm
# diff digest_type
( (
{ {
'flags': 0,
'protocol': 1,
'algorithm': 2,
'public_key': 'abcdef0123456',
'key_tag': 0,
'algorithm': 1,
'digest_type': 2,
'digest': 'abcdef0123456',
}, },
{ {
'flags': 0,
'protocol': 1,
'algorithm': 3,
'public_key': 'abcdef0123456',
'key_tag': 0,
'algorithm': 1,
'digest_type': 3,
'digest': 'abcdef0123456',
}, },
), ),
# diff public_key
# diff digest
( (
{ {
'flags': 0,
'protocol': 1,
'algorithm': 2,
'public_key': 'abcdef0123456',
'key_tag': 0,
'algorithm': 1,
'digest_type': 2,
'digest': 'abcdef0123456',
}, },
{ {
'flags': 0,
'protocol': 1,
'algorithm': 2,
'public_key': 'bcdef0123456a',
'key_tag': 0,
'algorithm': 1,
'digest_type': 2,
'digest': 'bcdef0123456a',
}, },
), ),
): ):
@ -104,102 +104,104 @@ class TestRecordDs(TestCase):
# things ints, will parse # things ints, will parse
self.assertEqual( self.assertEqual(
{ {
'flags': 'one',
'protocol': 'two',
'algorithm': 'three',
'public_key': 'key',
'key_tag': 'one',
'algorithm': 'two',
'digest_type': 'three',
'digest': 'key',
}, },
DsValue.parse_rdata_text('one two three key'), DsValue.parse_rdata_text('one two three key'),
) )
# valid # valid
data = { data = {
'flags': 0,
'protocol': 1,
'algorithm': 2,
'public_key': '99148c81',
'key_tag': 0,
'algorithm': 1,
'digest_type': 2,
'digest': '99148c81',
} }
self.assertEqual(data, DsValue.parse_rdata_text('0 1 2 99148c81')) self.assertEqual(data, DsValue.parse_rdata_text('0 1 2 99148c81'))
self.assertEqual([], DsValue.validate(data, 'DS')) self.assertEqual([], DsValue.validate(data, 'DS'))
# missing flags
data = {'protocol': 1, 'algorithm': 2, 'public_key': '99148c81'}
self.assertEqual(['missing flags'], DsValue.validate(data, 'DS'))
# invalid flags
data = {
'flags': 'a',
'protocol': 1,
'algorithm': 2,
'public_key': '99148c81',
}
self.assertEqual(['invalid flags "a"'], DsValue.validate(data, 'DS'))
# missing protocol
data = {'flags': 1, 'algorithm': 2, 'public_key': '99148c81'}
self.assertEqual(['missing protocol'], DsValue.validate(data, 'DS'))
# invalid protocol
# missing key_tag
data = {'algorithm': 1, 'digest_type': 2, 'digest': '99148c81'}
self.assertEqual(['missing key_tag'], DsValue.validate(data, 'DS'))
# invalid key_tag
data = { data = {
'flags': 1,
'protocol': 'a',
'algorithm': 2,
'public_key': '99148c81',
'key_tag': 'a',
'algorithm': 1,
'digest_type': 2,
'digest': '99148c81',
} }
self.assertEqual(['invalid protocol "a"'], DsValue.validate(data, 'DS'))
self.assertEqual(['invalid key_tag "a"'], DsValue.validate(data, 'DS'))
# missing algorithm # missing algorithm
data = {'flags': 1, 'protocol': 2, 'public_key': '99148c81'}
data = {'key_tag': 1, 'digest_type': 2, 'digest': '99148c81'}
self.assertEqual(['missing algorithm'], DsValue.validate(data, 'DS')) self.assertEqual(['missing algorithm'], DsValue.validate(data, 'DS'))
# invalid algorithm # invalid algorithm
data = { data = {
'flags': 1,
'protocol': 2,
'key_tag': 1,
'algorithm': 'a', 'algorithm': 'a',
'public_key': '99148c81',
'digest_type': 2,
'digest': '99148c81',
} }
self.assertEqual( self.assertEqual(
['invalid algorithm "a"'], DsValue.validate(data, 'DS') ['invalid algorithm "a"'], DsValue.validate(data, 'DS')
) )
# missing algorithm (list)
data = {'flags': 1, 'protocol': 2, 'algorithm': 3}
self.assertEqual(['missing public_key'], DsValue.validate([data], 'DS'))
# missing digest_type
data = {'key_tag': 1, 'algorithm': 2, 'digest': '99148c81'}
self.assertEqual(['missing digest_type'], DsValue.validate(data, 'DS'))
# invalid digest_type
data = {
'key_tag': 1,
'algorithm': 2,
'digest_type': 'a',
'digest': '99148c81',
}
self.assertEqual(
['invalid digest_type "a"'], DsValue.validate(data, 'DS')
)
# missing digest_type (list)
data = {'key_tag': 1, 'algorithm': 2, 'digest_type': 3}
self.assertEqual(['missing digest'], DsValue.validate([data], 'DS'))
zone = Zone('unit.tests.', []) zone = Zone('unit.tests.', [])
values = [ values = [
{ {
'flags': 0,
'protocol': 1,
'algorithm': 2,
'public_key': '99148c81',
'key_tag': 0,
'algorithm': 1,
'digest_type': 2,
'digest': '99148c81',
}, },
{ {
'flags': 1,
'protocol': 2,
'algorithm': 3,
'public_key': '99148c44',
'key_tag': 1,
'algorithm': 2,
'digest_type': 3,
'digest': '99148c44',
}, },
] ]
a = DsRecord(zone, 'ds', {'ttl': 32, 'values': values}) a = DsRecord(zone, 'ds', {'ttl': 32, 'values': values})
self.assertEqual(0, a.values[0].flags)
a.values[0].flags += 1
self.assertEqual(1, a.values[0].flags)
self.assertEqual(1, a.values[0].protocol)
a.values[0].protocol += 1
self.assertEqual(2, a.values[0].protocol)
self.assertEqual(0, a.values[0].key_tag)
a.values[0].key_tag += 1
self.assertEqual(1, a.values[0].key_tag)
self.assertEqual(2, a.values[0].algorithm)
self.assertEqual(1, a.values[0].algorithm)
a.values[0].algorithm += 1 a.values[0].algorithm += 1
self.assertEqual(3, a.values[0].algorithm)
self.assertEqual(2, a.values[0].algorithm)
self.assertEqual(2, a.values[0].digest_type)
a.values[0].digest_type += 1
self.assertEqual(3, a.values[0].digest_type)
self.assertEqual('99148c81', a.values[0].public_key)
a.values[0].public_key = '99148c42'
self.assertEqual('99148c42', a.values[0].public_key)
self.assertEqual('99148c81', a.values[0].digest)
a.values[0].digest = '99148c42'
self.assertEqual('99148c42', a.values[0].digest)
self.assertEqual(1, a.values[1].flags)
self.assertEqual(2, a.values[1].protocol)
self.assertEqual(3, a.values[1].algorithm)
self.assertEqual('99148c44', a.values[1].public_key)
self.assertEqual(1, a.values[1].key_tag)
self.assertEqual(2, a.values[1].algorithm)
self.assertEqual(3, a.values[1].digest_type)
self.assertEqual('99148c44', a.values[1].digest)
self.assertEqual(DsValue(values[1]), a.values[1].data) self.assertEqual(DsValue(values[1]), a.values[1].data)
self.assertEqual('1 2 3 99148c44', a.values[1].rdata_text) self.assertEqual('1 2 3 99148c44', a.values[1].rdata_text)


Loading…
Cancel
Save