summaryrefslogtreecommitdiff
path: root/src/conf_mode/vpn_l2tp.py
blob: 4d82a94009a6e2c6bcd516831f553342f91675a9 (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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
#!/usr/bin/env python3
#
# Copyright (C) 2019-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
import re

from copy import deepcopy
from stat import S_IRUSR, S_IWUSR, S_IRGRP
from sys import exit
from time import sleep

from ipaddress import ip_network

from vyos.config import Config
from vyos.util import call, get_half_cpus
from vyos.validate import is_ipv4
from vyos import ConfigError
from vyos.template import render

from vyos import airbag
airbag.enable()

l2tp_conf = '/run/accel-pppd/l2tp.conf'
l2tp_chap_secrets = '/run/accel-pppd/l2tp.chap-secrets'

default_config_data = {
    'auth_mode': 'local',
    'auth_ppp_mppe': 'prefer',
    'auth_proto': ['auth_mschap_v2'],
    'chap_secrets_file': l2tp_chap_secrets, # used in Jinja2 template
    'client_ip_pool': None,
    'client_ip_subnets': [],
    'client_ipv6_pool': [],
    'client_ipv6_delegate_prefix': [],
    'dnsv4': [],
    'dnsv6': [],
    'gateway_address': '10.255.255.0',
    'local_users' : [],
    'mtu': '1436',
    'outside_addr': '',
    'ppp_mppe': 'prefer',
    'ppp_echo_failure' : '3',
    'ppp_echo_interval' : '30',
    'ppp_echo_timeout': '0',
    'radius_server': [],
    'radius_acct_inter_jitter': '',
    'radius_acct_tmo': '3',
    'radius_max_try': '3',
    'radius_timeout': '3',
    'radius_nas_id': '',
    'radius_nas_ip': '',
    'radius_source_address': '',
    'radius_shaper_attr': '',
    'radius_shaper_vendor': '',
    'radius_dynamic_author': '',
    'wins': [],
    'ip6_column': [],
    'thread_cnt': get_half_cpus()
}

def get_config(config=None):
    if config:
        conf = config
    else:
        conf = Config()
    base_path = ['vpn', 'l2tp', 'remote-access']
    if not conf.exists(base_path):
        return None

    conf.set_level(base_path)
    l2tp = deepcopy(default_config_data)

    ### general options ###
    if conf.exists(['name-server']):
        for name_server in conf.return_values(['name-server']):
            if is_ipv4(name_server):
                l2tp['dnsv4'].append(name_server)
            else:
                l2tp['dnsv6'].append(name_server)

    if conf.exists(['wins-server']):
        l2tp['wins'] = conf.return_values(['wins-server'])

    if conf.exists('outside-address'):
        l2tp['outside_addr'] = conf.return_value('outside-address')

    if conf.exists(['authentication', 'mode']):
        l2tp['auth_mode'] = conf.return_value(['authentication', 'mode'])

    if conf.exists(['authentication', 'protocols']):
        auth_mods = {
            'pap': 'auth_pap',
            'chap': 'auth_chap_md5',
            'mschap': 'auth_mschap_v1',
            'mschap-v2': 'auth_mschap_v2'
        }

        for proto in conf.return_values(['authentication', 'protocols']):
            l2tp['auth_proto'].append(auth_mods[proto])

    if conf.exists(['authentication', 'mppe']):
        l2tp['auth_ppp_mppe'] = conf.return_value(['authentication', 'mppe'])

    #
    # local auth
    if conf.exists(['authentication', 'local-users']):
        for username in conf.list_nodes(['authentication', 'local-users', 'username']):
            user = {
                'name' : username,
                'password' : '',
                'state' : 'enabled',
                'ip' : '*',
                'upload' : None,
                'download' : None
            }

            conf.set_level(base_path + ['authentication', 'local-users', 'username', username])

            if conf.exists(['password']):
                user['password'] = conf.return_value(['password'])

            if conf.exists(['disable']):
                user['state'] = 'disable'

            if conf.exists(['static-ip']):
                user['ip'] = conf.return_value(['static-ip'])

            if conf.exists(['rate-limit', 'download']):
                user['download'] = conf.return_value(['rate-limit', 'download'])

            if conf.exists(['rate-limit', 'upload']):
                user['upload'] = conf.return_value(['rate-limit', 'upload'])

            l2tp['local_users'].append(user)

    #
    # RADIUS auth and settings
    conf.set_level(base_path + ['authentication', 'radius'])
    if conf.exists(['server']):
        for server in conf.list_nodes(['server']):
            radius = {
                'server' : server,
                'key' : '',
                'fail_time' : 0,
                'port' : '1812',
                'acct_port' : '1813'
            }

            conf.set_level(base_path + ['authentication', 'radius', 'server', server])

            if conf.exists(['disable-accounting']):
                radius['acct_port'] = '0'

            if conf.exists(['fail-time']):
                radius['fail_time'] = conf.return_value(['fail-time'])

            if conf.exists(['port']):
                radius['port'] = conf.return_value(['port'])

            if conf.exists(['acct-port']):
                radius['acct_port'] = conf.return_value(['acct-port'])

            if conf.exists(['key']):
                radius['key'] = conf.return_value(['key'])

            if not conf.exists(['disable']):
                l2tp['radius_server'].append(radius)

        #
        # advanced radius-setting
        conf.set_level(base_path + ['authentication', 'radius'])

        if conf.exists(['acct-interim-jitter']):
            l2tp['radius_acct_inter_jitter'] = conf.return_value(['acct-interim-jitter'])

        if conf.exists(['acct-timeout']):
            l2tp['radius_acct_tmo'] = conf.return_value(['acct-timeout'])

        if conf.exists(['max-try']):
            l2tp['radius_max_try'] = conf.return_value(['max-try'])

        if conf.exists(['timeout']):
            l2tp['radius_timeout'] = conf.return_value(['timeout'])

        if conf.exists(['nas-identifier']):
            l2tp['radius_nas_id'] = conf.return_value(['nas-identifier'])

        if conf.exists(['nas-ip-address']):
            l2tp['radius_nas_ip'] = conf.return_value(['nas-ip-address'])

        if conf.exists(['source-address']):
            l2tp['radius_source_address'] = conf.return_value(['source-address'])

        # Dynamic Authorization Extensions (DOA)/Change Of Authentication (COA)
        if conf.exists(['dynamic-author']):
            dae = {
                'port' : '',
                'server' : '',
                'key' : ''
            }

            if conf.exists(['dynamic-author', 'server']):
                dae['server'] = conf.return_value(['dynamic-author', 'server'])

            if conf.exists(['dynamic-author', 'port']):
                dae['port'] = conf.return_value(['dynamic-author', 'port'])

            if conf.exists(['dynamic-author', 'key']):
                dae['key'] = conf.return_value(['dynamic-author', 'key'])

            l2tp['radius_dynamic_author'] = dae

        if conf.exists(['rate-limit', 'enable']):
            l2tp['radius_shaper_attr'] = 'Filter-Id'
            c_attr = ['rate-limit', 'enable', 'attribute']
            if conf.exists(c_attr):
                l2tp['radius_shaper_attr'] = conf.return_value(c_attr)

            c_vendor = ['rate-limit', 'enable', 'vendor']
            if conf.exists(c_vendor):
                l2tp['radius_shaper_vendor'] = conf.return_value(c_vendor)

    conf.set_level(base_path)
    if conf.exists(['client-ip-pool']):
        if conf.exists(['client-ip-pool', 'start']) and conf.exists(['client-ip-pool', 'stop']):
            start = conf.return_value(['client-ip-pool', 'start'])
            stop  = conf.return_value(['client-ip-pool', 'stop'])
            l2tp['client_ip_pool'] = start + '-' + re.search('[0-9]+$', stop).group(0)

    if conf.exists(['client-ip-pool', 'subnet']):
        l2tp['client_ip_subnets'] = conf.return_values(['client-ip-pool', 'subnet'])

    if conf.exists(['client-ipv6-pool', 'prefix']):
        l2tp['ip6_column'].append('ip6')
        for prefix in conf.list_nodes(['client-ipv6-pool', 'prefix']):
            tmp = {
                'prefix': prefix,
                'mask': '64'
            }

            if conf.exists(['client-ipv6-pool', 'prefix', prefix, 'mask']):
                tmp['mask'] = conf.return_value(['client-ipv6-pool', 'prefix', prefix, 'mask'])

            l2tp['client_ipv6_pool'].append(tmp)

    if conf.exists(['client-ipv6-pool', 'delegate']):
        l2tp['ip6_column'].append('ip6-db')
        for prefix in conf.list_nodes(['client-ipv6-pool', 'delegate']):
            tmp = {
                'prefix': prefix,
                'mask': ''
            }

            if conf.exists(['client-ipv6-pool', 'delegate', prefix, 'delegation-prefix']):
                tmp['mask'] = conf.return_value(['client-ipv6-pool', 'delegate', prefix, 'delegation-prefix'])

            l2tp['client_ipv6_delegate_prefix'].append(tmp)

    if conf.exists(['mtu']):
        l2tp['mtu'] = conf.return_value(['mtu'])

    # gateway address
    if conf.exists(['gateway-address']):
        l2tp['gateway_address'] = conf.return_value(['gateway-address'])
    else:
        # calculate gw-ip-address
        if conf.exists(['client-ip-pool', 'start']):
            # use start ip as gw-ip-address
            l2tp['gateway_address'] = conf.return_value(['client-ip-pool', 'start'])

        elif conf.exists(['client-ip-pool', 'subnet']):
            # use first ip address from first defined pool
            subnet = conf.return_values(['client-ip-pool', 'subnet'])[0]
            subnet = ip_network(subnet)
            l2tp['gateway_address'] = str(list(subnet.hosts())[0])

    # LNS secret
    if conf.exists(['lns', 'shared-secret']):
        l2tp['lns_shared_secret'] = conf.return_value(['lns', 'shared-secret'])

    if conf.exists(['ccp-disable']):
        l2tp['ccp_disable'] = True

    # PPP options
    if conf.exists(['idle']):
        l2tp['ppp_echo_timeout'] = conf.return_value(['idle'])

    if conf.exists(['ppp-options', 'lcp-echo-failure']):
        l2tp['ppp_echo_failure'] = conf.return_value(['ppp-options', 'lcp-echo-failure'])

    if conf.exists(['ppp-options', 'lcp-echo-interval']):
        l2tp['ppp_echo_interval'] = conf.return_value(['ppp-options', 'lcp-echo-interval'])

    return l2tp


def verify(l2tp):
    if not l2tp:
        return None

    if l2tp['auth_mode'] == 'local':
        if not l2tp['local_users']:
            raise ConfigError('L2TP local auth mode requires local users to be configured!')

        for user in l2tp['local_users']:
            if not user['password']:
                raise ConfigError(f"Password required for user {user['name']}")

    elif l2tp['auth_mode'] == 'radius':
        if len(l2tp['radius_server']) == 0:
            raise ConfigError("RADIUS authentication requires at least one server")

        for radius in l2tp['radius_server']:
            if not radius['key']:
                raise ConfigError(f"Missing RADIUS secret for server { radius['key'] }")

    # check for the existence of a client ip pool
    if not (l2tp['client_ip_pool'] or l2tp['client_ip_subnets']):
        raise ConfigError(
            "set vpn l2tp remote-access client-ip-pool requires subnet or start/stop IP pool")

    # check ipv6
    if l2tp['client_ipv6_delegate_prefix'] and not l2tp['client_ipv6_pool']:
        raise ConfigError('IPv6 prefix delegation requires client-ipv6-pool prefix')

    for prefix in l2tp['client_ipv6_delegate_prefix']:
        if not prefix['mask']:
            raise ConfigError('Delegation-prefix required for individual delegated networks')

    if len(l2tp['wins']) > 2:
        raise ConfigError('Not more then two IPv4 WINS name-servers can be configured')

    if len(l2tp['dnsv4']) > 2:
        raise ConfigError('Not more then two IPv4 DNS name-servers can be configured')

    if len(l2tp['dnsv6']) > 3:
        raise ConfigError('Not more then three IPv6 DNS name-servers can be configured')

    return None


def generate(l2tp):
    if not l2tp:
        return None

    render(l2tp_conf, 'accel-ppp/l2tp.config.tmpl', l2tp, trim_blocks=True)

    if l2tp['auth_mode'] == 'local':
        render(l2tp_chap_secrets, 'accel-ppp/chap-secrets.tmpl', l2tp)
        os.chmod(l2tp_chap_secrets, S_IRUSR | S_IWUSR | S_IRGRP)

    else:
        if os.path.exists(l2tp_chap_secrets):
             os.unlink(l2tp_chap_secrets)

    return None


def apply(l2tp):
    if not l2tp:
        call('systemctl stop accel-ppp@l2tp.service')
        for file in [l2tp_chap_secrets, l2tp_conf]:
            if os.path.exists(file):
                os.unlink(file)

        return None

    call('systemctl restart accel-ppp@l2tp.service')

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