summaryrefslogtreecommitdiff
path: root/src/conf_mode/ntp.py
blob: 0ecb4d73657e71fb2f39314e7fb0cc76db8a4b39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
#!/usr/bin/env python3
#
# Copyright (C) 2018-2022 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

from vyos.config import Config
from vyos.configdict import is_node_changed
from vyos.configverify import verify_vrf
from vyos.configverify import verify_interface_exists
from vyos.util import call
from vyos.util import get_interface_config
from vyos.template import render
from vyos import ConfigError
from vyos import airbag
airbag.enable()

config_file = r'/run/ntpd/ntpd.conf'
systemd_override = r'/etc/systemd/system/ntp.service.d/override.conf'

def get_config(config=None):
    if config:
        conf = config
    else:
        conf = Config()
    base = ['system', 'ntp']
    if not conf.exists(base):
        return None

    ntp = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True)
    ntp['config_file'] = config_file

    tmp = is_node_changed(conf, base + ['vrf'])
    if tmp: ntp.update({'restart_required': {}})

    return ntp

def verify(ntp):
    # bail out early - looks like removal from running config
    if not ntp:
        return None

    if 'allow_clients' in ntp and 'server' not in ntp:
        raise ConfigError('NTP server not configured')

    verify_vrf(ntp)

    if 'interface' in ntp:
        # If ntpd should listen on a given interface, ensure it exists
        for interface in ntp['interface']:
            verify_interface_exists(interface)

            # If we run in a VRF, our interface must belong to this VRF, too
            if 'vrf' in ntp:
                tmp = get_interface_config(interface)
                vrf_name = ntp['vrf']
                if 'master' not in tmp or tmp['master'] != vrf_name:
                    raise ConfigError(f'NTP runs in VRF "{vrf_name}" - "{interface}" '\
                                      f'does not belong to this VRF!')

    return None

def generate(ntp):
    # bail out early - looks like removal from running config
    if not ntp:
        return None

    render(config_file, 'ntp/ntpd.conf.j2', ntp)
    render(systemd_override, 'ntp/override.conf.j2', ntp)

    return None

def apply(ntp):
    systemd_service = 'ntp.service'
    # Reload systemd manager configuration
    call('systemctl daemon-reload')

    if not ntp:
        # NTP support is removed in the commit
        call(f'systemctl stop {systemd_service}')
        if os.path.exists(config_file):
            os.unlink(config_file)
        if os.path.isfile(systemd_override):
            os.unlink(systemd_override)
        return

    # we need to restart the service if e.g. the VRF name changed
    systemd_action = 'reload-or-restart'
    if 'restart_required' in ntp:
        systemd_action = 'restart'

    call(f'systemctl {systemd_action} {systemd_service}')
    return None

if __name__ == '__main__':
    try:
        c = get_config()
        verify(c)
        generate(c)
        apply(c)
    except ConfigError as e:
        print(e)
        exit(1)