summaryrefslogtreecommitdiff
path: root/src/conf_mode/interfaces_bridge.py
blob: 637db442ac6474960b9181fbbabc0f2190697d1f (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
#!/usr/bin/env python3
#
# Copyright (C) 2019-2024 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 sys import exit

from vyos.config import Config
from vyos.configdict import get_interface_dict
from vyos.configdict import node_changed
from vyos.configdict import is_member
from vyos.configdict import is_source_interface
from vyos.configdict import has_vlan_subinterface_configured
from vyos.configverify import verify_dhcpv6
from vyos.configverify import verify_mirror_redirect
from vyos.configverify import verify_vrf
from vyos.ifconfig import BridgeIf
from vyos.configdict import has_address_configured
from vyos.configdict import has_vrf_configured
from vyos.configdep import set_dependents
from vyos.configdep import call_dependents
from vyos.utils.dict import dict_search
from vyos.utils.network import interface_exists
from vyos import ConfigError

from vyos import airbag
airbag.enable()

def get_config(config=None):
    """
    Retrive CLI config as dictionary. Dictionary can never be empty, as at least the
    interface name will be added or a deleted flag
    """
    if config:
        conf = config
    else:
        conf = Config()
    base = ['interfaces', 'bridge']
    ifname, bridge = get_interface_dict(conf, base)

    # determine which members have been removed
    tmp = node_changed(conf, base + [ifname, 'member', 'interface'])
    if tmp:
        if 'member' in bridge:
            bridge['member'].update({'interface_remove': {t: {} for t in tmp}})
        else:
            bridge.update({'member': {'interface_remove': {t: {} for t in tmp}}})
        for interface in tmp:
            # When using VXLAN member interfaces that are configured for Single
            # VXLAN Device (SVD) we need to call the VXLAN conf-mode script to
            # re-create VLAN to VNI mappings if required, but only if the interface
            # is already live on the system - this must not be done on first commit
            if interface.startswith('vxlan') and interface_exists(interface):
                set_dependents('vxlan', conf, interface)
                _, vxlan = get_interface_dict(conf, ['interfaces', 'vxlan'], ifname=interface)
                bridge['member']['interface_remove'].update({interface: vxlan})
            # When using Wireless member interfaces we need to inform hostapd
            # to properly set-up the bridge
            elif interface.startswith('wlan') and interface_exists(interface):
                set_dependents('wlan', conf, interface)

    if dict_search('member.interface', bridge) is not None:
        for interface in list(bridge['member']['interface']):
            # Check if member interface is already member of another bridge
            tmp = is_member(conf, interface, 'bridge')
            if tmp and bridge['ifname'] not in tmp:
                bridge['member']['interface'][interface].update({'is_bridge_member' : tmp})

            # Check if member interface is already member of a bond
            tmp = is_member(conf, interface, 'bonding')
            if tmp: bridge['member']['interface'][interface].update({'is_bond_member' : tmp})

            # Check if member interface is used as source-interface on another interface
            tmp = is_source_interface(conf, interface)
            if tmp: bridge['member']['interface'][interface].update({'is_source_interface' : tmp})

            # Bridge members must not have an assigned address
            tmp = has_address_configured(conf, interface)
            if tmp: bridge['member']['interface'][interface].update({'has_address' : ''})

            # Bridge members must not have a VRF attached
            tmp = has_vrf_configured(conf, interface)
            if tmp: bridge['member']['interface'][interface].update({'has_vrf' : ''})

            # VLAN-aware bridge members must not have VLAN interface configuration
            tmp = has_vlan_subinterface_configured(conf,interface)
            if 'enable_vlan' in bridge and tmp:
                bridge['member']['interface'][interface].update({'has_vlan' : ''})

            # When using VXLAN member interfaces that are configured for Single
            # VXLAN Device (SVD) we need to call the VXLAN conf-mode script to
            # re-create VLAN to VNI mappings if required, but only if the interface
            # is already live on the system - this must not be done on first commit
            if interface.startswith('vxlan') and interface_exists(interface):
                set_dependents('vxlan', conf, interface)
            # When using Wireless member interfaces we need to inform hostapd
            # to properly set-up the bridge
            elif interface.startswith('wlan') and interface_exists(interface):
                set_dependents('wlan', conf, interface)

    # delete empty dictionary keys - no need to run code paths if nothing is there to do
    if 'member' in bridge:
        if 'interface' in bridge['member'] and len(bridge['member']['interface']) == 0:
            del bridge['member']['interface']

        if len(bridge['member']) == 0:
            del bridge['member']

    return bridge

def verify(bridge):
    # to delete interface or remove a member interface VXLAN first need to check if
    # VXLAN does not require to be a member of a bridge interface
    if dict_search('member.interface_remove', bridge):
        for iface, iface_config in bridge['member']['interface_remove'].items():
            if iface.startswith('vxlan') and dict_search('parameters.neighbor_suppress', iface_config) != None:
                raise ConfigError(
                    f'To detach interface {iface} from bridge you must first '
                    f'disable "neighbor-suppress" parameter in the VXLAN interface {iface}'
                )

    if 'deleted' in bridge:
        return None

    verify_dhcpv6(bridge)
    verify_vrf(bridge)
    verify_mirror_redirect(bridge)

    ifname = bridge['ifname']

    if dict_search('member.interface', bridge):
        for interface, interface_config in bridge['member']['interface'].items():
            error_msg = f'Can not add interface "{interface}" to bridge, '

            if interface == 'lo':
                raise ConfigError('Loopback interface "lo" can not be added to a bridge')

            if 'is_bridge_member' in interface_config:
                tmp = next(iter(interface_config['is_bridge_member']))
                raise ConfigError(error_msg + f'it is already a member of bridge "{tmp}"!')

            if 'is_bond_member' in interface_config:
                tmp = next(iter(interface_config['is_bond_member']))
                raise ConfigError(error_msg + f'it is already a member of bond "{tmp}"!')

            if 'is_source_interface' in interface_config:
                tmp = interface_config['is_source_interface']
                raise ConfigError(error_msg + f'it is the source-interface of "{tmp}"!')

            if 'has_address' in interface_config:
                raise ConfigError(error_msg + 'it has an address assigned!')

            if 'has_vrf' in interface_config:
                raise ConfigError(error_msg + 'it has a VRF assigned!')

            if 'enable_vlan' in bridge:
                if 'has_vlan' in interface_config:
                    raise ConfigError(error_msg + 'it has VLAN subinterface(s) assigned!')
            else:
                for option in ['allowed_vlan', 'native_vlan']:
                    if option in interface_config:
                        raise ConfigError('Can not use VLAN options on non VLAN aware bridge')

    if 'enable_vlan' in bridge:
        if dict_search('vif.1', bridge):
            raise ConfigError(f'VLAN 1 sub interface cannot be set for VLAN aware bridge {ifname}, and VLAN 1 is always the parent interface')
    else:
        if dict_search('vif', bridge):
            raise ConfigError(f'You must first activate "enable-vlan" of {ifname} bridge to use "vif"')

    return None

def generate(bridge):
    return None

def apply(bridge):
    br = BridgeIf(bridge['ifname'])
    if 'deleted' in bridge:
        # delete interface
        br.remove()
    else:
        br.update(bridge)

    tmp = []
    if 'member' in bridge:
        if 'interface_remove' in bridge['member']:
            tmp.extend(bridge['member']['interface_remove'])
        if 'interface' in bridge['member']:
            tmp.extend(bridge['member']['interface'])

    for interface in tmp:
        if interface.startswith(tuple(['vxlan', 'wlan'])) and interface_exists(interface):
            try:
                call_dependents()
            except ConfigError:
                raise ConfigError(f'Error updating member interface {interface} configuration after changing bridge!')

    return None

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