summaryrefslogtreecommitdiff
path: root/src/conf_mode/interfaces-erspan.py
blob: 1bb5a4a9d4c63f144e4d0b76c69ed2639500c025 (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
#!/usr/bin/env python3
#
# Copyright (C) 2018-2020 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 sys import exit
from copy import deepcopy
from netifaces import interfaces

from vyos.config import Config
from vyos.configdict import dict_merge
from vyos.configdict import get_interface_dict
from vyos.configdict import node_changed
from vyos.configdict import leaf_node_changed
from vyos.configverify import verify_vrf
from vyos.configverify import verify_address
from vyos.configverify import verify_mtu_ipv6
from vyos.ifconfig import Interface
from vyos.ifconfig import ERSpanIf
from vyos.ifconfig import ER6SpanIf
from vyos.template import is_ipv4
from vyos.template import is_ipv6
from vyos.util import dict_search
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', 'erspan']
    erspan = get_interface_dict(conf, base)
    
    tmp = leaf_node_changed(conf, ['encapsulation'])
    if tmp: 
        erspan.update({'encapsulation_changed': {}})

    return erspan

def verify(erspan):
    if 'deleted' in erspan:
        return None
    
    if 'encapsulation' not in erspan:
        raise ConfigError('Must configure the ERSPAN tunnel encapsulation for '\
                          '{ifname}!'.format(**erspan))

    verify_mtu_ipv6(erspan)
    verify_address(erspan)
    verify_vrf(erspan)

    if 'local_ip' not in erspan:
        raise ConfigError('local-ip is mandatory for ERSPAN tunnel')

    if 'remote_ip' not in erspan:
        raise ConfigError('remote-ip is mandatory for ERSPAN tunnel')

    if erspan['encapsulation'] in ['ip6erspan']:
        error_ipv6 = 'Encapsulation mode requires IPv6'
        if 'local_ip' in erspan and not is_ipv6(erspan['local_ip']):
            raise ConfigError(f'{error_ipv6} local-ip')

        if 'remote_ip' in erspan and not is_ipv6(erspan['remote_ip']):
            raise ConfigError(f'{error_ipv6} remote-ip')
    else:
        error_ipv4 = 'Encapsulation mode requires IPv4'
        if 'local_ip' in erspan and not is_ipv4(erspan['local_ip']):
            raise ConfigError(f'{error_ipv4} local-ip')

        if 'remote_ip' in erspan and not is_ipv4(erspan['remote_ip']):
            raise ConfigError(f'{error_ipv4} remote-ip')
    
    if 'parameters' not in erspan:
        raise ConfigError('parameters is mandatory for ERSPAN tunnel')
    
    key = dict_search('parameters.ip.key',erspan)
    if key == None:
        raise ConfigError('parameters.ip.key is mandatory for ERSPAN tunnel')
    
    if erspan['encapsulation'] == 'erspan':
        if 'local_ip' in erspan and is_ipv6(erspan['local_ip']):
            raise ConfigError('Can not use local IPv6 address is for ERSPAN tunnels')
            

def generate(erspan):
    return None

def apply(erspan):
    if 'deleted' in erspan or 'encapsulation_changed' in erspan:
        if erspan['ifname'] in interfaces():
            tmp = Interface(erspan['ifname'])
            tmp.remove()
        if 'deleted' in erspan:
            return None

    dispatch = {
        'erspan': ERSpanIf,
        'ip6erspan': ER6SpanIf
    }

    # We need to re-map the tunnel encapsulation proto to a valid interface class
    encap = erspan['encapsulation']
    klass = dispatch[encap]
    
    conf = deepcopy(erspan)
    
    conf.update(klass.get_config())
    
    del conf['ifname']
    
    erspan_tunnel = klass(erspan['ifname'],**conf)
    erspan_tunnel.change_options()
    erspan_tunnel.update(erspan)

    return None

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