summaryrefslogtreecommitdiff
path: root/src/conf_mode/protocols_pim6.py
blob: 6a1235ba506848d2e01cc64d6d2fac004f0ac146 (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
#!/usr/bin/env python3
#
# Copyright (C) 2023 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/>.

from ipaddress import IPv6Address
from sys import exit
from typing import Optional

from vyos import ConfigError, airbag, frr
from vyos.config import Config, ConfigDict
from vyos.configdict import node_changed
from vyos.configverify import verify_interface_exists
from vyos.template import render_to_string

airbag.enable()


def get_config(config=None):
    if config:
        conf = config
    else:
        conf = Config()
    base = ['protocols', 'pim6']
    pim6 = conf.get_config_dict(base, key_mangling=('-', '_'),
                                 get_first_key=True, with_recursive_defaults=True)

    # FRR has VRF support for different routing daemons. As interfaces belong
    # to VRFs - or the global VRF, we need to check for changed interfaces so
    # that they will be properly rendered for the FRR config. Also this eases
    # removal of interfaces from the running configuration.
    interfaces_removed = node_changed(conf, base + ['interface'])
    if interfaces_removed:
        pim6['interface_removed'] = list(interfaces_removed)

    return pim6


def verify(pim6):
    if pim6 is None:
        return

    for interface, interface_config in pim6.get('interface', {}).items():
        verify_interface_exists(interface)
        if 'mld' in interface_config:
            mld = interface_config['mld']
            for group in mld.get('join', {}).keys():
                # Validate multicast group address
                if not IPv6Address(group).is_multicast:
                    raise ConfigError(f"{group} is not a multicast group")


def generate(pim6):
    if pim6 is None:
        return

    pim6['new_frr_config'] = render_to_string('frr/pim6d.frr.j2', pim6)


def apply(pim6):
    if pim6 is None:
        return

    pim6_daemon = 'pim6d'

    # Save original configuration prior to starting any commit actions
    frr_cfg = frr.FRRConfig()

    frr_cfg.load_configuration(pim6_daemon)

    for key in ['interface', 'interface_removed']:
        if key not in pim6:
            continue
        for interface in pim6[key]:
            frr_cfg.modify_section(
                f'^interface {interface}', stop_pattern='^exit', remove_stop_mark=True)

    if 'new_frr_config' in pim6:
        frr_cfg.add_before(frr.default_add_before, pim6['new_frr_config'])
    frr_cfg.commit_configuration(pim6_daemon)


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