BIND 10 master, updated. 9b6f54409617896742151c6aab9f5f318b7f53c5 [master] Merge branch 'trac1288'
BIND 10 source code commits
bind10-changes at lists.isc.org
Tue Nov 15 22:20:30 UTC 2011
The branch, master has been updated
via 9b6f54409617896742151c6aab9f5f318b7f53c5 (commit)
via 36a5cd751a12ccbd31284ea19d0b10e8a5836b70 (commit)
via f1cb067ea86ab38810007ec6743e7c1f91042e99 (commit)
via 6ddab5f4ea56162d0834e22a68605a1a427cc8c2 (commit)
via 8a5b3e3b460e7f741b1560f73423c8d688db9d85 (commit)
via 275d091229e914a848408b785f0143541abed6d5 (commit)
via b5553ef764f6c8cb0acea25e14b6e7a6a3a4cd47 (commit)
via bdde86c05963e9d491015e906c1b899609417887 (commit)
via 045c30f0dffebb30ad8862986be435748ed0efb6 (commit)
via a6fd03e989a1fd5ae9514774bb3b3bb2a6668765 (commit)
via 8c07f46adfdd748ee33b3b5e9d33a78a64dded10 (commit)
via 235ff5af7733a7d464b172c4424f8facf284fed6 (commit)
via 8f3f3e9da36c5a0cbbfa4e2a5ddc598be7fece4a (commit)
via fe04c9377836fcd387f79447906e7ec83911b5b2 (commit)
via 0f76bcddad8050baf811b0eaa5a117cc61dcbba1 (commit)
via f01fb1d89b20b23c0a680b1a97dc83e5a174e2e6 (commit)
via 7a5903389ed505f6c7ca4c87adf705216d11d1af (commit)
via d99d546be040419fd49ad3be179eb2206f5023de (commit)
via ca42fb6438b70ef569d00dc07b1bb23c0f6124f2 (commit)
via bcb37a2f6b11128620bb34a0c2d3dbf7334c0ab7 (commit)
via d17ae6dc7160a471abdd05f22aacc359df54b4e4 (commit)
via d9319841c509648c1ac18fec2c3d2b2c08313eb9 (commit)
via 89b3af8226cb89bcc59ceff5e9547dbfc5b30665 (commit)
via d0a7cf4a98daf0ec8759640a91a12059cece6c6d (commit)
via 5dc6be6febd523e202771cd11624efc29854349c (commit)
via f230c7d18b68d5c03131089a4f5c9739af7f9d83 (commit)
via e1682a42d23d36a3647878e13681dcd659622818 (commit)
via e45fa27d90ab3ea7b1081ca7d9513f63f5083b8d (commit)
via 1e9bc2c16ef78f35ec35e340c696b4bdc10b47b2 (commit)
via 85a2ce538c6f939ca539347676e5587228a29895 (commit)
via d1773b2ef6f98c26493ae76783158fc2ae6fbe52 (commit)
via 0b9c1b299f2078ab1a7bf08759a463eb179f0365 (commit)
from e4b99333e4c9946741148b6c95ed070653bec0fe (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 9b6f54409617896742151c6aab9f5f318b7f53c5
Merge: e4b9933 36a5cd7
Author: JINMEI Tatuya <jinmei at isc.org>
Date: Tue Nov 15 14:08:14 2011 -0800
[master] Merge branch 'trac1288'
-----------------------------------------------------------------------
Summary of changes:
src/bin/bind10/bind10_src.py.in | 50 ++-
src/bin/bind10/bob.spec | 2 +-
src/bin/bind10/tests/bind10_test.py.in | 5 +-
src/bin/xfrin/tests/Makefile.am | 2 +-
src/bin/xfrout/tests/Makefile.am | 8 +
src/bin/xfrout/tests/testdata/example.com | 6 +
.../tests/testdata/test.sqlite3} | Bin 11264 -> 11264 bytes
src/bin/xfrout/tests/xfrout_test.py.in | 383 ++++++++++++--------
src/bin/xfrout/xfrout.py.in | 289 +++++++++------
src/bin/xfrout/xfrout_messages.mes | 42 ++-
src/lib/python/isc/bind10/special_component.py | 6 +
src/lib/python/isc/notify/notify_out.py | 155 ++++++---
src/lib/python/isc/notify/notify_out_messages.mes | 21 +
src/lib/python/isc/notify/tests/Makefile.am | 9 +
src/lib/python/isc/notify/tests/notify_out_test.py | 73 ++---
.../isc/notify/tests/testdata/brokentest.sqlite3} | Bin 11264 -> 11264 bytes
.../python/isc/notify/tests/testdata/example.com | 10 +
.../python/isc/notify/tests/testdata/example.net | 14 +
.../isc/notify/tests/testdata/multisoa.example | 5 +
.../python/isc/notify/tests/testdata/nons.example | 3 +
.../python/isc/notify/tests/testdata/nosoa.example | 7 +
.../python/isc/notify/tests/testdata/test.sqlite3} | Bin 11264 -> 13312 bytes
22 files changed, 713 insertions(+), 377 deletions(-)
create mode 100644 src/bin/xfrout/tests/testdata/example.com
copy src/bin/{xfrin/tests/testdata/example.com.sqlite3 => xfrout/tests/testdata/test.sqlite3} (89%)
copy src/{bin/xfrin/tests/testdata/example.com.sqlite3 => lib/python/isc/notify/tests/testdata/brokentest.sqlite3} (77%)
create mode 100644 src/lib/python/isc/notify/tests/testdata/example.com
create mode 100644 src/lib/python/isc/notify/tests/testdata/example.net
create mode 100644 src/lib/python/isc/notify/tests/testdata/multisoa.example
create mode 100644 src/lib/python/isc/notify/tests/testdata/nons.example
create mode 100644 src/lib/python/isc/notify/tests/testdata/nosoa.example
copy src/{bin/xfrin/tests/testdata/example.com.sqlite3 => lib/python/isc/notify/tests/testdata/test.sqlite3} (69%)
-----------------------------------------------------------------------
diff --git a/src/bin/bind10/bind10_src.py.in b/src/bin/bind10/bind10_src.py.in
index 0b4f4cb..cbbaff5 100755
--- a/src/bin/bind10/bind10_src.py.in
+++ b/src/bin/bind10/bind10_src.py.in
@@ -628,21 +628,10 @@ class BoB:
# ... and start
return self.start_process("b10-resolver", resargs, self.c_channel_env)
- def start_cmdctl(self):
- """
- Starts the command control process
- """
- args = ["b10-cmdctl"]
- if self.cmdctl_port is not None:
- args.append("--port=" + str(self.cmdctl_port))
- if self.verbose:
- args.append("-v")
- return self.start_process("b10-cmdctl", args, self.c_channel_env,
- self.cmdctl_port)
-
- def start_xfrin(self):
- # XXX: a quick-hack workaround. xfrin will implicitly use dynamically
- # loadable data source modules, which will be installed in $(libdir).
+ def __ld_path_hack(self):
+ # XXX: a quick-hack workaround. xfrin/out will implicitly use
+ # dynamically loadable data source modules, which will be installed in
+ # $(libdir).
# On some OSes (including MacOS X and *BSDs) the main process (python)
# cannot find the modules unless they are located in a common shared
# object path or a path in the (DY)LD_LIBRARY_PATH. We should seek
@@ -655,21 +644,44 @@ class BoB:
# the same as for the libexec path addition
# TODO: Once #1292 is finished, remove this method and the special
# component, use it as normal component.
- c_channel_env = dict(self.c_channel_env)
+ env = dict(self.c_channel_env)
if ADD_LIBEXEC_PATH:
cur_path = os.getenv('DYLD_LIBRARY_PATH')
cur_path = '' if cur_path is None else ':' + cur_path
- c_channel_env['DYLD_LIBRARY_PATH'] = "@@LIBDIR@@" + cur_path
+ env['DYLD_LIBRARY_PATH'] = "@@LIBDIR@@" + cur_path
cur_path = os.getenv('LD_LIBRARY_PATH')
cur_path = '' if cur_path is None else ':' + cur_path
- c_channel_env['LD_LIBRARY_PATH'] = "@@LIBDIR@@" + cur_path
+ env['LD_LIBRARY_PATH'] = "@@LIBDIR@@" + cur_path
+ return env
+
+ def start_cmdctl(self):
+ """
+ Starts the command control process
+ """
+ args = ["b10-cmdctl"]
+ if self.cmdctl_port is not None:
+ args.append("--port=" + str(self.cmdctl_port))
+ if self.verbose:
+ args.append("-v")
+ return self.start_process("b10-cmdctl", args, self.c_channel_env,
+ self.cmdctl_port)
+
+ def start_xfrin(self):
# Set up the command arguments.
args = ['b10-xfrin']
if self.verbose:
args += ['-v']
- return self.start_process("b10-xfrin", args, c_channel_env)
+ return self.start_process("b10-xfrin", args, self.__ld_path_hack())
+
+ def start_xfrout(self):
+ # Set up the command arguments.
+ args = ['b10-xfrout']
+ if self.verbose:
+ args += ['-v']
+
+ return self.start_process("b10-xfrout", args, self.__ld_path_hack())
def start_all_components(self):
"""
diff --git a/src/bin/bind10/bob.spec b/src/bin/bind10/bob.spec
index 4a3cc85..4267b70 100644
--- a/src/bin/bind10/bob.spec
+++ b/src/bin/bind10/bob.spec
@@ -15,7 +15,7 @@
"kind": "dispensable"
},
"b10-xfrin": { "special": "xfrin", "kind": "dispensable" },
- "b10-xfrout": { "address": "Xfrout", "kind": "dispensable" },
+ "b10-xfrout": { "special": "xfrout", "kind": "dispensable" },
"b10-zonemgr": { "address": "Zonemgr", "kind": "dispensable" },
"b10-stats": { "address": "Stats", "kind": "dispensable" },
"b10-stats-httpd": {
diff --git a/src/bin/bind10/tests/bind10_test.py.in b/src/bin/bind10/tests/bind10_test.py.in
index 0aa6778..b238482 100644
--- a/src/bin/bind10/tests/bind10_test.py.in
+++ b/src/bin/bind10/tests/bind10_test.py.in
@@ -274,8 +274,7 @@ class MockBob(BoB):
return procinfo
def start_simple(self, name):
- procmap = { 'b10-xfrout': self.start_xfrout,
- 'b10-zonemgr': self.start_zonemgr,
+ procmap = { 'b10-zonemgr': self.start_zonemgr,
'b10-stats': self.start_stats,
'b10-stats-httpd': self.start_stats_httpd,
'b10-cmdctl': self.start_cmdctl,
@@ -475,7 +474,7 @@ class TestStartStopProcessesBob(unittest.TestCase):
if start_auth:
config['b10-auth'] = { 'kind': 'needed', 'special': 'auth' }
config['b10-xfrout'] = { 'kind': 'dispensable',
- 'address': 'Xfrout' }
+ 'special': 'xfrout' }
config['b10-xfrin'] = { 'kind': 'dispensable', 'special': 'xfrin' }
config['b10-zonemgr'] = { 'kind': 'dispensable',
'address': 'Zonemgr' }
diff --git a/src/bin/xfrin/tests/Makefile.am b/src/bin/xfrin/tests/Makefile.am
index 8f4fa91..cffafe1 100644
--- a/src/bin/xfrin/tests/Makefile.am
+++ b/src/bin/xfrin/tests/Makefile.am
@@ -10,7 +10,7 @@ LIBRARY_PATH_PLACEHOLDER =
if SET_ENV_LIBRARY_PATH
LIBRARY_PATH_PLACEHOLDER += $(ENV_LIBRARY_PATH)=$(abs_top_builddir)/src/lib/cryptolink/.libs:$(abs_top_builddir)/src/lib/dns/.libs:$(abs_top_builddir)/src/lib/dns/python/.libs:$(abs_top_builddir)/src/lib/cc/.libs:$(abs_top_builddir)/src/lib/config/.libs:$(abs_top_builddir)/src/lib/log/.libs:$(abs_top_builddir)/src/lib/util/.libs:$(abs_top_builddir)/src/lib/exceptions/.libs:$(abs_top_builddir)/src/lib/util/io/.libs:$(abs_top_builddir)/src/lib/datasrc/.libs:$$$(ENV_LIBRARY_PATH)
else
-# sunstudio needs the ds path even if not all paths are necessary
+# Some systems need the ds path even if not all paths are necessary
LIBRARY_PATH_PLACEHOLDER += $(ENV_LIBRARY_PATH)=$(abs_top_builddir)/src/lib/datasrc/.libs
endif
diff --git a/src/bin/xfrout/tests/Makefile.am b/src/bin/xfrout/tests/Makefile.am
index ace8fc9..509df79 100644
--- a/src/bin/xfrout/tests/Makefile.am
+++ b/src/bin/xfrout/tests/Makefile.am
@@ -2,11 +2,18 @@ PYCOVERAGE_RUN=@PYCOVERAGE_RUN@
PYTESTS = xfrout_test.py
noinst_SCRIPTS = $(PYTESTS)
+EXTRA_DIST = testdata/test.sqlite3
+# This one is actually not necessary, but added for reference
+EXTRA_DIST += testdata/example.com
+
# If necessary (rare cases), explicitly specify paths to dynamic libraries
# required by loadable python modules.
LIBRARY_PATH_PLACEHOLDER =
if SET_ENV_LIBRARY_PATH
LIBRARY_PATH_PLACEHOLDER += $(ENV_LIBRARY_PATH)=$(abs_top_builddir)/src/lib/cryptolink/.libs:$(abs_top_builddir)/src/lib/dns/.libs:$(abs_top_builddir)/src/lib/dns/python/.libs:$(abs_top_builddir)/src/lib/cc/.libs:$(abs_top_builddir)/src/lib/config/.libs:$(abs_top_builddir)/src/lib/log/.libs:$(abs_top_builddir)/src/lib/util/.libs:$(abs_top_builddir)/src/lib/exceptions/.libs:$(abs_top_builddir)/src/lib/util/io/.libs:$(abs_top_builddir)/src/lib/datasrc/.libs:$(abs_top_builddir)/src/lib/acl/.libs:$$$(ENV_LIBRARY_PATH)
+else
+# Some systems need the ds path even if not all paths are necessary
+LIBRARY_PATH_PLACEHOLDER += $(ENV_LIBRARY_PATH)=$(abs_top_builddir)/src/lib/datasrc/.libs
endif
# test using command-line arguments, so use check-local target instead of TESTS
@@ -24,5 +31,6 @@ endif
B10_FROM_BUILD=$(abs_top_builddir) \
$(LIBRARY_PATH_PLACEHOLDER) \
PYTHONPATH=$(COMMON_PYTHON_PATH):$(abs_top_builddir)/src/bin/xfrout:$(abs_top_builddir)/src/lib/dns/python/.libs:$(abs_top_builddir)/src/lib/util/io/.libs \
+ TESTDATASRCDIR=$(abs_srcdir)/testdata/ \
$(PYCOVERAGE_RUN) $(abs_builddir)/$$pytest || exit ; \
done
diff --git a/src/bin/xfrout/tests/testdata/example.com b/src/bin/xfrout/tests/testdata/example.com
new file mode 100644
index 0000000..25c5e6a
--- /dev/null
+++ b/src/bin/xfrout/tests/testdata/example.com
@@ -0,0 +1,6 @@
+;; This is the source of a zone stored in test.sqlite3. It's provided
+;; for reference purposes only.
+example.com. 3600 IN SOA a.dns.example.com. mail.example.com. 1 1 1 1 1
+example.com. 3600 IN NS a.dns.example.com.
+a.dns.example.com. 3600 IN A 192.0.2.1
+a.dns.example.com. 7200 IN A 192.0.2.2
diff --git a/src/bin/xfrout/tests/testdata/test.sqlite3 b/src/bin/xfrout/tests/testdata/test.sqlite3
new file mode 100644
index 0000000..af491f5
Binary files /dev/null and b/src/bin/xfrout/tests/testdata/test.sqlite3 differ
diff --git a/src/bin/xfrout/tests/xfrout_test.py.in b/src/bin/xfrout/tests/xfrout_test.py.in
index 0a9fd3c..8394b0a 100644
--- a/src/bin/xfrout/tests/xfrout_test.py.in
+++ b/src/bin/xfrout/tests/xfrout_test.py.in
@@ -21,12 +21,13 @@ import os
from isc.testutils.tsigctx_mock import MockTSIGContext
from isc.cc.session import *
import isc.config
-from pydnspp import *
+from isc.dns import *
from xfrout import *
import xfrout
import isc.log
import isc.acl.dns
+TESTDATA_SRCDIR = os.getenv("TESTDATASRCDIR")
TSIG_KEY = TSIGKey("example.com:SFuWd/q99SzF8Yzd1QbB9g==")
# our fake socket, where we can read and insert messages
@@ -55,19 +56,64 @@ class MySocket():
self.sendqueue = self.sendqueue[size:]
return result
- def read_msg(self):
+ def read_msg(self, parse_options=Message.PARSE_DEFAULT):
sent_data = self.readsent()
get_msg = Message(Message.PARSE)
- get_msg.from_wire(bytes(sent_data[2:]))
+ get_msg.from_wire(bytes(sent_data[2:]), parse_options)
return get_msg
def clear_send(self):
del self.sendqueue[:]
-# We subclass the Session class we're testing here, only
-# to override the handle() and _send_data() method
+class MockDataSrcClient:
+ def __init__(self, type, config):
+ pass
+
+ def get_iterator(self, zone_name, adjust_ttl=False):
+ if zone_name == Name('notauth.example.com'):
+ raise isc.datasrc.Error('no such zone')
+ self._zone_name = zone_name
+ return self
+
+ def get_soa(self): # emulate ZoneIterator.get_soa()
+ if self._zone_name == Name('nosoa.example.com'):
+ return None
+ soa_rrset = RRset(self._zone_name, RRClass.IN(), RRType.SOA(),
+ RRTTL(3600))
+ soa_rrset.add_rdata(Rdata(RRType.SOA(), RRClass.IN(),
+ 'master.example.com. ' +
+ 'admin.example.com. 1234 ' +
+ '3600 1800 2419200 7200'))
+ if self._zone_name == Name('multisoa.example.com'):
+ soa_rrset.add_rdata(Rdata(RRType.SOA(), RRClass.IN(),
+ 'master.example.com. ' +
+ 'admin.example.com. 1300 ' +
+ '3600 1800 2419200 7200'))
+ return soa_rrset
+
+class MyCCSession(isc.config.ConfigData):
+ def __init__(self):
+ module_spec = isc.config.module_spec_from_file(
+ xfrout.SPECFILE_LOCATION)
+ ConfigData.__init__(self, module_spec)
+
+ def get_remote_config_value(self, module_name, identifier):
+ if module_name == "Auth" and identifier == "database_file":
+ return "initdb.file", False
+ else:
+ return "unknown", False
+
+# This constant dictionary stores all default configuration parameters
+# defined in the xfrout spec file.
+DEFAULT_CONFIG = MyCCSession().get_full_config()
+
+# We subclass the Session class we're testing here, only overriding a few
+# methods
class MyXfroutSession(XfroutSession):
- def handle(self):
+ def _handle(self):
+ pass
+
+ def _close_socket(self):
pass
def _send_data(self, sock, data):
@@ -80,12 +126,23 @@ class MyXfroutSession(XfroutSession):
class Dbserver:
def __init__(self):
self._shutdown_event = threading.Event()
+ self.transfer_counter = 0
+ self._max_transfers_out = DEFAULT_CONFIG['transfers_out']
def get_db_file(self):
- return None
+ return 'test.sqlite3'
+ def increase_transfers_counter(self):
+ self.transfer_counter += 1
+ return True
def decrease_transfers_counter(self):
- pass
+ self.transfer_counter -= 1
+
+class TestXfroutSessionBase(unittest.TestCase):
+ '''Base classs for tests related to xfrout sessions
+
+ This class defines common setup/teadown and utility methods. Actual
+ tests are delegated to subclasses.
-class TestXfroutSession(unittest.TestCase):
+ '''
def getmsg(self):
msg = Message(Message.PARSE)
msg.from_wire(self.mdata)
@@ -102,15 +159,15 @@ class TestXfroutSession(unittest.TestCase):
def message_has_tsig(self, msg):
return msg.get_tsig_record() is not None
- def create_request_data(self, with_tsig=False):
+ def create_request_data(self, with_question=True, with_tsig=False):
msg = Message(Message.RENDER)
query_id = 0x1035
msg.set_qid(query_id)
msg.set_opcode(Opcode.QUERY())
msg.set_rcode(Rcode.NOERROR())
- query_question = Question(Name("example.com"), RRClass.IN(),
- RRType.AXFR())
- msg.add_question(query_question)
+ if with_question:
+ msg.add_question(Question(Name("example.com"), RRClass.IN(),
+ RRType.AXFR()))
renderer = MessageRenderer()
if with_tsig:
@@ -124,20 +181,76 @@ class TestXfroutSession(unittest.TestCase):
def setUp(self):
self.sock = MySocket(socket.AF_INET,socket.SOCK_STREAM)
self.xfrsess = MyXfroutSession(self.sock, None, Dbserver(),
- TSIGKeyRing(), ('127.0.0.1', 12345),
+ TSIGKeyRing(),
+ (socket.AF_INET, socket.SOCK_STREAM,
+ ('127.0.0.1', 12345)),
# When not testing ACLs, simply accept
isc.acl.dns.REQUEST_LOADER.load(
[{"action": "ACCEPT"}]),
{})
- self.mdata = self.create_request_data(False)
- self.soa_record = (4, 3, 'example.com.', 'com.example.', 3600, 'SOA', None, 'master.example.com. admin.example.com. 1234 3600 1800 2419200 7200')
+ self.mdata = self.create_request_data()
+ self.soa_rrset = RRset(Name('example.com'), RRClass.IN(), RRType.SOA(),
+ RRTTL(3600))
+ self.soa_rrset.add_rdata(Rdata(RRType.SOA(), RRClass.IN(),
+ 'master.Example.com. ' +
+ 'admin.exAmple.com. ' +
+ '1234 3600 1800 2419200 7200'))
+ # some test replaces a module-wide function. We should ensure the
+ # original is used elsewhere.
+ self.orig_get_rrset_len = xfrout.get_rrset_len
+
+ def tearDown(self):
+ xfrout.get_rrset_len = self.orig_get_rrset_len
+ # transfer_counter must be always be reset no matter happens within
+ # the XfroutSession object. We check the condition here.
+ self.assertEqual(0, self.xfrsess._server.transfer_counter)
+
+class TestXfroutSession(TestXfroutSessionBase):
+ def test_quota_error(self):
+ '''Emulating the server being too busy.
+
+ '''
+ self.xfrsess._request_data = self.mdata
+ self.xfrsess._server.increase_transfers_counter = lambda : False
+ XfroutSession._handle(self.xfrsess)
+ self.assertEqual(self.sock.read_msg().get_rcode(), Rcode.REFUSED())
+
+ def test_quota_ok(self):
+ '''The default case in terms of the xfrout quota.
+
+ '''
+ # set up a bogus request, which should result in FORMERR. (it only
+ # has to be something that is different from the previous case)
+ self.xfrsess._request_data = \
+ self.create_request_data(with_question=False)
+ # Replace the data source client to avoid datasrc related exceptions
+ self.xfrsess.ClientClass = MockDataSrcClient
+ XfroutSession._handle(self.xfrsess)
+ self.assertEqual(self.sock.read_msg().get_rcode(), Rcode.FORMERR())
+
+ def test_exception_from_session(self):
+ '''Test the case where the main processing raises an exception.
+
+ We just check it doesn't any unexpected disruption and (in tearDown)
+ transfer_counter is correctly reset to 0.
+
+ '''
+ def dns_xfrout_start(fd, msg, quota):
+ raise ValueError('fake exception')
+ self.xfrsess.dns_xfrout_start = dns_xfrout_start
+ XfroutSession._handle(self.xfrsess)
def test_parse_query_message(self):
[get_rcode, get_msg] = self.xfrsess._parse_query_message(self.mdata)
self.assertEqual(get_rcode.to_text(), "NOERROR")
+ # Broken request: no question
+ request_data = self.create_request_data(with_question=False)
+ rcode, msg = self.xfrsess._parse_query_message(request_data)
+ self.assertEqual(Rcode.FORMERR(), rcode)
+
# tsig signed query message
- request_data = self.create_request_data(True)
+ request_data = self.create_request_data(with_tsig=True)
# BADKEY
[rcode, msg] = self.xfrsess._parse_query_message(request_data)
self.assertEqual(rcode.to_text(), "NOTAUTH")
@@ -165,20 +278,23 @@ class TestXfroutSession(unittest.TestCase):
rcode, msg = self.xfrsess._parse_query_message(self.mdata)
self.assertEqual(rcode.to_text(), "NOERROR")
# This should be dropped completely, therefore returning None
- self.xfrsess._remote = ('192.0.2.1', 12345)
+ self.xfrsess._remote = (socket.AF_INET, socket.SOCK_STREAM,
+ ('192.0.2.1', 12345))
rcode, msg = self.xfrsess._parse_query_message(self.mdata)
self.assertEqual(None, rcode)
# This should be refused, therefore REFUSED
- self.xfrsess._remote = ('192.0.2.2', 12345)
+ self.xfrsess._remote = (socket.AF_INET, socket.SOCK_STREAM,
+ ('192.0.2.2', 12345))
rcode, msg = self.xfrsess._parse_query_message(self.mdata)
self.assertEqual(rcode.to_text(), "REFUSED")
# TSIG signed request
- request_data = self.create_request_data(True)
+ request_data = self.create_request_data(with_tsig=True)
# If the TSIG check fails, it should not check ACL
# (If it checked ACL as well, it would just drop the request)
- self.xfrsess._remote = ('192.0.2.1', 12345)
+ self.xfrsess._remote = (socket.AF_INET, socket.SOCK_STREAM,
+ ('192.0.2.1', 12345))
self.xfrsess._tsig_key_ring = TSIGKeyRing()
rcode, msg = self.xfrsess._parse_query_message(request_data)
self.assertEqual(rcode.to_text(), "NOTAUTH")
@@ -216,19 +332,23 @@ class TestXfroutSession(unittest.TestCase):
{"action": "REJECT"}
]))
# both matches
- self.xfrsess._remote = ('192.0.2.1', 12345)
+ self.xfrsess._remote = (socket.AF_INET, socket.SOCK_STREAM,
+ ('192.0.2.1', 12345))
[rcode, msg] = self.xfrsess._parse_query_message(request_data)
self.assertEqual(rcode.to_text(), "NOERROR")
# TSIG matches, but address doesn't
- self.xfrsess._remote = ('192.0.2.2', 12345)
+ self.xfrsess._remote = (socket.AF_INET, socket.SOCK_STREAM,
+ ('192.0.2.2', 12345))
[rcode, msg] = self.xfrsess._parse_query_message(request_data)
self.assertEqual(rcode.to_text(), "REFUSED")
# Address matches, but TSIG doesn't (not included)
- self.xfrsess._remote = ('192.0.2.1', 12345)
+ self.xfrsess._remote = (socket.AF_INET, socket.SOCK_STREAM,
+ ('192.0.2.1', 12345))
[rcode, msg] = self.xfrsess._parse_query_message(self.mdata)
self.assertEqual(rcode.to_text(), "REFUSED")
# Neither address nor TSIG matches
- self.xfrsess._remote = ('192.0.2.2', 12345)
+ self.xfrsess._remote = (socket.AF_INET, socket.SOCK_STREAM,
+ ('192.0.2.2', 12345))
[rcode, msg] = self.xfrsess._parse_query_message(self.mdata)
self.assertEqual(rcode.to_text(), "REFUSED")
@@ -289,10 +409,6 @@ class TestXfroutSession(unittest.TestCase):
self.xfrsess._get_transfer_acl(Name('EXAMPLE.COM'),
RRClass.IN()))
- def test_get_query_zone_name(self):
- msg = self.getmsg()
- self.assertEqual(self.xfrsess._get_query_zone_name(msg), "example.com.")
-
def test_send_data(self):
self.xfrsess._send_data(self.sock, self.mdata)
senddata = self.sock.readsent()
@@ -315,10 +431,13 @@ class TestXfroutSession(unittest.TestCase):
def test_send_message(self):
msg = self.getmsg()
msg.make_response()
- # soa record data with different cases
- soa_record = (4, 3, 'Example.com.', 'com.Example.', 3600, 'SOA', None, 'master.Example.com. admin.exAmple.com. 1234 3600 1800 2419200 7200')
- rrset_soa = self.xfrsess._create_rrset_from_db_record(soa_record)
- msg.add_rrset(Message.SECTION_ANSWER, rrset_soa)
+ # SOA record data with different cases
+ soa_rrset = RRset(Name('Example.com.'), RRClass.IN(), RRType.SOA(),
+ RRTTL(3600))
+ soa_rrset.add_rdata(Rdata(RRType.SOA(), RRClass.IN(),
+ 'master.Example.com. admin.exAmple.com. ' +
+ '1234 3600 1800 2419200 7200'))
+ msg.add_rrset(Message.SECTION_ANSWER, soa_rrset)
self.xfrsess._send_message(self.sock, msg)
send_out_data = self.sock.readsent()[2:]
@@ -347,23 +466,15 @@ class TestXfroutSession(unittest.TestCase):
self.assertEqual(msg.get_rcode(), rcode)
self.assertTrue(msg.get_header_flag(Message.HEADERFLAG_AA))
- def test_create_rrset_from_db_record(self):
- rrset = self.xfrsess._create_rrset_from_db_record(self.soa_record)
- self.assertEqual(rrset.get_name().to_text(), "example.com.")
- self.assertEqual(rrset.get_class(), RRClass("IN"))
- self.assertEqual(rrset.get_type().to_text(), "SOA")
- rdata = rrset.get_rdata()
- self.assertEqual(rdata[0].to_text(), self.soa_record[7])
-
def test_send_message_with_last_soa(self):
- rrset_soa = self.xfrsess._create_rrset_from_db_record(self.soa_record)
msg = self.getmsg()
msg.make_response()
# packet number less than TSIG_SIGN_EVERY_NTH
packet_neet_not_sign = xfrout.TSIG_SIGN_EVERY_NTH - 1
- self.xfrsess._send_message_with_last_soa(msg, self.sock, rrset_soa,
- 0, packet_neet_not_sign)
+ self.xfrsess._send_message_with_last_soa(msg, self.sock,
+ self.soa_rrset, 0,
+ packet_neet_not_sign)
get_msg = self.sock.read_msg()
# tsig context is not exist
self.assertFalse(self.message_has_tsig(get_msg))
@@ -378,12 +489,13 @@ class TestXfroutSession(unittest.TestCase):
self.assertEqual(answer.get_class(), RRClass("IN"))
self.assertEqual(answer.get_type().to_text(), "SOA")
rdata = answer.get_rdata()
- self.assertEqual(rdata[0].to_text(), self.soa_record[7])
+ self.assertEqual(rdata[0], self.soa_rrset.get_rdata()[0])
# msg is the TSIG_SIGN_EVERY_NTH one
# sending the message with last soa together
- self.xfrsess._send_message_with_last_soa(msg, self.sock, rrset_soa,
- 0, TSIG_SIGN_EVERY_NTH)
+ self.xfrsess._send_message_with_last_soa(msg, self.sock,
+ self.soa_rrset, 0,
+ TSIG_SIGN_EVERY_NTH)
get_msg = self.sock.read_msg()
# tsig context is not exist
self.assertFalse(self.message_has_tsig(get_msg))
@@ -392,7 +504,6 @@ class TestXfroutSession(unittest.TestCase):
# create tsig context
self.xfrsess._tsig_ctx = self.create_mock_tsig_ctx(TSIGError.NOERROR)
- rrset_soa = self.xfrsess._create_rrset_from_db_record(self.soa_record)
msg = self.getmsg()
msg.make_response()
@@ -400,8 +511,9 @@ class TestXfroutSession(unittest.TestCase):
packet_neet_not_sign = xfrout.TSIG_SIGN_EVERY_NTH - 1
# msg is not the TSIG_SIGN_EVERY_NTH one
# sending the message with last soa together
- self.xfrsess._send_message_with_last_soa(msg, self.sock, rrset_soa,
- 0, packet_neet_not_sign)
+ self.xfrsess._send_message_with_last_soa(msg, self.sock,
+ self.soa_rrset, 0,
+ packet_neet_not_sign)
get_msg = self.sock.read_msg()
self.assertTrue(self.message_has_tsig(get_msg))
@@ -411,22 +523,23 @@ class TestXfroutSession(unittest.TestCase):
# msg is the TSIG_SIGN_EVERY_NTH one
# sending the message with last soa together
- self.xfrsess._send_message_with_last_soa(msg, self.sock, rrset_soa,
- 0, TSIG_SIGN_EVERY_NTH)
+ self.xfrsess._send_message_with_last_soa(msg, self.sock,
+ self.soa_rrset, 0,
+ TSIG_SIGN_EVERY_NTH)
get_msg = self.sock.read_msg()
self.assertTrue(self.message_has_tsig(get_msg))
def test_trigger_send_message_with_last_soa(self):
rrset_a = RRset(Name("example.com"), RRClass.IN(), RRType.A(), RRTTL(3600))
rrset_a.add_rdata(Rdata(RRType.A(), RRClass.IN(), "192.0.2.1"))
- rrset_soa = self.xfrsess._create_rrset_from_db_record(self.soa_record)
msg = self.getmsg()
msg.make_response()
msg.add_rrset(Message.SECTION_ANSWER, rrset_a)
# length larger than MAX-len(rrset)
- length_need_split = xfrout.XFROUT_MAX_MESSAGE_SIZE - get_rrset_len(rrset_soa) + 1
+ length_need_split = xfrout.XFROUT_MAX_MESSAGE_SIZE - \
+ get_rrset_len(self.soa_rrset) + 1
# packet number less than TSIG_SIGN_EVERY_NTH
packet_neet_not_sign = xfrout.TSIG_SIGN_EVERY_NTH - 1
@@ -434,7 +547,9 @@ class TestXfroutSession(unittest.TestCase):
# this should have triggered the sending of two messages
# (1 with the rrset we added manually, and 1 that triggered
# the sending in _with_last_soa)
- self.xfrsess._send_message_with_last_soa(msg, self.sock, rrset_soa, length_need_split,
+ self.xfrsess._send_message_with_last_soa(msg, self.sock,
+ self.soa_rrset,
+ length_need_split,
packet_neet_not_sign)
get_msg = self.sock.read_msg()
self.assertFalse(self.message_has_tsig(get_msg))
@@ -461,20 +576,20 @@ class TestXfroutSession(unittest.TestCase):
self.assertEqual(answer.get_class(), RRClass("IN"))
self.assertEqual(answer.get_type().to_text(), "SOA")
rdata = answer.get_rdata()
- self.assertEqual(rdata[0].to_text(), self.soa_record[7])
+ self.assertEqual(rdata[0], self.soa_rrset.get_rdata()[0])
# and it should not have sent anything else
self.assertEqual(0, len(self.sock.sendqueue))
def test_trigger_send_message_with_last_soa_with_tsig(self):
self.xfrsess._tsig_ctx = self.create_mock_tsig_ctx(TSIGError.NOERROR)
- rrset_soa = self.xfrsess._create_rrset_from_db_record(self.soa_record)
msg = self.getmsg()
msg.make_response()
- msg.add_rrset(Message.SECTION_ANSWER, rrset_soa)
+ msg.add_rrset(Message.SECTION_ANSWER, self.soa_rrset)
# length larger than MAX-len(rrset)
- length_need_split = xfrout.XFROUT_MAX_MESSAGE_SIZE - get_rrset_len(rrset_soa) + 1
+ length_need_split = xfrout.XFROUT_MAX_MESSAGE_SIZE - \
+ get_rrset_len(self.soa_rrset) + 1
# packet number less than TSIG_SIGN_EVERY_NTH
packet_neet_not_sign = xfrout.TSIG_SIGN_EVERY_NTH - 1
@@ -482,7 +597,9 @@ class TestXfroutSession(unittest.TestCase):
# this should have triggered the sending of two messages
# (1 with the rrset we added manually, and 1 that triggered
# the sending in _with_last_soa)
- self.xfrsess._send_message_with_last_soa(msg, self.sock, rrset_soa, length_need_split,
+ self.xfrsess._send_message_with_last_soa(msg, self.sock,
+ self.soa_rrset,
+ length_need_split,
packet_neet_not_sign)
get_msg = self.sock.read_msg()
# msg is not the TSIG_SIGN_EVERY_NTH one, it shouldn't be tsig signed
@@ -495,7 +612,9 @@ class TestXfroutSession(unittest.TestCase):
# msg is the TSIG_SIGN_EVERY_NTH one, it should be tsig signed
- self.xfrsess._send_message_with_last_soa(msg, self.sock, rrset_soa, length_need_split,
+ self.xfrsess._send_message_with_last_soa(msg, self.sock,
+ self.soa_rrset,
+ length_need_split,
xfrout.TSIG_SIGN_EVERY_NTH)
get_msg = self.sock.read_msg()
self.assertTrue(self.message_has_tsig(get_msg))
@@ -506,49 +625,18 @@ class TestXfroutSession(unittest.TestCase):
self.assertEqual(0, len(self.sock.sendqueue))
def test_get_rrset_len(self):
- rrset_soa = self.xfrsess._create_rrset_from_db_record(self.soa_record)
- self.assertEqual(82, get_rrset_len(rrset_soa))
-
- def test_zone_has_soa(self):
- global sqlite3_ds
- def mydb1(zone, file):
- return True
- sqlite3_ds.get_zone_soa = mydb1
- self.assertTrue(self.xfrsess._zone_has_soa(""))
- def mydb2(zone, file):
- return False
- sqlite3_ds.get_zone_soa = mydb2
- self.assertFalse(self.xfrsess._zone_has_soa(""))
-
- def test_zone_exist(self):
- global sqlite3_ds
- def zone_exist(zone, file):
- return zone
- sqlite3_ds.zone_exist = zone_exist
- self.assertTrue(self.xfrsess._zone_exist(True))
- self.assertFalse(self.xfrsess._zone_exist(False))
+ self.assertEqual(82, get_rrset_len(self.soa_rrset))
def test_check_xfrout_available(self):
- def zone_exist(zone):
- return zone
- def zone_has_soa(zone):
- return (not zone)
- self.xfrsess._zone_exist = zone_exist
- self.xfrsess._zone_has_soa = zone_has_soa
- self.assertEqual(self.xfrsess._check_xfrout_available(False).to_text(), "NOTAUTH")
- self.assertEqual(self.xfrsess._check_xfrout_available(True).to_text(), "SERVFAIL")
-
- def zone_empty(zone):
- return zone
- self.xfrsess._zone_has_soa = zone_empty
- def false_func():
- return False
- self.xfrsess._server.increase_transfers_counter = false_func
- self.assertEqual(self.xfrsess._check_xfrout_available(True).to_text(), "REFUSED")
- def true_func():
- return True
- self.xfrsess._server.increase_transfers_counter = true_func
- self.assertEqual(self.xfrsess._check_xfrout_available(True).to_text(), "NOERROR")
+ self.xfrsess.ClientClass = MockDataSrcClient
+ self.assertEqual(self.xfrsess._check_xfrout_available(
+ Name('example.com')), Rcode.NOERROR())
+ self.assertEqual(self.xfrsess._check_xfrout_available(
+ Name('notauth.example.com')), Rcode.NOTAUTH())
+ self.assertEqual(self.xfrsess._check_xfrout_available(
+ Name('nosoa.example.com')), Rcode.SERVFAIL())
+ self.assertEqual(self.xfrsess._check_xfrout_available(
+ Name('multisoa.example.com')), Rcode.SERVFAIL())
def test_dns_xfrout_start_formerror(self):
# formerror
@@ -560,7 +648,6 @@ class TestXfroutSession(unittest.TestCase):
return "example.com"
def test_dns_xfrout_start_notauth(self):
- self.xfrsess._get_query_zone_name = self.default
def notauth(formpara):
return Rcode.NOTAUTH()
self.xfrsess._check_xfrout_available = notauth
@@ -568,13 +655,19 @@ class TestXfroutSession(unittest.TestCase):
get_msg = self.sock.read_msg()
self.assertEqual(get_msg.get_rcode().to_text(), "NOTAUTH")
+ def test_dns_xfrout_start_datasrc_servfail(self):
+ def internal_raise(x, y):
+ raise isc.datasrc.Error('exception for the sake of test')
+ self.xfrsess.ClientClass = internal_raise
+ self.xfrsess.dns_xfrout_start(self.sock, self.mdata)
+ self.assertEqual(self.sock.read_msg().get_rcode(), Rcode.SERVFAIL())
+
def test_dns_xfrout_start_noerror(self):
- self.xfrsess._get_query_zone_name = self.default
def noerror(form):
return Rcode.NOERROR()
self.xfrsess._check_xfrout_available = noerror
- def myreply(msg, sock, zonename):
+ def myreply(msg, sock):
self.sock.send(b"success")
self.xfrsess._reply_xfrout_query = myreply
@@ -582,41 +675,27 @@ class TestXfroutSession(unittest.TestCase):
self.assertEqual(self.sock.readsent(), b"success")
def test_reply_xfrout_query_noerror(self):
- global sqlite3_ds
- def get_zone_soa(zonename, file):
- return self.soa_record
-
- def get_zone_datas(zone, file):
- return [self.soa_record]
-
- sqlite3_ds.get_zone_soa = get_zone_soa
- sqlite3_ds.get_zone_datas = get_zone_datas
- self.xfrsess._reply_xfrout_query(self.getmsg(), self.sock, "example.com.")
+ self.xfrsess._soa = self.soa_rrset
+ self.xfrsess._iterator = [self.soa_rrset]
+ self.xfrsess._reply_xfrout_query(self.getmsg(), self.sock)
reply_msg = self.sock.read_msg()
self.assertEqual(reply_msg.get_rr_count(Message.SECTION_ANSWER), 2)
def test_reply_xfrout_query_noerror_with_tsig(self):
- rrset_data = (4, 3, 'a.example.com.', 'com.example.', 3600, 'A', None, '192.168.1.1')
- global sqlite3_ds
+ rrset = RRset(Name('a.example.com'), RRClass.IN(), RRType.A(),
+ RRTTL(3600))
+ rrset.add_rdata(Rdata(RRType.A(), RRClass.IN(), '192.0.2.1'))
global xfrout
- def get_zone_soa(zonename, file):
- return self.soa_record
-
- def get_zone_datas(zone, file):
- zone_rrsets = []
- for i in range(0, 100):
- zone_rrsets.insert(i, rrset_data)
- return zone_rrsets
def get_rrset_len(rrset):
return 65520
- sqlite3_ds.get_zone_soa = get_zone_soa
- sqlite3_ds.get_zone_datas = get_zone_datas
+ self.xfrsess._soa = self.soa_rrset
+ self.xfrsess._iterator = [rrset for i in range(0, 100)]
xfrout.get_rrset_len = get_rrset_len
self.xfrsess._tsig_ctx = self.create_mock_tsig_ctx(TSIGError.NOERROR)
- self.xfrsess._reply_xfrout_query(self.getmsg(), self.sock, "example.com.")
+ self.xfrsess._reply_xfrout_query(self.getmsg(), self.sock)
# tsig signed first package
reply_msg = self.sock.read_msg()
@@ -640,18 +719,34 @@ class TestXfroutSession(unittest.TestCase):
# and it should not have sent anything else
self.assertEqual(0, len(self.sock.sendqueue))
-class MyCCSession(isc.config.ConfigData):
- def __init__(self):
- module_spec = isc.config.module_spec_from_file(
- xfrout.SPECFILE_LOCATION)
- ConfigData.__init__(self, module_spec)
- def get_remote_config_value(self, module_name, identifier):
- if module_name == "Auth" and identifier == "database_file":
- return "initdb.file", False
- else:
- return "unknown", False
+class TestXfroutSessionWithSQLite3(TestXfroutSessionBase):
+ '''Tests for XFR-out sessions using an SQLite3 DB.
+ These are provided mainly to confirm the implementation actually works
+ in an environment closer to actual operational environments. So we
+ only check a few common cases; other details are tested using mock
+ data sources.
+
+ '''
+ def setUp(self):
+ super().setUp()
+ self.xfrsess._request_data = self.mdata
+ self.xfrsess._server.get_db_file = lambda : TESTDATA_SRCDIR + \
+ 'test.sqlite3'
+
+ def test_axfr_normal_session(self):
+ XfroutSession._handle(self.xfrsess)
+ response = self.sock.read_msg(Message.PRESERVE_ORDER);
+ self.assertEqual(Rcode.NOERROR(), response.get_rcode())
+ # This zone contains two A RRs for the same name with different TTLs.
+ # These TTLs should be preseved in the AXFR stream.
+ actual_ttls = []
+ for rr in response.get_section(Message.SECTION_ANSWER):
+ if rr.get_type() == RRType.A() and \
+ not rr.get_ttl() in actual_ttls:
+ actual_ttls.append(rr.get_ttl().get_value())
+ self.assertEqual([3600, 7200], sorted(actual_ttls))
class MyUnixSockServer(UnixSockServer):
def __init__(self):
@@ -670,23 +765,27 @@ class TestUnixSockServer(unittest.TestCase):
file descriptor. This is needed, because we get only that one
from auth."""
# We test with UDP, as it can be "connected" without other
- # endpoint
+ # endpoint. Note that in the current implementation _guess_remote()
+ # unconditionally returns SOCK_STREAM.
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
sock.connect(('127.0.0.1', 12345))
- self.assertEqual(('127.0.0.1', 12345),
+ self.assertEqual((socket.AF_INET, socket.SOCK_STREAM,
+ ('127.0.0.1', 12345)),
self.unix._guess_remote(sock.fileno()))
if socket.has_ipv6:
# Don't check IPv6 address on hosts not supporting them
sock = socket.socket(socket.AF_INET6, socket.SOCK_DGRAM)
sock.connect(('::1', 12345))
- self.assertEqual(('::1', 12345, 0, 0),
+ self.assertEqual((socket.AF_INET6, socket.SOCK_STREAM,
+ ('::1', 12345, 0, 0)),
self.unix._guess_remote(sock.fileno()))
# Try when pretending there's no IPv6 support
# (No need to pretend when there's really no IPv6)
xfrout.socket.has_ipv6 = False
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
sock.connect(('127.0.0.1', 12345))
- self.assertEqual(('127.0.0.1', 12345),
+ self.assertEqual((socket.AF_INET, socket.SOCK_STREAM,
+ ('127.0.0.1', 12345)),
self.unix._guess_remote(sock.fileno()))
# Return it back
xfrout.socket.has_ipv6 = True
diff --git a/src/bin/xfrout/xfrout.py.in b/src/bin/xfrout/xfrout.py.in
index cf3b04f..a473322 100755
--- a/src/bin/xfrout/xfrout.py.in
+++ b/src/bin/xfrout/xfrout.py.in
@@ -22,7 +22,7 @@ import isc.cc
import threading
import struct
import signal
-from isc.datasrc import sqlite3_ds
+from isc.datasrc import DataSourceClient
from socketserver import *
import os
from isc.config.ccsession import *
@@ -97,6 +97,38 @@ TSIG_SIGN_EVERY_NTH = 96
XFROUT_MAX_MESSAGE_SIZE = 65535
+# borrowed from xfrin.py @ #1298. We should eventually unify it.
+def format_zone_str(zone_name, zone_class):
+ """Helper function to format a zone name and class as a string of
+ the form '<name>/<class>'.
+ Parameters:
+ zone_name (isc.dns.Name) name to format
+ zone_class (isc.dns.RRClass) class to format
+ """
+ return zone_name.to_text() + '/' + str(zone_class)
+
+# borrowed from xfrin.py @ #1298.
+def format_addrinfo(addrinfo):
+ """Helper function to format the addrinfo as a string of the form
+ <addr>:<port> (for IPv4) or [<addr>]:port (for IPv6). For unix domain
+ sockets, and unknown address families, it returns a basic string
+ conversion of the third element of the passed tuple.
+ Parameters:
+ addrinfo: a 3-tuple consisting of address family, socket type, and,
+ depending on the family, either a 2-tuple with the address
+ and port, or a filename
+ """
+ try:
+ if addrinfo[0] == socket.AF_INET:
+ return str(addrinfo[2][0]) + ":" + str(addrinfo[2][1])
+ elif addrinfo[0] == socket.AF_INET6:
+ return "[" + str(addrinfo[2][0]) + "]:" + str(addrinfo[2][1])
+ else:
+ return str(addrinfo[2])
+ except IndexError:
+ raise TypeError("addrinfo argument to format_addrinfo() does not "
+ "appear to be consisting of (family, socktype, (addr, port))")
+
def get_rrset_len(rrset):
"""Returns the wire length of the given RRset"""
bytes = bytearray()
@@ -106,7 +138,7 @@ def get_rrset_len(rrset):
class XfroutSession():
def __init__(self, sock_fd, request_data, server, tsig_key_ring, remote,
- default_acl, zone_config):
+ default_acl, zone_config, client_class=DataSourceClient):
self._sock_fd = sock_fd
self._request_data = request_data
self._server = server
@@ -114,23 +146,51 @@ class XfroutSession():
self._tsig_ctx = None
self._tsig_len = 0
self._remote = remote
+ self._request_type = 'AXFR' # could be IXFR when we support it
self._acl = default_acl
self._zone_config = zone_config
- self.handle()
+ self.ClientClass = client_class # parameterize this for testing
+ self._soa = None # will be set in _check_xfrout_available or in tests
+ self._handle()
def create_tsig_ctx(self, tsig_record, tsig_key_ring):
return TSIGContext(tsig_record.get_name(), tsig_record.get_rdata().get_algorithm(),
tsig_key_ring)
- def handle(self):
- ''' Handle a xfrout query, send xfrout response '''
+ def _handle(self):
+ ''' Handle a xfrout query, send xfrout response(s).
+
+ This is separated from the constructor so that we can override
+ it from tests.
+
+ '''
+ # Check the xfrout quota. We do both increase/decrease in this
+ # method so it's clear we always release it once acuired.
+ quota_ok = self._server.increase_transfers_counter()
+ ex = None
try:
- self.dns_xfrout_start(self._sock_fd, self._request_data)
- #TODO, avoid catching all exceptions
+ self.dns_xfrout_start(self._sock_fd, self._request_data, quota_ok)
except Exception as e:
- logger.error(XFROUT_HANDLE_QUERY_ERROR, e)
- pass
+ # To avoid resource leak we need catch all possible exceptions
+ # We log it later to exclude the case where even logger raises
+ # an exception.
+ ex = e
+
+ # Release any critical resources
+ if quota_ok:
+ self._server.decrease_transfers_counter()
+ self._close_socket()
+
+ if ex is not None:
+ logger.error(XFROUT_HANDLE_QUERY_ERROR, ex)
+ def _close_socket(self):
+ '''Simply close the socket via the given FD.
+
+ This is a dedicated subroutine of handle() and is sepsarated from it
+ for the convenience of tests.
+
+ '''
os.close(self._sock_fd)
def _check_request_tsig(self, msg, request_data):
@@ -157,23 +217,31 @@ class XfroutSession():
# TSIG related checks
rcode = self._check_request_tsig(msg, mdata)
-
- if rcode == Rcode.NOERROR():
- # ACL checks
- zone_name = msg.get_question()[0].get_name()
- zone_class = msg.get_question()[0].get_class()
- acl = self._get_transfer_acl(zone_name, zone_class)
- acl_result = acl.execute(
- isc.acl.dns.RequestContext(self._remote,
- msg.get_tsig_record()))
- if acl_result == DROP:
- logger.info(XFROUT_QUERY_DROPPED, zone_name, zone_class,
- self._remote[0], self._remote[1])
- return None, None
- elif acl_result == REJECT:
- logger.info(XFROUT_QUERY_REJECTED, zone_name, zone_class,
- self._remote[0], self._remote[1])
- return Rcode.REFUSED(), msg
+ if rcode != Rcode.NOERROR():
+ return rcode, msg
+
+ # Make sure the question is valid. This should be ensured by
+ # the auth server, but since it's far from our xfrout itself,
+ # we check it by ourselves.
+ if msg.get_rr_count(Message.SECTION_QUESTION) != 1:
+ return Rcode.FORMERR(), msg
+
+ # ACL checks
+ zone_name = msg.get_question()[0].get_name()
+ zone_class = msg.get_question()[0].get_class()
+ acl = self._get_transfer_acl(zone_name, zone_class)
+ acl_result = acl.execute(
+ isc.acl.dns.RequestContext(self._remote[2], msg.get_tsig_record()))
+ if acl_result == DROP:
+ logger.info(XFROUT_QUERY_DROPPED, self._request_type,
+ format_addrinfo(self._remote),
+ format_zone_str(zone_name, zone_class))
+ return None, None
+ elif acl_result == REJECT:
+ logger.info(XFROUT_QUERY_REJECTED, self._request_type,
+ format_addrinfo(self._remote),
+ format_zone_str(zone_name, zone_class))
+ return Rcode.REFUSED(), msg
return rcode, msg
@@ -195,14 +263,6 @@ class XfroutSession():
return self._zone_config[config_key]['transfer_acl']
return self._acl
- def _get_query_zone_name(self, msg):
- question = msg.get_question()[0]
- return question.get_name().to_text()
-
- def _get_query_zone_class(self, msg):
- question = msg.get_question()[0]
- return question.get_class().to_text()
-
def _send_data(self, sock_fd, data):
size = len(data)
total_count = 0
@@ -238,51 +298,49 @@ class XfroutSession():
msg.set_rcode(rcode_)
self._send_message(sock_fd, msg, self._tsig_ctx)
- def _zone_has_soa(self, zone):
- '''Judge if the zone has an SOA record.'''
- # In some sense, the SOA defines a zone.
- # If the current name server has authority for the
- # specific zone, we need to judge if the zone has an SOA record;
- # if not, we consider the zone has incomplete data, so xfrout can't
- # serve for it.
- if sqlite3_ds.get_zone_soa(zone, self._server.get_db_file()):
- return True
-
- return False
-
- def _zone_exist(self, zonename):
- '''Judge if the zone is configured by config manager.'''
- # Currently, if we find the zone in datasource successfully, we
- # consider the zone is configured, and the current name server has
- # authority for the specific zone.
- # TODO: should get zone's configuration from cfgmgr or other place
- # in future.
- return sqlite3_ds.zone_exist(zonename, self._server.get_db_file())
-
def _check_xfrout_available(self, zone_name):
'''Check if xfr request can be responsed.
TODO, Get zone's configuration from cfgmgr or some other place
eg. check allow_transfer setting,
+
'''
- # If the current name server does not have authority for the
- # zone, xfrout can't serve for it, return rcode NOTAUTH.
- if not self._zone_exist(zone_name):
+
+ # Identify the data source for the requested zone and see if it has
+ # SOA while initializing objects used for request processing later.
+ # We should eventually generalize this so that we can choose the
+ # appropriate data source from (possible) multiple candidates.
+ # We should eventually take into account the RR class here.
+ # For now, we hardcode a particular type (SQLite3-based), and only
+ # consider that one.
+ datasrc_config = '{ "database_file": "' + \
+ self._server.get_db_file() + '"}'
+ self._datasrc_client = self.ClientClass('sqlite3', datasrc_config)
+ try:
+ # Note that we disable 'adjust_ttl'. In xfr-out we need to
+ # preserve as many things as possible (even if it's half broken)
+ # stored in the zone.
+ self._iterator = self._datasrc_client.get_iterator(zone_name,
+ False)
+ except isc.datasrc.Error:
+ # If the current name server does not have authority for the
+ # zone, xfrout can't serve for it, return rcode NOTAUTH.
+ # Note: this exception can happen for other reasons. We should
+ # update get_iterator() API so that we can distinguish "no such
+ # zone" and other cases (#1373). For now we consider all these
+ # cases as NOTAUTH.
return Rcode.NOTAUTH()
# If we are an authoritative name server for the zone, but fail
# to find the zone's SOA record in datasource, xfrout can't
# provide zone transfer for it.
- if not self._zone_has_soa(zone_name):
+ self._soa = self._iterator.get_soa()
+ if self._soa is None or self._soa.get_rdata_count() != 1:
return Rcode.SERVFAIL()
- #TODO, check allow_transfer
- if not self._server.increase_transfers_counter():
- return Rcode.REFUSED()
-
return Rcode.NOERROR()
- def dns_xfrout_start(self, sock_fd, msg_query):
+ def dns_xfrout_start(self, sock_fd, msg_query, quota_ok=True):
rcode_, msg = self._parse_query_message(msg_query)
#TODO. create query message and parse header
if rcode_ is None: # Dropped by ACL
@@ -292,29 +350,40 @@ class XfroutSession():
elif rcode_ != Rcode.NOERROR():
return self._reply_query_with_error_rcode(msg, sock_fd,
Rcode.FORMERR())
+ elif not quota_ok:
+ logger.warn(XFROUT_QUERY_QUOTA_EXCCEEDED, self._request_type,
+ format_addrinfo(self._remote),
+ self._server._max_transfers_out)
+ return self._reply_query_with_error_rcode(msg, sock_fd,
+ Rcode.REFUSED())
- zone_name = self._get_query_zone_name(msg)
- zone_class_str = self._get_query_zone_class(msg)
- # TODO: should we not also include class in the check?
- rcode_ = self._check_xfrout_available(zone_name)
+ question = msg.get_question()[0]
+ zone_name = question.get_name()
+ zone_class = question.get_class()
+ zone_str = format_zone_str(zone_name, zone_class) # for logging
+ # TODO: we should also include class in the check
+ try:
+ rcode_ = self._check_xfrout_available(zone_name)
+ except Exception as ex:
+ logger.error(XFROUT_XFR_TRANSFER_CHECK_ERROR, self._request_type,
+ format_addrinfo(self._remote), zone_str, ex)
+ rcode_ = Rcode.SERVFAIL()
if rcode_ != Rcode.NOERROR():
- logger.info(XFROUT_AXFR_TRANSFER_FAILED, zone_name,
- zone_class_str, rcode_.to_text())
+ logger.info(XFROUT_AXFR_TRANSFER_FAILED, self._request_type,
+ format_addrinfo(self._remote), zone_str, rcode_)
return self._reply_query_with_error_rcode(msg, sock_fd, rcode_)
try:
- logger.info(XFROUT_AXFR_TRANSFER_STARTED, zone_name, zone_class_str)
- self._reply_xfrout_query(msg, sock_fd, zone_name)
+ logger.info(XFROUT_AXFR_TRANSFER_STARTED, self._request_type,
+ format_addrinfo(self._remote), zone_str)
+ self._reply_xfrout_query(msg, sock_fd)
except Exception as err:
- logger.error(XFROUT_AXFR_TRANSFER_ERROR, zone_name,
- zone_class_str, str(err))
+ logger.error(XFROUT_AXFR_TRANSFER_ERROR, self._request_type,
+ format_addrinfo(self._remote), zone_str, err)
pass
- logger.info(XFROUT_AXFR_TRANSFER_DONE, zone_name, zone_class_str)
-
- self._server.decrease_transfers_counter()
- return
-
+ logger.info(XFROUT_AXFR_TRANSFER_DONE, self._request_type,
+ format_addrinfo(self._remote), zone_str)
def _clear_message(self, msg):
qid = msg.get_qid()
@@ -329,16 +398,6 @@ class XfroutSession():
msg.set_header_flag(Message.HEADERFLAG_QR)
return msg
- def _create_rrset_from_db_record(self, record):
- '''Create one rrset from one record of datasource, if the schema of record is changed,
- This function should be updated first.
- '''
- rrtype_ = RRType(record[5])
- rdata_ = Rdata(rrtype_, RRClass("IN"), " ".join(record[7:]))
- rrset_ = RRset(Name(record[2]), RRClass("IN"), rrtype_, RRTTL( int(record[4])))
- rrset_.add_rdata(rdata_)
- return rrset_
-
def _send_message_with_last_soa(self, msg, sock_fd, rrset_soa, message_upper_len,
count_since_last_tsig_sign):
'''Add the SOA record to the end of message. If it can't be
@@ -361,33 +420,30 @@ class XfroutSession():
self._send_message(sock_fd, msg, self._tsig_ctx)
- def _reply_xfrout_query(self, msg, sock_fd, zone_name):
+ def _reply_xfrout_query(self, msg, sock_fd):
#TODO, there should be a better way to insert rrset.
count_since_last_tsig_sign = TSIG_SIGN_EVERY_NTH
msg.make_response()
msg.set_header_flag(Message.HEADERFLAG_AA)
- soa_record = sqlite3_ds.get_zone_soa(zone_name, self._server.get_db_file())
- rrset_soa = self._create_rrset_from_db_record(soa_record)
- msg.add_rrset(Message.SECTION_ANSWER, rrset_soa)
+ msg.add_rrset(Message.SECTION_ANSWER, self._soa)
- message_upper_len = get_rrset_len(rrset_soa) + self._tsig_len
+ message_upper_len = get_rrset_len(self._soa) + self._tsig_len
- for rr_data in sqlite3_ds.get_zone_datas(zone_name, self._server.get_db_file()):
- if self._server._shutdown_event.is_set(): # Check if xfrout is shutdown
+ for rrset in self._iterator:
+ # Check if xfrout is shutdown
+ if self._server._shutdown_event.is_set():
logger.info(XFROUT_STOPPING)
return
- # TODO: RRType.SOA() ?
- if RRType(rr_data[5]) == RRType("SOA"): #ignore soa record
- continue
- rrset_ = self._create_rrset_from_db_record(rr_data)
+ if rrset.get_type() == RRType.SOA():
+ continue
# We calculate the maximum size of the RRset (i.e. the
# size without compression) and use that to see if we
# may have reached the limit
- rrset_len = get_rrset_len(rrset_)
+ rrset_len = get_rrset_len(rrset)
if message_upper_len + rrset_len < XFROUT_MAX_MESSAGE_SIZE:
- msg.add_rrset(Message.SECTION_ANSWER, rrset_)
+ msg.add_rrset(Message.SECTION_ANSWER, rrset)
message_upper_len += rrset_len
continue
@@ -400,7 +456,8 @@ class XfroutSession():
count_since_last_tsig_sign += 1
msg = self._clear_message(msg)
- msg.add_rrset(Message.SECTION_ANSWER, rrset_) # Add the rrset to the new message
+ # Add the RRset to the new message
+ msg.add_rrset(Message.SECTION_ANSWER, rrset)
# Reserve tsig space for signed packet
if count_since_last_tsig_sign == TSIG_SIGN_EVERY_NTH:
@@ -408,7 +465,8 @@ class XfroutSession():
else:
message_upper_len = rrset_len
- self._send_message_with_last_soa(msg, sock_fd, rrset_soa, message_upper_len,
+ self._send_message_with_last_soa(msg, sock_fd, self._soa,
+ message_upper_len,
count_since_last_tsig_sign)
class UnixSockServer(socketserver_mixin.NoPollMixIn,
@@ -517,9 +575,12 @@ class UnixSockServer(socketserver_mixin.NoPollMixIn,
t.start()
def _guess_remote(self, sock_fd):
- """
- Guess remote address and port of the socket. The sock_fd must be a
- socket
+ """Guess remote address and port of the socket.
+
+ The sock_fd must be a file descriptor of a socket.
+ This method retuns a 3-tuple consisting of address family,
+ socket type, and a 2-tuple with the address (string) and port (int).
+
"""
# This uses a trick. If the socket is IPv4 in reality and we pretend
# it to be IPv6, it returns IPv4 address anyway. This doesn't seem
@@ -531,11 +592,23 @@ class UnixSockServer(socketserver_mixin.NoPollMixIn,
# To make it work even on hosts without IPv6 support
# (Any idea how to simulate this in test?)
sock = socket.fromfd(sock_fd, socket.AF_INET, socket.SOCK_STREAM)
- return sock.getpeername()
+ peer = sock.getpeername()
+
+ # Identify the correct socket family. Due to the above "trick",
+ # we cannot simply use sock.family.
+ family = socket.AF_INET6
+ try:
+ socket.inet_pton(socket.AF_INET6, peer[0])
+ except socket.error:
+ family = socket.AF_INET
+ return (family, socket.SOCK_STREAM, peer)
def finish_request(self, sock_fd, request_data):
'''Finish one request by instantiating RequestHandlerClass.
+ This is an entry point of a separate thread spawned in
+ UnixSockServer.process_request().
+
This method creates a XfroutSession object.
'''
self._lock.acquire()
diff --git a/src/bin/xfrout/xfrout_messages.mes b/src/bin/xfrout/xfrout_messages.mes
index b2e432c..894ade5 100644
--- a/src/bin/xfrout/xfrout_messages.mes
+++ b/src/bin/xfrout/xfrout_messages.mes
@@ -15,17 +15,24 @@
# No namespace declaration - these constants go in the global namespace
# of the xfrout messages python module.
-% XFROUT_AXFR_TRANSFER_DONE transfer of %1/%2 complete
+% XFROUT_AXFR_TRANSFER_DONE %1 client %2: transfer of %3 complete
The transfer of the given zone has been completed successfully, or was
aborted due to a shutdown event.
-% XFROUT_AXFR_TRANSFER_ERROR error transferring zone %1/%2: %3
+% XFROUT_AXFR_TRANSFER_ERROR %1 client %2: error transferring zone %3: %4
An uncaught exception was encountered while sending the response to
an AXFR query. The error message of the exception is included in the
log message, but this error most likely points to incomplete exception
handling in the code.
-% XFROUT_AXFR_TRANSFER_FAILED transfer of %1/%2 failed, rcode: %3
+% XFROUT_XFR_TRANSFER_CHECK_ERROR %1 client %2: check for transfer of %3 failed: %4
+Pre-response check for an incomding XFR request failed unexpectedly.
+The most likely cause of this is that some low level error in the data
+source, but it may also be other general (more unlikely) errors such
+as memory shortage. Some detail of the error is also included in the
+message. The xfrout server tries to return a SERVFAIL response in this case.
+
+% XFROUT_AXFR_TRANSFER_FAILED %1 client %2: transfer of %3 failed, rcode: %4
A transfer out for the given zone failed. An error response is sent
to the client. The given rcode is the rcode that is set in the error
response. This is either NOTAUTH (we are not authoritative for the
@@ -36,7 +43,7 @@ Xfrout/max_transfers_out, has been reached).
# Still a TODO, but when implemented, REFUSED can also mean
# the client is not allowed to transfer the zone
-% XFROUT_AXFR_TRANSFER_STARTED transfer of zone %1/%2 has started
+% XFROUT_AXFR_TRANSFER_STARTED %1 client %2: transfer of zone %3 has started
A transfer out of the given zone has started.
% XFROUT_BAD_TSIG_KEY_STRING bad TSIG key string: %1
@@ -106,16 +113,27 @@ in the log message, but at this point no specific information other
than that could be given. This points to incomplete exception handling
in the code.
-% XFROUT_QUERY_DROPPED request to transfer %1/%2 to [%3]:%4 dropped
-The xfrout process silently dropped a request to transfer zone to given host.
-This is required by the ACLs. The %1 and %2 represent the zone name and class,
-the %3 and %4 the IP address and port of the peer requesting the transfer.
+% XFROUT_QUERY_DROPPED %1 client %2: request to transfer %3 dropped
+The xfrout process silently dropped a request to transfer zone to
+given host. This is required by the ACLs. The %2 represents the IP
+address and port of the peer requesting the transfer, and the %3
+represents the zone name and class.
-% XFROUT_QUERY_REJECTED request to transfer %1/%2 to [%3]:%4 rejected
+% XFROUT_QUERY_REJECTED %1 client %2: request to transfer %3 rejected
The xfrout process rejected (by REFUSED rcode) a request to transfer zone to
-given host. This is because of ACLs. The %1 and %2 represent the zone name and
-class, the %3 and %4 the IP address and port of the peer requesting the
-transfer.
+given host. This is because of ACLs. The %2 represents the IP
+address and port of the peer requesting the transfer, and the %3
+represents the zone name and class.
+
+% XFROUT_QUERY_QUOTA_EXCCEEDED %1 client %2: request denied due to quota (%3)
+The xfr request was rejected because the server was already handling
+the maximum number of allowable transfers as specified in the transfers_out
+configuration parameter, which is also shown in the log message. The
+request was immediately responded and terminated with an RCODE of REFUSED.
+This can happen for a busy xfrout server, and you may want to increase
+this parameter; if the server is being too busy due to requests from
+unexpected clients you may want to restrict the legitimate clients
+with ACL.
% XFROUT_RECEIVE_FILE_DESCRIPTOR_ERROR error receiving the file descriptor for an XFR connection
There was an error receiving the file descriptor for the transfer
diff --git a/src/lib/python/isc/bind10/special_component.py b/src/lib/python/isc/bind10/special_component.py
index bac51ff..1c8bc64 100644
--- a/src/lib/python/isc/bind10/special_component.py
+++ b/src/lib/python/isc/bind10/special_component.py
@@ -113,6 +113,11 @@ class XfrIn(Component):
Component.__init__(self, process, boss, kind, 'Xfrin', None,
boss.start_xfrin)
+class XfrOut(Component):
+ def __init__(self, process, boss, kind, address=None, params=None):
+ Component.__init__(self, process, boss, kind, 'Xfrout', None,
+ boss.start_xfrout)
+
class SetUID(BaseComponent):
"""
This is a pseudo-component which drops root privileges when started
@@ -154,6 +159,7 @@ def get_specials():
'cmdctl': CmdCtl,
# FIXME: Temporary workaround before #1292 is done
'xfrin': XfrIn,
+ 'xfrout': XfrOut,
# TODO: Remove when not needed, workaround before sockcreator works
'setuid': SetUID
}
diff --git a/src/lib/python/isc/notify/notify_out.py b/src/lib/python/isc/notify/notify_out.py
index 6b91c87..af79b7c 100644
--- a/src/lib/python/isc/notify/notify_out.py
+++ b/src/lib/python/isc/notify/notify_out.py
@@ -21,6 +21,7 @@ import threading
import time
import errno
from isc.datasrc import sqlite3_ds
+from isc.datasrc import DataSourceClient
from isc.net import addr
import isc
from isc.log_messages.notify_out_messages import *
@@ -31,7 +32,7 @@ logger = isc.log.Logger("notify_out")
# we can't import we should not start anyway, and logging an error
# is a bad idea since the logging system is most likely not
# initialized yet. see trac ticket #1103
-from pydnspp import *
+from isc.dns import *
ZONE_NEW_DATA_READY_CMD = 'zone_new_data_ready'
_MAX_NOTIFY_NUM = 30
@@ -51,6 +52,24 @@ _BAD_REPLY_PACKET = 5
SOCK_DATA = b's'
+# borrowed from xfrin.py @ #1298. We should eventually unify it.
+def format_zone_str(zone_name, zone_class):
+ """Helper function to format a zone name and class as a string of
+ the form '<name>/<class>'.
+ Parameters:
+ zone_name (isc.dns.Name) name to format
+ zone_class (isc.dns.RRClass) class to format
+ """
+ return zone_name.to_text() + '/' + str(zone_class)
+
+class NotifyOutDataSourceError(Exception):
+ """An exception raised when data source error happens within notify out.
+
+ This exception is expected to be caught within the notify_out module.
+
+ """
+ pass
+
class ZoneNotifyInfo:
'''This class keeps track of notify-out information for one zone.'''
@@ -123,16 +142,20 @@ class NotifyOut:
self._nonblock_event = threading.Event()
def _init_notify_out(self, datasrc_file):
- '''Get all the zones name and its notify target's address
+ '''Get all the zones name and its notify target's address.
+
TODO, currently the zones are got by going through the zone
table in database. There should be a better way to get them
and also the setting 'also_notify', and there should be one
- mechanism to cover the changed datasrc.'''
+ mechanism to cover the changed datasrc.
+
+ '''
self._db_file = datasrc_file
for zone_name, zone_class in sqlite3_ds.get_zones_info(datasrc_file):
zone_id = (zone_name, zone_class)
self._notify_infos[zone_id] = ZoneNotifyInfo(zone_name, zone_class)
- slaves = self._get_notify_slaves_from_ns(zone_name)
+ slaves = self._get_notify_slaves_from_ns(Name(zone_name),
+ RRClass(zone_class))
for item in slaves:
self._notify_infos[zone_id].notify_slaves.append((item, 53))
@@ -234,7 +257,7 @@ class NotifyOut:
def _get_rdata_data(self, rr):
return rr[7].strip()
- def _get_notify_slaves_from_ns(self, zone_name):
+ def _get_notify_slaves_from_ns(self, zone_name, zone_class):
'''Get all NS records, then remove the primary master from ns rrset,
then use the name in NS record rdata part to get the a/aaaa records
in the same zone. the targets listed in a/aaaa record rdata are treated
@@ -242,28 +265,56 @@ class NotifyOut:
Note: this is the simplest way to get the address of slaves,
but not correct, it can't handle the delegation slaves, or the CNAME
and DNAME logic.
- TODO. the function should be provided by one library.'''
- ns_rrset = sqlite3_ds.get_zone_rrset(zone_name, zone_name, 'NS', self._db_file)
- soa_rrset = sqlite3_ds.get_zone_rrset(zone_name, zone_name, 'SOA', self._db_file)
- ns_rr_name = []
- for ns in ns_rrset:
- ns_rr_name.append(self._get_rdata_data(ns))
-
- if len(soa_rrset) > 0:
- sname = (soa_rrset[0][sqlite3_ds.RR_RDATA_INDEX].split(' '))[0].strip() #TODO, bad hardcode to get rdata part
- if sname in ns_rr_name:
- ns_rr_name.remove(sname)
-
- addr_list = []
- for rr_name in ns_rr_name:
- a_rrset = sqlite3_ds.get_zone_rrset(zone_name, rr_name, 'A', self._db_file)
- aaaa_rrset = sqlite3_ds.get_zone_rrset(zone_name, rr_name, 'AAAA', self._db_file)
- for rr in a_rrset:
- addr_list.append(self._get_rdata_data(rr))
- for rr in aaaa_rrset:
- addr_list.append(self._get_rdata_data(rr))
-
- return addr_list
+ TODO. the function should be provided by one library.
+
+ '''
+ # Prepare data source client. This should eventually be moved to
+ # an earlier stage of initialization and also support multiple
+ # data sources.
+ datasrc_config = '{ "database_file": "' + self._db_file + '"}'
+ try:
+ result, finder = DataSourceClient('sqlite3',
+ datasrc_config).find_zone(
+ zone_name)
+ except isc.datasrc.Error as ex:
+ logger.error(NOTIFY_OUT_DATASRC_ACCESS_FAILURE, ex)
+ return []
+ if result is not DataSourceClient.SUCCESS:
+ logger.error(NOTIFY_OUT_DATASRC_ZONE_NOT_FOUND,
+ format_zone_str(zone_name, zone_class))
+ return []
+
+ result, ns_rrset = finder.find(zone_name, RRType.NS(), None,
+ finder.FIND_DEFAULT)
+ if result is not finder.SUCCESS or ns_rrset is None:
+ logger.warn(NOTIFY_OUT_ZONE_NO_NS,
+ format_zone_str(zone_name, zone_class))
+ return []
+ result, soa_rrset = finder.find(zone_name, RRType.SOA(), None,
+ finder.FIND_DEFAULT)
+ if result is not finder.SUCCESS or soa_rrset is None or \
+ soa_rrset.get_rdata_count() != 1:
+ logger.warn(NOTIFY_OUT_ZONE_BAD_SOA,
+ format_zone_str(zone_name, zone_class))
+ return [] # broken zone anyway, stop here.
+ soa_mname = Name(soa_rrset.get_rdata()[0].to_text().split(' ')[0])
+
+ addrs = []
+ for ns_rdata in ns_rrset.get_rdata():
+ ns_name = Name(ns_rdata.to_text())
+ if soa_mname == ns_name:
+ continue
+ result, rrset = finder.find(ns_name, RRType.A(), None,
+ finder.FIND_DEFAULT)
+ if result is finder.SUCCESS and rrset is not None:
+ addrs.extend([a.to_text() for a in rrset.get_rdata()])
+
+ result, rrset = finder.find(ns_name, RRType.AAAA(), None,
+ finder.FIND_DEFAULT)
+ if result is finder.SUCCESS and rrset is not None:
+ addrs.extend([aaaa.to_text() for aaaa in rrset.get_rdata()])
+
+ return addrs
def _prepare_select_info(self):
'''
@@ -404,8 +455,9 @@ class NotifyOut:
self._nonblock_event.set()
def _send_notify_message_udp(self, zone_notify_info, addrinfo):
- msg, qid = self._create_notify_message(zone_notify_info.zone_name,
- zone_notify_info.zone_class)
+ msg, qid = self._create_notify_message(
+ Name(zone_notify_info.zone_name),
+ RRClass(zone_notify_info.zone_class))
render = MessageRenderer()
render.set_length_limit(512)
msg.to_wire(render)
@@ -426,17 +478,6 @@ class NotifyOut:
return True
- def _create_rrset_from_db_record(self, record, zone_class):
- '''Create one rrset from one record of datasource, if the schema of record is changed,
- This function should be updated first. TODO, the function is copied from xfrout, there
- should be library for creating one rrset. '''
- rrtype_ = RRType(record[sqlite3_ds.RR_TYPE_INDEX])
- rdata_ = Rdata(rrtype_, RRClass(zone_class), " ".join(record[sqlite3_ds.RR_RDATA_INDEX:]))
- rrset_ = RRset(Name(record[sqlite3_ds.RR_NAME_INDEX]), RRClass(zone_class), \
- rrtype_, RRTTL( int(record[sqlite3_ds.RR_TTL_INDEX])))
- rrset_.add_rdata(rdata_)
- return rrset_
-
def _create_notify_message(self, zone_name, zone_class):
msg = Message(Message.RENDER)
qid = random.randint(0, 0xFFFF)
@@ -444,14 +485,36 @@ class NotifyOut:
msg.set_opcode(Opcode.NOTIFY())
msg.set_rcode(Rcode.NOERROR())
msg.set_header_flag(Message.HEADERFLAG_AA)
- question = Question(Name(zone_name), RRClass(zone_class), RRType('SOA'))
- msg.add_question(question)
- # Add soa record to answer section
- soa_record = sqlite3_ds.get_zone_rrset(zone_name, zone_name, 'SOA', self._db_file)
- rrset_soa = self._create_rrset_from_db_record(soa_record[0], zone_class)
- msg.add_rrset(Message.SECTION_ANSWER, rrset_soa)
+ msg.add_question(Question(zone_name, zone_class, RRType.SOA()))
+ msg.add_rrset(Message.SECTION_ANSWER, self._get_zone_soa(zone_name,
+ zone_class))
return msg, qid
+ def _get_zone_soa(self, zone_name, zone_class):
+ # We create (and soon drop) the data source client here because
+ # clients should be thread specific. We could let the main thread
+ # loop (_dispatcher) create and retain the client in order to avoid
+ # the overhead when we generalize the interface (and we may also
+ # revisit the design of notify_out more substantially anyway).
+ datasrc_config = '{ "database_file": "' + self._db_file + '"}'
+ result, finder = DataSourceClient('sqlite3',
+ datasrc_config).find_zone(zone_name)
+ if result is not DataSourceClient.SUCCESS:
+ raise NotifyOutDataSourceError('_get_zone_soa: Zone ' +
+ zone_name.to_text() + '/' +
+ zone_class.to_text() + ' not found')
+
+ result, soa_rrset = finder.find(zone_name, RRType.SOA(), None,
+ finder.FIND_DEFAULT)
+ if result is not finder.SUCCESS or soa_rrset is None or \
+ soa_rrset.get_rdata_count() != 1:
+ raise NotifyOutDataSourceError('_get_zone_soa: Zone ' +
+ zone_name.to_text() + '/' +
+ zone_class.to_text() +
+ ' is broken: no valid SOA found')
+
+ return soa_rrset
+
def _handle_notify_reply(self, zone_notify_info, msg_data, from_addr):
'''Parse the notify reply message.
rcode will not checked here, If we get the response
diff --git a/src/lib/python/isc/notify/notify_out_messages.mes b/src/lib/python/isc/notify/notify_out_messages.mes
index 570f51e..b77a60c 100644
--- a/src/lib/python/isc/notify/notify_out_messages.mes
+++ b/src/lib/python/isc/notify/notify_out_messages.mes
@@ -81,3 +81,24 @@ programming error, since all exceptions should have been caught
explicitly. Please file a bug report. Since there was a response,
no more notifies will be sent to this server for this notification
event.
+
+% NOTIFY_OUT_DATASRC_ACCESS_FAILURE failed to get access to data source: %1
+notify_out failed to get access to one of configured data sources.
+Detailed error is shown in the log message. This can be either a
+configuration error or installation setup failure.
+
+% NOTIFY_OUT_DATASRC_ZONE_NOT_FOUND Zone %1 is not found
+notify_out attempted to get slave information of a zone but the zone
+isn't found in the expected data source. This shouldn't happen,
+because notify_out first identifies a list of available zones before
+this process. So this means some critical inconsistency in the data
+source or software bug.
+
+% NOTIFY_OUT_ZONE_NO_NS Zone %1 doesn't have NS RR
+This is a warning issued when the notify_out module finds a zone that
+doesn't have an NS RR. Notify message won't be sent to such a zone.
+
+% NOTIFY_OUT_ZONE_BAD_SOA Zone %1 is invalid in terms of SOA
+This is a warning issued when the notify_out module finds a zone that
+doesn't have an SOA RR or has multiple SOA RRs. Notify message won't
+be sent to such a zone.
diff --git a/src/lib/python/isc/notify/tests/Makefile.am b/src/lib/python/isc/notify/tests/Makefile.am
index 00c2eee..6b62b90 100644
--- a/src/lib/python/isc/notify/tests/Makefile.am
+++ b/src/lib/python/isc/notify/tests/Makefile.am
@@ -1,12 +1,20 @@
PYCOVERAGE_RUN=@PYCOVERAGE_RUN@
PYTESTS = notify_out_test.py
EXTRA_DIST = $(PYTESTS)
+EXTRA_DIST += testdata/test.sqlite3 testdata/brokentest.sqlite3
+# The rest of the files are actually not necessary, but added for reference
+EXTRA_DIST += testdata/example.com testdata/example.net
+EXTRA_DIST += testdata/nons.example testdata/nosoa.example
+EXTRA_DIST += testdata/multisoa.example
# If necessary (rare cases), explicitly specify paths to dynamic libraries
# required by loadable python modules.
LIBRARY_PATH_PLACEHOLDER =
if SET_ENV_LIBRARY_PATH
LIBRARY_PATH_PLACEHOLDER += $(ENV_LIBRARY_PATH)=$(abs_top_builddir)/src/lib/cryptolink/.libs:$(abs_top_builddir)/src/lib/dns/.libs:$(abs_top_builddir)/src/lib/dns/python/.libs:$(abs_top_builddir)/src/lib/cc/.libs:$(abs_top_builddir)/src/lib/config/.libs:$(abs_top_builddir)/src/lib/log/.libs:$(abs_top_builddir)/src/lib/util/.libs:$(abs_top_builddir)/src/lib/exceptions/.libs:$(abs_top_builddir)/src/lib/datasrc/.libs:$$$(ENV_LIBRARY_PATH)
+else
+# Some systems need the ds path even if not all paths are necessary
+LIBRARY_PATH_PLACEHOLDER += $(ENV_LIBRARY_PATH)=$(abs_top_builddir)/src/lib/datasrc/.libs
endif
# test using command-line arguments, so use check-local target instead of TESTS
@@ -20,5 +28,6 @@ endif
echo Running test: $$pytest ; \
PYTHONPATH=$(COMMON_PYTHON_PATH):$(abs_top_builddir)/src/lib/dns/python/.libs \
$(LIBRARY_PATH_PLACEHOLDER) \
+ TESTDATASRCDIR=$(abs_top_srcdir)/src/lib/python/isc/notify/tests/testdata/ \
$(PYCOVERAGE_RUN) $(abs_srcdir)/$$pytest || exit ; \
done
diff --git a/src/lib/python/isc/notify/tests/notify_out_test.py b/src/lib/python/isc/notify/tests/notify_out_test.py
index 83f6d1a..d64c203 100644
--- a/src/lib/python/isc/notify/tests/notify_out_test.py
+++ b/src/lib/python/isc/notify/tests/notify_out_test.py
@@ -19,9 +19,11 @@ import os
import tempfile
import time
import socket
-from isc.datasrc import sqlite3_ds
from isc.notify import notify_out, SOCK_DATA
import isc.log
+from isc.dns import *
+
+TESTDATA_SRCDIR = os.getenv("TESTDATASRCDIR")
# our fake socket, where we can read and insert messages
class MockSocket():
@@ -92,10 +94,8 @@ class TestZoneNotifyInfo(unittest.TestCase):
class TestNotifyOut(unittest.TestCase):
def setUp(self):
- self._db_file = tempfile.NamedTemporaryFile(delete=False)
- sqlite3_ds.load(self._db_file.name, 'example.net.', self._example_net_data_reader)
- sqlite3_ds.load(self._db_file.name, 'example.com.', self._example_com_data_reader)
- self._notify = notify_out.NotifyOut(self._db_file.name)
+ self._db_file = TESTDATA_SRCDIR + '/test.sqlite3'
+ self._notify = notify_out.NotifyOut(self._db_file)
self._notify._notify_infos[('example.com.', 'IN')] = MockZoneNotifyInfo('example.com.', 'IN')
self._notify._notify_infos[('example.com.', 'CH')] = MockZoneNotifyInfo('example.com.', 'CH')
self._notify._notify_infos[('example.net.', 'IN')] = MockZoneNotifyInfo('example.net.', 'IN')
@@ -110,10 +110,6 @@ class TestNotifyOut(unittest.TestCase):
com_ch_info = self._notify._notify_infos[('example.com.', 'CH')]
com_ch_info.notify_slaves.append(('1.1.1.1', 5353))
- def tearDown(self):
- self._db_file.close()
- os.unlink(self._db_file.name)
-
def test_send_notify(self):
notify_out._MAX_NOTIFY_NUM = 2
@@ -309,39 +305,9 @@ class TestNotifyOut(unittest.TestCase):
self._notify._zone_notify_handler(example_net_info, notify_out._EVENT_READ)
self.assertNotEqual(cur_tgt, example_net_info._notify_current)
-
- def _example_net_data_reader(self):
- zone_data = [
- ('example.net.', '1000', 'IN', 'SOA', 'a.dns.example.net. mail.example.net. 1 1 1 1 1'),
- ('example.net.', '1000', 'IN', 'NS', 'a.dns.example.net.'),
- ('example.net.', '1000', 'IN', 'NS', 'b.dns.example.net.'),
- ('example.net.', '1000', 'IN', 'NS', 'c.dns.example.net.'),
- ('a.dns.example.net.', '1000', 'IN', 'A', '1.1.1.1'),
- ('a.dns.example.net.', '1000', 'IN', 'AAAA', '2:2::2:2'),
- ('b.dns.example.net.', '1000', 'IN', 'A', '3.3.3.3'),
- ('b.dns.example.net.', '1000', 'IN', 'AAAA', '4:4::4:4'),
- ('b.dns.example.net.', '1000', 'IN', 'AAAA', '5:5::5:5'),
- ('c.dns.example.net.', '1000', 'IN', 'A', '6.6.6.6'),
- ('c.dns.example.net.', '1000', 'IN', 'A', '7.7.7.7'),
- ('c.dns.example.net.', '1000', 'IN', 'AAAA', '8:8::8:8')]
- for item in zone_data:
- yield item
-
- def _example_com_data_reader(self):
- zone_data = [
- ('example.com.', '1000', 'IN', 'SOA', 'a.dns.example.com. mail.example.com. 1 1 1 1 1'),
- ('example.com.', '1000', 'IN', 'NS', 'a.dns.example.com.'),
- ('example.com.', '1000', 'IN', 'NS', 'b.dns.example.com.'),
- ('example.com.', '1000', 'IN', 'NS', 'c.dns.example.com.'),
- ('a.dns.example.com.', '1000', 'IN', 'A', '1.1.1.1'),
- ('b.dns.example.com.', '1000', 'IN', 'A', '3.3.3.3'),
- ('b.dns.example.com.', '1000', 'IN', 'AAAA', '4:4::4:4'),
- ('b.dns.example.com.', '1000', 'IN', 'AAAA', '5:5::5:5')]
- for item in zone_data:
- yield item
-
def test_get_notify_slaves_from_ns(self):
- records = self._notify._get_notify_slaves_from_ns('example.net.')
+ records = self._notify._get_notify_slaves_from_ns(Name('example.net.'),
+ RRClass.IN())
self.assertEqual(6, len(records))
self.assertEqual('8:8::8:8', records[5])
self.assertEqual('7.7.7.7', records[4])
@@ -350,14 +316,32 @@ class TestNotifyOut(unittest.TestCase):
self.assertEqual('4:4::4:4', records[1])
self.assertEqual('3.3.3.3', records[0])
- records = self._notify._get_notify_slaves_from_ns('example.com.')
+ records = self._notify._get_notify_slaves_from_ns(Name('example.com.'),
+ RRClass.IN())
self.assertEqual(3, len(records))
self.assertEqual('5:5::5:5', records[2])
self.assertEqual('4:4::4:4', records[1])
self.assertEqual('3.3.3.3', records[0])
+ def test_get_notify_slaves_from_ns_unusual(self):
+ self._notify._db_file = TESTDATA_SRCDIR + '/brokentest.sqlite3'
+ self.assertEqual([], self._notify._get_notify_slaves_from_ns(
+ Name('nons.example'), RRClass.IN()))
+ self.assertEqual([], self._notify._get_notify_slaves_from_ns(
+ Name('nosoa.example'), RRClass.IN()))
+ self.assertEqual([], self._notify._get_notify_slaves_from_ns(
+ Name('multisoa.example'), RRClass.IN()))
+
+ self.assertEqual([], self._notify._get_notify_slaves_from_ns(
+ Name('nosuchzone.example'), RRClass.IN()))
+
+ # This will cause failure in getting access to the data source.
+ self._notify._db_file = TESTDATA_SRCDIR + '/nodir/error.sqlite3'
+ self.assertEqual([], self._notify._get_notify_slaves_from_ns(
+ Name('example.com'), RRClass.IN()))
+
def test_init_notify_out(self):
- self._notify._init_notify_out(self._db_file.name)
+ self._notify._init_notify_out(self._db_file)
self.assertListEqual([('3.3.3.3', 53), ('4:4::4:4', 53), ('5:5::5:5', 53)],
self._notify._notify_infos[('example.com.', 'IN')].notify_slaves)
@@ -417,6 +401,5 @@ class TestNotifyOut(unittest.TestCase):
if __name__== "__main__":
isc.log.init("bind10")
+ isc.log.resetUnitTestRootLogger()
unittest.main()
-
-
diff --git a/src/lib/python/isc/notify/tests/testdata/brokentest.sqlite3 b/src/lib/python/isc/notify/tests/testdata/brokentest.sqlite3
new file mode 100644
index 0000000..61e766c
Binary files /dev/null and b/src/lib/python/isc/notify/tests/testdata/brokentest.sqlite3 differ
diff --git a/src/lib/python/isc/notify/tests/testdata/example.com b/src/lib/python/isc/notify/tests/testdata/example.com
new file mode 100644
index 0000000..5d59819
--- /dev/null
+++ b/src/lib/python/isc/notify/tests/testdata/example.com
@@ -0,0 +1,10 @@
+;; This is the source of a zone stored in test.sqlite3. It's provided
+;; for reference purposes only.
+example.com. 1000 IN SOA a.dns.example.com. mail.example.com. 1 1 1 1 1
+example.com. 1000 IN NS a.dns.example.com.
+example.com. 1000 IN NS b.dns.example.com.
+example.com. 1000 IN NS c.dns.example.com.
+a.dns.example.com. 1000 IN A 1.1.1.1
+b.dns.example.com. 1000 IN A 3.3.3.3
+b.dns.example.com. 1000 IN AAAA 4:4::4:4
+b.dns.example.com. 1000 IN AAAA 5:5::5:5
diff --git a/src/lib/python/isc/notify/tests/testdata/example.net b/src/lib/python/isc/notify/tests/testdata/example.net
new file mode 100644
index 0000000..001d2d9
--- /dev/null
+++ b/src/lib/python/isc/notify/tests/testdata/example.net
@@ -0,0 +1,14 @@
+;; This is the source of a zone stored in test.sqlite3. It's provided
+;; for reference purposes only.
+example.net. 1000 IN SOA a.dns.example.net. mail.example.net. 1 1 1 1 1
+example.net. 1000 IN NS a.dns.example.net.
+example.net. 1000 IN NS b.dns.example.net.
+example.net. 1000 IN NS c.dns.example.net.
+a.dns.example.net. 1000 IN A 1.1.1.1
+a.dns.example.net. 1000 IN AAAA 2:2::2:2
+b.dns.example.net. 1000 IN A 3.3.3.3
+b.dns.example.net. 1000 IN AAAA 4:4::4:4
+b.dns.example.net. 1000 IN AAAA 5:5::5:5
+c.dns.example.net. 1000 IN A 6.6.6.6
+c.dns.example.net. 1000 IN A 7.7.7.7
+c.dns.example.net. 1000 IN AAAA 8:8::8:8
diff --git a/src/lib/python/isc/notify/tests/testdata/multisoa.example b/src/lib/python/isc/notify/tests/testdata/multisoa.example
new file mode 100644
index 0000000..eca2fbd
--- /dev/null
+++ b/src/lib/python/isc/notify/tests/testdata/multisoa.example
@@ -0,0 +1,5 @@
+;; This is the source of a zone stored in test.sqlite3. It's provided
+;; for reference purposes only.
+multisoa.example. 1000 IN SOA a.dns.multisoa.example. mail.multisoa.example. 1 1 1 1 1
+multisoa.example. 1000 IN SOA a.dns.multisoa.example. mail.multisoa.example. 2 2 2 2 2
+multisoa.example. 1000 IN NS a.dns.multisoa.example.
diff --git a/src/lib/python/isc/notify/tests/testdata/nons.example b/src/lib/python/isc/notify/tests/testdata/nons.example
new file mode 100644
index 0000000..c1fc1b8
--- /dev/null
+++ b/src/lib/python/isc/notify/tests/testdata/nons.example
@@ -0,0 +1,3 @@
+;; This is the source of a zone stored in test.sqlite3. It's provided
+;; for reference purposes only.
+nons.example. 1000 IN SOA a.dns.nons.example. mail.nons.example. 1 1 1 1 1
diff --git a/src/lib/python/isc/notify/tests/testdata/nosoa.example b/src/lib/python/isc/notify/tests/testdata/nosoa.example
new file mode 100644
index 0000000..18e87e1
--- /dev/null
+++ b/src/lib/python/isc/notify/tests/testdata/nosoa.example
@@ -0,0 +1,7 @@
+;; This is the source of a zone stored in test.sqlite3. It's provided
+;; for reference purposes only.
+;; (SOA has been removed)
+nosoa.example. 1000 IN SOA a.dns.example.com. mail.example.com. 1 1 1 1 1
+nosoa.example. 1000 IN NS a.dns.nosoa.example.
+nosoa.example. 1000 IN NS b.dns.nosoa.example.
+nosoa.example. 1000 IN NS c.dns.nosoa.example.
diff --git a/src/lib/python/isc/notify/tests/testdata/test.sqlite3 b/src/lib/python/isc/notify/tests/testdata/test.sqlite3
new file mode 100644
index 0000000..e3cadb0
Binary files /dev/null and b/src/lib/python/isc/notify/tests/testdata/test.sqlite3 differ
More information about the bind10-changes
mailing list