Page MenuHomeVyOS Platform
Files F119064508

No OneTemporary
Actions

Size
14 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/src/conf_mode/ntp.py b/src/conf_mode/ntp.py
index bdc8e574c..f706d502f 100755
--- a/src/conf_mode/ntp.py
+++ b/src/conf_mode/ntp.py
@@ -1,173 +1,170 @@
#!/usr/bin/env python3
#
# Copyright (C) 2018 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
import sys
import os
import jinja2
import ipaddress
import copy
from vyos.config import Config
from vyos import ConfigError
config_file = r'/etc/ntp.conf'
# Please be careful if you edit the template.
config_tmpl = """
### Autogenerated by ntp.py ###
#
# Non-configurable defaults
#
driftfile /var/lib/ntp/ntp.drift
# By default, only allow ntpd to query time sources, ignore any incoming requests
-restrict default noquery nopeer notrap nomodify noquery notrust
+restrict default noquery nopeer notrap nomodify
# Local users have unrestricted access, allowing reconfiguration via ntpdc
restrict 127.0.0.1
restrict -6 ::1
#
# Configurable section
#
{% if servers -%}
{% for s in servers -%}
# Server configuration for: {{ s.name }}
server {{ s.name }} iburst {{ s.options | join(" ") }}
-# allow server sync
-restrict {{ s.name }} nomodify notrap
-
{% endfor -%}
{% endif %}
{% if allowed_networks -%}
{% for n in allowed_networks -%}
# Client configuration for network: {{ n.network }}
restrict {{ n.address }} mask {{ n.netmask }} nomodify notrap nopeer
{% endfor -%}
{% endif %}
{% if listen_address -%}
# NTP should listen on configured addresses only
interface ignore wildcard
{% for a in listen_address -%}
interface listen {{ a }}
{% endfor -%}
{% endif %}
"""
default_config_data = {
'servers': [],
'allowed_networks': [],
'listen_address': []
}
def get_config():
ntp = copy.deepcopy(default_config_data)
conf = Config()
if not conf.exists('system ntp'):
return None
else:
conf.set_level('system ntp')
if conf.exists('allow-clients address'):
networks = conf.return_values('allow-clients address')
for n in networks:
addr = ipaddress.ip_network(n)
net = {
"network" : n,
"address" : addr.network_address,
"netmask" : addr.netmask
}
ntp['allowed_networks'].append(net)
if conf.exists('listen-address'):
ntp['listen_address'] = conf.return_values('listen-address')
if conf.exists('server'):
for node in conf.list_nodes('server'):
options = []
server = {
"name": node,
"options": []
}
if conf.exists('server {0} noselect'.format(node)):
options.append('noselect')
if conf.exists('server {0} preempt'.format(node)):
options.append('preempt')
if conf.exists('server {0} prefer'.format(node)):
options.append('prefer')
server['options'] = options
ntp['servers'].append(server)
return ntp
def verify(ntp):
# bail out early - looks like removal from running config
if ntp is None:
return None
# Configuring allowed clients without a server makes no sense
if len(ntp['allowed_networks']) and not len(ntp['servers']):
raise ConfigError('NTP server not configured')
for n in ntp['allowed_networks']:
try:
addr = ipaddress.ip_network( n['network'] )
break
except ValueError:
raise ConfigError("{0} does not appear to be a valid IPv4 or IPv6 network, check host bits!".format(n['network']))
return None
def generate(ntp):
# bail out early - looks like removal from running config
if ntp is None:
return None
tmpl = jinja2.Template(config_tmpl)
config_text = tmpl.render(ntp)
with open(config_file, 'w') as f:
f.write(config_text)
return None
def apply(ntp):
if ntp is not None:
os.system('sudo systemctl restart ntp.service')
else:
# NTP support is removed in the commit
os.system('sudo systemctl stop ntp.service')
os.unlink(config_file)
return None
if __name__ == '__main__':
try:
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
sys.exit(1)
diff --git a/src/tests/test_ntp.py b/src/tests/test_ntp.py
index be47c0432..1cde490b4 100644
--- a/src/tests/test_ntp.py
+++ b/src/tests/test_ntp.py
@@ -1,265 +1,259 @@
#!/usr/bin/env python3
#
# Copyright (C) 2018 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
import os
import tempfile
import unittest
from unittest import TestCase, mock
import ipaddress
from contextlib import ExitStack
import textwrap
from vyos import ConfigError
from vyos.config import Config
try:
from src.conf_mode import ntp
except ModuleNotFoundError: # for unittest.main()
import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '../..'))
from src.conf_mode import ntp
class TestNtp(TestCase):
def test_get_config(self):
tests = [
{
'name': 'empty',
'config': {
'system ntp': None,
},
'expected': None,
},
{
'name': 'full-options',
'config': {
'system ntp': 'yes',
'allow-clients address': ['192.0.2.0/24'],
'listen-address': ['198.51.100.0/24'],
'server': ['example.com'],
'server example.com noselect': 'yes',
'server example.com preempt': 'yes',
'server example.com prefer': 'yes',
},
'expected': {
'allowed_networks': [{
'address': ipaddress.ip_address('192.0.2.0'),
'netmask': ipaddress.ip_address('255.255.255.0'),
'network': '192.0.2.0/24',
}],
'listen_address': ['198.51.100.0/24'],
'servers': [
{'name': 'example.com', 'options': ['noselect', 'preempt', 'prefer']}
]
},
},
{
'name': 'non-options',
'config': {
'system ntp': 'yes',
'allow-clients address': ['192.0.2.0/24'],
'listen-address': ['198.51.100.0/24'],
'server': ['example.com'],
},
'expected': {
'allowed_networks': [{
'address': ipaddress.ip_address('192.0.2.0'),
'netmask': ipaddress.ip_address('255.255.255.0'),
'network': '192.0.2.0/24',
}],
'listen_address': ['198.51.100.0/24'],
'servers': [
{'name': 'example.com', 'options': []}
]
},
},
]
for case in tests:
def mocked_fn(path):
return case['config'].get(path)
with self.subTest(msg = case['name']):
m = {
'return_value': mock.Mock(side_effect = mocked_fn),
'return_values': mock.Mock(side_effect = mocked_fn),
'list_nodes': mock.Mock(side_effect = mocked_fn),
'exists': mock.Mock(side_effect = mocked_fn),
}
with mock.patch.multiple(Config, **m):
actual = ntp.get_config()
self.assertEqual(actual, case['expected'])
def test_verify(self):
tests = [
{
'name': 'none',
'config': None,
'expected': None
},
{
'name': 'valid',
'config': {
'allowed_networks': [{
'address': ipaddress.ip_address('192.0.2.1'),
'netmask': ipaddress.ip_address('255.255.255.0'),
'network': '192.0.2.0/24',
}],
'listen_address': ['198.51.100.0/24'],
'servers': [
{'name': 'example.com', 'options': ['noselect', 'preempt', 'prefer']}
]
},
'expected': None,
},
{
'name': 'not configure servers',
'config': {
'allowed_networks': [{
'address': ipaddress.ip_address('192.0.2.1'),
'netmask': ipaddress.ip_address('255.255.255.0'),
'network': '192.0.2.0/24',
}],
'servers': []
},
'expected': ConfigError,
},
{
'name': 'does not exist in the network',
'config': {
'allowed_networks': [{
'address': ipaddress.ip_address('192.0.2.1'),
'netmask': ipaddress.ip_address('255.255.255.0'),
'network': '192.0.2.0/50', # invalid netmask
}],
'listen_address': ['198.51.100.0/24'],
'servers': [
{'name': 'example.com', 'options': []}
]
},
'expected': ConfigError,
},
]
for case in tests:
with self.subTest(msg = case['name']):
if case['expected'] is not None:
with self.assertRaises(case['expected']):
ntp.verify(case['config'])
else:
ntp.verify(case['config'])
def test_generate(self):
tests = [
{
'name': 'empty',
'config': None,
'expected': '',
},
{
'name': 'valid',
'config': {
'allowed_networks': [
{
'address': ipaddress.ip_address('192.0.2.1'),
'netmask': ipaddress.ip_address('255.255.255.0'),
'network': '192.0.2.0/24',
},
{
'address': ipaddress.ip_address('198.51.100.1'),
'netmask': ipaddress.ip_address('255.255.255.0'),
'network': '198.51.100.0/24',
},
],
'listen_address': ['198.51.100.0/24'],
'servers': [
{'name': '1.example.com', 'options': ['noselect', 'preempt', 'prefer']},
{'name': '2.example.com', 'options': []},
]
},
'expected': textwrap.dedent('''
### Autogenerated by ntp.py ###
#
# Non-configurable defaults
#
driftfile /var/lib/ntp/ntp.drift
# By default, only allow ntpd to query time sources, ignore any incoming requests
- restrict default noquery nopeer notrap nomodify noquery notrust
+ restrict default noquery nopeer notrap nomodify
# Local users have unrestricted access, allowing reconfiguration via ntpdc
restrict 127.0.0.1
restrict -6 ::1
#
# Configurable section
#
# Server configuration for: 1.example.com
server 1.example.com iburst noselect preempt prefer
- # allow server sync
- restrict 1.example.com nomodify notrap
-
# Server configuration for: 2.example.com
server 2.example.com iburst
- # allow server sync
- restrict 2.example.com nomodify notrap
-
# Client configuration for network: 192.0.2.0/24
restrict 192.0.2.1 mask 255.255.255.0 nomodify notrap nopeer
# Client configuration for network: 198.51.100.0/24
restrict 198.51.100.1 mask 255.255.255.0 nomodify notrap nopeer
# NTP should listen on configured addresses only
interface ignore wildcard
interface listen 198.51.100.0/24
'''),
},
]
for case in tests:
with self.subTest(msg = case['name']):
with tempfile.NamedTemporaryFile() as fp:
ntp.config_file = fp.name
ntp.generate(case['config'])
actual = fp.file.read().decode('ascii')
- # print(actual)
+ print(actual)
self.assertEqual(case['expected'], actual)
def test_apply(self):
with tempfile.NamedTemporaryFile(delete = False) as fp:
ntp.config_file = fp.name
with mock.patch('os.system') as os_system:
ntp.apply({}) # some configure
os_system.assert_has_calls([
mock.call('sudo systemctl restart ntp.service'),
])
self.assertTrue(os.path.exists(fp.name))
ntp.apply(None) # empty configure
os_system.assert_has_calls([
mock.call('sudo systemctl stop ntp.service'),
])
self.assertFalse(os.path.exists(fp.name))
if __name__ == "__main__":
unittest.main()

File Metadata

Mime Type
text/x-diff
Expires
Fri, Nov 6, 10:18 AM (54 m, 30 s)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
4645936
Default Alt Text
(14 KB)

Event Timeline