summaryrefslogtreecommitdiff
path: root/src/conf_mode/vpp_interfaces_gre.py
blob: 3756449a26b8a2637bc950bf178700fe8067dfa1 (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
#!/usr/bin/env python3
#
# Copyright (C) VyOS Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# 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, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

from vyos import ConfigError

from vyos.config import Config
from vyos.configdict import get_interface_dict
from vyos.configdep import set_dependents, call_dependents
from vyos.configverify import verify_mtu_ipv6
from vyos.utils.process import is_systemd_service_active

from vyos.ifconfig.vpp import VPPGREInterface
from vyos.vpp.config_deps import deps_bridge_dict
from vyos.vpp.config_deps import deps_xconnect_dict
from vyos.vpp.config_verify import verify_vpp_remove_bridge_interface
from vyos.vpp.config_verify import verify_vpp_remove_xconnect_interface
from vyos.vpp.config_verify import verify_vpp_tunnel_source_address
from vyos.vpp.utils import cli_ethernet_with_vifs_ifaces


def get_config(config=None) -> dict:
    """Get GRE interface configuration

    Args:
        config (vyos.config.Config, optional): The VyOS configuration dictionary
    Returns:
        dict: GRE interface configuration
    """
    if config:
        conf = config
    else:
        conf = Config()

    base = ['interfaces', 'vpp', 'gre']

    ifname, config = get_interface_dict(conf, base)

    if not conf.exists(['vpp']) and not conf.exists(base):
        config['remove_vpp'] = True
        return config

    # list of all Ethernet interfaces with vifs
    config['vpp_ether_vif_ifaces'] = cli_ethernet_with_vifs_ifaces(conf)

    # Dependency
    config['xconn_members'] = deps_xconnect_dict(conf)
    if ifname in config['xconn_members']:
        for xconn_iface in config['xconn_members'][ifname]:
            set_dependents('vpp_interfaces_xconnect', conf, xconn_iface)

    config['bridge_members'] = deps_bridge_dict(conf)
    if ifname in config['bridge_members']:
        for bridge_iface in config['bridge_members'][ifname]:
            set_dependents('vpp_interfaces_bridge', conf, bridge_iface)

    # Get 'vpp settings' config
    config['vpp_settings'] = conf.get_config_dict(
        ['vpp', 'settings'],
        key_mangling=('-', '_'),
        get_first_key=True,
        no_tag_node_value_mangle=True,
    )

    # Get all gre interfaces config
    config['gre_interfaces'] = conf.get_config_dict(
        base,
        key_mangling=('-', '_'),
        get_first_key=True,
        no_tag_node_value_mangle=True,
        with_defaults=True,
        with_recursive_defaults=True,
    )

    # NAT dependency
    if conf.exists(['vpp', 'nat', 'nat44']):
        set_dependents('vpp_nat_nat44', conf)
    if conf.exists(['vpp', 'nat', 'cgnat']):
        set_dependents('vpp_nat_cgnat', conf)

    # ACL dependency
    if conf.exists(['vpp', 'acl']):
        set_dependents('vpp_acl', conf)

    return config


def verify(config):
    # No need to verify anything if vpp is removed
    if 'remove_vpp' in config:
        return None

    verify_vpp_remove_xconnect_interface(config)
    verify_vpp_remove_bridge_interface(config)

    # config removed
    if 'deleted' in config:
        return None

    if not is_systemd_service_active('vpp.service'):
        raise ConfigError(
            'Cannot configure VPP GRE interface: vpp.service is not running'
        )

    # source-address and remote are mandatory options
    required_keys = {'source_address', 'remote', 'tunnel_type'}
    if not all(key in config for key in required_keys):
        missing_keys = required_keys - set(config.keys())
        raise ConfigError(
            f"Required options are missing: {', '.join(missing_keys).replace('_', '-')}"
        )

    # verify source address and remote address
    verify_vpp_tunnel_source_address(config)
    if config.get('source_address') == config.get('remote'):
        raise ConfigError('Remote address must not be the same as source address')

    verify_mtu_ipv6(config)

    # Disable checks as point-to-multipoint mode does not work without 'teib' feature that is not implemented yet
    # # check multipoint mode
    # if config.get('mode') == 'point-to-multipoint':
    #     # For multipoint mode, remote IP must be 0.0.0.0
    #     if config.get('remote') != '0.0.0.0':
    #         raise ConfigError('For point-to-multipoint mode, remote must be 0.0.0.0')
    #
    #     # Only one multipoint GRE tunnel is allowed from the same source address
    #     #   set interfaces vpp gre vppgre0 mode 'point-to-multipoint'
    #     #   set interfaces vpp gre vppgre0 remote '0.0.0.0'
    #     #   set interfaces vpp gre vppgre0 source-address '192.0.2.1'
    #     #   set interfaces vpp gre vppgre1 mode 'point-to-multipoint'
    #     #   set interfaces vpp gre vppgre1 remote '0.0.0.0'
    #     #   set interfaces vpp gre vppgre1 source-address '192.0.2.1'
    #     for other_iface, other_iface_config in config['gre_interfaces'].items():
    #         if other_iface == config['ifname']:
    #             continue
    #         if other_iface_config['mode'] == 'point-to-multipoint':
    #             if config['source_address'] == other_iface_config.get('source_address'):
    #                 raise ConfigError(
    #                     'Only one multipoint GRE tunnel is allowed from the same source address'
    #                 )


def generate(config):
    pass


def apply(config):
    if 'remove_vpp' in config:
        return None

    ifname = config.get('ifname')
    gre = VPPGREInterface(ifname, config)
    gre.remove()

    if 'deleted' in config:
        return

    gre.update(config)

    call_dependents()

    return None


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