summaryrefslogtreecommitdiff
path: root/src/conf_mode/service_pppoe-server.py
blob: 1f6f6ecc7766142823665840cf75fb691e71db60 (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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
#!/usr/bin/env python3
#
# Copyright VyOS maintainers and contributors <maintainers@vyos.io>
#
# 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 vyos.config import Config
from vyos.configdict import get_accel_dict
from vyos.configdict import is_node_changed, node_changed
from vyos.configdiff import Diff
from vyos.configverify import verify_interface_exists
from vyos.configverify import verify_virtual_interface_exists
from vyos.template import render
from vyos.utils.process import call
from vyos.utils.process import is_systemd_service_active
from vyos.utils.dict import dict_search
from vyos.accel_ppp_util import verify_accel_ppp_name_servers
from vyos.accel_ppp_util import verify_accel_ppp_wins_servers
from vyos.accel_ppp_util import verify_accel_ppp_authentication
from vyos.accel_ppp_util import verify_accel_ppp_ip_pool
from vyos.accel_ppp_util import get_pools_in_order
from vyos import ConfigError
from vyos import airbag
from vyos.vpp.control_vpp import VPPControl

airbag.enable()

pppoe_conf = r'/run/accel-pppd/pppoe.conf'
pppoe_chap_secrets = r'/run/accel-pppd/pppoe.chap-secrets'


def base_ifname(ifname):
    # Get the base interface name without VLAN
    return ifname.split('.')[0]


def convert_pado_delay(pado_delay):
    new_pado_delay = {'delays_without_sessions': [],
                      'delays_with_sessions': []}
    for delay, sessions in pado_delay.items():
        if not sessions:
            new_pado_delay['delays_without_sessions'].append(delay)
        else:
            new_pado_delay['delays_with_sessions'].append((delay, int(sessions['sessions'])))
    return new_pado_delay

def get_config(config=None):
    if config:
        conf = config
    else:
        conf = Config()
    base = ['service', 'pppoe-server']

    # retrieve common dictionary keys
    pppoe = get_accel_dict(conf, base, pppoe_chap_secrets)

    vpp_interface_base = ['vpp', 'settings', 'interface']
    vpp_bond_interface_base = ['interfaces', 'vpp', 'bonding']
    if conf.exists(vpp_interface_base) and is_systemd_service_active('vpp.service'):
        vpp_ifaces = conf.get_config_dict(
            vpp_interface_base,
            key_mangling=('-', '_'),
            get_first_key=True,
            no_tag_node_value_mangle=True,
        )
        vpp_bond_ifaces = conf.get_config_dict(
            vpp_bond_interface_base,
            key_mangling=('-', '_'),
            get_first_key=True,
            no_tag_node_value_mangle=True,
        )
        vpp_ifaces = vpp_ifaces | vpp_bond_ifaces
        pppoe['vpp_ifaces'] = vpp_ifaces
        for interface in pppoe.get('interface', {}):
            if base_ifname(interface) in vpp_ifaces:
                pppoe['interface'][interface]['vpp_cp'] = {}

    pppoe['vpp_cp_interfaces'] = [
        ifname
        for ifname, iface_conf in pppoe.get('interface', {}).items()
        if 'vpp_cp' in iface_conf
    ]

    if not conf.exists(base):
        pppoe['remove'] = True
        return pppoe

    if dict_search('client_ip_pool', pppoe):
        # Multiple named pools require ordered values T5099
        pppoe['ordered_named_pools'] = get_pools_in_order(dict_search('client_ip_pool', pppoe))

    if dict_search('pado_delay', pppoe):
        pado_delay = dict_search('pado_delay', pppoe)
        pppoe['pado_delay'] = convert_pado_delay(pado_delay)

    # reload-or-restart is not implemented in accel-ppp
    # use this workaround until it will be implemented
    # https://phabricator.accel-ppp.org/T3
    changed_vpp_ifaces = node_changed(
        conf, vpp_interface_base, expand_nodes=Diff.DELETE | Diff.ADD
    )
    changed_vpp_bond_ifaces = node_changed(
        conf,
        vpp_bond_interface_base,
        recursive=True,
        expand_nodes=Diff.DELETE | Diff.ADD,
    )
    all_changed_vpp_ifaces = set(changed_vpp_ifaces) | set(changed_vpp_bond_ifaces)
    conditions = [
        is_node_changed(conf, base + ['client-ip-pool']),
        is_node_changed(conf, base + ['client-ipv6-pool']),
        is_node_changed(conf, base + ['interface']),
        is_node_changed(conf, base + ['authentication', 'radius']),
        is_node_changed(conf, base + ['authentication', 'mode']),
        is_node_changed(conf, base + ['authentication', 'protocols']),
        any(
            base_ifname(iface) in all_changed_vpp_ifaces
            for iface in pppoe.get('interface', {})
        ),
    ]
    if any(conditions):
        pppoe.update({'restart_required': {}})
    pppoe['server_type'] = 'pppoe'
    return pppoe

def verify_pado_delay(pppoe):
    if 'pado_delay' in pppoe:
        pado_delay = pppoe['pado_delay']

        delays_without_sessions = pado_delay['delays_without_sessions']
        if 'disable' in delays_without_sessions:
            raise ConfigError(
                'Number of sessions must be specified for "pado-delay disable"'
            )

        if len(delays_without_sessions) > 1:
            raise ConfigError(
                f'Cannot add more then ONE pado-delay without sessions, '
                f'but {len(delays_without_sessions)} were set'
            )

        if 'disable' in [delay[0] for delay in pado_delay['delays_with_sessions']]:
            # need to sort delays by sessions to verify if there is no delay
            # for sessions after disabling
            sorted_pado_delay = sorted(pado_delay['delays_with_sessions'], key=lambda k_v: k_v[1])
            last_delay = sorted_pado_delay[-1]

            if last_delay[0] != 'disable':
                raise ConfigError(
                    f'Cannot add pado-delay after disabled sessions, but '
                    f'"pado-delay {last_delay[0]} sessions {last_delay[1]}" was set'
                )

def verify(pppoe):
    if 'remove' in pppoe:
        return None

    verify_accel_ppp_authentication(pppoe)
    verify_accel_ppp_ip_pool(pppoe)
    verify_accel_ppp_name_servers(pppoe)
    verify_accel_ppp_wins_servers(pppoe)
    verify_pado_delay(pppoe)

    if 'interface' not in pppoe:
        raise ConfigError('At least one listen interface must be defined!')

    # Check is interface exists in the system
    for interface, interface_config in pppoe['interface'].items():
        # Interfaces integrated with the control-plane in VPP must exist in the system
        warning_only = 'vpp_cp' not in interface_config
        if '.' in interface:
            verify_interface_func = verify_virtual_interface_exists
        else:
            verify_interface_func = verify_interface_exists
        verify_interface_func(pppoe, interface, warning_only=warning_only)

        if 'vlan_mon' in interface_config and base_ifname(interface) in pppoe.get(
            'vpp_ifaces', {}
        ):
            raise ConfigError(
                f'Cannot set option "vlan-mon": interface {interface} is integrated with control-plane!'
            )

        if 'vlan_mon' in interface_config and not 'vlan' in interface_config:
            raise ConfigError('Option "vlan-mon" requires "vlan" to be set!')

    return None


def generate(pppoe):
    if 'remove' in pppoe:
        return None

    render(pppoe_conf, 'accel-ppp/pppoe.config.j2', pppoe)

    if dict_search('authentication.mode', pppoe) == 'local':
        render(pppoe_chap_secrets, 'accel-ppp/chap-secrets.config_dict.j2',
               pppoe, permission=0o640)
    return None


def apply(pppoe):
    systemd_service = 'accel-ppp@pppoe.service'

    # delete pppoe mapping in vpp
    if 'vpp_ifaces' in pppoe:
        vpp = VPPControl()
        mapping = vpp.get_pppoe_interface_mapping()
        for dp_index, cp_index in mapping.items():
            vpp.delete_pppoe_mapping(dp_index, cp_index)

    if 'remove' in pppoe:
        call(f'systemctl stop {systemd_service}')
        for file in [pppoe_conf, pppoe_chap_secrets]:
            if os.path.exists(file):
                os.unlink(file)
        return None

    if 'restart_required' in pppoe:
        call(f'systemctl restart {systemd_service}')
    else:
        call(f'systemctl reload-or-restart {systemd_service}')

    # add pppoe mapping in vpp
    vpp_cp_ifaces_add = pppoe.get('vpp_cp_interfaces', [])
    if vpp_cp_ifaces_add:
        vpp = VPPControl()
        for iface in vpp_cp_ifaces_add:
            vpp.map_pppoe_interface(iface)


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